Detailed Description

Control structure for containing KPP parameters/data.

Definition at line 71 of file MOM_CVMix_KPP.F90.

Collaboration diagram for mom_cvmix_kpp::kpp_cs:

Public variables and constants
real	ri_crit
	Critical bulk Richardson number (defines OBL depth) More...

real	vonkarman
	von Karman constant (dimensionless) More...

real	cs
	Parameter for computing velocity scale function (dimensionless) More...

real	cs2
	Parameter for multiplying by non-local term. More...

logical	enhance_diffusion
	If True, add enhanced diffusivity at base of boundary layer. More...

character(len=10)	interptype
	Type of interpolation to compute bulk Richardson number. More...

character(len=10)	interptype2
	Type of interpolation to compute diff and visc at OBL_depth. More...

logical	computeekman
	If True, compute Ekman depth limit for OBLdepth. More...

logical	computemoninobukhov
	If True, compute Monin-Obukhov limit for OBLdepth. More...

logical	passivemode
	If True, makes KPP passive meaning it does NOT alter the diffusivity. More...

real	deepobloffset
	If non-zero, is a distance from the bottom that the OBL can not penetrate through [m]. More...

real	minobldepth
	If non-zero, is a minimum depth for the OBL [m]. More...

real	surf_layer_ext
	Fraction of OBL depth considered in the surface layer [nondim]. More...

real	minvtsqr
	Min for the squared unresolved velocity used in Rib CVMix calculation [m2 s-2]. More...

logical	fixedobldepth
	If True, will fix the OBL depth at fixedOBLdepth_value. More...

real	fixedobldepth_value
	value for the fixed OBL depth when fixedOBLdepth==True. More...

logical	debug
	If True, calculate checksums and write debugging information. More...

character(len=30)	matchtechnique
	Method used in CVMix for setting diffusivity and NLT profile functions. More...

integer	nlt_shape
	MOM6 over-ride of CVMix NLT shape function. More...

logical	applynonlocaltrans
	If True, apply non-local transport to heat and scalars. More...

integer	n_smooth
	Number of times smoothing operator is applied on OBLdepth. More...

logical	deepen_only
	If true, apply OBLdepth smoothing at a cell only if the OBLdepth gets deeper. More...

logical	kppzerodiffusivity
	If True, will set diffusivity and viscosity from KPP to zero for testing purposes. More...

logical	kppisadditive
	If True, will add KPP diffusivity to initial diffusivity. If False, will replace initial diffusivity wherever KPP diffusivity is non-zero. More...

real	min_thickness
	A minimum thickness used to avoid division by small numbers in the vicinity of vanished layers. More...

logical	correctsurflayeravg
	If true, applies a correction to the averaging of surface layer properties. More...

real	surflayerdepth
	A guess at the depth of the surface layer (which should 0.1 of OBLdepth) [m]. More...

integer	sw_method
	Sets method for using shortwave radiation in surface buoyancy flux. More...

logical	lt_k_enhancement
	Flags if enhancing mixing coefficients due to LT. More...

integer	lt_k_shape
	Integer for constant or shape function enhancement. More...

integer	lt_k_method
	Integer for mixing coefficients LT method. More...

real	kpp_k_enh_fac
	Factor to multiply by K if Method is CONSTANT. More...

logical	lt_vt2_enhancement
	Flags if enhancing Vt2 due to LT. More...

integer	lt_vt2_method
	Integer for Vt2 LT method. More...

real	kpp_vt2_enh_fac
	Factor to multiply by VT2 if Method is CONSTANT. More...

logical	stokes_mixing
	Flag if model is mixing down Stokes gradient This is relavent for which current to use in RiB. More...

type(cvmix_kpp_params_type), pointer	kpp_params => NULL()
	CVMix parameters. More...

type(diag_ctrl), pointer	diag => NULL()
	Pointer to diagnostics control structure. More...


integer	id_obldepth = -1
	Diagnostic handles. More...

integer	id_bulkri = -1
	Diagnostic handles. More...

integer	id_n = -1
	Diagnostic handles. More...

integer	id_n2 = -1
	Diagnostic handles. More...

integer	id_ws = -1
	Diagnostic handles. More...

integer	id_vt2 = -1
	Diagnostic handles. More...

integer	id_bulkuz2 = -1
	Diagnostic handles. More...

integer	id_bulkdrho = -1
	Diagnostic handles. More...

integer	id_ustar = -1
	Diagnostic handles. More...

integer	id_buoyflux = -1
	Diagnostic handles. More...

integer	id_qminussw = -1
	Diagnostic handles. More...

integer	id_nets = -1
	Diagnostic handles. More...

integer	id_sigma = -1
	Diagnostic handles. More...

