mom_kappa_shear mom_kappa_shear::kappa_shear_cs subroutine, public subroutine, public mom_kappa_shear::calculate_kappa_shear (u_in, v_in, h, tv, p_surf, kappa_io, tke_io, kv_io, dt, G, GV, US, CS, initialize_all) calculate_kappa_shear u_in u_in v_in v_in h h tv tv p_surf p_surf kappa_io kappa_io tke_io tke_io kv_io kv_io dt dt G G GV GV US US CS CS initialize_all initialize_all Subroutine for calculating shear-driven diffusivity and TKE in tracer columns. g The ocean's grid structure. gv The ocean's vertical grid structure. us A dimensional unit scaling type u_in Initial zonal velocity [L T-1 ~> m s-1]. v_in Initial meridional velocity [L T-1 ~> m s-1]. h Layer thicknesses [H ~> m or kg m-2]. tv A structure containing pointers to any available thermodynamic fields. Absent fields have NULL ptrs. p_surf The pressure at the ocean surface [R L2 T-2 ~> Pa] (or NULL). kappa_io The diapycnal diffusivity at each interface tke_io The turbulent kinetic energy per unit mass at kv_io The vertical viscosity at each interface dt Time increment [T ~> s]. cs The control structure returned by a previous call to kappa_shear_init. initialize_all If present and false, the previous value of kappa is used to start the iterations kappa_shear_column subroutine, public subroutine, public mom_kappa_shear::calc_kappa_shear_vertex (u_in, v_in, h, T_in, S_in, tv, p_surf, kappa_io, tke_io, kv_io, dt, G, GV, US, CS, initialize_all) calc_kappa_shear_vertex u_in u_in v_in v_in h h T_in T_in S_in S_in tv tv p_surf p_surf kappa_io kappa_io tke_io tke_io kv_io kv_io dt dt G G GV GV US US CS CS initialize_all initialize_all Subroutine for calculating shear-driven diffusivity and TKE in corner columns. g The ocean's grid structure. gv The ocean's vertical grid structure. us A dimensional unit scaling type u_in Initial zonal velocity [L T-1 ~> m s-1]. v_in Initial meridional velocity [L T-1 ~> m s-1]. h Layer thicknesses [H ~> m or kg m-2]. t_in Layer potential temperatures [degC] s_in Layer salinities in ppt. tv A structure containing pointers to any available thermodynamic fields. Absent fields have NULL ptrs. p_surf The pressure at the ocean surface [R L2 T-2 ~> Pa] (or NULL). kappa_io The diapycnal diffusivity at each interface tke_io The turbulent kinetic energy per unit mass at kv_io The vertical viscosity at each interface [Z2 T-1 ~> m2 s-1]. dt Time increment [T ~> s]. cs The control structure returned by a previous call to kappa_shear_init. initialize_all If present and false, the previous value of kappa is used to start the iterations kappa_shear_column mom_set_diffusivity::set_diffusivity subroutine subroutine mom_kappa_shear::kappa_shear_column (kappa, tke, dt, nzc, f2, surface_pres, dz, u0xdz, v0xdz, T0xdz, S0xdz, kappa_avg, tke_avg, tv, CS, GV, US, I_Ld2_1d, dz_Int_1d) kappa_shear_column kappa kappa tke tke dt dt nzc nzc f2 f2 surface_pres surface_pres dz dz u0xdz u0xdz v0xdz v0xdz T0xdz T0xdz S0xdz S0xdz kappa_avg kappa_avg tke_avg tke_avg tv tv CS CS GV GV US US I_Ld2_1d I_Ld2_1d dz_Int_1d dz_Int_1d This subroutine calculates shear-driven diffusivity and TKE in a single column. gv The ocean's vertical grid structure. kappa The time-weighted average of kappa [Z2 T-1 ~> m2 s-1]. tke The Turbulent Kinetic Energy per unit mass at nzc The number of active layers in the column. f2 The square of the Coriolis parameter [T-2 ~> s-2]. surface_pres The surface pressure [R L2 T-2 ~> Pa]. dz The layer thickness [Z ~> m]. u0xdz The initial zonal velocity times dz [Z L T-1 ~> m2 s-1]. v0xdz The initial meridional velocity times dz [Z L T-1 ~> m2 s-1]. t0xdz The initial temperature times dz [degC Z ~> degC m]. s0xdz The initial salinity times dz [ppt Z ~> ppt m]. kappa_avg The time-weighted average of kappa [Z2 T-1 ~> m2 s-1]. tke_avg The time-weighted average of TKE [Z2 T-2 ~> m2 s-2]. dt Time increment [T ~> s]. tv A structure containing pointers to any available thermodynamic fields. Absent fields have NULL ptrs. cs The control structure returned by a previous call to kappa_shear_init. us A dimensional unit scaling type i_ld2_1d The inverse of the squared mixing length [Z-2 ~> m-2]. dz_int_1d The extent of a finite-volume space surrounding an interface, calculate_projected_state find_kappa_tke calc_kappa_shear_vertex calculate_kappa_shear subroutine subroutine mom_kappa_shear::calculate_projected_state (kappa, u0, v0, T0, S0, dt, nz, dz, I_dz_int, dbuoy_dT, dbuoy_dS, u, v, T, Sal, GV, US, N2, S2, ks_int, ke_int, vel_underflow) calculate_projected_state kappa kappa u0 u0 v0 v0 T0 T0 S0 S0 dt dt nz nz dz dz I_dz_int I_dz_int dbuoy_dT dbuoy_dT dbuoy_dS dbuoy_dS u u v v T T Sal Sal GV GV US US N2 N2 S2 S2 ks_int ks_int ke_int ke_int vel_underflow vel_underflow This subroutine calculates the velocities, temperature and salinity that the water column will have after mixing for dt with diffusivities kappa. It may also calculate the projected buoyancy frequency and shear. nz The number of layers (after eliminating massless layers?). kappa The diapycnal diffusivity at interfaces, [Z2 T-1 ~> m2 s-1]. u0 The initial zonal velocity [L T-1 ~> m s-1]. v0 The initial meridional velocity [L T-1 ~> m s-1]. t0 The initial temperature [degC]. s0 The initial salinity [ppt]. dz The grid spacing of layers [Z ~> m]. i_dz_int The inverse of the layer's thicknesses [Z-1 ~> m-1]. dbuoy_dt The partial derivative of buoyancy with temperature [Z T-2 degC-1 ~> m s-2 degC-1]. dbuoy_ds The partial derivative of buoyancy with salinity [Z T-2 ppt-1 ~> m s-2 ppt-1]. dt The time step [T ~> s]. u The zonal velocity after dt [L T-1 ~> m s-1]. v The meridional velocity after dt [L T-1 ~> m s-1]. t The temperature after dt [degC]. sal The salinity after dt [ppt]. gv The ocean's vertical grid structure. us A dimensional unit scaling type n2 The buoyancy frequency squared at interfaces [T-2 ~> s-2]. s2 The squared shear at interfaces [T-2 ~> s-2]. ks_int The topmost k-index with a non-zero diffusivity. ke_int The bottommost k-index with a non-zero diffusivity. vel_underflow If present and true, any velocities that are smaller in magnitude than this value are set to 0 [L T-1 ~> m s-1]. kappa_shear_column subroutine subroutine mom_kappa_shear::find_kappa_tke (N2, S2, kappa_in, Idz, dz_Int, I_L2_bdry, f2, nz, CS, GV, US, K_Q, tke, kappa, kappa_src, local_src) find_kappa_tke N2 N2 S2 S2 kappa_in kappa_in Idz Idz dz_Int dz_Int I_L2_bdry I_L2_bdry f2 f2 nz nz CS CS GV GV US US K_Q K_Q tke tke kappa kappa kappa_src kappa_src local_src local_src This subroutine calculates new, consistent estimates of TKE and kappa. nz The number of layers to work on. n2 The buoyancy frequency squared at interfaces [T-2 ~> s-2]. s2 The squared shear at interfaces [T-2 ~> s-2]. kappa_in The initial guess at the diffusivity [Z2 T-1 ~> m2 s-1]. dz_int The thicknesses associated with interfaces [Z-1 ~> m-1]. i_l2_bdry The inverse of the squared distance to boundaries [Z-2 ~> m-2]. idz The inverse grid spacing of layers [Z-1 ~> m-1]. f2 The squared Coriolis parameter [T-2 ~> s-2]. cs A pointer to this module's control structure. gv The ocean's vertical grid structure. us A dimensional unit scaling type k_q The shear-driven diapycnal diffusivity divided by the turbulent kinetic energy per unit mass at interfaces [T ~> s]. tke The turbulent kinetic energy per unit mass at interfaces [Z2 T-2 ~> m2 s-2]. kappa The diapycnal diffusivity at interfaces [Z2 T-1 ~> m2 s-1]. kappa_src The source term for kappa [T-1 ~> s-1]. local_src The sum of all local sources for kappa, kappa_shear_column logical function, public logical function, public mom_kappa_shear::kappa_shear_init (Time, G, GV, US, param_file, diag, CS) kappa_shear_init Time Time G G GV GV US US param_file param_file diag diag CS CS This subroutine initializes the parameters that regulate shear-driven mixing. time The current model time. g The ocean's grid structure. gv The ocean's vertical grid structure. us A dimensional unit scaling type param_file A structure to parse for run-time parameters. diag A structure that is used to regulate diagnostic output. cs A pointer that is set to point to the control structure for this module True if module is to be used, False otherwise mom_error_handler::mom_error logical function, public logical function, public mom_kappa_shear::kappa_shear_is_used (param_file) kappa_shear_is_used param_file param_file This function indicates to other modules whether the Jackson et al shear mixing parameterization will be used without needing to duplicate the log entry. param_file A structure to parse for run-time parameters mom_cvmix_shear::cvmix_shear_init mom_diabatic_driver::diabatic_driver_init mom_set_visc::set_visc_init mom_set_visc::set_visc_register_restarts logical function, public logical function, public mom_kappa_shear::kappa_shear_at_vertex (param_file) kappa_shear_at_vertex param_file param_file This function indicates to other modules whether the Jackson et al shear mixing parameterization will be used at the vertices without needing to duplicate the log entry. It returns false if the Jackson et al scheme is not used or if it is used via calculations at the tracer points. param_file A structure to parse for run-time parameters mom_set_diffusivity::set_diffusivity_init mom_set_visc::set_visc_init mom_set_visc::set_visc_register_restarts Shear-dependent mixing following Jackson et al. 2008. By Laura Jackson and Robert Hallberg, 2006-2008. This file contains the subroutines that determine the diapycnal diffusivity driven by resolved shears, as specified by the parameterizations described in Jackson and Hallberg (JPO, 2008). The technique by which the 6 equations (for kappa, TKE, u, v, T, and S) are solved simultaneously has been dramatically revised from the previous version. The previous version was not converging in some cases, especially near the surface mixed layer, while the revised version does. The revised version solves for kappa and TKE with shear and stratification fixed, then marches the density and velocities forward with an adaptive (and aggressive) time step in a predictor-corrector-corrector emulation of a trapezoidal scheme. Run-time-settable parameters determine the tolerence to which the kappa and TKE equations are solved and the minimum time step that can be taken.