Canoe
Comprehensive Atmosphere N' Ocean Engine
Kessler94 Class Reference

Kessler (1994) microphysical scheme. More...

#include <microphysical_schemes.hpp>

Inheritance diagram for Kessler94:
[legend]

Public Types

enum  { Size = Base::Size }
 
using Base = MicrophysicalScheme< 3 >
 
- Public Types inherited from MicrophysicalScheme< 3 >
enum  
 
using RealVector = Eigen::Matrix< Real, D, 1 >
 
using RealMatrix = Eigen::Matrix< Real, D, D >
 

Public Member Functions

 Kessler94 (std::string name, YAML::Node const &node)
 constructor and destructor More...
 
 ~Kessler94 ()
 
void AssembleReactionMatrix (AirParcel const &air, Real time) override
 functions More...
 
void EvolveOneStep (AirParcel *air, Real time, Real dt) override
 Evolve the air parcel one time step. More...
 
void SetVsedFromConserved (AthenaArray< Real > vsed[3], Hydro const *phydro, int kl, int ku, int jl, int ju, int il, int iu) override
 inbound functions More...
 
- Public Member Functions inherited from MicrophysicalScheme< 3 >
 MicrophysicalScheme (std::string name, YAML::Node const &node)
 constructor and destructor More...
 
virtual ~MicrophysicalScheme ()
 
Real const * GetRatePtr () const
 member functions More...
 
Real const * GetJacobianPtr () const
 
void SetVsedFromConserved (AthenaArray< Real > vsed[3], Hydro const *phydro, int kl, int ku, int jl, int ju, int il, int iu) override
 inbound functions More...
 
- Public Member Functions inherited from MicrophysicalSchemeBase
 MicrophysicalSchemeBase (std::string name)
 constructor and destructor More...
 
virtual ~MicrophysicalSchemeBase ()
 
- 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
 

Protected Attributes

ChemistrySolver< Sizesolver_
 chemistry solver More...
 
- Protected Attributes inherited from MicrophysicalScheme< 3 >
Eigen::Matrix< Real, D, 1 > rate_
 rate and jacobian More...
 
Eigen::Matrix< Real, D, D > jacb_
 

Detailed Description

Kessler (1994) microphysical scheme.

Definition at line 120 of file microphysical_schemes.hpp.

Member Typedef Documentation

◆ Base

Definition at line 122 of file microphysical_schemes.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
Size 

Definition at line 123 of file microphysical_schemes.hpp.

Constructor & Destructor Documentation

◆ Kessler94()

Kessler94::Kessler94 ( std::string  name,
YAML::Node const &  node 
)

constructor and destructor

Definition at line 13 of file kessler94.cpp.

◆ ~Kessler94()

Kessler94::~Kessler94 ( )

Definition at line 19 of file kessler94.cpp.

Member Function Documentation

◆ AssembleReactionMatrix()

void Kessler94::AssembleReactionMatrix ( AirParcel const &  air,
Real  time 
)
overridevirtual

functions

Implements MicrophysicalSchemeBase.

Definition at line 24 of file kessler94.cpp.

◆ EvolveOneStep()

void Kessler94::EvolveOneStep ( AirParcel air,
Real  time,
Real  dt 
)
overridevirtual

Evolve the air parcel one time step.

Parameters
[in,out]airair parcel to be evolved
[in]timecurrent simulation time
[in]dttime step
Todo:
check this

Implements MicrophysicalSchemeBase.

Definition at line 69 of file kessler94.cpp.

◆ SetVsedFromConserved()

void Kessler94::SetVsedFromConserved ( AthenaArray< Real >  vsed[3],
Hydro const *  phydro,
int  kl,
int  ku,
int  jl,
int  ju,
int  il,
int  iu 
)
overridevirtual

inbound functions

Implements MicrophysicalSchemeBase.

Definition at line 86 of file kessler94.cpp.

Member Data Documentation

◆ solver_

ChemistrySolver<Size> Kessler94::solver_
protected

chemistry solver

Definition at line 140 of file microphysical_schemes.hpp.


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