1 #ifndef ERF_TURB_STRUCT_H_
2 #define ERF_TURB_STRUCT_H_
6 AMREX_ENUM(LESType, None, Smagorinsky, Smagorinsky2D, Deardorff);
10 AMREX_ENUM(PBLType, None, MYJ, MYNN25, MYNNEDMF, YSU, YSUNew, MRF, SHOC, EAMXX_SHOC, NATIVE_SHOC);
17 const amrex::ParmParse&
pp,
18 const char* query_string,
23 int count =
pp.countval(query_string);
26 }
else if (count == 1) {
28 return pp.query(query_string, query_var);
29 }
else if (count >= maxlev + 1) {
33 return pp.query(query_string, query_var, lev);
40 "For parmparse variable " +
pp.prefixedName(query_string) +
41 ": if specified, specify once total or at least once for each level");
49 const amrex::ParmParse&
pp,
50 const char* query_string,
55 int count =
pp.countval(query_string);
58 }
else if (count == 1) {
60 return pp.query_enum_case_insensitive(query_string, query_var);
61 }
else if (count >= maxlev + 1) {
65 return pp.query_enum_case_insensitive(query_string, query_var, lev);
72 "For parmparse variable " +
pp.prefixedName(query_string) +
73 ": if specified, specify once total or at least once for each level");
84 void init_params (
int lev,
int max_level, std::string pp_prefix)
86 amrex::ParmParse
pp(pp_prefix);
92 if (
les_type == LESType::Smagorinsky2D) {
101 amrex::Error(
"Hybrid RANS-LES not implemented");
107 static bool warned_legacy_shoc =
false;
108 if (!warned_legacy_shoc) {
109 amrex::Warning(
"erf.pbl_type = SHOC is deprecated; use erf.pbl_type = EAMXX_SHOC");
110 warned_legacy_shoc =
true;
119 amrex::Print() <<
"Selected a PBL model and an LES model: "
120 <<
"Using PBL for vertical transport, LES for horizontal"
123 if (
les_type == LESType::Smagorinsky) {
125 amrex::Error(
"If using Smagorinsky with a PBL model, the 2-D "
126 "formulation should be used");
127 }
else if (
les_type == LESType::Deardorff) {
129 "It is not recommended to use Deardorff LES and a PBL model");
162 pp,
"pbl_ysu_use_consistent_coriolis",
193 }
else if (
pbl_type == PBLType::MRF) {
213 }
else if (
pbl_type == PBLType::SHOC) {
215 amrex::Abort(
"You set use_shoc to true but didn't build with SHOC; you must rebuild the executable");
219 #ifndef ERF_USE_EAMXX_SHOC
220 amrex::Abort(
"PBLType::EAMXX_SHOC requested, but ERF was not built with ERF_ENABLE_EAMXX_SHOC=ON");
225 std::string zlo_bc =
"none";
226 amrex::ParmParse pp_bc(
"zlo");
227 pp_bc.get(
"type",zlo_bc);
228 if (amrex::toLower(zlo_bc) !=
"surface_layer") {
229 amrex::Abort(
"You must use the surface_layer BC at zlo with the selected PBL.");
260 if (
les_type == LESType::Deardorff) {
269 amrex::Print() <<
"Thermal stratification based on gradient of potential temperature" << std::endl;
271 amrex::Print() <<
"Thermal stratification based on gradient of virtual potential temperature" << std::endl;
273 amrex::Print() <<
"Thermal stratification based on gradient of linearized liquid-water potential temperature" << std::endl;
286 amrex::Print() <<
"Overriding default sigma_k for k-eqn RANS" << std::endl;
311 if (
les_type == LESType::Smagorinsky) {
313 amrex::Error(
"Need to specify Cs for Smagorsinky LES");
316 amrex::Print() <<
"Turning off mix_isotropic for 2-D Smagorinsky" << std::endl;
322 void check_params (amrex::GpuArray<ERF_BC, AMREX_SPACEDIM*2>& phys_bc_type)
326 phys_bc_type[amrex::Orientation(amrex::Direction::z,amrex::Orientation::low)] !=
ERF_BC::surface_layer ) {
327 amrex::Abort(
"The selected PBL model requires MOST at lower boundary");
330 (phys_bc_type[amrex::Orientation(amrex::Direction::z,amrex::Orientation::low)] !=
ERF_BC::surface_layer) &&
331 (phys_bc_type[amrex::Orientation(amrex::Direction::z,amrex::Orientation::low)] !=
ERF_BC::slip_wall) &&
332 (phys_bc_type[amrex::Orientation(amrex::Direction::z,amrex::Orientation::low)] !=
ERF_BC::no_slip_wall) )
334 amrex::Warning(
"Deardorff LES assumes wall at zlo when applying Ce_wall");
340 amrex::Print() <<
"Turbulence Settings at level " << lev << std::endl;
345 amrex::Print() <<
" Using DNS model at level " << lev << std::endl;
346 }
else if (
les_type == LESType::Smagorinsky) {
348 amrex::Print() <<
" Using 2D Smagorinsky LES model at level " << lev << std::endl;
350 amrex::Print() <<
" Using Smagorinsky LES model at level " << lev << std::endl;
353 amrex::Print() <<
" Smagorinsky uses Richardson number correction with Ri_crit = "
356 }
else if (
les_type == LESType::Deardorff) {
357 amrex::Print() <<
" Using Deardorff LES model at level " << lev << std::endl;
358 }
else if (
rans_type == RANSType::kEqn) {
360 <<
" Using Axell & Liungman one-equation RANS k model at level " << lev
362 }
else if (
pbl_type == PBLType::MYJ) {
363 amrex::Print() <<
" Using MYJ PBL model at level " << lev << std::endl;
364 }
else if (
pbl_type == PBLType::MYNN25) {
365 amrex::Print() <<
" Using MYNN2.5 PBL model at level " << lev << std::endl;
366 }
else if (
pbl_type == PBLType::MYNNEDMF) {
367 amrex::Print() <<
" Using MYNNEDMF PBL model at level " << lev << std::endl;
368 }
else if (
pbl_type == PBLType::YSU) {
369 amrex::Print() <<
" Using YSU PBL model at level " << lev << std::endl;
370 }
else if (
pbl_type == PBLType::YSUNew) {
371 amrex::Print() <<
" Using YSU PBL model at level " << lev << std::endl;
372 }
else if (
pbl_type == PBLType::MRF) {
373 amrex::Print() <<
" Using MRF PBL model at level " << lev << std::endl;
374 }
else if (
pbl_type == PBLType::EAMXX_SHOC) {
375 amrex::Print() <<
" Using EAMxx SHOC PBL model at level " << lev << std::endl;
376 }
else if (
pbl_type == PBLType::NATIVE_SHOC) {
377 amrex::Print() <<
" Using native SHOC PBL model at level " << lev << std::endl;
379 amrex::Error(
"Unknown turbulence model");
383 if (
les_type == LESType::Smagorinsky) {
384 amrex::Print() <<
" Cs : " <<
Cs << std::endl;
386 if (
les_type == LESType::Deardorff) {
387 amrex::Print() <<
" Ce : " <<
Ce << std::endl;
388 amrex::Print() <<
" Ce at wall : " <<
Ce_wall << std::endl;
389 amrex::Print() <<
" Ck : " <<
Ck << std::endl;
390 amrex::Print() <<
" sigma_k : " <<
sigma_k << std::endl;
394 amrex::Print() <<
" equivalent Cs : " << Cs_equiv
403 amrex::Print() <<
"Cmu0 : " <<
Cmu0 << std::endl;
404 amrex::Print() <<
"sigma_k : " <<
sigma_k << std::endl;
405 amrex::Print() <<
"Cb : " <<
Cb << std::endl;
406 amrex::Print() <<
"Rt_crit : " <<
Rt_crit << std::endl;
407 amrex::Print() <<
"Rt_min : " <<
Rt_min << std::endl;
408 amrex::Print() <<
"max_geom_lscale : " <<
l_g_max << std::endl;
412 if ((
les_type == LESType::Deardorff) ||
415 amrex::Print() <<
" reference theta : " <<
theta_ref << std::endl;
417 amrex::Print() <<
" reference theta : n/a" << std::endl;
422 amrex::Print() <<
" Pr_t : " <<
Pr_t << std::endl;
423 amrex::Print() <<
" Sc_t : " <<
Sc_t << std::endl;
427 amrex::Print() <<
" pbl_mynn_A1 : " <<
pbl_mynn.
A1 << std::endl;
428 amrex::Print() <<
" pbl_mynn_A2 : " <<
pbl_mynn.
A2 << std::endl;
429 amrex::Print() <<
" pbl_mynn_B1 : " <<
pbl_mynn.
B1 << std::endl;
430 amrex::Print() <<
" pbl_mynn_B2 : " <<
pbl_mynn.
B2 << std::endl;
431 amrex::Print() <<
" pbl_mynn_C1 : " <<
pbl_mynn.
C1 << std::endl;
432 amrex::Print() <<
" pbl_mynn_C2 : " <<
pbl_mynn.
C2 << std::endl;
433 amrex::Print() <<
" pbl_mynn_C3 : " <<
pbl_mynn.
C3 << std::endl;
434 amrex::Print() <<
" pbl_mynn_C4 : " <<
pbl_mynn.
C4 << std::endl;
435 amrex::Print() <<
" pbl_mynn_C5 : " <<
pbl_mynn.
C5 << std::endl;
437 amrex::Print() <<
" pbl_ysu_coriolis_freq : "
439 amrex::Print() <<
" pbl_ysu_use_consistent_coriolis : "
441 amrex::Print() <<
" pbl_ysu_force_over_water : "
443 amrex::Print() <<
" pbl_ysu_land_Ribcr : "
445 amrex::Print() <<
" pbl_ysu_unst_Ribcr : "
447 amrex::Print() <<
" enable_ysu_liquid_theta : "
449 amrex::Print() <<
" enable_ysu_countergradient : "
451 amrex::Print() <<
" enable_ysu_terrain_pblh_floor : "
453 amrex::Print() <<
" enable_ysu_sat_limiter : "
455 amrex::Print() <<
" enable_ysu_topdown : "
457 amrex::Print() <<
" enable_ysu_entrainment : "
459 amrex::Print() <<
" enable_ysu_cloud_pblh : "
461 amrex::Print() <<
" ysu_qcloud_threshold : "
463 amrex::Print() <<
" ysu_moistvars : "
465 amrex::Print() <<
" pbl_ysunew_highres_bounds : "
467 amrex::Print() <<
" enable_mrf_unbounded_vpert : "
469 }
else if (
pbl_type == PBLType::MRF) {
476 amrex::Print() <<
" pbl_mrf_sf : " <<
pbl_mrf_sf
545 return pbl_type == PBLType::EAMXX_SHOC;
550 return pbl_type == PBLType::NATIVE_SHOC;
560 return (
pbl_type == PBLType::MYNN25) ||
constexpr amrex::Real three
Definition: ERF_Constants.H:11
constexpr amrex::Real one
Definition: ERF_Constants.H:9
constexpr amrex::Real fourth
Definition: ERF_Constants.H:14
constexpr amrex::Real zero
Definition: ERF_Constants.H:8
Real T
Definition: ERF_InitCustomPert_Bubble.H:106
amrex::Real Real
Definition: ERF_ShocInterface.H:19
AMREX_ENUM(LESType, None, Smagorinsky, Smagorinsky2D, Deardorff)
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:48
int query_one_or_per_level(const amrex::ParmParse &pp, const char *query_string, T &query_var, const int lev, const int maxlev)
Definition: ERF_TurbStruct.H:16
@ theta
Definition: ERF_MM5.H:20
Definition: ERF_MYNNStruct.H:11
amrex::Real SMmax
Definition: ERF_MYNNStruct.H:58
amrex::Real SHmax
Definition: ERF_MYNNStruct.H:60
amrex::Real SQfac
Definition: ERF_MYNNStruct.H:54
amrex::Real C4
Definition: ERF_MYNNStruct.H:50
amrex::Real C1
Definition: ERF_MYNNStruct.H:47
amrex::Real C3
Definition: ERF_MYNNStruct.H:49
amrex::Real C2
Definition: ERF_MYNNStruct.H:48
amrex::Real A2
Definition: ERF_MYNNStruct.H:44
amrex::Real SHmin
Definition: ERF_MYNNStruct.H:59
amrex::Real B1
Definition: ERF_MYNNStruct.H:45
amrex::Real B2
Definition: ERF_MYNNStruct.H:46
amrex::Real C5
Definition: ERF_MYNNStruct.H:51
amrex::Real SMmin
Definition: ERF_MYNNStruct.H:57
amrex::Real A1
Definition: ERF_MYNNStruct.H:43
bool diffuse_moistvars
Definition: ERF_MYNNStruct.H:65
Definition: ERF_MYNNStruct.H:68
void init_coeffs(amrex::Real A1_lvl25, amrex::Real A2_lvl25, amrex::Real B1, amrex::Real B2, amrex::Real C1, amrex::Real C2, amrex::Real C3, amrex::Real, amrex::Real C5)
Definition: ERF_MYNNStruct.H:69
Definition: ERF_TurbStruct.H:82
bool enable_ysu_countergradient
Definition: ERF_TurbStruct.H:610
amrex::Real tke_min
Definition: ERF_TurbStruct.H:591
bool smag2d
Definition: ERF_TurbStruct.H:506
amrex::Real sigma_k
Definition: ERF_TurbStruct.H:522
bool pbl_mrf_use_zero_ri_extent
Definition: ERF_TurbStruct.H:636
MYNNLevel25 pbl_mynn
Definition: ERF_TurbStruct.H:573
PBLType pbl_type
Definition: ERF_TurbStruct.H:541
amrex::Real pbl_mrf_const_b
Definition: ERF_TurbStruct.H:629
bool use_pbl_tke
Definition: ERF_TurbStruct.H:581
amrex::Real ysu_qcloud_threshold
Definition: ERF_TurbStruct.H:622
void check_params(amrex::GpuArray< ERF_BC, AMREX_SPACEDIM *2 > &phys_bc_type)
Definition: ERF_TurbStruct.H:322
amrex::Real Sc_t_inv
Definition: ERF_TurbStruct.H:502
amrex::Real Rt_min
Definition: ERF_TurbStruct.H:517
bool use_keqn
Definition: ERF_TurbStruct.H:578
amrex::Real pbl_mrf_coriolis_freq
Definition: ERF_TurbStruct.H:627
bool pbl_ysunew_highres_bounds
Definition: ERF_TurbStruct.H:625
bool enable_ysu_topdown
Definition: ERF_TurbStruct.H:616
MYNNLevel2 pbl_mynn_level2
Definition: ERF_TurbStruct.H:574
amrex::Real Ri_crit
Definition: ERF_TurbStruct.H:533
RANSType rans_type
Definition: ERF_TurbStruct.H:536
StratType strat_type
Definition: ERF_TurbStruct.H:527
bool uses_eamxx_shoc() const noexcept
Definition: ERF_TurbStruct.H:543
bool enable_mrf_unbounded_vpert
Definition: ERF_TurbStruct.H:635
bool dirichlet_k
Definition: ERF_TurbStruct.H:538
amrex::Real pbl_mrf_Ribcr
Definition: ERF_TurbStruct.H:628
bool advect_tke
Definition: ERF_TurbStruct.H:639
amrex::Real Ck
Definition: ERF_TurbStruct.H:511
bool uses_shoc_family() const noexcept
Definition: ERF_TurbStruct.H:553
amrex::Real Cmu0
Definition: ERF_TurbStruct.H:514
bool pbl_ysu_use_consistent_coriolis
Definition: ERF_TurbStruct.H:598
bool uses_native_shoc() const noexcept
Definition: ERF_TurbStruct.H:548
amrex::Real Cb
Definition: ERF_TurbStruct.H:515
amrex::Real pbl_mrf_sf
Definition: ERF_TurbStruct.H:630
void init_params(int lev, int max_level, std::string pp_prefix)
Definition: ERF_TurbStruct.H:84
bool enable_mrf_countergradient
Definition: ERF_TurbStruct.H:632
bool use_Ri_correction
Definition: ERF_TurbStruct.H:532
bool enable_ysu_sat_limiter
Definition: ERF_TurbStruct.H:614
bool init_tke_from_ustar
Definition: ERF_TurbStruct.H:588
amrex::Real pbl_ysu_land_Ribcr
Definition: ERF_TurbStruct.H:604
bool mrf_moistvars
Definition: ERF_TurbStruct.H:631
bool use_tke
Definition: ERF_TurbStruct.H:583
bool diffuse_tke_3D
Definition: ERF_TurbStruct.H:641
bool enable_ysu_entrainment
Definition: ERF_TurbStruct.H:618
amrex::Real Cs
Definition: ERF_TurbStruct.H:505
amrex::Real Pr_t_inv
Definition: ERF_TurbStruct.H:498
bool pbl_suppresses_microphysics_condensation() const noexcept
Definition: ERF_TurbStruct.H:568
amrex::Real Ce_wall
Definition: ERF_TurbStruct.H:510
amrex::Real Ce
Definition: ERF_TurbStruct.H:509
bool enable_mrf_cloud_adjustment
Definition: ERF_TurbStruct.H:633
bool enable_ysu_cloud_pblh
Definition: ERF_TurbStruct.H:620
LESType les_type
Definition: ERF_TurbStruct.H:494
bool enable_ysu_terrain_pblh_floor
Definition: ERF_TurbStruct.H:612
amrex::Real pbl_ysu_coriolis_freq
Definition: ERF_TurbStruct.H:595
bool pbl_ysu_force_over_water
Definition: ERF_TurbStruct.H:601
bool enable_ysu_liquid_theta
Definition: ERF_TurbStruct.H:608
void display(int lev)
Definition: ERF_TurbStruct.H:338
bool pbl_mrf_highres_bounds
Definition: ERF_TurbStruct.H:634
amrex::Real Pr_t
Definition: ERF_TurbStruct.H:497
bool use_kturb
Definition: ERF_TurbStruct.H:577
amrex::Real theta_ref
Definition: ERF_TurbStruct.H:525
amrex::Real Sc_t
Definition: ERF_TurbStruct.H:501
amrex::Real Rt_crit
Definition: ERF_TurbStruct.H:516
bool ysu_moistvars
Definition: ERF_TurbStruct.H:624
amrex::Real pbl_ysu_unst_Ribcr
Definition: ERF_TurbStruct.H:606
bool mix_isotropic
Definition: ERF_TurbStruct.H:530
amrex::Real l_g_max
Definition: ERF_TurbStruct.H:518
bool pbl_requires_surface_layer() const noexcept
Definition: ERF_TurbStruct.H:558