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