mom_eos::calculate_density_derivs Interface Reference

Detailed Description

Calculate the derivatives of density with temperature and salinity from T, S, and P.

Definition at line 70 of file MOM_EOS.F90.

Private functions
subroutine	calculate_density_derivs_scalar (T, S, pressure, drho_dT, drho_dS, EOS, scale)
	Calls the appropriate subroutines to calculate density derivatives by promoting a scalar to a one-element array. More...
subroutine	calculate_density_derivs_array (T, S, pressure, drho_dT, drho_dS, start, npts, EOS, scale)
	Calls the appropriate subroutine to calculate density derivatives for 1-D array inputs. More...

Functions and subroutines

calculate_density_derivs_array()

subroutine mom_eos::calculate_density_derivs::calculate_density_derivs_array ( real, dimension(:), intent(in)  T, real, dimension(:), intent(in)  S, real, dimension(:), intent(in)  pressure, real, dimension(:), intent(out)  drho_dT, real, dimension(:), intent(out)  drho_dS, integer, intent(in)  start, integer, intent(in)  npts, type(eos_type), pointer  EOS, real, intent(in), optional  scale  )

private

Calls the appropriate subroutine to calculate density derivatives for 1-D array inputs.

Parameters

[in]	t	Potential temperature referenced to the surface [degC]
[in]	s	Salinity [ppt]
[in]	pressure	Pressure [Pa]
[out]	drho_dt	The partial derivative of density with potential temperature [kg m-3 degC-1] or [R degC-1 ~> kg m-3 degC-1].
[out]	drho_ds	The partial derivative of density with salinity, in [kg m-3 ppt-1] or [R degC-1 ~> kg m-3 ppt-1].
[in]	start	Starting index within the array
[in]	npts	The number of values to calculate
	eos	Equation of state structure
[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 367 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) :: drho_dT !< The partial derivative of density with potential
                                             !! temperature [kg m-3 degC-1] or [R degC-1 ~> kg m-3 degC-1].
  real, dimension(:), intent(out) :: drho_dS !< The partial derivative of density with salinity,
                                             !! in [kg m-3 ppt-1] or [R degC-1 ~> kg m-3 ppt-1].
  integer,            intent(in)  :: start !< Starting index within the array
  integer,            intent(in)  :: npts !< The number of values to calculate
  type(EOS_type),     pointer     :: EOS !< Equation of state structure
  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_derivs called with an unassociated EOS_type EOS.")
 
  select case (eos%form_of_EOS)
    case (eos_linear)
      call calculate_density_derivs_linear(t, s, pressure, drho_dt, drho_ds, eos%Rho_T0_S0, &
                                           eos%dRho_dT, eos%dRho_dS, start, npts)
    case (eos_unesco)
      call calculate_density_derivs_unesco(t, s, pressure, drho_dt, drho_ds, start, npts)
    case (eos_wright)
      call calculate_density_derivs_wright(t, s, pressure, drho_dt, drho_ds, start, npts)
    case (eos_teos10)
      call calculate_density_derivs_teos10(t, s, pressure, drho_dt, drho_ds, start, npts)
    case (eos_nemo)
      call calculate_density_derivs_nemo(t, s, pressure, drho_dt, drho_ds, start, npts)
    case default
      call mom_error(fatal, &
           "calculate_density_derivs_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
    drho_dt(j) = scale * drho_dt(j)
    drho_ds(j) = scale * drho_ds(j)
  enddo ; endif ; endif
 

calculate_density_derivs_scalar()

subroutine mom_eos::calculate_density_derivs::calculate_density_derivs_scalar ( real, intent(in)  T, real, intent(in)  S, real, intent(in)  pressure, real, intent(out)  drho_dT, real, intent(out)  drho_dS, type(eos_type), pointer  EOS, real, intent(in), optional  scale  )

private

Calls the appropriate subroutines to calculate density derivatives by promoting a scalar to a one-element array.

Parameters

[in]	t	Potential temperature referenced to the surface [degC]
[in]	s	Salinity [ppt]
[in]	pressure	Pressure [Pa]
[out]	drho_dt	The partial derivative of density with potential temperature [kg m-3 degC-1] or [R degC-1 ~> kg m-3 degC-1]
[out]	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
[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 411 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) :: drho_dT !< The partial derivative of density with potential
                                         !! temperature [kg m-3 degC-1] or [R degC-1 ~> kg m-3 degC-1]
  real,           intent(out) :: drho_dS !< The partial derivative of density with salinity,
                                         !! in [kg m-3 ppt-1] or [R ppt-1 ~> kg m-3 ppt-1].
  type(EOS_type), pointer     :: EOS !< Equation of state structure
  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_derivs called with an unassociated EOS_type EOS.")
 
  select case (eos%form_of_EOS)
    case (eos_linear)
      call calculate_density_derivs_linear(t, s, pressure, drho_dt, drho_ds, &
                                           eos%Rho_T0_S0, eos%dRho_dT, eos%dRho_dS)
    case (eos_wright)
      call calculate_density_derivs_wright(t, s, pressure, drho_dt, drho_ds)
    case (eos_teos10)
      call calculate_density_derivs_teos10(t, s, pressure, drho_dt, drho_ds)
    case default
      call mom_error(fatal, &
           "calculate_density_derivs_scalar: EOS%form_of_EOS is not valid.")
  end select
 
  if (present(scale)) then ; if (scale /= 1.0) then
    drho_dt = scale * drho_dt
    drho_ds = scale * drho_ds
  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