ERF
Energy Research and Forecasting: An Atmospheric Modeling Code
NullMoist Class Reference

#include <ERF_NullMoist.H>

Inheritance diagram for NullMoist:
Collaboration diagram for NullMoist:

Public Member Functions

 NullMoist ()
 
virtual ~NullMoist ()=default
 
virtual void Define (SolverChoice &)
 
virtual void Init (const amrex::MultiFab &, const amrex::BoxArray &, const amrex::Geometry &, const amrex::Real &, std::unique_ptr< amrex::MultiFab > &, std::unique_ptr< amrex::MultiFab > &)
 
virtual void Advance (const amrex::Real &, const SolverChoice &)
 
virtual void Update_Micro_Vars (amrex::MultiFab &)
 
virtual void Update_Micro_Vars (amrex::MultiFab &cons_in, const amrex::MultiFab *)
 
virtual void Update_State_Vars (amrex::MultiFab &, const amrex::MultiFab &)
 
virtual void Copy_State_to_Micro (const amrex::MultiFab &)
 
virtual void Copy_Micro_to_State (amrex::MultiFab &)
 
virtual amrex::MultiFab * Qmoist_Ptr (const int &)
 
virtual int Qmoist_Size ()
 
virtual int Qstate_Moist_Size ()
 
virtual int Qstate_Moist_NumConc_Size ()
 
virtual int Qstate_NonMoist_Size ()
 
virtual void Qmoist_Restart_Vars (const SolverChoice &, std::vector< int > &a_idx, std::vector< std::string > &a_names) const
 
virtual void GetPlotVarNames (amrex::Vector< std::string > &a_vec) const
 
virtual void GetPlotVar (const std::string &, amrex::MultiFab &) const
 
virtual void GetPlotVar (const std::string &a_name, amrex::MultiFab &a_mf, const int) const
 
virtual void SetCurrentLevel (const int &)
 
virtual void InitLevel (const int, const amrex::MultiFab &)
 
virtual int getDiagnosticsInterval () const
 
virtual void Set_dzmin (const amrex::Real)
 
virtual SurfacePrecipAccumulationSources Get_Surface_Precip_Accumulation_Ptrs (const int &) const
 
virtual void Set_RealWidth (const int)
 

Private Attributes

int m_qmoist_size = 0
 
int m_qstate_moist_size = 0
 
int m_qstate_moist_numconc_size = 0
 
int m_qstate_nonmoist_size = 0
 

Constructor & Destructor Documentation

◆ NullMoist()

NullMoist::NullMoist ( )
inline
12 {}

◆ ~NullMoist()

virtual NullMoist::~NullMoist ( )
virtualdefault

Member Function Documentation

◆ Advance()

virtual void NullMoist::Advance ( const amrex::Real ,
const SolverChoice  
)
inlinevirtual

Reimplemented in WSM6, SatAdj, Kessler, SAM, and Morrison.

31  { }

◆ Copy_Micro_to_State()

virtual void NullMoist::Copy_Micro_to_State ( amrex::MultiFab &  )
inlinevirtual

Reimplemented in WSM6, SatAdj, SAM, Morrison, and Kessler.

57 { }

◆ Copy_State_to_Micro()

virtual void NullMoist::Copy_State_to_Micro ( const amrex::MultiFab &  )
inlinevirtual

Reimplemented in WSM6, SatAdj, SAM, Morrison, and Kessler.

53 { }

◆ Define()

virtual void NullMoist::Define ( SolverChoice )
inlinevirtual

Reimplemented in WSM6, SatAdj, SAM, Morrison, and Kessler.

18 { }

◆ Get_Surface_Precip_Accumulation_Ptrs()

virtual SurfacePrecipAccumulationSources NullMoist::Get_Surface_Precip_Accumulation_Ptrs ( const int &  ) const
inlinevirtual

Reimplemented in WSM6, SAM, Morrison, and Kessler.

130  {
131  return {};
132  }

◆ getDiagnosticsInterval()

virtual int NullMoist::getDiagnosticsInterval ( ) const
inlinevirtual
121 { return 0; }

◆ GetPlotVar() [1/2]

virtual void NullMoist::GetPlotVar ( const std::string &  ,
amrex::MultiFab &   
) const
inlinevirtual

Reimplemented in Morrison.

98  {
99  amrex::Abort("NullMoist::GetPlotVar() should never be called.");
100  }

Referenced by GetPlotVar().

Here is the caller graph for this function:

◆ GetPlotVar() [2/2]

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

Reimplemented in Morrison.

