GiantPlanets::MwrAbsorberNH3 Class Reference

#include <mwr_absorbers.hpp>

Inheritance diagram for GiantPlanets::MwrAbsorberNH3:

Public Member Functions
	MwrAbsorberNH3 ()
MwrAbsorberNH3 &	SetModelHanley ()
MwrAbsorberNH3 &	SetModelBellotti ()
MwrAbsorberNH3 &	SetModelBellottiSwitch ()
MwrAbsorberNH3 &	SetModelDevaraj ()
MwrAbsorberNH3 &	SetModelRadtran ()
void	CheckFail () const override
	This function fails if the check fails. More...
Real	GetAttenuation (Real wave1, Real wave2, 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 void	LoadCoefficient (std::string fname, size_t bid)
	Load absorption coefficient from file. 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 >
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 bool	CheckWarn () 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 36 of file mwr_absorbers.hpp.

Constructor & Destructor Documentation

MwrAbsorberNH3()

GiantPlanets::MwrAbsorberNH3::MwrAbsorberNH3 ( )

inline

Definition at line 38 of file mwr_absorbers.hpp.

Member Function Documentation

SetModelHanley()

MwrAbsorberNH3& GiantPlanets::MwrAbsorberNH3::SetModelHanley ( )

inline

Definition at line 40 of file mwr_absorbers.hpp.

SetModelBellotti()

MwrAbsorberNH3& GiantPlanets::MwrAbsorberNH3::SetModelBellotti ( )

inline

Definition at line 44 of file mwr_absorbers.hpp.

SetModelBellottiSwitch()

MwrAbsorberNH3& GiantPlanets::MwrAbsorberNH3::SetModelBellottiSwitch ( )

inline

Definition at line 48 of file mwr_absorbers.hpp.

SetModelDevaraj()

MwrAbsorberNH3& GiantPlanets::MwrAbsorberNH3::SetModelDevaraj ( )

inline

Definition at line 52 of file mwr_absorbers.hpp.

SetModelRadtran()

MwrAbsorberNH3& GiantPlanets::MwrAbsorberNH3::SetModelRadtran ( )

inline

Definition at line 56 of file mwr_absorbers.hpp.

CheckFail()

void GiantPlanets::MwrAbsorberNH3::CheckFail ( ) const

overridevirtual

This function fails if the check fails.

Reimplemented from CheckGroup.

Definition at line 17 of file mwr_absorber_nh3.cpp.

GetAttenuation()

Real GiantPlanets::MwrAbsorberNH3::GetAttenuation ( Real  wave1, Real  wave2, AirParcel const &  var  ) const

overridevirtual

Get attenuation coefficient [1/m].

Reimplemented from Absorber.

Definition at line 27 of file mwr_absorber_nh3.cpp.

---

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

• /home/cli/canoe/src/opacity/Giants/microwave/mwr_absorbers.hpp
• /home/cli/canoe/src/opacity/Giants/microwave/mwr_absorber_nh3.cpp