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:

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. More...

real	omega
	The Earth's rotation rate [T-1 ~> s-1]. More...

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 + of4*omega^2) [nondim]. More...

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. More...

logical	use_mld_iteration =.false.
	False to use old ePBL method. More...

logical	mld_iteration_guess =.false.
	False to default to guessing half the ocean depth for the iteration. More...

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. More...

real	mixlenexponent
	Exponent in the mixing length shape-function. 1 is law-of-the-wall at top and bottom, 2 is more KPP like. More...

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]. More...

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. More...

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. More...

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. More...

real	mld_tol
	A tolerance for determining the boundary layer thickness when Use_MLD_iteration is true [Z ~> m]. More...

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. More...

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. More...

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. More...

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]. More...

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. More...

integer	mstar_scheme
	An encoded integer to determine which formula is used to set mstar. More...

logical	mstar_flatcap =.true.
	Set false to use asymptotic mstar cap. More...

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. More...

real	tke_decay
	The ratio of the natural Ekman depth to the TKE decay scale [nondim]. More...

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. More...

real	c_ek = 0.17
	MSTAR Coefficient in rotation limit for mstar_scheme=OM4. More...

real	mstar_coef = 0.3
	MSTAR coefficient in rotation/stabilizing balance for mstar_scheme=OM4. More...

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). More...

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. More...

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. More...

real	rh18_mstar_cs1
	MSTAR_S coefficient for RH18 in stabilizing limit. Value of 0.2 in RH18. More...

real	rh18_mstar_cs2
	MSTAR_S exponent for RH18 in stabilizing limit. Value of 0.4 in RH18. More...

real	mstar_convect_coef
	Factor to reduce mstar when statically unstable. More...

logical	use_lt = .false.
	Flag for using LT in Energy calculation. More...

integer	lt_enhance_form
	Integer for Enhancement functional form (various options) More...

real	lt_enhance_coef
	Coefficient in fit for Langmuir Enhancment. More...

real	lt_enhance_exp
	Exponent in fit for Langmuir Enhancement. More...

real	lac_mldoek
	Coefficient for Langmuir number modification based on the ratio of the mixed layer depth over the Ekman depth. More...

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. More...

real	lac_ekoob_stab
	Coefficient for Langmuir number modification based on the ratio of the Ekman depth over the Obukov depth with stablizing forcing. More...

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. More...

real	lac_ekoob_un
	Coefficient for Langmuir number modification based on the ratio of the Ekman depth over the Obukov depth with destablizing forcing. More...

real	max_enhance_m = 5.
	The maximum allowed LT enhancement to the mixing. More...

type(time_type), pointer	time =>NULL()
	A pointer to the ocean model's clock. More...

logical	tke_diagnostics = .false.
	If true, diagnostics of the TKE budget are being calculated. More...

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. More...

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. More...

type(diag_ctrl), pointer	diag =>NULL()
	A structure that is used to regulate the timing of diagnostic output. More...

real, dimension(:,:), allocatable	ml_depth
	The mixed layer depth determined by active mixing in ePBL [Z ~> m]. More...

real, dimension(:,:), allocatable	diag_tke_wind
	The wind source of TKE [R Z3 T-3 ~> W m-2]. More...

real, dimension(:,:), allocatable	diag_tke_mke
	The resolved KE source of TKE [R Z3 T-3 ~> W m-2]. More...

real, dimension(:,:), allocatable	diag_tke_conv
	The convective source of TKE [R Z3 T-3 ~> W m-2]. More...

real, dimension(:,:), allocatable	diag_tke_forcing
	The TKE sink required to mix surface penetrating shortwave heating. More...

real, dimension(:,:), allocatable	diag_tke_mech_decay
	The decay of mechanical TKE [R Z3 T-3 ~> W m-2]. More...

real, dimension(:,:), allocatable	diag_tke_conv_decay
	The decay of convective TKE [R Z3 T-3 ~> W m-2]. More...

