mom_kappa_shear::kappa_shear_cs integer integer mom_kappa_shear::kappa_shear_cs::id_kd_shear id_kd_shear = -1 Diagnostic IDs. integer integer mom_kappa_shear::kappa_shear_cs::id_tke id_tke = -1 Diagnostic IDs. integer integer mom_kappa_shear::kappa_shear_cs::id_ild2 id_ild2 = -1 Diagnostic IDs. integer integer mom_kappa_shear::kappa_shear_cs::id_dz_int id_dz_int = -1 Diagnostic IDs. real real mom_kappa_shear::kappa_shear_cs::rino_crit 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. real real mom_kappa_shear::kappa_shear_cs::shearmix_rate shearmix_rate A nondimensional rate scale for shear-driven entrainment [nondim]. The value given by Jackson et al. is 0.085-0.089. real real mom_kappa_shear::kappa_shear_cs::fri_curvature 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. real real mom_kappa_shear::kappa_shear_cs::c_n 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. real real mom_kappa_shear::kappa_shear_cs::c_s 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. real real mom_kappa_shear::kappa_shear_cs::lambda 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. real real mom_kappa_shear::kappa_shear_cs::lambda2_n_s 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]. real real mom_kappa_shear::kappa_shear_cs::tke_bg tke_bg The background level of TKE [Z2 T-2 ~> m2 s-2]. real real mom_kappa_shear::kappa_shear_cs::kappa_0 kappa_0 The background diapycnal diffusivity [Z2 T-1 ~> m2 s-1]. real real mom_kappa_shear::kappa_shear_cs::kappa_trunc kappa_trunc Diffusivities smaller than this are rounded to 0 [Z2 T-1 ~> m2 s-1]. real real mom_kappa_shear::kappa_shear_cs::kappa_tol_err kappa_tol_err The fractional error in kappa that is tolerated [nondim]. real real mom_kappa_shear::kappa_shear_cs::prandtl_turb prandtl_turb Prandtl number used to convert Kd_shear into viscosity [nondim]. integer integer mom_kappa_shear::kappa_shear_cs::nkml 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. integer integer mom_kappa_shear::kappa_shear_cs::max_rino_it max_rino_it The maximum number of iterations that may be used to estimate the instantaneous shear-driven mixing. integer integer mom_kappa_shear::kappa_shear_cs::max_ks_it max_ks_it The maximum number of iterations that may be used to estimate the time-averaged diffusivity. logical logical mom_kappa_shear::kappa_shear_cs::dkdq_iteration_bug 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. logical logical mom_kappa_shear::kappa_shear_cs::ks_at_vertex ks_at_vertex If true, do the calculations of the shear-driven mixing at the cell vertices (i.e., the vorticity points). logical logical mom_kappa_shear::kappa_shear_cs::eliminate_massless eliminate_massless If true, massless layers are merged with neighboring massive layers in this calculation. real real mom_kappa_shear::kappa_shear_cs::vel_underflow vel_underflow Velocity components smaller than vel_underflow are set to 0 [L T-1 ~> m s-1]. real real mom_kappa_shear::kappa_shear_cs::kappa_src_max_chg kappa_src_max_chg The maximum permitted increase in the kappa source within an iteration relative to the local source [nondim]. This must be greater than 1. The lower limit for the permitted fractional decrease is (1 - 0.5/kappa_src_max_chg). These limits could perhaps be made dynamic with an improved iterative solver. logical logical mom_kappa_shear::kappa_shear_cs::psurf_bug psurf_bug If true, do a simple average of the cell surface pressures to get a surface pressure at the corner if VERTEX_SHEAR=True. Otherwise mask out any land points in the average. logical logical mom_kappa_shear::kappa_shear_cs::all_layer_tke_bug all_layer_tke_bug If true, report back the latest estimate of TKE instead of the time average TKE when there is mass in all layers. Otherwise always report the time-averaged TKE, as is currently done when there are some massless layers. logical logical mom_kappa_shear::kappa_shear_cs::restrictive_tolerance_check restrictive_tolerance_check If false, uses the less restrictive tolerance check to determine if a timestep is acceptable for the KS_it outer iteration loop, as the code was originally written. True uses the more restrictive check. logical logical mom_kappa_shear::kappa_shear_cs::debug debug = .false. If true, write verbose debugging messages. type(diag_ctrl), pointer type(diag_ctrl), pointer mom_kappa_shear::kappa_shear_cs::diag diag => NULL() A structure that is used to regulate the timing of diagnostic output. This control structure holds the parameters that regulate shear mixing. real logical mom_kappa_shear::kappa_shear_cs psurf_bug restrictive_tolerance_check ks_at_vertex dkdq_iteration_bug all_layer_tke_bug eliminate_massless debug diag id_kd_shear max_rino_it id_tke nkml id_dz_int id_ild2 max_ks_it c_s fri_curvature kappa_src_max_chg vel_underflow lambda2_n_s kappa_tol_err tke_bg prandtl_turb lambda shearmix_rate ... diag_ctrl integer mom_kappa_shear::kappa_shear_csall_layer_tke_bug mom_kappa_shear::kappa_shear_csc_n mom_kappa_shear::kappa_shear_csc_s mom_kappa_shear::kappa_shear_csdebug mom_kappa_shear::kappa_shear_csdiag mom_kappa_shear::kappa_shear_csdkdq_iteration_bug mom_kappa_shear::kappa_shear_cseliminate_massless mom_kappa_shear::kappa_shear_csfri_curvature mom_kappa_shear::kappa_shear_csid_dz_int mom_kappa_shear::kappa_shear_csid_ild2 mom_kappa_shear::kappa_shear_csid_kd_shear mom_kappa_shear::kappa_shear_csid_tke mom_kappa_shear::kappa_shear_cskappa_0 mom_kappa_shear::kappa_shear_cskappa_src_max_chg mom_kappa_shear::kappa_shear_cskappa_tol_err mom_kappa_shear::kappa_shear_cskappa_trunc mom_kappa_shear::kappa_shear_csks_at_vertex mom_kappa_shear::kappa_shear_cslambda mom_kappa_shear::kappa_shear_cslambda2_n_s mom_kappa_shear::kappa_shear_csmax_ks_it mom_kappa_shear::kappa_shear_csmax_rino_it mom_kappa_shear::kappa_shear_csnkml mom_kappa_shear::kappa_shear_csprandtl_turb mom_kappa_shear::kappa_shear_cspsurf_bug mom_kappa_shear::kappa_shear_csrestrictive_tolerance_check mom_kappa_shear::kappa_shear_csrino_crit mom_kappa_shear::kappa_shear_csshearmix_rate mom_kappa_shear::kappa_shear_cstke_bg mom_kappa_shear::kappa_shear_csvel_underflow