ERF
Energy Research and Forecasting: An Atmospheric Modeling Code
ERF_DataStruct.H File Reference
#include <string>
#include <iostream>
#include <AMReX_ParmParse.H>
#include <AMReX_Print.H>
#include <AMReX_Gpu.H>
#include <AMReX_Geometry.H>
#include <ERF_Constants.H>
#include <ERF_IndexDefines.H>
#include <ERF_AdvStruct.H>
#include <ERF_DampingStruct.H>
#include <ERF_DiffStruct.H>
#include <ERF_EBStruct.H>
#include <ERF_SpongeStruct.H>
#include <ERF_TurbStruct.H>
#include <ERF_TurbPertStruct.H>
Include dependency graph for ERF_DataStruct.H:

Go to the source code of this file.

Classes

struct  MoistureComponentIndices
 Component indices for moisture species in the conserved state. More...
 
struct  SolverChoice
 

Enumerations

enum  MapFacType {
  m_x , u_x , v_x , num ,
  m_y = 0 , u_y = 1 , v_y = 2
}
 Indices for map scale factors on mass and face grids. More...
 
enum  TauType {
  tau11 , tau22 , tau33 , tau12 ,
  tau13 , tau23 , tau21 , tau31 ,
  tau32
}
 Stress tensor component indices. More...
 
enum class  Coord { x , y , z }
 Coordinate-axis selector. More...
 
enum  Rayleigh {
  ubar , vbar , wbar , thetabar ,
  nvars
}
 Rayleigh damping profile component indices. More...
 
enum  Sponge { ubar_sponge , vbar_sponge , nvars_sponge }
 Sponge reference-state component indices. More...
 

Functions

 AMREX_ENUM (InitType, None, Input_Sounding, NCFile, WRFInput, Metgrid, Uniform, ConstantDensity, ConstantDensityLinearTheta, Isentropic, MoistBaseState, HindCast)
 Initial-condition source used to populate the ERF state. More...
 
 AMREX_ENUM (SoundingType, ConstantDensity, Ideal, Isentropic, DryIsentropic)
 Interpretation of input sounding profiles. More...
 
 AMREX_ENUM (ABLDriverType, None, PressureGradient, GeostrophicWind)
 Large-scale atmospheric boundary-layer driver type. More...
 
 AMREX_ENUM (CouplingType, OneWay, TwoWay)
 Multilevel coupling strategy. More...
 
 AMREX_ENUM (SubsteppingType, None, Implicit)
 Acoustic substepping strategy. More...
 
 AMREX_ENUM (MeshType, ConstantDz, StretchedDz, VariableDz)
 Vertical mesh representation. More...
 
 AMREX_ENUM (TerrainType, None, StaticFittedMesh, MovingFittedMesh, EB, ImmersedForcing)
 Terrain and immersed-boundary representation. More...
 
 AMREX_ENUM (BuildingsType, None, ImmersedForcing)
 Building representation. More...
 
 AMREX_ENUM (MoistureModelType, Eulerian, Lagrangian, Undefined)
 Moisture transport representation. More...
 
 AMREX_ENUM (MoistureType, SAM, SAM_NoIce, SAM_NoPrecip_NoIce, Kessler, Kessler_NoRain, SatAdj, Morrison, Morrison_NoIce, WSM6, SuperDroplets, MoistNoCondensation, None)
 Moisture and microphysics model. More...
 
 AMREX_ENUM (WindFarmType, Fitch, EWP, SimpleAD, GeneralAD, None)
 Wind-farm model. More...
 
 AMREX_ENUM (WindFarmLocType, lat_lon, x_y, None)
 Coordinate system used for wind-farm locations. More...
 
 AMREX_ENUM (LandSurfaceType, SLM, NOAHMP, OceanSurf, None)
 Land-surface model. More...
 
 AMREX_ENUM (RadiationType, None, RRTMGP)
 Radiation model. More...
 

Enumeration Type Documentation

◆ Coord

enum Coord
strong

Coordinate-axis selector.

Enumerator
143  {
144  x, y, z
145 };

◆ MapFacType

enum MapFacType

Indices for map scale factors on mass and face grids.

Enumerator
m_x 
u_x 
v_x 
num 
m_y 
u_y 
v_y 
25  {
26 // This version assumes isotropic
27  m_x, u_x, v_x, num,
28  m_y = 0, u_y = 1, v_y = 2
29 // This version allows for non-isotropic
30 // m_x, u_x, v_x,
31 // m_y, u_y, v_y, num
32 };
@ v_x
Definition: ERF_DataStruct.H:27
@ num
Definition: ERF_DataStruct.H:27
@ u_y
Definition: ERF_DataStruct.H:28
@ v_y
Definition: ERF_DataStruct.H:28
@ m_y
Definition: ERF_DataStruct.H:28
@ u_x
Definition: ERF_DataStruct.H:27
@ m_x
Definition: ERF_DataStruct.H:27

