#include <ERF_TurbStruct.H>

Collaboration diagram for TurbChoice:

[legend]

Public Member Functions
void	init_params (int lev, int max_level, std::string pp_prefix)
	Read turbulence options for one AMR level from the input parameter database. More...

void	check_params (amrex::GpuArray< ERF_BC, AMREX_SPACEDIM *2 > &phys_bc_type)
	Validate turbulence options against physical boundary conditions. More...

void	display (int lev)
	Print turbulence settings for one AMR level. More...

bool	uses_eamxx_shoc () const noexcept
	Query whether this level uses the EAMxx SHOC PBL scheme. More...

bool	uses_native_shoc () const noexcept
	Query whether this level uses the native SHOC PBL scheme. More...

bool	uses_shoc_family () const noexcept
	Query whether this level uses any SHOC-family PBL scheme. More...

bool	pbl_requires_surface_layer () const noexcept
	Query whether the selected PBL scheme requires surface-layer boundary conditions. More...

bool	pbl_suppresses_microphysics_condensation () const noexcept
	Query whether the selected PBL scheme suppresses microphysics condensation. More...

Public Attributes
LESType	les_type = LESType::None
	Selected LES closure. More...

amrex::Real	Pr_t = one / three
	Turbulent Prandtl number. More...

amrex::Real	Pr_t_inv = three
	Inverse turbulent Prandtl number. More...

amrex::Real	Sc_t = one
	Turbulent Schmidt number. More...

amrex::Real	Sc_t_inv = one
	Inverse turbulent Schmidt number. More...

amrex::Real	Cs = zero
	Smagorinsky model coefficient. More...

bool	smag2d = false
	Whether the 2-D Smagorinsky formulation is used. More...

amrex::Real	Ce = amrex::Real(0.93)
	Deardorff dissipation coefficient. More...

amrex::Real	Ce_wall = zero
	Wall value for the Deardorff dissipation coefficient. More...

amrex::Real	Ck = amrex::Real(0.1)
	Deardorff eddy-viscosity coefficient. More...

amrex::Real	Cmu0 = amrex::Real(0.5562)
	One-equation RANS Cmu0 coefficient. More...

amrex::Real	Cb = amrex::Real(0.35)
	One-equation RANS buoyancy coefficient. More...

amrex::Real	Rt_crit = -one
	Critical turbulent Reynolds number. More...

amrex::Real	Rt_min = -three
	Minimum turbulent Reynolds number. More...

amrex::Real	l_g_max = amrex::Real(30.0)
	Maximum geometric length scale. More...

amrex::Real	sigma_k = amrex::Real(0.5)
	TKE diffusivity coefficient denominator. More...

amrex::Real	theta_ref = zero
	Reference potential temperature for stable stratification. More...

StratType	strat_type = StratType::theta
	Thermodynamic variable used for stability stratification. More...

bool	mix_isotropic = true
	Whether subgrid mixing uses isotropic length scales. More...

bool	use_Ri_correction = true
	Whether Richardson-number correction is applied. More...

amrex::Real	Ri_crit = fourth
	Critical Richardson number for stability correction. More...

RANSType	rans_type = RANSType::None
	Selected RANS closure. More...

bool	dirichlet_k = false
	Whether TKE uses Dirichlet boundary treatment. More...

amrex::Real	tke_floor = zero

bool	implicit_tke_dissipation = false

bool	rans_consistent_diffusivities = false

bool	rans_lscale_from_pblh = false

amrex::Real	rans_lscale_min = one

PBLType	pbl_type = PBLType::None
	Selected PBL closure. More...

MYNNLevel25	pbl_mynn
	MYNN level-2.5 closure coefficients. More...

MYNNLevel2	pbl_mynn_level2
	MYNN level-2 closure coefficients for limiting. More...

bool	use_kturb = false
	Whether any turbulence model is active. More...

bool	use_keqn
	Whether a microscale TKE closure is active. More...

bool	use_pbl_tke
	Whether a mesoscale PBL TKE closure is active. More...

bool	use_tke = false
	Whether any TKE or QKE closure is active. More...

bool	init_tke_from_ustar = false
	Whether initial TKE/QKE profiles are based on surface friction velocity. More...

amrex::Real	tke_min = amrex::Real(1.e-6)
	Minimum TKE/QKE value. More...

amrex::Real	pbl_ysu_coriolis_freq
	Coriolis frequency used by YSU-family PBL schemes. More...

bool	pbl_ysu_use_consistent_coriolis
	Whether YSU uses the ERF Coriolis frequency. More...

bool	pbl_ysu_force_over_water
	Whether YSU is forced to use over-water behavior. More...

amrex::Real	pbl_ysu_land_Ribcr
	Critical bulk Richardson number over land for stable YSU conditions. More...

amrex::Real	pbl_ysu_unst_Ribcr
	Critical bulk Richardson number for unstable YSU conditions. More...

bool	enable_ysu_liquid_theta
	Whether YSU uses liquid-water virtual potential temperature for stability. More...

bool	enable_ysu_countergradient
	Whether YSU countergradient corrections are enabled. More...

bool	enable_ysu_terrain_pblh_floor
	Whether YSU applies a terrain-following PBL-height floor. More...

bool	enable_ysu_sat_limiter
	Whether YSU applies a saturation limiter to moisture countergradient terms. More...

bool	enable_ysu_topdown
	Whether YSU top-down mixing is enabled. More...

bool	enable_ysu_entrainment
	Whether YSU entrainment-layer parameterization is enabled. More...

bool	enable_ysu_cloud_pblh
	Whether YSU cloud-based PBL-height detection is enabled. More...

amrex::Real	ysu_qcloud_threshold
	Cloud liquid water threshold for YSUNew [kg/kg]. More...

bool	ysu_moistvars = false
	Whether YSU applies turbulence to moisture variables. More...

bool	pbl_ysunew_highres_bounds = false
	Whether YSUNew applies high-resolution grid-dependent diffusivity bounds. More...

bool	enable_ysu_rad_tend_limiter = false

amrex::Real	ysu_rad_tend_limiter_magnitude = amrex::Real(1.0)

bool	enable_vh96_shear_correction = false
	Whether Vogelezang & Holtslag (1996) shear-correction term is enabled. More...

amrex::Real	vh96_shear_const_b = amrex::Real(100.0)
	Vogelezang & Holtslag (1996) shear-correction constant b. More...

bool	enable_pblh_smoothing = false
	Whether spatial smoothing of diagnosed PBLH is enabled. More...

int	pblh_smoothing_passes = 1
	Number of PBLH smoothing iterations to apply. More...

amrex::Real	pblh_smoothing_weight = amrex::Real(0.5)
	Center-cell weight in PBLH smoothing stencil (must be in [0,1]). More...

amrex::Real	pbl_mrf_coriolis_freq = amrex::Real(1.0e-4)
	Coriolis frequency used by the MRF PBL scheme. More...

amrex::Real	pbl_mrf_Ribcr = amrex::Real(0.5)
	Critical bulk Richardson number for the MRF PBL scheme. More...

amrex::Real	pbl_mrf_const_b = amrex::Real(7.8)
	MRF constant used to compute PBL height. More...

amrex::Real	pbl_mrf_sf = amrex::Real(0.1)
	MRF surface flux value used to compute PBL height. More...

amrex::Real	pbl_blend_length = amrex::Real(0.0)
	Boutle blending length L [m]. 0 = off. More...

amrex::Real	pbl_blend_cs = amrex::Real(0.17)
	Smagorinsky coeff for K_h ceiling. More...

amrex::Real	pbl_blend_c_max = amrex::Real(0.1)
	Power-law ceiling coeff [m^(2/3)/s]. More...

bool	pbl_blend_use_smag = true
	Use Smagorinsky ceiling (else power-law). More...

bool	enable_mrf_countergradient = false
	Whether MRF countergradient corrections are enabled. More...

bool	pbl_ib_aware = false

amrex::Real	pbl_ib_z0 = amrex::Real(0.01)

bool	enable_mrf_cloud_adjustment = false
	Whether MRF cloud-aware stability adjustments are enabled. More...

bool	pbl_mrf_highres_bounds = false
	Whether MRF applies high-resolution grid-dependent diffusivity bounds. More...

bool	enable_mrf_unbounded_vpert = false
	Whether MRF leaves VPERT unlimited by GAMCRT. More...

bool	pbl_mrf_use_zero_ri_extent = false
	Whether MRF uses the Ri=0 K-profile extent. More...

bool	enable_qnse_stable_functions = false

amrex::Real	qnse_am = amrex::Real(2.5)