real, dimension(:,:), allocatable	diag_tke_mixing
	The work done by TKE to deepen the mixed layer [R Z3 T-3 ~> W m-2]. More...

real, dimension(:,:), allocatable	mstar_mix
	Mstar used in EPBL [nondim]. More...

real, dimension(:,:), allocatable	mstar_lt
	Mstar due to Langmuir turbulence [nondim]. More...

real, dimension(:,:), allocatable	la
	Langmuir number [nondim]. More...

real, dimension(:,:), allocatable	la_mod
	Modified Langmuir number [nondim]. More...

real, dimension(:,:,:), allocatable	velocity_scale
	The velocity scale used in getting Kd [Z T-1 ~> m s-1]. More...

real, dimension(:,:,:), allocatable	mixing_length
	The length scale used in getting Kd [Z ~> m]. More...


integer	id_ml_depth = -1
	Diagnostic IDs. More...

integer	id_tke_wind = -1
	Diagnostic IDs. More...

integer	id_tke_mixing = -1
	Diagnostic IDs. More...

integer	id_tke_mke = -1
	Diagnostic IDs. More...

integer	id_tke_conv = -1
	Diagnostic IDs. More...

integer	id_tke_forcing = -1
	Diagnostic IDs. More...

integer	id_tke_mech_decay = -1
	Diagnostic IDs. More...

integer	id_tke_conv_decay = -1
	Diagnostic IDs. More...

integer	id_mixing_length = -1
	Diagnostic IDs. More...

integer	id_velocity_scale = -1
	Diagnostic IDs. More...

integer	id_mstar_mix = -1
	Diagnostic IDs. More...

integer	id_la_mod = -1
	Diagnostic IDs. More...

integer	id_la = -1
	Diagnostic IDs. More...

integer	id_mstar_lt = -1
	Diagnostic IDs. More...

Variables and constants

◆ answers_2018

logical mom_energetic_pbl::energetic_pbl_cs::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.

Definition at line 155 of file MOM_energetic_PBL.F90.

155 logical :: answers_2018 !< If true, use the order of arithmetic and expressions that recover the

◆ c_ek

real mom_energetic_pbl::energetic_pbl_cs::c_ek = 0.17

MSTAR Coefficient in rotation limit for mstar_scheme=OM4.

Definition at line 111 of file MOM_energetic_PBL.F90.

111 real :: C_EK = 0.17 !< MSTAR Coefficient in rotation limit for mstar_scheme=OM4

◆ diag

type(diag_ctrl), pointer mom_energetic_pbl::energetic_pbl_cs::diag =>NULL()

A structure that is used to regulate the timing of diagnostic output.

Definition at line 162 of file MOM_energetic_PBL.F90.

162 type(diag_ctrl), pointer :: diag=>null() !< A structure that is used to regulate the

◆ diag_tke_conv

real, dimension(:,:), allocatable mom_energetic_pbl::energetic_pbl_cs::diag_tke_conv

The convective source of TKE [R Z3 T-3 ~> W m-2].

Definition at line 169 of file MOM_energetic_PBL.F90.

◆ diag_tke_conv_decay

real, dimension(:,:), allocatable mom_energetic_pbl::energetic_pbl_cs::diag_tke_conv_decay

The decay of convective TKE [R Z3 T-3 ~> W m-2].

Definition at line 169 of file MOM_energetic_PBL.F90.

◆ diag_tke_forcing

real, dimension(:,:), allocatable mom_energetic_pbl::energetic_pbl_cs::diag_tke_forcing

The TKE sink required to mix surface penetrating shortwave heating.

Definition at line 169 of file MOM_energetic_PBL.F90.

◆ diag_tke_mech_decay

real, dimension(:,:), allocatable mom_energetic_pbl::energetic_pbl_cs::diag_tke_mech_decay

The decay of mechanical TKE [R Z3 T-3 ~> W m-2].

Definition at line 169 of file MOM_energetic_PBL.F90.

