mom_eos::calculate_density Interface Reference

Detailed Description

Calculates density of sea water from T, S and P.

Definition at line 45 of file MOM_EOS.F90.

Private functions
subroutine	calculate_density_scalar (T, S, pressure, rho, EOS)
	Calls the appropriate subroutine to calculate density of sea water for scalar inputs. More...
subroutine	calculate_density_array (T, S, pressure, rho, start, npts, EOS)
	Calls the appropriate subroutine to calculate the density of sea water for 1-D array inputs. More...

Functions and subroutines

calculate_density_array()

subroutine mom_eos::calculate_density::calculate_density_array ( real, dimension(:), intent(in)  T, real, dimension(:), intent(in)  S, real, dimension(:), intent(in)  pressure, real, dimension(:), intent(out)  rho, integer, intent(in)  start, integer, intent(in)  npts, type(eos_type), pointer  EOS  )

private

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

Parameters

[in]	t	Potential temperature referenced to the surface (degC)
[in]	s	Salinity (PSU)
[in]	pressure	Pressure (Pa)
[out]	rho	Density (in-situ if pressure is local) (kg m-3)
[in]	start	Start index for computation
[in]	npts	Number of point to compute
	eos	Equation of state structure

Definition at line 130 of file MOM_EOS.F90.

  real, dimension(:), intent(in)  :: t !< Potential temperature referenced to the surface (degC)
  real, dimension(:), intent(in)  :: s !< Salinity (PSU)
  real, dimension(:), intent(in)  :: pressure !< Pressure (Pa)
  real, dimension(:), intent(out) :: rho !< Density (in-situ if pressure is local) (kg m-3)
  integer,            intent(in)  :: start !< Start index for computation
  integer,            intent(in)  :: npts !< Number of point to compute
  type(eos_type),     pointer     :: eos !< Equation of state structure

  if (.not.associated(eos)) call mom_error(fatal, &
    "calculate_density_array called with an unassociated EOS_type EOS.")

  select case (eos%form_of_EOS)
    case (eos_linear)
      call calculate_density_array_linear(t, s, pressure, rho, start, npts, &
                                      eos%Rho_T0_S0, eos%dRho_dT, eos%dRho_dS)
    case (eos_unesco)
      call calculate_density_array_unesco(t, s, pressure, rho, start, npts)
    case (eos_wright)
      call calculate_density_array_wright(t, s, pressure, rho, start, npts)
    case (eos_teos10)
      call calculate_density_array_teos10(t, s, pressure, rho, start, npts)
    case (eos_nemo)
      call calculate_density_array_nemo  (t, s, pressure, rho, start, npts)
    case default
      call mom_error(fatal, &
           "calculate_density_array: EOS%form_of_EOS is not valid.")
  end select

calculate_density_scalar()

subroutine mom_eos::calculate_density::calculate_density_scalar ( real, intent(in)  T, real, intent(in)  S, real, intent(in)  pressure, real, intent(out)  rho, type(eos_type), pointer  EOS  )

private

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

Parameters

[in]	t	Potential temperature referenced to the surface (degC)
[in]	s	Salinity (PSU)
[in]	pressure	Pressure (Pa)
[out]	rho	Density (in-situ if pressure is local) (kg m-3)
	eos	Equation of state structure

Definition at line 100 of file MOM_EOS.F90.

  real,           intent(in)  :: t !< Potential temperature referenced to the surface (degC)
  real,           intent(in)  :: s !< Salinity (PSU)
  real,           intent(in)  :: pressure !< Pressure (Pa)
  real,           intent(out) :: rho !< Density (in-situ if pressure is local) (kg m-3)
  type(eos_type), pointer     :: eos !< Equation of state structure

  if (.not.associated(eos)) call mom_error(fatal, &
    "calculate_density_scalar called with an unassociated EOS_type EOS.")

  select case (eos%form_of_EOS)
    case (eos_linear)
      call calculate_density_scalar_linear(t, s, pressure, rho, &
                                      eos%Rho_T0_S0, eos%dRho_dT, eos%dRho_dS)
    case (eos_unesco)
      call calculate_density_scalar_unesco(t, s, pressure, rho)
    case (eos_wright)
      call calculate_density_scalar_wright(t, s, pressure, rho)
    case (eos_teos10)
      call calculate_density_scalar_teos10(t, s, pressure, rho)
    case (eos_nemo)
      call calculate_density_scalar_nemo(t, s, pressure, rho)
    case default
      call mom_error(fatal, &
           "calculate_density_scalar: EOS is not valid.")
  end select

---

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

• /home/adcroft/GitHub/workspace/Gaea-stats-MOM6-examples/MOM6-examples/src/MOM6/src/equation_of_state/MOM_EOS.F90