mom_lateral_mixing_coeffs mom_lateral_mixing_coeffs::varmix_cs subroutine, public subroutine, public mom_lateral_mixing_coeffs::calc_depth_function (G, CS) calc_depth_function G G CS CS Calculates the non-dimensional depth functions. g Ocean grid structure cs Variable mixing coefficients mom_error_handler::mom_error mom::step_mom mom::step_offline subroutine, public subroutine, public mom_lateral_mixing_coeffs::calc_resoln_function (h, tv, G, GV, US, CS) calc_resoln_function h h tv tv G G GV GV US US CS CS Calculates and stores the non-dimensional resolution functions. g Ocean grid structure h Layer thickness [H ~> m or kg m-2] tv Thermodynamic variables gv Vertical grid structure us A dimensional unit scaling type cs Variable mixing coefficients mom_error_handler::mom_error mom_diag_mediator::query_averaging_enabled mom_wave_speed::wave_speed mom::step_mom mom::step_offline subroutine, public subroutine, public mom_lateral_mixing_coeffs::calc_slope_functions (h, tv, dt, G, GV, US, CS, OBC) calc_slope_functions h h tv tv dt dt G G GV GV US US CS CS OBC OBC Calculates and stores functions of isopycnal slopes, e.g. Sx, Sy, S*N, mostly used in the Visbeck et al. style scaling of diffusivity. g Ocean grid structure gv Vertical grid structure us A dimensional unit scaling type h Layer thickness [H ~> m or kg m-2] tv Thermodynamic variables dt Time increment [T ~> s] cs Variable mixing coefficients obc Open boundaries control structure. mom_isopycnal_slopes::calc_isoneutral_slopes calc_slope_functions_using_just_e calc_visbeck_coeffs mom_error_handler::mom_error mom_diag_mediator::query_averaging_enabled subroutine subroutine mom_lateral_mixing_coeffs::calc_visbeck_coeffs (h, slope_x, slope_y, N2_u, N2_v, G, GV, US, CS, OBC) calc_visbeck_coeffs h h slope_x slope_x slope_y slope_y N2_u N2_u N2_v N2_v G G GV GV US US CS CS OBC OBC Calculates factors used when setting diffusivity coefficients similar to Visbeck et al. g Ocean grid structure gv Vertical grid structure h Layer thickness [H ~> m or kg m-2] slope_x Zonal isoneutral slope n2_u Buoyancy (Brunt-Vaisala) frequency at u-points [T-2 ~> s-2] slope_y Meridional isoneutral slope n2_v Buoyancy (Brunt-Vaisala) frequency at v-points [T-2 ~> s-2] us A dimensional unit scaling type cs Variable mixing coefficients obc Open boundaries control structure. mom_error_handler::mom_error mom_open_boundary::obc_none mom_diag_mediator::query_averaging_enabled calc_slope_functions subroutine subroutine mom_lateral_mixing_coeffs::calc_slope_functions_using_just_e (h, G, GV, US, CS, e, calculate_slopes, OBC) calc_slope_functions_using_just_e h h G G GV GV US US CS CS e e calculate_slopes calculate_slopes OBC OBC The original calc_slope_function() that calculated slopes using interface positions only, not accounting for density variations. g Ocean grid structure h Layer thickness [H ~> m or kg m-2] gv Vertical grid structure us A dimensional unit scaling type cs Variable mixing coefficients e Interface position [Z ~> m] calculate_slopes If true, calculate slopes internally otherwise use slopes stored in CS obc Open boundaries control structure. mom_error_handler::mom_error mom_open_boundary::obc_none calc_slope_functions subroutine, public subroutine, public mom_lateral_mixing_coeffs::calc_qg_leith_viscosity (CS, G, GV, US, h, k, div_xx_dx, div_xx_dy, vort_xy_dx, vort_xy_dy) calc_qg_leith_viscosity CS CS G G GV GV US US h h k k div_xx_dx div_xx_dx div_xx_dy div_xx_dy vort_xy_dx vort_xy_dx vort_xy_dy vort_xy_dy Calculates the Leith Laplacian and bi-harmonic viscosity coefficients. cs Variable mixing coefficients g Ocean grid structure gv The ocean's vertical grid structure. us A dimensional unit scaling type h Layer thickness [H ~> m or kg m-2] k Layer for which to calculate vorticity magnitude div_xx_dx x-derivative of horizontal divergence (d/dx(du/dx + dv/dy)) [L-1 T-1 ~> m-1 s-1] div_xx_dy y-derivative of horizontal divergence (d/dy(du/dx + dv/dy)) [L-1 T-1 ~> m-1 s-1] vort_xy_dx x-derivative of vertical vorticity (d/dx(dv/dx - du/dy)) [L-1 T-1 ~> m-1 s-1] vort_xy_dy y-derivative of vertical vorticity (d/dy(dv/dx - du/dy)) [L-1 T-1 ~> m-1 s-1] mom_hor_visc::horizontal_viscosity subroutine, public subroutine, public mom_lateral_mixing_coeffs::varmix_init (Time, G, GV, US, param_file, diag, CS) varmix_init Time Time G G GV GV US US param_file param_file diag diag CS CS Initializes the variables mixing coefficients container. time Current model time g Ocean grid structure gv The ocean's vertical grid structure us A dimensional unit scaling type param_file Parameter file handles diag Diagnostics control structure cs Variable mixing coefficients mom_error_handler::mom_error mom_wave_speed::wave_speed_init Variable mixing coefficients. This module provides a container for various factors used in prescribing diffusivities, that are a function of the state (in particular the stratification and isoneutral slopes). The resolution function is expressed in terms of the ratio of grid-spacing to deformation radius. The square of the resolution parameter is \[ R^2 = \frac{L_d^2}{\Delta^2} = \frac{ c_g^2 }{ f^2 \Delta^2 + c_g \beta \Delta^2 } \] where the grid spacing is calculated as \[ \Delta^2 = \Delta x^2 + \Delta y^2 . \] TodoCheck this reference to Bob on/off paper. The resolution function used in scaling diffusivities (Hallberg, 2010) is \[ r(\Delta,L_d) = \frac{1}{1+(\alpha R)^p} \] The resolution function can be applied independently to thickness diffusion (module mom_thickness_diffuse), tracer diffusion (mom_tracer_hordiff) lateral viscosity (mom_hor_visc). Robert Hallberg, 2013: Using a resolution function to regulate parameterizations of oceanic mesoscale eddy effects. Ocean Modelling, 71, pp 92-103. http://dx.doi.org/10.1016/j.ocemod.2013.08.007 Symbol Module parameter - USE_VARIABLE_MIXING - RESOLN_SCALED_KH - RESOLN_SCALED_KHTH - RESOLN_SCALED_KHTR $ \alpha $ KH_RES_SCALE_COEF (for thickness and tracer diffusivity) $ p $ KH_RES_FN_POWER (for thickness and tracer diffusivity) $ \alpha $ VISC_RES_SCALE_COEF (for lateral viscosity) $ p $ VISC_RES_FN_POWER (for lateral viscosity) - GILL_EQUATORIAL_LD This module also calculates factors used in setting the thickness diffusivity similar to a Visbeck et al., 1997, scheme. The factors are combined in mom_thickness_diffuse::thickness_diffuse() but calculated in this module. \[ \kappa_h = \alpha_s L_s^2 S N \] where $S$ is the magnitude of the isoneutral slope and $N$ is the Brunt-Vaisala frequency. Visbeck, Marshall, Haine and Spall, 1997: Specification of Eddy Transfer Coefficients in Coarse-Resolution Ocean Circulation Models. J. Phys. Oceanogr. http://dx.doi.org/10.1175/1520-0485(1997)027%3C0381:SOETCI%3E2.0.CO;2 Symbol Module parameter - USE_VARIABLE_MIXING $ \alpha_s $ KHTH_SLOPE_CFF (for mom_thickness_diffuse module) $ \alpha_s $ KHTR_SLOPE_CFF (for mom_tracer_hordiff module) $ L_{s} $ VISBECK_L_SCALE $ S_{max} $ VISBECK_MAX_SLOPE The thickness diffusivity can be prescribed a vertical distribution with the shape of the equivalent barotropic velocity mode. The structure function is stored in the control structure for thie module (varmix_cs) but is calculated using subroutines in mom_wave_speed. Symbol Module parameter - KHTH_USE_EBT_STRUCT