mom_cvmix_kpp mom_cvmix_kpp::kpp_cs integer integer mom_cvmix_kpp::id_clock_kpp_calc id_clock_kpp_calc CPU time clocks. kpp_calculate kpp_init integer integer mom_cvmix_kpp::id_clock_kpp_compute_bld id_clock_kpp_compute_bld CPU time clocks. kpp_compute_bld kpp_init integer integer mom_cvmix_kpp::id_clock_kpp_smoothing id_clock_kpp_smoothing CPU time clocks. kpp_init kpp_smooth_bld integer, parameter, private integer, parameter, private mom_cvmix_kpp::nlt_shape_cvmix nlt_shape_cvmix = 0 Use the CVMix profile. kpp_init integer, parameter, private integer, parameter, private mom_cvmix_kpp::nlt_shape_linear nlt_shape_linear = 1 Linear, $ G(\sigma) = 1-\sigma $. kpp_calculate kpp_init integer, parameter, private integer, parameter, private mom_cvmix_kpp::nlt_shape_parabolic nlt_shape_parabolic = 2 Parabolic, $ G(\sigma) = (1-\sigma)^2 $. kpp_calculate kpp_init integer, parameter, private integer, parameter, private mom_cvmix_kpp::nlt_shape_cubic nlt_shape_cubic = 3 Cubic, $ G(\sigma) = 1 + (2\sigma-3) \sigma^2$. kpp_calculate kpp_init integer, parameter, private integer, parameter, private mom_cvmix_kpp::nlt_shape_cubic_lmd nlt_shape_cubic_lmd = 4 Original shape, $ G(\sigma) = \frac{27}{4} \sigma (1-\sigma)^2 $. kpp_calculate kpp_init integer, parameter, private integer, parameter, private mom_cvmix_kpp::sw_method_all_sw sw_method_all_sw = 0 Use all shortwave radiation. kpp_calculate kpp_init integer, parameter, private integer, parameter, private mom_cvmix_kpp::sw_method_mxl_sw sw_method_mxl_sw = 1 Use shortwave radiation absorbed in mixing layer. kpp_calculate kpp_init integer, parameter, private integer, parameter, private mom_cvmix_kpp::sw_method_lv1_sw sw_method_lv1_sw = 2 Use shortwave radiation absorbed in layer 1. kpp_calculate kpp_init integer, parameter, private integer, parameter, private mom_cvmix_kpp::lt_k_constant lt_k_constant = 1 Constant enhance K through column. kpp_calculate kpp_init integer, parameter, private integer, parameter, private mom_cvmix_kpp::lt_k_scaled lt_k_scaled = 2 Enhance K scales with G(sigma) kpp_calculate kpp_init integer, parameter, private integer, parameter, private mom_cvmix_kpp::lt_k_mode_constant lt_k_mode_constant = 1 Prescribed enhancement for K. kpp_calculate kpp_init integer, parameter, private integer, parameter, private mom_cvmix_kpp::lt_k_mode_vr12 lt_k_mode_vr12 = 2 Enhancement for K based on. kpp_calculate kpp_init integer, parameter, private integer, parameter, private mom_cvmix_kpp::lt_k_mode_rw16 lt_k_mode_rw16 = 3 Enhancement for K based on. kpp_calculate kpp_init integer, parameter, private integer, parameter, private mom_cvmix_kpp::lt_vt2_mode_constant lt_vt2_mode_constant = 1 Prescribed enhancement for Vt2. kpp_compute_bld kpp_init integer, parameter, private integer, parameter, private mom_cvmix_kpp::lt_vt2_mode_vr12 lt_vt2_mode_vr12 = 2 Enhancement for Vt2 based on. kpp_compute_bld kpp_init integer, parameter, private integer, parameter, private mom_cvmix_kpp::lt_vt2_mode_rw16 lt_vt2_mode_rw16 = 3 Enhancement for Vt2 based on. kpp_compute_bld kpp_init integer, parameter, private integer, parameter, private mom_cvmix_kpp::lt_vt2_mode_lf17 lt_vt2_mode_lf17 = 4 Enhancement for Vt2 based on. kpp_compute_bld kpp_init logical function, public logical function, public mom_cvmix_kpp::kpp_init (paramFile, G, GV, US, diag, Time, CS, passive, Waves) kpp_init paramFile paramFile G G GV GV US US diag diag Time Time CS CS passive passive Waves Waves Initialize the CVMix KPP module and set up diagnostics Returns True if KPP is to be used, False otherwise. paramfile File parser g Ocean grid gv Vertical grid structure. us A dimensional unit scaling type diag Diagnostics time Model time cs Control structure passive Copy of passiveMode waves Wave CS mom_file_parser::closeparameterblock id_clock_kpp_calc id_clock_kpp_compute_bld id_clock_kpp_smoothing lt_k_constant lt_k_mode_constant lt_k_mode_rw16 lt_k_mode_vr12 lt_k_scaled lt_vt2_mode_constant lt_vt2_mode_lf17 lt_vt2_mode_rw16 lt_vt2_mode_vr12 mom_error_handler::mom_error nlt_shape_cubic nlt_shape_cubic_lmd nlt_shape_cvmix nlt_shape_linear nlt_shape_parabolic mom_file_parser::openparameterblock mom_diag_mediator::register_diag_field sw_method_all_sw sw_method_lv1_sw sw_method_mxl_sw subroutine, public subroutine, public mom_cvmix_kpp::kpp_calculate (CS, G, GV, US, h, uStar, buoyFlux, Kt, Ks, Kv, nonLocalTransHeat, nonLocalTransScalar, waves) kpp_calculate CS CS G G GV GV US US h h uStar uStar buoyFlux buoyFlux Kt Kt Ks Ks Kv Kv nonLocalTransHeat nonLocalTransHeat nonLocalTransScalar nonLocalTransScalar waves waves KPP vertical diffusivity/viscosity and non-local tracer transport. cs Control structure g Ocean grid gv Ocean vertical grid us A dimensional unit scaling type waves Wave CS h Layer/level thicknesses [H ~> m or kg m-2] ustar Surface friction velocity [Z T-1 ~> m s-1] buoyflux Surface buoyancy flux [L2 T-3 ~> m2 s-3] kt (in) Vertical diffusivity of heat w/o KPP (out) Vertical diffusivity including KPP [Z2 T-1 ~> m2 s-1] ks (in) Vertical diffusivity of salt w/o KPP (out) Vertical diffusivity including KPP [Z2 T-1 ~> m2 s-1] kv (in) Vertical viscosity w/o KPP (out) Vertical viscosity including KPP [Z2 T-1 ~> m2 s-1] nonlocaltransheat Temp non-local transport [m s-1] nonlocaltransscalar scalar non-local transport [m s-1] id_clock_kpp_calc lt_k_constant lt_k_mode_constant lt_k_mode_rw16 lt_k_mode_vr12 lt_k_scaled mom_error_handler::mom_error nlt_shape_cubic nlt_shape_cubic_lmd nlt_shape_linear nlt_shape_parabolic sw_method_all_sw sw_method_lv1_sw sw_method_mxl_sw subroutine, public subroutine, public mom_cvmix_kpp::kpp_compute_bld (CS, G, GV, US, h, Temp, Salt, u, v, tv, uStar, buoyFlux, Waves) kpp_compute_bld CS CS G G GV GV US US h h Temp Temp Salt Salt u u v v tv tv uStar uStar buoyFlux buoyFlux Waves Waves Compute OBL depth. cs Control structure g Ocean grid gv Ocean vertical grid us A dimensional unit scaling type h Layer/level thicknesses [H ~> m or kg m-2] temp potential/cons temp [degC] salt Salinity [ppt] u Velocity i-component [L T-1 ~> m s-1] v Velocity j-component [L T-1 ~> m s-1] tv Thermodynamics structure. ustar Surface friction velocity [Z T-1 ~> m s-1] buoyflux Surface buoyancy flux [L2 T-3 ~> m2 s-3] waves Wave CS mom_wave_interface::get_langmuir_number id_clock_kpp_compute_bld kpp_smooth_bld lt_vt2_mode_constant lt_vt2_mode_lf17 lt_vt2_mode_rw16 lt_vt2_mode_vr12 subroutine subroutine mom_cvmix_kpp::kpp_smooth_bld (CS, G, GV, h) kpp_smooth_bld CS CS G G GV GV h h Apply a 1-1-4-1-1 Laplacian filter one time on BLD to reduce any horizontal two-grid-point noise. cs Control structure g Ocean grid gv Ocean vertical grid h Layer/level thicknesses [H ~> m or kg m-2] id_clock_kpp_smoothing kpp_compute_bld subroutine, public subroutine, public mom_cvmix_kpp::kpp_get_bld (CS, BLD, G, US, m_to_BLD_units) kpp_get_bld CS CS BLD BLD G G US US m_to_BLD_units m_to_BLD_units Copies KPP surface boundary layer depth into BLD, in units of [Z ~> m] unless other units are specified. cs Control structure for this module g Grid structure us A dimensional unit scaling type bld Boundary layer depth [Z ~> m] or other units m_to_bld_units A conversion factor from meters to the desired units for BLD mom_lateral_boundary_diffusion::lateral_boundary_diffusion mom_neutral_diffusion::neutral_diffusion_calc_coeffs subroutine, public subroutine, public mom_cvmix_kpp::kpp_nonlocaltransport_temp (CS, G, GV, h, nonLocalTrans, surfFlux, dt, scalar, C_p) kpp_nonlocaltransport_temp CS CS G G GV GV h h nonLocalTrans nonLocalTrans surfFlux surfFlux dt dt scalar scalar C_p C_p Apply KPP non-local transport of surface fluxes for temperature. cs Control structure g Ocean grid gv Ocean vertical grid h Layer/level thickness [H ~> m or kg m-2] nonlocaltrans Non-local transport [nondim] surfflux Surface flux of scalar [conc H s-1 ~> conc m s-1 or conc kg m-2 s-1] dt Time-step [s] scalar temperature c_p Seawater specific heat capacity [J kg-1 degC-1] mom_diabatic_driver::diabatic_ale mom_diabatic_driver::diabatic_ale_legacy mom_diabatic_driver::layered_diabatic subroutine, public subroutine, public mom_cvmix_kpp::kpp_nonlocaltransport_saln (CS, G, GV, h, nonLocalTrans, surfFlux, dt, scalar) kpp_nonlocaltransport_saln CS CS G G GV GV h h nonLocalTrans nonLocalTrans surfFlux surfFlux dt dt scalar scalar Apply KPP non-local transport of surface fluxes for salinity. This routine is a useful prototype for other material tracers. cs Control structure g Ocean grid gv Ocean vertical grid h Layer/level thickness [H ~> m or kg m-2] nonlocaltrans Non-local transport [nondim] surfflux Surface flux of scalar [conc H s-1 ~> conc m s-1 or conc kg m-2 s-1] dt Time-step [s] scalar Scalar (scalar units [conc]) mom_diabatic_driver::diabatic_ale mom_diabatic_driver::diabatic_ale_legacy mom_diabatic_driver::layered_diabatic subroutine, public subroutine, public mom_cvmix_kpp::kpp_end (CS) kpp_end CS CS Clear pointers, deallocate memory. cs Control structure Provides the K-Profile Parameterization (KPP) of Large et al., 1994, via CVMix.