◆ diag_tke_mixing

real, dimension(:,:), allocatable mom_energetic_pbl::energetic_pbl_cs::diag_tke_mixing

The work done by TKE to deepen the mixed layer [R Z3 T-3 ~> W m-2].

Definition at line 169 of file MOM_energetic_PBL.F90.

◆ diag_tke_mke

real, dimension(:,:), allocatable mom_energetic_pbl::energetic_pbl_cs::diag_tke_mke

The resolved KE source of TKE [R Z3 T-3 ~> W m-2].

Definition at line 169 of file MOM_energetic_PBL.F90.

◆ diag_tke_wind

real, dimension(:,:), allocatable mom_energetic_pbl::energetic_pbl_cs::diag_tke_wind

The wind source of TKE [R Z3 T-3 ~> W m-2].

Definition at line 169 of file MOM_energetic_PBL.F90.

   real, allocatable, dimension(:,:) :: &
     diag_TKE_wind, &   !< The wind source of TKE [R Z3 T-3 ~> W m-2].
     diag_TKE_MKE, &    !< The resolved KE source of TKE [R Z3 T-3 ~> W m-2].
     diag_TKE_conv, &   !< The convective source of TKE [R Z3 T-3 ~> W m-2].
     diag_TKE_forcing, & !< The TKE sink required to mix surface penetrating shortwave heating
                        !! [R Z3 T-3 ~> W m-2].
     diag_tke_mech_decay, & !< The decay of mechanical TKE [R Z3 T-3 ~> W m-2].
     diag_tke_conv_decay, & !< The decay of convective TKE [R Z3 T-3 ~> W m-2].
     diag_tke_mixing, & !< The work done by TKE to deepen the mixed layer [R Z3 T-3 ~> W m-2].
     ! These additional diagnostics are also 2d.
     mstar_mix, &       !< Mstar used in EPBL [nondim]
     mstar_lt, &        !< Mstar due to Langmuir turbulence [nondim]
     la, &              !< Langmuir number [nondim]
     la_mod             !< Modified Langmuir number [nondim]

◆ ekman_scale_coef

real mom_energetic_pbl::energetic_pbl_cs::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.

Definition at line 65 of file MOM_energetic_PBL.F90.

65 real :: Ekman_scale_coef !< A nondimensional scaling factor controlling the inhibition of the

◆ fixed_mstar

real mom_energetic_pbl::energetic_pbl_cs::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.

Definition at line 104 of file MOM_energetic_PBL.F90.

104 real :: fixed_mstar !< Mstar is the ratio of the friction velocity cubed to the TKE available to

◆ id_la

integer mom_energetic_pbl::energetic_pbl_cs::id_la = -1

Diagnostic IDs.

Definition at line 192 of file MOM_energetic_PBL.F90.

◆ id_la_mod

integer mom_energetic_pbl::energetic_pbl_cs::id_la_mod = -1

Diagnostic IDs.

Definition at line 192 of file MOM_energetic_PBL.F90.

◆ id_mixing_length

integer mom_energetic_pbl::energetic_pbl_cs::id_mixing_length = -1

Diagnostic IDs.

Definition at line 191 of file MOM_energetic_PBL.F90.

191 integer :: id_Mixing_Length = -1, id_velocity_scale = -1

◆ id_ml_depth

integer mom_energetic_pbl::energetic_pbl_cs::id_ml_depth = -1

Diagnostic IDs.

Definition at line 188 of file MOM_energetic_PBL.F90.

188 integer :: id_ML_depth = -1, id_tke_wind = -1, id_tke_mixing = -1

◆ id_mstar_lt

integer mom_energetic_pbl::energetic_pbl_cs::id_mstar_lt = -1

Diagnostic IDs.

Definition at line 192 of file MOM_energetic_PBL.F90.

◆ id_mstar_mix

integer mom_energetic_pbl::energetic_pbl_cs::id_mstar_mix = -1

Diagnostic IDs.

