Base class for microphysics interface. More...

#include <ERF_Microphysics.H>

Inheritance diagram for Microphysics:

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

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

virtual void	Define (const int &, SolverChoice &)=0
	define the microphysics object More...

virtual void	Init (const int &, const amrex::MultiFab &, const amrex::BoxArray &, const amrex::Geometry &, const amrex::Real &, std::unique_ptr< amrex::MultiFab > &, std::unique_ptr< amrex::MultiFab > &)=0
	initialize the microphysics object More...

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

virtual void	Advance (const int &, const amrex::Real &, const int &, const amrex::Real &, const SolverChoice &, amrex::Vector< amrex::Vector< amrex::MultiFab >> &, const amrex::Vector< std::unique_ptr< amrex::MultiFab >> &, const amrex::GpuArray< ERF_BC, AMREX_SPACEDIM *2 > &)=0
	advance microphysics for one time step More...

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

virtual void	Update_State_Vars_Lev (const int &, amrex::MultiFab &, const amrex::MultiFab &)=0
	update ERF state variables from microphysics variables 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 SurfacePrecipAccumulationSources	Get_Surface_Precip_Accumulation_Ptrs (const int &) const
	get scheme-native surface precipitation accumulators and their kg/m^2 conversion factors More...

virtual const SedimentationFlux *	Get_Sed_Flux (const int &) const
	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...

virtual void	Set_Sed_Inflow (const int &, const amrex::MultiFab *)
	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...

virtual amrex::MultiFab *	Get_Qmoist_Ptr (const int &, const int &)=0
	get pointer to a moisture variable More...

virtual int	Get_Qmoist_Size (const int &)=0
	get the number of moisture model variables More...

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

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

virtual int	Get_Qstate_NonMoist_Size ()=0
	get the number of microphysics conserved non-moist (non-water, i.e., other vapor/condensed species) state variables 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...

virtual void	Get_Qmoist_Restart_Vars (int, const SolverChoice &, std::vector< int > &, std::vector< std::string > &) const =0
	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 =0
	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 =0
	Fills in a MultiFab for plotting. More...

virtual void	Set_dzmin (const int lev, const amrex::Real dz_min) const =0
	Import minimum dz at this level. More...

virtual void	Set_Lmask (const int lev, amrex::iMultiFab *lmask) const =0
	Import ERF's land/water mask at this level. More...

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

Detailed Description

Base class for microphysics interface.

Constructor & Destructor Documentation

◆ Microphysics()

Microphysics::Microphysics ( )

inline

Null constructor.

23 { }

◆ ~Microphysics()

virtual Microphysics::~Microphysics ( )

virtualdefault

default destructor

Member Function Documentation

◆ Advance()

virtual void Microphysics::Advance	(	const int &	,
		const amrex::Real &	,
		const int &	,
		const amrex::Real &	,
		const SolverChoice &	,
		amrex::Vector< amrex::Vector< amrex::MultiFab >> &	,
		const amrex::Vector< std::unique_ptr< amrex::MultiFab >> &	,
		const amrex::GpuArray< ERF_BC, AMREX_SPACEDIM *2 > &
	)

pure virtual

advance microphysics for one time step

Implemented in EulerianMicrophysics.

◆ AverageDownMicroVars()

virtual void Microphysics::AverageDownMicroVars ( const int )

inlinevirtual

average down moisture multifabs from finest_level to 0 (AMR coverage); no-op for non-Lagrangian models

66 { }

◆ Define()

virtual void Microphysics::Define	(	const int &	,
		SolverChoice &
	)

pure virtual

define the microphysics object

Implemented in EulerianMicrophysics.

◆ FinishInit()

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

pure virtual

finish initializations steps that require flow variables

Implemented in EulerianMicrophysics.

◆ Get_Qmoist_Ptr()

virtual amrex::MultiFab* Microphysics::Get_Qmoist_Ptr	(	const int &	,
		const int &
	)

pure virtual

get pointer to a moisture variable

Implemented in EulerianMicrophysics.

◆ Get_Qmoist_Restart_Vars()

virtual void Microphysics::Get_Qmoist_Restart_Vars	(	int	,
		const SolverChoice &	,
		std::vector< int > &	,
		std::vector< std::string > &
	)		const

pure virtual

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

Implemented in EulerianMicrophysics.

◆ Get_Qmoist_Size()

virtual int Microphysics::Get_Qmoist_Size ( const int & )

pure virtual

get the number of moisture model variables

Implemented in EulerianMicrophysics.

◆ Get_Qstate_Moist_NumConc_Size()

virtual int Microphysics::Get_Qstate_Moist_NumConc_Size ( )

pure virtual

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

Implemented in EulerianMicrophysics.

◆ Get_Qstate_Moist_Size()

virtual int Microphysics::Get_Qstate_Moist_Size ( )

pure virtual

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

Implemented in EulerianMicrophysics.

Referenced by Get_Qstate_Size().

Here is the caller graph for this function:

◆ Get_Qstate_NonMoist_Size()

virtual int Microphysics::Get_Qstate_NonMoist_Size ( )

pure virtual

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

Implemented in EulerianMicrophysics.

Referenced by Get_Qstate_Size().

Here is the caller graph for this function:

◆ Get_Qstate_Size()

int Microphysics::Get_Qstate_Size ( )

inline

get total number of conserved state variables

     {
         return Get_Qstate_Moist_Size() + Get_Qstate_NonMoist_Size();
     }

