Eulerian microphysics interface. More...

#include <ERF_EulerianMicrophysics.H>

Inheritance diagram for EulerianMicrophysics:

Collaboration diagram for EulerianMicrophysics:

Public Member Functions
	EulerianMicrophysics ()
	Null constructor. More...

	~EulerianMicrophysics ()=default
	default destructor More...

	EulerianMicrophysics (const int &nlev, const MoistureType &a_model_type)
	Constructor: create the moisture model. More...

void	Define (const int &lev, SolverChoice &sc) override
	Define the moisture model. More...

void	Init (const int &lev, const amrex::MultiFab &cons_in, const amrex::BoxArray &grids, const amrex::Geometry &geom, const amrex::Real &dt_advance, std::unique_ptr< amrex::MultiFab > &z_phys_nd, std::unique_ptr< amrex::MultiFab > &detJ_cc) override
	Initialize the moisture model. More...

virtual void	FinishInit (const int &, amrex::MultiFab &, const amrex::Vector< std::unique_ptr< amrex::MultiFab >> &) override
	finish initializations steps that require flow variables More...

void	Advance (const int &lev, const amrex::Real &dt_advance, const int &, const amrex::Real &, const SolverChoice &solverChoice, amrex::Vector< amrex::Vector< amrex::MultiFab >> &, const amrex::Vector< std::unique_ptr< amrex::MultiFab >> &, const amrex::GpuArray< ERF_BC, AMREX_SPACEDIM *2 > &) override
	Advance the moisture model for one time step. More...

void	Update_Micro_Vars_Lev (const int &lev, amrex::MultiFab &cons_in, const amrex::MultiFab *base_state=nullptr) override
	update microphysics variables from ERF state variables More...

void	Update_State_Vars_Lev (const int &lev, amrex::MultiFab &cons_in, const amrex::MultiFab &z_phys_nd) override
	update ERF state variables from microphysics variables More...

amrex::MultiFab *	Get_Qmoist_Ptr (const int &lev, const int &varIdx) override
	get pointer to a moisture variable More...

int	Get_Qmoist_Size (const int &) override
	get the number of moisture model variables More...

int	Get_Qstate_Moist_Size () override
	get the number of microphysics conserved moist (water-related) state variables More...

int	Get_Qstate_Moist_NumConc_Size () override
	get the number of microphysics conserved moist (water-related) state variables that are number concentrations More...

int	Get_Qstate_NonMoist_Size () override
	get the number of microphysics conserved non-moist (non-water, i.e., other vapor/condensed species) state variables More...

void	Get_Qmoist_Restart_Vars (const int a_lev, const SolverChoice &a_sc, std::vector< int > &a_idx, std::vector< std::string > &a_names) const override
	get the indices and names of moisture model variables for restart at a given level More...

virtual void	GetPlotVarNames (amrex::Vector< std::string > &a_vec) const override
	Returns a list of additional plot variable names. More...

virtual void	GetPlotVar (const std::string &a_name, amrex::MultiFab &a_mf, const int a_lev) const override
	Fills in a MultiFab for plotting. More...

virtual void	Set_dzmin (const int a_lev, const amrex::Real dz_min) const override
	Populates dz_min in micro model for precipitation. More...

virtual void	Set_Lmask (const int a_lev, amrex::iMultiFab *lmask) const override
	Populates ERF's land/water mask in the micro model. More...

SurfacePrecipAccumulationSources	Get_Surface_Precip_Accumulation_Ptrs (const int &lev) const override
	get scheme-native surface precipitation accumulators and their kg/m^2 conversion factors More...

const SedimentationFlux *	Get_Sed_Flux (const int &lev) const override
	The sedimentation face fluxes of the most recent Advance at a level, or null when the moisture model does not sediment there (see ERF_SedimentationFlux.H) More...

void	Set_Sed_Inflow (const int &lev, const amrex::MultiFab *inflow) override
	Hand the moisture model at a level the inflow through the top of its fine patches for the next Advance, or null (see ERF_SedimentationFlux.H) More...

Public Member Functions inherited from Microphysics
	Microphysics ()
	Null constructor. More...

virtual	~Microphysics ()=default
	default destructor More...

virtual void	Update_Diagnostic_State_Lev (const int &, amrex::MultiFab &, const amrex::MultiFab &)

virtual void	AverageDownMicroVars (const int)
	average down moisture multifabs from finest_level to 0 (AMR coverage); no-op for non-Lagrangian models More...

virtual bool	Qstate_Is_Diagnostic (int) const
	Whether a Q-state offset is a projection rather than host-transported state. More...

int	Get_Qstate_Size ()
	get total number of conserved state variables More...

Protected Member Functions
template<class NewMoistModel >
void	SetModel ()
	Create and set the specified moisture model. More...

Private Attributes
amrex::Vector< std::unique_ptr< NullMoist > >	m_moist_model

Additional Inherited Members
Static Public Member Functions inherited from Microphysics
static MoistureModelType	modelType (const MoistureType a_moisture_type)
	query if a specified moisture model is Eulerian or Lagrangian More...

Detailed Description

Eulerian microphysics interface.

Constructor & Destructor Documentation

◆ EulerianMicrophysics() [1/2]

EulerianMicrophysics::EulerianMicrophysics ( )

inline

Null constructor.

25 { }

◆ ~EulerianMicrophysics()

EulerianMicrophysics::~EulerianMicrophysics ( )

default

default destructor

◆ EulerianMicrophysics() [2/2]

EulerianMicrophysics::EulerianMicrophysics	(	const int &	nlev,
		const MoistureType &	a_model_type
	)

inline

Constructor: create the moisture model.

Parameters

nlev	Number of AMR levels
a_model_type	moisture model

     {
         AMREX_ASSERT( Microphysics::modelType(a_model_type) == MoistureModelType::Eulerian );
         m_moist_model.resize(nlev);
         if (a_model_type == MoistureType::SAM ||
             a_model_type == MoistureType::SAM_NoIce ||
             a_model_type == MoistureType::SAM_NoPrecip_NoIce) {
             SetModel<SAM>();
         } else if (a_model_type == MoistureType::Kessler ||
                    a_model_type == MoistureType::Kessler_NoRain) {
             SetModel<Kessler>();
         } else if (a_model_type == MoistureType::Morrison ||
                    a_model_type == MoistureType::Morrison_NoIce) {
             SetModel<Morrison>();
         } else if (a_model_type == MoistureType::WSM6) {
             SetModel<WSM6>();
         } else if (a_model_type == MoistureType::WDM6) {
             SetModel<WDM6>();
         } else if (a_model_type == MoistureType::SatAdj) {
             SetModel<SatAdj>();
         } else if (a_model_type == MoistureType::MoistNoCondensation) {
             SetModel<MoistNoCondensation>();
         } else if (a_model_type == MoistureType::SBM) {
             SetModel<SBMNullMoist>();
         } else if (a_model_type == MoistureType::None) {
             SetModel<NullMoist>();
         } else {
             amrex::Abort("EulerianMicrophysics: Dont know this moisture_type!") ;
         }
     }

Here is the call graph for this function:

Member Function Documentation

◆ Advance()

void EulerianMicrophysics::Advance	(	const int &	lev,
		const amrex::Real &	dt_advance,
		const int &	,
		const amrex::Real &	,
		const SolverChoice &	solverChoice,
		amrex::Vector< amrex::Vector< amrex::MultiFab >> &	,
		const amrex::Vector< std::unique_ptr< amrex::MultiFab >> &	,
		const amrex::GpuArray< ERF_BC, AMREX_SPACEDIM *2 > &
	)

inlineoverridevirtual

Advance the moisture model for one time step.

Parameters

lev	AMR level
dt_advance	Time step
solverChoice	Solver choice object

Implements Microphysics.

     {
         m_moist_model[lev]->Advance(dt_advance, solverChoice);
     }

◆ Define()

void EulerianMicrophysics::Define	(	const int &	lev,
		SolverChoice &	sc
	)

inlineoverridevirtual

Define the moisture model.

Parameters

lev	AMR level
sc	Solver choice object

Implements Microphysics.

     {
         m_moist_model[lev]->SetCurrentLevel(lev);
         m_moist_model[lev]->Define(sc);
     }

◆ FinishInit()

virtual void EulerianMicrophysics::FinishInit	(	const int &	,
		amrex::MultiFab &	,
		const amrex::Vector< std::unique_ptr< amrex::MultiFab >> &
	)