amrex::Real	qnse_bm = amrex::Real(0.2)

amrex::Real	qnse_ah = amrex::Real(2.5)

amrex::Real	qnse_bh = amrex::Real(0.2)

bool	advect_tke = true
	Whether TKE/QKE is advected. More...

bool	diffuse_tke_3D = true
	Whether three-dimensional numerical diffusion is applied to TKE/QKE. More...

Detailed Description

Container holding quantities related to turbulence parametrizations

Member Function Documentation

◆ check_params()

void TurbChoice::check_params ( amrex::GpuArray< ERF_BC, AMREX_SPACEDIM *2 > & phys_bc_type )

inline

Validate turbulence options against physical boundary conditions.

Parameters

phys_bc_type Physical boundary-condition types.

   {
       // BC compatibility
       if (pbl_requires_surface_layer() &&
           phys_bc_type[amrex::Orientation(amrex::Direction::z,amrex::Orientation::low)] != ERF_BC::surface_layer ) {
           amrex::Abort("The selected PBL model requires MOST at lower boundary");
       }
       if ( (les_type == LESType::Deardorff) && (Ce_wall > 0) &&
            (phys_bc_type[amrex::Orientation(amrex::Direction::z,amrex::Orientation::low)] != ERF_BC::surface_layer) &&
            (phys_bc_type[amrex::Orientation(amrex::Direction::z,amrex::Orientation::low)] != ERF_BC::slip_wall) &&
            (phys_bc_type[amrex::Orientation(amrex::Direction::z,amrex::Orientation::low)] != ERF_BC::no_slip_wall) )
       {
           amrex::Warning("Deardorff LES assumes wall at zlo when applying Ce_wall");
       }
   }

Here is the call graph for this function:

◆ display()

void TurbChoice::display ( int lev )

inline

Print turbulence settings for one AMR level.

Parameters

lev	AMR level index.

   {
     amrex::Print() << "Turbulence Settings at level " << lev << std::endl;
  
     if (
       les_type == LESType::None && rans_type == RANSType::None &&
       pbl_type == PBLType::None) {
       amrex::Print() << "    Using DNS model at level " << lev << std::endl;
     } else if (les_type == LESType::Smagorinsky) {
       if (smag2d) {
         amrex::Print() << "    Using 2D Smagorinsky LES model at level " << lev << std::endl;
       } else {
         amrex::Print() << "    Using Smagorinsky LES model at level " << lev << std::endl;
       }
       if (use_Ri_correction) {
         amrex::Print() << "    Smagorinsky uses Richardson number correction with Ri_crit = "
                        << Ri_crit << std::endl;
       }
     } else if (les_type == LESType::Deardorff) {
       amrex::Print() << "    Using Deardorff LES model at level " << lev << std::endl;
     } else if (rans_type == RANSType::kEqn) {
       amrex::Print()
         << "    Using Axell & Liungman one-equation RANS k model at level " << lev
         << std::endl;
     } else if (pbl_type == PBLType::MYJ) {
       amrex::Print() << "    Using MYJ PBL model at level " << lev << std::endl;
     } else if (pbl_type == PBLType::MYNN25) {
       amrex::Print() << "    Using MYNN2.5 PBL model at level " << lev << std::endl;
     } else if (pbl_type == PBLType::MYNNEDMF) {
       amrex::Print() << "    Using MYNNEDMF PBL model at level " << lev << std::endl;
     } else if (pbl_type == PBLType::YSU) {
       amrex::Print() << "    Using YSU PBL model at level " << lev << std::endl;
     } else if (pbl_type == PBLType::YSUNew) {
       amrex::Print() << "    Using YSU PBL model at level " << lev << std::endl;
     } else if (pbl_type == PBLType::MRF) {
       amrex::Print() << "    Using MRF PBL model at level " << lev << std::endl;
     } else if (pbl_type == PBLType::EAMXX_SHOC) {
       amrex::Print() << "    Using EAMxx SHOC PBL model at level " << lev << std::endl;
     } else if (pbl_type == PBLType::NATIVE_SHOC) {
       amrex::Print() << "    Using native SHOC PBL model at level " << lev << std::endl;
     } else {
       amrex::Error("Unknown turbulence model");
     }
  
     if (les_type != LESType::None) {
       if (les_type == LESType::Smagorinsky) {
         amrex::Print() << "    Cs                      : " << Cs << std::endl;
       }
       if (les_type == LESType::Deardorff) {
         amrex::Print() << "    Ce                      : " << Ce      << std::endl;
         amrex::Print() << "    Ce at wall              : " << Ce_wall << std::endl;
         amrex::Print() << "    Ck                      : " << Ck      << std::endl;
         amrex::Print() << "    sigma_k                 : " << sigma_k << std::endl;
  
         // Sullivan et al 1994, Eqn 14
         amrex::Real Cs_equiv = std::sqrt(Ck * std::sqrt(Ck / Ce));
         amrex::Print() << "    equivalent Cs           : " << Cs_equiv
                        << std::endl;
       }
       amrex::Print() << "    isotropic mixing        : " << mix_isotropic
                      << std::endl;
     }
  
     if (rans_type != RANSType::None) {
       if (rans_type == RANSType::kEqn) {
         amrex::Print() << "Cmu0                        : " << Cmu0 << std::endl;
         amrex::Print() << "sigma_k                     : " << sigma_k << std::endl;
         amrex::Print() << "Cb                          : " << Cb << std::endl;
         amrex::Print() << "Rt_crit                     : " << Rt_crit << std::endl;
         amrex::Print() << "Rt_min                      : " << Rt_min << std::endl;
         amrex::Print() << "max_geom_lscale             : " << l_g_max << std::endl;
         amrex::Print() << "dirichlet_k                 : " << dirichlet_k << std::endl;
         amrex::Print() << "tke_floor                   : " << tke_floor << std::endl;
         amrex::Print() << "implicit_tke_dissipation    : " << implicit_tke_dissipation << std::endl;
         amrex::Print() << "consistent diffusivities    : " << rans_consistent_diffusivities << std::endl;
         amrex::Print() << "lscale cap from PBL height  : " << rans_lscale_from_pblh
                        << " (floor " << rans_lscale_min << " m)" << std::endl;
       }
     }
  
     if ((les_type  == LESType::Deardorff) ||
         (rans_type == RANSType::kEqn)) {
       if (theta_ref > 0) {
         amrex::Print() << "    reference theta         : " << theta_ref << std::endl;
       } else {
         amrex::Print() << "    reference theta         : n/a" << std::endl;
       }
     }
  
     if ((les_type != LESType::None) || (rans_type != RANSType::None)) {
       amrex::Print() << "    Pr_t                    : " << Pr_t << std::endl;
       amrex::Print() << "    Sc_t                    : " << Sc_t << std::endl;
     }
  
     if (pbl_type == PBLType::MYNN25 || pbl_type == PBLType::MYNNEDMF) {
       amrex::Print() << "    pbl_mynn_A1 : " << pbl_mynn.A1 << std::endl;
       amrex::Print() << "    pbl_mynn_A2 : " << pbl_mynn.A2 << std::endl;
       amrex::Print() << "    pbl_mynn_B1 : " << pbl_mynn.B1 << std::endl;
       amrex::Print() << "    pbl_mynn_B2 : " << pbl_mynn.B2 << std::endl;
       amrex::Print() << "    pbl_mynn_C1 : " << pbl_mynn.C1 << std::endl;
       amrex::Print() << "    pbl_mynn_C2 : " << pbl_mynn.C2 << std::endl;
       amrex::Print() << "    pbl_mynn_C3 : " << pbl_mynn.C3 << std::endl;
       amrex::Print() << "    pbl_mynn_C4 : " << pbl_mynn.C4 << std::endl;
       amrex::Print() << "    pbl_mynn_C5 : " << pbl_mynn.C5 << std::endl;
     } else if (pbl_type == PBLType::YSU || pbl_type == PBLType::YSUNew) {
       amrex::Print() << "    pbl_ysu_coriolis_freq              : "
                      << pbl_ysu_coriolis_freq << std::endl;
       amrex::Print() << "    pbl_ysu_use_consistent_coriolis    : "
                      << pbl_ysu_use_consistent_coriolis << std::endl;
       amrex::Print() << "    pbl_ysu_force_over_water           : "
                      << pbl_ysu_force_over_water << std::endl;
       amrex::Print() << "    pbl_ysu_land_Ribcr                 : "
                      << pbl_ysu_land_Ribcr << std::endl;
       amrex::Print() << "    pbl_ysu_unst_Ribcr                 : "
                      << pbl_ysu_unst_Ribcr << std::endl;
       amrex::Print() << "    enable_ysu_liquid_theta            : "
                      << enable_ysu_liquid_theta << std::endl;
       amrex::Print() << "    enable_ysu_countergradient         : "
                      << enable_ysu_countergradient << std::endl;
       amrex::Print() << "    enable_ysu_terrain_pblh_floor      : "
                      << enable_ysu_terrain_pblh_floor << std::endl;
       amrex::Print() << "    enable_ysu_sat_limiter             : "
                      << enable_ysu_sat_limiter << std::endl;
       amrex::Print() << "    enable_ysu_topdown                 : "
                      << enable_ysu_topdown << std::endl;
       amrex::Print() << "    enable_ysu_entrainment             : "
                      << enable_ysu_entrainment << std::endl;
       amrex::Print() << "    enable_ysu_cloud_pblh              : "
                      << enable_ysu_cloud_pblh << std::endl;
       amrex::Print() << "    ysu_qcloud_threshold               : "
                      << ysu_qcloud_threshold << std::endl;
       amrex::Print() << "    ysu_moistvars                      : "
                      << ysu_moistvars << std::endl;
       amrex::Print() << "    pbl_ysunew_highres_bounds          : "
                      << pbl_ysunew_highres_bounds << std::endl;
       // Radiative tendency limiter/smoothing (YSUNew-only)
       amrex::Print() << "    enable_ysu_rad_tend_limiter        : "
                      << enable_ysu_rad_tend_limiter << std::endl;
       amrex::Print() << "    ysu_rad_tend_limiter_magnitude     : "
                      << ysu_rad_tend_limiter_magnitude << std::endl;
       amrex::Print() << "    enable_vh96_shear_correction       : "
                      << enable_vh96_shear_correction << std::endl;
       amrex::Print() << "    vh96_shear_const_b                 : "
                      << vh96_shear_const_b << std::endl;
       amrex::Print() << "    enable_pblh_smoothing              : "
                      << enable_pblh_smoothing << std::endl;
       amrex::Print() << "    pblh_smoothing_passes              : "
                      << pblh_smoothing_passes << std::endl;
       amrex::Print() << "    pblh_smoothing_weight              : "
                      << pblh_smoothing_weight << std::endl;
       amrex::Print() << "    enable_mrf_unbounded_vpert         : "
                      << enable_mrf_unbounded_vpert << std::endl;
       amrex::Print() << "    enable_qnse_stable_functions       : "
                      << enable_qnse_stable_functions << std::endl;
       if (enable_qnse_stable_functions) {
         amrex::Print() << "      qnse_am (momentum coeff)         : " << qnse_am << std::endl;
         amrex::Print() << "      qnse_bm (momentum coeff)         : " << qnse_bm << std::endl;
         amrex::Print() << "      qnse_ah (heat coeff)             : " << qnse_ah << std::endl;
         amrex::Print() << "      qnse_bh (heat coeff)             : " << qnse_bh << std::endl;
       }
     } else if (pbl_type == PBLType::MRF) {
       amrex::Print() << "    pbl_mrf_coriolis_freq : " << pbl_mrf_coriolis_freq
                      << std::endl;
       amrex::Print() << "    pbl_mrf_Ribcr         : " << pbl_mrf_Ribcr
                      << std::endl;
       amrex::Print() << "    pbl_mrf_const_b       : " << pbl_mrf_const_b
                      << std::endl;
       amrex::Print() << "    pbl_mrf_sf            : " << pbl_mrf_sf
                      << std::endl;
       amrex::Print() << "    enable_mrf_countergradient : " << enable_mrf_countergradient
                      << std::endl;
       amrex::Print() << "    enable_mrf_cloud_adjustment : " << enable_mrf_cloud_adjustment
                      << std::endl;
       amrex::Print() << "    pbl_mrf_highres_bounds     : " << pbl_mrf_highres_bounds
                      << std::endl;
       amrex::Print() << "    enable_mrf_unbounded_vpert : " << enable_mrf_unbounded_vpert
                      << std::endl;
       amrex::Print() << "    pbl_mrf_use_zero_ri_extent : " << pbl_mrf_use_zero_ri_extent
                      << std::endl;
       amrex::Print() << "    pbl_blend_length   : " << pbl_blend_length
                      << std::endl;
       amrex::Print() << "    pbl_blend_cs       : " << pbl_blend_cs
                      << std::endl;
       amrex::Print() << "    pbl_blend_c_max    : " << pbl_blend_c_max
                      << std::endl;
       amrex::Print() << "    pbl_blend_use_smag : " << pbl_blend_use_smag
                      << std::endl;
       amrex::Print() << "    enable_vh96_shear_correction : " << enable_vh96_shear_correction
                      << std::endl;
       amrex::Print() << "    vh96_shear_const_b           : " << vh96_shear_const_b
                      << std::endl;
       amrex::Print() << "    enable_pblh_smoothing        : " << enable_pblh_smoothing
                      << std::endl;
       amrex::Print() << "    pblh_smoothing_passes        : " << pblh_smoothing_passes
                      << std::endl;
       amrex::Print() << "    pblh_smoothing_weight        : " << pblh_smoothing_weight
                      << std::endl;
       amrex::Print() << "    enable_qnse_stable_functions       : "
                      << enable_qnse_stable_functions << std::endl;
       if (enable_qnse_stable_functions) {
         amrex::Print() << "      qnse_am (momentum coeff)         : " << qnse_am << std::endl;
         amrex::Print() << "      qnse_bm (momentum coeff)         : " << qnse_bm << std::endl;
         amrex::Print() << "      qnse_ah (heat coeff)             : " << qnse_ah << std::endl;
         amrex::Print() << "      qnse_bh (heat coeff)             : " << qnse_bh << std::endl;
       }
     }
   }

