Canoe
Comprehensive Atmosphere N' Ocean Engine
FuWaterLiquidCloud Class Reference

#include <water_cloud.hpp>

Inheritance diagram for FuWaterLiquidCloud:
[legend]

Public Member Functions

 FuWaterLiquidCloud ()
 
Real GetAttenuation (Real wave1, Real wave2, AirParcel const &var) const override
 Get attenuation coefficient [1/m]. More...
 
Real GetSingleScatteringAlbedo (Real wave1, Real wave2, AirParcel const &var) const override
 Get single scattering albedo [1]. More...
 
void GetPhaseMomentum (Real *pp, Real wave1, Real wave2, AirParcel const &var, int np) const override
 Get phase function [1]. More...
 
- Public Member Functions inherited from Absorber
 Absorber (std::string name)
 
virtual ~Absorber ()
 
void SetModel (std::string name)
 Set absorption model. More...
 
void LoadOpacityFromFile (std::string filename)
 Combines SetOpacityFile() and LoadOpacity() More...
 
void SetOpacityFile (std::string filename)
 Set opacity filename to internal variable, does not load opacity. More...
 
void LoadOpacity ()
 Load opacity from internal variable. More...
 
virtual void LoadCoefficient (std::string fname, size_t bid)
 Load absorption coefficient from file. More...
 
- Public Member Functions inherited from NamedGroup
 NamedGroup (std::string name)
 
virtual ~NamedGroup ()
 
std::string GetName () const
 
- Public Member Functions inherited from ParameterGroup
virtual ~ParameterGroup ()
 
void SetRealsFrom (YAML::Node const &node)
 
void SetPar (std::string const &name, Real value)
 Set real parameter. More...
 
void SetPar (std::string const &name, int value)
 Set int parameter. More...
 
void SetPar (std::string const &name, std::string const &value)
 Set string parameter. More...
 
template<typename T >
GetPar (std::string const &name) const
 Get parameter. More...
 
bool HasPar (std::string const &name) const
 Check if a parameter exists. More...
 
template<>
int GetPar (std::string const &name) const
 
template<>
Real GetPar (std::string const &name) const
 
- Public Member Functions inherited from SpeciesIndexGroup
virtual ~SpeciesIndexGroup ()
 
void SetSpeciesIndex (std::vector< std::string > const &species_names)
 Set species index based on species names. More...
 
std::vector< int > const & GetSpeciesIndexArray () const
 
int GetSpeciesIndex (int n) const
 
std::vector< int > const & GetCloudIndexArray () const
 
int GetCloudIndex (int n) const
 
std::vector< int > const & GetChemistryIndexArray () const
 
int GetChemistryIndex (int n) const
 
- Public Member Functions inherited from CheckGroup
virtual ~CheckGroup ()
 
virtual void CheckFail () const
 This function fails if the check fails. More...
 
virtual bool CheckWarn () const
 

Protected Member Functions

Real getAttenuation1 (Real wave, AirParcel const &var) const
 
Real getSingleScatteringAlbedo1 (Real wave, AirParcel const &var) const
 
void getPhaseMomentum1 (Real *pp, Real wave, AirParcel const &var, int np) const
 

Additional Inherited Members

- Protected Attributes inherited from Absorber
std::string model_name_
 absorption model model More...
 
std::string opacity_filename_
 opacity filename More...
 

Detailed Description

Definition at line 40 of file water_cloud.hpp.

Constructor & Destructor Documentation

◆ FuWaterLiquidCloud()

FuWaterLiquidCloud::FuWaterLiquidCloud ( )
inline

Definition at line 42 of file water_cloud.hpp.

Member Function Documentation

◆ GetAttenuation()

Real FuWaterLiquidCloud::GetAttenuation ( Real  wave1,
Real  wave2,
AirParcel const &  var 
) const
inlineoverridevirtual

Get attenuation coefficient [1/m].

Reimplemented from Absorber.

Definition at line 44 of file water_cloud.hpp.

◆ GetSingleScatteringAlbedo()

Real FuWaterLiquidCloud::GetSingleScatteringAlbedo ( Real  wave1,
Real  wave2,
AirParcel const &  var 
) const
inlineoverridevirtual

Get single scattering albedo [1].

Reimplemented from Absorber.

Definition at line 49 of file water_cloud.hpp.

◆ GetPhaseMomentum()

void FuWaterLiquidCloud::GetPhaseMomentum ( Real *  pp,
Real  wave1,
Real  wave2,
AirParcel const &  var,
int  np 
) const
inlineoverridevirtual

Get phase function [1].

Reimplemented from Absorber.

Definition at line 54 of file water_cloud.hpp.

◆ getAttenuation1()

Real FuWaterLiquidCloud::getAttenuation1 ( Real  wave,
AirParcel const &  var 
) const
protected

Definition at line 102 of file fu_waterliquid_cloud.cpp.

◆ getSingleScatteringAlbedo1()

Real FuWaterLiquidCloud::getSingleScatteringAlbedo1 ( Real  wave,
AirParcel const &  var 
) const
protected

Definition at line 128 of file fu_waterliquid_cloud.cpp.

◆ getPhaseMomentum1()

void FuWaterLiquidCloud::getPhaseMomentum1 ( Real *  pp,
Real  wave,
AirParcel const &  var,
int  np 
) const
protected

Definition at line 151 of file fu_waterliquid_cloud.cpp.


The documentation for this class was generated from the following files: