mom_wave_speed mom_wave_speed::wave_speed_cs subroutine, public subroutine, public mom_wave_speed::wave_speed (h, tv, G, GV, US, cg1, CS, full_halos, use_ebt_mode, mono_N2_column_fraction, mono_N2_depth, modal_structure, better_speed_est, min_speed, wave_speed_tol) wave_speed h h tv tv G G GV GV US US cg1 cg1 CS CS full_halos full_halos use_ebt_mode use_ebt_mode mono_N2_column_fraction mono_N2_column_fraction mono_N2_depth mono_N2_depth modal_structure modal_structure better_speed_est better_speed_est min_speed min_speed wave_speed_tol wave_speed_tol Calculates the wave speed of the first baroclinic mode. 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 cg1 First mode internal wave speed [L T-1 ~> m s-1] cs Control structure for MOM_wave_speed full_halos If true, do the calculation over the entire computational domain. use_ebt_mode If true, use the equivalent barotropic mode instead of the first baroclinic mode. mono_n2_column_fraction The lower fraction of water column over which N2 is limited as monotonic for the purposes of calculating vertical modal structure. mono_n2_depth A depth below which N2 is limited as monotonic for the purposes of calculating vertical modal structure [Z ~> m]. modal_structure Normalized model structure [nondim] better_speed_est If true, use a more robust estimate of the first mode speed as the starting point for iterations. min_speed If present, set a floor in the first mode speed below which 0 is returned [L T-1 ~> m s-1]. wave_speed_tol The fractional tolerance for finding the wave speeds [nondim] mom_error_handler::mom_error mom_remapping::remapping_core_h tdma6 tridiag_det mom_lateral_mixing_coeffs::calc_resoln_function mom_diagnostics::calculate_diagnostic_fields subroutine subroutine mom_wave_speed::tdma6 (n, a, c, lam, y) tdma6 n n a a c c lam lam y y Solve a non-symmetric tridiagonal problem with the sum of the upper and lower diagnonals minus a scalar contribution as the leading diagonal. This uses the Thomas algorithm rather than the Hallberg algorithm since the matrix is not symmetric. n Number of rows of matrix a Lower diagonal [T2 L-2 ~> s2 m-2] c Upper diagonal [T2 L-2 ~> s2 m-2] lam Scalar subtracted from leading diagonal [T2 L-2 ~> s2 m-2] y RHS on entry, result on exit wave_speed subroutine, public subroutine, public mom_wave_speed::wave_speeds (h, tv, G, GV, US, nmodes, cn, CS, full_halos, better_speed_est, min_speed, wave_speed_tol) wave_speeds h h tv tv G G GV GV US US nmodes nmodes cn cn CS CS full_halos full_halos better_speed_est better_speed_est min_speed min_speed wave_speed_tol wave_speed_tol Calculates the wave speeds for the first few barolinic modes. 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 nmodes Number of modes cn Waves speeds [L T-1 ~> m s-1] cs Control structure for MOM_wave_speed full_halos If true, do the calculation over the entire computational domain. better_speed_est If true, use a more robust estimate of the first mode speed as the starting point for iterations. min_speed If present, set a floor in the first mode speed below which 0 is returned [L T-1 ~> m s-1]. wave_speed_tol The fractional tolerance for finding the wave speeds [nondim] mom_error_handler::mom_error tridiag_det mom_diabatic_driver::diabatic subroutine subroutine mom_wave_speed::tridiag_det (a, c, ks, ke, lam, det, ddet, row_scale) tridiag_det a a c c ks ks ke ke lam lam det det ddet ddet row_scale row_scale Calculate the determinant of a tridiagonal matrix with diagonals a,b-lam,c and its derivative with lam, where lam is constant across rows. Only the ratio of det to its derivative and their signs are typically used, so internal rescaling by consistent factors are used to avoid over- or underflow. a Lower diagonal of matrix (first entry unused) c Upper diagonal of matrix (last entry unused) ks Starting index to use in determinant ke Ending index to use in determinant lam Value subtracted from b det Determinant ddet Derivative of determinant with lam row_scale A scaling factor of the rows of the matrix to limit the growth of the determinant wave_speed wave_speeds subroutine, public subroutine, public mom_wave_speed::wave_speed_init (CS, use_ebt_mode, mono_N2_column_fraction, mono_N2_depth, remap_answers_2018, better_speed_est, min_speed, wave_speed_tol) wave_speed_init CS CS use_ebt_mode use_ebt_mode mono_N2_column_fraction mono_N2_column_fraction mono_N2_depth mono_N2_depth remap_answers_2018 remap_answers_2018 better_speed_est better_speed_est min_speed min_speed wave_speed_tol wave_speed_tol Initialize control structure for MOM_wave_speed. cs Control structure for MOM_wave_speed use_ebt_mode If true, use the equivalent barotropic mode instead of the first baroclinic mode. mono_n2_column_fraction The lower fraction of water column over which N2 is limited as monotonic for the purposes of calculating the vertical modal structure. mono_n2_depth The depth below which N2 is limited as monotonic for the purposes of calculating the vertical modal structure [Z ~> m]. remap_answers_2018 If true, use the order of arithmetic and expressions that recover the remapping answers from 2018. Otherwise use more robust but mathematically equivalent expressions. better_speed_est If true, use a more robust estimate of the first mode speed as the starting point for iterations. min_speed If present, set a floor in the first mode speed below which 0 is returned [L T-1 ~> m s-1]. wave_speed_tol The fractional tolerance for finding the wave speeds [nondim] mom_remapping::initialize_remapping mom_error_handler::mom_error wave_speed_set_param mom_diagnostics::mom_diagnostics_init mom_lateral_mixing_coeffs::varmix_init subroutine, public subroutine, public mom_wave_speed::wave_speed_set_param (CS, use_ebt_mode, mono_N2_column_fraction, mono_N2_depth, remap_answers_2018, better_speed_est, min_speed, wave_speed_tol) wave_speed_set_param CS CS use_ebt_mode use_ebt_mode mono_N2_column_fraction mono_N2_column_fraction mono_N2_depth mono_N2_depth remap_answers_2018 remap_answers_2018 better_speed_est better_speed_est min_speed min_speed wave_speed_tol wave_speed_tol Sets internal parameters for MOM_wave_speed. cs Control structure for MOM_wave_speed use_ebt_mode If true, use the equivalent barotropic mode instead of the first baroclinic mode. mono_n2_column_fraction The lower fraction of water column over which N2 is limited as monotonic for the purposes of calculating the vertical modal structure. mono_n2_depth The depth below which N2 is limited as monotonic for the purposes of calculating the vertical modal structure [Z ~> m]. remap_answers_2018 If true, use the order of arithmetic and expressions that recover the remapping answers from 2018. Otherwise use more robust but mathematically equivalent expressions. better_speed_est If true, use a more robust estimate of the first mode speed as the starting point for iterations. min_speed If present, set a floor in the first mode speed below which 0 is returned [L T-1 ~> m s-1]. wave_speed_tol The fractional tolerance for finding the wave speeds [nondim] mom_error_handler::mom_error wave_speed_init Routines for calculating baroclinic wave speeds.