inlineoverridevirtual

finish initializations steps that require flow variables

Implements Microphysics.

87 { }

◆ Get_Qmoist_Ptr()

amrex::MultiFab* EulerianMicrophysics::Get_Qmoist_Ptr	(	const int &	lev,
		const int &	varIdx
	)

inlineoverridevirtual

get pointer to a moisture variable

Parameters

lev	AMR level
varIdx	moisture variable index

Implements Microphysics.

     {
         return m_moist_model[lev]->Qmoist_Ptr(varIdx);
     }

◆ Get_Qmoist_Restart_Vars()

void EulerianMicrophysics::Get_Qmoist_Restart_Vars	(	const int	a_lev,
		const SolverChoice &	a_sc,
		std::vector< int > &	a_idx,
		std::vector< std::string > &	a_names
	)		const

inlineoverridevirtual

get the indices and names of moisture model variables for restart at a given level

Parameters

a_lev	level
a_sc	Solver choice object
a_idx	indices
a_names	names

Implements Microphysics.

     {
         m_moist_model[a_lev]->Qmoist_Restart_Vars(a_sc, a_idx, a_names);
     }

◆ Get_Qmoist_Size()

int EulerianMicrophysics::Get_Qmoist_Size ( const int & )

inlineoverridevirtual

get the number of moisture model variables

Implements Microphysics.

     {
         return m_moist_model[0]->Qmoist_Size();
     }

◆ Get_Qstate_Moist_NumConc_Size()

int EulerianMicrophysics::Get_Qstate_Moist_NumConc_Size ( )

inlineoverridevirtual

get the number of microphysics conserved moist (water-related) state variables that are number concentrations

Implements Microphysics.

     {
         return m_moist_model[0]->Qstate_Moist_NumConc_Size();
     }

◆ Get_Qstate_Moist_Size()

int EulerianMicrophysics::Get_Qstate_Moist_Size ( )

inlineoverridevirtual

get the number of microphysics conserved moist (water-related) state variables

Implements Microphysics.

     {
         return m_moist_model[0]->Qstate_Moist_Size();
     }

◆ Get_Qstate_NonMoist_Size()

int EulerianMicrophysics::Get_Qstate_NonMoist_Size ( )

inlineoverridevirtual

get the number of microphysics conserved non-moist (non-water, i.e., other vapor/condensed species) state variables

Implements Microphysics.

     {
         return m_moist_model[0]->Qstate_NonMoist_Size();
     }

◆ Get_Sed_Flux()

const SedimentationFlux* EulerianMicrophysics::Get_Sed_Flux ( const int & ) const

inlineoverridevirtual

The sedimentation face fluxes of the most recent Advance at a level, or null when the moisture model does not sediment there (see ERF_SedimentationFlux.H)

Reimplemented from Microphysics.

     {
         return m_moist_model[lev]->Sed_Flux();
     }

◆ Get_Surface_Precip_Accumulation_Ptrs()

SurfacePrecipAccumulationSources EulerianMicrophysics::Get_Surface_Precip_Accumulation_Ptrs ( const int & ) const

inlineoverridevirtual

get scheme-native surface precipitation accumulators and their kg/m^2 conversion factors

Reimplemented from Microphysics.

     {
         return m_moist_model[lev]->Get_Surface_Precip_Accumulation_Ptrs(lev);
     }

◆ GetPlotVar()

virtual void EulerianMicrophysics::GetPlotVar	(	const std::string &	a_name,
		amrex::MultiFab &	a_mf,
		const int	a_lev
	)		const

inlineoverridevirtual

Fills in a MultiFab for plotting.

Implements Microphysics.

     {
         m_moist_model[a_lev]->GetPlotVar(a_name, a_mf);
     }

◆ GetPlotVarNames()

virtual void EulerianMicrophysics::GetPlotVarNames ( amrex::Vector< std::string > & a_vec ) const

inlineoverridevirtual

Returns a list of additional plot variable names.

Implements Microphysics.

     {
         m_moist_model[0]->GetPlotVarNames(a_vec);
     }

◆ Init()

