mom_energetic_pbl::energetic_pbl_cs integer integer mom_energetic_pbl::energetic_pbl_cs::id_ml_depth id_ml_depth = -1 Diagnostic IDs. integer integer mom_energetic_pbl::energetic_pbl_cs::id_hml_depth id_hml_depth = -1 Diagnostic IDs. integer integer mom_energetic_pbl::energetic_pbl_cs::id_tke_wind id_tke_wind = -1 Diagnostic IDs. integer integer mom_energetic_pbl::energetic_pbl_cs::id_tke_mixing id_tke_mixing = -1 Diagnostic IDs. integer integer mom_energetic_pbl::energetic_pbl_cs::id_tke_mke id_tke_mke = -1 Diagnostic IDs. integer integer mom_energetic_pbl::energetic_pbl_cs::id_tke_conv id_tke_conv = -1 Diagnostic IDs. integer integer mom_energetic_pbl::energetic_pbl_cs::id_tke_forcing id_tke_forcing = -1 Diagnostic IDs. integer integer mom_energetic_pbl::energetic_pbl_cs::id_tke_mech_decay id_tke_mech_decay = -1 Diagnostic IDs. integer integer mom_energetic_pbl::energetic_pbl_cs::id_tke_conv_decay id_tke_conv_decay = -1 Diagnostic IDs. integer integer mom_energetic_pbl::energetic_pbl_cs::id_mixing_length id_mixing_length = -1 Diagnostic IDs. integer integer mom_energetic_pbl::energetic_pbl_cs::id_velocity_scale id_velocity_scale = -1 Diagnostic IDs. integer integer mom_energetic_pbl::energetic_pbl_cs::id_mstar_mix id_mstar_mix = -1 Diagnostic IDs. integer integer mom_energetic_pbl::energetic_pbl_cs::id_la_mod id_la_mod = -1 Diagnostic IDs. integer integer mom_energetic_pbl::energetic_pbl_cs::id_la id_la = -1 Diagnostic IDs. integer integer mom_energetic_pbl::energetic_pbl_cs::id_mstar_lt id_mstar_lt = -1 Diagnostic IDs. real real mom_energetic_pbl::energetic_pbl_cs::vonkar vonkar = 0.41 The von Karman coefficient. This should be a runtime parameter, but because it is set to 0.4 at runtime in KPP it might change answers. real real mom_energetic_pbl::energetic_pbl_cs::omega omega The Earth's rotation rate [T-1 ~> s-1]. real real mom_energetic_pbl::energetic_pbl_cs::omega_frac 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-omega_frac)*f^2 + omega_frac*4*omega^2) [nondim]. real real mom_energetic_pbl::energetic_pbl_cs::nstar 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 logical mom_energetic_pbl::energetic_pbl_cs::use_mld_iteration use_mld_iteration If true, use the proximity to the bottom of the actively turbulent surface boundary layer to constrain the mixing lengths. logical logical mom_energetic_pbl::energetic_pbl_cs::mld_iteration_guess mld_iteration_guess False to default to guessing half the ocean depth for the first iteration. logical logical mom_energetic_pbl::energetic_pbl_cs::mld_bisection mld_bisection If true, use bisection with the iterative determination of the self-consistent mixed layer depth. Otherwise use the false position after a maximum and minimum bound have been evaluated and the returned value from the previous guess or bisection before this. integer integer mom_energetic_pbl::energetic_pbl_cs::max_mld_its 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 real mom_energetic_pbl::energetic_pbl_cs::mixlenexponent mixlenexponent Exponent in the mixing length shape-function. 1 is law-of-the-wall at top and bottom, 2 is more KPP like. real real mom_energetic_pbl::energetic_pbl_cs::mke_to_tke_effic 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 real mom_energetic_pbl::energetic_pbl_cs::ustar_min 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 real mom_energetic_pbl::energetic_pbl_cs::ekman_scale_coef 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 real mom_energetic_pbl::energetic_pbl_cs::translay_scale 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 real mom_energetic_pbl::energetic_pbl_cs::mld_tol mld_tol A tolerance for determining the boundary layer thickness when Use_MLD_iteration is true [Z ~> m]. real real mom_energetic_pbl::energetic_pbl_cs::min_mix_len 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 integer mom_energetic_pbl::energetic_pbl_cs::wt_scheme 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 real mom_energetic_pbl::energetic_pbl_cs::wstar_ustar_coef 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 real mom_energetic_pbl::energetic_pbl_cs::vstar_surf_fac 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 real mom_energetic_pbl::energetic_pbl_cs::vstar_scale_fac 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 integer mom_energetic_pbl::energetic_pbl_cs::mstar_scheme mstar_scheme An encoded integer to determine which formula is used to set mstar. logical logical mom_energetic_pbl::energetic_pbl_cs::mstar_flatcap mstar_flatcap =.true. Set false to use asymptotic mstar cap. real real mom_energetic_pbl::energetic_pbl_cs::mstar_cap 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 real mom_energetic_pbl::energetic_pbl_cs::tke_decay tke_decay The ratio of the natural Ekman depth to the TKE decay scale [nondim]. real real mom_energetic_pbl::energetic_pbl_cs::fixed_mstar 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 real mom_energetic_pbl::energetic_pbl_cs::c_ek c_ek = 0.17 MSTAR Coefficient in rotation limit for mstar_scheme=OM4. real real mom_energetic_pbl::energetic_pbl_cs::mstar_coef mstar_coef = 0.3 MSTAR coefficient in rotation/stabilizing balance for mstar_scheme=OM4. real real mom_energetic_pbl::energetic_pbl_cs::rh18_mstar_cn1 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 real mom_energetic_pbl::energetic_pbl_cs::rh18_mstar_cn2 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 real mom_energetic_pbl::energetic_pbl_cs::rh18_mstar_cn3 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 real mom_energetic_pbl::energetic_pbl_cs::rh18_mstar_cs1 rh18_mstar_cs1 MSTAR_S coefficient for RH18 in stabilizing limit. Value of 0.2 in RH18. real real mom_energetic_pbl::energetic_pbl_cs::rh18_mstar_cs2 rh18_mstar_cs2 MSTAR_S exponent for RH18 in stabilizing limit. Value of 0.4 in RH18. real real mom_energetic_pbl::energetic_pbl_cs::mstar_convect_coef mstar_convect_coef Factor to reduce mstar when statically unstable. logical logical mom_energetic_pbl::energetic_pbl_cs::use_lt use_lt = .false. Flag for using LT in Energy calculation. integer integer mom_energetic_pbl::energetic_pbl_cs::lt_enhance_form lt_enhance_form Integer for Enhancement functional form (various options) real real mom_energetic_pbl::energetic_pbl_cs::lt_enhance_coef lt_enhance_coef Coefficient in fit for Langmuir Enhancment. real real mom_energetic_pbl::energetic_pbl_cs::lt_enhance_exp lt_enhance_exp Exponent in fit for Langmuir Enhancement. real real mom_energetic_pbl::energetic_pbl_cs::lac_mldoek lac_mldoek Coefficient for Langmuir number modification based on the ratio of the mixed layer depth over the Ekman depth. real real mom_energetic_pbl::energetic_pbl_cs::lac_mldoob_stab 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 real mom_energetic_pbl::energetic_pbl_cs::lac_ekoob_stab lac_ekoob_stab Coefficient for Langmuir number modification based on the ratio of the Ekman depth over the Obukov depth with stablizing forcing. real real mom_energetic_pbl::energetic_pbl_cs::lac_mldoob_un 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 real mom_energetic_pbl::energetic_pbl_cs::lac_ekoob_un lac_ekoob_un Coefficient for Langmuir number modification based on the ratio of the Ekman depth over the Obukov depth with destablizing forcing. real real mom_energetic_pbl::energetic_pbl_cs::max_enhance_m max_enhance_m = 5. The maximum allowed LT enhancement to the mixing. type(time_type), pointer type(time_type), pointer mom_energetic_pbl::energetic_pbl_cs::time time =>NULL() A pointer to the ocean model's clock. logical logical mom_energetic_pbl::energetic_pbl_cs::tke_diagnostics tke_diagnostics = .false. If true, diagnostics of the TKE budget are being calculated. logical logical mom_energetic_pbl::energetic_pbl_cs::answers_2018 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 logical mom_energetic_pbl::energetic_pbl_cs::orig_pe_calc 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 type(diag_ctrl), pointer mom_energetic_pbl::energetic_pbl_cs::diag diag =>NULL() A structure that is used to regulate the timing of diagnostic output. real, dimension(:,:), allocatable real, dimension(:,:), allocatable mom_energetic_pbl::energetic_pbl_cs::ml_depth ml_depth The mixed layer depth determined by active mixing in ePBL [Z ~> m]. real, dimension(:,:), allocatable real, dimension(:,:), allocatable mom_energetic_pbl::energetic_pbl_cs::diag_tke_wind diag_tke_wind The wind source of TKE [R Z3 T-3 ~> W m-2]. real, dimension(:,:), allocatable real, dimension(:,:), allocatable mom_energetic_pbl::energetic_pbl_cs::diag_tke_mke diag_tke_mke The resolved KE source of TKE [R Z3 T-3 ~> W m-2]. real, dimension(:,:), allocatable real, dimension(:,:), allocatable mom_energetic_pbl::energetic_pbl_cs::diag_tke_conv diag_tke_conv The convective source of TKE [R Z3 T-3 ~> W m-2]. real, dimension(:,:), allocatable real, dimension(:,:), allocatable mom_energetic_pbl::energetic_pbl_cs::diag_tke_forcing diag_tke_forcing The TKE sink required to mix surface penetrating shortwave heating. real, dimension(:,:), allocatable real, dimension(:,:), allocatable mom_energetic_pbl::energetic_pbl_cs::diag_tke_mech_decay diag_tke_mech_decay The decay of mechanical TKE [R Z3 T-3 ~> W m-2]. real, dimension(:,:), allocatable real, dimension(:,:), allocatable mom_energetic_pbl::energetic_pbl_cs::diag_tke_conv_decay diag_tke_conv_decay The decay of convective TKE [R Z3 T-3 ~> W m-2]. real, dimension(:,:), allocatable real, dimension(:,:), allocatable mom_energetic_pbl::energetic_pbl_cs::diag_tke_mixing diag_tke_mixing The work done by TKE to deepen the mixed layer [R Z3 T-3 ~> W m-2]. real, dimension(:,:), allocatable real, dimension(:,:), allocatable mom_energetic_pbl::energetic_pbl_cs::mstar_mix mstar_mix Mstar used in EPBL [nondim]. real, dimension(:,:), allocatable real, dimension(:,:), allocatable mom_energetic_pbl::energetic_pbl_cs::mstar_lt mstar_lt Mstar due to Langmuir turbulence [nondim]. real, dimension(:,:), allocatable real, dimension(:,:), allocatable mom_energetic_pbl::energetic_pbl_cs::la la Langmuir number [nondim]. real, dimension(:,:), allocatable real, dimension(:,:), allocatable mom_energetic_pbl::energetic_pbl_cs::la_mod la_mod Modified Langmuir number [nondim]. type(efp_type), dimension(2) type(efp_type), dimension(2) mom_energetic_pbl::energetic_pbl_cs::sum_its sum_its The total number of iterations and columns worked on. real, dimension(:,:,:), allocatable real, dimension(:,:,:), allocatable mom_energetic_pbl::energetic_pbl_cs::velocity_scale velocity_scale The velocity scale used in getting Kd [Z T-1 ~> m s-1]. real, dimension(:,:,:), allocatable real, dimension(:,:,:), allocatable mom_energetic_pbl::energetic_pbl_cs::mixing_length mixing_length The length scale used in getting Kd [Z ~> m]. This control structure holds parameters for the MOM_energetic_PBL module. real type(efp_type), dimension(2) mom_energetic_pbl::energetic_pbl_cs use_lt answers_2018 orig_pe_calc mld_bisection mstar_flatcap use_mld_iteration tke_diagnostics mld_iteration_guess time sum_its diag max_mld_its mstar_scheme id_tke_mke id_la id_mstar_mix id_tke_conv_decay id_mixing_length id_tke_wind id_tke_mech_decay id_tke_conv ... mstar_lt diag_tke_mixing diag_tke_mke lac_mldoob_un lac_ekoob_stab rh18_mstar_cs1 c_ek mstar_cap lt_enhance_exp rh18_mstar_cs2 ... logical time_type diag_ctrl integer mom_energetic_pbl::energetic_pbl_csanswers_2018 mom_energetic_pbl::energetic_pbl_csc_ek mom_energetic_pbl::energetic_pbl_csdiag mom_energetic_pbl::energetic_pbl_csdiag_tke_conv mom_energetic_pbl::energetic_pbl_csdiag_tke_conv_decay mom_energetic_pbl::energetic_pbl_csdiag_tke_forcing mom_energetic_pbl::energetic_pbl_csdiag_tke_mech_decay mom_energetic_pbl::energetic_pbl_csdiag_tke_mixing mom_energetic_pbl::energetic_pbl_csdiag_tke_mke mom_energetic_pbl::energetic_pbl_csdiag_tke_wind mom_energetic_pbl::energetic_pbl_csekman_scale_coef mom_energetic_pbl::energetic_pbl_csfixed_mstar mom_energetic_pbl::energetic_pbl_csid_hml_depth mom_energetic_pbl::energetic_pbl_csid_la mom_energetic_pbl::energetic_pbl_csid_la_mod mom_energetic_pbl::energetic_pbl_csid_mixing_length mom_energetic_pbl::energetic_pbl_csid_ml_depth mom_energetic_pbl::energetic_pbl_csid_mstar_lt mom_energetic_pbl::energetic_pbl_csid_mstar_mix mom_energetic_pbl::energetic_pbl_csid_tke_conv mom_energetic_pbl::energetic_pbl_csid_tke_conv_decay mom_energetic_pbl::energetic_pbl_csid_tke_forcing mom_energetic_pbl::energetic_pbl_csid_tke_mech_decay mom_energetic_pbl::energetic_pbl_csid_tke_mixing mom_energetic_pbl::energetic_pbl_csid_tke_mke mom_energetic_pbl::energetic_pbl_csid_tke_wind mom_energetic_pbl::energetic_pbl_csid_velocity_scale mom_energetic_pbl::energetic_pbl_csla mom_energetic_pbl::energetic_pbl_csla_mod mom_energetic_pbl::energetic_pbl_cslac_ekoob_stab mom_energetic_pbl::energetic_pbl_cslac_ekoob_un mom_energetic_pbl::energetic_pbl_cslac_mldoek mom_energetic_pbl::energetic_pbl_cslac_mldoob_stab mom_energetic_pbl::energetic_pbl_cslac_mldoob_un mom_energetic_pbl::energetic_pbl_cslt_enhance_coef mom_energetic_pbl::energetic_pbl_cslt_enhance_exp mom_energetic_pbl::energetic_pbl_cslt_enhance_form mom_energetic_pbl::energetic_pbl_csmax_enhance_m mom_energetic_pbl::energetic_pbl_csmax_mld_its mom_energetic_pbl::energetic_pbl_csmin_mix_len mom_energetic_pbl::energetic_pbl_csmixing_length mom_energetic_pbl::energetic_pbl_csmixlenexponent mom_energetic_pbl::energetic_pbl_csmke_to_tke_effic mom_energetic_pbl::energetic_pbl_csml_depth mom_energetic_pbl::energetic_pbl_csmld_bisection mom_energetic_pbl::energetic_pbl_csmld_iteration_guess mom_energetic_pbl::energetic_pbl_csmld_tol mom_energetic_pbl::energetic_pbl_csmstar_cap mom_energetic_pbl::energetic_pbl_csmstar_coef mom_energetic_pbl::energetic_pbl_csmstar_convect_coef mom_energetic_pbl::energetic_pbl_csmstar_flatcap mom_energetic_pbl::energetic_pbl_csmstar_lt mom_energetic_pbl::energetic_pbl_csmstar_mix mom_energetic_pbl::energetic_pbl_csmstar_scheme mom_energetic_pbl::energetic_pbl_csnstar mom_energetic_pbl::energetic_pbl_csomega mom_energetic_pbl::energetic_pbl_csomega_frac mom_energetic_pbl::energetic_pbl_csorig_pe_calc mom_energetic_pbl::energetic_pbl_csrh18_mstar_cn1 mom_energetic_pbl::energetic_pbl_csrh18_mstar_cn2 mom_energetic_pbl::energetic_pbl_csrh18_mstar_cn3 mom_energetic_pbl::energetic_pbl_csrh18_mstar_cs1 mom_energetic_pbl::energetic_pbl_csrh18_mstar_cs2 mom_energetic_pbl::energetic_pbl_cssum_its mom_energetic_pbl::energetic_pbl_cstime mom_energetic_pbl::energetic_pbl_cstke_decay mom_energetic_pbl::energetic_pbl_cstke_diagnostics mom_energetic_pbl::energetic_pbl_cstranslay_scale mom_energetic_pbl::energetic_pbl_csuse_lt mom_energetic_pbl::energetic_pbl_csuse_mld_iteration mom_energetic_pbl::energetic_pbl_csustar_min mom_energetic_pbl::energetic_pbl_csvelocity_scale mom_energetic_pbl::energetic_pbl_csvonkar mom_energetic_pbl::energetic_pbl_csvstar_scale_fac mom_energetic_pbl::energetic_pbl_csvstar_surf_fac mom_energetic_pbl::energetic_pbl_cswstar_ustar_coef mom_energetic_pbl::energetic_pbl_cswt_scheme