integer	id_kv_kpp = -1
	Diagnostic handles. More...

integer	id_kt_kpp = -1
	Diagnostic handles. More...

integer	id_ks_kpp = -1
	Diagnostic handles. More...

integer	id_tsurf = -1
	Diagnostic handles. More...

integer	id_ssurf = -1
	Diagnostic handles. More...

integer	id_usurf = -1
	Diagnostic handles. More...

integer	id_vsurf = -1
	Diagnostic handles. More...

integer	id_kd_in = -1
	Diagnostic handles. More...

integer	id_nltt = -1
	Diagnostic handles. More...

integer	id_nlts = -1
	Diagnostic handles. More...

integer	id_nlt_dsdt = -1
	Diagnostic handles. More...

integer	id_nlt_dtdt = -1
	Diagnostic handles. More...

integer	id_nlt_temp_budget = -1
	Diagnostic handles. More...

integer	id_nlt_saln_budget = -1
	Diagnostic handles. More...

integer	id_enhk = -1
	Diagnostic handles. More...

integer	id_enhvt2 = -1
	Diagnostic handles. More...

integer	id_enhw = -1
	Diagnostic handles. More...

integer	id_la_sl = -1
	Diagnostic handles. More...

integer	id_obldepth_original = -1
	Diagnostic handles. More...

real, dimension(:,:), allocatable	obldepth
	Depth (positive) of OBL [m]. More...

real, dimension(:,:), allocatable	obldepth_original
	Depth (positive) of OBL [m] without smoothing. More...

real, dimension(:,:), allocatable	kobl
	Level (+fraction) of OBL extent. More...

real, dimension(:,:), allocatable	obldepthprev
	previous Depth (positive) of OBL [m] More...

real, dimension(:,:), allocatable	la_sl
	Langmuir number used in KPP. More...

real, dimension(:,:,:), allocatable	drho
	Bulk difference in density [kg m-3]. More...

real, dimension(:,:,:), allocatable	uz2
	Square of bulk difference in resolved velocity [m2 s-2]. More...

real, dimension(:,:,:), allocatable	bulkri
	Bulk Richardson number for each layer (dimensionless) More...

real, dimension(:,:,:), allocatable	sigma
	Sigma coordinate (dimensionless) More...

real, dimension(:,:,:), allocatable	ws
	Turbulent velocity scale for scalars [m s-1]. More...

real, dimension(:,:,:), allocatable	n
	Brunt-Vaisala frequency [s-1]. More...

real, dimension(:,:,:), allocatable	n2
	Squared Brunt-Vaisala frequency [s-2]. More...

real, dimension(:,:,:), allocatable	vt2
	Unresolved squared turbulence velocity for bulk Ri [m2 s-2]. More...

real, dimension(:,:,:), allocatable	kt_kpp
	Temp diffusivity from KPP [m2 s-1]. More...

real, dimension(:,:,:), allocatable	ks_kpp
	Scalar diffusivity from KPP [m2 s-1]. More...

real, dimension(:,:,:), allocatable	kv_kpp
	Viscosity due to KPP [m2 s-1]. More...

real, dimension(:,:), allocatable	tsurf
	Temperature of surface layer [degC]. More...

real, dimension(:,:), allocatable	ssurf
	Salinity of surface layer [ppt]. More...

real, dimension(:,:), allocatable	usurf
	i-velocity of surface layer [m s-1] More...

real, dimension(:,:), allocatable	vsurf
	j-velocity of surface layer [m s-1] More...

real, dimension(:,:,:), allocatable	enhk
	Enhancement for mixing coefficient. More...

real, dimension(:,:,:), allocatable	enhvt2
	Enhancement for Vt2. More...

Variables and constants

◆ applynonlocaltrans

logical mom_cvmix_kpp::kpp_cs::applynonlocaltrans

If True, apply non-local transport to heat and scalars.

Definition at line 95 of file MOM_CVMix_KPP.F90.

95 logical :: applyNonLocalTrans !< If True, apply non-local transport to heat and scalars

◆ bulkri

real, dimension(:,:,:), allocatable mom_cvmix_kpp::kpp_cs::bulkri

Bulk Richardson number for each layer (dimensionless)

Definition at line 156 of file MOM_CVMix_KPP.F90.

156 real, allocatable, dimension(:,:,:) :: BulkRi !< Bulk Richardson number for each layer (dimensionless)

◆ computeekman

logical mom_cvmix_kpp::kpp_cs::computeekman

If True, compute Ekman depth limit for OBLdepth.

Definition at line 82 of file MOM_CVMix_KPP.F90.

82 logical :: computeEkman !< If True, compute Ekman depth limit for OBLdepth

◆ computemoninobukhov

logical mom_cvmix_kpp::kpp_cs::computemoninobukhov