void EulerianMicrophysics::Init	(	const int &	lev,
		const amrex::MultiFab &	cons_in,
		const amrex::BoxArray &	grids,
		const amrex::Geometry &	geom,
		const amrex::Real &	dt_advance,
		std::unique_ptr< amrex::MultiFab > &	z_phys_nd,
		std::unique_ptr< amrex::MultiFab > &	detJ_cc
	)

inlineoverridevirtual

Initialize the moisture model.

Parameters

lev	AMR level
cons_in	Conserved state variables
grids	Grids
geom	Geometry
dt_advance	Time step

Implements Microphysics.

     {
         m_moist_model[lev]->Init(cons_in, grids, geom, dt_advance,
                                  z_phys_nd, detJ_cc);
     }

◆ Set_dzmin()

virtual void EulerianMicrophysics::Set_dzmin	(	const int	a_lev,
		const amrex::Real	dz_min
	)		const

inlineoverridevirtual

Populates dz_min in micro model for precipitation.

Implements Microphysics.

     {
         m_moist_model[a_lev]->Set_dzmin(dz_min);
     }

◆ Set_Lmask()

virtual void EulerianMicrophysics::Set_Lmask	(	const int	a_lev,
		amrex::iMultiFab *	lmask
	)		const

inlineoverridevirtual

Populates ERF's land/water mask in the micro model.

Implements Microphysics.

     {
         m_moist_model[a_lev]->Set_Lmask(lmask);
     }

◆ Set_Sed_Inflow()

void EulerianMicrophysics::Set_Sed_Inflow	(	const int &	,
		const amrex::MultiFab *
	)

inlineoverridevirtual

Hand the moisture model at a level the inflow through the top of its fine patches for the next Advance, or null (see ERF_SedimentationFlux.H)

Reimplemented from Microphysics.

     {
         m_moist_model[lev]->Set_Sed_Inflow(inflow);
     }

◆ SetModel()

template<class NewMoistModel >

void EulerianMicrophysics::SetModel ( )

inlineprotected

Create and set the specified moisture model.

     {
         for (int lev(0); lev<m_moist_model.size(); ++lev) {
             m_moist_model[lev] = std::make_unique<NewMoistModel>();
         }
     }

◆ Update_Micro_Vars_Lev()

void EulerianMicrophysics::Update_Micro_Vars_Lev	(	const int &	lev,
		amrex::MultiFab &	cons_in,
		const amrex::MultiFab *	base_state = `nullptr`
	)

inlineoverridevirtual

update microphysics variables from ERF state variables

Parameters

cons_in AMR level Conserved state variables

Implements Microphysics.

     {
         m_moist_model[lev]->Update_Micro_Vars(cons_in, base_state);
     }

◆ Update_State_Vars_Lev()

void EulerianMicrophysics::Update_State_Vars_Lev	(	const int &	lev,
		amrex::MultiFab &	cons_in,
		const amrex::MultiFab &	z_phys_nd
	)

inlineoverridevirtual

update ERF state variables from microphysics variables

Parameters

lev	AMR level
cons_in	Conserved state variables
z_phys_nd	Nodal terrain heights

Implements Microphysics.

     {
         m_moist_model[lev]->Update_State_Vars(cons_in, z_phys_nd);
     }

Member Data Documentation

◆ m_moist_model

amrex::Vector<std::unique_ptr<NullMoist> > EulerianMicrophysics::m_moist_model

private

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

Source/Microphysics/ERF_EulerianMicrophysics.H

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ EulerianMicrophysics() [1/2]

◆ ~EulerianMicrophysics()

◆ EulerianMicrophysics() [2/2]

Member Function Documentation

◆ Advance()

◆ Define()

◆ FinishInit()

◆ Get_Qmoist_Ptr()

◆ Get_Qmoist_Restart_Vars()

◆ Get_Qmoist_Size()

◆ Get_Qstate_Moist_NumConc_Size()

◆ Get_Qstate_Moist_Size()

◆ Get_Qstate_NonMoist_Size()

◆ Get_Sed_Flux()

◆ Get_Surface_Precip_Accumulation_Ptrs()

◆ GetPlotVar()

◆ GetPlotVarNames()

◆ Init()

◆ Set_dzmin()

◆ Set_Lmask()

◆ Set_Sed_Inflow()

◆ SetModel()

◆ Update_Micro_Vars_Lev()

◆ Update_State_Vars_Lev()

Member Data Documentation

◆ m_moist_model