◆ init_params()

void TurbChoice::init_params	(	int	lev,
		int	max_level,
		std::string	pp_prefix
	)

inline

Read turbulence options for one AMR level from the input parameter database.

Parameters

lev	AMR level index.
max_level	Maximum AMR level configured for the run.
pp_prefix	ParmParse prefix for the ERF input namespace.

   {
     amrex::ParmParse pp(pp_prefix);
  
     // Which LES closure?
     query_one_or_per_level(pp, "les_type", les_type, lev, max_level);
     // Immersed-boundary awareness of the MRF and YSUNew schemes (off by default):
     // the surface of a column with immersed solid cells is the first fluid cell
     // above them, heights and the boundary-layer depth are measured from it,
     // the eddy diffusivities are zero inside the solid, and the surface
     // scales over such a column come from a neutral log law at its top with
     // the roughness pbl_ib_z0. Only MRF and YSUNew honour it.
     query_one_or_per_level(pp, "pbl_ib_aware", pbl_ib_aware, lev, max_level);
     query_one_or_per_level(pp, "pbl_ib_z0",    pbl_ib_z0,    lev, max_level);
  
     // Handle 2-D Smag
     if (les_type == LESType::Smagorinsky2D) {
         les_type = LESType::Smagorinsky;
         smag2d = true;
     }
  
     // Which RANS closure?
     query_one_or_per_level(pp, "rans_type", rans_type, lev, max_level);
  
     if ((rans_type != RANSType::None) && (les_type != LESType::None)) {
         amrex::Error("Hybrid RANS-LES not implemented");
     }
  
     // Which PBL Closure
     query_one_or_per_level_enum_case_insensitive(pp, "pbl_type", pbl_type, lev, max_level);
     if (pbl_type == PBLType::SHOC) {
       static bool warned_legacy_shoc = false;
       if (!warned_legacy_shoc) {
         amrex::Warning("erf.pbl_type = SHOC is deprecated; use erf.pbl_type = EAMXX_SHOC");
         warned_legacy_shoc = true;
       }
       pbl_type = PBLType::EAMXX_SHOC;
     }
  
     // Do some more stuff for PBL Modeling
     if (pbl_type != PBLType::None) {
       // Check for compatibility between PBL, LES, Molec Transport
       if (les_type != LESType::None) {
         amrex::Print() << "Selected a PBL model and an LES model: "
                        << "Using PBL for vertical transport, LES for horizontal"
                        << std::endl;
       }
       if (les_type == LESType::Smagorinsky) {
         if (!smag2d)
           amrex::Error("If using Smagorinsky with a PBL model, the 2-D "
                        "formulation should be used");
       } else if (les_type == LESType::Deardorff) {
         amrex::Error(
           "It is not recommended to use Deardorff LES and a PBL model");
       }
       // Both the k-eqn RANS closure and these PBL schemes transport RhoKE
       if ((rans_type == RANSType::kEqn) &&
           ((pbl_type == PBLType::MYJ) || (pbl_type == PBLType::MYNN25) ||
            (pbl_type == PBLType::MYNNEDMF) || uses_shoc_family())) {
         amrex::Error("erf.rans_type = kEqn cannot be combined with erf.pbl_type = " +
                      std::string(amrex::getEnumNameString(pbl_type)) +
                      ": both transport the turbulent kinetic energy");
       }
  
       if (pbl_type == PBLType::MYNN25 || pbl_type == PBLType::MYNNEDMF) {
         query_one_or_per_level(pp, "pbl_mynn_A1", pbl_mynn.A1, lev, max_level);
         query_one_or_per_level(pp, "pbl_mynn_A2", pbl_mynn.A2, lev, max_level);
         query_one_or_per_level(pp, "pbl_mynn_B1", pbl_mynn.B1, lev, max_level);
         query_one_or_per_level(pp, "pbl_mynn_B2", pbl_mynn.B2, lev, max_level);
         query_one_or_per_level(pp, "pbl_mynn_C1", pbl_mynn.C1, lev, max_level);
         query_one_or_per_level(pp, "pbl_mynn_C2", pbl_mynn.C2, lev, max_level);
         query_one_or_per_level(pp, "pbl_mynn_C3", pbl_mynn.C3, lev, max_level);
         query_one_or_per_level(pp, "pbl_mynn_C4", pbl_mynn.C4, lev, max_level);
         query_one_or_per_level(pp, "pbl_mynn_C5", pbl_mynn.C5, lev, max_level);
         pbl_mynn_level2.init_coeffs(
           pbl_mynn.A1, pbl_mynn.A2, pbl_mynn.B1, pbl_mynn.B2, pbl_mynn.C1,
           pbl_mynn.C2, pbl_mynn.C3, pbl_mynn.C4, pbl_mynn.C5);
         query_one_or_per_level(
           pp, "pbl_mynn_diffuse_moistvars", pbl_mynn.diffuse_moistvars, lev,
           max_level);
         query_one_or_per_level(
           pp, "pbl_mynn_SMmin", pbl_mynn.SMmin, lev, max_level);
         query_one_or_per_level(
           pp, "pbl_mynn_SMmax", pbl_mynn.SMmax, lev, max_level);
         query_one_or_per_level(
           pp, "pbl_mynn_SHmin", pbl_mynn.SHmin, lev, max_level);
         query_one_or_per_level(
           pp, "pbl_mynn_SHmax", pbl_mynn.SHmax, lev, max_level);
         query_one_or_per_level(
           pp, "pbl_mynn_SQfactor", pbl_mynn.SQfac, lev, max_level);
  
         // SQ = SQfac*SM, so its bound is tied to SHmax and SQfac; the default member
         // initializer was evaluated before either could be overridden here.
         pbl_mynn.SQmax = pbl_mynn.SQfac * pbl_mynn.SHmax;
  
       } else if (pbl_type == PBLType::YSU || pbl_type == PBLType::YSUNew) {
         query_one_or_per_level(
           pp, "pbl_ysu_coriolis_freq", pbl_ysu_coriolis_freq, lev, max_level);
         query_one_or_per_level(
           pp, "pbl_ysu_use_consistent_coriolis",
           pbl_ysu_use_consistent_coriolis, lev, max_level);
         query_one_or_per_level(
           pp, "pbl_ysu_force_over_water", pbl_ysu_force_over_water, lev,
           max_level);
         query_one_or_per_level(
           pp, "pbl_ysu_land_Ribcr", pbl_ysu_land_Ribcr, lev, max_level);
         query_one_or_per_level(
           pp, "pbl_ysu_unst_Ribcr", pbl_ysu_unst_Ribcr, lev, max_level);
         query_one_or_per_level(
           pp, "enable_ysu_liquid_theta", enable_ysu_liquid_theta, lev, max_level);
         query_one_or_per_level(
           pp, "enable_ysu_countergradient", enable_ysu_countergradient, lev, max_level);
         query_one_or_per_level(
           pp, "enable_ysu_terrain_pblh_floor", enable_ysu_terrain_pblh_floor, lev, max_level);
         query_one_or_per_level(
           pp, "enable_ysu_sat_limiter", enable_ysu_sat_limiter, lev, max_level);
         query_one_or_per_level(
           pp, "enable_ysu_topdown", enable_ysu_topdown, lev, max_level);
         query_one_or_per_level(
           pp, "enable_ysu_entrainment", enable_ysu_entrainment, lev, max_level);
         query_one_or_per_level(
           pp, "enable_ysu_cloud_pblh", enable_ysu_cloud_pblh, lev, max_level);
         query_one_or_per_level(
           pp, "enable_mrf_unbounded_vpert", enable_mrf_unbounded_vpert, lev, max_level);
         query_one_or_per_level(
           pp, "ysu_qcloud_threshold", ysu_qcloud_threshold, lev, max_level);
         query_one_or_per_level(
           pp, "ysu_moistvars", ysu_moistvars, lev, max_level);
         query_one_or_per_level(
           pp, "pbl_ysunew_highres_bounds", pbl_ysunew_highres_bounds, lev, max_level);
         // Radiative tendency limiter (YSUNew-only)
         query_one_or_per_level(
           pp, "enable_ysu_rad_tend_limiter", enable_ysu_rad_tend_limiter, lev, max_level);
         query_one_or_per_level(
           pp, "ysu_rad_tend_limiter_magnitude", ysu_rad_tend_limiter_magnitude, lev, max_level);
         if (!(ysu_rad_tend_limiter_magnitude > 0.0)) {
             if (amrex::ParallelDescriptor::IOProcessor()) {
                 amrex::Print() << "WARNING: erf.ysu_rad_tend_limiter_magnitude = "
                                << ysu_rad_tend_limiter_magnitude
                                << " is not positive; using the default of 1.0 K/s\n";
             }
             ysu_rad_tend_limiter_magnitude = amrex::Real(1.0);
         }
         // Vogelezang & Holtslag (1996) shear correction
         query_one_or_per_level(
           pp, "enable_vh96_shear_correction", enable_vh96_shear_correction, lev, max_level);
         query_one_or_per_level(
           pp, "vh96_shear_const_b", vh96_shear_const_b, lev, max_level);
         // PBLH spatial smoothing
         query_one_or_per_level(
           pp, "enable_pblh_smoothing", enable_pblh_smoothing, lev, max_level);
         query_one_or_per_level(
           pp, "pblh_smoothing_passes", pblh_smoothing_passes, lev, max_level);
         query_one_or_per_level(
           pp, "pblh_smoothing_weight", pblh_smoothing_weight, lev, max_level);
         // Validate pblh_smoothing_weight is in [0,1]
         if (enable_pblh_smoothing && (pblh_smoothing_weight < 0 || pblh_smoothing_weight > 1)) {
           amrex::Error("pblh_smoothing_weight must be in [0, 1]");
         }
         // QNSE stable stability functions (Sukoriansky et al. 2005)
         query_one_or_per_level(
           pp, "enable_qnse_stable_functions", enable_qnse_stable_functions, lev, max_level);
         query_one_or_per_level(
           pp, "qnse_am", qnse_am, lev, max_level);
         query_one_or_per_level(
           pp, "qnse_bm", qnse_bm, lev, max_level);
         query_one_or_per_level(
           pp, "qnse_ah", qnse_ah, lev, max_level);
         query_one_or_per_level(
           pp, "qnse_bh", qnse_bh, lev, max_level);
       } else if (pbl_type == PBLType::MRF) {
         query_one_or_per_level(
           pp, "pbl_mrf_coriolis_freq", pbl_mrf_coriolis_freq, lev, max_level);
         query_one_or_per_level(
           pp, "pbl_mrf_Ribcr", pbl_mrf_Ribcr, lev, max_level);
         query_one_or_per_level(
           pp, "pbl_mrf_const_b", pbl_mrf_const_b, lev, max_level);
         query_one_or_per_level(pp, "pbl_mrf_sf", pbl_mrf_sf, lev, max_level);
         query_one_or_per_level(
           pp, "enable_mrf_countergradient", enable_mrf_countergradient, lev, max_level);
         query_one_or_per_level(
           pp, "enable_mrf_cloud_adjustment", enable_mrf_cloud_adjustment, lev, max_level);
         query_one_or_per_level(
           pp, "pbl_mrf_highres_bounds", pbl_mrf_highres_bounds, lev, max_level);
         query_one_or_per_level(
           pp, "enable_mrf_unbounded_vpert", enable_mrf_unbounded_vpert, lev, max_level);
         query_one_or_per_level(
           pp, "pbl_mrf_use_zero_ri_extent", pbl_mrf_use_zero_ri_extent, lev, max_level);
         // QNSE stable stability functions (Sukoriansky et al. 2005)
         query_one_or_per_level(
           pp, "enable_qnse_stable_functions", enable_qnse_stable_functions, lev, max_level);
         query_one_or_per_level(
           pp, "qnse_am", qnse_am, lev, max_level);
         query_one_or_per_level(
           pp, "qnse_bm", qnse_bm, lev, max_level);
         query_one_or_per_level(
           pp, "qnse_ah", qnse_ah, lev, max_level);
         query_one_or_per_level(
           pp, "qnse_bh", qnse_bh, lev, max_level);
         // Scale-aware PBL-LES blending parameters.
         query_one_or_per_level(
           pp, "pbl_blend_length", pbl_blend_length, lev, max_level);
         query_one_or_per_level(
           pp, "pbl_blend_cs", pbl_blend_cs, lev, max_level);
         query_one_or_per_level(
           pp, "pbl_blend_c_max", pbl_blend_c_max, lev, max_level);
         query_one_or_per_level(
           pp, "pbl_blend_use_smag", pbl_blend_use_smag, lev, max_level);
         // Vogelezang & Holtslag (1996) shear correction
         query_one_or_per_level(
           pp, "enable_vh96_shear_correction", enable_vh96_shear_correction, lev, max_level);
         query_one_or_per_level(
           pp, "vh96_shear_const_b", vh96_shear_const_b, lev, max_level);
         // PBLH spatial smoothing
         query_one_or_per_level(
           pp, "enable_pblh_smoothing", enable_pblh_smoothing, lev, max_level);
         query_one_or_per_level(
           pp, "pblh_smoothing_passes", pblh_smoothing_passes, lev, max_level);
         query_one_or_per_level(
           pp, "pblh_smoothing_weight", pblh_smoothing_weight, lev, max_level);
         // Validate pblh_smoothing_weight is in [0,1]
         if (enable_pblh_smoothing && (pblh_smoothing_weight < 0 || pblh_smoothing_weight > 1)) {
           amrex::Error("pblh_smoothing_weight must be in [0, 1]");
         }
       } else if (pbl_type == PBLType::SHOC) {
 #ifndef ERF_USE_SHOC
           amrex::Abort("You set use_shoc to true but didn't build with SHOC; you must rebuild the executable");
       }
 #endif
       if (uses_eamxx_shoc()) {
 #ifndef ERF_USE_EAMXX_SHOC
           amrex::Abort("PBLType::EAMXX_SHOC requested, but ERF was not built with ERF_ENABLE_EAMXX_SHOC=ON");
 #endif
       }
  
       if (pbl_requires_surface_layer()) {
           std::string zlo_bc = "none";
           amrex::ParmParse pp_bc("zlo");
           pp_bc.get("type",zlo_bc);
           if (amrex::toLower(zlo_bc) != "surface_layer") {
                amrex::Abort("You must use the surface_layer BC at zlo with the selected PBL.");
           }
       }
     }
  
     // Flags for QKE/TKE equation
     if (pbl_type == PBLType::MYJ || pbl_type == PBLType::MYNN25 || pbl_type == PBLType::MYNNEDMF) {
         // Add sources/sinks to QKE/TKE? (MYJ does this inline)
         if (pbl_type == PBLType::MYNN25 || pbl_type == PBLType::MYNNEDMF) {
             use_pbl_tke = true;
         }
         // Advect QKE/TKE?
         query_one_or_per_level(pp, "advect_tke"    , advect_tke    , lev, max_level);
         // Apply numerical diffusion to QKE/TKE?
         query_one_or_per_level(pp, "diffuse_tke_3D", diffuse_tke_3D, lev, max_level);
     }
  
     // There is a default value of 1e-6 but the user can override the value here,
     //   and in addition can add perturbational values.  and in addition can add perturbational values.
     pp.queryAdd("tke_min",tke_min);
  
     // LES constants...
     query_one_or_per_level(pp, "Cs", Cs, lev, max_level);
  
     query_one_or_per_level(pp, "Pr_t", Pr_t, lev, max_level);
     query_one_or_per_level(pp, "Sc_t", Sc_t, lev, max_level);
  
     // Compute relevant forms of diffusion parameters
     Pr_t_inv = one / Pr_t;
     Sc_t_inv = one / Sc_t;
  
     if (les_type == LESType::Deardorff) {
         query_one_or_per_level(pp, "Ck", Ck, lev, max_level);
         query_one_or_per_level(pp, "Ce", Ce, lev, max_level);
         query_one_or_per_level(pp, "Ce_wall", Ce_wall, lev, max_level);
     }
  
     // To quantify atmospheric stability for subgrid modeling
     query_one_or_per_level(pp, "thermal_stratification", strat_type, lev, max_level);
     if (strat_type == StratType::theta) {
         amrex::Print() << "Thermal stratification based on gradient of potential temperature" << std::endl;
     } else if (strat_type == StratType::thetav) {
         amrex::Print() << "Thermal stratification based on gradient of virtual potential temperature" << std::endl;
     } else if (strat_type == StratType::thetal) {
         amrex::Print() << "Thermal stratification based on gradient of linearized liquid-water potential temperature" << std::endl;
     }
  
     // k-eqn constants
     query_one_or_per_level(pp, "Cmu0", Cmu0, lev, max_level);
     query_one_or_per_level(pp, "Cb", Cb, lev, max_level);
     query_one_or_per_level(pp, "Rt_crit", Rt_crit, lev, max_level);
     query_one_or_per_level(pp, "Rt_min", Rt_min, lev, max_level);
     query_one_or_per_level(pp, "max_geom_lscale", l_g_max, lev, max_level);
     query_one_or_per_level(pp, "dirichlet_k", dirichlet_k, lev, max_level);
     query_one_or_per_level(pp, "tke_floor", tke_floor, lev, max_level);
     query_one_or_per_level(pp, "implicit_tke_dissipation", implicit_tke_dissipation, lev, max_level);
     query_one_or_per_level(pp, "rans_consistent_diffusivities", rans_consistent_diffusivities, lev, max_level);
     query_one_or_per_level(pp, "rans_lscale_from_pblh", rans_lscale_from_pblh, lev, max_level);
     query_one_or_per_level(pp, "rans_lscale_min", rans_lscale_min, lev, max_level);
     if (rans_lscale_from_pblh && !(rans_lscale_min > 0)) {
         amrex::Error("erf.rans_lscale_min must be > 0 with erf.rans_lscale_from_pblh");
     }
  
     if (rans_type == RANSType::kEqn) {
         // The stability functions (AL01 Eqs. 31, 32) have poles near Rt = -3.6;
         // the Burchard & Petersen smoothing maps Rt < Rt_crit onto
         // (Rt_min, Rt_crit) and needs Rt_min < Rt_crit <= 0.
         if (!(Cmu0 > 0)) { amrex::Error("erf.Cmu0 must be > 0 for the k-eqn RANS"); }
         if (!(Cb > 0)) { amrex::Error("erf.Cb must be > 0 for the k-eqn RANS"); }
         if (!(l_g_max > 0)) { amrex::Error("erf.max_geom_lscale must be > 0 for the k-eqn RANS"); }
         if (!(Rt_crit <= 0)) { amrex::Error("erf.Rt_crit must be <= 0 for the k-eqn RANS"); }
         if (!(Rt_min < Rt_crit)) { amrex::Error("erf.Rt_min must be < erf.Rt_crit for the k-eqn RANS"); }
         if (!(Rt_min > amrex::Real(-3.6))) {
             amrex::Error("erf.Rt_min must be > -3.6 for the k-eqn RANS (stability functions have poles near -3.61)");
         }
     }
     if (tke_floor < 0) { amrex::Error("erf.tke_floor must be >= 0"); }
  
     // Common inputs (LES or RANS)
     if (!query_one_or_per_level(pp, "sigma_k", sigma_k, lev, max_level) && rans_type == RANSType::kEqn) {
         amrex::Print() << "Overriding default sigma_k for k-eqn RANS" << std::endl;
         sigma_k = one;
     };
     query_one_or_per_level(pp, "theta_ref", theta_ref, lev, max_level);
  
     query_one_or_per_level(pp, "mix_isotropic", mix_isotropic, lev, max_level);
     query_one_or_per_level(pp, "use_Ri_correction", use_Ri_correction, lev, max_level);
     query_one_or_per_level(pp, "Ri_crit", Ri_crit, lev, max_level);
  
     // Set common flags
     use_kturb =
       ((les_type != LESType::None) || (rans_type != RANSType::None) ||
        (pbl_type != PBLType::None));
     use_keqn =
       ((les_type == LESType::Deardorff) || (rans_type == RANSType::kEqn));
     use_tke =
       ((les_type == LESType::Deardorff) || (rans_type == RANSType::kEqn) ||
        (pbl_type == PBLType::MYJ)       || (pbl_type == PBLType::MYNN25) ||
        (pbl_type == PBLType::MYNNEDMF)  || uses_shoc_family());
  
     if (use_tke) {
         query_one_or_per_level(pp, "init_tke_from_ustar", init_tke_from_ustar, lev, max_level);
     }
  
     // Validate inputs
     if (les_type == LESType::Smagorinsky) {
       if (Cs == 0) {
         amrex::Error("Need to specify Cs for Smagorsinky LES");
       }
       if (smag2d && mix_isotropic) {
         amrex::Print() << "Turning off mix_isotropic for 2-D Smagorinsky" << std::endl;
         mix_isotropic = false;
       }
     }
   }

