mom_eos::calculate_spec_vol Interface Reference

Detailed Description

Calculates specific volume of sea water from T, S and P.

Definition at line 65 of file MOM_EOS.F90.

Private functions
subroutine	calculate_spec_vol_scalar (T, S, pressure, specvol, EOS, spv_ref)
	Calls the appropriate subroutine to calculate specific volume of sea water for scalar inputs. More...
subroutine	calculate_spec_vol_array (T, S, pressure, specvol, start, npts, EOS, spv_ref)
	Calls the appropriate subroutine to calculate the specific volume of sea water for 1-D array inputs. More...

Functions and subroutines

calculate_spec_vol_array()

subroutine mom_eos::calculate_spec_vol::calculate_spec_vol_array ( real, dimension(:), intent(in)  T, real, dimension(:), intent(in)  S, real, dimension(:), intent(in)  pressure, real, dimension(:), intent(out)  specvol, integer, intent(in)  start, integer, intent(in)  npts, type(eos_type), pointer  EOS, real, intent(in), optional  spv_ref  )

private

Calls the appropriate subroutine to calculate the specific volume of sea water for 1-D array inputs.

Parameters

[in]	t	potential temperature relative to the surface [degC].
[in]	s	salinity [ppt].
[in]	pressure	pressure [Pa].
[out]	specvol	in situ specific volume [kg m-3].
[in]	start	the starting point in the arrays.
[in]	npts	the number of values to calculate.
	eos	Equation of state structure
[in]	spv_ref	A reference specific volume [m3 kg-1].

Definition at line 240 of file MOM_EOS.F90.

  real, dimension(:), intent(in)  :: T        !< potential temperature relative to the surface
                                              !! [degC].
  real, dimension(:), intent(in)  :: S        !< salinity [ppt].
  real, dimension(:), intent(in)  :: pressure !< pressure [Pa].
  real, dimension(:), intent(out) :: specvol  !< in situ specific volume [kg m-3].
  integer,            intent(in)  :: start    !< the starting point in the arrays.
  integer,            intent(in)  :: npts     !< the number of values to calculate.
  type(EOS_type),     pointer     :: EOS      !< Equation of state structure
  real,     optional, intent(in)  :: spv_ref  !< A reference specific volume [m3 kg-1].
 
  real, dimension(size(specvol)) :: rho
 
 
  if (.not.associated(eos)) call mom_error(fatal, &
    "calculate_spec_vol_array called with an unassociated EOS_type EOS.")
 
  select case (eos%form_of_EOS)
    case (eos_linear)
      call calculate_spec_vol_linear(t, s, pressure, specvol, start, npts, &
               eos%rho_T0_S0, eos%drho_dT, eos%drho_dS, spv_ref)
    case (eos_unesco)
      call calculate_spec_vol_unesco(t, s, pressure, specvol, start, npts, spv_ref)
    case (eos_wright)
      call calculate_spec_vol_wright(t, s, pressure, specvol, start, npts, spv_ref)
    case (eos_teos10)
      call calculate_spec_vol_teos10(t, s, pressure, specvol, start, npts, spv_ref)
    case (eos_nemo)
      call calculate_density_nemo  (t, s, pressure, rho, start, npts)
      if (present(spv_ref)) then
        specvol(:) = 1.0 / rho(:) - spv_ref
      else
        specvol(:) = 1.0 / rho(:)
      endif
    case default
      call mom_error(fatal, &
           "calculate_spec_vol_array: EOS%form_of_EOS is not valid.")
  end select
 

calculate_spec_vol_scalar()

subroutine mom_eos::calculate_spec_vol::calculate_spec_vol_scalar ( real, intent(in)  T, real, intent(in)  S, real, intent(in)  pressure, real, intent(out)  specvol, type(eos_type), pointer  EOS, real, intent(in), optional  spv_ref  )

private

Calls the appropriate subroutine to calculate specific volume of sea water for scalar inputs.

Parameters

[in]	t	Potential temperature referenced to the surface [degC]
[in]	s	Salinity [ppt]
[in]	pressure	Pressure [Pa]
[out]	specvol	specific volume (in-situ if pressure is local) [m3 kg-1]
	eos	Equation of state structure
[in]	spv_ref	A reference specific volume [m3 kg-1].

Definition at line 200 of file MOM_EOS.F90.

  real,           intent(in)  :: T !< Potential temperature referenced to the surface [degC]
  real,           intent(in)  :: S !< Salinity [ppt]
  real,           intent(in)  :: pressure !< Pressure [Pa]
  real,           intent(out) :: specvol  !< specific volume (in-situ if pressure is local) [m3 kg-1]
  type(EOS_type), pointer     :: EOS      !< Equation of state structure
  real, optional, intent(in)  :: spv_ref  !< A reference specific volume [m3 kg-1].
 
  real :: rho
 
  if (.not.associated(eos)) call mom_error(fatal, &
    "calculate_spec_vol_scalar called with an unassociated EOS_type EOS.")
 
  select case (eos%form_of_EOS)
    case (eos_linear)
      call calculate_spec_vol_linear(t, s, pressure, specvol, &
               eos%rho_T0_S0, eos%drho_dT, eos%drho_dS, spv_ref)
    case (eos_unesco)
      call calculate_spec_vol_unesco(t, s, pressure, specvol, spv_ref)
    case (eos_wright)
      call calculate_spec_vol_wright(t, s, pressure, specvol, spv_ref)
    case (eos_teos10)
      call calculate_spec_vol_teos10(t, s, pressure, specvol, spv_ref)
    case (eos_nemo)
      call calculate_density_nemo(t, s, pressure, rho)
      if (present(spv_ref)) then
        specvol = 1.0 / rho - spv_ref
      else
        specvol = 1.0 / rho
      endif
    case default
      call mom_error(fatal, &
           "calculate_spec_vol_scalar: EOS is not valid.")
  end select
 

---

The documentation for this interface was generated from the following file:

• /home/docs/checkouts/readthedocs.org/user_builds/mom6-doctesting/checkouts/brokenbreathe/src/equation_of_state/MOM_EOS.F90