NullSurf Class Reference

#include <ERF_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 int &, const amrex::MultiFab &, const amrex::Geometry &, const amrex::Real &)
virtual void	Advance (const amrex::Real &)
virtual void	Advance_With_State (const int &, amrex::MultiFab &, amrex::MultiFab &, amrex::MultiFab &, amrex::MultiFab *, amrex::MultiFab *, const amrex::Real &, const int &)
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 int	Lsm_Flux_Size ()
virtual std::string	Lsm_DataName (const int &)
virtual std::string	Lsm_FluxName (const int &)
virtual int	Lsm_DataIndex (std::string)
virtual int	Lsm_FluxIndex (std::string)

Private Attributes
int	m_lsm_size = 1
amrex::Geometry	m_lsm_geom
std::string	dataname = " "
std::string	fluxname = " "

Constructor & Destructor Documentation

NullSurf()

NullSurf::NullSurf ( )

inline

{}

~NullSurf()

virtual NullSurf::~NullSurf ( )

virtualdefault

Member Function Documentation

Advance()

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

inlinevirtual

Reimplemented in SLM, and MM5.

{ }

Advance_With_State()

virtual void NullSurf::Advance_With_State ( const int &  , amrex::MultiFab &  , amrex::MultiFab &  , amrex::MultiFab &  , amrex::MultiFab *  , amrex::MultiFab *  , const amrex::Real &  , const int &    )

inlinevirtual

Reimplemented in NOAHMP.

                                      { }

Copy_Micro_to_State()

virtual void NullSurf::Copy_Micro_to_State ( amrex::MultiFab &  )

inlinevirtual

{ }

Copy_State_to_Micro()

virtual void NullSurf::Copy_State_to_Micro ( const amrex::MultiFab &  )

inlinevirtual

{ }

Define()

virtual void NullSurf::Define ( SolverChoice &  )

inlinevirtual

Reimplemented in SLM, NOAHMP, and MM5.

{ }

Init()

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

inlinevirtual

Reimplemented in NOAHMP, SLM, and MM5.

                                   { }

Lsm_Data_Ptr()

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

inlinevirtual

Reimplemented in SLM, NOAHMP, and MM5.

{ return nullptr; }

Lsm_Data_Size()

virtual int NullSurf::Lsm_Data_Size ( )

inlinevirtual

Reimplemented in SLM, NOAHMP, and MM5.

{ return NullSurf::m_lsm_size; }

Lsm_DataIndex()

virtual int NullSurf::Lsm_DataIndex ( std::string  )

inlinevirtual

Reimplemented in NOAHMP.

    {
        return (-1);
    }

Lsm_DataName()

virtual std::string NullSurf::Lsm_DataName ( const int &  )

inlinevirtual

Reimplemented in SLM, NOAHMP, and MM5.

    {
        return dataname;
    }

Lsm_Flux_Ptr()

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

inlinevirtual

Reimplemented in SLM, NOAHMP, and MM5.

{ return nullptr; }

Lsm_Flux_Size()

virtual int NullSurf::Lsm_Flux_Size ( )

inlinevirtual

Reimplemented in NOAHMP.

{ return NullSurf::m_lsm_size; }

Lsm_FluxIndex()

virtual int NullSurf::Lsm_FluxIndex ( std::string  )

inlinevirtual

Reimplemented in NOAHMP.

    {
        return (-1);
    }

Lsm_FluxName()

virtual std::string NullSurf::Lsm_FluxName ( const int &  )

inlinevirtual

Reimplemented in NOAHMP.

    {
        return fluxname;
    }

Lsm_Geom()

virtual amrex::Geometry NullSurf::Lsm_Geom ( )

inlinevirtual

Reimplemented in SLM, NOAHMP, and MM5.

{ return m_lsm_geom; }

Update_Micro_Vars()

virtual void NullSurf::Update_Micro_Vars ( amrex::MultiFab &  )

inlinevirtual

{ }

Update_State_Vars()

virtual void NullSurf::Update_State_Vars ( amrex::MultiFab &  )

inlinevirtual

{ }

Member Data Documentation

dataname

std::string NullSurf::dataname = " "

private

Referenced by Lsm_DataName().

fluxname

std::string NullSurf::fluxname = " "

private

Referenced by Lsm_FluxName().

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(), and Lsm_Flux_Size().

---

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

• Source/LandSurfaceModel/Null/ERF_NullSurf.H