Definition at line 192 of file MOM_energetic_PBL.F90.

192 integer :: id_MSTAR_mix = -1, id_la_mod = -1, id_la = -1, id_mstar_lt = -1

◆ id_tke_conv

integer mom_energetic_pbl::energetic_pbl_cs::id_tke_conv = -1

Diagnostic IDs.

Definition at line 189 of file MOM_energetic_PBL.F90.

◆ id_tke_conv_decay

integer mom_energetic_pbl::energetic_pbl_cs::id_tke_conv_decay = -1

Diagnostic IDs.

Definition at line 190 of file MOM_energetic_PBL.F90.

◆ id_tke_forcing

integer mom_energetic_pbl::energetic_pbl_cs::id_tke_forcing = -1

Diagnostic IDs.

Definition at line 189 of file MOM_energetic_PBL.F90.

◆ id_tke_mech_decay

integer mom_energetic_pbl::energetic_pbl_cs::id_tke_mech_decay = -1

Diagnostic IDs.

Definition at line 190 of file MOM_energetic_PBL.F90.

190 integer :: id_TKE_mech_decay = -1, id_tke_conv_decay = -1

◆ id_tke_mixing

integer mom_energetic_pbl::energetic_pbl_cs::id_tke_mixing = -1

Diagnostic IDs.

Definition at line 188 of file MOM_energetic_PBL.F90.

◆ id_tke_mke

integer mom_energetic_pbl::energetic_pbl_cs::id_tke_mke = -1

Diagnostic IDs.

Definition at line 189 of file MOM_energetic_PBL.F90.

189 integer :: id_TKE_MKE = -1, id_tke_conv = -1, id_tke_forcing = -1

◆ id_tke_wind

integer mom_energetic_pbl::energetic_pbl_cs::id_tke_wind = -1

Diagnostic IDs.

Definition at line 188 of file MOM_energetic_PBL.F90.

◆ id_velocity_scale

integer mom_energetic_pbl::energetic_pbl_cs::id_velocity_scale = -1

Diagnostic IDs.

Definition at line 191 of file MOM_energetic_PBL.F90.

◆ la

real, dimension(:,:), allocatable mom_energetic_pbl::energetic_pbl_cs::la

Langmuir number [nondim].

Definition at line 169 of file MOM_energetic_PBL.F90.

◆ la_mod

real, dimension(:,:), allocatable mom_energetic_pbl::energetic_pbl_cs::la_mod

Modified Langmuir number [nondim].

Definition at line 169 of file MOM_energetic_PBL.F90.

◆ lac_ekoob_stab

real mom_energetic_pbl::energetic_pbl_cs::lac_ekoob_stab

Coefficient for Langmuir number modification based on the ratio of the Ekman depth over the Obukov depth with stablizing forcing.

Definition at line 143 of file MOM_energetic_PBL.F90.

143 real :: LaC_EKoOB_stab !< Coefficient for Langmuir number modification based on the ratio of

◆ lac_ekoob_un

real mom_energetic_pbl::energetic_pbl_cs::lac_ekoob_un

Coefficient for Langmuir number modification based on the ratio of the Ekman depth over the Obukov depth with destablizing forcing.

Definition at line 147 of file MOM_energetic_PBL.F90.

147 real :: LaC_EKoOB_un !< Coefficient for Langmuir number modification based on the ratio of

◆ lac_mldoek

real mom_energetic_pbl::energetic_pbl_cs::lac_mldoek

Coefficient for Langmuir number modification based on the ratio of the mixed layer depth over the Ekman depth.

Definition at line 139 of file MOM_energetic_PBL.F90.

139 real :: LaC_MLDoEK !< Coefficient for Langmuir number modification based on the ratio of

◆ lac_mldoob_stab

real mom_energetic_pbl::energetic_pbl_cs::lac_mldoob_stab

Coefficient for Langmuir number modification based on the ratio of the mixed layer depth over the Obukov depth with stablizing forcing.

