mom_eos mom_eos::calculate_compress mom_eos::calculate_density mom_eos::calculate_density_derivs mom_eos::calculate_density_second_derivs mom_eos::calculate_spec_vol mom_eos::calculate_specific_vol_derivs mom_eos::calculate_tfreeze mom_eos::eos_type integer, parameter, public integer, parameter, public mom_eos::eos_linear eos_linear = 1 A named integer specifying an equation of state. analytic_int_density_dz analytic_int_specific_vol_dp calculate_compress_array calculate_density_array calculate_density_derivs_array calculate_density_derivs_scalar calculate_density_scalar calculate_density_second_derivs_array calculate_density_second_derivs_scalar calculate_spec_vol_array calculate_spec_vol_derivs_array calculate_stanley_density_1d calculate_stanley_density_array calculate_stanley_density_scalar eos_init eos_use_linear mom_neutral_diffusion::ndiff_unit_tests_discontinuous integer, parameter, public integer, parameter, public mom_eos::eos_unesco eos_unesco = 2 A named integer specifying an equation of state. calculate_compress_array calculate_density_array calculate_density_derivs_array calculate_density_scalar calculate_spec_vol_array calculate_spec_vol_derivs_array eos_init integer, parameter, public integer, parameter, public mom_eos::eos_wright eos_wright = 3 A named integer specifying an equation of state. analytic_int_density_dz analytic_int_specific_vol_dp calculate_compress_array calculate_density_array calculate_density_derivs_array calculate_density_derivs_scalar calculate_density_scalar calculate_density_second_derivs_array calculate_density_second_derivs_scalar calculate_spec_vol_array calculate_spec_vol_derivs_array calculate_stanley_density_1d calculate_stanley_density_array calculate_stanley_density_scalar eos_init integer, parameter, public integer, parameter, public mom_eos::eos_teos10 eos_teos10 = 4 A named integer specifying an equation of state. calculate_compress_array calculate_density_array calculate_density_derivs_array calculate_density_derivs_scalar calculate_density_scalar calculate_density_second_derivs_array calculate_density_second_derivs_scalar calculate_spec_vol_array calculate_spec_vol_derivs_array calculate_stanley_density_1d calculate_stanley_density_array calculate_stanley_density_scalar convert_temp_salt_for_teos10 eos_init integer, parameter, public integer, parameter, public mom_eos::eos_nemo eos_nemo = 5 A named integer specifying an equation of state. calculate_compress_array calculate_density_array calculate_density_derivs_array calculate_density_scalar calculate_spec_vol_array calculate_spec_vol_derivs_array convert_temp_salt_for_teos10 eos_init character *(10), parameter character*(10), parameter mom_eos::eos_linear_string eos_linear_string = "LINEAR" A string for specifying the equation of state. eos_init character *(10), parameter character*(10), parameter mom_eos::eos_unesco_string eos_unesco_string = "UNESCO" A string for specifying the equation of state. eos_init character *(10), parameter character*(10), parameter mom_eos::eos_wright_string eos_wright_string = "WRIGHT" A string for specifying the equation of state. eos_init character *(10), parameter character*(10), parameter mom_eos::eos_teos10_string eos_teos10_string = "TEOS10" A string for specifying the equation of state. eos_init character *(10), parameter character*(10), parameter mom_eos::eos_nemo_string eos_nemo_string = "NEMO" A string for specifying the equation of state. eos_init character *(10), parameter character*(10), parameter mom_eos::eos_default eos_default = EOS_WRIGHT_STRING The default equation of state. eos_init integer, parameter integer, parameter mom_eos::tfreeze_linear tfreeze_linear = 1 A named integer specifying a freezing point expression. calculate_tfreeze_array calculate_tfreeze_scalar eos_init integer, parameter integer, parameter mom_eos::tfreeze_millero tfreeze_millero = 2 A named integer specifying a freezing point expression. calculate_tfreeze_array calculate_tfreeze_scalar eos_init integer, parameter integer, parameter mom_eos::tfreeze_teos10 tfreeze_teos10 = 3 A named integer specifying a freezing point expression. calculate_tfreeze_array calculate_tfreeze_scalar eos_init character *(10), parameter character*(10), parameter mom_eos::tfreeze_linear_string tfreeze_linear_string = "LINEAR" A string for specifying the freezing point expression. eos_init character *(10), parameter character*(10), parameter mom_eos::tfreeze_millero_string tfreeze_millero_string = "MILLERO_78" A string for specifying freezing point expression. eos_init character *(10), parameter character*(10), parameter mom_eos::tfreeze_teos10_string tfreeze_teos10_string = "TEOS10" A string for specifying the freezing point expression. eos_init character *(10), parameter character*(10), parameter mom_eos::tfreeze_default tfreeze_default = TFREEZE_LINEAR_STRING The default freezing point expression. eos_init subroutine subroutine mom_eos::calculate_density_scalar (T, S, pressure, rho, EOS, rho_ref, scale) calculate_density_scalar T T S S pressure pressure rho rho EOS EOS rho_ref rho_ref scale scale Calls the appropriate subroutine to calculate density of sea water for scalar inputs. If rho_ref is present, the anomaly with respect to rho_ref is returned. The pressure and density can be rescaled with the US. If both the US and scale arguments are present the density scaling uses the product of the two scaling factors. t Potential temperature referenced to the surface [degC] s Salinity [ppt] pressure Pressure [Pa] or [R L2 T-2 ~> Pa] rho Density (in-situ if pressure is local) [kg m-3] or [R ~> kg m-3] eos Equation of state structure rho_ref A reference density [kg m-3] scale A multiplicative factor by which to scale density in combination with scaling given by US [various] eos_linear eos_nemo eos_teos10 eos_unesco eos_wright mom_error_handler::mom_error subroutine subroutine mom_eos::calculate_stanley_density_scalar (T, S, pressure, Tvar, TScov, Svar, rho, EOS, rho_ref, scale) calculate_stanley_density_scalar T T S S pressure pressure Tvar Tvar TScov TScov Svar Svar rho rho EOS EOS rho_ref rho_ref scale scale Calls the appropriate subroutine to calculate density of sea water for scalar inputs including the variance of T, S and covariance of T-S. The calculation uses only the second order correction in a series as discussed in Stanley et al., 2020. If rho_ref is present, the anomaly with respect to rho_ref is returned. The density can be rescaled using rho_ref. t Potential temperature referenced to the surface [degC] s Salinity [ppt] tvar Variance of potential temperature referenced to the surface [degC2] tscov Covariance of potential temperature and salinity [degC ppt] svar Variance of salinity [ppt2] pressure Pressure [Pa] rho Density (in-situ if pressure is local) [kg m-3] or [R ~> kg m-3] eos Equation of state structure rho_ref A reference density [kg m-3]. scale A multiplicative factor by which to scale density from kg m-3 to the desired units [R m3 kg-1] eos_linear eos_teos10 eos_wright mom_error_handler::mom_error subroutine subroutine mom_eos::calculate_density_array (T, S, pressure, rho, start, npts, EOS, rho_ref, scale) calculate_density_array T T S S pressure pressure rho rho start start npts npts EOS EOS rho_ref rho_ref scale scale Calls the appropriate subroutine to calculate the density of sea water for 1-D array inputs. If rho_ref is present, the anomaly with respect to rho_ref is returned. t Potential temperature referenced to the surface [degC] s Salinity [ppt] pressure Pressure [Pa] or [R L2 T-2 ~> Pa] rho Density (in-situ if pressure is local) [kg m-3] or [R ~> kg m-3] start Start index for computation npts Number of point to compute eos Equation of state structure rho_ref A reference density [kg m-3] scale A multiplicative factor by which to scale density in combination with scaling given by US [various] eos_linear eos_nemo eos_teos10 eos_unesco eos_wright mom_error_handler::mom_error calculate_density_1d subroutine subroutine mom_eos::calculate_stanley_density_array (T, S, pressure, Tvar, TScov, Svar, rho, start, npts, EOS, rho_ref, scale) calculate_stanley_density_array T T S S pressure pressure Tvar Tvar TScov TScov Svar Svar rho rho start start npts npts EOS EOS rho_ref rho_ref scale scale Calls the appropriate subroutine to calculate the density of sea water for 1-D array inputs including the variance of T, S and covariance of T-S. The calculation uses only the second order correction in a series as discussed in Stanley et al., 2020. If rho_ref is present, the anomaly with respect to rho_ref is returned. t Potential temperature referenced to the surface [degC] s Salinity [ppt] pressure Pressure [Pa] tvar Variance of potential temperature referenced to the surface [degC2] tscov Covariance of potential temperature and salinity [degC ppt] svar Variance of salinity [ppt2] rho Density (in-situ if pressure is local) [kg m-3] start Start index for computation npts Number of point to compute eos Equation of state structure rho_ref A reference density [kg m-3]. scale A multiplicative factor by which to scale density from kg m-3 to the desired units [R m3 kg-1] eos_linear eos_teos10 eos_wright mom_error_handler::mom_error subroutine subroutine mom_eos::calculate_density_1d (T, S, pressure, rho, EOS, dom, rho_ref, scale) calculate_density_1d T T S S pressure pressure rho rho EOS EOS dom dom rho_ref rho_ref scale scale Calls the appropriate subroutine to calculate the density of sea water for 1-D array inputs, potentially limiting the domain of indices that are worked on. If rho_ref is present, the anomaly with respect to rho_ref is returned. t Potential temperature referenced to the surface [degC] s Salinity [ppt] pressure Pressure [R L2 T-2 ~> Pa] rho Density (in-situ if pressure is local) [R ~> kg m-3] eos Equation of state structure dom The domain of indices to work on, taking into account that arrays start at 1. rho_ref A reference density [kg m-3] scale A multiplicative factor by which to scale density in combination with scaling given by US [various] calculate_density_array mom_error_handler::mom_error subroutine subroutine mom_eos::calculate_stanley_density_1d (T, S, pressure, Tvar, TScov, Svar, rho, EOS, dom, rho_ref, scale) calculate_stanley_density_1d T T S S pressure pressure Tvar Tvar TScov TScov Svar Svar rho rho EOS EOS dom dom rho_ref rho_ref scale scale Calls the appropriate subroutine to calculate the density of sea water for 1-D array inputs including the variance of T, S and covariance of T-S, potentially limiting the domain of indices that are worked on. The calculation uses only the second order correction in a series as discussed in Stanley et al., 2020. If rho_ref is present, the anomaly with respect to rho_ref is returned. t Potential temperature referenced to the surface [degC] s Salinity [ppt] pressure Pressure [R L2 T-2 ~> Pa] tvar Variance of potential temperature [degC2] tscov Covariance of potential temperature and salinity [degC ppt] svar Variance of salinity [ppt2] rho Density (in-situ if pressure is local) [R ~> kg m-3] eos Equation of state structure dom The domain of indices to work on, taking into account that arrays start at 1. rho_ref A reference density [kg m-3] scale A multiplicative factor by which to scale density in combination with scaling given by US [various] eos_linear eos_teos10 eos_wright mom_error_handler::mom_error subroutine subroutine mom_eos::calculate_spec_vol_array (T, S, pressure, specvol, start, npts, EOS, spv_ref, scale) calculate_spec_vol_array T T S S pressure pressure specvol specvol start start npts npts EOS EOS spv_ref spv_ref scale scale Calls the appropriate subroutine to calculate the specific volume of sea water for 1-D array inputs. t potential temperature relative to the surface [degC] s salinity [ppt] pressure pressure [Pa] specvol in situ specific volume [kg m-3] start the starting point in the arrays. npts the number of values to calculate. eos Equation of state structure spv_ref A reference specific volume [m3 kg-1] scale A multiplicative factor by which to scale specific volume in combination with scaling given by US [various] eos_linear eos_nemo eos_teos10 eos_unesco eos_wright mom_error_handler::mom_error calc_spec_vol_1d calc_spec_vol_scalar subroutine subroutine mom_eos::calc_spec_vol_scalar (T, S, pressure, specvol, EOS, spv_ref, scale) calc_spec_vol_scalar T T S S pressure pressure specvol specvol EOS EOS spv_ref spv_ref scale scale Calls the appropriate subroutine to calculate specific volume of sea water for scalar inputs. t Potential temperature referenced to the surface [degC] s Salinity [ppt] pressure Pressure [Pa] or [R L2 T-2 ~> Pa] specvol In situ? specific volume [m3 kg-1] or [R-1 ~> m3 kg-1] eos Equation of state structure spv_ref A reference specific volume [m3 kg-1] or [R-1 m3 kg-1] scale A multiplicative factor by which to scale specific volume in combination with scaling given by US [various] calculate_spec_vol_array mom_error_handler::mom_error subroutine subroutine mom_eos::calc_spec_vol_1d (T, S, pressure, specvol, EOS, dom, spv_ref, scale) calc_spec_vol_1d T T S S pressure pressure specvol specvol EOS EOS dom dom spv_ref spv_ref scale scale Calls the appropriate subroutine to calculate the specific volume of sea water for 1-D array inputs, potentially limiting the domain of indices that are worked on. t Potential temperature referenced to the surface [degC] s Salinity [ppt] pressure Pressure [R L2 T-2 ~> Pa] specvol In situ specific volume [R-1 ~> m3 kg-1] eos Equation of state structure dom The domain of indices to work on, taking into account that arrays start at 1. spv_ref A reference specific volume [R-1 ~> m3 kg-1] scale A multiplicative factor by which to scale output specific volume in combination with scaling given by US [various] calculate_spec_vol_array mom_error_handler::mom_error subroutine subroutine mom_eos::calculate_tfreeze_scalar (S, pressure, T_fr, EOS, pres_scale) calculate_tfreeze_scalar S S pressure pressure T_fr T_fr EOS EOS pres_scale pres_scale Calls the appropriate subroutine to calculate the freezing point for scalar inputs. s Salinity [ppt] pressure Pressure [Pa] or [other] t_fr Freezing point potential temperature referenced to the surface [degC] eos Equation of state structure pres_scale A multiplicative factor to convert pressure into Pa mom_error_handler::mom_error tfreeze_linear tfreeze_millero tfreeze_teos10 subroutine subroutine mom_eos::calculate_tfreeze_array (S, pressure, T_fr, start, npts, EOS, pres_scale) calculate_tfreeze_array S S pressure pressure T_fr T_fr start start npts npts EOS EOS pres_scale pres_scale Calls the appropriate subroutine to calculate the freezing point for a 1-D array. s Salinity [ppt] pressure Pressure [Pa] or [other] t_fr Freezing point potential temperature referenced to the surface [degC] start Starting index within the array npts The number of values to calculate eos Equation of state structure pres_scale A multiplicative factor to convert pressure into Pa. mom_error_handler::mom_error tfreeze_linear tfreeze_millero tfreeze_teos10 subroutine subroutine mom_eos::calculate_density_derivs_array (T, S, pressure, drho_dT, drho_dS, start, npts, EOS, scale) calculate_density_derivs_array T T S S pressure pressure drho_dT drho_dT drho_dS drho_dS start start npts npts EOS EOS scale scale Calls the appropriate subroutine to calculate density derivatives for 1-D array inputs. t Potential temperature referenced to the surface [degC] s Salinity [ppt] pressure Pressure [Pa] or [R L2 T-2 ~> Pa] drho_dt The partial derivative of density with potential temperature [kg m-3 degC-1] or [R degC-1 ~> kg m-3 degC-1] drho_ds The partial derivative of density with salinity, in [kg m-3 ppt-1] or [R degC-1 ~> kg m-3 ppt-1] start Starting index within the array npts The number of values to calculate eos Equation of state structure scale A multiplicative factor by which to scale density in combination with scaling given by US [various] eos_linear eos_nemo eos_teos10 eos_unesco eos_wright mom_error_handler::mom_error calculate_density_derivs_1d subroutine subroutine mom_eos::calculate_density_derivs_1d (T, S, pressure, drho_dT, drho_dS, EOS, dom, scale) calculate_density_derivs_1d T T S S pressure pressure drho_dT drho_dT drho_dS drho_dS EOS EOS dom dom scale scale Calls the appropriate subroutine to calculate density derivatives for 1-D array inputs. t Potential temperature referenced to the surface [degC] s Salinity [ppt] pressure Pressure [R L2 T-2 ~> Pa] drho_dt The partial derivative of density with potential temperature [R degC-1 ~> kg m-3 degC-1] drho_ds The partial derivative of density with salinity [R degC-1 ~> kg m-3 ppt-1] eos Equation of state structure dom The domain of indices to work on, taking into account that arrays start at 1. scale A multiplicative factor by which to scale density in combination with scaling given by US [various] calculate_density_derivs_array mom_error_handler::mom_error subroutine subroutine mom_eos::calculate_density_derivs_scalar (T, S, pressure, drho_dT, drho_dS, EOS, scale) calculate_density_derivs_scalar T T S S pressure pressure drho_dT drho_dT drho_dS drho_dS EOS EOS scale scale Calls the appropriate subroutines to calculate density derivatives by promoting a scalar to a one-element array. t Potential temperature referenced to the surface [degC] s Salinity [ppt] pressure Pressure [Pa] or [R L2 T-2 ~> Pa] drho_dt The partial derivative of density with potential temperature [kg m-3 degC-1] or [R degC-1 ~> kg m-3 degC-1] drho_ds The partial derivative of density with salinity, in [kg m-3 ppt-1] or [R ppt-1 ~> kg m-3 ppt-1] eos Equation of state structure scale A multiplicative factor by which to scale density in combination with scaling given by US [various] eos_linear eos_teos10 eos_wright mom_error_handler::mom_error subroutine subroutine mom_eos::calculate_density_second_derivs_array (T, S, pressure, drho_dS_dS, drho_dS_dT, drho_dT_dT, drho_dS_dP, drho_dT_dP, start, npts, EOS, scale) calculate_density_second_derivs_array T T S S pressure pressure drho_dS_dS drho_dS_dS drho_dS_dT drho_dS_dT drho_dT_dT drho_dT_dT drho_dS_dP drho_dS_dP drho_dT_dP drho_dT_dP start start npts npts EOS EOS scale scale Calls the appropriate subroutine to calculate density second derivatives for 1-D array inputs. t Potential temperature referenced to the surface [degC] s Salinity [ppt] pressure Pressure [Pa] or [R L2 T-2 ~> Pa] drho_ds_ds Partial derivative of beta with respect to S [kg m-3 ppt-2] or [R ppt-2 ~> kg m-3 ppt-2] drho_ds_dt Partial derivative of beta with respect to T [kg m-3 ppt-1 degC-1] or [R ppt-1 degC-1 ~> kg m-3 ppt-1 degC-1] drho_dt_dt Partial derivative of alpha with respect to T [kg m-3 degC-2] or [R degC-2 ~> kg m-3 degC-2] drho_ds_dp Partial derivative of beta with respect to pressure [kg m-3 ppt-1 Pa-1] or [R ppt-1 Pa-1 ~> kg m-3 ppt-1 Pa-1] drho_dt_dp Partial derivative of alpha with respect to pressure [kg m-3 degC-1 Pa-1] or [R degC-1 Pa-1 ~> kg m-3 degC-1 Pa-1] start Starting index within the array npts The number of values to calculate eos Equation of state structure scale A multiplicative factor by which to scale density in combination with scaling given by US [various] eos_linear eos_teos10 eos_wright mom_error_handler::mom_error subroutine subroutine mom_eos::calculate_density_second_derivs_scalar (T, S, pressure, drho_dS_dS, drho_dS_dT, drho_dT_dT, drho_dS_dP, drho_dT_dP, EOS, scale) calculate_density_second_derivs_scalar T T S S pressure pressure drho_dS_dS drho_dS_dS drho_dS_dT drho_dS_dT drho_dT_dT drho_dT_dT drho_dS_dP drho_dS_dP drho_dT_dP drho_dT_dP EOS EOS scale scale Calls the appropriate subroutine to calculate density second derivatives for scalar nputs. t Potential temperature referenced to the surface [degC] s Salinity [ppt] pressure Pressure [Pa] or [R L2 T-2 ~> Pa] drho_ds_ds Partial derivative of beta with respect to S [kg m-3 ppt-2] or [R ppt-2 ~> kg m-3 ppt-2] drho_ds_dt Partial derivative of beta with respect to T [kg m-3 ppt-1 degC-1] or [R ppt-1 degC-1 ~> kg m-3 ppt-1 degC-1] drho_dt_dt Partial derivative of alpha with respect to T [kg m-3 degC-2] or [R degC-2 ~> kg m-3 degC-2] drho_ds_dp Partial derivative of beta with respect to pressure [kg m-3 ppt-1 Pa-1] or [R ppt-1 Pa-1 ~> kg m-3 ppt-1 Pa-1] drho_dt_dp Partial derivative of alpha with respect to pressure [kg m-3 degC-1 Pa-1] or [R degC-1 Pa-1 ~> kg m-3 degC-1 Pa-1] eos Equation of state structure scale A multiplicative factor by which to scale density in combination with scaling given by US [various] eos_linear eos_teos10 eos_wright mom_error_handler::mom_error subroutine subroutine mom_eos::calculate_spec_vol_derivs_array (T, S, pressure, dSV_dT, dSV_dS, start, npts, EOS) calculate_spec_vol_derivs_array T T S S pressure pressure dSV_dT dSV_dT dSV_dS dSV_dS start start npts npts EOS EOS Calls the appropriate subroutine to calculate specific volume derivatives for an array. t Potential temperature referenced to the surface [degC] s Salinity [ppt] pressure Pressure [Pa] dsv_dt The partial derivative of specific volume with potential temperature [m3 kg-1 degC-1] dsv_ds The partial derivative of specific volume with salinity [m3 kg-1 ppt-1] start Starting index within the array npts The number of values to calculate eos Equation of state structure eos_linear eos_nemo eos_teos10 eos_unesco eos_wright mom_error_handler::mom_error calc_spec_vol_derivs_1d subroutine subroutine mom_eos::calc_spec_vol_derivs_1d (T, S, pressure, dSV_dT, dSV_dS, EOS, dom, scale) calc_spec_vol_derivs_1d T T S S pressure pressure dSV_dT dSV_dT dSV_dS dSV_dS EOS EOS dom dom scale scale Calls the appropriate subroutine to calculate specific volume derivatives for 1-d array inputs, potentially limiting the domain of indices that are worked on. t Potential temperature referenced to the surface [degC] s Salinity [ppt] pressure Pressure [R L2 T-2 ~> Pa] dsv_dt The partial derivative of specific volume with potential temperature [R-1 degC-1 ~> m3 kg-1 degC-1] dsv_ds The partial derivative of specific volume with salinity [R-1 ppt-1 ~> m3 kg-1 ppt-1] eos Equation of state structure dom The domain of indices to work on, taking into account that arrays start at 1. scale A multiplicative factor by which to scale specific volume in combination with scaling given by US [various] calculate_spec_vol_derivs_array mom_error_handler::mom_error subroutine subroutine mom_eos::calculate_compress_array (T, S, press, rho, drho_dp, start, npts, EOS) calculate_compress_array T T S S press press rho rho drho_dp drho_dp start start npts npts EOS EOS Calls the appropriate subroutine to calculate the density and compressibility for 1-D array inputs. If US is present, the units of the inputs and outputs are rescaled. t Potential temperature referenced to the surface [degC] s Salinity [PSU] press Pressure [Pa] or [R L2 T-2 ~> Pa] rho In situ density [kg m-3] or [R ~> kg m-3] drho_dp The partial derivative of density with pressure (also the inverse of the square of sound speed) [s2 m-2] or [T2 L-2] start Starting index within the array npts The number of values to calculate eos Equation of state structure mom_eos_linear::calculate_compress_linear mom_eos_nemo::calculate_compress_nemo mom_eos_unesco::calculate_compress_unesco eos_linear eos_nemo eos_teos10 eos_unesco eos_wright mom_error_handler::mom_error calculate_compress_scalar subroutine subroutine mom_eos::calculate_compress_scalar (T, S, pressure, rho, drho_dp, EOS) calculate_compress_scalar T T S S pressure pressure rho rho drho_dp drho_dp EOS EOS Calculate density and compressibility for a scalar. This just promotes the scalar to an array with a singleton dimension and calls calculate_compress_array. If US is present, the units of the inputs and outputs are rescaled. t Potential temperature referenced to the surface [degC] s Salinity [ppt] pressure Pressure [Pa] or [R L2 T-2 ~> Pa] rho In situ density [kg m-3] or [R ~> kg m-3] drho_dp The partial derivative of density with pressure (also the inverse of the square of sound speed) [s2 m-2] or [T2 L-2] eos Equation of state structure calculate_compress_array mom_error_handler::mom_error integer function, dimension(2), public integer function, dimension(2), public mom_eos::eos_domain (HI, halo) eos_domain HI HI halo halo This subroutine returns a two point integer array indicating the domain of i-indices to work on in EOS calls based on information from a hor_index type. hi The horizontal index structure halo The halo size to work on; missing is equivalent to 0. The index domain that the EOS will work on, taking into account that the arrays inside the EOS routines will start at 1. mom::adjust_ssh_for_p_atm mom_bulk_mixed_layer::bulkmixedlayer mom_forcing_type::calculatebuoyancyflux1d mom_tracer_z_init::determine_temperature mom_set_diffusivity::double_diffusion mom_entrain_diffusive::entrainment_diffusive mom_set_diffusivity::find_n2 mom_int_tide_input::find_n2_bottom mom_set_diffusivity::find_tke_to_kd mom_diabatic_driver::layered_diabatic mom_mixed_layer_restrat::mixedlayer_restrat_bml mom_mixed_layer_restrat::mixedlayer_restrat_general mom_regularize_layers::regularize_surface rgc_initialization::rgc_initialize_sponges mom_set_diffusivity::set_density_ratios mom_entrain_diffusive::set_ent_bl mom_full_convection::smoothed_drdt_drds mom_tracer_hor_diff::tracer_epipycnal_ml_diff user_change_diffusivity::user_change_diff subroutine, public subroutine, public mom_eos::analytic_int_specific_vol_dp (T, S, p_t, p_b, alpha_ref, HI, EOS, dza, intp_dza, intx_dza, inty_dza, halo_size, bathyP, dP_tiny, useMassWghtInterp) analytic_int_specific_vol_dp T T S S p_t p_t p_b p_b alpha_ref alpha_ref HI HI EOS EOS dza dza intp_dza intp_dza intx_dza intx_dza inty_dza inty_dza halo_size halo_size bathyP bathyP dP_tiny dP_tiny useMassWghtInterp useMassWghtInterp Calls the appropriate subroutine to calculate analytical and nearly-analytical integrals in pressure across layers of geopotential anomalies, which are required for calculating the finite-volume form pressure accelerations in a non-Boussinesq model. There are essentially no free assumptions, apart from the use of Boole's rule to do the horizontal integrals, and from a truncation in the series for log(1-eps/1+eps) that assumes that |eps| < 0.34. hi The horizontal index structure t Potential temperature referenced to the surface [degC] s Salinity [ppt] p_t Pressure at the top of the layer [R L2 T-2 ~> Pa] or [Pa] p_b Pressure at the bottom of the layer [R L2 T-2 ~> Pa] or [Pa] alpha_ref A mean specific volume that is subtracted out to reduce the magnitude of each of the integrals [R-1 ~> m3 kg-1] The calculation is mathematically identical with different values of alpha_ref, but this reduces the effects of roundoff. eos Equation of state structure dza The change in the geopotential anomaly across intp_dza The integral in pressure through the layer of the intx_dza The integral in x of the difference between the inty_dza The integral in y of the difference between the halo_size The width of halo points on which to calculate dza. bathyp The pressure at the bathymetry [R L2 T-2 ~> Pa] or [Pa] dp_tiny A miniscule pressure change with the same units as p_t [R L2 T-2 ~> Pa] or [Pa] usemasswghtinterp If true, uses mass weighting to interpolate T/S for top and bottom integrals. eos_linear eos_wright mom_eos_linear::int_spec_vol_dp_linear mom_error_handler::mom_error subroutine, public subroutine, public mom_eos::analytic_int_density_dz (T, S, z_t, z_b, rho_ref, rho_0, G_e, HI, EOS, dpa, intz_dpa, intx_dpa, inty_dpa, bathyT, dz_neglect, useMassWghtInterp) analytic_int_density_dz T T S S z_t z_t z_b z_b rho_ref rho_ref rho_0 rho_0 G_e G_e HI HI EOS EOS dpa dpa intz_dpa intz_dpa intx_dpa intx_dpa inty_dpa inty_dpa bathyT bathyT dz_neglect dz_neglect useMassWghtInterp useMassWghtInterp This subroutine calculates analytical and nearly-analytical integrals of pressure anomalies across layers, which are required for calculating the finite-volume form pressure accelerations in a Boussinesq model. hi Ocean horizontal index structure t Potential temperature referenced to the surface [degC] s Salinity [ppt] z_t Height at the top of the layer in depth units [Z ~> m] z_b Height at the bottom of the layer [Z ~> m] rho_ref A mean density [R ~> kg m-3] or [kg m-3], that is subtracted out to reduce the magnitude of each of the integrals. rho_0 A density [R ~> kg m-3] or [kg m-3], that is used to calculate the pressure (as p~=-z*rho_0*G_e) used in the equation of state. g_e The Earth's gravitational acceleration [L2 Z-1 T-2 ~> m s-2] or [m2 Z-1 s-2 ~> m s-2] eos Equation of state structure dpa The change in the pressure anomaly intz_dpa The integral through the thickness of the intx_dpa The integral in x of the difference between inty_dpa The integral in y of the difference between bathyt The depth of the bathymetry [Z ~> m] dz_neglect A miniscule thickness change [Z ~> m] usemasswghtinterp If true, uses mass weighting to interpolate T/S for top and bottom integrals. eos_linear eos_wright mom_error_handler::mom_error logical function, public logical function, public mom_eos::query_compressible (EOS) query_compressible EOS EOS Returns true if the equation of state is compressible (i.e. has pressure dependence) eos Equation of state structure mom_error_handler::mom_error mom_pressureforce_mont::pressureforce_mont_bouss mom_pressureforce_mont::pressureforce_mont_nonbouss subroutine, public subroutine, public mom_eos::eos_init (param_file, EOS, US) eos_init param_file param_file EOS EOS US US Initializes EOS_type by allocating and reading parameters. param_file Parameter file structure eos Equation of state structure us A dimensional unit scaling type eos_allocate eos_default eos_linear eos_linear_string eos_nemo eos_nemo_string eos_teos10 eos_teos10_string eos_unesco eos_unesco_string eos_wright eos_wright_string mom_error_handler::mom_error mom_error_handler::mom_mesg tfreeze_default tfreeze_linear tfreeze_linear_string tfreeze_millero tfreeze_millero_string tfreeze_teos10 tfreeze_teos10_string mom_string_functions::uppercase mom_ice_shelf::initialize_ice_shelf mom::initialize_mom subroutine, public subroutine, public mom_eos::eos_manual_init (EOS, form_of_EOS, form_of_TFreeze, EOS_quadrature, Compressible, Rho_T0_S0, drho_dT, dRho_dS, TFr_S0_P0, dTFr_dS, dTFr_dp) eos_manual_init EOS EOS form_of_EOS form_of_EOS form_of_TFreeze form_of_TFreeze EOS_quadrature EOS_quadrature Compressible Compressible Rho_T0_S0 Rho_T0_S0 drho_dT drho_dT dRho_dS dRho_dS TFr_S0_P0 TFr_S0_P0 dTFr_dS dTFr_dS dTFr_dp dTFr_dp Manually initialized an EOS type (intended for unit testing of routines which need a specific EOS) eos Equation of state structure form_of_eos A coded integer indicating the equation of state to use. form_of_tfreeze A coded integer indicating the expression for the potential temperature of the freezing point. eos_quadrature If true, always use the generic (quadrature) code for the integrals of density. compressible If true, in situ density is a function of pressure. rho_t0_s0 Density at T=0 degC and S=0 ppt [kg m-3] drho_dt Partial derivative of density with temperature in [kg m-3 degC-1] drho_ds Partial derivative of density with salinity in [kg m-3 ppt-1] tfr_s0_p0 The freezing potential temperature at S=0, P=0 [degC] dtfr_ds The derivative of freezing point with salinity in [degC ppt-1] dtfr_dp The derivative of freezing point with pressure in [degC Pa-1] eos_quadrature subroutine, public subroutine, public mom_eos::eos_allocate (EOS) eos_allocate EOS EOS Allocates EOS_type. eos Equation of state structure eos_init subroutine, public subroutine, public mom_eos::eos_end (EOS) eos_end EOS EOS Deallocates EOS_type. eos Equation of state structure subroutine, public subroutine, public mom_eos::eos_use_linear (Rho_T0_S0, dRho_dT, dRho_dS, EOS, use_quadrature) eos_use_linear Rho_T0_S0 Rho_T0_S0 dRho_dT dRho_dT dRho_dS dRho_dS EOS EOS use_quadrature use_quadrature Set equation of state structure (EOS) to linear with given coefficients. This routine is primarily for testing and allows a local copy of the EOS_type (EOS argument) to be set to use the linear equation of state independent from the rest of the model. rho_t0_s0 Density at T=0 degC and S=0 ppt [kg m-3] drho_dt Partial derivative of density with temperature [kg m-3 degC-1] drho_ds Partial derivative of density with salinity [kg m-3 ppt-1] use_quadrature If true, always use the generic (quadrature) code for the integrals of density. eos Equation of state structure eos_linear mom_error_handler::mom_error subroutine, public subroutine, public mom_eos::convert_temp_salt_for_teos10 (T, S, HI, kd, mask_z, EOS) convert_temp_salt_for_teos10 T T S S HI HI kd kd mask_z mask_z EOS EOS Convert T&S to Absolute Salinity and Conservative Temperature if using TEOS10. kd The number of layers to work on hi The horizontal index structure t Potential temperature referenced to the surface [degC] s Salinity [ppt] mask_z 3d mask regulating which points to convert. eos Equation of state structure eos_nemo eos_teos10 mom_error_handler::mom_error logical function, public logical function, public mom_eos::eos_quadrature (EOS) eos_quadrature EOS EOS Return value of EOS_quadrature. eos Equation of state structure eos_manual_init extract_member_eos subroutine, public subroutine, public mom_eos::extract_member_eos (EOS, form_of_EOS, form_of_TFreeze, EOS_quadrature, Compressible, Rho_T0_S0, drho_dT, dRho_dS, TFr_S0_P0, dTFr_dS, dTFr_dp) extract_member_eos EOS EOS form_of_EOS form_of_EOS form_of_TFreeze form_of_TFreeze EOS_quadrature EOS_quadrature Compressible Compressible Rho_T0_S0 Rho_T0_S0 drho_dT drho_dT dRho_dS dRho_dS TFr_S0_P0 TFr_S0_P0 dTFr_dS dTFr_dS dTFr_dp dTFr_dp Extractor routine for the EOS type if the members need to be accessed outside this module. eos Equation of state structure form_of_eos A coded integer indicating the equation of state to use. form_of_tfreeze A coded integer indicating the expression for the potential temperature of the freezing point. eos_quadrature If true, always use the generic (quadrature) code for the integrals of density. compressible If true, in situ density is a function of pressure. rho_t0_s0 Density at T=0 degC and S=0 ppt [kg m-3] drho_dt Partial derivative of density with temperature in [kg m-3 degC-1] drho_ds Partial derivative of density with salinity in [kg m-3 ppt-1] tfr_s0_p0 The freezing potential temperature at S=0, P=0 [degC] dtfr_ds The derivative of freezing point with salinity [degC PSU-1] dtfr_dp The derivative of freezing point with pressure [degC Pa-1] eos_quadrature Provides subroutines for quantities specific to the equation of state. The MOM_EOS module is a wrapper for various equations of state (e.g. Linear, Wright, UNESCO) and provides a uniform interface to the rest of the model independent of which equation of state is being used.