1 #ifndef ERF_DATA_STRUCT_H_
2 #define ERF_DATA_STRUCT_H_
7 #include <AMReX_ParmParse.H>
8 #include <AMReX_Print.H>
10 #include <AMReX_Geometry.H>
45 None, Input_Sounding, NCFile, WRFInput, Metgrid, Uniform, ConstantDensity, ConstantDensityLinearTheta,
46 Isentropic, MoistBaseState, HindCast
53 ConstantDensity, Ideal, Isentropic, DryIsentropic
60 None, PressureGradient, GeostrophicWind
81 ConstantDz, StretchedDz, VariableDz
88 None, StaticFittedMesh, MovingFittedMesh, EB, ImmersedForcing
102 Eulerian, Lagrangian, Undefined
109 SAM, SAM_NoIce, SAM_NoPrecip_NoIce,
Kessler, Kessler_NoRain,
SatAdj,
Morrison, Morrison_NoIce,
WSM6, SuperDroplets,
MoistNoCondensation, None
203 :
qv(qv_comp),
qc(qc_comp),
qi(qi_comp),
qr(qr_comp),
qs(qs_comp),
qg(qg_comp),
204 nc(nc_comp),
ni(ni_comp),
nr(nr_comp),
ns(ns_comp),
ng(ng_comp) {}
250 amrex::ParmParse
pp(pp_prefix);
253 if (
pp.query(
"use_terrain",bogus_bool) > 0) {
254 amrex::Error(
"The input use_terrain is deprecated. Set terrain_type instead.");
257 if (
pp.query(
"use_moist_background",bogus_bool) > 0) {
258 amrex::Error(
"The input use_moist_background is deprecated. Set init_type = MoistBaseState instead.");
277 amrex::Error(
"The input moisture_type is deprecated. Set moisture_model instead.");
305 }
else if ( (
moisture_type == MoistureType::Morrison_NoIce) ||
313 }
else if ( (
moisture_type == MoistureType::SAM_NoPrecip_NoIce) ||
339 for (
int i = 0; i <= max_level; ++i) {
354 for (
int i = 0; i <= max_level; ++i) {
368 pp.query_enum_case_insensitive(
"land_surface_model",
lsm_type);
371 for (
int lev = 0; lev <= max_level; ++lev) {
373 amrex::Print() <<
"Level " << lev <<
" is land" << std::endl;
374 }
else if (
is_land[lev] == 0) {
375 amrex::Print() <<
"Level " << lev <<
" is water" << std::endl;
377 amrex::Error(
"is_land should be 0 or 1");
383 pp.query_enum_case_insensitive(
"radiation_model",
rad_type);
386 #ifndef ERF_USE_RRTMGP
387 if (
rad_type == RadiationType::RRTMGP)
389 amrex::Error(
"ERF was not compiled with RRTMGP enabled!");
394 std::string terrain_type_temp =
"";
395 pp.query(
"terrain_type", terrain_type_temp);
396 if (terrain_type_temp ==
"Moving") {
397 amrex::Warning(
"erf.terrain_type = Moving is deprecated; please replace Moving by MovingFittedMesh");
399 }
else if (terrain_type_temp ==
"Static") {
400 amrex::Warning(
"erf.terrain_type = Static is deprecated; please replace Static by StaticFittedMesh");
407 std::string buildings_type_temp =
"";
408 pp.query(
"buildings_type", buildings_type_temp);
409 if (buildings_type_temp ==
"ImmersedForcing") {
416 std::string init_type_temp_string;
418 int found =
pp.query(
"init_type",init_type_temp_string);
420 if ( (init_type_temp_string ==
"Real") || (init_type_temp_string ==
"real") ) {
421 amrex::Error(
"erf.init_type = Real is deprecated; please replace Real by WRFInput");
422 }
else if ( (init_type_temp_string ==
"Ideal") || (init_type_temp_string ==
"ideal") ) {
423 amrex::Error(
"erf.init_type = Ideal is deprecated; please replace Ideal by WRFInput");
425 pp.query_enum_case_insensitive(
"init_type",
init_type);
431 amrex::Error(
"Only terrain_type = StaticFittedMesh are allowed with init_type = WRFInput or Metgrid");
435 if (
init_type == InitType::MoistBaseState) {
437 amrex::Error(
"Makes no sense to have moist base state with no moisture model");
443 amrex::Error(
"Can't have moisture_type = None with init_type = WRFInput");
447 std::string nc_bdy_file_temp_string;
448 bool has_bdy =
pp.query(
"nc_bdy_file", nc_bdy_file_temp_string);
452 pp.query(
"use_real_bcs", use_real_bcs_temp);
458 if (found == 0 ||
init_type == InitType::None) {
459 amrex::Print() <<
"init_type must now be set. The options are " << std::endl;
460 amrex::Print() <<
" Input_Sounding, NCFile, WRFInput, Metgrid, Uniform, " << std::endl;
461 amrex::Print() <<
" ConstantDensity, Isentropic, MoistBaseState, or HindCast " << std::endl;
462 amrex::Error(
"Please add a string for init_type to your inputs file or command line");
466 if (
init_type == InitType::Input_Sounding) {
480 amrex::Abort(
"SAM is not correct with variable dz -- choose another moisture model");
486 "The grid stretching ratio must be greater than 1");
497 amrex::Print() <<
"Nominal zsurface height != 0, may result in unexpected behavior"
500 pp.get(
"initial_dz",
dz0);
503 int n_zlevels =
pp.countval(
"terrain_z_levels");
525 amrex::Print() <<
"Must rebalance when not using WRF height grid. Setting rebalance_wrf_input to true \n";
534 amrex::Print() <<
"Setting use_gravity to true due to init_type = WRFInput / Metgrid " << std::endl;
540 pp.query(
"c_p",
c_p);
551 bool any_anelastic =
false;
552 bool any_compress =
false;
553 for (
int i = 0; i <= max_level; ++i) {
558 any_anelastic =
true;
582 for (
int i = 0; i <= max_level; i++) {
586 for (
int i = 0; i <= max_level; i++) {
600 int nvals_old =
pp.countval(
"no_substepping");
602 amrex::Error(
"The no_substepping flag is deprecated -- set substepping_type instead");
610 #ifdef AMREX_USE_FLOAT
614 for (
int lev = 0; lev <= max_level; lev++) {
657 amrex::Error(
"Can only specify one of init_surf_temp, surf_temp_flux, or Olen");
677 for (
int lev = 0; lev <= max_level; ++lev) {
680 pp,
"perturbation_type",
pert_type[lev], lev, max_level);
683 amrex::Vector<amrex::Real> abl_pressure_grad_in = {
zero,
zero,
zero};
684 pp.queryarr(
"abl_pressure_grad",abl_pressure_grad_in);
685 for(
int i = 0; i < AMREX_SPACEDIM; ++i)
abl_pressure_grad[i] = abl_pressure_grad_in[i];
687 amrex::Vector<amrex::Real> abl_geo_forcing_in = {
zero,
zero,
zero};
688 if(
pp.queryarr(
"abl_geo_forcing",abl_geo_forcing_in)) {
689 amrex::Print() <<
"Specified abl_geo_forcing: (";
690 for (
int i = 0; i < AMREX_SPACEDIM; ++i) {
694 amrex::Print() <<
")" << std::endl;
716 "Should not have both abl_geo_wind_table and custom_geostrophic_profile set.");
723 "Numerical diffusion coefficient must be between 0 & one");
726 amrex::Print() <<
"6th-order numerical diffusion turned on with coefficient = "
738 for (
int lev = 0; lev <= max_level; lev++) {
739 turbChoice[lev].init_params(lev,max_level,pp_prefix);
743 for (
int lev = 0; lev <= max_level; lev++) {
751 for (
int lev = 0; lev <= max_level; lev++) {
752 if (
turbChoice[lev].pbl_ysu_use_consistent_coriolis) {
756 amrex::Print() <<
"YSU PBL using ERF coriolis frequency: " <<
turbChoice[lev].pbl_ysu_coriolis_freq << std::endl;
759 amrex::Error(
"YSU cannot use ERF coriolis frequency if not using coriolis");
764 for (
int lev = 0; lev <= max_level; lev++) {
765 if (
turbChoice[lev].pbl_ysu_use_consistent_coriolis) {
769 amrex::Print() <<
"MRF PBL using ERF coriolis frequency: " <<
turbChoice[lev].pbl_ysu_coriolis_freq << std::endl;
772 amrex::Error(
"MRF cannot use ERF coriolis frequency if not using coriolis");
790 for (
int lev = 0; lev <= max_level; ++lev) {
801 amrex::Print() <<
"Turning off native vertical implicit solve at all levels with SHOC family PBL scheme." << std::endl;
802 for (
int lev = 0; lev <= max_level; lev++) {
809 bool do_vert_implicit =
true;
810 pp.query(
"vert_implicit", do_vert_implicit);
812 if (!do_vert_implicit) {
813 for (
int lev = 0; lev <= max_level; lev++) {
814 amrex::Print() <<
"Turning off native vertical implicit solve from vert_implicit flag at level " << lev << std::endl;
821 for (
int lev = 0; lev <= max_level; lev++) {
823 amrex::Print() <<
"Turning off native vertical implicit solve flag because anelastic at level " << lev << std::endl;
831 int n_impfac =
pp.countval(
"vert_implicit_fac");
833 if (n_impfac > 0 && do_vert_implicit) {
834 amrex::Print() <<
"Overriding defaults with specified implicit factor(s)" << std::endl;
839 pp.get(
"vert_implicit_fac", fac_in);
840 for (
int lev = 0; lev <= max_level; lev++) {
841 for (
int i=0; i<3; ++i) {
845 }
else if (n_impfac == 3) {
846 for (
int lev = 0; lev <= max_level; lev++) {
871 for (
int lev = 0; lev <= max_level; lev++) {
873 amrex::Print() <<
"implicit_before_substep cannot be false without substepping; setting to true." <<
"\n";
881 for (
int lev = 0; lev <= max_level; lev++) {
882 if (do_vert_implicit) {
883 amrex::Print() <<
"Implicit diffusion is not supported with EB; turning off at level " << lev <<
"\n";
895 amrex::Print() <<
"Thermal, moisture, KE, and momentum diffusion are all turned off; turning off vertical implicit solve." << std::endl;
896 for (
int lev = 0; lev <= max_level; lev++) {
910 if (any_anelastic && any_compress) {
945 amrex::Error(
"ERROR: Missing input parameter 'erf.hindcast_boundary_data_dir' for boundary data for lateral forcing");
949 amrex::Error(
"ERROR: Input parameter 'erf.hindcast_data_interval_in_hrs' which is the time interval between the "
950 "data files is either missing or set to less than zero");
961 amrex::Error(
"ERROR: Missing input parameter 'erf.hindcast_lateral_sponge_strength' or it is specified to be less than zero");
965 amrex::Error(
"ERROR: Missing input parameter 'erf.hindcast_lateral_sponge_length' or it is specified to be less than zero");
969 amrex::Error(
"ERROR: Missing input parameter 'erf.hindcast_zhi_sponge_length' or it is specified to be less than zero");
973 amrex::Error(
"ERROR: Missing input parameter 'erf.hindcast_zhi_sponge_strength' or it is specified to be less than zero");
987 amrex::Error(
"ERROR: You are using 'erf.io_hurricane_eye_tracker' to write out the files that track the eye of the hurricane"
988 " but have not provided the initial location of the eye of the hurricane to be tracked. There has to be two"
989 " options in the inputs - erf.hurricane_eye_latitude and erf.hurricane_eye_longitude that gives an approximate"
990 " location of the eye in the initial condition");
996 amrex::ParmParse pp_ens(
"ensemble");
999 amrex::Abort(
"You are using an ensemble run. There needs to be at least 2 ensemble members. "
1000 "erf.n_ensemble must be >=2.");
1004 amrex::Abort(
"coarse_bckgnd_data_file is empty! For ensmeble simulations, there needs to be a coarse background file which "
1005 "contains the data which will be interpolated onto the fine mesh. There has to a entry ensemble.coarse_bckgnd_data_file "
1006 "which contains the filename in the inputs.");
1010 amrex::Error(
"You are using initialization for ensemble simulations using the inputs option "
1011 "ensemble.is_init_for_ensemble=true. In this case, there has to be an option "
1012 "ensemble.ens_pert_amplitude which is the value of the amplitude of the perturbation "
1013 "to be added to the background state and has to be greater than 0.0");
1017 amrex::Error(
"You are using initialization with spatially correlated perturbations using the inputs option "
1018 "ensemble.is_init_for_ensemble=true. In this case, there has to be an option "
1019 "ensemble.ens_pert_correlated_radius which is the value of the the spatial correlation radius, "
1020 "and has to be greater than 0.0");
1031 void check_params (
int max_level,
const amrex::Vector<amrex::Geometry>& geom_vect, amrex::GpuArray<ERF_BC, AMREX_SPACEDIM*2> phys_bc_type)
1035 for (
int lev = 0; lev <= max_level; lev++) {
1037 amrex::Warning(
"\n*** WARNING: Moisture may not yet be compatible with PBL models, \n proceed with caution ***");
1044 for (
int lev = 0; lev <= max_level; lev++) {
1046 amrex::Error(
"buoyancy_type must be 1, 2, 3 or 4");
1051 amrex::Error(
"Can't turn off lagged_delta_rt when terrain not moving");
1058 amrex::Error(
"To use simplified actuator disks, you need to provide a variable"
1059 " erf.sampling_distance_by_D in the inputs which specifies the upstream"
1060 " distance as a factor of the turbine diameter at which the incoming free stream"
1061 " velocity will be computed at.");
1065 amrex::Error(
"To use simplified actuator disks, you need to provide a variable"
1066 " erf.turb_disk_angle_from_x in the inputs which is the angle of the face of the"
1067 " turbine disk from the x-axis. A turbine facing an oncoming flow in the x-direction"
1068 " will have turb_disk_angle value of 90 deg.");
1071 amrex::Error(
"You are using windfarms with latitude-logitude option to position the turbines."
1072 " For this you should provide the inputs erf.windfarm_x_shift and"
1073 " erf.windfarm_y_shift which are the values by which the bounding box of the"
1074 " windfarm is shifted from the x and the y axes.");
1079 amrex::Error(
"Constant mass flux (in x) should be used with periodic boundaries");
1083 amrex::Error(
"Constant mass flux (in y) should be used with periodic boundaries");
1087 for (
int lev = 0; lev <= max_level; lev++) {
1088 if ((geom_vect[lev].CellSize(0) >
amrex::Real(2000.)) || (geom_vect[lev].CellSize(1) >
amrex::Real(2000.)))
1091 amrex::Warning(
"Should use 2-D Smagorinsky for mesoscale resolution");
1092 }
else if (
turbChoice[lev].les_type == LESType::Deardorff) {
1093 amrex::Warning(
"Should not use Deardorff LES for mesoscale resolution");
1100 for (
int lev = 1; lev <= max_level; lev++) {
1101 l_use_kturb = (l_use_kturb ||
turbChoice[lev].use_kturb);
1105 for (
int lev = 0; lev <= max_level; lev++) {
1109 if (l_implicit_diff && !l_use_diff) {
1110 amrex:: Print() <<
"No molecular or turbulent diffusion, turning off implicit solve at level " << lev << std::endl;
1118 for (
int lev = 0; lev <= max_level; lev++) {
1119 if (
turbChoice[lev].enable_mrf_countergradient) {
1124 "enable_mrf_countergradient requires vert_implicit_fac > 0");
1127 "enable_mrf_countergradient requires implicit_thermal_diffusion = true");
1131 "enable_mrf_countergradient with moisture requires implicit_moisture_diffusion = true");
1136 for (
int lev = 0; lev <= max_level; lev++) {
1146 void display (
int max_level, std::string pp_prefix)
1148 amrex::Print() <<
"SOLVER CHOICE: " << std::endl;
1149 for (
int lev = 0; lev <= max_level; lev++) {
1150 amrex::Print() <<
"At level " << lev <<
" : " << std::endl;
1152 amrex::Print() <<
" anelastic with no substepping" << std::endl;
1155 amrex::Print() <<
" compressible with no substepping" << std::endl;
1157 amrex::Print() <<
" compressible with implicit substepping" << std::endl;
1161 amrex::Print() <<
" and fixed density" << std::endl;
1165 for (
int lev = 0; lev <= max_level; lev++) {
1166 amrex::Print() <<
"vert_implicit_fac at level " << lev <<
" : "
1178 #ifdef ERF_IMPLICIT_W
1179 amrex::Print() <<
", including w";
1181 amrex::Print() <<
")";
1184 amrex::Print() << std::endl;
1185 amrex::Print() <<
"use_coriolis : " <<
use_coriolis << std::endl;
1186 amrex::Print() <<
"use_gravity : " <<
use_gravity << std::endl;
1189 amrex::Print() <<
"Moisture Model: SAM" << std::endl;
1191 amrex::Print() <<
"Moisture Model: SAM No Ice" << std::endl;
1192 }
else if (
moisture_type == MoistureType::SAM_NoPrecip_NoIce) {
1193 amrex::Print() <<
"Moisture Model: SAM No Precip No Ice" << std::endl;
1195 amrex::Print() <<
"Moisture Model: Morrison" << std::endl;
1197 amrex::Print() <<
"Moisture Model: Morrison_NoIce" << std::endl;
1199 amrex::Print() <<
"Moisture Model: WSM6" << std::endl;
1201 amrex::Print() <<
"Moisture Model: Kessler" << std::endl;
1203 amrex::Print() <<
"Moisture Model: Kessler No Rain" << std::endl;
1205 amrex::Print() <<
"Moisture Model: Saturation Adjustment" << std::endl;
1206 }
else if (
moisture_type == MoistureType::MoistNoCondensation) {
1207 amrex::Print() <<
"Moisture Model: MoistNoCondensation" << std::endl;
1209 amrex::Print() <<
"Moisture Model: None" << std::endl;
1213 amrex::Print() <<
"Terrain Type: StaticFittedMesh" << std::endl;
1214 }
else if (
terrain_type == TerrainType::MovingFittedMesh) {
1215 amrex::Print() <<
"Terrain Type: MovingFittedMesh" << std::endl;
1217 amrex::Print() <<
"Terrain Type: EB" << std::endl;
1219 }
else if (
terrain_type == TerrainType::ImmersedForcing) {
1220 amrex::Print() <<
"Terrain Type: ImmersedForcing" << std::endl;
1222 amrex::Print() <<
"Terrain Type: None" << std::endl;
1226 amrex::Print() <<
"Buildings Type: ImmersedForcing" << std::endl;
1228 amrex::Print() <<
"Buildings Type: None" << std::endl;
1231 if (
mesh_type == MeshType::ConstantDz) {
1232 amrex::Print() <<
" Mesh Type: ConstantDz" << std::endl;
1233 }
else if (
mesh_type == MeshType::StretchedDz) {
1234 amrex::Print() <<
" Mesh Type: StretchedDz" << std::endl;
1235 }
else if (
mesh_type == MeshType::VariableDz) {
1236 amrex::Print() <<
" Mesh Type: VariableDz" << std::endl;
1238 amrex::Error(
"No mesh_type set!");
1241 amrex::Print() <<
"ABL Driver Type: " << std::endl;
1243 amrex::Print() <<
" None" << std::endl;
1245 amrex::Print() <<
" Pressure Gradient "
1249 amrex::Print() <<
" Geostrophic Wind "
1254 if (max_level > 0) {
1255 amrex::Print() <<
"Coupling Type: " << std::endl;
1257 amrex::Print() <<
" Two-way" << std::endl;
1259 amrex::Print() <<
" One-way" << std::endl;
1263 if (
rad_type == RadiationType::RRTMGP) {
1264 amrex::Print() <<
"Radiation Model: RRTMGP" << std::endl;
1266 amrex::Print() <<
"Radiation Model: None" << std::endl;
1269 amrex::Print() <<
"Gradp_type : " <<
gradp_type << std::endl;
1271 for (
int lev = 0; lev <= max_level; lev++) {
1272 amrex::Print() <<
"Buoyancy_type at level " << lev <<
" : " <<
buoyancy_type[lev] << std::endl;
1280 for (
int lev = 0; lev <= max_level; lev++) {
1291 amrex::ParmParse
pp(pp_prefix);
1294 double rot_time_period = 86400.0;
1295 pp.query(
"rotational_time_period", rot_time_period);
1303 pp.query(
"latitude", latitude_for_coriolis);
1305 sinphi = std::sin(latitude_for_coriolis);
1309 cosphi = std::cos(latitude_for_coriolis);
1317 amrex::Vector<amrex::Real> abl_geo_wind(3);
1318 pp.queryarr(
"abl_geo_wind",abl_geo_wind);
1327 amrex::Print() <<
"NOTE: abl_geo_wind_table provided, ignoring input abl_geo_wind" << std::endl;
1340 amrex::Vector<int>& vec_to_fill,
int default_int)
1342 amrex::ParmParse
pp(
"erf");
1343 int nvals =
pp.countval(string_to_read);
1345 amrex::Vector<int> temp; temp.resize(nvals);
1346 pp.queryarr(string_to_read,temp);
1348 if (vec_to_fill.size() < max_level+1) {
1349 vec_to_fill.resize(max_level+1);
1353 for (
int i = 0; i <= max_level; ++i) vec_to_fill[i] = default_int;
1354 }
else if (nvals == 1) {
1355 for (
int i = 0; i <= max_level; ++i) vec_to_fill[i] = temp[0];
1357 for (
int i = 0; i <= max_level; ++i) vec_to_fill[i] = temp[i];
1426 #ifdef AMREX_USE_FLOAT
1524 return pert_type[lev] == PerturbationType::Source ||
1525 pert_type[lev] == PerturbationType::Direct ||
1526 pert_type[lev] == PerturbationType::CPM ||
1527 pert_type[lev] == PerturbationType::CPM_W;
1537 return pert_type[lev] == PerturbationType::Direct ||
1538 pert_type[lev] == PerturbationType::CPM ||
1539 pert_type[lev] == PerturbationType::CPM_W;
1549 return pert_type[lev] == PerturbationType::Source;
1559 return pert_type[lev] == PerturbationType::CPM_W;
1587 if (type == PerturbationType::Source ||
1588 type == PerturbationType::Direct ||
1589 type == PerturbationType::CPM) {
constexpr amrex::Real Cp_d
Definition: ERF_Constants.H:49
constexpr amrex::Real two
Definition: ERF_Constants.H:10
constexpr amrex::Real bogus_large_value
Definition: ERF_Constants.H:26
constexpr amrex::Real one
Definition: ERF_Constants.H:9
constexpr amrex::Real zero
Definition: ERF_Constants.H:8
constexpr amrex::Real PI
Definition: ERF_Constants.H:42
constexpr amrex::Real CONST_GRAV
Definition: ERF_Constants.H:64
constexpr amrex::Real R_d
Definition: ERF_Constants.H:47
TauType
Stress tensor component indices.
Definition: ERF_DataStruct.H:37
@ 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
AMREX_ENUM(InitType, None, Input_Sounding, NCFile, WRFInput, Metgrid, Uniform, ConstantDensity, ConstantDensityLinearTheta, Isentropic, MoistBaseState, HindCast)
Initial-condition source used to populate the ERF state.
Rayleigh
Rayleigh damping profile component indices.
Definition: ERF_DataStruct.H:151
@ 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
Sponge reference-state component indices.
Definition: ERF_DataStruct.H:159
@ nvars_sponge
Definition: ERF_DataStruct.H:160
@ vbar_sponge
Definition: ERF_DataStruct.H:160
@ ubar_sponge
Definition: ERF_DataStruct.H:160
MapFacType
Indices for map scale factors on mass and face grids.
Definition: ERF_DataStruct.H:25
@ 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
Coord
Coordinate-axis selector.
Definition: ERF_DataStruct.H:143
#define RhoQ4_comp
Definition: ERF_IndexDefines.H:45
#define RhoQ2_comp
Definition: ERF_IndexDefines.H:43
#define RhoQ3_comp
Definition: ERF_IndexDefines.H:44
#define RhoQ11_comp
Definition: ERF_IndexDefines.H:52
#define RhoQ9_comp
Definition: ERF_IndexDefines.H:50
#define RhoQ1_comp
Definition: ERF_IndexDefines.H:42
#define RhoQ6_comp
Definition: ERF_IndexDefines.H:47
#define RhoQ8_comp
Definition: ERF_IndexDefines.H:49
#define RhoQ5_comp
Definition: ERF_IndexDefines.H:46
#define RhoQ7_comp
Definition: ERF_IndexDefines.H:48
#define RhoQ10_comp
Definition: ERF_IndexDefines.H:51
AMREX_ALWAYS_ASSERT(bx.length()[2]==khi+1)
AMREX_ALWAYS_ASSERT_WITH_MESSAGE(m_cloud_chamber_config.active, "Cloud Chamber: initializer reached without a parsed configuration")
amrex::Real Real
Definition: ERF_ShocInterface.H:19
int query_one_or_per_level_enum_case_insensitive(const amrex::ParmParse &pp, const char *query_string, T &query_var, const int lev, const int maxlev)
Query a scalar or per-level enum input value using case-insensitive matching.
Definition: ERF_TurbStruct.H:80
AMREX_ASSERT_WITH_MESSAGE(wbar_cutoff_min > wbar_cutoff_max, "ERROR: wbar_cutoff_min < wbar_cutoff_max")
Definition: ERF_Fitch.H:9
Definition: ERF_GeneralAD.H:8
Definition: ERF_Kessler.H:40
Definition: ERF_MoistNoCondensation.H:13
Definition: ERF_Morrison.H:59
Definition: ERF_NOAHMP.H:57
Definition: ERF_OceanSurf.H:19
Definition: ERF_SatAdj.H:45
Definition: ERF_SimpleAD.H:8
Definition: ERF_WSM6.H:38
Definition: ERF_AdvStruct.H:19
void display(std::string &pp_prefix)
Print the configured advection choices.
Definition: ERF_AdvStruct.H:243
void init_params(std::string pp_prefix)
Read advection options from the input parameter database.
Definition: ERF_AdvStruct.H:25
Definition: ERF_DampingStruct.H:22
void init_params(std::string pp_prefix)
Read damping options from the input parameter database.
Definition: ERF_DampingStruct.H:28
void display()
Print the configured damping options.
Definition: ERF_DampingStruct.H:71
Definition: ERF_DiffStruct.H:22
MolecDiffType molec_diff_type
Selected molecular transport model.
Definition: ERF_DiffStruct.H:94
void init_params(std::string pp_prefix)
Read diffusion options from the input parameter database.
Definition: ERF_DiffStruct.H:28
void display()
Print the configured diffusion options.
Definition: ERF_DiffStruct.H:77
Definition: ERF_EBStruct.H:36
void init_params(std::string pp_prefix)
Read embedded-boundary options from the input parameter database.
Definition: ERF_EBStruct.H:42
void display()
Print the configured embedded-boundary options.
Definition: ERF_EBStruct.H:63
Component indices for moisture species in the conserved state.
Definition: ERF_DataStruct.H:166
int ns
Snow number concentration component index.
Definition: ERF_DataStruct.H:176
int qi
Cloud ice component index.
Definition: ERF_DataStruct.H:169
MoistureComponentIndices()=default
Construct an empty set of moisture component indices.
int qv
Water vapor component index.
Definition: ERF_DataStruct.H:167
MoistureComponentIndices(int qv_comp, int qc_comp, int qi_comp=-1, int qr_comp=-1, int qs_comp=-1, int qg_comp=-1, int nc_comp=-1, int ni_comp=-1, int nr_comp=-1, int ns_comp=-1, int ng_comp=-1)
Construct moisture component indices from conserved-state component numbers.
Definition: ERF_DataStruct.H:193
int qs
Snow component index.
Definition: ERF_DataStruct.H:171
int qr
Rain component index.
Definition: ERF_DataStruct.H:170
int qc
Cloud liquid water component index.
Definition: ERF_DataStruct.H:168
int ng
Graupel number concentration component index.
Definition: ERF_DataStruct.H:177
int qg
Graupel component index.
Definition: ERF_DataStruct.H:172
int ni
Cloud ice number concentration component index.
Definition: ERF_DataStruct.H:174
int nr
Rain number concentration component index.
Definition: ERF_DataStruct.H:175
int nc
Cloud liquid water number concentration component index.
Definition: ERF_DataStruct.H:173
Definition: ERF_DataStruct.H:241
bool custom_geostrophic_profile
Whether a custom geostrophic wind profile is used.
Definition: ERF_DataStruct.H:1495
int n_ensemble
Number of ensemble members.
Definition: ERF_DataStruct.H:1670
WindFarmLocType windfarm_loc_type
Coordinate system for wind-farm turbine locations.
Definition: ERF_DataStruct.H:1606
bool implicit_before_substep
Whether implicit diffusion is applied before acoustic substepping.
Definition: ERF_DataStruct.H:1423
amrex::Real const_massflux_v
Target constant mass flux in the y direction.
Definition: ERF_DataStruct.H:1651
std::string hindcast_boundary_data_dir
Directory containing hindcast lateral boundary data.
Definition: ERF_DataStruct.H:1658
amrex::Real ens_pert_correlated_radius
Spatial correlation radius for ensemble perturbations.
Definition: ERF_DataStruct.H:1671
static InitType init_type
Initial-condition source selected for the run.
Definition: ERF_DataStruct.H:1362
amrex::Real coriolis_factor
Twice the planetary rotation rate used for Coriolis forcing.
Definition: ERF_DataStruct.H:1485
bool io_hurricane_eye_tracker
Whether hurricane-eye tracking output is enabled.
Definition: ERF_DataStruct.H:1666
std::string abl_geo_wind_table
Path to a time-varying geostrophic wind table.
Definition: ERF_DataStruct.H:1613
amrex::Vector< int > fixed_density
Per-level flag selecting fixed-density treatment.
Definition: ERF_DataStruct.H:1400
amrex::Vector< TurbChoice > turbChoice
Turbulence options for each AMR level.
Definition: ERF_DataStruct.H:1393
amrex::Real const_massflux_layer_lo
Lower height of the constant-mass-flux forcing layer.
Definition: ERF_DataStruct.H:1653
amrex::Real hindcast_zhi_sponge_length
Length of the upper hindcast sponge layer.
Definition: ERF_DataStruct.H:1663
amrex::Real gravity
Effective gravitational acceleration.
Definition: ERF_DataStruct.H:1475
void check_params(int max_level, const amrex::Vector< amrex::Geometry > &geom_vect, amrex::GpuArray< ERF_BC, AMREX_SPACEDIM *2 > phys_bc_type)
Validate solver options after geometry and boundary conditions are known.
Definition: ERF_DataStruct.H:1031
bool pbl_suppresses_microphysics_condensation() const noexcept
Query whether the active PBL scheme suppresses microphysics condensation.
Definition: ERF_DataStruct.H:1575
bool variable_coriolis
Whether spatially varying Coriolis forcing is enabled.
Definition: ERF_DataStruct.H:1616
bool implicit_moisture_diffusion
Whether implicit vertical moisture diffusion is included.
Definition: ERF_DataStruct.H:1420
MoistureType moisture_type
Moisture or microphysics model.
Definition: ERF_DataStruct.H:1604
void display(int max_level, std::string pp_prefix)
Print the configured solver, physics, and transport options.
Definition: ERF_DataStruct.H:1146
amrex::Real poisson_abstol
Absolute tolerance for the Poisson solve.
Definition: ERF_DataStruct.H:1430
amrex::Real if_Cd_momentum
Immersed-forcing drag coefficient for momentum.
Definition: ERF_DataStruct.H:1452
amrex::Real if_Olen_in
Input Obukhov length for immersed-forcing MOST [m].
Definition: ERF_DataStruct.H:1462
amrex::Vector< int > buoyancy_type
Per-level buoyancy formulation selector.
Definition: ERF_DataStruct.H:1402
void build_coriolis_forcings_const_lat(std::string pp_prefix)
Build constant-latitude Coriolis forcing parameters.
Definition: ERF_DataStruct.H:1289
CouplingType coupling_type
Multilevel coupling strategy.
Definition: ERF_DataStruct.H:1603
bool use_pert_pres_gradient
Whether momentum equations use perturbational pressure gradients.
Definition: ERF_DataStruct.H:1438
amrex::Vector< int > project_initial_velocity
Per-level flag for projecting the initial velocity.
Definition: ERF_DataStruct.H:1401
int ave_plane
Averaging plane index used by diagnostics.
Definition: ERF_DataStruct.H:1618
amrex::Real const_massflux_u
Target constant mass flux in the x direction.
Definition: ERF_DataStruct.H:1650
void read_int_string(int max_level, const char *string_to_read, amrex::Vector< int > &vec_to_fill, int default_int)
Read one integer value or one value per AMR level.
Definition: ERF_DataStruct.H:1339
int ncorr
Number of projection correction iterations.
Definition: ERF_DataStruct.H:1425
amrex::Real sampling_distance_by_D
Turbine inflow sampling distance normalized by rotor diameter.
Definition: ERF_DataStruct.H:1627
amrex::Real windfarm_y_shift
Wind-farm y-coordinate shift.
Definition: ERF_DataStruct.H:1630
bool use_rotate_surface_flux
Whether MOST surface fluxes are rotated with terrain.
Definition: ERF_DataStruct.H:1505
bool moisture_tight_coupling
Whether moisture updates use tight coupling.
Definition: ERF_DataStruct.H:1623
EBChoice ebChoice
Embedded-boundary options.
Definition: ERF_DataStruct.H:1394
amrex::Real beta_s
Time off-centering coefficient for forward weighting.
Definition: ERF_DataStruct.H:1410
bool implicit_ke_diffusion
Whether implicit vertical TKE diffusion is included.
Definition: ERF_DataStruct.H:1421
bool any_perturbation() const
Query whether any level uses a turbulent perturbation mode.
Definition: ERF_DataStruct.H:1584
amrex::Real if_z0
Immersed-forcing roughness length [m].
Definition: ERF_DataStruct.H:1458
bool forest_substep
Whether canopy source terms are applied only during substeps.
Definition: ERF_DataStruct.H:1449
bool use_wrf_bdy_density
Definition: ERF_DataStruct.H:1636
bool implicit_thermal_diffusion
Whether implicit vertical thermal diffusion is included.
Definition: ERF_DataStruct.H:1419
bool use_gravity
Whether gravitational forcing is enabled.
Definition: ERF_DataStruct.H:1441
amrex::Real num_diff_coeff
Numerical diffusion coefficient after input scaling.
Definition: ERF_DataStruct.H:1601
amrex::Real bdy_nudge_factor
Boundary sponge nudging factor.
Definition: ERF_DataStruct.H:1633
amrex::Real rdOcp
Ratio of dry-air gas constant to c_p.
Definition: ERF_DataStruct.H:1477
bool use_wvel_perturbation(int lev) const
Query whether vertical-velocity CPM perturbations are enabled on a level.
Definition: ERF_DataStruct.H:1557
bool hindcast_lateral_forcing
Whether hindcast lateral forcing is enabled.
Definition: ERF_DataStruct.H:1660
bool do_theta_advection
Whether custom vertical subsidence is applied to rho-theta.
Definition: ERF_DataStruct.H:1493
bool use_native_shoc
Whether any level uses the native SHOC PBL scheme.
Definition: ERF_DataStruct.H:1509
static bool use_real_bcs
Whether real-data lateral boundary conditions are used.
Definition: ERF_DataStruct.H:1374
bool spatial_moisture_forcing
Whether spatially varying moisture forcing is enabled.
Definition: ERF_DataStruct.H:1498
amrex::Vector< SubsteppingType > substepping_type
Acoustic substepping type for each AMR level.
Definition: ERF_DataStruct.H:1398
bool use_perturbation(int lev) const
Query whether any turbulent perturbation mode is enabled on a level.
Definition: ERF_DataStruct.H:1522
static SoundingType sounding_type
Interpretation used for input sounding profiles.
Definition: ERF_DataStruct.H:1365
int bdy_moist_nudge_type
Moist-variable nudging strategy in boundary regions.
Definition: ERF_DataStruct.H:1641
amrex::Real poisson_reltol
Relative tolerance for the Poisson solve.
Definition: ERF_DataStruct.H:1431
bool use_coriolis
Whether Coriolis forcing is enabled.
Definition: ERF_DataStruct.H:1442
amrex::Vector< PerturbationType > pert_type
Turbulent perturbation type for each AMR level.
Definition: ERF_DataStruct.H:1597
static MeshType mesh_type
Vertical mesh representation.
Definition: ERF_DataStruct.H:1377
bool use_wrf_height_grid
Definition: ERF_DataStruct.H:1644
AdvChoice advChoice
Advection-related options.
Definition: ERF_DataStruct.H:1389
SpongeChoice spongeChoice
Sponge-layer options.
Definition: ERF_DataStruct.H:1392
void init_params(int max_level, std::string pp_prefix)
Read solver-wide algorithmic options from the input parameter database.
Definition: ERF_DataStruct.H:248
bool time_avg_vel
Whether time-averaged velocity fields are output.
Definition: ERF_DataStruct.H:1515
bool use_direct_perturbation(int lev) const
Query whether direct turbulent perturbations are enabled on a level.
Definition: ERF_DataStruct.H:1535
bool have_geo_wind_profile
Whether a geostrophic wind profile has been configured.
Definition: ERF_DataStruct.H:1614
amrex::GpuArray< amrex::Real, AMREX_SPACEDIM > abl_pressure_grad
Applied ABL pressure-gradient forcing vector.
Definition: ERF_DataStruct.H:1611
amrex::Vector< int > anelastic
Per-level flag selecting anelastic dynamics.
Definition: ERF_DataStruct.H:1399
bool four_stream_radiation
Whether the four-stream radiation approximation is enabled.
Definition: ERF_DataStruct.H:1445
int gradp_type
Terrain-fitted horizontal pressure-gradient formulation.
Definition: ERF_DataStruct.H:1436
DampingChoice dampingChoice
Damping-related options.
Definition: ERF_DataStruct.H:1391
amrex::Real if_damp_alpha
Immersed-forcing damping coefficient.
Definition: ERF_DataStruct.H:1466
bool rebalance_wrf_input
Whether to rebalance states from wrfinput and wrfbdy data.
Definition: ERF_DataStruct.H:1472
amrex::Real turb_disk_angle
Turbine disk angle from the x axis [deg].
Definition: ERF_DataStruct.H:1628
amrex::Real hindcast_data_interval_in_hrs
Time interval between hindcast data files [hr].
Definition: ERF_DataStruct.H:1659
amrex::Real const_massflux_layer_hi
Upper height of the constant-mass-flux forcing layer.
Definition: ERF_DataStruct.H:1654
std::string windfarm_spec_table_extra
Additional wind-farm turbine specification table path.
Definition: ERF_DataStruct.H:1625
amrex::Real if_ws_floor
Wind-speed floor for immersed-forcing MOST [m/s].
Definition: ERF_DataStruct.H:1465
bool is_init_for_ensemble
Whether initialization is for an ensemble simulation.
Definition: ERF_DataStruct.H:1669
bool uses_shoc_family() const noexcept
Query whether any SHOC-family PBL scheme is active.
Definition: ERF_DataStruct.H:1566
bool test_mapfactor
Whether to use test map scale factors.
Definition: ERF_DataStruct.H:1434
std::string coarse_bckgnd_data_file
Coarse background data file used for ensemble initialization.
Definition: ERF_DataStruct.H:1673
bool do_forest_drag
Whether forest canopy drag is enabled.
Definition: ERF_DataStruct.H:1647
amrex::Real dz0
Initial vertical grid spacing for stretched-grid setup.
Definition: ERF_DataStruct.H:1482
amrex::Real windfarm_x_shift
Wind-farm x-coordinate shift.
Definition: ERF_DataStruct.H:1629
bool use_lagged_delta_rt
Whether to use lagged delta terms for moving terrain.
Definition: ERF_DataStruct.H:1469
amrex::Real ens_pert_amplitude
Amplitude of ensemble initialization perturbations.
Definition: ERF_DataStruct.H:1672
std::string windfarm_airfoil_tables
Wind-farm airfoil table paths.
Definition: ERF_DataStruct.H:1626
amrex::Real bdy_rho_nudge_factor
Definition: ERF_DataStruct.H:1638
amrex::Vector< amrex::Vector< amrex::Real > > vert_implicit_fac
Per-level, per-stage implicit vertical diffusion factors.
Definition: ERF_DataStruct.H:1416
bool transport_scalar
Whether the passive scalar component is transported.
Definition: ERF_DataStruct.H:1512
bool hindcast_zhi_sponge_damping
Whether upper-boundary hindcast sponge damping is enabled.
Definition: ERF_DataStruct.H:1664
amrex::Real hurricane_eye_longitude
Initial hurricane-eye longitude.
Definition: ERF_DataStruct.H:1667
LandSurfaceType lsm_type
Land-surface model.
Definition: ERF_DataStruct.H:1607
int massflux_khi
Upper vertical index for constant-mass-flux forcing.
Definition: ERF_DataStruct.H:1656
bool substepping_diag
Whether to emit extra CFL diagnostics for compressible substepping.
Definition: ERF_DataStruct.H:1406
static TerrainType terrain_type
Terrain or immersed-boundary representation.
Definition: ERF_DataStruct.H:1368
std::string windfarm_blade_table
Wind-farm blade table path.
Definition: ERF_DataStruct.H:1626
amrex::Vector< int > is_land
Per-level land/water selector.
Definition: ERF_DataStruct.H:1403
amrex::Real hindcast_lateral_sponge_strength
Strength of the hindcast lateral sponge layer.
Definition: ERF_DataStruct.H:1662
amrex::Real hurricane_eye_latitude
Initial hurricane-eye latitude.
Definition: ERF_DataStruct.H:1667
amrex::Real cosphi
Cosine of the latitude used for Coriolis forcing.
Definition: ERF_DataStruct.H:1486
amrex::Real if_Cd_scalar
Immersed-forcing drag coefficient for scalars.
Definition: ERF_DataStruct.H:1453
static BuildingsType buildings_type
Building representation.
Definition: ERF_DataStruct.H:1371
std::string windfarm_loc_table
Wind-farm location table path.
Definition: ERF_DataStruct.H:1625
std::string hindcast_surface_data_dir
Directory containing hindcast surface boundary data.
Definition: ERF_DataStruct.H:1658
bool custom_rhotheta_forcing
Whether custom rho-theta forcing is enabled.
Definition: ERF_DataStruct.H:1490
amrex::Real zsurf
Nominal surface height for stretched-grid setup.
Definition: ERF_DataStruct.H:1481
amrex::Real if_init_surf_temp
Initial immersed-forcing surface temperature [K].
Definition: ERF_DataStruct.H:1460
int massflux_klo
Lower vertical index for constant-mass-flux forcing.
Definition: ERF_DataStruct.H:1655
std::string windfarm_spec_table
Wind-farm turbine specification table path.
Definition: ERF_DataStruct.H:1625
amrex::GpuArray< amrex::Real, AMREX_SPACEDIM > abl_geo_forcing
Applied geostrophic-wind forcing vector.
Definition: ERF_DataStruct.H:1612
ABLDriverType abl_driver_type
Atmospheric boundary-layer driver type.
Definition: ERF_DataStruct.H:1610
DiffChoice diffChoice
Diffusion-related options.
Definition: ERF_DataStruct.H:1390
amrex::Real if_surf_temp_flux
Immersed-forcing surface temperature flux [K m/s].
Definition: ERF_DataStruct.H:1459
bool spatial_rhotheta_forcing
Whether spatially varying rho-theta forcing is enabled.
Definition: ERF_DataStruct.H:1497
WindFarmType windfarm_type
Wind-farm model.
Definition: ERF_DataStruct.H:1605
bool use_source_perturbation(int lev) const
Query whether source-term turbulent perturbations are enabled on a level.
Definition: ERF_DataStruct.H:1547
bool custom_w_subsidence
Whether custom vertical subsidence is enabled.
Definition: ERF_DataStruct.H:1492
bool custom_moisture_forcing
Whether custom moisture forcing is enabled.
Definition: ERF_DataStruct.H:1491
amrex::Real if_surf_heating_rate
Immersed-forcing surface heating rate [K/hr].
Definition: ERF_DataStruct.H:1461
MoistureComponentIndices moisture_indices
Conserved-state component indices for active moisture species.
Definition: ERF_DataStruct.H:1621
RadiationType rad_type
Radiation model.
Definition: ERF_DataStruct.H:1608
amrex::Real grid_stretching_ratio
Vertical grid stretching ratio.
Definition: ERF_DataStruct.H:1480
bool hindcast_surface_bcs
Whether hindcast surface boundary conditions are enabled.
Definition: ERF_DataStruct.H:1661
bool immersed_forcing_substep
Whether immersed-forcing source terms are applied only during substeps.
Definition: ERF_DataStruct.H:1448
bool if_use_most
Whether immersed-forcing MOST is enabled.
Definition: ERF_DataStruct.H:1463
amrex::Real const_massflux_tau
Relaxation time scale for constant-mass-flux forcing.
Definition: ERF_DataStruct.H:1652
amrex::Real hindcast_lateral_sponge_length
Length of the hindcast lateral sponge layer.
Definition: ERF_DataStruct.H:1662
bool use_eamxx_shoc
Whether any level uses the EAMxx SHOC PBL scheme.
Definition: ERF_DataStruct.H:1508
amrex::Real sinphi
Sine of the latitude used for Coriolis forcing.
Definition: ERF_DataStruct.H:1487
amrex::Real hindcast_zhi_sponge_strength
Strength of the upper hindcast sponge layer.
Definition: ERF_DataStruct.H:1663
bool coriolis_3d
Whether the three-dimensional Coriolis terms are included.
Definition: ERF_DataStruct.H:1443
int force_stage1_single_substep
Flag forcing a single substep in the first RK stage.
Definition: ERF_DataStruct.H:1396
amrex::Real c_p
Specific heat at constant pressure for dry air [J/(kg-K)].
Definition: ERF_DataStruct.H:1476
bool if_implicit_drag
Definition: ERF_DataStruct.H:1456
bool implicit_momentum_diffusion
Whether implicit vertical momentum diffusion is included.
Definition: ERF_DataStruct.H:1422
bool do_mom_advection
Whether custom vertical subsidence is applied to momentum.
Definition: ERF_DataStruct.H:1494
bool if_stability_correction
Whether immersed-forcing stability corrections are enabled.
Definition: ERF_DataStruct.H:1464
bool custom_forcing_prim_vars
Whether custom forcing operates on primitive variables.
Definition: ERF_DataStruct.H:1496
bool nudging_from_input_sounding
Whether solution fields are nudged toward input sounding data.
Definition: ERF_DataStruct.H:1502
static void set_mesh_type(MeshType new_mesh_type)
Override the globally selected mesh type.
Definition: ERF_DataStruct.H:1384
bool use_num_diff
Whether sixth-order numerical diffusion is enabled.
Definition: ERF_DataStruct.H:1600
Definition: ERF_SpongeStruct.H:22
void display()
Print the configured sponge-layer options.
Definition: ERF_SpongeStruct.H:85
void init_params(std::string pp_prefix)
Read sponge-layer options from the input parameter database.
Definition: ERF_SpongeStruct.H:28