Definition at line 141 of file MOM_energetic_PBL.F90.

141 real :: LaC_MLDoOB_stab !< Coefficient for Langmuir number modification based on the ratio of

◆ lac_mldoob_un

real mom_energetic_pbl::energetic_pbl_cs::lac_mldoob_un

Coefficient for Langmuir number modification based on the ratio of the mixed layer depth over the Obukov depth with destablizing forcing.

Definition at line 145 of file MOM_energetic_PBL.F90.

145 real :: LaC_MLDoOB_un !< Coefficient for Langmuir number modification based on the ratio of

◆ lt_enhance_coef

real mom_energetic_pbl::energetic_pbl_cs::lt_enhance_coef

Coefficient in fit for Langmuir Enhancment.

Definition at line 137 of file MOM_energetic_PBL.F90.

137 real :: LT_ENHANCE_COEF !< Coefficient in fit for Langmuir Enhancment

◆ lt_enhance_exp

real mom_energetic_pbl::energetic_pbl_cs::lt_enhance_exp

Exponent in fit for Langmuir Enhancement.

Definition at line 138 of file MOM_energetic_PBL.F90.

138 real :: LT_ENHANCE_EXP !< Exponent in fit for Langmuir Enhancement

◆ lt_enhance_form

integer mom_energetic_pbl::energetic_pbl_cs::lt_enhance_form

Integer for Enhancement functional form (various options)

Definition at line 136 of file MOM_energetic_PBL.F90.

136 integer :: LT_ENHANCE_FORM !< Integer for Enhancement functional form (various options)

◆ max_enhance_m

real mom_energetic_pbl::energetic_pbl_cs::max_enhance_m = 5.

The maximum allowed LT enhancement to the mixing.

Definition at line 149 of file MOM_energetic_PBL.F90.

149 real :: Max_Enhance_M = 5. !< The maximum allowed LT enhancement to the mixing.

◆ max_mld_its

integer mom_energetic_pbl::energetic_pbl_cs::max_mld_its

The maximum number of iterations that can be used to find a self-consistent mixed layer depth with Use_MLD_iteration.

Definition at line 55 of file MOM_energetic_PBL.F90.

55 integer :: max_MLD_its !< The maximum number of iterations that can be used to find a

◆ min_mix_len

real mom_energetic_pbl::energetic_pbl_cs::min_mix_len

The minimum mixing length scale that will be used by ePBL [Z ~> m]. The default (0) does not set a minimum.

Definition at line 74 of file MOM_energetic_PBL.F90.

74 real :: min_mix_len !< The minimum mixing length scale that will be used by ePBL [Z ~> m].

◆ mixing_length

real, dimension(:,:,:), allocatable mom_energetic_pbl::energetic_pbl_cs::mixing_length

The length scale used in getting Kd [Z ~> m].

Definition at line 184 of file MOM_energetic_PBL.F90.

◆ mixlenexponent

real mom_energetic_pbl::energetic_pbl_cs::mixlenexponent

Exponent in the mixing length shape-function. 1 is law-of-the-wall at top and bottom, 2 is more KPP like.

Definition at line 57 of file MOM_energetic_PBL.F90.

57 real :: MixLenExponent !< Exponent in the mixing length shape-function.

◆ mke_to_tke_effic

real mom_energetic_pbl::energetic_pbl_cs::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].

Definition at line 60 of file MOM_energetic_PBL.F90.

60 real :: MKE_to_TKE_effic !< The efficiency with which mean kinetic energy released by

◆ ml_depth

real, dimension(:,:), allocatable mom_energetic_pbl::energetic_pbl_cs::ml_depth

The mixed layer depth determined by active mixing in ePBL [Z ~> m].

Definition at line 165 of file MOM_energetic_PBL.F90.

165 real, allocatable, dimension(:,:) :: &

166 ML_depth !< The mixed layer depth determined by active mixing in ePBL [Z ~> m].