If True, compute Monin-Obukhov limit for OBLdepth.

Definition at line 83 of file MOM_CVMix_KPP.F90.

83 logical :: computeMoninObukhov !< If True, compute Monin-Obukhov limit for OBLdepth

◆ correctsurflayeravg

logical mom_cvmix_kpp::kpp_cs::correctsurflayeravg

If true, applies a correction to the averaging of surface layer properties.

Definition at line 106 of file MOM_CVMix_KPP.F90.

106 logical :: correctSurfLayerAvg !< If true, applies a correction to the averaging of surface layer properties

◆ cs

real mom_cvmix_kpp::kpp_cs::cs

Parameter for computing velocity scale function (dimensionless)

Definition at line 76 of file MOM_CVMix_KPP.F90.

76 real :: cs !< Parameter for computing velocity scale function (dimensionless)

◆ cs2

real mom_cvmix_kpp::kpp_cs::cs2

Parameter for multiplying by non-local term.

Definition at line 77 of file MOM_CVMix_KPP.F90.

77 real :: cs2 !< Parameter for multiplying by non-local term

◆ debug

logical mom_cvmix_kpp::kpp_cs::debug

If True, calculate checksums and write debugging information.

Definition at line 92 of file MOM_CVMix_KPP.F90.

92 logical :: debug !< If True, calculate checksums and write debugging information

◆ deepen_only

logical mom_cvmix_kpp::kpp_cs::deepen_only

If true, apply OBLdepth smoothing at a cell only if the OBLdepth gets deeper.

Definition at line 97 of file MOM_CVMix_KPP.F90.

97 logical :: deepen_only !< If true, apply OBLdepth smoothing at a cell only if the OBLdepth gets deeper.

◆ deepobloffset

real mom_cvmix_kpp::kpp_cs::deepobloffset

If non-zero, is a distance from the bottom that the OBL can not penetrate through [m].

Definition at line 85 of file MOM_CVMix_KPP.F90.

85 real :: deepOBLoffset !< If non-zero, is a distance from the bottom that the OBL can not

◆ diag

type(diag_ctrl), pointer mom_cvmix_kpp::kpp_cs::diag => NULL()

Pointer to diagnostics control structure.

Definition at line 123 of file MOM_CVMix_KPP.F90.

123 type(diag_ctrl), pointer :: diag => null() !< Pointer to diagnostics control structure

◆ drho

real, dimension(:,:,:), allocatable mom_cvmix_kpp::kpp_cs::drho

Bulk difference in density [kg m-3].

Definition at line 154 of file MOM_CVMix_KPP.F90.

154 real, allocatable, dimension(:,:,:) :: dRho !< Bulk difference in density [kg m-3]

◆ enhance_diffusion

logical mom_cvmix_kpp::kpp_cs::enhance_diffusion

If True, add enhanced diffusivity at base of boundary layer.

Definition at line 79 of file MOM_CVMix_KPP.F90.

79 logical :: enhance_diffusion !< If True, add enhanced diffusivity at base of boundary layer.

◆ enhk

real, dimension(:,:,:), allocatable mom_cvmix_kpp::kpp_cs::enhk

Enhancement for mixing coefficient.

Definition at line 169 of file MOM_CVMix_KPP.F90.

169 real, allocatable, dimension(:,:,:) :: EnhK !< Enhancement for mixing coefficient

◆ enhvt2

real, dimension(:,:,:), allocatable mom_cvmix_kpp::kpp_cs::enhvt2

Enhancement for Vt2.

Definition at line 170 of file MOM_CVMix_KPP.F90.

170 real, allocatable, dimension(:,:,:) :: EnhVt2 !< Enhancement for Vt2

◆ fixedobldepth

logical mom_cvmix_kpp::kpp_cs::fixedobldepth

If True, will fix the OBL depth at fixedOBLdepth_value.

Definition at line 90 of file MOM_CVMix_KPP.F90.

90 logical :: fixedOBLdepth !< If True, will fix the OBL depth at fixedOBLdepth_value

◆ fixedobldepth_value

real mom_cvmix_kpp::kpp_cs::fixedobldepth_value

value for the fixed OBL depth when fixedOBLdepth==True.

Definition at line 91 of file MOM_CVMix_KPP.F90.

91 real :: fixedOBLdepth_value !< value for the fixed OBL depth when fixedOBLdepth==True.

◆ id_bulkdrho

integer mom_cvmix_kpp::kpp_cs::id_bulkdrho = -1

Diagnostic handles.

Definition at line 128 of file MOM_CVMix_KPP.F90.

◆ id_bulkri

integer mom_cvmix_kpp::kpp_cs::id_bulkri = -1

Diagnostic handles.

