Canoe
Comprehensive Atmosphere N' Ocean Engine
Microphysics Class Reference

root-level management class for microphysics More...

#include <microphysics.hpp>

Public Member Functions

 Microphysics (MeshBlock *pmb, ParameterInput *pin)
 constructor and destructor More...
 
 ~Microphysics ()
 
size_t GetNumSystems () const
 functions More...
 
std::shared_ptr< MicrophysicalSchemeBaseGetSystem (int i) const
 
void EvolveSystems (AirColumn &ac, Real time, Real dt)
 Evolve all microphysical systems. More...
 
void SetVsedFromConserved (Hydro const *phydro)
 inbound functions More...
 

Public Attributes

AthenaArray< Real > w
 primitive variables: mass fraction [kg/kg] More...
 
AthenaArray< Real > u
 conserved variables: mass concentration [kg/m^3] More...
 
AthenaArray< Real > vsedf [3]
 sedimentation velocity at cell interface [m/s] More...
 
AthenaArray< Real > mass_flux [3]
 mass flux of the dry fluid [kg/m^2/s] More...
 

Static Public Attributes

static const std::string input_key = "microphysics_config"
 microphysics input key in the input file [microphysics_config] More...
 

Protected Attributes

AthenaArray< Real > vsed_ [3]
 sedimentation velocity at cell center [m/s] More...
 
std::vector< std::shared_ptr< MicrophysicalSchemeBase > > systems_
 pointers of microphysical systems More...
 

Private Attributes

MeshBlock const * pmy_block_
 meshblock pointer More...
 

Detailed Description

root-level management class for microphysics

Definition at line 23 of file microphysics.hpp.

Constructor & Destructor Documentation

◆ Microphysics()

Microphysics::Microphysics ( MeshBlock *  pmb,
ParameterInput *  pin 
)

constructor and destructor

Definition at line 29 of file microphysics.cpp.

◆ ~Microphysics()

Microphysics::~Microphysics ( )

Definition at line 67 of file microphysics.cpp.

Member Function Documentation

◆ GetNumSystems()

size_t Microphysics::GetNumSystems ( ) const
inline

functions

Definition at line 49 of file microphysics.hpp.

◆ GetSystem()

std::shared_ptr<MicrophysicalSchemeBase> Microphysics::GetSystem ( int  i) const
inline

Definition at line 50 of file microphysics.hpp.

◆ EvolveSystems()

void Microphysics::EvolveSystems ( AirColumn ac,
Real  time,
Real  dt 
)

Evolve all microphysical systems.

Parameters
[in,out]acair column to be evolved
[in]timecurrent simulation time
[in]dttime step

Definition at line 77 of file microphysics.cpp.

◆ SetVsedFromConserved()

void Microphysics::SetVsedFromConserved ( Hydro const *  phydro)

inbound functions

Definition at line 85 of file microphysics.cpp.

Member Data Documentation

◆ input_key

const std::string Microphysics::input_key = "microphysics_config"
static

microphysics input key in the input file [microphysics_config]

public access members

Todo:
(CLI) track cloud temperature and momentum tem, v1, v2, v3 enum { NCLOUD_HYDRO = 4 };

Definition at line 30 of file microphysics.hpp.

◆ w

AthenaArray<Real> Microphysics::w

primitive variables: mass fraction [kg/kg]

Definition at line 33 of file microphysics.hpp.

◆ u

AthenaArray<Real> Microphysics::u

conserved variables: mass concentration [kg/m^3]

Definition at line 36 of file microphysics.hpp.

◆ vsedf

AthenaArray<Real> Microphysics::vsedf[3]

sedimentation velocity at cell interface [m/s]

Definition at line 39 of file microphysics.hpp.

◆ mass_flux

AthenaArray<Real> Microphysics::mass_flux[3]

mass flux of the dry fluid [kg/m^2/s]

Definition at line 42 of file microphysics.hpp.

◆ vsed_

AthenaArray<Real> Microphysics::vsed_[3]
protected

sedimentation velocity at cell center [m/s]

Definition at line 67 of file microphysics.hpp.

◆ systems_

std::vector<std::shared_ptr<MicrophysicalSchemeBase> > Microphysics::systems_
protected

pointers of microphysical systems

Definition at line 70 of file microphysics.hpp.

◆ pmy_block_

MeshBlock const* Microphysics::pmy_block_
private

meshblock pointer

Definition at line 74 of file microphysics.hpp.


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