◆ mld_iteration_guess

logical mom_energetic_pbl::energetic_pbl_cs::mld_iteration_guess =.false.

False to default to guessing half the ocean depth for the iteration.

Definition at line 53 of file MOM_energetic_PBL.F90.

53 logical :: MLD_iteration_guess=.false. !< False to default to guessing half the

◆ mld_tol

real mom_energetic_pbl::energetic_pbl_cs::mld_tol

A tolerance for determining the boundary layer thickness when Use_MLD_iteration is true [Z ~> m].

Definition at line 72 of file MOM_energetic_PBL.F90.

72 real :: MLD_tol !< A tolerance for determining the boundary layer thickness when

◆ mstar_cap

real mom_energetic_pbl::energetic_pbl_cs::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.

Definition at line 95 of file MOM_energetic_PBL.F90.

95 real :: mstar_cap !< Since MSTAR is restoring undissipated energy to mixing,

◆ mstar_coef

real mom_energetic_pbl::energetic_pbl_cs::mstar_coef = 0.3

MSTAR coefficient in rotation/stabilizing balance for mstar_scheme=OM4.

Definition at line 112 of file MOM_energetic_PBL.F90.

112 real :: MSTAR_COEF = 0.3 !< MSTAR coefficient in rotation/stabilizing balance for mstar_scheme=OM4

◆ mstar_convect_coef

real mom_energetic_pbl::energetic_pbl_cs::mstar_convect_coef

Factor to reduce mstar when statically unstable.

Definition at line 132 of file MOM_energetic_PBL.F90.

132 real :: mstar_convect_coef !< Factor to reduce mstar when statically unstable.

◆ mstar_flatcap

logical mom_energetic_pbl::energetic_pbl_cs::mstar_flatcap =.true.

Set false to use asymptotic mstar cap.

Definition at line 94 of file MOM_energetic_PBL.F90.

94 logical :: MSTAR_FLATCAP=.true. !< Set false to use asymptotic mstar cap.

◆ mstar_lt

real, dimension(:,:), allocatable mom_energetic_pbl::energetic_pbl_cs::mstar_lt

Mstar due to Langmuir turbulence [nondim].

Definition at line 169 of file MOM_energetic_PBL.F90.

◆ mstar_mix

real, dimension(:,:), allocatable mom_energetic_pbl::energetic_pbl_cs::mstar_mix

Mstar used in EPBL [nondim].

Definition at line 169 of file MOM_energetic_PBL.F90.

◆ mstar_scheme

integer mom_energetic_pbl::energetic_pbl_cs::mstar_scheme

An encoded integer to determine which formula is used to set mstar.

Definition at line 93 of file MOM_energetic_PBL.F90.

93 integer :: mstar_scheme !< An encoded integer to determine which formula is used to set mstar

◆ nstar

real mom_energetic_pbl::energetic_pbl_cs::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.

Definition at line 46 of file MOM_energetic_PBL.F90.

46 real :: nstar !< The fraction of the TKE input to the mixed layer available to drive

◆ omega

real mom_energetic_pbl::energetic_pbl_cs::omega

The Earth's rotation rate [T-1 ~> s-1].

Definition at line 40 of file MOM_energetic_PBL.F90.

40 real :: omega !< The Earth's rotation rate [T-1 ~> s-1].

◆ omega_frac

real mom_energetic_pbl::energetic_pbl_cs::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].

Definition at line 41 of file MOM_energetic_PBL.F90.

41 real :: omega_frac !< When setting the decay scale for turbulence, use this fraction of

◆ orig_pe_calc

logical mom_energetic_pbl::energetic_pbl_cs::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.

Definition at line 158 of file MOM_energetic_PBL.F90.

158 logical :: orig_PE_calc !< If true, the ePBL code uses the original form of the

◆ rh18_mstar_cn1

real mom_energetic_pbl::energetic_pbl_cs::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).

Definition at line 115 of file MOM_energetic_PBL.F90.

