Wrapper class for managing urban models across AMR levels. More...

#include <ERF_Urban.H>

Collaboration diagram for Urban:

[legend]

Public Member Functions
	Urban ()=default

	~Urban ()=default

void	ReSize (const int &nlev, const amrex::Vector< int > &active_levs)
	Resizes urban-model storage and records active AMR levels. More...

template<class NewUrbanModel >
void	SetModel ()
	Instantiates an urban model on each active AMR level. More...

void	Define (const int &lev, SolverChoice &sc)
	Defines the urban model on an active level. More...

void	Init (const int &lev, const amrex::MultiFab &cons_in, const amrex::MultiFab &u_in, const amrex::MultiFab &v_in, const amrex::Geometry &geom, const amrex::Real &dt_advance, const amrex::MultiFab &z_phys_nd, const amrex::iMultiFab &land_type, const amrex::MultiFab &urb_frac)
	Initializes the urban model on an active level. More...

void	Advance (const int &lev, const amrex::Real &dt_advance, const amrex::Real &time, const amrex::Real &start_time, const amrex::Geometry &geom, const amrex::MultiFab *z_phys_nd, amrex::MultiFab &eddyDiffs_lev, const amrex::Real &calday)
	Advances the urban model on an active level. More...

void	Update_Urban_Vars_Lev (const int &lev, amrex::MultiFab &cons_in, amrex::MultiFab &u_in, amrex::MultiFab &v_in)
	Updates coupled urban fields on an active level. More...

void	Update_State_Vars_Lev (const int &lev, amrex::MultiFab &cons_in)
	Updates atmospheric state fields on an active level. More...

amrex::MultiFab *	Get_Data_Ptr (const int &lev, const int &varIdx)
	Returns a model data field, or null for an inactive level. More...

amrex::MultiFab *	Get_Flux_Ptr (const int &lev, const int &varIdx)
	Returns a model flux field, or null for an inactive level. More...

amrex::Geometry	Get_Urban_Geom (const int &lev)
	Returns the urban-model geometry for a level. More...

int	Get_Data_Size ()
	Returns the number of model data fields. More...

std::string	Get_DataName (const int &varIdx)
	Returns a model data-field name. More...

int	Get_DataIdx (const int &lev, const std::string &varname)
	Returns a model data-field index. More...

void	set_urban_flux_inputs (const int &lev, const amrex::Real &declin)
	Sets flux inputs on an active level. More...

void	set_urban_terrain_inputs (const int &lev, const amrex::Vector< amrex::Vector< std::unique_ptr< amrex::MultiFab >>> &tsk_in, const amrex::Vector< amrex::Vector< std::unique_ptr< amrex::iMultiFab >>> &lmask_in, const amrex::Vector< amrex::Vector< std::unique_ptr< amrex::iMultiFab >>> &land_type_in, const amrex::Vector< amrex::Vector< std::unique_ptr< amrex::MultiFab >>> &urb_frac_in, amrex::MultiFab lat_in, amrex::MultiFab lon_in)
	Sets terrain inputs on an active level. More...

Private Attributes
amrex::Vector< std::unique_ptr< NullUrban > >	m_urban_model

amrex::Vector< int >	m_active_levs

int	m_first_active_lev = -1

Detailed Description

Wrapper class for managing urban models across AMR levels.

Constructor & Destructor Documentation

◆ Urban()

Urban::Urban ( )

default

◆ ~Urban()

Urban::~Urban ( )

default

Member Function Documentation

◆ Advance()

void Urban::Advance	(	const int &	lev,
		const amrex::Real &	dt_advance,
		const amrex::Real &	time,
		const amrex::Real &	start_time,
		const amrex::Geometry &	geom,
		const amrex::MultiFab *	z_phys_nd,
		amrex::MultiFab &	eddyDiffs_lev,
		const amrex::Real &	calday
	)

inline

