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

#include <NullSurf.H>

Inheritance diagram for NullSurf:
Collaboration diagram for NullSurf:

Public Member Functions

 NullSurf ()
 
virtual ~NullSurf ()=default
 
virtual void Define (SolverChoice &)
 
virtual void Init (const amrex::MultiFab &, const amrex::Geometry &, const amrex::Real &)
 
virtual void Advance (const amrex::Real &)
 
virtual void Update_Micro_Vars (amrex::MultiFab &)
 
virtual void Update_State_Vars (amrex::MultiFab &)
 
virtual void Copy_State_to_Micro (const amrex::MultiFab &)
 
virtual void Copy_Micro_to_State (amrex::MultiFab &)
 
virtual amrex::MultiFab * Lsm_Data_Ptr (const int &)
 
virtual amrex::MultiFab * Lsm_Flux_Ptr (const int &)
 
virtual amrex::Geometry Lsm_Geom ()
 
virtual int Lsm_Data_Size ()
 
virtual std::string Lsm_VarName (const int &)
 

Private Attributes

int m_lsm_size = 1
 
amrex::Geometry m_lsm_geom
 
std::string varname = " "
 

Constructor & Destructor Documentation

◆ NullSurf()

NullSurf::NullSurf ( )
inline
11 {}

◆ ~NullSurf()

virtual NullSurf::~NullSurf ( )
virtualdefault

Member Function Documentation

◆ Advance()

virtual void NullSurf::Advance ( const amrex::Real &  )
inlinevirtual

Reimplemented in SLM, and MM5.

26 { }

◆ Copy_Micro_to_State()

virtual void NullSurf::Copy_Micro_to_State ( amrex::MultiFab &  )
inlinevirtual
42 { }

◆ Copy_State_to_Micro()

virtual void NullSurf::Copy_State_to_Micro ( const amrex::MultiFab &  )
inlinevirtual
38 { }

◆ Define()

virtual void NullSurf::Define ( SolverChoice )
inlinevirtual

Reimplemented in SLM, and MM5.

17 { }

◆ Init()

virtual void NullSurf::Init ( const amrex::MultiFab &  ,
const amrex::Geometry &  ,
const amrex::Real &   
)
inlinevirtual

Reimplemented in SLM, and MM5.

22  { }

◆ Lsm_Data_Ptr()

virtual amrex::MultiFab* NullSurf::Lsm_Data_Ptr ( const int &  )
inlinevirtual

Reimplemented in SLM, and MM5.

46 { return nullptr; }

◆ Lsm_Data_Size()

virtual int NullSurf::Lsm_Data_Size ( )
inlinevirtual

Reimplemented in SLM, and MM5.

58 { return NullSurf::m_lsm_size; }
int m_lsm_size
Definition: NullSurf.H:68

◆ Lsm_Flux_Ptr()

virtual amrex::MultiFab* NullSurf::Lsm_Flux_Ptr ( const int &  )
inlinevirtual

Reimplemented in SLM, and MM5.

50 { return nullptr; }

◆ Lsm_Geom()

virtual amrex::Geometry NullSurf::Lsm_Geom ( )
inlinevirtual

Reimplemented in SLM, and MM5.

54 { return m_lsm_geom; }
amrex::Geometry m_lsm_geom
Definition: NullSurf.H:69

◆ Lsm_VarName()

virtual std::string NullSurf::Lsm_VarName ( const int &  )
inlinevirtual

Reimplemented in SLM, and MM5.

63  {
64  return varname;
65  }
std::string varname
Definition: NullSurf.H:70

◆ Update_Micro_Vars()

virtual void NullSurf::Update_Micro_Vars ( amrex::MultiFab &  )
inlinevirtual
30 { }

◆ Update_State_Vars()

virtual void NullSurf::Update_State_Vars ( amrex::MultiFab &  )
inlinevirtual
34 { }

Member Data Documentation

◆ m_lsm_geom

amrex::Geometry NullSurf::m_lsm_geom
private

Referenced by Lsm_Geom().

◆ m_lsm_size

int NullSurf::m_lsm_size = 1
private

Referenced by Lsm_Data_Size().

◆ varname

std::string NullSurf::varname = " "
private

Referenced by Lsm_VarName().


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