Definition at line 125 of file MOM_CVMix_KPP.F90.

◆ id_bulkuz2

integer mom_cvmix_kpp::kpp_cs::id_bulkuz2 = -1

Diagnostic handles.

Definition at line 128 of file MOM_CVMix_KPP.F90.

128 integer :: id_BulkUz2 = -1, id_bulkdrho = -1

◆ id_buoyflux

integer mom_cvmix_kpp::kpp_cs::id_buoyflux = -1

Diagnostic handles.

Definition at line 129 of file MOM_CVMix_KPP.F90.

◆ id_enhk

integer mom_cvmix_kpp::kpp_cs::id_enhk = -1

Diagnostic handles.

Definition at line 142 of file MOM_CVMix_KPP.F90.

142 integer :: id_EnhK = -1, id_enhvt2 = -1

◆ id_enhvt2

integer mom_cvmix_kpp::kpp_cs::id_enhvt2 = -1

Diagnostic handles.

Definition at line 142 of file MOM_CVMix_KPP.F90.

◆ id_enhw

integer mom_cvmix_kpp::kpp_cs::id_enhw = -1

Diagnostic handles.

Definition at line 143 of file MOM_CVMix_KPP.F90.

143 integer :: id_EnhW = -1

◆ id_kd_in

integer mom_cvmix_kpp::kpp_cs::id_kd_in = -1

Diagnostic handles.

Definition at line 135 of file MOM_CVMix_KPP.F90.

135 integer :: id_Kd_in = -1

◆ id_ks_kpp

integer mom_cvmix_kpp::kpp_cs::id_ks_kpp = -1

Diagnostic handles.

Definition at line 132 of file MOM_CVMix_KPP.F90.

◆ id_kt_kpp

integer mom_cvmix_kpp::kpp_cs::id_kt_kpp = -1

Diagnostic handles.

Definition at line 132 of file MOM_CVMix_KPP.F90.

132 integer :: id_Kt_KPP = -1, id_ks_kpp = -1

◆ id_kv_kpp

integer mom_cvmix_kpp::kpp_cs::id_kv_kpp = -1

Diagnostic handles.

Definition at line 131 of file MOM_CVMix_KPP.F90.

◆ id_la_sl

integer mom_cvmix_kpp::kpp_cs::id_la_sl = -1

Diagnostic handles.

Definition at line 144 of file MOM_CVMix_KPP.F90.

144 integer :: id_La_SL = -1

◆ id_n

integer mom_cvmix_kpp::kpp_cs::id_n = -1

Diagnostic handles.

Definition at line 126 of file MOM_CVMix_KPP.F90.

126 integer :: id_N = -1, id_n2 = -1

◆ id_n2

integer mom_cvmix_kpp::kpp_cs::id_n2 = -1

Diagnostic handles.

Definition at line 126 of file MOM_CVMix_KPP.F90.

◆ id_nets

integer mom_cvmix_kpp::kpp_cs::id_nets = -1

Diagnostic handles.

Definition at line 130 of file MOM_CVMix_KPP.F90.

◆ id_nlt_dsdt

integer mom_cvmix_kpp::kpp_cs::id_nlt_dsdt = -1

Diagnostic handles.

Definition at line 138 of file MOM_CVMix_KPP.F90.

138 integer :: id_NLT_dSdt = -1

◆ id_nlt_dtdt

integer mom_cvmix_kpp::kpp_cs::id_nlt_dtdt = -1

Diagnostic handles.

Definition at line 139 of file MOM_CVMix_KPP.F90.

139 integer :: id_NLT_dTdt = -1

◆ id_nlt_saln_budget

integer mom_cvmix_kpp::kpp_cs::id_nlt_saln_budget = -1

Diagnostic handles.

Definition at line 141 of file MOM_CVMix_KPP.F90.

141 integer :: id_NLT_saln_budget = -1

◆ id_nlt_temp_budget

integer mom_cvmix_kpp::kpp_cs::id_nlt_temp_budget = -1

Diagnostic handles.

Definition at line 140 of file MOM_CVMix_KPP.F90.

140 integer :: id_NLT_temp_budget = -1

◆ id_nlts

integer mom_cvmix_kpp::kpp_cs::id_nlts = -1

Diagnostic handles.

Definition at line 137 of file MOM_CVMix_KPP.F90.

137 integer :: id_NLTs = -1

◆ id_nltt

integer mom_cvmix_kpp::kpp_cs::id_nltt = -1

Diagnostic handles.

Definition at line 136 of file MOM_CVMix_KPP.F90.

136 integer :: id_NLTt = -1

◆ id_obldepth

integer mom_cvmix_kpp::kpp_cs::id_obldepth = -1

Diagnostic handles.