Advances the urban model on an active level.

     {
         if (m_active_levs[lev] == 1) {
             m_urban_model[lev]->Advance(dt_advance, time, start_time, geom,
                                         z_phys_nd, eddyDiffs_lev, calday);
         }
     }

◆ Define()

void Urban::Define	(	const int &	lev,
		SolverChoice &	sc
	)

inline

Defines the urban model on an active level.

     {
         if (m_active_levs[lev] == 1) {
             m_urban_model[lev]->Define(sc);
         }
     }

◆ Get_Data_Ptr()

amrex::MultiFab* Urban::Get_Data_Ptr	(	const int &	lev,
		const int &	varIdx
	)

inline

Returns a model data field, or null for an inactive level.

     {
         return m_active_levs[lev] ? m_urban_model[lev]->Urban_Data_Ptr(varIdx) : nullptr;
     }

◆ Get_Data_Size()

int Urban::Get_Data_Size ( )

inline

Returns the number of model data fields.

     {
         return (m_first_active_lev != -1)
             ? m_urban_model[m_first_active_lev]->Urban_Data_Size() : 0;
     }

◆ Get_DataIdx()

int Urban::Get_DataIdx	(	const int &	lev,
		const std::string &	varname
	)

inline

Returns a model data-field index.

     {
         return m_active_levs[lev] ? m_urban_model[lev]->Urban_DataIndex(varname) : -1;
     }

◆ Get_DataName()

std::string Urban::Get_DataName ( const int & varIdx )

inline

Returns a model data-field name.

     {
         return (m_first_active_lev != -1)
             ? m_urban_model[m_first_active_lev]->Urban_DataName(varIdx) : "";
     }

◆ Get_Flux_Ptr()

amrex::MultiFab* Urban::Get_Flux_Ptr	(	const int &	lev,
		const int &	varIdx
	)

inline

Returns a model flux field, or null for an inactive level.

     {
         return m_active_levs[lev] ? m_urban_model[lev]->Urban_Flux_Ptr(varIdx) : nullptr;
     }

◆ Get_Urban_Geom()

amrex::Geometry Urban::Get_Urban_Geom ( const int & lev )

inline

Returns the urban-model geometry for a level.

     {
         return m_active_levs[lev] ? m_urban_model[lev]->Urban_Geom() : amrex::Geometry();
     }

◆ Init()

void Urban::Init	(	const int &	lev,
		const amrex::MultiFab &	cons_in,
		const amrex::MultiFab &	u_in,
		const amrex::MultiFab &	v_in,
		const amrex::Geometry &	geom,
		const amrex::Real &	dt_advance,
		const amrex::MultiFab &	z_phys_nd,
		const amrex::iMultiFab &	land_type,
		const amrex::MultiFab &	urb_frac
	)

inline

Initializes the urban model on an active level.

     {
         if (m_active_levs[lev] == 1) {
             m_urban_model[lev]->Init(cons_in, u_in, v_in, geom, dt_advance,
                                       z_phys_nd, land_type, urb_frac);
         }
     }

◆ ReSize()

void Urban::ReSize	(	const int &	nlev,
		const amrex::Vector< int > &	active_levs
	)

inline

Resizes urban-model storage and records active AMR levels.

     {
         AMREX_ALWAYS_ASSERT(active_levs.size() == nlev);
         m_urban_model.resize(nlev);
         m_active_levs = active_levs;
     }

Here is the call graph for this function:

◆ set_urban_flux_inputs()

void Urban::set_urban_flux_inputs	(	const int &	lev,
		const amrex::Real &	declin
	)

inline

Sets flux inputs on an active level.

     {
         if (m_active_levs[lev] == 1) {
             m_urban_model[lev]->set_flux_inputs(declin);
         }
     }

◆ set_urban_terrain_inputs()

