MOM6
mom_energetic_pbl::energetic_pbl_cs Type Reference

Detailed Description

This control structure holds parameters for the MOM_energetic_PBL module.

Definition at line 35 of file MOM_energetic_PBL.F90.

Collaboration diagram for mom_energetic_pbl::energetic_pbl_cs:
[legend]

Public variables and constants

real vonkar = 0.41
 The von Karman coefficient. This should be runtime, but because it is runtime in KPP and set to 0.4 it might change answers.
 
real omega
 The Earth's rotation rate [T-1].
 
real omega_frac
 When setting the decay scale for turbulence, use this fraction of the absolute rotation rate blended with the local value of f, as sqrt((1-of)*f^2 + of*4*omega^2) [nondim].
 
real nstar
 The fraction of the TKE input to the mixed layer available to drive entrainment [nondim]. This quantity is the vertically integrated buoyancy production minus the vertically integrated dissipation of TKE produced by buoyancy.
 
logical use_mld_iteration =.false.
 False to use old ePBL method.
 
logical mld_iteration_guess =.false.
 False to default to guessing half the ocean depth for the iteration.
 
integer max_mld_its
 The maximum number of iterations that can be used to find a self-consistent mixed layer depth with Use_MLD_iteration.
 
real mixlenexponent
 Exponent in the mixing length shape-function. 1 is law-of-the-wall at top and bottom, 2 is more KPP like.
 
real mke_to_tke_effic
 The efficiency with which mean kinetic energy released by mechanically forced entrainment of the mixed layer is converted to TKE [nondim].
 
real ustar_min
 A minimum value of ustar to avoid numerical problems [Z T-1 ~> m s-1]. If the value is small enough, this should not affect the solution.
 
real ekman_scale_coef
 A nondimensional scaling factor controlling the inhibition of the diffusive length scale by rotation. Making this larger decreases the diffusivity in the planetary boundary layer.
 
real translay_scale
 A scale for the mixing length in the transition layer at the edge of the boundary layer as a fraction of the boundary layer thickness. The default is 0, but a value of 0.1 might be better justified by observations.
 
real mld_tol
 A tolerance for determining the boundary layer thickness when Use_MLD_iteration is true [Z ~> m].
 
real min_mix_len
 The minimum mixing length scale that will be used by ePBL [Z ~> m]. The default (0) does not set a minimum.
 
integer wt_scheme
 An enumerated value indicating the method for finding the turbulent velocity scale. There are currently two options: wT_mwT_from_cRoot_TKE is the original (TKE_remaining)^1/3 wT_from_RH18 is the version described by Reichl and Hallberg, 2018.
 
real wstar_ustar_coef
 A ratio relating the efficiency with which convectively released energy is converted to a turbulent velocity, relative to mechanically forced turbulent kinetic energy [nondim]. Making this larger increases the diffusivity.
 
real vstar_surf_fac
 If (wT_scheme == wT_from_RH18) this is the proportionality coefficient between ustar and the surface mechanical contribution to vstar [nondim].
 
real vstar_scale_fac
 An overall nondimensional scaling factor for vstar times a unit conversion factor [Z s T-1 m-1 ~> nondim]. Making this larger increases the diffusivity.
 
integer mstar_scheme
 An encoded integer to determine which formula is used to set mstar.
 
logical mstar_flatcap =.true.
 Set false to use asymptotic mstar cap.
 
real mstar_cap
 Since MSTAR is restoring undissipated energy to mixing, there must be a cap on how large it can be. This is definitely a function of latitude (Ekman limit), but will be taken as constant for now.
 
real tke_decay
 The ratio of the natural Ekman depth to the TKE decay scale [nondim].
 
real fixed_mstar
 Mstar is the ratio of the friction velocity cubed to the TKE available to drive entrainment, nondimensional. This quantity is the vertically integrated shear production minus the vertically integrated dissipation of TKE produced by shear. This value is used if the option for using a fixed mstar is used.
 
real c_ek = 0.17
 MSTAR Coefficient in rotation limit for mstar_scheme=OM4.
 
real mstar_coef = 0.3
 MSTAR coefficient in rotation/stabilizing balance for mstar_scheme=OM4.
 
real rh18_mstar_cn1
 MSTAR_N coefficient 1 (outter-most coefficient for fit). Value of 0.275 in RH18. Increasing this coefficient increases mechanical mixing for all values of Hf/ust, but is most effective at low values (weakly developed OSBLs).
 
real rh18_mstar_cn2
 MSTAR_N coefficient 2 (coefficient outside of exponential decay). Value of 8.0 in RH18. Increasing this coefficient increases MSTAR for all values of HF/ust, with a consistent affect across a wide range of Hf/ust.
 
real rh18_mstar_cn3
 MSTAR_N coefficient 3 (exponential decay coefficient). Value of -5.0 in RH18. Increasing this increases how quickly the value of MSTAR decreases as Hf/ust increases.
 
