MOM6
mom_kappa_shear::kappa_shear_cs Type Reference

Detailed Description

This control structure holds the parameters that regulate shear mixing.

Definition at line 35 of file MOM_kappa_shear.F90.

Collaboration diagram for mom_kappa_shear::kappa_shear_cs:
[legend]

Public variables and constants

real rino_crit
 The critical shear Richardson number for shear-entrainment [nondim]. The theoretical value is 0.25. The values found by Jackson et al. are 0.25-0.35. More...
 
real shearmix_rate
 A nondimensional rate scale for shear-driven entrainment [nondim]. The value given by Jackson et al. is 0.085-0.089. More...
 
real fri_curvature
 A constant giving the curvature of the function of the Richardson number that relates shear to sources in the kappa equation [nondim]. The values found by Jackson et al. are -0.97 - -0.89. More...
 
real c_n
 The coefficient for the decay of TKE due to stratification (i.e. proportional to N*tke) [nondim]. The values found by Jackson et al. are 0.24-0.28. More...
 
real c_s
 The coefficient for the decay of TKE due to shear (i.e. proportional to |S|*tke) [nondim]. The values found by Jackson et al. are 0.14-0.12. More...
 
real lambda
 The coefficient for the buoyancy length scale in the kappa equation [nondim]. The values found by Jackson et al. are 0.82-0.81. More...
 
real lambda2_n_s
 The square of the ratio of the coefficients of the buoyancy and shear scales in the diffusivity equation, 0 to eliminate the shear scale [nondim]. More...
 
real tke_bg
 The background level of TKE [Z2 T-2 ~> m2 s-2]. More...
 
real kappa_0
 The background diapycnal diffusivity [Z2 T-1 ~> m2 s-1]. More...
 
real kappa_trunc
 Diffusivities smaller than this are rounded to 0 [Z2 T-1 ~> m2 s-1]. More...
 
real kappa_tol_err
 The fractional error in kappa that is tolerated [nondim]. More...
 
real prandtl_turb
 Prandtl number used to convert Kd_shear into viscosity [nondim]. More...
 
integer nkml
 The number of layers in the mixed layer, as treated in this routine. If the pieces of the mixed layer are not to be treated collectively, nkml is set to 1. More...
 
integer max_rino_it
 The maximum number of iterations that may be used to estimate the instantaneous shear-driven mixing. More...
 
integer max_ks_it
 The maximum number of iterations that may be used to estimate the time-averaged diffusivity. More...
 
logical dkdq_iteration_bug
 If true. use an older, dimensionally inconsistent estimate of the derivative of diffusivity with energy in the Newton's method iteration. The bug causes undercorrections when dz > 1m. More...
 
logical ks_at_vertex
 If true, do the calculations of the shear-driven mixing at the cell vertices (i.e., the vorticity points). More...
 
logical eliminate_massless
 If true, massless layers are merged with neighboring massive layers in this calculation. More...
 
real vel_underflow
 Velocity components smaller than vel_underflow are set to 0 [L T-1 ~> m s-1]. More...
 
logical debug = .false.
 If true, write verbose debugging messages. More...
 
type(diag_ctrl), pointer diag => NULL()
 A structure that is used to regulate the timing of diagnostic output. More...
 
integer id_kd_shear = -1
 Diagnostic IDs. More...
 
integer id_tke = -1
 Diagnostic IDs. More...
 
integer id_ild2 = -1
 Diagnostic IDs. More...
 
integer id_dz_int = -1
 Diagnostic IDs. More...
 

Variables and constants

◆ c_n

real mom_kappa_shear::kappa_shear_cs::c_n

The coefficient for the decay of TKE due to stratification (i.e. proportional to N*tke) [nondim]. The values found by Jackson et al. are 0.24-0.28.

Definition at line 46 of file MOM_kappa_shear.F90.

46  real :: C_N !< The coefficient for the decay of TKE due to

◆ c_s

real mom_kappa_shear::kappa_shear_cs::c_s

The coefficient for the decay of TKE due to shear (i.e. proportional to |S|*tke) [nondim]. The values found by Jackson et al. are 0.14-0.12.

Definition at line 49 of file MOM_kappa_shear.F90.

49  real :: C_S !< The coefficient for the decay of TKE due to

◆ debug

logical mom_kappa_shear::kappa_shear_cs::debug = .false.

If true, write verbose debugging messages.

Definition at line 83 of file MOM_kappa_shear.F90.

83  logical :: debug = .false. !< If true, write verbose debugging messages.

◆ diag

type(diag_ctrl), pointer mom_kappa_shear::kappa_shear_cs::diag => NULL()

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

Definition at line 84 of file MOM_kappa_shear.F90.

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

◆ dkdq_iteration_bug

logical mom_kappa_shear::kappa_shear_cs::dkdq_iteration_bug

If true. use an older, dimensionally inconsistent estimate of the derivative of diffusivity with energy in the Newton's method iteration. The bug causes undercorrections when dz > 1m.

Definition at line 71 of file MOM_kappa_shear.F90.

71  logical :: dKdQ_iteration_bug !< If true. use an older, dimensionally inconsistent estimate of

◆ eliminate_massless

logical mom_kappa_shear::kappa_shear_cs::eliminate_massless

If true, massless layers are merged with neighboring massive layers in this calculation.

Definition at line 76 of file MOM_kappa_shear.F90.

76  logical :: eliminate_massless !< If true, massless layers are merged with neighboring

◆ fri_curvature

real mom_kappa_shear::kappa_shear_cs::fri_curvature

A constant giving the curvature of the function of the Richardson number that relates shear to sources in the kappa equation [nondim]. The values found by Jackson et al. are -0.97 - -0.89.

Definition at line 42 of file MOM_kappa_shear.F90.