Here is the call graph for this function:

◆ pbl_requires_surface_layer()

bool TurbChoice::pbl_requires_surface_layer ( ) const

inlinenoexcept

Query whether the selected PBL scheme requires surface-layer boundary conditions.

Returns: True if the PBL scheme requires a lower surface-layer boundary.

   {
       return (pbl_type == PBLType::MYNN25)   ||
              (pbl_type == PBLType::MYNNEDMF) ||
              (pbl_type == PBLType::YSU)      ||
              (pbl_type == PBLType::YSUNew)      ||
              (pbl_type == PBLType::MRF)       ||
              uses_shoc_family();
   }

Referenced by check_params(), and init_params().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ pbl_suppresses_microphysics_condensation()

bool TurbChoice::pbl_suppresses_microphysics_condensation ( ) const

inlinenoexcept

Query whether the selected PBL scheme suppresses microphysics condensation.

Returns: True when the PBL scheme owns condensation handling.

   {
       return uses_shoc_family();
   }

Here is the call graph for this function:

◆ uses_eamxx_shoc()

bool TurbChoice::uses_eamxx_shoc ( ) const

inlinenoexcept

Query whether this level uses the EAMxx SHOC PBL scheme.

Returns: True if PBLType::EAMXX_SHOC is selected.

   {
       return pbl_type == PBLType::EAMXX_SHOC;
   }