Here is the call graph for this function:

◆ Get_Sed_Flux()

virtual const SedimentationFlux* Microphysics::Get_Sed_Flux ( const int & ) const

inlinevirtual

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 in EulerianMicrophysics.

77 { return nullptr; }

◆ Get_Surface_Precip_Accumulation_Ptrs()

virtual SurfacePrecipAccumulationSources Microphysics::Get_Surface_Precip_Accumulation_Ptrs ( const int & ) const

inlinevirtual

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

Reimplemented in EulerianMicrophysics.

     {
         return {};
     }

◆ GetPlotVar()

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

pure virtual

Fills in a MultiFab for plotting.

Implemented in EulerianMicrophysics.

◆ GetPlotVarNames()

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

pure virtual

Returns a list of additional plot variable names.

Implemented in EulerianMicrophysics.

◆ Init()

virtual void Microphysics::Init	(	const int &	,
		const amrex::MultiFab &	,
		const amrex::BoxArray &	,
		const amrex::Geometry &	,
		const amrex::Real &	,
		std::unique_ptr< amrex::MultiFab > &	,
		std::unique_ptr< amrex::MultiFab > &
	)

pure virtual

initialize the microphysics object

Implemented in EulerianMicrophysics.

◆ modelType()

static MoistureModelType Microphysics::modelType ( const MoistureType a_moisture_type )

inlinestatic

query if a specified moisture model is Eulerian or Lagrangian

     {
         if (    (a_moisture_type == MoistureType::SAM)
              || (a_moisture_type == MoistureType::SAM_NoIce)
              || (a_moisture_type == MoistureType::SAM_NoPrecip_NoIce)
              || (a_moisture_type == MoistureType::Morrison)
              || (a_moisture_type == MoistureType::Morrison_NoIce)
              || (a_moisture_type == MoistureType::WSM6)
              || (a_moisture_type == MoistureType::WDM6)
              || (a_moisture_type == MoistureType::Kessler)
              || (a_moisture_type == MoistureType::Kessler_NoRain)
              || (a_moisture_type == MoistureType::SatAdj)
              || (a_moisture_type == MoistureType::MoistNoCondensation)
              || (a_moisture_type == MoistureType::SBM)
              || (a_moisture_type == MoistureType::None) ) {
             return MoistureModelType::Eulerian;
         } else if ( (a_moisture_type == MoistureType::SuperDroplets) ) {
             return MoistureModelType::Lagrangian;
         } else {
             amrex::Abort("Dont know this moisture_type!") ;
             return MoistureModelType::Undefined;
         }
     }

Referenced by ERF::Advance(), ERF::advance_microphysics(), ERF::BuildPlot3DScratch(), EulerianMicrophysics::EulerianMicrophysics(), ERF::InitData_post(), ERF::initializeMicrophysics(), ERF::ReadCheckpointFile(), and ERF::timeStep().

Here is the caller graph for this function:

◆ Qstate_Is_Diagnostic()

virtual bool Microphysics::Qstate_Is_Diagnostic ( int ) const

inlinevirtual

Whether a Q-state offset is a projection rather than host-transported state.

99 { return false; }

◆ Set_dzmin()

virtual void Microphysics::Set_dzmin	(	const int	lev,
		const amrex::Real	dz_min
	)		const

pure virtual

Import minimum dz at this level.

Implemented in EulerianMicrophysics.

◆ Set_Lmask()

virtual void Microphysics::Set_Lmask	(	const int	lev,
		amrex::iMultiFab *	lmask
	)		const

pure virtual

Import ERF's land/water mask at this level.

The mask is held by pointer, not copied, so a mask that is retagged after this call (e.g. buildings set to 2 in init_zphys) is picked up. Callers must re-issue this after any rebuild of lmask_lev, since init_stuff replaces the unique_ptr.

Implemented in EulerianMicrophysics.

◆ Set_Sed_Inflow()

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

inlinevirtual

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 in EulerianMicrophysics.

81 { }

◆ Update_Diagnostic_State_Lev()

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

inlinevirtual

Refresh diagnostic Q projections after particle redistribution, without advancing sources.

63 {}

◆ Update_Micro_Vars_Lev()

virtual void Microphysics::Update_Micro_Vars_Lev	(	const int &	,
		amrex::MultiFab &	,
		const amrex::MultiFab *	base_state = `nullptr`
	)

pure virtual

update microphysics variables from ERF state variables

Implemented in EulerianMicrophysics.

◆ Update_State_Vars_Lev()

virtual void Microphysics::Update_State_Vars_Lev	(	const int &	,
		amrex::MultiFab &	,
		const amrex::MultiFab &
	)

pure virtual

update ERF state variables from microphysics variables

Implemented in EulerianMicrophysics.

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

Source/Microphysics/ERF_Microphysics.H

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Microphysics()

◆ ~Microphysics()

Member Function Documentation

◆ Advance()

◆ AverageDownMicroVars()

◆ 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_Qstate_Size()

◆ Get_Sed_Flux()

◆ Get_Surface_Precip_Accumulation_Ptrs()

◆ GetPlotVar()

◆ GetPlotVarNames()

◆ Init()

◆ modelType()

◆ Qstate_Is_Diagnostic()

◆ Set_dzmin()

◆ Set_Lmask()

◆ Set_Sed_Inflow()

◆ Update_Diagnostic_State_Lev()

◆ Update_Micro_Vars_Lev()

◆ Update_State_Vars_Lev()