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>
34 None, Input_Sounding, NCFile, WRFInput, Metgrid, Uniform
38 ConstantDensity, Ideal, Isentropic, DryIsentropic
42 None, PressureGradient, GeostrophicWind
50 None, Explicit, Implicit
54 ConstantDz, StretchedDz, VariableDz
58 None, StaticFittedMesh, MovingFittedMesh, EB, ImmersedForcing
62 Eulerian, Lagrangian, Undefined
113 :
qv(qv_comp),
qc(qc_comp),
qi(qi_comp),
qr(qr_comp),
qs(qs_comp),
qg(qg_comp) {}
127 amrex::ParmParse
pp(pp_prefix);
130 if (
pp.query(
"use_terrain",
bogus) > 0) {
131 amrex::Abort(
"The input use_terrain is deprecated. Set terrain_type instead.");
137 "The grid stretching ratio must be greater than 1");
144 amrex::Print() <<
"Turning terrain on to enable grid stretching" << std::endl;
149 amrex::Print() <<
"Nominal zsurface height != 0, may result in unexpected behavior"
152 pp.get(
"initial_dz",
dz0);
161 amrex::Abort(
"The input moisture_type is deprecated. Set moisture_model instead.");
174 }
else if ( (
moisture_type == MoistureType::Morrison_NoIce) ||
182 }
else if ( (
moisture_type == MoistureType::SAM_NoPrecip_NoIce) ||
221 pp.query_enum_case_insensitive(
"land_surface_model",
lsm_type);
225 pp.query_enum_case_insensitive(
"radiation_model",
rad_type);
228 #ifndef ERF_USE_RRTMGP
229 if (
rad_type == RadiationType::RRTMGP)
231 amrex::Abort(
"ERF was not compiled with RRTMGP enabled!");
236 std::string terrain_type_temp =
"";
237 pp.query(
"terrain_type", terrain_type_temp);
238 if (terrain_type_temp ==
"Moving") {
239 amrex::Warning(
"erf.terrain_type = Moving is deprecated; please replace Moving by MovingFittedMesh");
241 }
else if (terrain_type_temp ==
"Static") {
242 amrex::Warning(
"erf.terrain_type = Static is deprecated; please replace Static by StaticFittedMesh");
251 std::string init_type_temp_string;
252 pp.query(
"init_type",init_type_temp_string);
253 if ( (init_type_temp_string ==
"Real") || (init_type_temp_string ==
"real") ) {
254 amrex::Warning(
"erf.init_type = Real is deprecated; please replace Real by WRFInput");
258 }
else if ( (init_type_temp_string ==
"Ideal") || (init_type_temp_string ==
"ideal") ) {
259 amrex::Warning(
"erf.init_type = Ideal is deprecated; please replace Ideal by WRFInput");
263 pp.query_enum_case_insensitive(
"init_type",
init_type);
272 amrex::Abort(
"Only terrain_type = StaticFittedMesh are allowed with init_type = WRFInput or Metgrid");
278 amrex::Abort(
"Can't have moisture_type = None with init_type = WRFInput");
282 std::string nc_bdy_file_temp_string;
283 bool has_bdy =
pp.query(
"nc_bdy_file", nc_bdy_file_temp_string);
287 pp.query(
"use_real_bcs", use_real_bcs_temp);
302 if (
init_type == InitType::Input_Sounding) {
311 int n_zlevels =
pp.countval(
"terrain_z_levels");
329 pp.query(
"c_p",
c_p);
339 for (
int i = 0; i <= max_level; i++) {
343 int nvals =
pp.countval(
"substepping_type");
344 AMREX_ALWAYS_ASSERT(nvals == 0 || nvals == 1 || nvals >= max_level+1);
348 for (
int i = 1; i <= max_level; i++) {
351 }
else if (nvals > 1) {
352 for (
int i = 0; i <= max_level; i++) {
360 int nvals_old =
pp.countval(
"no_substepping");
362 amrex::Abort(
"The no_substepping flag is deprecated -- set substepping_type instead");
366 bool any_anelastic =
false;
367 for (
int i = 0; i <= max_level; ++i) {
368 if (
anelastic[i] == 1) any_anelastic =
true;
371 if (any_anelastic == 1) {
387 for (
int lev = 0; lev <= max_level; lev++) {
417 AMREX_ASSERT_WITH_MESSAGE(
terrain_type != TerrainType::None,
"MOST stress rotations are only valid with terrain!");
431 pp.query_enum_case_insensitive(
"perturbation_type",
pert_type);
433 amrex::Vector<amrex::Real> abl_pressure_grad_in = {0.0, 0.0, 0.0};
434 pp.queryarr(
"abl_pressure_grad",abl_pressure_grad_in);
435 for(
int i = 0; i < AMREX_SPACEDIM; ++i)
abl_pressure_grad[i] = abl_pressure_grad_in[i];
437 amrex::Vector<amrex::Real> abl_geo_forcing_in = {0.0, 0.0, 0.0};
438 if(
pp.queryarr(
"abl_geo_forcing",abl_geo_forcing_in)) {
439 amrex::Print() <<
"Specified abl_geo_forcing: (";
440 for (
int i = 0; i < AMREX_SPACEDIM; ++i) {
444 amrex::Print() <<
")" << std::endl;
462 "Should not have both abl_geo_wind_table and custom_geostrophic_profile set.");
471 "Numerical diffusion coefficient must be between 0 & 1.");
474 amrex::Print() <<
"6th-order numerical diffusion turned on with coefficient = "
484 for (
int lev = 0; lev <= max_level; lev++) {
485 turbChoice[lev].init_params(lev,max_level,pp_prefix);
489 for (
int lev = 0; lev <= max_level; lev++) {
490 if (
turbChoice[lev].pbl_ysu_use_consistent_coriolis) {
494 amrex::Print() <<
"YSU PBL using ERF coriolis frequency: " <<
turbChoice[lev].pbl_ysu_coriolis_freq << std::endl;
497 amrex::Abort(
"YSU cannot use ERF coriolis frequency if not using coriolis");
502 for (
int lev = 0; lev <= max_level; lev++) {
503 if (
turbChoice[lev].pbl_ysu_use_consistent_coriolis) {
507 amrex::Print() <<
"MRF PBL using ERF coriolis frequency: " <<
turbChoice[lev].pbl_ysu_coriolis_freq << std::endl;
510 amrex::Abort(
"MRF cannot use ERF coriolis frequency if not using coriolis");
519 amrex::Abort(
"You set use_shoc to true but didn't build with SHOC; you must rebuild the executable");
531 static std::string windfarm_loc_type_string =
"None";
561 for (
int lev = 0; lev <= max_level; lev++) {
563 amrex::Warning(
"\n*** WARNING: Moisture may not yet be compatible with PBL models, \n proceed with caution ***");
570 amrex::Abort(
"buoyancy_type must be 1, 2, 3 or 4");
574 amrex::Error(
"Can't turn off lagged_delta_rt when terrain not moving");
581 amrex::Abort(
"To use simplified actuator disks, you need to provide a variable"
582 " erf.sampling_distance_by_D in the inputs which specifies the upstream"
583 " distance as a factor of the turbine diameter at which the incoming free stream"
584 " velocity will be computed at.");
588 amrex::Abort(
"To use simplified actuator disks, you need to provide a variable"
589 " erf.turb_disk_angle_from_x in the inputs which is the angle of the face of the"
590 " turbine disk from the x-axis. A turbine facing an oncoming flow in the x-direction"
591 " will have turb_disk_angle value of 90 deg.");
594 amrex::Abort(
"You are using windfarms with latitude-logitude option to position the turbines."
595 " For this you should provide the inputs erf.windfarm_x_shift and"
596 " erf.windfarm_y_shift which are the values by which the bounding box of the"
597 " windfarm is shifted from the x and the y axes.");
601 void display (
int max_level, std::string pp_prefix)
603 amrex::Print() <<
"SOLVER CHOICE: " << std::endl;
605 for (
int lev = 0; lev <= max_level; lev++) {
607 amrex::Print() <<
"Level " << lev <<
" is anelastic" << std::endl;
610 amrex::Print() <<
"No substepping at level " << lev << std::endl;
612 amrex::Print() <<
"Explicit substepping at level " << lev << std::endl;
614 amrex::Print() <<
"Implicit substepping at level " << lev << std::endl;
617 amrex::Print() <<
"fixed_density : " <<
fixed_density << std::endl;
618 amrex::Print() <<
"use_coriolis : " <<
use_coriolis << std::endl;
619 amrex::Print() <<
"use_gravity : " <<
use_gravity << std::endl;
622 amrex::Print() <<
"Moisture Model: SAM" << std::endl;
624 amrex::Print() <<
"Moisture Model: SAM No Ice" << std::endl;
625 }
else if (
moisture_type == MoistureType::SAM_NoPrecip_NoIce) {
626 amrex::Print() <<
"Moisture Model: SAM No Precip No Ice" << std::endl;
628 amrex::Print() <<
"Moisture Model: Morrison" << std::endl;
630 amrex::Print() <<
"Moisture Model: Morrison_NoIce" << std::endl;
632 amrex::Print() <<
"Moisture Model: Kessler" << std::endl;
634 amrex::Print() <<
"Moisture Model: Kessler No Rain" << std::endl;
636 amrex::Print() <<
"Moisture Model: Saturation Adjustment" << std::endl;
638 amrex::Print() <<
"Moisture Model: None" << std::endl;
642 amrex::Print() <<
"Terrain Type: StaticFittedMesh" << std::endl;
643 }
else if (
terrain_type == TerrainType::MovingFittedMesh) {
644 amrex::Print() <<
"Terrain Type: MovingFittedMesh" << std::endl;
646 amrex::Print() <<
"Terrain Type: EB" << std::endl;
647 }
else if (
terrain_type == TerrainType::ImmersedForcing) {
648 amrex::Print() <<
"Terrain Type: ImmersedForcing" << std::endl;
650 amrex::Print() <<
"Terrain Type: None" << std::endl;
654 amrex::Print() <<
" Mesh Type: ConstantDz" << std::endl;
655 }
else if (
mesh_type == MeshType::StretchedDz) {
656 amrex::Print() <<
" Mesh Type: StretchedDz" << std::endl;
657 }
else if (
mesh_type == MeshType::VariableDz) {
658 amrex::Print() <<
" Mesh Type: VariableDz" << std::endl;
660 amrex::Abort(
"No mesh_type set!");
663 amrex::Print() <<
"ABL Driver Type: " << std::endl;
665 amrex::Print() <<
" None" << std::endl;
667 amrex::Print() <<
" Pressure Gradient "
671 amrex::Print() <<
" Geostrophic Wind "
677 amrex::Print() <<
"Coupling Type: " << std::endl;
679 amrex::Print() <<
" Two-way" << std::endl;
681 amrex::Print() <<
" One-way" << std::endl;
685 if (
rad_type == RadiationType::RRTMGP) {
686 amrex::Print() <<
"Radiation Model: RRTMGP" << std::endl;
688 amrex::Print() <<
"Radiation Model: None" << std::endl;
691 amrex::Print() <<
"Buoyancy_type : " <<
buoyancy_type << std::endl;
697 for (
int lev = 0; lev <= max_level; lev++) {
704 amrex::ParmParse
pp(pp_prefix);
708 pp.query(
"rotational_time_period", rot_time_period);
713 pp.query(
"latitude", latitude);
718 latitude *= (
PI/180.);
719 sinphi = std::sin(latitude);
721 cosphi = std::cos(latitude);
729 amrex::Vector<amrex::Real> abl_geo_wind(3);
730 pp.queryarr(
"abl_geo_wind",abl_geo_wind);
739 amrex::Print() <<
"NOTE: abl_geo_wind_table provided, ignoring input abl_geo_wind" << std::endl;
745 amrex::Vector<int>& vec_to_fill,
int default_int)
747 amrex::ParmParse
pp(
"erf");
748 int nvals =
pp.countval(string_to_read);
749 AMREX_ALWAYS_ASSERT(nvals == 0 || nvals == 1 || nvals >= max_level+1);
750 amrex::Vector<int> temp; temp.resize(nvals);
751 pp.queryarr(string_to_read,temp);
753 for (
int i = 0; i <= max_level; ++i) vec_to_fill.push_back(default_int);
754 }
else if (nvals == 1) {
755 for (
int i = 0; i <= max_level; ++i) vec_to_fill.push_back(temp[0]);
757 for (
int i = 0; i <= max_level; ++i) vec_to_fill.push_back(temp[i]);
constexpr amrex::Real Cp_d
Definition: ERF_Constants.H:12
constexpr amrex::Real PI
Definition: ERF_Constants.H:6
constexpr amrex::Real CONST_GRAV
Definition: ERF_Constants.H:21
constexpr amrex::Real R_d
Definition: ERF_Constants.H:10
TauType
Definition: ERF_DataStruct.H:29
@ tau12
Definition: ERF_DataStruct.H:30
@ tau23
Definition: ERF_DataStruct.H:30
@ tau33
Definition: ERF_DataStruct.H:30
@ tau22
Definition: ERF_DataStruct.H:30
@ tau11
Definition: ERF_DataStruct.H:30
@ tau32
Definition: ERF_DataStruct.H:30
@ tau31
Definition: ERF_DataStruct.H:30
@ tau21
Definition: ERF_DataStruct.H:30
@ tau13
Definition: ERF_DataStruct.H:30
Rayleigh
Definition: ERF_DataStruct.H:90
@ ubar
Definition: ERF_DataStruct.H:91
@ wbar
Definition: ERF_DataStruct.H:91
@ nvars
Definition: ERF_DataStruct.H:91
@ vbar
Definition: ERF_DataStruct.H:91
@ thetabar
Definition: ERF_DataStruct.H:91
Sponge
Definition: ERF_DataStruct.H:95
@ nvars_sponge
Definition: ERF_DataStruct.H:96
@ vbar_sponge
Definition: ERF_DataStruct.H:96
@ ubar_sponge
Definition: ERF_DataStruct.H:96
MapFacType
Definition: ERF_DataStruct.H:20
@ v_x
Definition: ERF_DataStruct.H:22
@ num
Definition: ERF_DataStruct.H:22
@ u_y
Definition: ERF_DataStruct.H:23
@ v_y
Definition: ERF_DataStruct.H:23
@ m_y
Definition: ERF_DataStruct.H:23
@ u_x
Definition: ERF_DataStruct.H:22
@ m_x
Definition: ERF_DataStruct.H:22
Coord
Definition: ERF_DataStruct.H:85
AMREX_ENUM(InitType, None, Input_Sounding, NCFile, WRFInput, Metgrid, Uniform)
#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 RhoQ1_comp
Definition: ERF_IndexDefines.H:42
#define RhoQ6_comp
Definition: ERF_IndexDefines.H:47
#define RhoQ5_comp
Definition: ERF_IndexDefines.H:46
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real pp(amrex::Real y)
Definition: ERF_MicrophysicsUtils.H:230
amrex::Real Real
Definition: ERF_ShocInterface.H:16
Definition: ERF_Fitch.H:9
Definition: ERF_GeneralAD.H:8
Definition: ERF_Kessler.H:38
Definition: ERF_Morrison.H:58
Definition: ERF_NOAHMP.H:37
Definition: ERF_SatAdj.H:41
Definition: ERF_SimpleAD.H:8
@ bogus
Definition: ERF_IndexDefines.H:204
Definition: ERF_AdvStruct.H:19
void display(std::string &pp_prefix)
Definition: ERF_AdvStruct.H:211
void init_params(std::string pp_prefix)
Definition: ERF_AdvStruct.H:21
Definition: ERF_DiffStruct.H:19
void init_params(std::string pp_prefix)
Definition: ERF_DiffStruct.H:21
void display()
Definition: ERF_DiffStruct.H:67
Definition: ERF_DataStruct.H:99
int qs
Definition: ERF_DataStruct.H:104
int qr
Definition: ERF_DataStruct.H:103
MoistureComponentIndices()=default
int qi
Definition: ERF_DataStruct.H:102
int qv
Definition: ERF_DataStruct.H:100
int qc
Definition: ERF_DataStruct.H:101
int qg
Definition: ERF_DataStruct.H:105
MoistureComponentIndices(int qv_comp, int qc_comp, int qi_comp=-1, int qr_comp=-1, int qs_comp=-1, int qg_comp=-1)
Definition: ERF_DataStruct.H:108
Definition: ERF_DataStruct.H:123
bool rayleigh_damp_T
Definition: ERF_DataStruct.H:812
amrex::Real dz0
Definition: ERF_DataStruct.H:833
amrex::Real const_massflux_layer_lo
Definition: ERF_DataStruct.H:910
bool use_lagged_delta_rt
Definition: ERF_DataStruct.H:823
amrex::Real coriolis_factor
Definition: ERF_DataStruct.H:838
static MeshType mesh_type
Definition: ERF_DataStruct.H:777
amrex::Real windfarm_x_shift
Definition: ERF_DataStruct.H:900
bool rayleigh_damp_V
Definition: ERF_DataStruct.H:810
void display(int max_level, std::string pp_prefix)
Definition: ERF_DataStruct.H:601
bool rebalance_wrfinput
Definition: ERF_DataStruct.H:870
amrex::Real poisson_reltol
Definition: ERF_DataStruct.H:798
bool rayleigh_damp_substep
Definition: ERF_DataStruct.H:816
void build_coriolis_forcings_const_lat(std::string pp_prefix)
Definition: ERF_DataStruct.H:702
amrex::Real rayleigh_zdamp
Definition: ERF_DataStruct.H:814
amrex::Real rdOcp
Definition: ERF_DataStruct.H:828
RadiationType rad_type
Definition: ERF_DataStruct.H:877
void read_int_string(int max_level, const char *string_to_read, amrex::Vector< int > &vec_to_fill, int default_int)
Definition: ERF_DataStruct.H:744
std::string windfarm_spec_table
Definition: ERF_DataStruct.H:896
DiffChoice diffChoice
Definition: ERF_DataStruct.H:786
amrex::Real const_massflux_v
Definition: ERF_DataStruct.H:908
bool use_gravity
Definition: ERF_DataStruct.H:805
int ncorr
Definition: ERF_DataStruct.H:796
int force_stage1_single_substep
Definition: ERF_DataStruct.H:790
std::string windfarm_spec_table_extra
Definition: ERF_DataStruct.H:896
amrex::Real cosphi
Definition: ERF_DataStruct.H:839
LandSurfaceType lsm_type
Definition: ERF_DataStruct.H:876
amrex::Real c_p
Definition: ERF_DataStruct.H:827
std::string windfarm_loc_table
Definition: ERF_DataStruct.H:896
amrex::Real gravity
Definition: ERF_DataStruct.H:826
void check_params(int max_level)
Definition: ERF_DataStruct.H:558
bool custom_rhotheta_forcing
Definition: ERF_DataStruct.H:843
amrex::GpuArray< amrex::Real, AMREX_SPACEDIM > abl_geo_forcing
Definition: ERF_DataStruct.H:881
bool use_shoc
Definition: ERF_DataStruct.H:857
WindFarmLocType windfarm_loc_type
Definition: ERF_DataStruct.H:875
int massflux_klo
Definition: ERF_DataStruct.H:912
bool moisture_tight_coupling
Definition: ERF_DataStruct.H:894
bool custom_w_subsidence
Definition: ERF_DataStruct.H:845
bool nudging_from_input_sounding
Definition: ERF_DataStruct.H:851
bool rayleigh_damp_U
Definition: ERF_DataStruct.H:809
bool custom_geostrophic_profile
Definition: ERF_DataStruct.H:846
amrex::Real rayleigh_ztop
Definition: ERF_DataStruct.H:815
bool immersed_forcing_substep
Definition: ERF_DataStruct.H:819
amrex::Real grid_stretching_ratio
Definition: ERF_DataStruct.H:831
amrex::Real sinphi
Definition: ERF_DataStruct.H:840
bool have_geo_wind_profile
Definition: ERF_DataStruct.H:883
amrex::Real const_massflux_u
Definition: ERF_DataStruct.H:907
amrex::GpuArray< amrex::Real, AMREX_SPACEDIM > abl_pressure_grad
Definition: ERF_DataStruct.H:880
void init_params(int max_level, std::string pp_prefix)
Definition: ERF_DataStruct.H:125
amrex::Vector< SubsteppingType > substepping_type
Definition: ERF_DataStruct.H:792
bool coriolis_3d
Definition: ERF_DataStruct.H:807
bool use_num_diff
Definition: ERF_DataStruct.H:866
amrex::Real sampling_distance_by_D
Definition: ERF_DataStruct.H:898
bool test_mapfactor
Definition: ERF_DataStruct.H:800
bool use_coriolis
Definition: ERF_DataStruct.H:806
static SoundingType sounding_type
Definition: ERF_DataStruct.H:765
bool custom_moisture_forcing
Definition: ERF_DataStruct.H:844
amrex::Real num_diff_coeff
Definition: ERF_DataStruct.H:867
std::string windfarm_blade_table
Definition: ERF_DataStruct.H:897
bool fixed_density
Definition: ERF_DataStruct.H:795
amrex::Real zsurf
Definition: ERF_DataStruct.H:832
amrex::Vector< TurbChoice > turbChoice
Definition: ERF_DataStruct.H:788
bool variable_coriolis
Definition: ERF_DataStruct.H:886
bool project_initial_velocity
Definition: ERF_DataStruct.H:835
amrex::Vector< int > anelastic
Definition: ERF_DataStruct.H:793
static bool upwind_real_bcs
Definition: ERF_DataStruct.H:774
AdvChoice advChoice
Definition: ERF_DataStruct.H:785
bool use_moist_background
Definition: ERF_DataStruct.H:891
MoistureType moisture_type
Definition: ERF_DataStruct.H:873
bool custom_forcing_prim_vars
Definition: ERF_DataStruct.H:847
std::string abl_geo_wind_table
Definition: ERF_DataStruct.H:882
static TerrainType terrain_type
Definition: ERF_DataStruct.H:768
ABLDriverType abl_driver_type
Definition: ERF_DataStruct.H:879
bool rayleigh_damp_W
Definition: ERF_DataStruct.H:811
PerturbationType pert_type
Definition: ERF_DataStruct.H:863
SpongeChoice spongeChoice
Definition: ERF_DataStruct.H:787
WindFarmType windfarm_type
Definition: ERF_DataStruct.H:874
static InitType init_type
Definition: ERF_DataStruct.H:762
amrex::Real const_massflux_layer_hi
Definition: ERF_DataStruct.H:911
static bool use_real_bcs
Definition: ERF_DataStruct.H:771
int buoyancy_type
Definition: ERF_DataStruct.H:802
amrex::Real poisson_abstol
Definition: ERF_DataStruct.H:797
MoistureComponentIndices moisture_indices
Definition: ERF_DataStruct.H:892
amrex::Real turb_disk_angle
Definition: ERF_DataStruct.H:899
amrex::Real windfarm_y_shift
Definition: ERF_DataStruct.H:901
bool do_hurricane_simulation
Definition: ERF_DataStruct.H:915
bool has_lat_lon
Definition: ERF_DataStruct.H:885
bool use_rotate_surface_flux
Definition: ERF_DataStruct.H:854
bool do_forest_drag
Definition: ERF_DataStruct.H:904
amrex::Real const_massflux_tau
Definition: ERF_DataStruct.H:909
int massflux_khi
Definition: ERF_DataStruct.H:913
bool time_avg_vel
Definition: ERF_DataStruct.H:860
bool forest_substep
Definition: ERF_DataStruct.H:820
amrex::Real rayleigh_dampcoef
Definition: ERF_DataStruct.H:813
CouplingType coupling_type
Definition: ERF_DataStruct.H:872
std::string windfarm_airfoil_tables
Definition: ERF_DataStruct.H:897
static void set_mesh_type(MeshType new_mesh_type)
Definition: ERF_DataStruct.H:780
int ave_plane
Definition: ERF_DataStruct.H:888
Definition: ERF_SpongeStruct.H:15
void display()
Definition: ERF_SpongeStruct.H:45
void init_params(std::string pp_prefix)
Definition: ERF_SpongeStruct.H:17