Referenced by erf_slow_rhs_post(), erf_slow_rhs_pre(), init_params(), and uses_shoc_family().

Here is the caller graph for this function:

◆ uses_native_shoc()

bool TurbChoice::uses_native_shoc ( ) const

inlinenoexcept

Query whether this level uses the native SHOC PBL scheme.

Returns: True if PBLType::NATIVE_SHOC is selected.

   {
       return pbl_type == PBLType::NATIVE_SHOC;
   }

Referenced by erf_slow_rhs_post(), erf_slow_rhs_pre(), and uses_shoc_family().

Here is the caller graph for this function:

◆ uses_shoc_family()

bool TurbChoice::uses_shoc_family ( ) const

inlinenoexcept

Query whether this level uses any SHOC-family PBL scheme.

Returns: True if native or EAMxx SHOC is selected.

   {
       return uses_eamxx_shoc() || uses_native_shoc();
   }

Referenced by ComputeTurbulentViscosity(), init_params(), pbl_requires_surface_layer(), and pbl_suppresses_microphysics_condensation().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ advect_tke

TurbChoice::advect_tke = true

Whether TKE/QKE is advected.

Referenced by erf_slow_rhs_post(), and init_params().

◆ Cb

TurbChoice::Cb = amrex::Real(0.35)

