mom_tidal_mixing mom_tidal_mixing::tidal_mixing_cs mom_tidal_mixing::tidal_mixing_diags character *(20), parameter character*(20), parameter mom_tidal_mixing::stlaurent_profile_string stlaurent_profile_string = "STLAURENT_02" Coded parmameters for specifying mixing schemes. tidal_mixing_init character *(20), parameter character*(20), parameter mom_tidal_mixing::polzin_profile_string polzin_profile_string = "POLZIN_09" Coded parmameters for specifying mixing schemes. tidal_mixing_init integer, parameter integer, parameter mom_tidal_mixing::stlaurent_02 stlaurent_02 = 1 Coded parmameters for specifying mixing schemes. add_int_tide_diffusivity tidal_mixing_init integer, parameter integer, parameter mom_tidal_mixing::polzin_09 polzin_09 = 2 Coded parmameters for specifying mixing schemes. add_int_tide_diffusivity tidal_mixing_init character *(20), parameter character*(20), parameter mom_tidal_mixing::simmons_scheme_string simmons_scheme_string = "SIMMONS" Coded parmameters for specifying mixing schemes. tidal_mixing_init character *(20), parameter character*(20), parameter mom_tidal_mixing::schmittner_scheme_string schmittner_scheme_string = "SCHMITTNER" Coded parmameters for specifying mixing schemes. tidal_mixing_init integer, parameter integer, parameter mom_tidal_mixing::simmons simmons = 1 Coded parmameters for specifying mixing schemes. calculate_cvmix_tidal setup_tidal_diagnostics tidal_mixing_init integer, parameter integer, parameter mom_tidal_mixing::schmittner schmittner = 2 Coded parmameters for specifying mixing schemes. calculate_cvmix_tidal setup_tidal_diagnostics tidal_mixing_init logical function, public logical function, public mom_tidal_mixing::tidal_mixing_init (Time, G, GV, US, param_file, diag, CS) tidal_mixing_init Time Time G G GV GV US US param_file param_file diag diag CS CS Initializes internal tidal dissipation scheme for diapycnal mixing. 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. TODO: add units mom_error_handler::is_root_pe mom_string_functions::lowercase mom_error_handler::mom_error polzin_09 polzin_profile_string read_tidal_energy schmittner schmittner_scheme_string simmons simmons_scheme_string stlaurent_02 stlaurent_profile_string mom_string_functions::uppercase mom_set_diffusivity::set_diffusivity_init subroutine, public subroutine, public mom_tidal_mixing::calculate_tidal_mixing (h, N2_bot, j, TKE_to_Kd, max_TKE, G, GV, US, CS, N2_lay, N2_int, Kd_lay, Kd_int, Kd_max, Kv) calculate_tidal_mixing h h N2_bot N2_bot j j TKE_to_Kd TKE_to_Kd max_TKE max_TKE G G GV GV US US CS CS N2_lay N2_lay N2_int N2_int Kd_lay Kd_lay Kd_int Kd_int Kd_max Kd_max Kv Kv Depending on whether or not CVMix is active, calls the associated subroutine to compute internal tidal dissipation and to add the effect of internal-tide-driven mixing to the layer or interface diffusivities. g The ocean's grid structure gv The ocean's vertical grid structure us A dimensional unit scaling type h Layer thicknesses [H ~> m or kg m-2] n2_bot The near-bottom squared buoyancy frequency [T-2 ~> s-2]. n2_lay The squared buoyancy frequency of the layers [T-2 ~> s-2]. n2_int The squared buoyancy frequency at the interfaces [T-2 ~> s-2]. j The j-index to work on tke_to_kd The conversion rate between the TKE dissipated within a layer and the diapycnal diffusivity within that layer, usually (~Rho_0 / (G_Earth * dRho_lay)) [Z2 T-1 / Z3 T-3 = T2 Z-1 ~> s2 m-1] max_tke The energy required to for a layer to entrain to its maximum realizable thickness [Z3 T-3 ~> m3 s-3] cs The control structure for this module kd_lay The diapycnal diffusivity in layers [Z2 T-1 ~> m2 s-1]. kd_int The diapycnal diffusivity at interfaces, kd_max The maximum increment for diapycnal diffusivity due to TKE-based processes, [Z2 T-1 ~> m2 s-1]. Set this to a negative value to have no limit. kv The "slow" vertical viscosity at each interface (not layer!) [Z2 T-1 ~> m2 s-1]. add_int_tide_diffusivity calculate_cvmix_tidal subroutine subroutine mom_tidal_mixing::calculate_cvmix_tidal (h, j, G, GV, US, CS, N2_int, Kd_lay, Kd_int, Kv) calculate_cvmix_tidal h h j j G G GV GV US US CS CS N2_int N2_int Kd_lay Kd_lay Kd_int Kd_int Kv Kv Calls the CVMix routines to compute tidal dissipation and to add the effect of internal-tide-driven mixing to the interface diffusivities. j The j-index to work on g Grid structure. gv ocean vertical grid structure us A dimensional unit scaling type cs This module's control structure. n2_int The squared buoyancy frequency at the interfaces [T-2 ~> s-2]. h Layer thicknesses [H ~> m or kg m-2]. kd_lay The diapycnal diffusivity in the layers [Z2 T-1 ~> m2 s-1]. kd_int The diapycnal diffusivity at interfaces [Z2 T-1 ~> m2 s-1]. kv The "slow" vertical viscosity at each interface (not layer!) [Z2 T-1 ~> m2 s-1]. mom_error_handler::mom_error mom_remapping::remapping_core_h schmittner simmons calculate_tidal_mixing subroutine subroutine mom_tidal_mixing::add_int_tide_diffusivity (h, N2_bot, j, TKE_to_Kd, max_TKE, G, GV, US, CS, N2_lay, Kd_lay, Kd_int, Kd_max) add_int_tide_diffusivity h h N2_bot N2_bot j j TKE_to_Kd TKE_to_Kd max_TKE max_TKE G G GV GV US US CS CS N2_lay N2_lay Kd_lay Kd_lay Kd_int Kd_int Kd_max Kd_max This subroutine adds the effect of internal-tide-driven mixing to the layer diffusivities. The mechanisms considered are (1) local dissipation of internal waves generated by the barotropic flow ("itidal"), (2) local dissipation of internal waves generated by the propagating low modes (rays) of the internal tide ("lowmode"), and (3) local dissipation of internal lee waves. Will eventually need to add diffusivity due to other wave-breaking processes (e.g. Bottom friction, Froude-number-depending breaking, PSI, etc.). g The ocean's grid structure gv The ocean's vertical grid structure us A dimensional unit scaling type h Layer thicknesses [H ~> m or kg m-2] n2_bot The near-bottom squared buoyancy frequency frequency [T-2 ~> s-2]. n2_lay The squared buoyancy frequency of the layers [T-2 ~> s-2]. j The j-index to work on tke_to_kd The conversion rate between the TKE dissipated within a layer and the diapycnal diffusivity within that layer, usually (~Rho_0 / (G_Earth * dRho_lay)) [Z2 T-1 / Z3 T-3 = T2 Z-1 ~> s2 m-1] max_tke The energy required to for a layer to entrain to its maximum realizable thickness [Z3 T-3 ~> m3 s-3] cs The control structure for this module kd_lay The diapycnal diffusivity in layers [Z2 T-1 ~> m2 s-1]. kd_int The diapycnal diffusivity at interfaces kd_max The maximum increment for diapycnal diffusivity due to TKE-based processes [Z2 T-1 ~> m2 s-1]. Set this to a negative value to have no limit. mom_error_handler::mom_error polzin_09 stlaurent_02 calculate_tidal_mixing subroutine, public subroutine, public mom_tidal_mixing::setup_tidal_diagnostics (G, CS) setup_tidal_diagnostics G G CS CS Sets up diagnostics arrays for tidal mixing. g The ocean's grid structure cs The control structure for this module mom_error_handler::mom_error schmittner simmons subroutine, public subroutine, public mom_tidal_mixing::post_tidal_diagnostics (G, GV, h, CS) post_tidal_diagnostics G G GV GV h h CS CS This subroutine offers up diagnostics of the tidal mixing. g The ocean's grid structure gv The ocean's vertical grid structure. h Layer thicknesses [H ~> m or kg m-2]. cs The control structure for this module subroutine, public subroutine, public mom_tidal_mixing::tidal_mixing_h_amp (h_amp, G, j, CS) tidal_mixing_h_amp h_amp h_amp G G j j CS CS This subroutine returns a zonal slice of the topographic roughness amplitudes. g The ocean's grid structure h_amp The topographic roughness amplitude [Z ~> m] j j-index of the row to work on cs The control structure for this module subroutine subroutine mom_tidal_mixing::read_tidal_energy (G, US, tidal_energy_type, tidal_energy_file, CS) read_tidal_energy G G US US tidal_energy_type tidal_energy_type tidal_energy_file tidal_energy_file CS CS This subroutine read tidal energy inputs from a file. g The ocean's grid structure us A dimensional unit scaling type tidal_energy_type The type of tidal energy inputs to read tidal_energy_file The file from which to read tidalinputs cs The control structure for this module mom_error_handler::mom_error read_tidal_constituents mom_string_functions::uppercase tidal_mixing_init subroutine subroutine mom_tidal_mixing::read_tidal_constituents (G, US, tidal_energy_file, CS) read_tidal_constituents G G US US tidal_energy_file tidal_energy_file CS CS This subroutine reads tidal input energy from a file by constituent. g The ocean's grid structure us A dimensional unit scaling type tidal_energy_file The file from which to read tidal energy inputs cs The control structure for this module mom_remapping::initialize_remapping mom_error_handler::mom_error read_tidal_energy subroutine, public subroutine, public mom_tidal_mixing::tidal_mixing_end (CS) tidal_mixing_end CS CS Clear pointers and deallocate memory. cs This module's control structure, which will be deallocated in this routine. mom_set_diffusivity::set_diffusivity_end Interface to vertical tidal mixing schemes including CVMix tidal mixing.