Canoe
Comprehensive Atmosphere N' Ocean Engine
CorrelatedKAbsorber Class Reference

#include <correlatedk_absorber.hpp>

Inheritance diagram for CorrelatedKAbsorber:
[legend]

Public Member Functions

 CorrelatedKAbsorber (std::string name)
 
virtual ~CorrelatedKAbsorber ()
 
void LoadCoefficient (std::string fname, size_t bid) override
 Load absorption coefficient from file. More...
 
Real GetAttenuation (Real g1, Real g2, AirParcel const &var) const override
 Get attenuation coefficient [1/m]. 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 Real GetSingleScatteringAlbedo (Real wave1, Real wave2, AirParcel const &var) const
 Get single scattering albedo [1]. More...
 
virtual void GetPhaseMomentum (Real *pp, Real wave1, Real wave2, AirParcel const &var, int np) const
 Get phase function [1]. 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 Attributes

size_t len_ [3]
 
std::vector< Real > axis_
 
std::vector< Real > kcoeff_
 
- 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 11 of file correlatedk_absorber.hpp.

Constructor & Destructor Documentation

◆ CorrelatedKAbsorber()

CorrelatedKAbsorber::CorrelatedKAbsorber ( std::string  name)
inline

Definition at line 13 of file correlatedk_absorber.hpp.

◆ ~CorrelatedKAbsorber()

virtual CorrelatedKAbsorber::~CorrelatedKAbsorber ( )
inlinevirtual

Definition at line 14 of file correlatedk_absorber.hpp.

Member Function Documentation

◆ LoadCoefficient()

void CorrelatedKAbsorber::LoadCoefficient ( std::string  fname,
size_t  bid 
)
overridevirtual

Load absorption coefficient from file.

Reimplemented from Absorber.

Definition at line 27 of file correlatedk_absorber.cpp.

◆ GetAttenuation()

Real CorrelatedKAbsorber::GetAttenuation ( Real  wave1,
Real  wave2,
AirParcel const &  var 
) const
overridevirtual

Get attenuation coefficient [1/m].

Reimplemented from Absorber.

Definition at line 55 of file correlatedk_absorber.cpp.

Member Data Documentation

◆ len_

size_t CorrelatedKAbsorber::len_[3]
protected

length of interpolation axis

Definition at line 20 of file correlatedk_absorber.hpp.

◆ axis_

std::vector<Real> CorrelatedKAbsorber::axis_
protected

interpolation axis

Definition at line 21 of file correlatedk_absorber.hpp.

◆ kcoeff_

std::vector<Real> CorrelatedKAbsorber::kcoeff_
protected

absorption coefficient

Definition at line 22 of file correlatedk_absorber.hpp.


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