115 real :: RH18_mstar_cN1 !< MSTAR_N coefficient 1 (outter-most coefficient for fit).

◆ rh18_mstar_cn2

real mom_energetic_pbl::energetic_pbl_cs::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.

Definition at line 119 of file MOM_energetic_PBL.F90.

119 real :: RH18_mstar_cN2 !< MSTAR_N coefficient 2 (coefficient outside of exponential decay).

◆ rh18_mstar_cn3

real mom_energetic_pbl::energetic_pbl_cs::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.

Definition at line 123 of file MOM_energetic_PBL.F90.

123 real :: RH18_mstar_cN3 !< MSTAR_N coefficient 3 (exponential decay coefficient). Value of

◆ rh18_mstar_cs1

real mom_energetic_pbl::energetic_pbl_cs::rh18_mstar_cs1

MSTAR_S coefficient for RH18 in stabilizing limit. Value of 0.2 in RH18.

Definition at line 126 of file MOM_energetic_PBL.F90.

126 real :: RH18_mstar_cS1 !< MSTAR_S coefficient for RH18 in stabilizing limit.

◆ rh18_mstar_cs2

real mom_energetic_pbl::energetic_pbl_cs::rh18_mstar_cs2

MSTAR_S exponent for RH18 in stabilizing limit. Value of 0.4 in RH18.

Definition at line 128 of file MOM_energetic_PBL.F90.

128 real :: RH18_mstar_cS2 !< MSTAR_S exponent for RH18 in stabilizing limit.

◆ time

type(time_type), pointer mom_energetic_pbl::energetic_pbl_cs::time =>NULL()

A pointer to the ocean model's clock.

Definition at line 152 of file MOM_energetic_PBL.F90.

152 type(time_type), pointer :: Time=>null() !< A pointer to the ocean model's clock.

◆ tke_decay

real mom_energetic_pbl::energetic_pbl_cs::tke_decay

The ratio of the natural Ekman depth to the TKE decay scale [nondim].

Definition at line 101 of file MOM_energetic_PBL.F90.

101 real :: TKE_decay !< The ratio of the natural Ekman depth to the TKE decay scale [nondim].

◆ tke_diagnostics

logical mom_energetic_pbl::energetic_pbl_cs::tke_diagnostics = .false.

If true, diagnostics of the TKE budget are being calculated.

Definition at line 154 of file MOM_energetic_PBL.F90.

154 logical :: TKE_diagnostics = .false. !< If true, diagnostics of the TKE budget are being calculated.

◆ translay_scale

real mom_energetic_pbl::energetic_pbl_cs::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.

Definition at line 68 of file MOM_energetic_PBL.F90.

68 real :: transLay_scale !< A scale for the mixing length in the transition layer

◆ use_lt

logical mom_energetic_pbl::energetic_pbl_cs::use_lt = .false.

Flag for using LT in Energy calculation.

Definition at line 135 of file MOM_energetic_PBL.F90.

135 logical :: Use_LT = .false. !< Flag for using LT in Energy calculation

◆ use_mld_iteration

logical mom_energetic_pbl::energetic_pbl_cs::use_mld_iteration =.false.

False to use old ePBL method.

Definition at line 52 of file MOM_energetic_PBL.F90.

52 logical :: Use_MLD_iteration=.false. !< False to use old ePBL method.

◆ ustar_min

real mom_energetic_pbl::energetic_pbl_cs::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.

Definition at line 63 of file MOM_energetic_PBL.F90.

63 real :: ustar_min !< A minimum value of ustar to avoid numerical problems [Z T-1 ~> m s-1].

◆ velocity_scale

real, dimension(:,:,:), allocatable mom_energetic_pbl::energetic_pbl_cs::velocity_scale

The velocity scale used in getting Kd [Z T-1 ~> m s-1].