real rh18_mstar_cs1
 MSTAR_S coefficient for RH18 in stabilizing limit. Value of 0.2 in RH18.
 
real rh18_mstar_cs2
 MSTAR_S exponent for RH18 in stabilizing limit. Value of 0.4 in RH18.
 
real mstar_convect_coef
 Factor to reduce mstar when statically unstable.
 
logical use_lt = .false.
 Flag for using LT in Energy calculation.
 
integer lt_enhance_form
 Integer for Enhancement functional form (various options)
 
real lt_enhance_coef
 Coefficient in fit for Langmuir Enhancment.
 
real lt_enhance_exp
 Exponent in fit for Langmuir Enhancement.
 
real lac_mldoek
 Coefficient for Langmuir number modification based on the ratio of the mixed layer depth over the Ekman depth.
 
real lac_mldoob_stab
 Coefficient for Langmuir number modification based on the ratio of the mixed layer depth over the Obukov depth with stablizing forcing.
 
real lac_ekoob_stab
 Coefficient for Langmuir number modification based on the ratio of the Ekman depth over the Obukov depth with stablizing forcing.
 
real lac_mldoob_un
 Coefficient for Langmuir number modification based on the ratio of the mixed layer depth over the Obukov depth with destablizing forcing.
 
real lac_ekoob_un
 Coefficient for Langmuir number modification based on the ratio of the Ekman depth over the Obukov depth with destablizing forcing.
 
real max_enhance_m = 5.
 The maximum allowed LT enhancement to the mixing.
 
type(time_type), pointer time =>NULL()
 A pointer to the ocean model's clock.
 
logical tke_diagnostics = .false.
 If true, diagnostics of the TKE budget are being calculated.
 
logical answers_2018
 If true, use the order of arithmetic and expressions that recover the answers from the end of 2018. Otherwise, use updated and more robust forms of the same expressions.
 
logical orig_pe_calc
 If true, the ePBL code uses the original form of the potential energy change code. Otherwise, it uses a newer version that can work with successive increments to the diffusivity in upward or downward passes.
 
type(diag_ctrl), pointer diag =>NULL()
 A structure that is used to regulate the timing of diagnostic output.
 
real, dimension(:,:), allocatable ml_depth
 The mixed layer depth determined by active mixing in ePBL [Z ~> m].
 
real, dimension(:,:), allocatable diag_tke_wind
 The wind source of TKE [kg m-3 Z3 T-3 ~> W m-2].
 
real, dimension(:,:), allocatable diag_tke_mke
 The resolved KE source of TKE [kg m-3 Z3 T-3 ~> W m-2].
 
real, dimension(:,:), allocatable diag_tke_conv
 The convective source of TKE [kg m-3 Z3 T-3 ~> W m-2].
 
real, dimension(:,:), allocatable diag_tke_forcing
 The TKE sink required to mix surface penetrating shortwave heating.
 
real, dimension(:,:), allocatable diag_tke_mech_decay
 The decay of mechanical TKE [kg m-3 Z3 T-3 ~> W m-2].
 
real, dimension(:,:), allocatable diag_tke_conv_decay
 The decay of convective TKE [kg m-3 Z3 T-3 ~> W m-2].
 
real, dimension(:,:), allocatable diag_tke_mixing
 The work done by TKE to deepen the mixed layer [kg m-3 Z3 T-3 ~> W m-2].
 
real, dimension(:,:), allocatable mstar_mix
 Mstar used in EPBL [nondim].
 
real, dimension(:,:), allocatable mstar_lt
 Mstar due to Langmuir turbulence [nondim].
 
real, dimension(:,:), allocatable la
 Langmuir number [nondim].
 
real, dimension(:,:), allocatable la_mod
 Modified Langmuir number [nondim].
 
real, dimension(:,:,:), allocatable velocity_scale
 The velocity scale used in getting Kd [Z T-1 ~> m s-1].
 
real, dimension(:,:,:), allocatable mixing_length
 The length scale used in getting Kd [Z ~> m].
 
integer id_ml_depth = -1
 Diagnostic IDs.
 
integer id_tke_wind = -1
 Diagnostic IDs.
 
integer id_tke_mixing = -1
 Diagnostic IDs.
 
integer id_tke_mke = -1
 Diagnostic IDs.
 
integer id_tke_conv = -1
 Diagnostic IDs.
 
integer id_tke_forcing = -1
 Diagnostic IDs.
 
integer id_tke_mech_decay = -1
 Diagnostic IDs.
 
integer id_tke_conv_decay = -1
 Diagnostic IDs.
 
integer id_mixing_length = -1
 Diagnostic IDs.
 
integer id_velocity_scale = -1
 Diagnostic IDs.
 
integer id_mstar_mix = -1
 Diagnostic IDs.
 
integer id_la_mod = -1
 Diagnostic IDs.
 
integer id_la = -1
 Diagnostic IDs.
 
integer id_mstar_lt = -1
 Diagnostic IDs.
 

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