Definition at line 125 of file MOM_CVMix_KPP.F90.

125 integer :: id_OBLdepth = -1, id_bulkri = -1

◆ id_obldepth_original

integer mom_cvmix_kpp::kpp_cs::id_obldepth_original = -1

Diagnostic handles.

Definition at line 145 of file MOM_CVMix_KPP.F90.

145 integer :: id_OBLdepth_original = -1

◆ id_qminussw

integer mom_cvmix_kpp::kpp_cs::id_qminussw = -1

Diagnostic handles.

Definition at line 130 of file MOM_CVMix_KPP.F90.

130 integer :: id_QminusSW = -1, id_nets = -1

◆ id_sigma

integer mom_cvmix_kpp::kpp_cs::id_sigma = -1

Diagnostic handles.

Definition at line 131 of file MOM_CVMix_KPP.F90.

131 integer :: id_sigma = -1, id_kv_kpp = -1

◆ id_ssurf

integer mom_cvmix_kpp::kpp_cs::id_ssurf = -1

Diagnostic handles.

Definition at line 133 of file MOM_CVMix_KPP.F90.

◆ id_tsurf

integer mom_cvmix_kpp::kpp_cs::id_tsurf = -1

Diagnostic handles.

Definition at line 133 of file MOM_CVMix_KPP.F90.

133 integer :: id_Tsurf = -1, id_ssurf = -1

◆ id_ustar

integer mom_cvmix_kpp::kpp_cs::id_ustar = -1

Diagnostic handles.

Definition at line 129 of file MOM_CVMix_KPP.F90.

129 integer :: id_uStar = -1, id_buoyflux = -1

◆ id_usurf

integer mom_cvmix_kpp::kpp_cs::id_usurf = -1

Diagnostic handles.

Definition at line 134 of file MOM_CVMix_KPP.F90.

134 integer :: id_Usurf = -1, id_vsurf = -1

◆ id_vsurf

integer mom_cvmix_kpp::kpp_cs::id_vsurf = -1

Diagnostic handles.

Definition at line 134 of file MOM_CVMix_KPP.F90.

◆ id_vt2

integer mom_cvmix_kpp::kpp_cs::id_vt2 = -1

Diagnostic handles.

Definition at line 127 of file MOM_CVMix_KPP.F90.

◆ id_ws

integer mom_cvmix_kpp::kpp_cs::id_ws = -1

Diagnostic handles.

Definition at line 127 of file MOM_CVMix_KPP.F90.

127 integer :: id_Ws = -1, id_vt2 = -1

◆ interptype

character(len=10) mom_cvmix_kpp::kpp_cs::interptype

Type of interpolation to compute bulk Richardson number.

Definition at line 80 of file MOM_CVMix_KPP.F90.

80 character(len=10) :: interpType !< Type of interpolation to compute bulk Richardson number

◆ interptype2

character(len=10) mom_cvmix_kpp::kpp_cs::interptype2

Type of interpolation to compute diff and visc at OBL_depth.

Definition at line 81 of file MOM_CVMix_KPP.F90.

81 character(len=10) :: interpType2 !< Type of interpolation to compute diff and visc at OBL_depth

◆ kobl

real, dimension(:,:), allocatable mom_cvmix_kpp::kpp_cs::kobl

Level (+fraction) of OBL extent.

Definition at line 151 of file MOM_CVMix_KPP.F90.

151 real, allocatable, dimension(:,:) :: kOBL !< Level (+fraction) of OBL extent

◆ kpp_k_enh_fac

real mom_cvmix_kpp::kpp_cs::kpp_k_enh_fac

Factor to multiply by K if Method is CONSTANT.

Definition at line 113 of file MOM_CVMix_KPP.F90.

113 real :: KPP_K_ENH_FAC !< Factor to multiply by K if Method is CONSTANT

◆ kpp_params

type(cvmix_kpp_params_type), pointer mom_cvmix_kpp::kpp_cs::kpp_params => NULL()

CVMix parameters.

Definition at line 121 of file MOM_CVMix_KPP.F90.

121 type(CVMix_kpp_params_type), pointer :: KPP_params => null()

◆ kpp_vt2_enh_fac

real mom_cvmix_kpp::kpp_cs::kpp_vt2_enh_fac

Factor to multiply by VT2 if Method is CONSTANT.

Definition at line 116 of file MOM_CVMix_KPP.F90.

116 real :: KPP_VT2_ENH_FAC !< Factor to multiply by VT2 if Method is CONSTANT

◆ kppisadditive

logical mom_cvmix_kpp::kpp_cs::kppisadditive

If True, will add KPP diffusivity to initial diffusivity. If False, will replace initial diffusivity wherever KPP diffusivity is non-zero.