One-equation RANS buoyancy coefficient.

Referenced by ComputeTurbulentViscosityRANS(), display(), and init_params().

◆ Ce

TurbChoice::Ce = amrex::Real(0.93)

Deardorff dissipation coefficient.

Referenced by ComputeTurbulentViscosityLES(), display(), and init_params().

◆ Ce_wall

TurbChoice::Ce_wall = zero

Wall value for the Deardorff dissipation coefficient.

Referenced by check_params(), ComputeTurbulentViscosityLES(), display(), and init_params().

◆ Ck

TurbChoice::Ck = amrex::Real(0.1)

Deardorff eddy-viscosity coefficient.

Referenced by ComputeTurbulentViscosityLES(), display(), and init_params().

◆ Cmu0

TurbChoice::Cmu0 = amrex::Real(0.5562)

One-equation RANS Cmu0 coefficient.

Referenced by ComputeTurbulentViscosityRANS(), display(), and init_params().

◆ Cs

TurbChoice::Cs = zero

Smagorinsky model coefficient.

Referenced by ComputeTurbulentViscosityLES(), ComputeTurbulentViscosityLES_EB(), display(), and init_params().

◆ diffuse_tke_3D

TurbChoice::diffuse_tke_3D = true

Whether three-dimensional numerical diffusion is applied to TKE/QKE.

Referenced by init_params(), and make_sources().

◆ dirichlet_k

TurbChoice::dirichlet_k = false

Whether TKE uses Dirichlet boundary treatment.

Referenced by display(), erf_slow_rhs_post(), and init_params().

◆ enable_mrf_cloud_adjustment

TurbChoice::enable_mrf_cloud_adjustment = false

Whether MRF cloud-aware stability adjustments are enabled.

Referenced by ComputeDiffusivityMRF(), display(), and init_params().

◆ enable_mrf_countergradient

TurbChoice::enable_mrf_countergradient = false

Whether MRF countergradient corrections are enabled.

Referenced by ComputeDiffusivityMRF(), display(), and init_params().

◆ enable_mrf_unbounded_vpert

TurbChoice::enable_mrf_unbounded_vpert = false

Whether MRF leaves VPERT unlimited by GAMCRT.

Referenced by ComputeDiffusivityMRF(), ComputeDiffusivityYSUNew(), display(), and init_params().

◆ enable_pblh_smoothing

TurbChoice::enable_pblh_smoothing = false

Whether spatial smoothing of diagnosed PBLH is enabled.

Referenced by ComputeDiffusivityMRF(), ComputeDiffusivityYSUNew(), display(), and init_params().

◆ enable_qnse_stable_functions

bool TurbChoice::enable_qnse_stable_functions = false

Referenced by ComputeDiffusivityMRF(), ComputeDiffusivityYSUNew(), display(), and init_params().

◆ enable_vh96_shear_correction

TurbChoice::enable_vh96_shear_correction = false

Whether Vogelezang & Holtslag (1996) shear-correction term is enabled.

Referenced by ComputeDiffusivityMRF(), ComputeDiffusivityYSUNew(), display(), and init_params().

◆ enable_ysu_cloud_pblh

TurbChoice::enable_ysu_cloud_pblh

Initial value:

=

true

Whether YSU cloud-based PBL-height detection is enabled.

Referenced by ComputeDiffusivityYSUNew(), display(), and init_params().

◆ enable_ysu_countergradient

TurbChoice::enable_ysu_countergradient

Initial value:

=

true

Whether YSU countergradient corrections are enabled.

Referenced by ComputeDiffusivityYSUNew(), display(), and init_params().

◆ enable_ysu_entrainment

TurbChoice::enable_ysu_entrainment

Initial value:

=

true

Whether YSU entrainment-layer parameterization is enabled.

Referenced by ComputeDiffusivityYSUNew(), display(), and init_params().

◆ enable_ysu_liquid_theta

TurbChoice::enable_ysu_liquid_theta

Initial value:

=

true

Whether YSU uses liquid-water virtual potential temperature for stability.

Referenced by ComputeDiffusivityYSUNew(), display(), and init_params().

◆ enable_ysu_rad_tend_limiter

bool TurbChoice::enable_ysu_rad_tend_limiter = false

Referenced by ComputeDiffusivityYSUNew(), display(), and init_params().

◆ enable_ysu_sat_limiter

TurbChoice::enable_ysu_sat_limiter

Initial value:

=

false

Whether YSU applies a saturation limiter to moisture countergradient terms.

Referenced by ComputeDiffusivityYSUNew(), display(), and init_params().

◆ enable_ysu_terrain_pblh_floor

TurbChoice::enable_ysu_terrain_pblh_floor

Initial value:

=

true

Whether YSU applies a terrain-following PBL-height floor.

Referenced by ComputeDiffusivityYSUNew(), display(), and init_params().

◆ enable_ysu_topdown

TurbChoice::enable_ysu_topdown

