namespace mom_eos¶

Overview¶

Provides subroutines for quantities specific to the equation of state. More…

namespace mom_eos {

// interfaces

interface calculate_density;
interface calculate_density_derivs;
interface calculate_density_second_derivs;
interface calculate_spec_vol;
interface calculate_tfreeze;

// global variables

integer, parameter, public eos_linear = 1;
integer, parameter, public eos_unesco = 2;
integer, parameter, public eos_wright = 3;
integer, parameter, public eos_teos10 = 4;
integer, parameter, public eos_nemo = 5;

// global functions

subroutine, public calculate_specific_vol_derivs(
    T T,
    S S,
    pressure pressure,
    dSV_dT dSV_dT,
    dSV_dS dSV_dS,
    start start,
    npts npts,
    EOS EOS
    );

subroutine, public calculate_compress(
    T T,
    S S,
    pressure pressure,
    rho rho,
    drho_dp drho_dp,
    start start,
    npts npts,
    EOS EOS
    );

subroutine, public 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
    );

subroutine, public 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,
    HII HII,
    HIO HIO,
    EOS EOS,
    dpa dpa,
    intz_dpa intz_dpa,
    intx_dpa intx_dpa,
    inty_dpa inty_dpa,
    bathyT bathyT,
    dz_neglect dz_neglect,
    useMassWghtInterp useMassWghtInterp
    );

logical function, public query_compressible(EOS EOS);
subroutine, public eos_init(param_file param_file, EOS EOS);

subroutine, public 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
    );

subroutine, public eos_allocate(EOS EOS);
subroutine, public eos_end(EOS EOS);

subroutine, public eos_use_linear(
    Rho_T0_S0 Rho_T0_S0,
    dRho_dT dRho_dT,
    dRho_dS dRho_dS,
    EOS EOS,
    use_quadrature use_quadrature
    );

subroutine, public int_density_dz_generic(
    T T,
    S S,
    z_t z_t,
    z_b z_b,
    rho_ref rho_ref,
    rho_0 rho_0,
    G_e G_e,
    HII HII,
    HIO HIO,
    EOS EOS,
    dpa dpa,
    intz_dpa intz_dpa,
    intx_dpa intx_dpa,
    inty_dpa inty_dpa,
    bathyT bathyT,
    dz_neglect dz_neglect,
    useMassWghtInterp useMassWghtInterp
    );

subroutine, public int_density_dz_generic_plm(
    T_t T_t,
    T_b T_b,
    S_t S_t,
    S_b S_b,
    z_t z_t,
    z_b z_b,
    rho_ref rho_ref,
    rho_0 rho_0,
    G_e G_e,
    dz_subroundoff dz_subroundoff,
    bathyT bathyT,
    HII HII,
    HIO HIO,
    EOS EOS,
    dpa dpa,
    intz_dpa intz_dpa,
    intx_dpa intx_dpa,
    inty_dpa inty_dpa,
    useMassWghtInterp useMassWghtInterp
    );

subroutine, public find_depth_of_pressure_in_cell(
    T_t T_t,
    T_b T_b,
    S_t S_t,
    S_b S_b,
    z_t z_t,
    z_b z_b,
    P_t P_t,
    P_tgt P_tgt,
    rho_ref rho_ref,
    G_e G_e,
    EOS EOS,
    P_b P_b,
    z_out z_out,
    z_tol z_tol
    );

subroutine, public int_density_dz_generic_ppm(
    T T,
    T_t T_t,
    T_b T_b,
    S S,
    S_t S_t,
    S_b S_b,
    z_t z_t,
    z_b z_b,
    rho_ref rho_ref,
    rho_0 rho_0,
    G_e G_e,
    HII HII,
    HIO HIO,
    EOS EOS,
    dpa dpa,
    intz_dpa intz_dpa,
    intx_dpa intx_dpa,
    inty_dpa inty_dpa
    );

subroutine, public int_spec_vol_dp_generic(
    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_neglect dP_neglect,
    useMassWghtInterp useMassWghtInterp
    );

subroutine, public int_spec_vol_dp_generic_plm(
    T_t T_t,
    T_b T_b,
    S_t S_t,
    S_b S_b,
    p_t p_t,
    p_b p_b,
    alpha_ref alpha_ref,
    dP_neglect dP_neglect,
    bathyP bathyP,
    HI HI,
    EOS EOS,
    dza dza,
    intp_dza intp_dza,
    intx_dza intx_dza,
    inty_dza inty_dza,
    useMassWghtInterp useMassWghtInterp
    );

subroutine, public convert_temp_salt_for_teos10(T T, S S, press press, G G, kd kd, mask_z mask_z, EOS EOS);

subroutine, public 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
    );

} // namespace mom_eos

Detailed Documentation¶

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.