42  real :: FRi_curvature !< A constant giving the curvature of the function

◆ id_dz_int

integer mom_kappa_shear::kappa_shear_cs::id_dz_int = -1

Diagnostic IDs.

Definition at line 87 of file MOM_kappa_shear.F90.

◆ id_ild2

integer mom_kappa_shear::kappa_shear_cs::id_ild2 = -1

Diagnostic IDs.

Definition at line 87 of file MOM_kappa_shear.F90.

◆ id_kd_shear

integer mom_kappa_shear::kappa_shear_cs::id_kd_shear = -1

Diagnostic IDs.

Definition at line 87 of file MOM_kappa_shear.F90.

87  integer :: id_Kd_shear = -1, id_tke = -1, id_ild2 = -1, id_dz_int = -1

◆ id_tke

integer mom_kappa_shear::kappa_shear_cs::id_tke = -1

Diagnostic IDs.

Definition at line 87 of file MOM_kappa_shear.F90.

◆ kappa_0

real mom_kappa_shear::kappa_shear_cs::kappa_0

The background diapycnal diffusivity [Z2 T-1 ~> m2 s-1].

Definition at line 59 of file MOM_kappa_shear.F90.

59  real :: kappa_0 !< The background diapycnal diffusivity [Z2 T-1 ~> m2 s-1].

◆ kappa_tol_err

real mom_kappa_shear::kappa_shear_cs::kappa_tol_err

The fractional error in kappa that is tolerated [nondim].

Definition at line 61 of file MOM_kappa_shear.F90.

61  real :: kappa_tol_err !< The fractional error in kappa that is tolerated [nondim].

◆ kappa_trunc

real mom_kappa_shear::kappa_shear_cs::kappa_trunc

Diffusivities smaller than this are rounded to 0 [Z2 T-1 ~> m2 s-1].

Definition at line 60 of file MOM_kappa_shear.F90.

60  real :: kappa_trunc !< Diffusivities smaller than this are rounded to 0 [Z2 T-1 ~> m2 s-1].

◆ ks_at_vertex

logical mom_kappa_shear::kappa_shear_cs::ks_at_vertex

If true, do the calculations of the shear-driven mixing at the cell vertices (i.e., the vorticity points).

Definition at line 74 of file MOM_kappa_shear.F90.

74  logical :: KS_at_vertex !< If true, do the calculations of the shear-driven mixing

◆ lambda

real mom_kappa_shear::kappa_shear_cs::lambda

The coefficient for the buoyancy length scale in the kappa equation [nondim]. The values found by Jackson et al. are 0.82-0.81.

Definition at line 52 of file MOM_kappa_shear.F90.

52  real :: lambda !< The coefficient for the buoyancy length scale

◆ lambda2_n_s

real mom_kappa_shear::kappa_shear_cs::lambda2_n_s

The square of the ratio of the coefficients of the buoyancy and shear scales in the diffusivity equation, 0 to eliminate the shear scale [nondim].

Definition at line 55 of file MOM_kappa_shear.F90.

55  real :: lambda2_N_S !< The square of the ratio of the coefficients of

◆ max_ks_it

integer mom_kappa_shear::kappa_shear_cs::max_ks_it

The maximum number of iterations that may be used to estimate the time-averaged diffusivity.

Definition at line 69 of file MOM_kappa_shear.F90.

69  integer :: max_KS_it !< The maximum number of iterations that may be used

◆ max_rino_it

integer mom_kappa_shear::kappa_shear_cs::max_rino_it

The maximum number of iterations that may be used to estimate the instantaneous shear-driven mixing.

Definition at line 67 of file MOM_kappa_shear.F90.

67  integer :: max_RiNo_it !< The maximum number of iterations that may be used

◆ nkml

integer mom_kappa_shear::kappa_shear_cs::nkml

The number of layers in the mixed layer, as treated in this routine. If the pieces of the mixed layer are not to be treated collectively, nkml is set to 1.

Definition at line 63 of file MOM_kappa_shear.F90.

63  integer :: nkml !< The number of layers in the mixed layer, as

◆ prandtl_turb

real mom_kappa_shear::kappa_shear_cs::prandtl_turb

Prandtl number used to convert Kd_shear into viscosity [nondim].

Definition at line 62 of file MOM_kappa_shear.F90.

62  real :: Prandtl_turb !< Prandtl number used to convert Kd_shear into viscosity [nondim].

◆ rino_crit

real mom_kappa_shear::kappa_shear_cs::rino_crit

The critical shear Richardson number for shear-entrainment [nondim]. The theoretical value is 0.25. The values found by Jackson et al. are 0.25-0.35.

Definition at line 36 of file MOM_kappa_shear.F90.

36  real :: RiNo_crit !< The critical shear Richardson number for

◆ shearmix_rate

real mom_kappa_shear::kappa_shear_cs::shearmix_rate

A nondimensional rate scale for shear-driven entrainment [nondim]. The value given by Jackson et al. is 0.085-0.089.

Definition at line 39 of file MOM_kappa_shear.F90.

39  real :: Shearmix_rate !< A nondimensional rate scale for shear-driven

◆ tke_bg

real mom_kappa_shear::kappa_shear_cs::tke_bg

The background level of TKE [Z2 T-2 ~> m2 s-2].

Definition at line 58 of file MOM_kappa_shear.F90.

58  real :: TKE_bg !< The background level of TKE [Z2 T-2 ~> m2 s-2].

◆ vel_underflow

real mom_kappa_shear::kappa_shear_cs::vel_underflow

Velocity components smaller than vel_underflow are set to 0 [L T-1 ~> m s-1].

Definition at line 79 of file MOM_kappa_shear.F90.

79  real :: vel_underflow !< Velocity components smaller than vel_underflow

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