NullUrban Class Reference

#include <ERF_NullUrban.H>

Collaboration diagram for NullUrban:

Public Member Functions
	NullUrban ()=default
virtual	~NullUrban ()=default
virtual void	Define (SolverChoice &)
	Defines a no-op urban model. More...
virtual void	Init (const amrex::MultiFab &, const amrex::MultiFab &, const amrex::MultiFab &, const amrex::Geometry &, const amrex::Real &, const amrex::MultiFab &, const amrex::iMultiFab &, const amrex::MultiFab &)
	Initializes a no-op urban model. More...
virtual void	Advance (const amrex::Real &, const amrex::Real &, const amrex::Real &, const amrex::Geometry &, const amrex::MultiFab *, amrex::MultiFab &, const amrex::Real &)
	Advances a no-op urban model. More...
virtual void	Update_Urban_Vars (amrex::MultiFab &, amrex::MultiFab &, amrex::MultiFab &)
	Updates no urban coupling fields. More...
virtual void	Update_State_Vars (amrex::MultiFab &)
	Updates no atmospheric state fields. More...
virtual amrex::MultiFab *	Urban_Data_Ptr (const int &)
	Returns no urban data field. More...
virtual amrex::MultiFab *	Urban_Flux_Ptr (const int &)
	Returns no urban flux field. More...
virtual amrex::Geometry	Urban_Geom ()
	Returns the null-model geometry. More...
virtual int	Urban_Data_Size ()
	Returns the number of null-model fields. More...
virtual std::string	Urban_DataName (const int &)
	Returns a null-model field name. More...
virtual int	Urban_DataIndex (const std::string &)
	Returns no field index. More...
virtual void	set_flux_inputs (const amrex::Real &)
	Accepts no flux input. More...
virtual void	set_terrain_inputs (const amrex::Vector< std::unique_ptr< amrex::MultiFab >> &, const amrex::Vector< std::unique_ptr< amrex::iMultiFab >> &, const amrex::Vector< std::unique_ptr< amrex::iMultiFab >> &, const amrex::Vector< std::unique_ptr< amrex::MultiFab >> &, amrex::MultiFab *, amrex::MultiFab *)
	Accepts no terrain input. More...
virtual void	WriteCheckpoint (const int &, const std::string &) const
	Writes no checkpoint state. More...
virtual void	ReadCheckpoint (const int &, const std::string &)
	Reads no checkpoint state. More...

Private Attributes
int	m_urban_size = 1
amrex::Geometry	m_urban_geom
std::string	varname = " "

Constructor & Destructor Documentation

NullUrban()

NullUrban::NullUrban ( )

default

~NullUrban()

virtual NullUrban::~NullUrban ( )

virtualdefault

Member Function Documentation

Advance()

virtual void NullUrban::Advance ( const amrex::Real &  , const amrex::Real &  , const amrex::Real &  , const amrex::Geometry &  , const amrex::MultiFab *  , amrex::MultiFab &  , const amrex::Real &    )

inlinevirtual

Advances a no-op urban model.

                                              { }

Define()

virtual void NullUrban::Define ( SolverChoice &  )

inlinevirtual

Defines a no-op urban model.

{ }

Init()

virtual void NullUrban::Init ( const amrex::MultiFab &  , const amrex::MultiFab &  , const amrex::MultiFab &  , const amrex::Geometry &  , const amrex::Real &  , const amrex::MultiFab &  , const amrex::iMultiFab &  , const amrex::MultiFab &    )

inlinevirtual

Initializes a no-op urban model.

                                               { }

ReadCheckpoint()

virtual void NullUrban::ReadCheckpoint ( const int &  , const std::string &    )

inlinevirtual

Reads no checkpoint state.

{ }

set_flux_inputs()

virtual void NullUrban::set_flux_inputs ( const amrex::Real &  )

inlinevirtual

Accepts no flux input.

{ }

set_terrain_inputs()

virtual void NullUrban::set_terrain_inputs ( const amrex::Vector< std::unique_ptr< amrex::MultiFab >> &  , const amrex::Vector< std::unique_ptr< amrex::iMultiFab >> &  , const amrex::Vector< std::unique_ptr< amrex::iMultiFab >> &  , const amrex::Vector< std::unique_ptr< amrex::MultiFab >> &  , amrex::MultiFab *  , amrex::MultiFab *    )

inlinevirtual

Accepts no terrain input.

                                            { }

Update_State_Vars()

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

inlinevirtual

Updates no atmospheric state fields.

{ }

Update_Urban_Vars()

virtual void NullUrban::Update_Urban_Vars ( amrex::MultiFab &  , amrex::MultiFab &  , amrex::MultiFab &    )

inlinevirtual

Updates no urban coupling fields.

                                                      { }

Urban_Data_Ptr()

virtual amrex::MultiFab* NullUrban::Urban_Data_Ptr ( const int &  )

inlinevirtual

Returns no urban data field.

{ return nullptr; }

Urban_Data_Size()

virtual int NullUrban::Urban_Data_Size ( )

inlinevirtual

Returns the number of null-model fields.

{ return m_urban_size; }

Urban_DataIndex()

virtual int NullUrban::Urban_DataIndex ( const std::string &  )

inlinevirtual

Returns no field index.

{ return -1; }

Urban_DataName()

virtual std::string NullUrban::Urban_DataName ( const int &  )

inlinevirtual

Returns a null-model field name.

{ return varname; }

Urban_Flux_Ptr()

virtual amrex::MultiFab* NullUrban::Urban_Flux_Ptr ( const int &  )

inlinevirtual

Returns no urban flux field.

{ return nullptr; }

Urban_Geom()

virtual amrex::Geometry NullUrban::Urban_Geom ( )

inlinevirtual

Returns the null-model geometry.

{ return m_urban_geom; }

WriteCheckpoint()

virtual void NullUrban::WriteCheckpoint ( const int &  , const std::string &    ) const

inlinevirtual

Writes no checkpoint state.

{ }

Member Data Documentation

m_urban_geom

amrex::Geometry NullUrban::m_urban_geom

private

Referenced by Urban_Geom().

m_urban_size

int NullUrban::m_urban_size = 1

private

Referenced by Urban_Data_Size().

varname

std::string NullUrban::varname = " "

private

Referenced by Urban_DataName().

---

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

• Source/UrbanModel/Null/ERF_NullUrban.H