void Urban::set_urban_terrain_inputs	(	const int &	lev,
		const amrex::Vector< amrex::Vector< std::unique_ptr< amrex::MultiFab >>> &	tsk_in,
		const amrex::Vector< amrex::Vector< std::unique_ptr< amrex::iMultiFab >>> &	lmask_in,
		const amrex::Vector< amrex::Vector< std::unique_ptr< amrex::iMultiFab >>> &	land_type_in,
		const amrex::Vector< amrex::Vector< std::unique_ptr< amrex::MultiFab >>> &	urb_frac_in,
		amrex::MultiFab *	lat_in,
		amrex::MultiFab *	lon_in
	)

inline

Sets terrain inputs on an active level.

     {
         if (m_active_levs[lev] == 1) {
             m_urban_model[lev]->set_terrain_inputs(
                 tsk_in[lev], lmask_in[lev], land_type_in[lev], urb_frac_in[lev],
                 lat_in, lon_in);
         }
     }

◆ SetModel()

template<class NewUrbanModel >

void Urban::SetModel ( )

inline

Instantiates an urban model on each active AMR level.

     {
         m_first_active_lev = -1;
         for (int lev = 0; lev < m_urban_model.size(); ++lev) {
             if (m_active_levs[lev] == 1) {
                 m_urban_model[lev] = std::make_unique<NewUrbanModel>();
                 if (m_first_active_lev == -1) {
                     m_first_active_lev = lev;
                 }
             }
         }
     }

◆ Update_State_Vars_Lev()

void Urban::Update_State_Vars_Lev	(	const int &	lev,
		amrex::MultiFab &	cons_in
	)

inline

Updates atmospheric state fields on an active level.

     {
         if (m_active_levs[lev] == 1) {
             m_urban_model[lev]->Update_State_Vars(cons_in);
         }
     }

◆ Update_Urban_Vars_Lev()

void Urban::Update_Urban_Vars_Lev	(	const int &	lev,
		amrex::MultiFab &	cons_in,
		amrex::MultiFab &	u_in,
		amrex::MultiFab &	v_in
	)

inline

Updates coupled urban fields on an active level.

     {
         if (m_active_levs[lev] == 1) {
             m_urban_model[lev]->Update_Urban_Vars(cons_in, u_in, v_in);
         }
     }

Member Data Documentation

◆ m_active_levs

amrex::Vector<int> Urban::m_active_levs

private

Referenced by Advance(), Define(), Get_Data_Ptr(), Get_DataIdx(), Get_Flux_Ptr(), Get_Urban_Geom(), Init(), ReSize(), set_urban_flux_inputs(), set_urban_terrain_inputs(), SetModel(), Update_State_Vars_Lev(), and Update_Urban_Vars_Lev().

◆ m_first_active_lev

int Urban::m_first_active_lev = -1

private

Referenced by Get_Data_Size(), Get_DataName(), and SetModel().

◆ m_urban_model

amrex::Vector<std::unique_ptr<NullUrban> > Urban::m_urban_model

private

Referenced by Advance(), Define(), Get_Data_Ptr(), Get_Data_Size(), Get_DataIdx(), Get_DataName(), Get_Flux_Ptr(), Get_Urban_Geom(), Init(), ReSize(), set_urban_flux_inputs(), set_urban_terrain_inputs(), SetModel(), Update_State_Vars_Lev(), and Update_Urban_Vars_Lev().

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

Source/UrbanModel/ERF_Urban.H

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Urban()

◆ ~Urban()

Member Function Documentation

◆ Advance()

◆ Define()

◆ Get_Data_Ptr()

◆ Get_Data_Size()

◆ Get_DataIdx()

◆ Get_DataName()

◆ Get_Flux_Ptr()

◆ Get_Urban_Geom()

◆ Init()

◆ ReSize()

◆ set_urban_flux_inputs()

◆ set_urban_terrain_inputs()

◆ SetModel()

◆ Update_State_Vars_Lev()

◆ Update_Urban_Vars_Lev()

Member Data Documentation

◆ m_active_levs

◆ m_first_active_lev

◆ m_urban_model