Definition at line 100 of file MOM_CVMix_KPP.F90.

100 logical :: KPPisAdditive !< If True, will add KPP diffusivity to initial diffusivity.

◆ kppzerodiffusivity

logical mom_cvmix_kpp::kpp_cs::kppzerodiffusivity

If True, will set diffusivity and viscosity from KPP to zero for testing purposes.

Definition at line 98 of file MOM_CVMix_KPP.F90.

98 logical :: KPPzeroDiffusivity !< If True, will set diffusivity and viscosity from KPP to zero

◆ ks_kpp

real, dimension(:,:,:), allocatable mom_cvmix_kpp::kpp_cs::ks_kpp

Scalar diffusivity from KPP [m2 s-1].

Definition at line 163 of file MOM_CVMix_KPP.F90.

163 real, allocatable, dimension(:,:,:) :: Ks_KPP !< Scalar diffusivity from KPP [m2 s-1]

◆ kt_kpp

real, dimension(:,:,:), allocatable mom_cvmix_kpp::kpp_cs::kt_kpp

Temp diffusivity from KPP [m2 s-1].

Definition at line 162 of file MOM_CVMix_KPP.F90.

162 real, allocatable, dimension(:,:,:) :: Kt_KPP !< Temp diffusivity from KPP [m2 s-1]

◆ kv_kpp

real, dimension(:,:,:), allocatable mom_cvmix_kpp::kpp_cs::kv_kpp

Viscosity due to KPP [m2 s-1].

Definition at line 164 of file MOM_CVMix_KPP.F90.

164 real, allocatable, dimension(:,:,:) :: Kv_KPP !< Viscosity due to KPP [m2 s-1]

◆ la_sl

real, dimension(:,:), allocatable mom_cvmix_kpp::kpp_cs::la_sl

Langmuir number used in KPP.

Definition at line 153 of file MOM_CVMix_KPP.F90.

153 real, allocatable, dimension(:,:) :: La_SL !< Langmuir number used in KPP

◆ lt_k_enhancement

logical mom_cvmix_kpp::kpp_cs::lt_k_enhancement

Flags if enhancing mixing coefficients due to LT.

Definition at line 110 of file MOM_CVMix_KPP.F90.

110 logical :: LT_K_Enhancement !< Flags if enhancing mixing coefficients due to LT

◆ lt_k_method

integer mom_cvmix_kpp::kpp_cs::lt_k_method

Integer for mixing coefficients LT method.

Definition at line 112 of file MOM_CVMix_KPP.F90.

112 integer :: LT_K_Method !< Integer for mixing coefficients LT method

◆ lt_k_shape

integer mom_cvmix_kpp::kpp_cs::lt_k_shape

Integer for constant or shape function enhancement.

Definition at line 111 of file MOM_CVMix_KPP.F90.

111 integer :: LT_K_Shape !< Integer for constant or shape function enhancement

◆ lt_vt2_enhancement

logical mom_cvmix_kpp::kpp_cs::lt_vt2_enhancement

Flags if enhancing Vt2 due to LT.

Definition at line 114 of file MOM_CVMix_KPP.F90.

114 logical :: LT_Vt2_Enhancement !< Flags if enhancing Vt2 due to LT

◆ lt_vt2_method

integer mom_cvmix_kpp::kpp_cs::lt_vt2_method

Integer for Vt2 LT method.

Definition at line 115 of file MOM_CVMix_KPP.F90.

115 integer :: LT_VT2_METHOD !< Integer for Vt2 LT method

◆ matchtechnique

character(len=30) mom_cvmix_kpp::kpp_cs::matchtechnique

Method used in CVMix for setting diffusivity and NLT profile functions.

Definition at line 93 of file MOM_CVMix_KPP.F90.

93 character(len=30) :: MatchTechnique !< Method used in CVMix for setting diffusivity and NLT profile functions

◆ min_thickness

real mom_cvmix_kpp::kpp_cs::min_thickness

A minimum thickness used to avoid division by small numbers in the vicinity of vanished layers.

Definition at line 103 of file MOM_CVMix_KPP.F90.

103 real :: min_thickness !< A minimum thickness used to avoid division by small numbers

◆ minobldepth

real mom_cvmix_kpp::kpp_cs::minobldepth

If non-zero, is a minimum depth for the OBL [m].

Definition at line 87 of file MOM_CVMix_KPP.F90.

87 real :: minOBLdepth !< If non-zero, is a minimum depth for the OBL [m]

◆ minvtsqr

real mom_cvmix_kpp::kpp_cs::minvtsqr

Min for the squared unresolved velocity used in Rib CVMix calculation [m2 s-2].

Definition at line 89 of file MOM_CVMix_KPP.F90.

