Canoe
Comprehensive Atmosphere N' Ocean Engine
Public Types | Public Member Functions | Protected Attributes | List of all members
MicrophysicalScheme< D > Class Template Reference

base class for all microphysical schemes More...

#include <microphysical_schemes.hpp>

Inheritance diagram for MicrophysicalScheme< D >:
[legend]

Public Types

enum  { Size = D }
 
using RealVector = Eigen::Matrix< Real, D, 1 >
 
using RealMatrix = Eigen::Matrix< Real, D, D >
 

Public Member Functions

 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 ()
 
virtual void AssembleReactionMatrix (AirParcel const &air, Real time)=0
 Assemble the reaction matrix. More...
 
virtual void EvolveOneStep (AirParcel *air, Real time, Real dt)=0
 Evolve the air parcel one time step. 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
 

Protected Attributes

Eigen::Matrix< Real, D, 1 > rate_
 rate and jacobian More...
 
Eigen::Matrix< Real, D, D > jacb_
 

Detailed Description

template<int D>
class MicrophysicalScheme< D >

base class for all microphysical schemes

Definition at line 71 of file microphysical_schemes.hpp.

Member Typedef Documentation

◆ RealVector

template<int D>
using MicrophysicalScheme< D >::RealVector = Eigen::Matrix<Real, D, 1>

Definition at line 79 of file microphysical_schemes.hpp.

◆ RealMatrix

template<int D>
using MicrophysicalScheme< D >::RealMatrix = Eigen::Matrix<Real, D, D>

Definition at line 80 of file microphysical_schemes.hpp.

Member Enumeration Documentation

◆ anonymous enum

template<int D>
anonymous enum
Enumerator
Size 

Definition at line 78 of file microphysical_schemes.hpp.

Constructor & Destructor Documentation

◆ MicrophysicalScheme()

template<int D>
MicrophysicalScheme< D >::MicrophysicalScheme ( std::string  name,
YAML::Node const &  node 
)
inline

constructor and destructor

Definition at line 83 of file microphysical_schemes.hpp.

◆ ~MicrophysicalScheme()

template<int D>
virtual MicrophysicalScheme< D >::~MicrophysicalScheme ( )
inlinevirtual

Definition at line 93 of file microphysical_schemes.hpp.

Member Function Documentation

◆ GetRatePtr()

template<int D>
Real const* MicrophysicalScheme< D >::GetRatePtr ( ) const
inline

member functions

Definition at line 96 of file microphysical_schemes.hpp.

◆ GetJacobianPtr()

template<int D>
Real const* MicrophysicalScheme< D >::GetJacobianPtr ( ) const
inline

Definition at line 97 of file microphysical_schemes.hpp.

◆ SetVsedFromConserved()

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

inbound functions

Implements MicrophysicalSchemeBase.

Definition at line 100 of file microphysical_schemes.hpp.

Member Data Documentation

◆ rate_

template<int D>
Eigen::Matrix<Real, D, 1> MicrophysicalScheme< D >::rate_
protected

rate and jacobian

Definition at line 115 of file microphysical_schemes.hpp.

◆ jacb_

template<int D>
Eigen::Matrix<Real, D, D> MicrophysicalScheme< D >::jacb_
protected

Definition at line 116 of file microphysical_schemes.hpp.

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