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>
30 None, Input_Sounding, NCFile, WRFInput, Metgrid, Uniform
34 None, PressureGradient, GeostrophicWind
42 None, Explicit, Implicit
46 ConstantDz, StretchedDz, VariableDz
50 None, StaticFittedMesh, MovingFittedMesh, EB, ImmersedForcing
54 Eulerian, Lagrangian, Undefined
99 amrex::ParmParse
pp(pp_prefix);
102 if (
pp.query(
"use_terrain",
bogus) > 0) {
103 amrex::Abort(
"The input use_terrain is deprecated. Set terrain_type instead.");
109 "The grid stretching ratio must be greater than 1");
116 amrex::Print() <<
"Turning terrain on to enable grid stretching" << std::endl;
121 amrex::Print() <<
"Nominal zsurface height != 0, may result in unexpected behavior"
124 pp.get(
"initial_dz",
dz0);
133 amrex::Abort(
"The input moisture_type is deprecated. Set moisture_model instead.");
143 }
else if ( (
moisture_type == MoistureType::SAM_NoPrecip_NoIce) ||
176 pp.query_enum_case_insensitive(
"land_surface_model",
lsm_type);
180 pp.query_enum_case_insensitive(
"radiation_model",
rad_type);
183 #ifndef ERF_USE_RRTMGP
184 if (
rad_type == RadiationType::RRTMGP)
186 amrex::Abort(
"ERF was not compiled with RRTMGP enabled!");
191 std::string terrain_type_temp =
"";
192 pp.query(
"terrain_type", terrain_type_temp);
193 if (terrain_type_temp ==
"Moving") {
194 amrex::Warning(
"erf.terrain_type = Moving is deprecated; please replace Moving by MovingFittedMesh");
196 }
else if (terrain_type_temp ==
"Static") {
197 amrex::Warning(
"erf.terrain_type = Static is deprecated; please replace Static by StaticFittedMesh");
206 std::string init_type_temp_string;
207 pp.query(
"init_type",init_type_temp_string);
208 if ( (init_type_temp_string ==
"Real") || (init_type_temp_string ==
"real") ) {
209 amrex::Warning(
"erf.init_type = Real is deprecated; please replace Real by WRFInput");
212 }
else if ( (init_type_temp_string ==
"Ideal") || (init_type_temp_string ==
"ideal") ) {
213 amrex::Warning(
"erf.init_type = Ideal is deprecated; please replace Ideal by WRFInput");
217 pp.query_enum_case_insensitive(
"init_type",
init_type);
223 amrex::Abort(
"Only terrain_type = StaticFittedMesh are allowed with init_type = WRFInput or Metgrid");
229 amrex::Abort(
"Can't have moisture_type = None with init_type = WRFInput");
233 std::string nc_bdy_file_temp_string;
234 bool has_bdy =
pp.query(
"nc_bdy_file", nc_bdy_file_temp_string);
238 pp.query(
"use_real_bcs", use_real_bcs_temp);
255 int n_zlevels =
pp.countval(
"terrain_z_levels");
273 pp.query(
"c_p",
c_p);
283 for (
int i = 0; i <= max_level; i++) {
287 int nvals =
pp.countval(
"substepping_type");
288 AMREX_ALWAYS_ASSERT(nvals == 0 || nvals == 1 || nvals >= max_level+1);
292 for (
int i = 1; i <= max_level; i++) {
295 }
else if (nvals > 1) {
296 for (
int i = 0; i <= max_level; i++) {
304 int nvals_old =
pp.countval(
"no_substepping");
306 amrex::Abort(
"The no_substepping flag is deprecated -- set substepping_type instead");
310 bool any_anelastic =
false;
311 for (
int i = 0; i <= max_level; ++i) {
312 if (
anelastic[i] == 1) any_anelastic =
true;
315 if (any_anelastic == 1) {
331 for (
int lev = 0; lev <= max_level; lev++) {
361 AMREX_ASSERT_WITH_MESSAGE(
terrain_type != TerrainType::None,
"MOST stress rotations are only valid with terrain!");
370 pp.query_enum_case_insensitive(
"perturbation_type",
pert_type);
372 amrex::Vector<amrex::Real> abl_pressure_grad_in = {0.0, 0.0, 0.0};
373 pp.queryarr(
"abl_pressure_grad",abl_pressure_grad_in);
374 for(
int i = 0; i < AMREX_SPACEDIM; ++i)
abl_pressure_grad[i] = abl_pressure_grad_in[i];
376 amrex::Vector<amrex::Real> abl_geo_forcing_in = {0.0, 0.0, 0.0};
377 if(
pp.queryarr(
"abl_geo_forcing",abl_geo_forcing_in)) {
378 amrex::Print() <<
"Specified abl_geo_forcing: (";
379 for (
int i = 0; i < AMREX_SPACEDIM; ++i) {
383 amrex::Print() <<
")" << std::endl;
401 "Should not have both abl_geo_wind_table and custom_geostrophic_profile set.");
410 "Numerical diffusion coefficient must be between 0 & 1.");
413 amrex::Print() <<
"6th-order numerical diffusion turned on with coefficient = "
426 for (
int lev = 0; lev <= max_level; lev++) {
427 turbChoice[lev].init_params(lev,max_level,pp_prefix);
431 for (
int lev = 0; lev <= max_level; lev++) {
432 if (
turbChoice[lev].pbl_ysu_use_consistent_coriolis) {
436 amrex::Print() <<
"YSU PBL using ERF coriolis frequency: " <<
turbChoice[lev].pbl_ysu_coriolis_freq << std::endl;
439 amrex::Abort(
"YSU cannot use ERF coriolis frequency if not using coriolis");
453 static std::string windfarm_loc_type_string =
"None";
481 for (
int lev = 0; lev <= max_level; lev++) {
483 amrex::Warning(
"\n*** WARNING: Moisture may not yet be compatible with PBL models, \n proceed with caution ***");
490 amrex::Abort(
"buoyancy_type must be 1, 2, 3 or 4");
494 amrex::Error(
"Can't turn off lagged_delta_rt when terrain not moving");
501 amrex::Abort(
"To use simplified actuator disks, you need to provide a variable"
502 " erf.sampling_distance_by_D in the inputs which specifies the upstream"
503 " distance as a factor of the turbine diameter at which the incoming free stream"
504 " velocity will be computed at.");
508 amrex::Abort(
"To use simplified actuator disks, you need to provide a variable"
509 " erf.turb_disk_angle_from_x in the inputs which is the angle of the face of the"
510 " turbine disk from the x-axis. A turbine facing an oncoming flow in the x-direction"
511 " will have turb_disk_angle value of 90 deg.");
514 amrex::Abort(
"You are using windfarms with latitude-logitude option to position the turbines."
515 " For this you should provide the inputs erf.windfarm_x_shift and"
516 " erf.windfarm_y_shift which are the values by which the bounding box of the"
517 " windfarm is shifted from the x and the y axes.");
521 void display (
int max_level, std::string pp_prefix)
523 amrex::Print() <<
"SOLVER CHOICE: " << std::endl;
525 for (
int lev = 0; lev <= max_level; lev++) {
526 amrex::Print() <<
"anelastic at level : " << lev <<
" is " <<
anelastic[lev] << std::endl;
528 amrex::Print() <<
"No substepping at level " << lev << std::endl;
530 amrex::Print() <<
"Explicit substepping at level " << lev << std::endl;
532 amrex::Print() <<
"Implicit substepping at level " << lev << std::endl;
535 amrex::Print() <<
"fixed_density : " <<
fixed_density << std::endl;
536 amrex::Print() <<
"use_coriolis : " <<
use_coriolis << std::endl;
537 amrex::Print() <<
"use_gravity : " <<
use_gravity << std::endl;
540 amrex::Print() <<
"Moisture Model: SAM" << std::endl;
542 amrex::Print() <<
"Moisture Model: SAM No Ice" << std::endl;
543 }
else if (
moisture_type == MoistureType::SAM_NoPrecip_NoIce) {
544 amrex::Print() <<
"Moisture Model: SAM No Precip No Ice" << std::endl;
546 amrex::Print() <<
"Moisture Model: Morrison" << std::endl;
548 amrex::Print() <<
"Moisture Model: Morrison_NoIce" << std::endl;
550 amrex::Print() <<
"Moisture Model: Kessler" << std::endl;
552 amrex::Print() <<
"Moisture Model: Kessler No Rain" << std::endl;
554 amrex::Print() <<
"Moisture Model: None" << std::endl;
558 amrex::Print() <<
"Terrain Type: StaticFittedMesh" << std::endl;
559 }
else if (
terrain_type == TerrainType::MovingFittedMesh) {
560 amrex::Print() <<
"Terrain Type: MovingFittedMesh" << std::endl;
562 amrex::Print() <<
"Terrain Type: EB" << std::endl;
563 }
else if (
terrain_type == TerrainType::ImmersedForcing) {
564 amrex::Print() <<
"Terrain Type: ImmersedForcing" << std::endl;
566 amrex::Print() <<
"Terrain Type: None" << std::endl;
570 amrex::Print() <<
" Mesh Type: ConstantDz" << std::endl;
571 }
else if (
mesh_type == MeshType::StretchedDz) {
572 amrex::Print() <<
" Mesh Type: StretchedDz" << std::endl;
573 }
else if (
mesh_type == MeshType::VariableDz) {
574 amrex::Print() <<
" Mesh Type: VariableDz" << std::endl;
576 amrex::Abort(
"No mesh_type set!");
579 amrex::Print() <<
"ABL Driver Type: " << std::endl;
581 amrex::Print() <<
" None" << std::endl;
583 amrex::Print() <<
" Pressure Gradient "
587 amrex::Print() <<
" Geostrophic Wind "
593 amrex::Print() <<
"Coupling Type: " << std::endl;
595 amrex::Print() <<
" Two-way" << std::endl;
597 amrex::Print() <<
" One-way" << std::endl;
601 if (
rad_type == RadiationType::RRTMGP) {
602 amrex::Print() <<
"Radiation Model: RRTMGP" << std::endl;
604 amrex::Print() <<
"Radiation Model: None" << std::endl;
607 amrex::Print() <<
"Buoyancy_type : " <<
buoyancy_type << std::endl;
613 for (
int lev = 0; lev <= max_level; lev++) {
620 amrex::ParmParse
pp(pp_prefix);
623 amrex::Real rot_time_period = 86400.0;
624 pp.query(
"rotational_time_period", rot_time_period);
628 amrex::Real latitude = 90.0;
629 pp.query(
"latitude", latitude);
634 latitude *= (
PI/180.);
635 sinphi = std::sin(latitude);
637 cosphi = std::cos(latitude);
645 amrex::Vector<amrex::Real> abl_geo_wind(3);
646 pp.queryarr(
"abl_geo_wind",abl_geo_wind);
655 amrex::Print() <<
"NOTE: abl_geo_wind_table provided, ignoring input abl_geo_wind" << std::endl;
661 amrex::Vector<int>& vec_to_fill,
int default_int)
663 amrex::ParmParse
pp(
"erf");
664 int nvals =
pp.countval(string_to_read);
665 AMREX_ALWAYS_ASSERT(nvals == 0 || nvals == 1 || nvals >= max_level+1);
666 amrex::Vector<int> temp; temp.resize(nvals);
667 pp.queryarr(string_to_read,temp);
669 for (
int i = 0; i <= max_level; ++i) vec_to_fill.push_back(default_int);
670 }
else if (nvals == 1) {
671 for (
int i = 0; i <= max_level; ++i) vec_to_fill.push_back(temp[0]);
673 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:25
@ tau12
Definition: ERF_DataStruct.H:26
@ tau23
Definition: ERF_DataStruct.H:26
@ tau33
Definition: ERF_DataStruct.H:26
@ tau22
Definition: ERF_DataStruct.H:26
@ tau11
Definition: ERF_DataStruct.H:26
@ tau32
Definition: ERF_DataStruct.H:26
@ tau31
Definition: ERF_DataStruct.H:26
@ tau21
Definition: ERF_DataStruct.H:26
@ tau13
Definition: ERF_DataStruct.H:26
Rayleigh
Definition: ERF_DataStruct.H:82
@ ubar
Definition: ERF_DataStruct.H:83
@ wbar
Definition: ERF_DataStruct.H:83
@ nvars
Definition: ERF_DataStruct.H:83
@ vbar
Definition: ERF_DataStruct.H:83
@ thetabar
Definition: ERF_DataStruct.H:83
Sponge
Definition: ERF_DataStruct.H:87
@ nvars_sponge
Definition: ERF_DataStruct.H:88
@ vbar_sponge
Definition: ERF_DataStruct.H:88
@ ubar_sponge
Definition: ERF_DataStruct.H:88
MapFacType
Definition: ERF_DataStruct.H:20
@ v_x
Definition: ERF_DataStruct.H:21
@ num
Definition: ERF_DataStruct.H:21
@ u_y
Definition: ERF_DataStruct.H:22
@ v_y
Definition: ERF_DataStruct.H:22
@ m_y
Definition: ERF_DataStruct.H:22
@ u_x
Definition: ERF_DataStruct.H:21
@ m_x
Definition: ERF_DataStruct.H:21
Coord
Definition: ERF_DataStruct.H:77
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
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real pp(amrex::Real y)
Definition: ERF_MicrophysicsUtils.H:219
Definition: ERF_Fitch.H:9
Definition: ERF_GeneralAD.H:8
Definition: ERF_Kessler.H:38
Definition: ERF_Morrison.H:58
Definition: ERF_NOAH.H:30
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:190
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:64
Definition: ERF_DataStruct.H:95
bool rayleigh_damp_T
Definition: ERF_DataStruct.H:722
amrex::Real dz0
Definition: ERF_DataStruct.H:743
bool use_lagged_delta_rt
Definition: ERF_DataStruct.H:733
amrex::Real coriolis_factor
Definition: ERF_DataStruct.H:748
static MeshType mesh_type
Definition: ERF_DataStruct.H:687
amrex::Real windfarm_x_shift
Definition: ERF_DataStruct.H:815
bool rayleigh_damp_V
Definition: ERF_DataStruct.H:720
int RhoQr_comp
Definition: ERF_DataStruct.H:809
void display(int max_level, std::string pp_prefix)
Definition: ERF_DataStruct.H:521
bool rebalance_wrfinput
Definition: ERF_DataStruct.H:780
amrex::Real poisson_reltol
Definition: ERF_DataStruct.H:708
bool rayleigh_damp_substep
Definition: ERF_DataStruct.H:726
void build_coriolis_forcings_const_lat(std::string pp_prefix)
Definition: ERF_DataStruct.H:618
amrex::Real rayleigh_zdamp
Definition: ERF_DataStruct.H:724
amrex::Real rdOcp
Definition: ERF_DataStruct.H:738
RadiationType rad_type
Definition: ERF_DataStruct.H:787
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:660
std::string windfarm_spec_table
Definition: ERF_DataStruct.H:811
bool use_mono_adv
Definition: ERF_DataStruct.H:777
DiffChoice diffChoice
Definition: ERF_DataStruct.H:696
bool use_gravity
Definition: ERF_DataStruct.H:715
int ncorr
Definition: ERF_DataStruct.H:706
int force_stage1_single_substep
Definition: ERF_DataStruct.H:700
std::string windfarm_spec_table_extra
Definition: ERF_DataStruct.H:811
amrex::Real cosphi
Definition: ERF_DataStruct.H:749
LandSurfaceType lsm_type
Definition: ERF_DataStruct.H:786
amrex::Real c_p
Definition: ERF_DataStruct.H:737
std::string windfarm_loc_table
Definition: ERF_DataStruct.H:811
amrex::Real gravity
Definition: ERF_DataStruct.H:736
void check_params(int max_level)
Definition: ERF_DataStruct.H:478
bool custom_rhotheta_forcing
Definition: ERF_DataStruct.H:753
amrex::GpuArray< amrex::Real, AMREX_SPACEDIM > abl_geo_forcing
Definition: ERF_DataStruct.H:791
WindFarmLocType windfarm_loc_type
Definition: ERF_DataStruct.H:785
bool custom_w_subsidence
Definition: ERF_DataStruct.H:755
bool nudging_from_input_sounding
Definition: ERF_DataStruct.H:761
bool rayleigh_damp_U
Definition: ERF_DataStruct.H:719
int RhoQc_comp
Definition: ERF_DataStruct.H:803
bool custom_geostrophic_profile
Definition: ERF_DataStruct.H:756
amrex::Real rayleigh_ztop
Definition: ERF_DataStruct.H:725
bool immersed_forcing_substep
Definition: ERF_DataStruct.H:729
amrex::Real grid_stretching_ratio
Definition: ERF_DataStruct.H:741
amrex::Real sinphi
Definition: ERF_DataStruct.H:750
bool have_geo_wind_profile
Definition: ERF_DataStruct.H:793
amrex::GpuArray< amrex::Real, AMREX_SPACEDIM > abl_pressure_grad
Definition: ERF_DataStruct.H:790
void init_params(int max_level, std::string pp_prefix)
Definition: ERF_DataStruct.H:97
amrex::Vector< SubsteppingType > substepping_type
Definition: ERF_DataStruct.H:702
bool coriolis_3d
Definition: ERF_DataStruct.H:717
bool use_num_diff
Definition: ERF_DataStruct.H:773
amrex::Real sampling_distance_by_D
Definition: ERF_DataStruct.H:813
int RhoQv_comp
Definition: ERF_DataStruct.H:802
bool test_mapfactor
Definition: ERF_DataStruct.H:710
bool use_coriolis
Definition: ERF_DataStruct.H:716
bool custom_moisture_forcing
Definition: ERF_DataStruct.H:754
amrex::Real num_diff_coeff
Definition: ERF_DataStruct.H:774
std::string windfarm_blade_table
Definition: ERF_DataStruct.H:812
bool fixed_density
Definition: ERF_DataStruct.H:705
amrex::Real zsurf
Definition: ERF_DataStruct.H:742
amrex::Vector< TurbChoice > turbChoice
Definition: ERF_DataStruct.H:698
bool variable_coriolis
Definition: ERF_DataStruct.H:796
bool project_initial_velocity
Definition: ERF_DataStruct.H:745
amrex::Vector< int > anelastic
Definition: ERF_DataStruct.H:703
AdvChoice advChoice
Definition: ERF_DataStruct.H:695
bool use_moist_background
Definition: ERF_DataStruct.H:801
MoistureType moisture_type
Definition: ERF_DataStruct.H:783
bool custom_forcing_prim_vars
Definition: ERF_DataStruct.H:757
std::string abl_geo_wind_table
Definition: ERF_DataStruct.H:792
static TerrainType terrain_type
Definition: ERF_DataStruct.H:681
ABLDriverType abl_driver_type
Definition: ERF_DataStruct.H:789
bool rayleigh_damp_W
Definition: ERF_DataStruct.H:721
PerturbationType pert_type
Definition: ERF_DataStruct.H:770
SpongeChoice spongeChoice
Definition: ERF_DataStruct.H:697
WindFarmType windfarm_type
Definition: ERF_DataStruct.H:784
static InitType init_type
Definition: ERF_DataStruct.H:678
static bool use_real_bcs
Definition: ERF_DataStruct.H:684
int buoyancy_type
Definition: ERF_DataStruct.H:712
amrex::Real poisson_abstol
Definition: ERF_DataStruct.H:707
amrex::Real turb_disk_angle
Definition: ERF_DataStruct.H:814
amrex::Real windfarm_y_shift
Definition: ERF_DataStruct.H:816
bool has_lat_lon
Definition: ERF_DataStruct.H:795
bool use_rotate_surface_flux
Definition: ERF_DataStruct.H:764
bool do_forest_drag
Definition: ERF_DataStruct.H:819
bool time_avg_vel
Definition: ERF_DataStruct.H:767
bool forest_substep
Definition: ERF_DataStruct.H:730
amrex::Real rayleigh_dampcoef
Definition: ERF_DataStruct.H:723
CouplingType coupling_type
Definition: ERF_DataStruct.H:782
std::string windfarm_airfoil_tables
Definition: ERF_DataStruct.H:812
static void set_mesh_type(MeshType new_mesh_type)
Definition: ERF_DataStruct.H:690
int ave_plane
Definition: ERF_DataStruct.H:798
Definition: ERF_SpongeStruct.H:15
void display()
Definition: ERF_SpongeStruct.H:45
void init_params(std::string pp_prefix)
Definition: ERF_SpongeStruct.H:17