MicrophysicalSchemeBase Class Reference

virtual base class for all microphysical schemes More...

#include <microphysical_schemes.hpp>

Inheritance diagram for MicrophysicalSchemeBase:

Public Member Functions
	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...
virtual void	SetVsedFromConserved (AthenaArray< Real > vsed[3], Hydro const *phydro, int kl, int ku, int jl, int ju, int il, int iu)=0
	Set the sedimentation velocity from the conserved variables. More...
Public Member Functions inherited from NamedGroup
	NamedGroup (std::string name)
virtual	~NamedGroup ()
std::string	GetName () const

Detailed Description

virtual base class for all microphysical schemes

Definition at line 31 of file microphysical_schemes.hpp.

Constructor & Destructor Documentation

MicrophysicalSchemeBase()

MicrophysicalSchemeBase::MicrophysicalSchemeBase ( std::string  name )

inline

constructor and destructor

Definition at line 33 of file microphysical_schemes.hpp.

~MicrophysicalSchemeBase()

virtual MicrophysicalSchemeBase::~MicrophysicalSchemeBase ( )

inlinevirtual

Definition at line 34 of file microphysical_schemes.hpp.

Member Function Documentation

AssembleReactionMatrix()

virtual void MicrophysicalSchemeBase::AssembleReactionMatrix ( AirParcel const &  air, Real  time  )

pure virtual

Assemble the reaction matrix.

functions

Parameters

[in]	air	air parcel provides data to populate the reaction matrix
[in]	time	current simulation time

Implemented in Kessler94.

EvolveOneStep()

virtual void MicrophysicalSchemeBase::EvolveOneStep ( AirParcel *  air, Real  time, Real  dt  )

pure virtual

Evolve the air parcel one time step.

Parameters

[in,out]	air	air parcel to be evolved
[in]	time	current simulation time
[in]	dt	time step

Implemented in Kessler94.

SetVsedFromConserved()

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

pure virtual

Set the sedimentation velocity from the conserved variables.

inbound functions

Parameters

[in,out]	vsed	sedimentation velocity
[in]	phydro	root-level hydrodynamic class

Implemented in Kessler94, MicrophysicalScheme< D >, and MicrophysicalScheme< 3 >.

---

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

• /home/cli/canoe/src/microphysics/microphysical_schemes.hpp