Initial value:

=

true

Whether YSU top-down mixing is enabled.

Referenced by ComputeDiffusivityYSUNew(), display(), and init_params().

◆ implicit_tke_dissipation

bool TurbChoice::implicit_tke_dissipation = false

Referenced by display(), erf_slow_rhs_post(), and init_params().

◆ init_tke_from_ustar

TurbChoice::init_tke_from_ustar = false

Whether initial TKE/QKE profiles are based on surface friction velocity.

Referenced by init_params().

◆ l_g_max

TurbChoice::l_g_max = amrex::Real(30.0)

Maximum geometric length scale.

Referenced by ComputeTurbulentViscosityRANS(), display(), and init_params().

◆ les_type

TurbChoice::les_type = LESType::None

Selected LES closure.

Referenced by check_params(), ComputeTurbulentViscosity(), ComputeTurbulentViscosityLES(), ComputeTurbulentViscosityLES_EB(), display(), erf_make_tau_terms(), erf_slow_rhs_post(), erf_slow_rhs_pre(), and init_params().

◆ mix_isotropic

TurbChoice::mix_isotropic = true

Whether subgrid mixing uses isotropic length scales.

Referenced by ComputeTurbulentViscosityLES(), ComputeTurbulentViscosityLES_EB(), display(), and init_params().

◆ pbl_blend_c_max

amrex::Real TurbChoice::pbl_blend_c_max = amrex::Real(0.1)

Power-law ceiling coeff [m^(2/3)/s].

Referenced by ComputeDiffusivityMRF(), display(), and init_params().

◆ pbl_blend_cs

amrex::Real TurbChoice::pbl_blend_cs = amrex::Real(0.17)

Smagorinsky coeff for K_h ceiling.

Referenced by ComputeDiffusivityMRF(), display(), and init_params().

◆ pbl_blend_length

amrex::Real TurbChoice::pbl_blend_length = amrex::Real(0.0)

Boutle blending length L [m]. 0 = off.

Referenced by ComputeDiffusivityMRF(), display(), and init_params().

◆ pbl_blend_use_smag

bool TurbChoice::pbl_blend_use_smag = true

Use Smagorinsky ceiling (else power-law).

Referenced by display(), and init_params().

◆ pbl_ib_aware

TurbChoice::pbl_ib_aware = false

When true, the MRF and YSUNew schemes treat the first fluid cell above the immersed solid of a column (buildings or terrain by immersed forcing) as that column's surface: the bulk Richardson heights, the boundary-layer depth and the K profile are measured from it, the diffusivities vanish inside the solid, and the surface scales of such a column are a neutral log law at its top (u* from the wind there and pbl_ib_z0, theta* = 0). The boundary-layer height both schemes store (pblh, Lturb) stays the absolute height above the domain bottom; with enable_pblh_smoothing the stencil runs on that absolute height, and the smoothed value is kept at or above each column's own floor (half a cell above its surface, at least 10 m). Off by default; without immersed cells the results are identical. Not supported with terrain-fitted coordinates.

Referenced by ComputeDiffusivityMRF(), ComputeDiffusivityYSUNew(), and init_params().

◆ pbl_ib_z0

TurbChoice::pbl_ib_z0 = amrex::Real(0.01)

Roughness length [m] of that log law.

Referenced by ComputeDiffusivityMRF(), ComputeDiffusivityYSUNew(), and init_params().

◆ pbl_mrf_const_b

TurbChoice::pbl_mrf_const_b = amrex::Real(7.8)

MRF constant used to compute PBL height.

Referenced by ComputeDiffusivityMRF(), ComputeDiffusivityYSUNew(), display(), and init_params().

◆ pbl_mrf_coriolis_freq

TurbChoice::pbl_mrf_coriolis_freq = amrex::Real(1.0e-4)

Coriolis frequency used by the MRF PBL scheme.

Referenced by display(), and init_params().

◆ pbl_mrf_highres_bounds

TurbChoice::pbl_mrf_highres_bounds = false

Whether MRF applies high-resolution grid-dependent diffusivity bounds.

Referenced by ComputeDiffusivityMRF(), display(), and init_params().

◆ pbl_mrf_Ribcr

TurbChoice::pbl_mrf_Ribcr = amrex::Real(0.5)

Critical bulk Richardson number for the MRF PBL scheme.

Referenced by ComputeDiffusivityMRF(), display(), and init_params().

◆ pbl_mrf_sf

TurbChoice::pbl_mrf_sf = amrex::Real(0.1)

MRF surface flux value used to compute PBL height.

Referenced by ComputeDiffusivityMRF(), ComputeDiffusivityYSUNew(), display(), and init_params().

◆ pbl_mrf_use_zero_ri_extent

TurbChoice::pbl_mrf_use_zero_ri_extent = false

Whether MRF uses the Ri=0 K-profile extent.

Referenced by ComputeDiffusivityMRF(), ComputeDiffusivityYSUNew(), display(), and init_params().

◆ pbl_mynn

TurbChoice::pbl_mynn

MYNN level-2.5 closure coefficients.

Referenced by ComputeDiffusivityMYNN25(), ComputeDiffusivityMYNNEDMF(), display(), and init_params().

◆ pbl_mynn_level2

TurbChoice::pbl_mynn_level2

MYNN level-2 closure coefficients for limiting.

Referenced by ComputeDiffusivityMYNN25(), ComputeDiffusivityMYNNEDMF(), and init_params().

◆ pbl_type

TurbChoice::pbl_type = PBLType::None

Selected PBL closure.

Referenced by ComputeTurbulentViscosity(), display(), erf_make_tau_terms(), erf_slow_rhs_post(), erf_slow_rhs_pre(), init_params(), pbl_requires_surface_layer(), uses_eamxx_shoc(), and uses_native_shoc().

◆ pbl_ysu_coriolis_freq

TurbChoice::pbl_ysu_coriolis_freq

Initial value:

=

amrex::Real(1.0e-4)

Coriolis frequency used by YSU-family PBL schemes.

Referenced by ComputeDiffusivityYSU(), ComputeDiffusivityYSUNew(), display(), and init_params().

◆ pbl_ysu_force_over_water

TurbChoice::pbl_ysu_force_over_water

Initial value:

=

false

Whether YSU is forced to use over-water behavior.

Referenced by ComputeDiffusivityYSU(), display(), and init_params().

◆ pbl_ysu_land_Ribcr

TurbChoice::pbl_ysu_land_Ribcr

Initial value:

=

fourth

constexpr amrex::Real fourth

Definition: ERF_NumericalConstants.H:35

Critical bulk Richardson number over land for stable YSU conditions.

Referenced by ComputeDiffusivityYSU(), ComputeDiffusivityYSUNew(), display(), and init_params().

◆ pbl_ysu_unst_Ribcr

TurbChoice::pbl_ysu_unst_Ribcr

Initial value:

=

zero

constexpr amrex::Real zero

Definition: ERF_NumericalConstants.H:29

Critical bulk Richardson number for unstable YSU conditions.

Referenced by ComputeDiffusivityYSU(), display(), and init_params().

◆ pbl_ysu_use_consistent_coriolis

TurbChoice::pbl_ysu_use_consistent_coriolis

Initial value:

=

false

Whether YSU uses the ERF Coriolis frequency.

Referenced by display(), and init_params().

◆ pbl_ysunew_highres_bounds

TurbChoice::pbl_ysunew_highres_bounds = false

Whether YSUNew applies high-resolution grid-dependent diffusivity bounds.

Referenced by ComputeDiffusivityYSUNew(), display(), and init_params().

◆ pblh_smoothing_passes

TurbChoice::pblh_smoothing_passes = 1

Number of PBLH smoothing iterations to apply.

Referenced by ComputeDiffusivityMRF(), ComputeDiffusivityYSUNew(), display(), and init_params().

◆ pblh_smoothing_weight

TurbChoice::pblh_smoothing_weight = amrex::Real(0.5)

Center-cell weight in PBLH smoothing stencil (must be in [0,1]).

Referenced by ComputeDiffusivityMRF(), ComputeDiffusivityYSUNew(), display(), and init_params().

◆ Pr_t

TurbChoice::Pr_t = one / three

Turbulent Prandtl number.

Referenced by display(), and init_params().

◆ Pr_t_inv

TurbChoice::Pr_t_inv = three

Inverse turbulent Prandtl number.

Referenced by ComputeTurbulentViscosityLES(), ComputeTurbulentViscosityLES_EB(), ComputeTurbulentViscosityRANS(), and init_params().

◆ qnse_ah

amrex::Real TurbChoice::qnse_ah = amrex::Real(2.5)

