mom_bkgnd_mixing mom_bkgnd_mixing::bkgnd_mixing_cs character(len=40) character(len=40) mom_bkgnd_mixing::mdl mdl = "MOM_bkgnd_mixing" This module's name. bkgnd_mixing_init cvmix_bkgnd_is_used subroutine, public subroutine, public mom_bkgnd_mixing::bkgnd_mixing_init (Time, G, GV, US, param_file, diag, CS) bkgnd_mixing_init Time Time G G GV GV US US param_file param_file diag diag CS CS Initialize the background mixing routine. time The current time. g Grid structure. gv Vertical grid structure. us A dimensional unit scaling type param_file Run-time parameter file handle diag Diagnostics control structure. cs This module's control structure. check_bkgnd_scheme mdl mom_error_handler::mom_error subroutine, public subroutine, public mom_bkgnd_mixing::calculate_bkgnd_mixing (h, tv, N2_lay, Kd_lay, Kd_int, Kv_bkgnd, j, G, GV, US, CS) calculate_bkgnd_mixing h h tv tv N2_lay N2_lay Kd_lay Kd_lay Kd_int Kd_int Kv_bkgnd Kv_bkgnd j j G G GV GV US US CS CS Calculates the vertical background diffusivities/viscosities. g Grid structure. gv Vertical grid structure. h Layer thickness [H ~> m or kg m-2]. tv Thermodynamics structure. n2_lay squared buoyancy frequency associated with layers [T-2 ~> s-2] kd_lay The background diapycnal diffusivity of each layer [Z2 T-1 ~> m2 s-1]. kd_int The background diapycnal diffusivity of each interface [Z2 T-1 ~> m2 s-1]. kv_bkgnd The background vertical viscosity at each interface [Z2 T-1 ~> m2 s-1] j Meridional grid index us A dimensional unit scaling type cs The control structure returned by a previous call to bkgnd_mixing_init. mom_intrinsic_functions::invcosh logical function logical function mom_bkgnd_mixing::cvmix_bkgnd_is_used (param_file) cvmix_bkgnd_is_used param_file param_file Reads the parameter "USE_CVMix_BACKGROUND" and returns state. This function allows other modules to know whether this parameterization will be used without needing to duplicate the log entry. param_file A structure to parse for run-time parameters mdl subroutine subroutine mom_bkgnd_mixing::check_bkgnd_scheme (CS, str) check_bkgnd_scheme CS CS str str Sets CSbkgnd_scheme_str to check whether multiple background diffusivity schemes are activated. The string is also for error/log messages. cs Control structure str Background scheme identifier deducted from MOM_input parameters mom_error_handler::mom_error bkgnd_mixing_init subroutine, public subroutine, public mom_bkgnd_mixing::bkgnd_mixing_end (CS) bkgnd_mixing_end CS CS Clear pointers and dealocate memory. cs Control structure for this module that will be deallocated in this subroutine mom_set_diffusivity::set_diffusivity_end Interface to background mixing schemes, including the Bryan and Lewis (1979) which is applied via CVMix.