Definition at line 184 of file MOM_energetic_PBL.F90.

   real, allocatable, dimension(:,:,:) :: &
     Velocity_Scale, & !< The velocity scale used in getting Kd [Z T-1 ~> m s-1]
     Mixing_Length     !< The length scale used in getting Kd [Z ~> m]

◆ vonkar

real mom_energetic_pbl::energetic_pbl_cs::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.

Definition at line 38 of file MOM_energetic_PBL.F90.

38 real :: VonKar = 0.41 !< The von Karman coefficient. This should be runtime, but because

◆ vstar_scale_fac

real mom_energetic_pbl::energetic_pbl_cs::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.

Definition at line 88 of file MOM_energetic_PBL.F90.

88 real :: vstar_scale_fac !< An overall nondimensional scaling factor for vstar times a unit

◆ vstar_surf_fac

real mom_energetic_pbl::energetic_pbl_cs::vstar_surf_fac

If (wT_scheme == wT_from_RH18) this is the proportionality coefficient between ustar and the surface mechanical contribution to vstar [nondim].

Definition at line 86 of file MOM_energetic_PBL.F90.

86 real :: vstar_surf_fac !< If (wT_scheme == wT_from_RH18) this is the proportionality coefficient between

◆ wstar_ustar_coef

real mom_energetic_pbl::energetic_pbl_cs::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.

Definition at line 82 of file MOM_energetic_PBL.F90.

82 real :: wstar_ustar_coef !< A ratio relating the efficiency with which convectively released

◆ wt_scheme

integer mom_energetic_pbl::energetic_pbl_cs::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.

Definition at line 78 of file MOM_energetic_PBL.F90.

78 integer :: wT_scheme !< An enumerated value indicating the method for finding the turbulent

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

/glade/work/altuntas/cesm.sandboxes/cesm2_2_alpha_X_mom/components/mom/MOM6/src/parameterizations/vertical/MOM_energetic_PBL.F90

Detailed Description

Public variables and constants

Variables and constants

◆ answers_2018

◆ c_ek

◆ diag

◆ diag_tke_conv

◆ diag_tke_conv_decay

◆ diag_tke_forcing

◆ diag_tke_mech_decay

◆ diag_tke_mixing

◆ diag_tke_mke

◆ diag_tke_wind

◆ ekman_scale_coef

◆ fixed_mstar

◆ id_la

◆ id_la_mod

◆ id_mixing_length

◆ id_ml_depth

◆ id_mstar_lt

◆ id_mstar_mix

◆ id_tke_conv

◆ id_tke_conv_decay

◆ id_tke_forcing

◆ id_tke_mech_decay

◆ id_tke_mixing

◆ id_tke_mke

◆ id_tke_wind

◆ id_velocity_scale

◆ la

◆ la_mod

◆ lac_ekoob_stab

◆ lac_ekoob_un

◆ lac_mldoek

◆ lac_mldoob_stab

◆ lac_mldoob_un

◆ lt_enhance_coef

◆ lt_enhance_exp

◆ lt_enhance_form

◆ max_enhance_m

◆ max_mld_its

◆ min_mix_len

◆ mixing_length

◆ mixlenexponent

◆ mke_to_tke_effic

◆ ml_depth

◆ mld_iteration_guess

◆ mld_tol

◆ mstar_cap

◆ mstar_coef

◆ mstar_convect_coef

◆ mstar_flatcap

◆ mstar_lt

◆ mstar_mix

◆ mstar_scheme

◆ nstar

◆ omega

◆ omega_frac

◆ orig_pe_calc

◆ rh18_mstar_cn1

◆ rh18_mstar_cn2

◆ rh18_mstar_cn3

◆ rh18_mstar_cs1

◆ rh18_mstar_cs2

◆ time

◆ tke_decay

◆ tke_diagnostics

◆ translay_scale

◆ use_lt

◆ use_mld_iteration

◆ ustar_min

◆ velocity_scale

◆ vonkar

◆ vstar_scale_fac

◆ vstar_surf_fac

◆ wstar_ustar_coef

◆ wt_scheme