ERF
Energy Research and Forecasting: An Atmospheric Modeling Code
ERF_DataStruct.H
Go to the documentation of this file.
1 #ifndef ERF_DATA_STRUCT_H_
2 #define ERF_DATA_STRUCT_H_
3 
4 #include <string>
5 #include <iostream>
6 
7 #include <AMReX_ParmParse.H>
8 #include <AMReX_Print.H>
9 #include <AMReX_Gpu.H>
10 #include <AMReX_Geometry.H>
11 
12 #include <ERF_Constants.H>
13 #include <ERF_IndexDefines.H>
14 #include <ERF_AdvStruct.H>
15 #include <ERF_DampingStruct.H>
16 #include <ERF_DiffStruct.H>
17 #include <ERF_EBStruct.H>
18 #include <ERF_SpongeStruct.H>
19 #include <ERF_TurbStruct.H>
20 #include <ERF_TurbPertStruct.H>
21 
22 enum MapFacType {
23 // This version assumes isotropic
24  m_x, u_x, v_x, num,
25  m_y = 0, u_y = 1, v_y = 2
26 // This version allows for non-isotropic
27 // m_x, u_x, v_x,
28 // m_y, u_y, v_y, num
29 };
30 
31 enum TauType {
33 };
34 
35 AMREX_ENUM(InitType,
36  None, Input_Sounding, NCFile, WRFInput, Metgrid, Uniform, ConstantDensity, ConstantDensityLinearTheta,
37  Isentropic, MoistBaseState, HindCast
38 );
39 
40 AMREX_ENUM(SoundingType,
41  ConstantDensity, Ideal, Isentropic, DryIsentropic
42 );
43 
44 AMREX_ENUM(ABLDriverType,
45  None, PressureGradient, GeostrophicWind
46 );
47 
48 AMREX_ENUM(CouplingType,
49  OneWay, TwoWay
50 );
51 
52 AMREX_ENUM(SubsteppingType,
53  None, Implicit
54 );
55 
56 AMREX_ENUM(MeshType,
57  ConstantDz, StretchedDz, VariableDz
58 );
59 
60 AMREX_ENUM(TerrainType,
61  None, StaticFittedMesh, MovingFittedMesh, EB, ImmersedForcing
62 );
63 
64 AMREX_ENUM(BuildingsType,
65  None, ImmersedForcing
66 );
67 
68 AMREX_ENUM(MoistureModelType,
69  Eulerian, Lagrangian, Undefined
70 );
71 
72 AMREX_ENUM(MoistureType,
73  SAM, SAM_NoIce, SAM_NoPrecip_NoIce, Kessler, Kessler_NoRain, SatAdj, Morrison, Morrison_NoIce, WSM6, SuperDroplets, None
74 );
75 
76 AMREX_ENUM(WindFarmType,
77  Fitch, EWP, SimpleAD, GeneralAD, None
78 );
79 
80 AMREX_ENUM(WindFarmLocType,
81  lat_lon, x_y, None
82 );
83 
84 AMREX_ENUM(LandSurfaceType,
85  SLM, MM5, None, NOAHMP
86 );
87 
88 AMREX_ENUM(RadiationType,
89  None, RRTMGP
90 );
91 
92 enum struct Coord {
93  x, y, z
94 };
95 
96 // These are used as integers so must be enum not enum struct
97 enum Rayleigh {
99 };
100 
101 // These are used as integers so must be enum not enum struct
102 enum Sponge {
104 };
105 
107  int qv = -1; // Water vapor
108  int qc = -1; // Cloud liquid water
109  int qi = -1; // Cloud ice
110  int qr = -1; // Rain
111  int qs = -1; // Snow
112  int qg = -1; // Graupel
113 
114  // Constructor for easy initialization
115  MoistureComponentIndices (int qv_comp, int qc_comp,
116  int qi_comp=-1,
117  int qr_comp=-1,
118  int qs_comp=-1,
119  int qg_comp=-1)
120  : qv(qv_comp), qc(qc_comp), qi(qi_comp), qr(qr_comp), qs(qs_comp), qg(qg_comp) {}
121 
122  // Default constructor
124 };
125 
126 /**
127  * Container holding many of the algorithmic options and parameters
128  */
129 
130 struct SolverChoice {
131  public:
132  void init_params (int max_level, std::string pp_prefix)
133  {
134  amrex::ParmParse pp(pp_prefix);
135 
136  bool bogus_bool;
137  if (pp.query("use_terrain",bogus_bool) > 0) {
138  amrex::Error("The input use_terrain is deprecated. Set terrain_type instead.");
139  }
140 
141  if (pp.query("use_moist_background",bogus_bool) > 0) {
142  amrex::Error("The input use_moist_background is deprecated. Set init_type = MoistBaseState instead.");
143  }
144 
145  // Do we set map scale factors to myhalf instead of 1 for testing?
146  pp.query("test_mapfactor", test_mapfactor);
147 
148  // Which horizontal pressure gradient formulation to use with terrain fitted coords?
149  // 0: dp/dx with dp/dz correction (default)
150  // 1: gradient of vertically interpolated p, see Klemp 2011
151  pp.query("gradp_type", gradp_type);
153 
154  // What type of moisture model to use?
155  moisture_type = MoistureType::None; // Default
156  if (pp.query("moisture_type",moisture_type) > 0) {
157  amrex::Error("The input moisture_type is deprecated. Set moisture_model instead.");
158  }
159  pp.query_enum_case_insensitive("moisture_model",moisture_type);
160  if ( (moisture_type == MoistureType::Morrison) ||
161  (moisture_type == MoistureType::WSM6) ||
162  (moisture_type == MoistureType::SAM) ) {
164  RhoQ1_comp, // water vapor
165  RhoQ2_comp, // cloud water
166  RhoQ3_comp, // cloud ice
167  RhoQ4_comp, // rain
168  RhoQ5_comp, // snow
169  RhoQ6_comp // graupel
170  );
171  } else if ( (moisture_type == MoistureType::Morrison_NoIce) ||
172  (moisture_type == MoistureType::SAM_NoIce) ) {
174  RhoQ1_comp, // water vapor
175  RhoQ2_comp, // cloud water
176  -1, // cloud ice
177  RhoQ4_comp // rain
178  );
179  } else if ( (moisture_type == MoistureType::SAM_NoPrecip_NoIce) ||
180  (moisture_type == MoistureType::Kessler_NoRain) ||
181  (moisture_type == MoistureType::SatAdj) ) {
183  RhoQ1_comp, // water vapor
184  RhoQ2_comp // cloud water
185  );
186  } else if (moisture_type == MoistureType::Kessler) {
188  RhoQ1_comp, // water vapor
189  RhoQ2_comp, // cloud water
190  -1, // cloud ice
191  RhoQ3_comp // rain
192  );
193  } else if (moisture_type == MoistureType::SuperDroplets) {
195  RhoQ1_comp, // water vapor
196  RhoQ2_comp, // cloud water
197  RhoQ3_comp // rain
198  );
199  }
200 
201  // Set a default for dry
202  buoyancy_type.resize(max_level+1);
203  for (int i = 0; i <= max_level; ++i) {
204  buoyancy_type[i] = 1; // uses Rhoprime
205  }
206 
207  // Set a default for moist
208  if (moisture_type != MoistureType::None) {
209  if ( !(moisture_type == MoistureType::Kessler_NoRain ||
210  moisture_type == MoistureType::SAM ||
211  moisture_type == MoistureType::SAM_NoIce ||
212  moisture_type == MoistureType::SAM_NoPrecip_NoIce ||
213  moisture_type == MoistureType::Morrison ||
214  moisture_type == MoistureType::Morrison_NoIce ||
215  moisture_type == MoistureType::WSM6 ||
216  moisture_type == MoistureType::SatAdj) )
217  {
218  for (int i = 0; i <= max_level; ++i) {
219  buoyancy_type[i] = 2; // uses Tprime
220  }
221  }
222 
223  pp.query("moisture_tight_coupling",moisture_tight_coupling);
224  }
225 
226  // Which expression (1,2/3 or 4) to use for buoyancy
227  int default_buoyancy_type = buoyancy_type[0];
228  read_int_string(max_level, "buoyancy_type", buoyancy_type, default_buoyancy_type);
229 
230  // What type of land surface model to use
231  lsm_type = LandSurfaceType::None; // Default
232  pp.query_enum_case_insensitive("land_surface_model",lsm_type);
233 
234  // What type of radiation model to use
235  rad_type = RadiationType::None; // Default
236  pp.query_enum_case_insensitive("radiation_model", rad_type);
237 
238  // Verify that radiation model cannot be RRTMGP if ERF was not compiled with RRTMGP
239 #ifndef ERF_USE_RRTMGP
240  if (rad_type == RadiationType::RRTMGP)
241  {
242  amrex::Error("ERF was not compiled with RRTMGP enabled!");
243  }
244 #endif
245 
246  // Is the terrain none, static or moving?
247  std::string terrain_type_temp = "";
248  pp.query("terrain_type", terrain_type_temp);
249  if (terrain_type_temp == "Moving") {
250  amrex::Warning("erf.terrain_type = Moving is deprecated; please replace Moving by MovingFittedMesh");
251  terrain_type = TerrainType::MovingFittedMesh;
252  } else if (terrain_type_temp == "Static") {
253  amrex::Warning("erf.terrain_type = Static is deprecated; please replace Static by StaticFittedMesh");
254  terrain_type = TerrainType::StaticFittedMesh;
255  } else {
256  pp.query_enum_case_insensitive("terrain_type",terrain_type);
257  }
258 
259  // Get buildings type
260  std::string buildings_type_temp = "";
261  pp.query("buildings_type", buildings_type_temp);
262  if (buildings_type_temp == "ImmersedForcing") {
263  buildings_type = BuildingsType::ImmersedForcing;
264  }
265 
266  //
267  // Read the init_type here to make sure we correctly set the mesh and terrain types
268  //
269  std::string init_type_temp_string;
270 
271  int found = pp.query("init_type",init_type_temp_string);
272 
273  if ( (init_type_temp_string == "Real") || (init_type_temp_string == "real") ) {
274  amrex::Error("erf.init_type = Real is deprecated; please replace Real by WRFInput");
275  } else if ( (init_type_temp_string == "Ideal") || (init_type_temp_string == "ideal") ) {
276  amrex::Error("erf.init_type = Ideal is deprecated; please replace Ideal by WRFInput");
277  } else {
278  pp.query_enum_case_insensitive("init_type",init_type);
279  use_real_bcs = ( (init_type == InitType::WRFInput) || (init_type == InitType::Metgrid) );
280  }
281 
282  if ( (init_type == InitType::WRFInput) || (init_type == InitType::Metgrid) ) {
283  if (terrain_type != TerrainType::StaticFittedMesh) {
284  amrex::Error("Only terrain_type = StaticFittedMesh are allowed with init_type = WRFInput or Metgrid");
285  }
286  }
287 
288  if (init_type == InitType::MoistBaseState) {
289  if (moisture_type == MoistureType::None) {
290  amrex::Error("Makes no sense to have moist base state with no moisture model");
291  }
292  }
293 
294  if (init_type == InitType::WRFInput) {
295  if (moisture_type == MoistureType::None) {
296  amrex::Error("Can't have moisture_type = None with init_type = WRFInput");
297  }
298 
299  // NetCDF wrfbdy lateral boundary file
300  std::string nc_bdy_file_temp_string;
301  bool has_bdy = pp.query("nc_bdy_file", nc_bdy_file_temp_string);
302  if (!has_bdy) use_real_bcs = false;
303 
304  bool use_real_bcs_temp = use_real_bcs;
305  pp.query("use_real_bcs", use_real_bcs_temp);
306  if (use_real_bcs && !use_real_bcs_temp) {
307  use_real_bcs = false;
308  }
309  }
310 
311  if (found == 0 || init_type == InitType::None) {
312  amrex::Print() << "init_type must now be set. The options are " << std::endl;
313  amrex::Print() << " Input_Sounding, NCFile, WRFInput, Metgrid, Uniform, " << std::endl;
314  amrex::Print() << " ConstantDensity, Isentropic, MoistBaseState, or HindCast " << std::endl;
315  amrex::Error("Please add a string for init_type to your inputs file or command line");
316  }
317 
318  if (use_real_bcs) {
319  pp.query("upwind_real_bcs",upwind_real_bcs);
320  }
321 
322  // Check for rebalancing with wrfinput
323  if (init_type == InitType::WRFInput) {
324  pp.query("rebalance_wrfinput",rebalance_wrfinput);
325  }
326 
327  // How to interpret input_sounding
328  if (init_type == InitType::Input_Sounding) {
329  pp.query_enum_case_insensitive("sounding_type",sounding_type);
330  }
331 
332  if (terrain_type == TerrainType::StaticFittedMesh ||
333  terrain_type == TerrainType::MovingFittedMesh) {
334  mesh_type = MeshType::VariableDz;
335  }
336 
337  pp.query("grid_stretching_ratio", grid_stretching_ratio);
338  if (grid_stretching_ratio != 0) {
340  "The grid stretching ratio must be greater than 1");
341  }
342  if (grid_stretching_ratio >= 1) {
343  if (terrain_type == TerrainType::None) {
344  terrain_type = TerrainType::StaticFittedMesh;
345  }
346  if (mesh_type == MeshType::ConstantDz) {
347  mesh_type = MeshType::StretchedDz;
348  }
349  pp.query("zsurface", zsurf);
350  if (zsurf != zero) {
351  amrex::Print() << "Nominal zsurface height != 0, may result in unexpected behavior"
352  << std::endl;
353  }
354  pp.get("initial_dz", dz0);
355  }
356 
357  int n_zlevels = pp.countval("terrain_z_levels");
358  if (n_zlevels > 0)
359  {
360  if (terrain_type == TerrainType::None) {
361  terrain_type = TerrainType::StaticFittedMesh;
362  }
363  if (mesh_type == MeshType::ConstantDz) {
364  mesh_type = MeshType::StretchedDz;
365  }
366  }
367 
368  // Use lagged_delta_rt in the fast integrator?
369  pp.query("use_lagged_delta_rt", use_lagged_delta_rt);
370 
371  // These default to true but are used for unit testing
372  pp.query("use_gravity", use_gravity);
374 
375  pp.query("c_p", c_p);
376  rdOcp = R_d / c_p;
377 
378  // *******************************************************************************
379  // Read anelastic etc and over-ride if necessary
380  // *******************************************************************************
381 
382  read_int_string(max_level, "anelastic", anelastic, 0);
383  read_int_string(max_level, "fixed_density", fixed_density, 0);
384  read_int_string(max_level, "project_initial_velocity", project_initial_velocity, 0);
385 
386  for (int i = 0; i <= max_level; ++i) {
387  if (anelastic[i] == 1) {
389  fixed_density[i] = 1; // We default to true but are allowed to override below
390  buoyancy_type[i] = 3; // (This isn't actually used when anelastic is set)
391  }
392  }
393 
394  // *******************************************************************************
395 
396  if (!upwind_real_bcs && anelastic[0]) {
397  amrex::Print() << "Setting upwind_real_bcs to true because we are doing anelastic at level 0" << std::endl;
398  upwind_real_bcs = true;
399  }
400 
401  // *******************************************************************************
402  // Read substepping_type and allow for different values at each level
403  // *******************************************************************************
404  substepping_type.resize(max_level+1);
405 
406  for (int i = 0; i <= max_level; i++) {
407  substepping_type[i] = SubsteppingType::Implicit;
408  }
409 
410  for (int i = 0; i <= max_level; i++) {
412  pp, "substepping_type", substepping_type[i], i, max_level);
413  }
414 
415  pp.query("substepping_diag", substepping_diag);
416 
417  pp.query("beta_s", beta_s);
418 
419 
420 
421  // *******************************************************************************
422  // Error check on deprecated input
423  // *******************************************************************************
424  int nvals_old = pp.countval("no_substepping");
425  if (nvals_old > 0) {
426  amrex::Error("The no_substepping flag is deprecated -- set substepping_type instead");
427  }
428 
429  // *******************************************************************************
430 
431  pp.query("ncorr", ncorr);
432  pp.query("poisson_abstol", poisson_abstol);
433  pp.query("poisson_reltol", poisson_reltol);
434 
435  for (int lev = 0; lev <= max_level; lev++) {
436  if (anelastic[lev] != 0)
437  {
438  substepping_type[lev] = SubsteppingType::None;
439  }
440  }
441 
442  pp.query("force_stage1_single_substep", force_stage1_single_substep);
443 
444  // Include Coriolis forcing?
445  pp.query("use_coriolis", use_coriolis);
446  pp.query("variable_coriolis", variable_coriolis);
447 
448  // Include four stream radiation approximation
449  pp.query("four_stream_radiation", four_stream_radiation);
450 
451  // flags for whether to apply other source terms in substep only
452  pp.query("immersed_forcing_substep", immersed_forcing_substep); // apply immersed forcing source terms in substep only
453  pp.query("forest_substep", forest_substep); // apply canopy-related source terms in substep only
454 
455  // immersed forcing parameters
456  pp.query("if_Cd_scalar", if_Cd_scalar);
457  pp.query("if_Cd_momentum", if_Cd_momentum);
458  pp.query("if_z0", if_z0);
459  pp.query("if_surf_temp_flux", if_surf_temp_flux);
460  pp.query("if_init_surf_temp", if_init_surf_temp);
461  pp.query("if_surf_heating_rate", if_surf_heating_rate);
462  pp.query("if_Olen", if_Olen_in);
463  pp.query("if_use_most",if_use_most);
464 
465  if ((if_init_surf_temp > zero && if_surf_temp_flux != 1e-8) ||
466  (if_init_surf_temp > zero && if_Olen_in != 1e-8) ||
467  (if_Olen_in != 1e-8 && if_surf_temp_flux != 1e-8))
468  {
469  amrex::Error("Can only specify one of init_surf_temp, surf_temp_flux, or Olen");
470  }
471 
472  if (if_use_most && buildings_type == BuildingsType::ImmersedForcing)
473  {
474  amrex::Error("MOST wall-model with immersed forcing for buildings is not currently supported");
475  }
476 
477  if (if_surf_temp_flux != 1e-8 && buildings_type == BuildingsType::ImmersedForcing)
478  {
479  amrex::Error("Specifying surf_temp_flux with immersed forcing for buildings is not currently supported");
480  }
481 
482  if (if_Olen_in != 1e-8 && buildings_type == BuildingsType::ImmersedForcing)
483  {
484  amrex::Error("Specifying Olen with immersed forcing for buildings is not currently supported");
485  }
486 
487  // Flag to do MOST rotations with terrain
488  pp.query("use_rotate_surface_flux",use_rotate_surface_flux);
490  AMREX_ASSERT_WITH_MESSAGE(terrain_type != TerrainType::None,"MOST stress rotations are only valid with terrain!");
491  }
492 
493  // Which external forcings?
494  abl_driver_type = ABLDriverType::None; // Default: no ABL driver for simulating classical fluid dynamics problems
495  pp.query_enum_case_insensitive("abl_driver_type",abl_driver_type);
496  pp.query("const_massflux_u", const_massflux_u);
497  pp.query("const_massflux_v", const_massflux_v);
498  pp.query("const_massflux_tau", const_massflux_tau);
499  pp.query("const_massflux_layer_lo", const_massflux_layer_lo);
500  pp.query("const_massflux_layer_hi", const_massflux_layer_hi);
501 
502  // Which type of inflow turbulent generation
503  pert_type.resize(max_level+1);
504  for (int lev = 0; lev <= max_level; ++lev) {
505  pert_type[lev] = PerturbationType::None; // Default
507  pp, "perturbation_type", pert_type[lev], lev, max_level);
508  }
509 
510  amrex::Vector<amrex::Real> abl_pressure_grad_in = {zero, zero, zero};
511  pp.queryarr("abl_pressure_grad",abl_pressure_grad_in);
512  for(int i = 0; i < AMREX_SPACEDIM; ++i) abl_pressure_grad[i] = abl_pressure_grad_in[i];
513 
514  amrex::Vector<amrex::Real> abl_geo_forcing_in = {zero, zero, zero};
515  if(pp.queryarr("abl_geo_forcing",abl_geo_forcing_in)) {
516  amrex::Print() << "Specified abl_geo_forcing: (";
517  for (int i = 0; i < AMREX_SPACEDIM; ++i) {
518  abl_geo_forcing[i] = abl_geo_forcing_in[i];
519  amrex::Print() << abl_geo_forcing[i] << " ";
520  }
521  amrex::Print() << ")" << std::endl;
522  }
523 
524  if (use_coriolis)
525  {
527  }
528 
529  pp.query("add_custom_rhotheta_forcing", custom_rhotheta_forcing);
530  pp.query("add_custom_moisture_forcing", custom_moisture_forcing);
531  pp.query("add_custom_w_subsidence", custom_w_subsidence);
532  pp.query("add_do_theta_advection", do_theta_advection); // If true, apply custom subsidence to (rho*theta) when add_custom_w_subsidence is used
533  pp.query("add_do_mom_advection", do_mom_advection); // If true, apply custom subsidence to momentum when add_custom_w_subsidence is used
534  pp.query("add_custom_geostrophic_profile", custom_geostrophic_profile);
535  pp.query("custom_forcing_uses_primitive_vars", custom_forcing_prim_vars);
536  pp.query("spatial_rhotheta_forcing", spatial_rhotheta_forcing);
537  pp.query("spatial_moisture_forcing", spatial_moisture_forcing);
538 
539  pp.query("nudging_from_input_sounding", nudging_from_input_sounding);
540 
542  AMREX_ALWAYS_ASSERT_WITH_MESSAGE(!(!abl_geo_wind_table.empty() && custom_geostrophic_profile),
543  "Should not have both abl_geo_wind_table and custom_geostrophic_profile set.");
544 
545  pp.query("Ave_Plane", ave_plane);
546 
547  // Use numerical diffusion?
548  pp.query("num_diff_coeff",num_diff_coeff);
550  "Numerical diffusion coefficient must be between 0 & one");
552  if (use_num_diff) {
553  amrex::Print() << "6th-order numerical diffusion turned on with coefficient = "
554  << num_diff_coeff << std::endl;
555  num_diff_coeff *= std::pow(two,-6);
556  }
557 
558  advChoice.init_params(pp_prefix);
559  diffChoice.init_params(pp_prefix);
560  dampingChoice.init_params(pp_prefix);
561  spongeChoice.init_params(pp_prefix);
562  ebChoice.init_params(pp_prefix);
563 
564  turbChoice.resize(max_level+1);
565  for (int lev = 0; lev <= max_level; lev++) {
566  turbChoice[lev].init_params(lev,max_level,pp_prefix);
567  }
568 
569  // YSU PBL: use consistent coriolis frequency
570  for (int lev = 0; lev <= max_level; lev++) {
571  if (turbChoice[lev].pbl_ysu_use_consistent_coriolis) {
572  if (use_coriolis) {
573  turbChoice[lev].pbl_ysu_coriolis_freq = coriolis_factor * sinphi;
574  if (lev == 0) {
575  amrex::Print() << "YSU PBL using ERF coriolis frequency: " << turbChoice[lev].pbl_ysu_coriolis_freq << std::endl;
576  }
577  } else {
578  amrex::Error("YSU cannot use ERF coriolis frequency if not using coriolis");
579  }
580  }
581  }
582  // MRF
583  for (int lev = 0; lev <= max_level; lev++) {
584  if (turbChoice[lev].pbl_ysu_use_consistent_coriolis) {
585  if (use_coriolis) {
586  turbChoice[lev].pbl_ysu_coriolis_freq = coriolis_factor * sinphi;
587  if (lev == 0) {
588  amrex::Print() << "MRF PBL using ERF coriolis frequency: " << turbChoice[lev].pbl_ysu_coriolis_freq << std::endl;
589  }
590  } else {
591  amrex::Error("MRF cannot use ERF coriolis frequency if not using coriolis");
592  }
593  }
594  }
595 
596  // What's the strength of the bdy nudging?
597  pp.query("bdy_nudge_factor",bdy_nudge_factor);
598 
599  // Are me transporting the scalar component?
600  pp.query("transport_scalar",transport_scalar);
601 
602  // Are we using SHOC? (test on compilation done in turb struct)
603  if (turbChoice[0].pbl_type == PBLType::SHOC) { use_shoc = true; }
604 
605  // Implicit vertical diffusion (not available with Shoc)
606  if (!use_shoc) {
607  // This controls the time-centering of the vertical differences in the diffusive term
608  bool do_vert_implicit = false;
609  if (pp.query("vert_implicit", do_vert_implicit) && do_vert_implicit) {
610  // set to default here
611  vert_implicit_fac[0] = one;
612  vert_implicit_fac[1] = one;
613  vert_implicit_fac[2] = zero;
614  }
615 
616  // This may be one value for all RK stages or a different value in each stage
617  int n_impfac = pp.countval("vert_implicit_fac");
618  AMREX_ALWAYS_ASSERT(n_impfac == 0 || n_impfac == 1 || n_impfac==3);
619  if (n_impfac > 0 && do_vert_implicit) {
620  amrex::Print() << "Overriding defaults with specified implicit factor(s)" << std::endl;
621  }
622 
623  if (n_impfac == 1) {
624  amrex::Real fac_in;
625  pp.get("vert_implicit_fac", fac_in);
626  for (int i=0; i<3; ++i) { vert_implicit_fac[i] = fac_in; }
627  } else if (n_impfac == 3) {
628  pp.getarr("vert_implicit_fac", vert_implicit_fac);
629  }
630 
631  // If true (default), include implicit contributions to vertical
632  // thermal diffusion
633  pp.query("implicit_thermal_diffusion", implicit_thermal_diffusion);
634 
635  // If true (default), include implicit contributions to vertical
636  // moisture diffusion
637  pp.query("implicit_moisture_diffusion", implicit_moisture_diffusion);
638 
639  // If true (default), include implicit contributions in tau13, tau23,
640  // (and if ERF_IMPLICIT_W is set, tau33) to correct u, v, (and w).
641  pp.query("implicit_momentum_diffusion", implicit_momentum_diffusion);
642 
646  amrex::Print() << "Thermal and momentum diffusion are both turned off -- turning off vertical implicit solve" << std::endl;
647  vert_implicit_fac[0] = zero;
648  vert_implicit_fac[1] = zero;
649  vert_implicit_fac[2] = zero;
650  }
651 
652  // This controls when the vertical implicit solve for the diffusive terms will happen relative to
653  // the acoustic substepping (if it happens, i.e. if any of the implicit_fac > zero)
654  // The default is true (i.e. that it happens before the acoustic substepping).
655  pp.query("implicit_before_substep", implicit_before_substep);
656  }
657 
658  // Which type of multilevel coupling
659  coupling_type = CouplingType::TwoWay; // Default
660  pp.query_enum_case_insensitive("coupling_type",coupling_type);
661 
662  // Test for hybrid (compressible + anelastic) -- in this case we must use one-way coupling
663  bool any_anelastic = false;
664  bool any_compress = false;
665  for (int lev = 0; lev <= max_level; lev++) {
666  if (anelastic[lev] == 0) {
667  any_compress = true;
668  } else {
669  any_anelastic = true;
670  }
671  }
672  if (any_anelastic && any_compress) {
673  coupling_type = CouplingType::OneWay;
674  }
675 
676  // Which type of windfarm model
677  windfarm_type = WindFarmType::None; // Default
678  pp.query_enum_case_insensitive("windfarm_type",windfarm_type);
679 
680  static std::string windfarm_loc_type_string = "None";
681  windfarm_loc_type = WindFarmLocType::None;
682  pp.query_enum_case_insensitive("windfarm_loc_type",windfarm_loc_type);
683 
684  pp.query("windfarm_loc_table", windfarm_loc_table);
685  pp.query("windfarm_spec_table", windfarm_spec_table);
686  pp.query("windfarm_blade_table", windfarm_blade_table);
687  pp.query("windfarm_airfoil_tables", windfarm_airfoil_tables);
688  pp.query("windfarm_spec_table_extra", windfarm_spec_table_extra);
689 
690  // Sampling distance upstream of the turbine to find the
691  // incoming free stream velocity as a factor of the diameter of the
692  // turbine. ie. the sampling distance will be this number multiplied
693  // by the diameter of the turbine
694  pp.query("sampling_distance_by_D", sampling_distance_by_D);
695  pp.query("turb_disk_angle_from_x", turb_disk_angle);
696 
697  pp.query("windfarm_x_shift",windfarm_x_shift);
698  pp.query("windfarm_y_shift",windfarm_y_shift);
699  // Test if time averaged data is to be output
700  pp.query("time_avg_vel",time_avg_vel);
701 
702  pp.query("hindcast_lateral_forcing", hindcast_lateral_forcing);
703 
705  pp.query("hindcast_boundary_data_dir", hindcast_boundary_data_dir);
706 
707  if(hindcast_boundary_data_dir.empty()) {
708  amrex::Error("ERROR: Missing input parameter 'erf.hindcast_boundary_data_dir' for boundary data for lateral forcing");
709  }
710  pp.query("hindcast_data_interval_in_hrs", hindcast_data_interval_in_hrs);
712  amrex::Error("ERROR: Input parameter 'erf.hindcast_data_interval_in_hrs' which is the time interval between the "
713  "data files is either missing or set to less than zero");
714  }
715  pp.query("hindcast_lateral_sponge_strength", hindcast_lateral_sponge_strength);
716  pp.query("hindcast_lateral_sponge_length", hindcast_lateral_sponge_length);
717 
718  pp.query("hindcast_zhi_sponge_length", hindcast_zhi_sponge_length);
719  pp.query("hindcast_zhi_sponge_strength", hindcast_zhi_sponge_strength);
720 
721  pp.query("hindcast_zhi_sponge_damping", hindcast_zhi_sponge_damping);
722 
724  amrex::Error("ERROR: Missing input parameter 'erf.hindcast_lateral_sponge_strength' or it is specified to be less than zero");
725  }
726 
728  amrex::Error("ERROR: Missing input parameter 'erf.hindcast_lateral_sponge_length' or it is specified to be less than zero");
729  }
730 
732  amrex::Error("ERROR: Missing input parameter 'erf.hindcast_zhi_sponge_strength' or it is specified to be less than zero");
733  }
734 
736  amrex::Error("ERROR: Missing input parameter 'erf.hindcast_zhi_sponge_strength' or it is specified to be less than zero");
737  }
738  }
739 
740  pp.query("hindcast_surface_bcs", hindcast_surface_bcs);
742  pp.query("hindcast_surface_data_dir", hindcast_surface_data_dir);
743  }
744 
745  pp.query("io_hurricane_eye_tracker", io_hurricane_eye_tracker);
747  pp.query("hurricane_eye_latitude", hurricane_eye_latitude);
748  pp.query("hurricane_eye_longitude", hurricane_eye_longitude);
749  if(hurricane_eye_latitude == -1e10 or hurricane_eye_longitude == -1e10) {
750  amrex::Error("ERROR: You are using 'erf.io_hurricane_eye_tracker' to write out the files that track the eye of the hurricane"
751  " but have not provided the initial location of the eye of the hurricane to be tracked. There has to be two"
752  " options in the inputs - erf.hurricane_eye_latitude and erf.hurricane_eye_longitude that gives an approximate"
753  " location of the eye in the initial condition");
754  }
755  }
756 
757  pp.query("is_init_for_ensemble", is_init_for_ensemble);
759  amrex::ParmParse pp_ens("ensemble");
760  pp_ens.query("n_members", n_ensemble);
761  pp_ens.query("coarse_bckgnd_data_file", coarse_bckgnd_data_file);
762  pp_ens.query("ens_pert_amplitude", ens_pert_amplitude);
763  pp_ens.query("ens_pert_correlated_radius", ens_pert_correlated_radius);
764  if (n_ensemble < 0) {
765  amrex::Abort("You are running an ensemble simulation, There needs to be an entry in the inputs "
766  "ensemble.n_ensemble which is the number of ensemble members, and should be greater than 0.");
767  }
768  if (coarse_bckgnd_data_file.empty()) {
769  amrex::Abort("coarse_bckgnd_data_file is empty! For ensmeble simulations, there needs to be a coarse background file which "
770  "contains the data which will be interpolated onto the fine mesh. There has to a entry ensemble.coarse_bckgnd_data_file "
771  "which contains the filename in the inputs.");
772  }
773  if(ens_pert_amplitude <= 0.0) {
774  amrex::Error("You are using initialization for ensemble simulations using the inputs option "
775  "ensemble.is_init_for_ensemble=true. In this case, there has to be an option "
776  "ensemble.ens_pert_amplitude which is the value of the amplitude of the perturbation "
777  "to be added to the background state and has to be greater than 0.0");
778  }
779  if(ens_pert_correlated_radius <= 0.0) {
780  amrex::Error("You are using initialization with spatially correlated perturbations using the inputs option "
781  "ensemble.is_init_for_ensemble=true. In this case, there has to be an option "
782  "ensemble.ens_pert_correlated_radius which is the value of the the spatial correlation radius, "
783  "and has to be greater than 0.0");
784  }
785  }
786  }
787 
788  void check_params (int max_level, const amrex::Vector<amrex::Geometry>& geom_vect, amrex::GpuArray<ERF_BC, AMREX_SPACEDIM*2> phys_bc_type)
789  {
790 #if 0
791  // Warn for PBL models and moisture - these may not yet be compatible
792  for (int lev = 0; lev <= max_level; lev++) {
793  if ((moisture_type != MoistureType::None) && (turbChoice[lev].pbl_type != PBLType::None)) {
794  amrex::Warning("\n*** WARNING: Moisture may not yet be compatible with PBL models, \n proceed with caution ***");
795  }
796  }
797 #endif
798  //
799  // Buoyancy type check
800  //
801  for (int lev = 0; lev <= max_level; lev++) {
802  if (buoyancy_type[lev] != 1 && buoyancy_type[lev] != 2 && buoyancy_type[lev] != 3 && buoyancy_type[lev] != 4) {
803  amrex::Error("buoyancy_type must be 1, 2, 3 or 4");
804  }
805  }
806 
807  if (!use_lagged_delta_rt && !(terrain_type == TerrainType::MovingFittedMesh)) {
808  amrex::Error("Can't turn off lagged_delta_rt when terrain not moving");
809  }
810 
811  //
812  // Wind farm checks
813  //
814  if (windfarm_type==WindFarmType::SimpleAD and sampling_distance_by_D < zero) {
815  amrex::Error("To use simplified actuator disks, you need to provide a variable"
816  " erf.sampling_distance_by_D in the inputs which specifies the upstream"
817  " distance as a factor of the turbine diameter at which the incoming free stream"
818  " velocity will be computed at.");
819  }
820  if ( (windfarm_type==WindFarmType::SimpleAD ||
821  windfarm_type==WindFarmType::GeneralAD ) && turb_disk_angle < zero) {
822  amrex::Error("To use simplified actuator disks, you need to provide a variable"
823  " erf.turb_disk_angle_from_x in the inputs which is the angle of the face of the"
824  " turbine disk from the x-axis. A turbine facing an oncoming flow in the x-direction"
825  " will have turb_disk_angle value of 90 deg.");
826  }
827  if (windfarm_loc_type == WindFarmLocType::lat_lon and (windfarm_x_shift < zero or windfarm_y_shift < zero)) {
828  amrex::Error("You are using windfarms with latitude-logitude option to position the turbines."
829  " For this you should provide the inputs erf.windfarm_x_shift and"
830  " erf.windfarm_y_shift which are the values by which the bounding box of the"
831  " windfarm is shifted from the x and the y axes.");
832  }
833 
834 
835  if ( (const_massflux_u != 0) && !(geom_vect[0].isPeriodic(0)) ) {
836  amrex::Error("Constant mass flux (in x) should be used with periodic boundaries");
837  }
838 
839  if ( (const_massflux_v != 0) && !(geom_vect[0].isPeriodic(1)) ) {
840  amrex::Error("Constant mass flux (in y) should be used with periodic boundaries");
841  }
842 
843  // Mesoscale diffusion -- test if LES appropriate with this dx,dy
844  for (int lev = 0; lev <= max_level; lev++) {
845  if ((geom_vect[lev].CellSize(0) > amrex::Real(2000.)) || (geom_vect[lev].CellSize(1) > amrex::Real(2000.)))
846  {
847  if ( (turbChoice[lev].les_type == LESType::Smagorinsky) && !turbChoice[lev].smag2d ) {
848  amrex::Warning("Should use 2-D Smagorinsky for mesoscale resolution");
849  } else if (turbChoice[lev].les_type == LESType::Deardorff) {
850  amrex::Warning("Should not use Deardorff LES for mesoscale resolution");
851  }
852  }
853  }
854 
855  // Turn off implicit solve if we have no diffusion
856  bool l_use_kturb = turbChoice[0].use_kturb;
857  for (int lev = 1; lev <= max_level; lev++) {
858  l_use_kturb = (l_use_kturb || turbChoice[lev].use_kturb);
859  }
860  bool l_use_diff = ( (diffChoice.molec_diff_type != MolecDiffType::None) || l_use_kturb );
861  bool l_implicit_diff = (vert_implicit_fac[0] > 0 ||
862  vert_implicit_fac[1] > 0 ||
863  vert_implicit_fac[2] > 0);
864  if (l_implicit_diff && !l_use_diff) {
865  amrex:: Print() << "No molecular or turbulent diffusion, turning off implicit solve" << std::endl;
866  vert_implicit_fac[0] = 0;
867  vert_implicit_fac[1] = 0;
868  vert_implicit_fac[2] = 0;
869  }
870 
871  for (int lev = 0; lev <= max_level; lev++) {
872  turbChoice[lev].check_params(phys_bc_type);
873  }
874  }
875 
876  void display (int max_level, std::string pp_prefix)
877  {
878  amrex::Print() << "SOLVER CHOICE: " << std::endl;
879  for (int lev = 0; lev <= max_level; lev++) {
880  amrex::Print() << "At level " << lev << " : " << std::endl;
881  if (anelastic[lev]) {
882  amrex::Print() << " anelastic with no substepping" << std::endl;
883  } else {
884  if (substepping_type[lev] == SubsteppingType::None) {
885  amrex::Print() << " compressible with no substepping" << std::endl;
886  } else if (substepping_type[lev] == SubsteppingType::Implicit) {
887  amrex::Print() << " compressible with implicit substepping" << std::endl;
888  }
889  }
890  if (fixed_density[lev]) {
891  amrex::Print() << " and fixed density" << std::endl;
892  }
893  }
894 
895  amrex::Print() << "vert_implicit_fac : " << vert_implicit_fac[0] << " "
896  << vert_implicit_fac[1] << " "
897  << vert_implicit_fac[2];
898  if (vert_implicit_fac[0] > 0 ||
899  vert_implicit_fac[0] > 1 ||
900  vert_implicit_fac[0] > 2)
901  {
902  amrex::Print() << " (theta=" << implicit_thermal_diffusion
903  << ", moisture=" << implicit_moisture_diffusion
904  << ", momenta=" << implicit_momentum_diffusion;
905 #ifdef ERF_IMPLICIT_W
906  amrex::Print() << ", including w";
907 #endif
908  amrex::Print() << ")";
909  }
910  amrex::Print() << std::endl;
911  amrex::Print() << "use_coriolis : " << use_coriolis << std::endl;
912  amrex::Print() << "use_gravity : " << use_gravity << std::endl;
913 
914  if (moisture_type == MoistureType::SAM) {
915  amrex::Print() << "Moisture Model: SAM" << std::endl;
916  } else if (moisture_type == MoistureType::SAM_NoIce) {
917  amrex::Print() << "Moisture Model: SAM No Ice" << std::endl;
918  } else if (moisture_type == MoistureType::SAM_NoPrecip_NoIce) {
919  amrex::Print() << "Moisture Model: SAM No Precip No Ice" << std::endl;
920  } else if (moisture_type == MoistureType::Morrison) {
921  amrex::Print() << "Moisture Model: Morrison" << std::endl;
922  } else if (moisture_type == MoistureType::Morrison_NoIce) {
923  amrex::Print() << "Moisture Model: Morrison_NoIce" << std::endl;
924  } else if (moisture_type == MoistureType::WSM6) {
925  amrex::Print() << "Moisture Model: WSM6" << std::endl;
926  } else if (moisture_type == MoistureType::Kessler) {
927  amrex::Print() << "Moisture Model: Kessler" << std::endl;
928  } else if (moisture_type == MoistureType::Kessler_NoRain) {
929  amrex::Print() << "Moisture Model: Kessler No Rain" << std::endl;
930  } else if (moisture_type == MoistureType::SatAdj) {
931  amrex::Print() << "Moisture Model: Saturation Adjustment" << std::endl;
932  } else {
933  amrex::Print() << "Moisture Model: None" << std::endl;
934  }
935 
936  if (terrain_type == TerrainType::StaticFittedMesh) {
937  amrex::Print() << "Terrain Type: StaticFittedMesh" << std::endl;
938  } else if (terrain_type == TerrainType::MovingFittedMesh) {
939  amrex::Print() << "Terrain Type: MovingFittedMesh" << std::endl;
940  } else if (terrain_type == TerrainType::EB) {
941  amrex::Print() << "Terrain Type: EB" << std::endl;
942  ebChoice.display();
943  } else if (terrain_type == TerrainType::ImmersedForcing) {
944  amrex::Print() << "Terrain Type: ImmersedForcing" << std::endl;
945  } else {
946  amrex::Print() << "Terrain Type: None" << std::endl;
947  }
948 
949  if (buildings_type == BuildingsType::ImmersedForcing) {
950  amrex::Print() << "Buildings Type: ImmersedForcing" << std::endl;
951  } else {
952  amrex::Print() << "Buildings Type: None" << std::endl;
953  }
954 
955  if (mesh_type == MeshType::ConstantDz) {
956  amrex::Print() << " Mesh Type: ConstantDz" << std::endl;
957  } else if (mesh_type == MeshType::StretchedDz) {
958  amrex::Print() << " Mesh Type: StretchedDz" << std::endl;
959  } else if (mesh_type == MeshType::VariableDz) {
960  amrex::Print() << " Mesh Type: VariableDz" << std::endl;
961  } else {
962  amrex::Error("No mesh_type set!");
963  }
964 
965  amrex::Print() << "ABL Driver Type: " << std::endl;
966  if (abl_driver_type == ABLDriverType::None) {
967  amrex::Print() << " None" << std::endl;
968  } else if (abl_driver_type == ABLDriverType::PressureGradient) {
969  amrex::Print() << " Pressure Gradient "
970  << amrex::RealVect(abl_pressure_grad[0],abl_pressure_grad[1],abl_pressure_grad[2])
971  << std::endl;
972  } else if (abl_driver_type == ABLDriverType::GeostrophicWind) {
973  amrex::Print() << " Geostrophic Wind "
974  << amrex::RealVect(abl_geo_forcing[0],abl_geo_forcing[1],abl_geo_forcing[2])
975  << std::endl;
976  }
977 
978  if (max_level > 0) {
979  amrex::Print() << "Coupling Type: " << std::endl;
980  if (coupling_type == CouplingType::TwoWay) {
981  amrex::Print() << " Two-way" << std::endl;
982  } else if (coupling_type == CouplingType::OneWay) {
983  amrex::Print() << " One-way" << std::endl;
984  }
985  }
986 
987  if (rad_type == RadiationType::RRTMGP) {
988  amrex::Print() << "Radiation Model: RRTMGP" << std::endl;
989  } else {
990  amrex::Print() << "Radiation Model: None" << std::endl;
991  }
992 
993  amrex::Print() << "Gradp_type : " << gradp_type << std::endl;
994 
995  for (int lev = 0; lev <= max_level; lev++) {
996  amrex::Print() << "Buoyancy_type at level " << lev << " : " << buoyancy_type[lev] << std::endl;
997  }
998 
999  advChoice.display(pp_prefix);
1000  diffChoice.display();
1003 
1004  for (int lev = 0; lev <= max_level; lev++) {
1005  turbChoice[lev].display(lev);
1006  }
1007  }
1008 
1009  void build_coriolis_forcings_const_lat (std::string pp_prefix)
1010  {
1011  amrex::ParmParse pp(pp_prefix);
1012 
1013  // Read the rotational time period (in seconds)
1014  amrex::Real rot_time_period = amrex::Real(86400.0);
1015  pp.query("rotational_time_period", rot_time_period);
1016 
1017  coriolis_factor = two * two * PI / rot_time_period;
1018 
1019  amrex::Real latitude = amrex::Real(90.0);
1020  pp.query("latitude", latitude);
1021 
1022  pp.query("coriolis_3d", coriolis_3d);
1023 
1024  // Convert to radians
1025  latitude *= (PI/amrex::Real(180.));
1026  sinphi = std::sin(latitude);
1027  if (coriolis_3d) {
1028  cosphi = std::cos(latitude);
1029  }
1030 
1031  amrex::Print() << "Coriolis frequency, f = " << coriolis_factor * sinphi << " 1/s" << std::endl;
1032 
1033  if (abl_driver_type == ABLDriverType::GeostrophicWind) {
1034  // Read in the geostrophic wind -- we only use this to construct
1035  // the forcing term so no need to keep it
1036  amrex::Vector<amrex::Real> abl_geo_wind(3);
1037  pp.queryarr("abl_geo_wind",abl_geo_wind);
1038 
1039  if(!pp.query("abl_geo_wind_table",abl_geo_wind_table)) {
1040  abl_geo_forcing = {
1041  -coriolis_factor * (abl_geo_wind[1]*sinphi - abl_geo_wind[2]*cosphi),
1042  coriolis_factor * abl_geo_wind[0]*sinphi,
1043  -coriolis_factor * abl_geo_wind[0]*cosphi
1044  };
1045  } else {
1046  amrex::Print() << "NOTE: abl_geo_wind_table provided, ignoring input abl_geo_wind" << std::endl;
1047  }
1048  }
1049  }
1050 
1051  void read_int_string (int max_level, const char* string_to_read,
1052  amrex::Vector<int>& vec_to_fill, int default_int)
1053  {
1054  amrex::ParmParse pp("erf");
1055  int nvals = pp.countval(string_to_read);
1056  AMREX_ALWAYS_ASSERT(nvals == 0 || nvals == 1 || nvals >= max_level+1);
1057  amrex::Vector<int> temp; temp.resize(nvals);
1058  pp.queryarr(string_to_read,temp);
1059 
1060  if (vec_to_fill.size() < max_level+1) {
1061  vec_to_fill.resize(max_level+1);
1062  }
1063 
1064  if (nvals == 0) {
1065  for (int i = 0; i <= max_level; ++i) vec_to_fill[i] = default_int;
1066  } else if (nvals == 1) {
1067  for (int i = 0; i <= max_level; ++i) vec_to_fill[i] = temp[0];
1068  } else {
1069  for (int i = 0; i <= max_level; ++i) vec_to_fill[i] = temp[i];
1070  }
1071  }
1072 
1073  inline static
1074  InitType init_type = InitType::None;
1075 
1076  inline static
1077  SoundingType sounding_type = SoundingType::Ideal;
1078 
1079  inline static
1080  TerrainType terrain_type = TerrainType::None;
1081 
1082  inline static
1083  BuildingsType buildings_type = BuildingsType::None;
1084 
1085  inline static
1086  bool use_real_bcs = false;
1087 
1088  inline static
1089  bool upwind_real_bcs = false;
1090 
1091  inline static
1092  MeshType mesh_type = MeshType::ConstantDz;
1093 
1094  static
1095  void set_mesh_type (MeshType new_mesh_type)
1096  {
1097  mesh_type = new_mesh_type;
1098  }
1099 
1104  amrex::Vector<TurbChoice> turbChoice;
1106 
1108 
1109  amrex::Vector<SubsteppingType> substepping_type;
1110  amrex::Vector<int> anelastic;
1111  amrex::Vector<int> fixed_density;
1112  amrex::Vector<int> project_initial_velocity;
1113  amrex::Vector<int> buoyancy_type;
1114 
1115  // do some extra CFL diagnostics for compressible with substepping
1116  bool substepping_diag = false;
1117 
1118  // time off-centering coefficient, > 0 for forward weighting (i.e., bias
1119  // towards the future time step)
1121 
1122  // This controls the time-centering of the *vertical* differences in the diffusive term for
1123  // theta, u, v (and w if ERF_IMPLICIT_W is set)
1124  // 0: fully explicit
1125  // 1: fully implicit
1126  amrex::Vector<amrex::Real> vert_implicit_fac = {zero, zero, zero}; // one value per RK stage
1127  // if any vert_implicit_fac > 0, then the following apply:
1132 
1133  int ncorr = 1;
1136 
1137  bool test_mapfactor = false;
1138 
1139  int gradp_type = 0;
1140 
1141  // Specify what additional physics/forcing modules we use
1142  bool use_gravity = false;
1143  bool use_coriolis = false;
1144  bool coriolis_3d = true;
1145 
1147 
1148  // Specify whether to apply other various source terms on substep only
1150  bool forest_substep = false;
1151 
1152  // immersed forcing parameters
1155  // immersed forcing MOST parameters.
1157  amrex::Real if_surf_temp_flux = 1e-8; // [K m/s]
1160  amrex::Real if_Olen_in = 1e-8; // [m]
1161  bool if_use_most = false;
1162 
1163  // This defaults to true but can be set to false for moving terrain cases only
1164  bool use_lagged_delta_rt = true;
1165 
1166  // Constants
1168  amrex::Real c_p = Cp_d; // specific heat at constant pressure for dry air [J/(kg-K)]
1170 
1171  // Staggered z levels for vertical grid stretching
1175 
1176  // Coriolis forcing
1180 
1181  // User-specified forcings in problem definition
1184  bool custom_w_subsidence = false;
1185  bool do_theta_advection = true; // Apply custom vertical subsidence to (rho*theta) equation when using custom w subsidence
1186  bool do_mom_advection = true; // Apply custom vertical subsidence to momentum equations when using custom w subsidence
1191 
1192  // Do we use source terms to nudge the solution towards
1193  // the time-varying data provided in input sounding files?
1195 
1196  // MOST stress rotations
1198 
1199  // Should we use SHOC?
1200  bool use_shoc = false;
1201 
1202  // Transport the passive scalar?
1203  bool transport_scalar = true;
1204 
1205  // User wishes to output time averaged velocity fields
1206  bool time_avg_vel = false;
1207 
1208  bool use_perturbation (int lev) const
1209  {
1210  return pert_type[lev] == PerturbationType::Source ||
1211  pert_type[lev] == PerturbationType::Direct ||
1212  pert_type[lev] == PerturbationType::CPM;
1213  }
1214 
1215  bool use_direct_perturbation (int lev) const
1216  {
1217  return pert_type[lev] == PerturbationType::Direct ||
1218  pert_type[lev] == PerturbationType::CPM;
1219  }
1220 
1221  bool use_source_perturbation (int lev) const
1222  {
1223  return pert_type[lev] == PerturbationType::Source;
1224  }
1225 
1226  bool any_perturbation () const
1227  {
1228  for (const auto& type : pert_type) {
1229  if (type == PerturbationType::Source ||
1230  type == PerturbationType::Direct ||
1231  type == PerturbationType::CPM) {
1232  return true;
1233  }
1234  }
1235  return false;
1236  }
1237 
1238  // Type of perturbation
1239  amrex::Vector<PerturbationType> pert_type;
1240 
1241  // Numerical diffusion
1242  bool use_num_diff{false};
1244 
1245  // Rebalance wrfinput
1246  bool rebalance_wrfinput{false};
1247 
1248  CouplingType coupling_type;
1249  MoistureType moisture_type;
1250  WindFarmType windfarm_type;
1251  WindFarmLocType windfarm_loc_type;
1252  LandSurfaceType lsm_type;
1253  RadiationType rad_type;
1254 
1255  ABLDriverType abl_driver_type;
1256  amrex::GpuArray<amrex::Real, AMREX_SPACEDIM> abl_pressure_grad;
1257  amrex::GpuArray<amrex::Real, AMREX_SPACEDIM> abl_geo_forcing;
1258  std::string abl_geo_wind_table;
1260 
1261  bool variable_coriolis{false};
1262 
1263  int ave_plane {2};
1264 
1265  // Microphysics params
1267 
1269 
1276 
1277  // Nudging factor for bdy sponging : F1 = 1/(nudge_factor * dt)
1279 
1280  // Use forest canopy model?
1281  bool do_forest_drag {false};
1282 
1283  // Enforce constant mass flux?
1289  int massflux_klo {0}; // these are updated in ERF.cpp
1290  int massflux_khi {0};
1291 
1295  bool hindcast_surface_bcs = false;
1299 
1302 
1303  bool is_init_for_ensemble = false;
1304  int n_ensemble = -1;
1308 };
1309 #endif
constexpr amrex::Real Cp_d
Definition: ERF_Constants.H:23
constexpr amrex::Real two
Definition: ERF_Constants.H:8
constexpr amrex::Real one
Definition: ERF_Constants.H:7
constexpr amrex::Real zero
Definition: ERF_Constants.H:6
constexpr amrex::Real PI
Definition: ERF_Constants.H:16
constexpr amrex::Real CONST_GRAV
Definition: ERF_Constants.H:32
constexpr amrex::Real R_d
Definition: ERF_Constants.H:21
TauType
Definition: ERF_DataStruct.H:31
@ tau12
Definition: ERF_DataStruct.H:32
@ tau23
Definition: ERF_DataStruct.H:32
@ tau33
Definition: ERF_DataStruct.H:32
@ tau22
Definition: ERF_DataStruct.H:32
@ tau11
Definition: ERF_DataStruct.H:32
@ tau32
Definition: ERF_DataStruct.H:32
@ tau31
Definition: ERF_DataStruct.H:32
@ tau21
Definition: ERF_DataStruct.H:32
@ tau13
Definition: ERF_DataStruct.H:32
AMREX_ENUM(InitType, None, Input_Sounding, NCFile, WRFInput, Metgrid, Uniform, ConstantDensity, ConstantDensityLinearTheta, Isentropic, MoistBaseState, HindCast)
Rayleigh
Definition: ERF_DataStruct.H:97
@ ubar
Definition: ERF_DataStruct.H:98
@ wbar
Definition: ERF_DataStruct.H:98
@ nvars
Definition: ERF_DataStruct.H:98
@ vbar
Definition: ERF_DataStruct.H:98
@ thetabar
Definition: ERF_DataStruct.H:98
Sponge
Definition: ERF_DataStruct.H:102
@ nvars_sponge
Definition: ERF_DataStruct.H:103
@ vbar_sponge
Definition: ERF_DataStruct.H:103
@ ubar_sponge
Definition: ERF_DataStruct.H:103
MapFacType
Definition: ERF_DataStruct.H:22
@ v_x
Definition: ERF_DataStruct.H:24
@ num
Definition: ERF_DataStruct.H:24
@ u_y
Definition: ERF_DataStruct.H:25
@ v_y
Definition: ERF_DataStruct.H:25
@ m_y
Definition: ERF_DataStruct.H:25
@ u_x
Definition: ERF_DataStruct.H:24
@ m_x
Definition: ERF_DataStruct.H:24
Coord
Definition: ERF_DataStruct.H:92
#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
ParmParse pp("prob")
AMREX_ALWAYS_ASSERT(bx.length()[2]==khi+1)
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)
Definition: ERF_TurbStruct.H:40
AMREX_ASSERT_WITH_MESSAGE(wbar_cutoff_min > wbar_cutoff_max, "ERROR: wbar_cutoff_min < wbar_cutoff_max")
Definition: ERF_EWP.H:9
Definition: ERF_Fitch.H:9
Definition: ERF_GeneralAD.H:8
Definition: ERF_Kessler.H:38
Definition: ERF_MM5.H:26
Definition: ERF_Morrison.H:58
Definition: ERF_NOAHMP.H:53
Definition: ERF_SAM.H:53
Definition: ERF_SLM.H:26
Definition: ERF_SatAdj.H:41
Definition: ERF_SimpleAD.H:8
Definition: ERF_WSM6.H:37
Definition: ERF_AdvStruct.H:19
void display(std::string &pp_prefix)
Definition: ERF_AdvStruct.H:235
void init_params(std::string pp_prefix)
Definition: ERF_AdvStruct.H:21
Definition: ERF_DampingStruct.H:19
void init_params(std::string pp_prefix)
Definition: ERF_DampingStruct.H:21
void display()
Definition: ERF_DampingStruct.H:61
Definition: ERF_DiffStruct.H:19
void init_params(std::string pp_prefix)
Definition: ERF_DiffStruct.H:21
void display()
Definition: ERF_DiffStruct.H:67
MolecDiffType molec_diff_type
Definition: ERF_DiffStruct.H:84
Definition: ERF_EBStruct.H:23
void init_params(std::string pp_prefix)
Definition: ERF_EBStruct.H:25
void display()
Definition: ERF_EBStruct.H:43
Definition: ERF_DataStruct.H:106
int qs
Definition: ERF_DataStruct.H:111
int qr
Definition: ERF_DataStruct.H:110
MoistureComponentIndices()=default
int qi
Definition: ERF_DataStruct.H:109
int qv
Definition: ERF_DataStruct.H:107
int qc
Definition: ERF_DataStruct.H:108
int qg
Definition: ERF_DataStruct.H:112
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:115
Definition: ERF_DataStruct.H:130
amrex::Real hurricane_eye_latitude
Definition: ERF_DataStruct.H:1301
bool do_mom_advection
Definition: ERF_DataStruct.H:1186
amrex::Real if_init_surf_temp
Definition: ERF_DataStruct.H:1158
amrex::Real dz0
Definition: ERF_DataStruct.H:1174
amrex::Real const_massflux_layer_lo
Definition: ERF_DataStruct.H:1287
bool use_lagged_delta_rt
Definition: ERF_DataStruct.H:1164
amrex::Real coriolis_factor
Definition: ERF_DataStruct.H:1177
static MeshType mesh_type
Definition: ERF_DataStruct.H:1092
amrex::Real if_surf_temp_flux
Definition: ERF_DataStruct.H:1157
amrex::Real windfarm_x_shift
Definition: ERF_DataStruct.H:1274
void check_params(int max_level, const amrex::Vector< amrex::Geometry > &geom_vect, amrex::GpuArray< ERF_BC, AMREX_SPACEDIM *2 > phys_bc_type)
Definition: ERF_DataStruct.H:788
void display(int max_level, std::string pp_prefix)
Definition: ERF_DataStruct.H:876
bool rebalance_wrfinput
Definition: ERF_DataStruct.H:1246
amrex::Real hindcast_lateral_sponge_strength
Definition: ERF_DataStruct.H:1296
amrex::Real poisson_reltol
Definition: ERF_DataStruct.H:1135
void build_coriolis_forcings_const_lat(std::string pp_prefix)
Definition: ERF_DataStruct.H:1009
bool if_use_most
Definition: ERF_DataStruct.H:1161
DampingChoice dampingChoice
Definition: ERF_DataStruct.H:1102
int n_ensemble
Definition: ERF_DataStruct.H:1304
amrex::Real rdOcp
Definition: ERF_DataStruct.H:1169
bool spatial_moisture_forcing
Definition: ERF_DataStruct.H:1190
RadiationType rad_type
Definition: ERF_DataStruct.H:1253
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:1051
amrex::Vector< int > project_initial_velocity
Definition: ERF_DataStruct.H:1112
std::string windfarm_spec_table
Definition: ERF_DataStruct.H:1270
amrex::Real hindcast_zhi_sponge_length
Definition: ERF_DataStruct.H:1297
DiffChoice diffChoice
Definition: ERF_DataStruct.H:1101
amrex::Real const_massflux_v
Definition: ERF_DataStruct.H:1285
amrex::Real if_z0
Definition: ERF_DataStruct.H:1156
bool use_gravity
Definition: ERF_DataStruct.H:1142
int ncorr
Definition: ERF_DataStruct.H:1133
amrex::Vector< PerturbationType > pert_type
Definition: ERF_DataStruct.H:1239
int force_stage1_single_substep
Definition: ERF_DataStruct.H:1107
bool hindcast_zhi_sponge_damping
Definition: ERF_DataStruct.H:1298
std::string windfarm_spec_table_extra
Definition: ERF_DataStruct.H:1270
amrex::Real cosphi
Definition: ERF_DataStruct.H:1178
LandSurfaceType lsm_type
Definition: ERF_DataStruct.H:1252
amrex::Real c_p
Definition: ERF_DataStruct.H:1168
amrex::Vector< int > buoyancy_type
Definition: ERF_DataStruct.H:1113
std::string windfarm_loc_table
Definition: ERF_DataStruct.H:1270
amrex::Real ens_pert_amplitude
Definition: ERF_DataStruct.H:1306
bool do_theta_advection
Definition: ERF_DataStruct.H:1185
amrex::Real gravity
Definition: ERF_DataStruct.H:1167
bool any_perturbation() const
Definition: ERF_DataStruct.H:1226
amrex::Real bdy_nudge_factor
Definition: ERF_DataStruct.H:1278
amrex::Real beta_s
Definition: ERF_DataStruct.H:1120
bool custom_rhotheta_forcing
Definition: ERF_DataStruct.H:1182
amrex::Real hindcast_lateral_sponge_length
Definition: ERF_DataStruct.H:1296
amrex::GpuArray< amrex::Real, AMREX_SPACEDIM > abl_geo_forcing
Definition: ERF_DataStruct.H:1257
bool use_shoc
Definition: ERF_DataStruct.H:1200
WindFarmLocType windfarm_loc_type
Definition: ERF_DataStruct.H:1251
bool hindcast_lateral_forcing
Definition: ERF_DataStruct.H:1294
int massflux_klo
Definition: ERF_DataStruct.H:1289
bool moisture_tight_coupling
Definition: ERF_DataStruct.H:1268
bool custom_w_subsidence
Definition: ERF_DataStruct.H:1184
bool nudging_from_input_sounding
Definition: ERF_DataStruct.H:1194
bool custom_geostrophic_profile
Definition: ERF_DataStruct.H:1187
amrex::Real if_Cd_scalar
Definition: ERF_DataStruct.H:1153
bool immersed_forcing_substep
Definition: ERF_DataStruct.H:1149
amrex::Real grid_stretching_ratio
Definition: ERF_DataStruct.H:1172
amrex::Real sinphi
Definition: ERF_DataStruct.H:1179
bool have_geo_wind_profile
Definition: ERF_DataStruct.H:1259
amrex::Vector< amrex::Real > vert_implicit_fac
Definition: ERF_DataStruct.H:1126
bool use_perturbation(int lev) const
Definition: ERF_DataStruct.H:1208
amrex::Real hurricane_eye_longitude
Definition: ERF_DataStruct.H:1301
amrex::Real const_massflux_u
Definition: ERF_DataStruct.H:1284
amrex::GpuArray< amrex::Real, AMREX_SPACEDIM > abl_pressure_grad
Definition: ERF_DataStruct.H:1256
bool implicit_moisture_diffusion
Definition: ERF_DataStruct.H:1129
std::string hindcast_surface_data_dir
Definition: ERF_DataStruct.H:1292
void init_params(int max_level, std::string pp_prefix)
Definition: ERF_DataStruct.H:132
bool io_hurricane_eye_tracker
Definition: ERF_DataStruct.H:1300
bool use_direct_perturbation(int lev) const
Definition: ERF_DataStruct.H:1215
amrex::Vector< SubsteppingType > substepping_type
Definition: ERF_DataStruct.H:1109
bool coriolis_3d
Definition: ERF_DataStruct.H:1144
amrex::Real if_Olen_in
Definition: ERF_DataStruct.H:1160
bool use_num_diff
Definition: ERF_DataStruct.H:1242
amrex::Real sampling_distance_by_D
Definition: ERF_DataStruct.H:1272
bool implicit_thermal_diffusion
Definition: ERF_DataStruct.H:1128
amrex::Real hindcast_zhi_sponge_strength
Definition: ERF_DataStruct.H:1297
bool test_mapfactor
Definition: ERF_DataStruct.H:1137
bool use_coriolis
Definition: ERF_DataStruct.H:1143
static SoundingType sounding_type
Definition: ERF_DataStruct.H:1077
bool four_stream_radiation
Definition: ERF_DataStruct.H:1146
std::string coarse_bckgnd_data_file
Definition: ERF_DataStruct.H:1307
bool custom_moisture_forcing
Definition: ERF_DataStruct.H:1183
amrex::Real num_diff_coeff
Definition: ERF_DataStruct.H:1243
std::string windfarm_blade_table
Definition: ERF_DataStruct.H:1271
amrex::Real zsurf
Definition: ERF_DataStruct.H:1173
amrex::Real if_surf_heating_rate
Definition: ERF_DataStruct.H:1159
amrex::Vector< TurbChoice > turbChoice
Definition: ERF_DataStruct.H:1104
bool variable_coriolis
Definition: ERF_DataStruct.H:1261
amrex::Vector< int > anelastic
Definition: ERF_DataStruct.H:1110
amrex::Real if_Cd_momentum
Definition: ERF_DataStruct.H:1154
static bool upwind_real_bcs
Definition: ERF_DataStruct.H:1089
AdvChoice advChoice
Definition: ERF_DataStruct.H:1100
MoistureType moisture_type
Definition: ERF_DataStruct.H:1249
bool custom_forcing_prim_vars
Definition: ERF_DataStruct.H:1188
std::string abl_geo_wind_table
Definition: ERF_DataStruct.H:1258
static BuildingsType buildings_type
Definition: ERF_DataStruct.H:1083
static TerrainType terrain_type
Definition: ERF_DataStruct.H:1080
amrex::Real hindcast_data_interval_in_hrs
Definition: ERF_DataStruct.H:1293
ABLDriverType abl_driver_type
Definition: ERF_DataStruct.H:1255
amrex::Vector< int > fixed_density
Definition: ERF_DataStruct.H:1111
SpongeChoice spongeChoice
Definition: ERF_DataStruct.H:1103
WindFarmType windfarm_type
Definition: ERF_DataStruct.H:1250
static InitType init_type
Definition: ERF_DataStruct.H:1074
bool substepping_diag
Definition: ERF_DataStruct.H:1116
bool implicit_momentum_diffusion
Definition: ERF_DataStruct.H:1130
amrex::Real ens_pert_correlated_radius
Definition: ERF_DataStruct.H:1305
amrex::Real const_massflux_layer_hi
Definition: ERF_DataStruct.H:1288
bool use_source_perturbation(int lev) const
Definition: ERF_DataStruct.H:1221
bool implicit_before_substep
Definition: ERF_DataStruct.H:1131
static bool use_real_bcs
Definition: ERF_DataStruct.H:1086
amrex::Real poisson_abstol
Definition: ERF_DataStruct.H:1134
MoistureComponentIndices moisture_indices
Definition: ERF_DataStruct.H:1266
amrex::Real turb_disk_angle
Definition: ERF_DataStruct.H:1273
bool hindcast_surface_bcs
Definition: ERF_DataStruct.H:1295
amrex::Real windfarm_y_shift
Definition: ERF_DataStruct.H:1275
bool use_rotate_surface_flux
Definition: ERF_DataStruct.H:1197
bool do_forest_drag
Definition: ERF_DataStruct.H:1281
amrex::Real const_massflux_tau
Definition: ERF_DataStruct.H:1286
int massflux_khi
Definition: ERF_DataStruct.H:1290
bool time_avg_vel
Definition: ERF_DataStruct.H:1206
bool spatial_rhotheta_forcing
Definition: ERF_DataStruct.H:1189
bool forest_substep
Definition: ERF_DataStruct.H:1150
EBChoice ebChoice
Definition: ERF_DataStruct.H:1105
CouplingType coupling_type
Definition: ERF_DataStruct.H:1248
std::string windfarm_airfoil_tables
Definition: ERF_DataStruct.H:1271
bool transport_scalar
Definition: ERF_DataStruct.H:1203
int gradp_type
Definition: ERF_DataStruct.H:1139
static void set_mesh_type(MeshType new_mesh_type)
Definition: ERF_DataStruct.H:1095
bool is_init_for_ensemble
Definition: ERF_DataStruct.H:1303
int ave_plane
Definition: ERF_DataStruct.H:1263
std::string hindcast_boundary_data_dir
Definition: ERF_DataStruct.H:1292
Definition: ERF_SpongeStruct.H:15
void display()
Definition: ERF_SpongeStruct.H:47
void init_params(std::string pp_prefix)
Definition: ERF_SpongeStruct.H:17