mom_eos::calculate_density Interface Reference

Detailed Description

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

Definition at line 60 of file MOM_EOS.F90.

Private functions
subroutine	calculate_density_scalar (T, S, pressure, rho, EOS, rho_ref, 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. More...
subroutine	calculate_density_array (T, S, pressure, rho, start, npts, EOS, rho_ref, 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. 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, real, intent(in), optional  rho_ref, real, intent(in), optional  scale  )

private

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.

Parameters

[in]	t	Potential temperature referenced to the surface [degC]
[in]	s	Salinity [ppt]
[in]	pressure	Pressure [Pa]
[out]	rho	Density (in-situ if pressure is local) [kg m-3] or [R ~> kg m-3]
[in]	start	Start index for computation
[in]	npts	Number of point to compute
	eos	Equation of state structure
[in]	rho_ref	A reference density [kg m-3].
[in]	scale	A multiplicative factor by which to scale density from kg m-3 to the desired units [R m3 kg-1]

Definition at line 177 of file MOM_EOS.F90.

  real, dimension(:), intent(in)  :: T !< Potential temperature referenced to the surface [degC]
  real, dimension(:), intent(in)  :: S !< Salinity [ppt]
  real, dimension(:), intent(in)  :: pressure !< Pressure [Pa]
  real, dimension(:), intent(out) :: rho !< Density (in-situ if pressure is local) [kg m-3] or [R ~> 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
  real,     optional, intent(in)  :: rho_ref  !< A reference density [kg m-3].
  real,     optional, intent(in)  :: scale !< A multiplicative factor by which to scale density
                                           !! from kg m-3 to the desired units [R m3 kg-1]
  integer :: j
 
  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_linear(t, s, pressure, rho, start, npts, &
                                      eos%Rho_T0_S0, eos%dRho_dT, eos%dRho_dS, rho_ref)
    case (eos_unesco)
      call calculate_density_unesco(t, s, pressure, rho, start, npts, rho_ref)
    case (eos_wright)
      call calculate_density_wright(t, s, pressure, rho, start, npts, rho_ref)
    case (eos_teos10)
      call calculate_density_teos10(t, s, pressure, rho, start, npts, rho_ref)
    case (eos_nemo)
      call calculate_density_nemo  (t, s, pressure, rho, start, npts, rho_ref)
    case default
      call mom_error(fatal, &
           "calculate_density_array: EOS%form_of_EOS is not valid.")
  end select
 
  if (present(scale)) then ; if (scale /= 1.0) then
    do j=start,start+npts-1 ; rho(j) = scale * rho(j) ; enddo
  endif ; endif
 

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, real, intent(in), optional  rho_ref, real, intent(in), optional  scale  )

private

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.

Parameters

[in]	t	Potential temperature referenced to the surface [degC]
[in]	s	Salinity [ppt]
[in]	pressure	Pressure [Pa]
[out]	rho	Density (in-situ if pressure is local) [kg m-3] or [R ~> kg m-3]
	eos	Equation of state structure
[in]	rho_ref	A reference density [kg m-3].
[in]	scale	A multiplicative factor by which to scale density from kg m-3 to the desired units [R m3 kg-1]

Definition at line 139 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) :: rho !< Density (in-situ if pressure is local) [kg m-3] or [R ~> kg m-3]
  type(EOS_type), pointer     :: EOS !< Equation of state structure
  real, optional, intent(in)  :: rho_ref  !< A reference density [kg m-3].
  real, optional, intent(in)  :: scale !< A multiplicative factor by which to scale density
                                       !! from kg m-3 to the desired units [R m3 kg-1]
 
  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_linear(t, s, pressure, rho, &
                                      eos%Rho_T0_S0, eos%dRho_dT, eos%dRho_dS, rho_ref)
    case (eos_unesco)
      call calculate_density_unesco(t, s, pressure, rho, rho_ref)
    case (eos_wright)
      call calculate_density_wright(t, s, pressure, rho, rho_ref)
    case (eos_teos10)
      call calculate_density_teos10(t, s, pressure, rho, rho_ref)
    case (eos_nemo)
      call calculate_density_nemo(t, s, pressure, rho, rho_ref)
    case default
      call mom_error(fatal, &
           "calculate_density_scalar: EOS is not valid.")
  end select
 
  if (present(scale)) then ; if (scale /= 1.0) then
    rho = scale * rho
  endif ; endif
 

---

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

• /glade/work/altuntas/cesm.sandboxes/cesm2_2_alpha_X_mom/components/mom/MOM6/src/equation_of_state/MOM_EOS.F90