Referenced by ComputeDiffusivityMRF(), display(), and init_params().

◆ qnse_am

amrex::Real TurbChoice::qnse_am = amrex::Real(2.5)

Referenced by ComputeDiffusivityMRF(), ComputeDiffusivityYSUNew(), display(), and init_params().

◆ qnse_bh

amrex::Real TurbChoice::qnse_bh = amrex::Real(0.2)

Referenced by ComputeDiffusivityMRF(), display(), and init_params().

◆ qnse_bm

amrex::Real TurbChoice::qnse_bm = amrex::Real(0.2)

Referenced by ComputeDiffusivityMRF(), ComputeDiffusivityYSUNew(), display(), and init_params().

◆ rans_consistent_diffusivities

bool TurbChoice::rans_consistent_diffusivities = false

Referenced by ComputeTurbulentViscosityRANS(), display(), and init_params().

◆ rans_lscale_from_pblh

bool TurbChoice::rans_lscale_from_pblh = false

Referenced by ComputeTurbulentViscosityRANS(), display(), and init_params().

◆ rans_lscale_min

amrex::Real TurbChoice::rans_lscale_min = one

Referenced by ComputeTurbulentViscosityRANS(), display(), and init_params().

◆ rans_type

TurbChoice::rans_type = RANSType::None

Selected RANS closure.

Referenced by ComputeTurbulentViscosity(), ComputeTurbulentViscosityRANS(), display(), erf_make_tau_terms(), erf_slow_rhs_post(), erf_slow_rhs_pre(), and init_params().

◆ Ri_crit

TurbChoice::Ri_crit = fourth

Critical Richardson number for stability correction.

Referenced by ComputeTurbulentViscosityLES(), ComputeTurbulentViscosityLES_EB(), display(), and init_params().

◆ Rt_crit

TurbChoice::Rt_crit = -one

Critical turbulent Reynolds number.

Referenced by ComputeTurbulentViscosityRANS(), display(), and init_params().

◆ Rt_min

TurbChoice::Rt_min = -three

Minimum turbulent Reynolds number.

Referenced by ComputeTurbulentViscosityRANS(), display(), and init_params().

◆ Sc_t

TurbChoice::Sc_t = one

Turbulent Schmidt number.

Referenced by display(), and init_params().

◆ Sc_t_inv

TurbChoice::Sc_t_inv = one

Inverse turbulent Schmidt number.

Referenced by ComputeTurbulentViscosityLES(), ComputeTurbulentViscosityLES_EB(), ComputeTurbulentViscosityRANS(), and init_params().

◆ sigma_k

TurbChoice::sigma_k = amrex::Real(0.5)

TKE diffusivity coefficient denominator.

Referenced by ComputeTurbulentViscosityLES(), ComputeTurbulentViscosityLES_EB(), ComputeTurbulentViscosityRANS(), display(), and init_params().

◆ smag2d

TurbChoice::smag2d = false

Whether the 2-D Smagorinsky formulation is used.

Referenced by ComputeTurbulentViscosityLES(), display(), and init_params().

◆ strat_type

TurbChoice::strat_type = StratType::theta

Thermodynamic variable used for stability stratification.

Referenced by ComputeTurbulentViscosityLES(), and init_params().

◆ theta_ref

TurbChoice::theta_ref = zero

Reference potential temperature for stable stratification.

Referenced by ComputeTurbulentViscosityLES(), ComputeTurbulentViscosityRANS(), display(), and init_params().

◆ tke_floor

amrex::Real TurbChoice::tke_floor = zero

Referenced by ComputeTurbulentViscosityRANS(), display(), erf_slow_rhs_post(), and init_params().

◆ tke_min

TurbChoice::tke_min = amrex::Real(1.e-6)

Minimum TKE/QKE value.

Referenced by init_params().

◆ use_keqn

TurbChoice::use_keqn

Initial value:

=

false

Whether a microscale TKE closure is active.

Referenced by erf_slow_rhs_post(), erf_slow_rhs_pre(), and init_params().

◆ use_kturb

TurbChoice::use_kturb = false

Whether any turbulence model is active.

Referenced by ERF::advance_dycore(), erf_make_tau_terms(), erf_slow_rhs_post(), erf_slow_rhs_pre(), ImplicitDiffForMomLU_N(), ImplicitDiffForMomLU_S(), ImplicitDiffForMomLU_T(), and init_params().

◆ use_pbl_tke

TurbChoice::use_pbl_tke

Initial value:

=

false

Whether a mesoscale PBL TKE closure is active.

Referenced by init_params().

◆ use_Ri_correction

TurbChoice::use_Ri_correction = true

Whether Richardson-number correction is applied.

Referenced by ComputeTurbulentViscosityLES(), ComputeTurbulentViscosityLES_EB(), display(), and init_params().

◆ use_tke

TurbChoice::use_tke = false

Whether any TKE or QKE closure is active.

Referenced by erf_slow_rhs_post(), init_params(), and make_sources().

◆ vh96_shear_const_b

TurbChoice::vh96_shear_const_b = amrex::Real(100.0)

Vogelezang & Holtslag (1996) shear-correction constant b.

Referenced by ComputeDiffusivityMRF(), ComputeDiffusivityYSUNew(), display(), and init_params().

◆ ysu_moistvars

TurbChoice::ysu_moistvars = false

Whether YSU applies turbulence to moisture variables.

Referenced by ComputeDiffusivityYSUNew(), display(), and init_params().

◆ ysu_qcloud_threshold

TurbChoice::ysu_qcloud_threshold

Initial value:

=

amrex::Real(1.0e-4)

Cloud liquid water threshold for YSUNew [kg/kg].

Referenced by ComputeDiffusivityYSUNew(), display(), and init_params().

◆ ysu_rad_tend_limiter_magnitude

amrex::Real TurbChoice::ysu_rad_tend_limiter_magnitude = amrex::Real(1.0)

Referenced by ComputeDiffusivityYSUNew(), display(), and init_params().

The documentation for this struct was generated from the following file:

Source/DataStructs/ERF_TurbStruct.H

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ check_params()

◆ display()

◆ init_params()

◆ pbl_requires_surface_layer()

◆ pbl_suppresses_microphysics_condensation()

◆ uses_eamxx_shoc()

◆ uses_native_shoc()

◆ uses_shoc_family()

Member Data Documentation

◆ advect_tke

◆ Cb

◆ Ce

◆ Ce_wall

◆ Ck

◆ Cmu0

◆ Cs

◆ diffuse_tke_3D

◆ dirichlet_k

◆ enable_mrf_cloud_adjustment

◆ enable_mrf_countergradient

◆ enable_mrf_unbounded_vpert

◆ enable_pblh_smoothing

◆ enable_qnse_stable_functions

◆ enable_vh96_shear_correction

◆ enable_ysu_cloud_pblh

◆ enable_ysu_countergradient

◆ enable_ysu_entrainment

◆ enable_ysu_liquid_theta

◆ enable_ysu_rad_tend_limiter

◆ enable_ysu_sat_limiter

◆ enable_ysu_terrain_pblh_floor

◆ enable_ysu_topdown

◆ implicit_tke_dissipation

◆ init_tke_from_ustar

◆ l_g_max

◆ les_type

◆ mix_isotropic

◆ pbl_blend_c_max

◆ pbl_blend_cs

◆ pbl_blend_length

◆ pbl_blend_use_smag

◆ pbl_ib_aware

◆ pbl_ib_z0

◆ pbl_mrf_const_b

◆ pbl_mrf_coriolis_freq

◆ pbl_mrf_highres_bounds

◆ pbl_mrf_Ribcr

◆ pbl_mrf_sf

◆ pbl_mrf_use_zero_ri_extent

◆ pbl_mynn

◆ pbl_mynn_level2

◆ pbl_type

◆ pbl_ysu_coriolis_freq

◆ pbl_ysu_force_over_water

◆ pbl_ysu_land_Ribcr

◆ pbl_ysu_unst_Ribcr

◆ pbl_ysu_use_consistent_coriolis

◆ pbl_ysunew_highres_bounds

◆ pblh_smoothing_passes

◆ pblh_smoothing_weight

◆ Pr_t

◆ Pr_t_inv

◆ qnse_ah

◆ qnse_am

◆ qnse_bh

◆ qnse_bm

◆ rans_consistent_diffusivities

◆ rans_lscale_from_pblh

◆ rans_lscale_min

◆ rans_type

◆ Ri_crit

◆ Rt_crit

◆ Rt_min

◆ Sc_t

◆ Sc_t_inv

◆ sigma_k