89 real :: minVtsqr !< Min for the squared unresolved velocity used in Rib CVMix calculation [m2 s-2]

◆ n

real, dimension(:,:,:), allocatable mom_cvmix_kpp::kpp_cs::n

Brunt-Vaisala frequency [s-1].

Definition at line 159 of file MOM_CVMix_KPP.F90.

159 real, allocatable, dimension(:,:,:) :: N !< Brunt-Vaisala frequency [s-1]

◆ n2

real, dimension(:,:,:), allocatable mom_cvmix_kpp::kpp_cs::n2

Squared Brunt-Vaisala frequency [s-2].

Definition at line 160 of file MOM_CVMix_KPP.F90.

160 real, allocatable, dimension(:,:,:) :: N2 !< Squared Brunt-Vaisala frequency [s-2]

◆ n_smooth

integer mom_cvmix_kpp::kpp_cs::n_smooth

Number of times smoothing operator is applied on OBLdepth.

Definition at line 96 of file MOM_CVMix_KPP.F90.

96 integer :: n_smooth !< Number of times smoothing operator is applied on OBLdepth.

◆ nlt_shape

integer mom_cvmix_kpp::kpp_cs::nlt_shape

MOM6 over-ride of CVMix NLT shape function.

Definition at line 94 of file MOM_CVMix_KPP.F90.

94 integer :: NLT_shape !< MOM6 over-ride of CVMix NLT shape function

◆ obldepth

real, dimension(:,:), allocatable mom_cvmix_kpp::kpp_cs::obldepth

Depth (positive) of OBL [m].

Definition at line 149 of file MOM_CVMix_KPP.F90.

149 real, allocatable, dimension(:,:) :: OBLdepth !< Depth (positive) of OBL [m]

◆ obldepth_original

real, dimension(:,:), allocatable mom_cvmix_kpp::kpp_cs::obldepth_original

Depth (positive) of OBL [m] without smoothing.

Definition at line 150 of file MOM_CVMix_KPP.F90.

150 real, allocatable, dimension(:,:) :: OBLdepth_original !< Depth (positive) of OBL [m] without smoothing

◆ obldepthprev

real, dimension(:,:), allocatable mom_cvmix_kpp::kpp_cs::obldepthprev

previous Depth (positive) of OBL [m]

Definition at line 152 of file MOM_CVMix_KPP.F90.

152 real, allocatable, dimension(:,:) :: OBLdepthprev !< previous Depth (positive) of OBL [m]

◆ passivemode

logical mom_cvmix_kpp::kpp_cs::passivemode

If True, makes KPP passive meaning it does NOT alter the diffusivity.

Definition at line 84 of file MOM_CVMix_KPP.F90.

84 logical :: passiveMode !< If True, makes KPP passive meaning it does NOT alter the diffusivity

◆ ri_crit

real mom_cvmix_kpp::kpp_cs::ri_crit

Critical bulk Richardson number (defines OBL depth)

Definition at line 74 of file MOM_CVMix_KPP.F90.

74 real :: Ri_crit !< Critical bulk Richardson number (defines OBL depth)

◆ sigma

real, dimension(:,:,:), allocatable mom_cvmix_kpp::kpp_cs::sigma

Sigma coordinate (dimensionless)

Definition at line 157 of file MOM_CVMix_KPP.F90.

157 real, allocatable, dimension(:,:,:) :: sigma !< Sigma coordinate (dimensionless)

◆ ssurf

real, dimension(:,:), allocatable mom_cvmix_kpp::kpp_cs::ssurf

Salinity of surface layer [ppt].

Definition at line 166 of file MOM_CVMix_KPP.F90.

166 real, allocatable, dimension(:,:) :: Ssurf !< Salinity of surface layer [ppt]

◆ stokes_mixing

logical mom_cvmix_kpp::kpp_cs::stokes_mixing

Flag if model is mixing down Stokes gradient This is relavent for which current to use in RiB.

Definition at line 117 of file MOM_CVMix_KPP.F90.

117 logical :: STOKES_MIXING !< Flag if model is mixing down Stokes gradient

◆ surf_layer_ext

real mom_cvmix_kpp::kpp_cs::surf_layer_ext

Fraction of OBL depth considered in the surface layer [nondim].

Definition at line 88 of file MOM_CVMix_KPP.F90.

88 real :: surf_layer_ext !< Fraction of OBL depth considered in the surface layer [nondim]

◆ surflayerdepth

real mom_cvmix_kpp::kpp_cs::surflayerdepth

A guess at the depth of the surface layer (which should 0.1 of OBLdepth) [m].

Definition at line 107 of file MOM_CVMix_KPP.F90.

107 real :: surfLayerDepth !< A guess at the depth of the surface layer (which should 0.1 of OBLdepth) [m]