107  {
108  GetPlotVar(a_name, a_mf);
109  }
virtual void GetPlotVar(const std::string &, amrex::MultiFab &) const
Definition: ERF_NullMoist.H:96
Here is the call graph for this function:

◆ GetPlotVarNames()

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

Reimplemented in Morrison.

90  {
91  a_vec.resize(0);
92  }

◆ Init()

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

Reimplemented in WSM6, SAM, Morrison, Kessler, and SatAdj.

26  { }

◆ InitLevel()

virtual void NullMoist::InitLevel ( const int  ,
const amrex::MultiFab &   
)
inlinevirtual
117 {}

◆ Qmoist_Ptr()

virtual amrex::MultiFab* NullMoist::Qmoist_Ptr ( const int &  )
inlinevirtual

Reimplemented in WSM6, SatAdj, SAM, Morrison, and Kessler.

61 { return nullptr; }

◆ Qmoist_Restart_Vars()

virtual void NullMoist::Qmoist_Restart_Vars ( const SolverChoice ,
std::vector< int > &  a_idx,
std::vector< std::string > &  a_names 
) const
inlinevirtual

Reimplemented in WSM6, SatAdj, SAM, Morrison, and Kessler.

82  {
83  a_idx.clear();
84  a_names.clear();
85  }

◆ Qmoist_Size()

virtual int NullMoist::Qmoist_Size ( )
inlinevirtual

Reimplemented in WSM6, SatAdj, SAM, Morrison, and Kessler.

65 { return NullMoist::m_qmoist_size; }
int m_qmoist_size
Definition: ERF_NullMoist.H:144

◆ Qstate_Moist_NumConc_Size()

virtual int NullMoist::Qstate_Moist_NumConc_Size ( )
inlinevirtual

Reimplemented in WSM6, SatAdj, SAM, Morrison, MoistNoCondensation, and Kessler.

int m_qstate_moist_numconc_size
Definition: ERF_NullMoist.H:146

◆ Qstate_Moist_Size()

virtual int NullMoist::Qstate_Moist_Size ( )
inlinevirtual

Reimplemented in WSM6, SatAdj, SAM, Morrison, MoistNoCondensation, and Kessler.

int m_qstate_moist_size
Definition: ERF_NullMoist.H:145

◆ Qstate_NonMoist_Size()

virtual int NullMoist::Qstate_NonMoist_Size ( )
inlinevirtual
int m_qstate_nonmoist_size
Definition: ERF_NullMoist.H:147

◆ Set_dzmin()

virtual void NullMoist::Set_dzmin ( const amrex::Real  )
inlinevirtual

Reimplemented in WSM6, SAM, Morrison, and Kessler.

125 { }

◆ Set_RealWidth()

virtual void NullMoist::Set_RealWidth ( const int  )
inlinevirtual
140 { }

◆ SetCurrentLevel()

virtual void NullMoist::SetCurrentLevel ( const int &  )
inlinevirtual
113 {}

◆ Update_Micro_Vars() [1/2]

virtual void NullMoist::Update_Micro_Vars ( amrex::MultiFab &  )
inlinevirtual

Reimplemented in WSM6, SatAdj, SAM, Morrison, and Kessler.

35 { }

Referenced by Update_Micro_Vars().

Here is the caller graph for this function:

◆ Update_Micro_Vars() [2/2]

virtual void NullMoist::Update_Micro_Vars ( amrex::MultiFab &  cons_in,
const amrex::MultiFab *   
)
inlinevirtual

Reimplemented in SatAdj.

42  {
43  Update_Micro_Vars(cons_in);
44  }
virtual void Update_Micro_Vars(amrex::MultiFab &)
Definition: ERF_NullMoist.H:35
Here is the call graph for this function:

◆ Update_State_Vars()

virtual void NullMoist::Update_State_Vars ( amrex::MultiFab &  ,
const amrex::MultiFab &   
)
inlinevirtual

Reimplemented in WSM6, SatAdj, SAM, Morrison, and Kessler.

49  { }

Member Data Documentation

◆ m_qmoist_size

int NullMoist::m_qmoist_size = 0
private

Referenced by Qmoist_Size().

◆ m_qstate_moist_numconc_size

int NullMoist::m_qstate_moist_numconc_size = 0
private

◆ m_qstate_moist_size

int NullMoist::m_qstate_moist_size = 0
private

Referenced by Qstate_Moist_Size().

◆ m_qstate_nonmoist_size

int NullMoist::m_qstate_nonmoist_size = 0
private

Referenced by Qstate_NonMoist_Size().


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