ERF
Energy Research and Forecasting: An Atmospheric Modeling Code
SurfaceModel::Field Struct Reference

Describes a registered land/urban field mapping. More...

Collaboration diagram for SurfaceModel::Field:

Public Attributes

std::pair< int, int > map
 Land and urban model field indices, respectively. More...
 
amrex::Vector< amrex::MultiFab * > lsm_ptr
 Per-level land-model field pointers. More...
 
amrex::Vector< amrex::MultiFab * > urb_ptr
 Per-level urban-model field pointers. More...
 
int mf_ind
 Index of the mapped field in the SurfaceModel field array. More...
 
bool fill_bound
 Whether boundaries are filled after mapping the field. More...
 
bool active = false
 Whether a consumer currently requires this mapped field. More...
 
bool persistent_consumer = false
 Whether the field must be updated on every timestep. More...
 

Detailed Description

Describes a registered land/urban field mapping.

A Field associates the common name used by ERF consumers with either model-specific field indices or per-level field pointers. The mapped fields are stored in the SurfaceModel-owned field array and the source pointers remain owned by their respective surface models.

Member Data Documentation

◆ active

bool SurfaceModel::Field::active = false

Whether a consumer currently requires this mapped field.

Referenced by SurfaceModel::activate_field_map(), and SurfaceModel::deactivate_transient_field_maps().

◆ fill_bound

bool SurfaceModel::Field::fill_bound

Whether boundaries are filled after mapping the field.

Referenced by SurfaceModel::register_field_map().

◆ lsm_ptr

amrex::Vector<amrex::MultiFab*> SurfaceModel::Field::lsm_ptr

◆ map

std::pair<int, int> SurfaceModel::Field::map

Land and urban model field indices, respectively.

Referenced by SurfaceModel::is_field_mapped(), SurfaceModel::register_field_map(), and SurfaceModel::set_field_map_pointers().

◆ mf_ind

int SurfaceModel::Field::mf_ind

◆ persistent_consumer

bool SurfaceModel::Field::persistent_consumer = false

Whether the field must be updated on every timestep.

Referenced by SurfaceModel::activate_field_map(), and SurfaceModel::deactivate_transient_field_maps().

◆ urb_ptr

amrex::Vector<amrex::MultiFab*> SurfaceModel::Field::urb_ptr

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