◆ sw_method

integer mom_cvmix_kpp::kpp_cs::sw_method

Sets method for using shortwave radiation in surface buoyancy flux.

Definition at line 109 of file MOM_CVMix_KPP.F90.

109 integer :: SW_METHOD !< Sets method for using shortwave radiation in surface buoyancy flux

◆ tsurf

real, dimension(:,:), allocatable mom_cvmix_kpp::kpp_cs::tsurf

Temperature of surface layer [degC].

Definition at line 165 of file MOM_CVMix_KPP.F90.

165 real, allocatable, dimension(:,:) :: Tsurf !< Temperature of surface layer [degC]

◆ usurf

real, dimension(:,:), allocatable mom_cvmix_kpp::kpp_cs::usurf

i-velocity of surface layer [m s-1]

Definition at line 167 of file MOM_CVMix_KPP.F90.

167 real, allocatable, dimension(:,:) :: Usurf !< i-velocity of surface layer [m s-1]

◆ uz2

real, dimension(:,:,:), allocatable mom_cvmix_kpp::kpp_cs::uz2

Square of bulk difference in resolved velocity [m2 s-2].

Definition at line 155 of file MOM_CVMix_KPP.F90.

155 real, allocatable, dimension(:,:,:) :: Uz2 !< Square of bulk difference in resolved velocity [m2 s-2]

◆ vonkarman

real mom_cvmix_kpp::kpp_cs::vonkarman

von Karman constant (dimensionless)

Definition at line 75 of file MOM_CVMix_KPP.F90.

75 real :: vonKarman !< von Karman constant (dimensionless)

◆ vsurf

real, dimension(:,:), allocatable mom_cvmix_kpp::kpp_cs::vsurf

j-velocity of surface layer [m s-1]

Definition at line 168 of file MOM_CVMix_KPP.F90.

168 real, allocatable, dimension(:,:) :: Vsurf !< j-velocity of surface layer [m s-1]

◆ vt2

real, dimension(:,:,:), allocatable mom_cvmix_kpp::kpp_cs::vt2

Unresolved squared turbulence velocity for bulk Ri [m2 s-2].

Definition at line 161 of file MOM_CVMix_KPP.F90.

161 real, allocatable, dimension(:,:,:) :: Vt2 !< Unresolved squared turbulence velocity for bulk Ri [m2 s-2]

◆ ws

real, dimension(:,:,:), allocatable mom_cvmix_kpp::kpp_cs::ws

Turbulent velocity scale for scalars [m s-1].

Definition at line 158 of file MOM_CVMix_KPP.F90.

158 real, allocatable, dimension(:,:,:) :: Ws !< Turbulent velocity scale for scalars [m s-1]

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_CVMix_KPP.F90

Detailed Description

Public variables and constants

Variables and constants

◆ applynonlocaltrans

◆ bulkri

◆ computeekman

◆ computemoninobukhov

◆ correctsurflayeravg

◆ cs

◆ cs2

◆ debug

◆ deepen_only

◆ deepobloffset

◆ diag

◆ drho

◆ enhance_diffusion

◆ enhk

◆ enhvt2

◆ fixedobldepth

◆ fixedobldepth_value

◆ id_bulkdrho

◆ id_bulkri

◆ id_bulkuz2

◆ id_buoyflux

◆ id_enhk

◆ id_enhvt2

◆ id_enhw

◆ id_kd_in

◆ id_ks_kpp

◆ id_kt_kpp

◆ id_kv_kpp

◆ id_la_sl

◆ id_n

◆ id_n2

◆ id_nets

◆ id_nlt_dsdt

◆ id_nlt_dtdt

◆ id_nlt_saln_budget

◆ id_nlt_temp_budget

◆ id_nlts

◆ id_nltt

◆ id_obldepth

◆ id_obldepth_original

◆ id_qminussw

◆ id_sigma

◆ id_ssurf

◆ id_tsurf

◆ id_ustar

◆ id_usurf

◆ id_vsurf

◆ id_vt2

◆ id_ws

◆ interptype

◆ interptype2

◆ kobl

◆ kpp_k_enh_fac

◆ kpp_params

◆ kpp_vt2_enh_fac

◆ kppisadditive

◆ kppzerodiffusivity

◆ ks_kpp

◆ kt_kpp

◆ kv_kpp

◆ la_sl

◆ lt_k_enhancement

◆ lt_k_method

◆ lt_k_shape

◆ lt_vt2_enhancement

◆ lt_vt2_method

◆ matchtechnique

◆ min_thickness

◆ minobldepth

◆ minvtsqr

◆ n

◆ n2

◆ n_smooth

◆ nlt_shape

◆ obldepth

◆ obldepth_original

◆ obldepthprev