◆ Rayleigh

enum Rayleigh

Rayleigh damping profile component indices.

Enumerator
ubar 
vbar 
wbar 
thetabar 
nvars 
151  {
153 };
@ ubar
Definition: ERF_DataStruct.H:152
@ wbar
Definition: ERF_DataStruct.H:152
@ nvars
Definition: ERF_DataStruct.H:152
@ vbar
Definition: ERF_DataStruct.H:152
@ thetabar
Definition: ERF_DataStruct.H:152

◆ Sponge

enum Sponge

Sponge reference-state component indices.

Enumerator
ubar_sponge 
vbar_sponge 
nvars_sponge 
159  {
161 };
@ nvars_sponge
Definition: ERF_DataStruct.H:160
@ vbar_sponge
Definition: ERF_DataStruct.H:160
@ ubar_sponge
Definition: ERF_DataStruct.H:160

◆ TauType

enum TauType

Stress tensor component indices.

Enumerator
tau11 
tau22 
tau33 
tau12 
tau13 
tau23 
tau21 
tau31 
tau32 
37  {
39 };
@ tau12
Definition: ERF_DataStruct.H:38
@ tau23
Definition: ERF_DataStruct.H:38
@ tau33
Definition: ERF_DataStruct.H:38
@ tau22
Definition: ERF_DataStruct.H:38
@ tau11
Definition: ERF_DataStruct.H:38
@ tau32
Definition: ERF_DataStruct.H:38
@ tau31
Definition: ERF_DataStruct.H:38
@ tau21
Definition: ERF_DataStruct.H:38
@ tau13
Definition: ERF_DataStruct.H:38

Function Documentation

◆ AMREX_ENUM() [1/14]

AMREX_ENUM ( ABLDriverType  ,
None  ,
PressureGradient  ,
GeostrophicWind   
)

Large-scale atmospheric boundary-layer driver type.

◆ AMREX_ENUM() [2/14]

AMREX_ENUM ( BuildingsType  ,
None  ,
ImmersedForcing   
)

Building representation.

◆ AMREX_ENUM() [3/14]

AMREX_ENUM ( CouplingType  ,
OneWay  ,
TwoWay   
)

Multilevel coupling strategy.

◆ AMREX_ENUM() [4/14]

AMREX_ENUM ( InitType  ,
None  ,
Input_Sounding  ,
NCFile  ,
WRFInput  ,
Metgrid  ,
Uniform  ,
ConstantDensity  ,
ConstantDensityLinearTheta  ,
Isentropic  ,
MoistBaseState  ,
HindCast   
)

Initial-condition source used to populate the ERF state.

◆ AMREX_ENUM() [5/14]

AMREX_ENUM ( LandSurfaceType  ,
SLM  ,
NOAHMP  ,
OceanSurf  ,
None   
)

Land-surface model.

◆ AMREX_ENUM() [6/14]

AMREX_ENUM ( MeshType  ,
ConstantDz  ,
StretchedDz  ,
VariableDz   
)

Vertical mesh representation.

◆ AMREX_ENUM() [7/14]

AMREX_ENUM ( MoistureModelType  ,
Eulerian  ,
Lagrangian  ,
Undefined   
)

Moisture transport representation.

◆ AMREX_ENUM() [8/14]

AMREX_ENUM ( MoistureType  ,
SAM  ,
SAM_NoIce  ,
SAM_NoPrecip_NoIce  ,
Kessler  ,
Kessler_NoRain  ,
SatAdj  ,
Morrison  ,
Morrison_NoIce  ,
WSM6  ,
SuperDroplets  ,
MoistNoCondensation  ,
None   
)

Moisture and microphysics model.

◆ AMREX_ENUM() [9/14]

AMREX_ENUM ( RadiationType  ,
None  ,
RRTMGP   
)

Radiation model.

◆ AMREX_ENUM() [10/14]

AMREX_ENUM ( SoundingType  ,
ConstantDensity  ,
Ideal  ,
Isentropic  ,
DryIsentropic   
)

Interpretation of input sounding profiles.

◆ AMREX_ENUM() [11/14]

AMREX_ENUM ( SubsteppingType  ,
None  ,
Implicit   
)

Acoustic substepping strategy.

◆ AMREX_ENUM() [12/14]

AMREX_ENUM ( TerrainType  ,
None  ,
StaticFittedMesh  ,
MovingFittedMesh  ,
EB  ,
ImmersedForcing   
)

Terrain and immersed-boundary representation.

◆ AMREX_ENUM() [13/14]

AMREX_ENUM ( WindFarmLocType  ,
lat_lon  ,
x_y  ,
None   
)

Coordinate system used for wind-farm locations.

◆ AMREX_ENUM() [14/14]

AMREX_ENUM ( WindFarmType  ,
Fitch  ,
EWP  ,
SimpleAD  ,
GeneralAD  ,
None   
)

Wind-farm model.