mom_eos_wright Module Reference

Data Types
interface	calculate_density_wright

Functions/Subroutines
subroutine, public	calculate_density_scalar_wright (T, S, pressure, rho)
	This subroutine computes the in situ density of sea water (rho in units of kg/m^3) from salinity (S in psu), potential temperature (T in deg C), and pressure in Pa. It uses the expression from Wright, 1997, J. Atmos. Ocean. Tech., 14, 735-740. Coded by R. Hallberg, 7/00. More...
subroutine, public	calculate_density_array_wright (T, S, pressure, rho, start, npts)
	This subroutine computes the in situ density of sea water (rho in units of kg/m^3) from salinity (S in psu), potential temperature (T in deg C), and pressure in Pa. It uses the expression from Wright, 1997, J. Atmos. Ocean. Tech., 14, 735-740. Coded by R. Hallberg, 7/00. More...
subroutine, public	calculate_density_derivs_wright (T, S, pressure, drho_dT, drho_dS, start, npts)
subroutine, public	calculate_specvol_derivs_wright (T, S, pressure, dSV_dT, dSV_dS, start, npts)
subroutine, public	calculate_compress_wright (T, S, pressure, rho, drho_dp, start, npts)
	This subroutine computes the in situ density of sea water (rho in units of kg/m^3) and the compressibility (drho/dp = C_sound^-2) (drho_dp in units of s2 m-2) from salinity (sal in psu), potential temperature (T in deg C), and pressure in Pa. It uses the expressions from Wright, 1997, J. Atmos. Ocean. Tech., 14, 735-740. Coded by R. Hallberg, 1/01. More...
subroutine, public	int_density_dz_wright (T, S, z_t, z_b, rho_ref, rho_0, G_e, HII, HIO, dpa, intz_dpa, intx_dpa, inty_dpa)
	This subroutine calculates analytical and nearly-analytical integrals of pressure anomalies across layers, which are required for calculating the finite-volume form pressure accelerations in a Boussinesq model. More...
subroutine, public	int_spec_vol_dp_wright (T, S, p_t, p_b, alpha_ref, HI, dza, intp_dza, intx_dza, inty_dza, halo_size)
	This subroutine calculates analytical and nearly-analytical integrals in pressure across layers of geopotential anomalies, which are required for calculating the finite-volume form pressure accelerations in a non-Boussinesq model. There are essentially no free assumptions, apart from the use of Bode's rule to do the horizontal integrals, and from a truncation in the series for log(1-eps/1+eps) that assumes that |eps| < 0.34. More...

Variables
real, parameter	a0 = 7.057924e-4
real, parameter	a1 = 3.480336e-7
real, parameter	a2 = -1.112733e-7
real, parameter	b0 = 5.790749e8
real, parameter	b1 = 3.516535e6
real, parameter	b2 = -4.002714e4
real, parameter	b3 = 2.084372e2
real, parameter	b4 = 5.944068e5
real, parameter	b5 = -9.643486e3
real, parameter	c0 = 1.704853e5
real, parameter	c1 = 7.904722e2
real, parameter	c2 = -7.984422
real, parameter	c3 = 5.140652e-2
real, parameter	c4 = -2.302158e2
real, parameter	c5 = -3.079464

Function/Subroutine Documentation

calculate_compress_wright()

subroutine, public mom_eos_wright::calculate_compress_wright	(	real, dimension(:), intent(in)	T,
		real, dimension(:), intent(in)	S,
		real, dimension(:), intent(in)	pressure,
		real, dimension(:), intent(out)	rho,
		real, dimension(:), intent(out)	drho_dp,
		integer, intent(in)	start,
		integer, intent(in)	npts
	)

This subroutine computes the in situ density of sea water (rho in units of kg/m^3) and the compressibility (drho/dp = C_sound^-2) (drho_dp in units of s2 m-2) from salinity (sal in psu), potential temperature (T in deg C), and pressure in Pa. It uses the expressions from Wright, 1997, J. Atmos. Ocean. Tech., 14, 735-740. Coded by R. Hallberg, 1/01.

Parameters

[in]	t	Potential temperature relative to the surface in C.
[in]	s	Salinity in PSU.
[in]	pressure	Pressure in Pa.
[out]	rho	In situ density in kg m-3.
[out]	drho_dp	The partial derivative of density with pressure (also the inverse of the square of sound speed) in s2 m-2.
[in]	start	The starting point in the arrays.
[in]	npts	The number of values to calculate.

Definition at line 232 of file MOM_EOS_Wright.F90.

References a0, a1, a2, b0, b1, b2, b3, b4, b5, c0, c1, c2, c3, c4, and c5.

Referenced by mom_eos::calculate_compress().

  real,    intent(in),  dimension(:) :: t        !< Potential temperature relative to the surface
                                                 !! in C.
  real,    intent(in),  dimension(:) :: s        !< Salinity in PSU.
  real,    intent(in),  dimension(:) :: pressure !< Pressure in Pa.
  real,    intent(out), dimension(:) :: rho      !< In situ density in kg m-3.
  real,    intent(out), dimension(:) :: drho_dp  !< The partial derivative of density with pressure
                                                 !! (also the inverse of the square of sound speed)
                                                 !! in s2 m-2.
  integer, intent(in)                :: start    !< The starting point in the arrays.
  integer, intent(in)                :: npts     !< The number of values to calculate.

! * Arguments: T - potential temperature relative to the surface in C. *
! *  (in)      S - salinity in PSU.                                    *
! *  (in)      pressure - pressure in Pa.                              *
! *  (out)     rho - in situ density in kg m-3.                        *
! *  (out)     drho_dp - the partial derivative of density with        *
! *                      pressure (also the inverse of the square of   *
! *                      sound speed) in s2 m-2.                       *
! *  (in)      start - the starting point in the arrays.               *
! *  (in)      npts - the number of values to calculate.               *
! *====================================================================*
! *  This subroutine computes the in situ density of sea water (rho in *
! *  units of kg/m^3) and the compressibility (drho/dp = C_sound^-2)   *
! *  (drho_dp in units of s2 m-2) from salinity (sal in psu), potential*
! *  temperature (T in deg C), and pressure in Pa.  It uses the expres-*
! *  sions from Wright, 1997, J. Atmos. Ocean. Tech., 14, 735-740.     *
! *  Coded by R. Hallberg, 1/01                                        *
! *====================================================================*
  real :: al0, p0, lambda, i_denom
  integer :: j

  do j=start,start+npts-1
    al0 = (a0 + a1*t(j)) +a2*s(j)
    p0 = (b0 + b4*s(j)) + t(j) * (b1 + t(j)*((b2 + b3*t(j))) + b5*s(j))
    lambda = (c0 +c4*s(j)) + t(j) * (c1 + t(j)*((c2 + c3*t(j))) + c5*s(j))

    i_denom = 1.0 / (lambda + al0*(pressure(j) + p0))
    rho(j) = (pressure(j) + p0) * i_denom
    drho_dp(j) = lambda * i_denom * i_denom
  enddo

Here is the caller graph for this function:

calculate_density_array_wright()

subroutine, public mom_eos_wright::calculate_density_array_wright	(	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
	)

This subroutine computes the in situ density of sea water (rho in units of kg/m^3) from salinity (S in psu), potential temperature (T in deg C), and pressure in Pa. It uses the expression from Wright, 1997, J. Atmos. Ocean. Tech., 14, 735-740. Coded by R. Hallberg, 7/00.

Parameters

[in]	t	potential temperature relative to the surface in C.
[in]	s	salinity in PSU.
[in]	pressure	pressure in Pa.
[out]	rho	in situ density in kg m-3.
[in]	start	the starting point in the arrays.
[in]	npts	the number of values to calculate.

Definition at line 109 of file MOM_EOS_Wright.F90.

References a0, a1, a2, b0, b1, b2, b3, b4, b5, c0, c1, c2, c3, c4, and c5.

Referenced by calculate_density_scalar_wright().

  real,    intent(in),  dimension(:) :: t        !< potential temperature relative to the surface
                                                 !! in C.
  real,    intent(in),  dimension(:) :: s        !< salinity in PSU.
  real,    intent(in),  dimension(:) :: pressure !< pressure in Pa.
  real,    intent(out), dimension(:) :: rho      !< in situ density in kg m-3.
  integer, intent(in)                :: start    !< the starting point in the arrays.
  integer, intent(in)                :: npts     !< the number of values to calculate.

! * Arguments: T - potential temperature relative to the surface in C. *
! *  (in)      S - salinity in PSU.                                    *
! *  (in)      pressure - pressure in Pa.                              *
! *  (out)     rho - in situ density in kg m-3.                        *
! *  (in)      start - the starting point in the arrays.               *
! *  (in)      npts - the number of values to calculate.               *

! *====================================================================*
! *  This subroutine computes the in situ density of sea water (rho in *
! *  units of kg/m^3) from salinity (S in psu), potential temperature  *
! *  (T in deg C), and pressure in Pa.  It uses the expression from    *
! *  Wright, 1997, J. Atmos. Ocean. Tech., 14, 735-740.                *
! *  Coded by R. Hallberg, 7/00                                        *
! *====================================================================*
  real :: al0, p0, lambda
  integer :: j

  do j=start,start+npts-1
    al0 = (a0 + a1*t(j)) +a2*s(j)
    p0 = (b0 + b4*s(j)) + t(j) * (b1 + t(j)*((b2 + b3*t(j))) + b5*s(j))
    lambda = (c0 +c4*s(j)) + t(j) * (c1 + t(j)*((c2 + c3*t(j))) + c5*s(j))

    rho(j) = (pressure(j) + p0) / (lambda + al0*(pressure(j) + p0))
  enddo

Here is the caller graph for this function:

calculate_density_derivs_wright()

subroutine, public mom_eos_wright::calculate_density_derivs_wright	(	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
	)

Parameters

[in]	t	Potential temperature relative to the surface in C.
[in]	s	Salinity in PSU.
[in]	pressure	Pressure in Pa.
[out]	drho_dt	The partial derivative of density with potential temperature, in kg m-3 K-1.
[out]	drho_ds	The partial derivative of density with salinity, in kg m-3 psu-1.
[in]	start	The starting point in the arrays.
[in]	npts	The number of values to calculate.

Definition at line 145 of file MOM_EOS_Wright.F90.

References a0, a1, a2, b0, b1, b2, b3, b4, b5, c0, c1, c2, c3, c4, and c5.

  real,    intent(in),  dimension(:) :: t        !< Potential temperature relative to the surface
                                                 !! in C.
  real,    intent(in),  dimension(:) :: s        !< Salinity in PSU.
  real,    intent(in),  dimension(:) :: pressure !< Pressure in Pa.
  real,    intent(out), dimension(:) :: drho_dt  !< The partial derivative of density with potential
                                                 !! temperature, in kg m-3 K-1.
  real,    intent(out), dimension(:) :: drho_ds  !< The partial derivative of density with salinity,
                                                 !! in kg m-3 psu-1.
  integer, intent(in)                :: start    !< The starting point in the arrays.
  integer, intent(in)                :: npts     !< The number of values to calculate.

! * Arguments: T - potential temperature relative to the surface in C. *
! *  (in)      S - salinity in PSU.                                    *
! *  (in)      pressure - pressure in Pa.                              *
! *  (out)     drho_dT - the partial derivative of density with        *
! *                      potential temperature, in kg m-3 K-1.         *
! *  (out)     drho_dS - the partial derivative of density with        *
! *                      salinity, in kg m-3 psu-1.                    *
! *  (in)      start - the starting point in the arrays.               *
! *  (in)      npts - the number of values to calculate.               *
  real :: al0, p0, lambda, i_denom2
  integer :: j

  do j=start,start+npts-1
    al0 = (a0 + a1*t(j)) + a2*s(j)
    p0 = (b0 + b4*s(j)) + t(j) * (b1 + t(j)*((b2 + b3*t(j))) + b5*s(j))
    lambda = (c0 +c4*s(j)) + t(j) * (c1 + t(j)*((c2 + c3*t(j))) + c5*s(j))

    i_denom2 = 1.0 / (lambda + al0*(pressure(j) + p0))
    i_denom2 = i_denom2 *i_denom2
    drho_dt(j) = i_denom2 * &
      (lambda* (b1 + t(j)*(2.0*b2 + 3.0*b3*t(j)) + b5*s(j)) - &
       (pressure(j)+p0) * ( (pressure(j)+p0)*a1 + &
        (c1 + t(j)*(c2*2.0 + c3*3.0*t(j)) + c5*s(j)) ))
    drho_ds(j) = i_denom2 * (lambda* (b4 + b5*t(j)) - &
      (pressure(j)+p0) * ( (pressure(j)+p0)*a2 + (c4 + c5*t(j)) ))
  enddo

calculate_density_scalar_wright()

subroutine, public mom_eos_wright::calculate_density_scalar_wright	(	real, intent(in)	T,
		real, intent(in)	S,
		real, intent(in)	pressure,
		real, intent(out)	rho
	)

This subroutine computes the in situ density of sea water (rho in units of kg/m^3) from salinity (S in psu), potential temperature (T in deg C), and pressure in Pa. It uses the expression from Wright, 1997, J. Atmos. Ocean. Tech., 14, 735-740. Coded by R. Hallberg, 7/00.

Parameters

[in]	t	Potential temperature relative to the surface in C.
[in]	s	Salinity in PSU.
[in]	pressure	Pressure in Pa.
[out]	rho	In situ density in kg m-3.

Definition at line 69 of file MOM_EOS_Wright.F90.

References calculate_density_array_wright().

real,    intent(in)  :: t        !< Potential temperature relative to the surface in C.
real,    intent(in)  :: s        !< Salinity in PSU.
real,    intent(in)  :: pressure !< Pressure in Pa.
real,    intent(out) :: rho      !< In situ density in kg m-3.

! * Arguments: T - potential temperature relative to the surface in C. *
! *  (in)      S - salinity in PSU.                                    *
! *  (in)      pressure - pressure in Pa.                              *
! *  (out)     rho - in situ density in kg m-3.                        *
! *  (in)      start - the starting point in the arrays.               *
! *  (in)      npts - the number of values to calculate.               *

! *====================================================================*
! *  This subroutine computes the in situ density of sea water (rho in *
! *  units of kg/m^3) from salinity (S in psu), potential temperature  *
! *  (T in deg C), and pressure in Pa.  It uses the expression from    *
! *  Wright, 1997, J. Atmos. Ocean. Tech., 14, 735-740.                *
! *  Coded by R. Hallberg, 7/00                                        *
! *====================================================================*

  real :: al0, p0, lambda
  integer :: j
  real, dimension(1) :: t0, s0, pressure0
  real, dimension(1) :: rho0

  t0(1) = t
  s0(1) = s
  pressure0(1) = pressure

  call calculate_density_array_wright(t0, s0, pressure0, rho0, 1, 1)
  rho = rho0(1)

Here is the call graph for this function:

calculate_specvol_derivs_wright()

subroutine, public mom_eos_wright::calculate_specvol_derivs_wright	(	real, dimension(:), intent(in)	T,
		real, dimension(:), intent(in)	S,
		real, dimension(:), intent(in)	pressure,
		real, dimension(:), intent(out)	dSV_dT,
		real, dimension(:), intent(out)	dSV_dS,
		integer, intent(in)	start,
		integer, intent(in)	npts
	)

Parameters

[in]	t	Potential temperature relative to the surface in C.
[in]	s	Salinity in g/kg.
[in]	pressure	Pressure in Pa.
[out]	dsv_dt	The partial derivative of specific volume with potential temperature, in m3 kg-1 K-1.
[out]	dsv_ds	The partial derivative of specific volume with salinity, in m3 kg-1 / (g/kg).
[in]	start	The starting point in the arrays.
[in]	npts	The number of values to calculate.

Definition at line 186 of file MOM_EOS_Wright.F90.

References a1, a2, b0, b1, b2, b3, b4, b5, c0, c1, c2, c3, c4, and c5.

  real,    intent(in),  dimension(:) :: t        !< Potential temperature relative to the surface
                                                 !! in C.
  real,    intent(in),  dimension(:) :: s        !< Salinity in g/kg.
  real,    intent(in),  dimension(:) :: pressure !< Pressure in Pa.
  real,    intent(out), dimension(:) :: dsv_dt   !< The partial derivative of specific volume with
                                                 !! potential temperature, in m3 kg-1 K-1.
  real,    intent(out), dimension(:) :: dsv_ds   !< The partial derivative of specific volume with
                                                 !! salinity, in m3 kg-1 / (g/kg).
  integer, intent(in)                :: start    !< The starting point in the arrays.
  integer, intent(in)                :: npts     !< The number of values to calculate.

! * Arguments: T - potential temperature relative to the surface in C. *
! *  (in)      S - salinity in g/kg.                                   *
! *  (in)      pressure - pressure in Pa.                              *
! *  (out)     dSV_dT - the partial derivative of specific volume with *
! *                     potential temperature, in m3 kg-1 K-1.         *
! *  (out)     dSV_dS - the partial derivative of specific volume with *
! *                      salinity, in m3 kg-1 / (g/kg).                *
! *  (in)      start - the starting point in the arrays.               *
! *  (in)      npts - the number of values to calculate.               *
  real :: al0, p0, lambda, i_denom
  integer :: j

  do j=start,start+npts-1
!    al0 = (a0 + a1*T(j)) + a2*S(j)
    p0 = (b0 + b4*s(j)) + t(j) * (b1 + t(j)*((b2 + b3*t(j))) + b5*s(j))
    lambda = (c0 +c4*s(j)) + t(j) * (c1 + t(j)*((c2 + c3*t(j))) + c5*s(j))

    ! SV = al0 + lambda / (pressure(j) + p0)

    i_denom = 1.0 / (pressure(j) + p0)
    dsv_dt(j) = (a1 + i_denom * (c1 + t(j)*((2.0*c2 + 3.0*c3*t(j))) + c5*s(j))) - &
                (i_denom**2 * lambda) *  (b1 + t(j)*((2.0*b2 + 3.0*b3*t(j))) + b5*s(j))
    dsv_ds(j) = (a2 + i_denom * (c4 + c5*t(j))) - &
                (i_denom**2 * lambda) *  (b4 + b5*t(j))
  enddo

int_density_dz_wright()

subroutine, public mom_eos_wright::int_density_dz_wright	(	real, dimension(hii%isd:hii%ied,hii%jsd:hii%jed), intent(in)	T,
		real, dimension(hii%isd:hii%ied,hii%jsd:hii%jed), intent(in)	S,
		real, dimension(hii%isd:hii%ied,hii%jsd:hii%jed), intent(in)	z_t,
		real, dimension(hii%isd:hii%ied,hii%jsd:hii%jed), intent(in)	z_b,
		real, intent(in)	rho_ref,
		real, intent(in)	rho_0,
		real, intent(in)	G_e,
		type(hor_index_type), intent(in)	HII,
		type(hor_index_type), intent(in)	HIO,
		real, dimension(hio%isd:hio%ied,hio%jsd:hio%jed), intent(out)	dpa,
		real, dimension(hio%isd:hio%ied,hio%jsd:hio%jed), intent(out), optional	intz_dpa,
		real, dimension(hio%isdb:hio%iedb,hio%jsd:hio%jed), intent(out), optional	intx_dpa,
		real, dimension(hio%isd:hio%ied,hio%jsdb:hio%jedb), intent(out), optional	inty_dpa
	)

This subroutine calculates analytical and nearly-analytical integrals of pressure anomalies across layers, which are required for calculating the finite-volume form pressure accelerations in a Boussinesq model.

Parameters

[in]	t	Potential temperature relative to the surface
[in]	s	Salinity in PSU.
[in]	z_t	Height at the top of the layer in m.
[in]	z_b	Height at the top of the layer in m.
[in]	rho_ref	A mean density, in kg m-3, that is subtracted out to reduce the magnitude of each of the integrals. (The pressure is calucated as p~=-z*rho_0*G_e.)
[in]	rho_0	Density, in kg m-3, that is used to calculate the pressure (as p~=-z*rho_0*G_e) used in the equation of state.
[in]	g_e	The Earth's gravitational acceleration, in m s-2.
[out]	dpa	The change in the pressure anomaly across the
[out]	intz_dpa	The integral through the thickness of the layer
[out]	intx_dpa	The integral in x of the difference between the
[out]	inty_dpa	The integral in y of the difference between the

Definition at line 279 of file MOM_EOS_Wright.F90.

References a0, a1, a2, b0, b1, b2, b3, b4, b5, c0, c1, c2, c3, c4, and c5.

  type(hor_index_type), intent(in)  :: hii, hio
  real, dimension(HII%isd:HII%ied,HII%jsd:HII%jed), &
                        intent(in)  :: t        !< Potential temperature relative to the surface
                                                !! in C.
  real, dimension(HII%isd:HII%ied,HII%jsd:HII%jed), &
                        intent(in)  :: s        !< Salinity in PSU.
  real, dimension(HII%isd:HII%ied,HII%jsd:HII%jed), &
                        intent(in)  :: z_t      !< Height at the top of the layer in m.
  real, dimension(HII%isd:HII%ied,HII%jsd:HII%jed), &
                        intent(in)  :: z_b      !< Height at the top of the layer in m.
  real,                 intent(in)  :: rho_ref  !< A mean density, in kg m-3, that is subtracted out
                                                !! to reduce the magnitude of each of the integrals.
                                                !! (The pressure is calucated as p~=-z*rho_0*G_e.)
  real,                 intent(in)  :: rho_0    !< Density, in kg m-3, that is used to calculate the
                                                !! pressure (as p~=-z*rho_0*G_e) used in the
                                                !! equation of state.
  real,                 intent(in)  :: g_e      !< The Earth's gravitational acceleration, in m s-2.
  real, dimension(HIO%isd:HIO%ied,HIO%jsd:HIO%jed), &
                        intent(out) :: dpa      !< The change in the pressure anomaly across the
                                                !! layer, in Pa.
  real, dimension(HIO%isd:HIO%ied,HIO%jsd:HIO%jed), &
              optional, intent(out) :: intz_dpa !< The integral through the thickness of the layer
                                                !! of the pressure anomaly relative to the anomaly
                                                !! at the top of the layer, in Pa m.
  real, dimension(HIO%IsdB:HIO%IedB,HIO%jsd:HIO%jed), &
              optional, intent(out) :: intx_dpa !< The integral in x of the difference between the
                                                !! pressure anomaly at the top and bottom of the
                                                !! layer divided by the x grid spacing, in Pa.
  real, dimension(HIO%isd:HIO%ied,HIO%JsdB:HIO%JedB), &
              optional, intent(out) :: inty_dpa !< The integral in y of the difference between the
                                                !! pressure anomaly at the top and bottom of the
                                                !! layer divided by the y grid spacing, in Pa.

!   This subroutine calculates analytical and nearly-analytical integrals of
! pressure anomalies across layers, which are required for calculating the
! finite-volume form pressure accelerations in a Boussinesq model.
!
! Arguments: T - potential temperature relative to the surface in C.
!  (in)      S - salinity in PSU.
!  (in)      z_t - height at the top of the layer in m.
!  (in)      z_b - height at the top of the layer in m.
!  (in)      rho_ref - A mean density, in kg m-3, that is subtracted out to reduce
!                    the magnitude of each of the integrals.
!                    (The pressure is calucated as p~=-z*rho_0*G_e.)
!  (in)      rho_0 - A density, in kg m-3, that is used to calculate the pressure
!                    (as p~=-z*rho_0*G_e) used in the equation of state.
!  (in)      G_e - The Earth's gravitational acceleration, in m s-2.
!  (in)      G - The ocean's grid structure.
!  (out)     dpa - The change in the pressure anomaly across the layer,
!                  in Pa.
!  (out,opt) intz_dpa - The integral through the thickness of the layer of the
!                       pressure anomaly relative to the anomaly at the top of
!                       the layer, in Pa m.
!  (out,opt) intx_dpa - The integral in x of the difference between the
!                       pressure anomaly at the top and bottom of the layer
!                       divided by the x grid spacing, in Pa.
!  (out,opt) inty_dpa - The integral in y of the difference between the
!                       pressure anomaly at the top and bottom of the layer
!                       divided by the y grid spacing, in Pa.

  real, dimension(HII%isd:HII%ied,HII%jsd:HII%jed) :: al0_2d, p0_2d, lambda_2d
  real :: al0, p0, lambda
  real :: eps, eps2, rho_anom, rem
  real :: w_left, w_right, intz(5)
  real, parameter :: c1_3 = 1.0/3.0, c1_7 = 1.0/7.0    ! Rational constants.
  real, parameter :: c1_9 = 1.0/9.0, c1_90 = 1.0/90.0  ! Rational constants.
  real :: gxrho, i_rho
  real :: dz, p_ave, i_al0, i_lzz
  integer :: is, ie, js, je, isq, ieq, jsq, jeq, i, j, ioff, joff, m

  ioff = hio%idg_offset - hii%idg_offset
  joff = hio%jdg_offset - hii%jdg_offset

  ! These array bounds work for the indexing convention of the input arrays, but
  ! on the computational domain defined for the output arrays.
  isq = hio%IscB + ioff ; ieq = hio%IecB + ioff
  jsq = hio%JscB + joff ; jeq = hio%JecB + joff
  is = hio%isc + ioff ; ie = hio%iec + ioff
  js = hio%jsc + joff ; je = hio%jec + joff

  gxrho = g_e * rho_0
  i_rho = 1.0 / rho_0

  do j=jsq,jeq+1 ; do i=isq,ieq+1
    al0_2d(i,j) = (a0 + a1*t(i,j)) + a2*s(i,j)
    p0_2d(i,j) = (b0 + b4*s(i,j)) + t(i,j) * (b1 + t(i,j)*((b2 + b3*t(i,j))) + b5*s(i,j))
    lambda_2d(i,j) = (c0 +c4*s(i,j)) + t(i,j) * (c1 + t(i,j)*((c2 + c3*t(i,j))) + c5*s(i,j))

    al0 = al0_2d(i,j) ; p0 = p0_2d(i,j) ; lambda = lambda_2d(i,j)

    dz = z_t(i,j) - z_b(i,j)
    p_ave = -0.5*gxrho*(z_t(i,j)+z_b(i,j))

    i_al0 = 1.0 / al0
    i_lzz = 1.0 / (p0 + (lambda * i_al0) + p_ave)
    eps = 0.5*gxrho*dz*i_lzz ; eps2 = eps*eps

!     rho(j) = (pressure(j) + p0) / (lambda + al0*(pressure(j) + p0))

    rho_anom = (p0 + p_ave)*(i_lzz*i_al0) - rho_ref
    rem = i_rho * (lambda * i_al0**2) * eps2 * &
          (c1_3 + eps2*(0.2 + eps2*(c1_7 + c1_9*eps2)))
    dpa(i-ioff,j-joff) = g_e*rho_anom*dz - 2.0*eps*rem
    if (present(intz_dpa)) &
      intz_dpa(i-ioff,j-joff) = 0.5*g_e*rho_anom*dz**2 - dz*(1.0+eps)*rem
  enddo ; enddo

  if (present(intx_dpa)) then ; do j=js,je ; do i=isq,ieq
    intz(1) = dpa(i-ioff,j-joff) ; intz(5) = dpa(i+1-ioff,j-joff)
    do m=2,4
      w_left = 0.25*real(m-1) ; w_right = 1.0-w_left
      al0 = w_left*al0_2d(i,j) + w_right*al0_2d(i+1,j)
      p0 = w_left*p0_2d(i,j) + w_right*p0_2d(i+1,j)
      lambda = w_left*lambda_2d(i,j) + w_right*lambda_2d(i+1,j)

      dz = w_left*(z_t(i,j) - z_b(i,j)) + w_right*(z_t(i+1,j) - z_b(i+1,j))
      p_ave = -0.5*gxrho*(w_left*(z_t(i,j)+z_b(i,j)) + &
                          w_right*(z_t(i+1,j)+z_b(i+1,j)))

      i_al0 = 1.0 / al0
      i_lzz = 1.0 / (p0 + (lambda * i_al0) + p_ave)
      eps = 0.5*gxrho*dz*i_lzz ; eps2 = eps*eps

      intz(m) = g_e*dz*((p0 + p_ave)*(i_lzz*i_al0) - rho_ref) - 2.0*eps * &
               i_rho * (lambda * i_al0**2) * eps2 * &
               (c1_3 + eps2*(0.2 + eps2*(c1_7 + c1_9*eps2)))
    enddo
    ! Use Bode's rule to integrate the values.
    intx_dpa(i-ioff,j-joff) = c1_90*(7.0*(intz(1)+intz(5)) + 32.0*(intz(2)+intz(4)) + &
                           12.0*intz(3))
  enddo ; enddo ; endif

  if (present(inty_dpa)) then ; do j=jsq,jeq ; do i=is,ie
    intz(1) = dpa(i-ioff,j-joff) ; intz(5) = dpa(i-ioff,j+1-joff)
    do m=2,4
      w_left = 0.25*real(m-1) ; w_right = 1.0-w_left
      al0 = w_left*al0_2d(i,j) + w_right*al0_2d(i,j+1)
      p0 = w_left*p0_2d(i,j) + w_right*p0_2d(i,j+1)
      lambda = w_left*lambda_2d(i,j) + w_right*lambda_2d(i,j+1)

      dz = w_left*(z_t(i,j) - z_b(i,j)) + w_right*(z_t(i,j+1) - z_b(i,j+1))
      p_ave = -0.5*gxrho*(w_left*(z_t(i,j)+z_b(i,j)) + &
                          w_right*(z_t(i,j+1)+z_b(i,j+1)))

      i_al0 = 1.0 / al0
      i_lzz = 1.0 / (p0 + (lambda * i_al0) + p_ave)
      eps = 0.5*gxrho*dz*i_lzz ; eps2 = eps*eps

      intz(m) = g_e*dz*((p0 + p_ave)*(i_lzz*i_al0) - rho_ref) - 2.0*eps * &
               i_rho * (lambda * i_al0**2) * eps2 * &
               (c1_3 + eps2*(0.2 + eps2*(c1_7 + c1_9*eps2)))
    enddo
    ! Use Bode's rule to integrate the values.
    inty_dpa(i-ioff,j-joff) = c1_90*(7.0*(intz(1)+intz(5)) + 32.0*(intz(2)+intz(4)) + &
                           12.0*intz(3))
  enddo ; enddo ; endif

int_spec_vol_dp_wright()

subroutine, public mom_eos_wright::int_spec_vol_dp_wright	(	real, dimension(hi%isd:hi%ied,hi%jsd:hi%jed), intent(in)	T,
		real, dimension(hi%isd:hi%ied,hi%jsd:hi%jed), intent(in)	S,
		real, dimension(hi%isd:hi%ied,hi%jsd:hi%jed), intent(in)	p_t,
		real, dimension(hi%isd:hi%ied,hi%jsd:hi%jed), intent(in)	p_b,
		real, intent(in)	alpha_ref,
		type(hor_index_type), intent(in)	HI,
		real, dimension(hi%isd:hi%ied,hi%jsd:hi%jed), intent(out)	dza,
		real, dimension(hi%isd:hi%ied,hi%jsd:hi%jed), intent(out), optional	intp_dza,
		real, dimension(hi%isdb:hi%iedb,hi%jsd:hi%jed), intent(out), optional	intx_dza,
		real, dimension(hi%isd:hi%ied,hi%jsdb:hi%jedb), intent(out), optional	inty_dza,
		integer, intent(in), optional	halo_size
	)

This subroutine calculates analytical and nearly-analytical integrals in pressure across layers of geopotential anomalies, which are required for calculating the finite-volume form pressure accelerations in a non-Boussinesq model. There are essentially no free assumptions, apart from the use of Bode's rule to do the horizontal integrals, and from a truncation in the series for log(1-eps/1+eps) that assumes that |eps| < 0.34.

Parameters

[in]	t	Potential temperature relative to the surface
[in]	s	Salinity in PSU.
[in]	p_t	Pressure at the top of the layer in Pa.
[in]	p_b	Pressure at the top of the layer in Pa.
[in]	alpha_ref	A mean specific volume that is subtracted out to reduce the magnitude of each of the integrals, m3 kg-1.The calculation is mathematically identical with different values of alpha_ref, but this reduces the effects of roundoff.
[out]	dza	The change in the geopotential anomaly across
[out]	intp_dza	The integral in pressure through the layer of
[out]	intx_dza	The integral in x of the difference between the
[out]	inty_dza	The integral in y of the difference between the
[in]	halo_size	The width of halo points on which to calculate dza.

Definition at line 445 of file MOM_EOS_Wright.F90.

References a0, a1, a2, b0, b1, b2, b3, b4, b5, c0, c1, c2, c3, c4, and c5.

Referenced by mom_eos::int_specific_vol_dp().

  type(hor_index_type), intent(in)  :: hi
  real, dimension(HI%isd:HI%ied,HI%jsd:HI%jed), &
                        intent(in)  :: t         !< Potential temperature relative to the surface
                                                 !! in C.
  real, dimension(HI%isd:HI%ied,HI%jsd:HI%jed), &
                        intent(in)  :: s         !< Salinity in PSU.
  real, dimension(HI%isd:HI%ied,HI%jsd:HI%jed), &
                        intent(in)  :: p_t       !< Pressure at the top of the layer in Pa.
  real, dimension(HI%isd:HI%ied,HI%jsd:HI%jed), &
                        intent(in)  :: p_b       !< Pressure at the top of the layer in Pa.
  real,                 intent(in)  :: alpha_ref !< A mean specific volume that is subtracted out
           !! to reduce the magnitude of each of the integrals, m3 kg-1.The calculation is
           !! mathematically identical with different values of alpha_ref, but this reduces the
           !! effects of roundoff.
  real, dimension(HI%isd:HI%ied,HI%jsd:HI%jed), &
                        intent(out) :: dza       !< The change in the geopotential anomaly across
                                                 !! the layer, in m2 s-2.
  real, dimension(HI%isd:HI%ied,HI%jsd:HI%jed), &
              optional, intent(out) :: intp_dza  !< The integral in pressure through the layer of
                                                 !! the geopotential anomaly relative to the anomaly
                                                 !! at the bottom of the layer, in Pa m2 s-2.
  real, dimension(HI%IsdB:HI%IedB,HI%jsd:HI%jed), &
              optional, intent(out) :: intx_dza  !< The integral in x of the difference between the
                                                 !! geopotential anomaly at the top and bottom of
                                                 !! the layer divided by the x grid spacing,
                                                 !! in m2 s-2.
  real, dimension(HI%isd:HI%ied,HI%JsdB:HI%JedB), &
              optional, intent(out) :: inty_dza  !< The integral in y of the difference between the
                                                 !! geopotential anomaly at the top and bottom of
                                                 !! the layer divided by the y grid spacing,
                                                 !! in m2 s-2.
  integer,    optional, intent(in)  :: halo_size !< The width of halo points on which to calculate
                                                 !! dza.

!   This subroutine calculates analytical and nearly-analytical integrals in
! pressure across layers of geopotential anomalies, which are required for
! calculating the finite-volume form pressure accelerations in a non-Boussinesq
! model.  There are essentially no free assumptions, apart from the use of
! Bode's rule to do the horizontal integrals, and from a truncation in the
! series for log(1-eps/1+eps) that assumes that |eps| < 0.34.
!
! Arguments: T - potential temperature relative to the surface in C.
!  (in)      S - salinity in PSU.
!  (in)      p_t - pressure at the top of the layer in Pa.
!  (in)      p_b - pressure at the top of the layer in Pa.
!  (in)      alpha_ref - A mean specific volume that is subtracted out to reduce
!                        the magnitude of each of the integrals, m3 kg-1.
!                        The calculation is mathematically identical with
!                        different values of alpha_ref, but this reduces the
!                        effects of roundoff.
!  (in)      HI - The ocean's horizontal index structure.
!  (out)     dza - The change in the geopotential anomaly across the layer,
!                  in m2 s-2.
!  (out,opt) intp_dza - The integral in pressure through the layer of the
!                       geopotential anomaly relative to the anomaly at the
!                       bottom of the layer, in Pa m2 s-2.
!  (out,opt) intx_dza - The integral in x of the difference between the
!                       geopotential anomaly at the top and bottom of the layer
!                       divided by the x grid spacing, in m2 s-2.
!  (out,opt) inty_dza - The integral in y of the difference between the
!                       geopotential anomaly at the top and bottom of the layer
!                       divided by the y grid spacing, in m2 s-2.
!  (in,opt)  halo_size - The width of halo points on which to calculate dza.

  real, dimension(HI%isd:HI%ied,HI%jsd:HI%jed) :: al0_2d, p0_2d, lambda_2d
  real :: al0, p0, lambda
  real :: alpha_anom, dp, p_ave
  real :: rem, eps, eps2
  real :: w_left, w_right, intp(5)
  real, parameter :: c1_3 = 1.0/3.0, c1_7 = 1.0/7.0    ! Rational constants.
  real, parameter :: c1_9 = 1.0/9.0, c1_90 = 1.0/90.0  ! Rational constants.
  integer :: isq, ieq, jsq, jeq, ish, ieh, jsh, jeh, i, j, m, halo

  isq = hi%IscB ; ieq = hi%IecB ; jsq = hi%JscB ; jeq = hi%JecB
  halo = 0 ; if (present(halo_size)) halo = max(halo_size,0)
  ish = hi%isc-halo ; ieh = hi%iec+halo ; jsh = hi%jsc-halo ; jeh = hi%jec+halo
  if (present(intx_dza)) then ; ish = min(isq,ish) ; ieh = max(ieq+1,ieh); endif
  if (present(inty_dza)) then ; jsh = min(jsq,jsh) ; jeh = max(jeq+1,jeh); endif

  if (present(intp_dza)) then
    do j=jsh,jeh ; do i=ish,ieh
      al0_2d(i,j) = (a0 + a1*t(i,j)) + a2*s(i,j)
      p0_2d(i,j) = (b0 + b4*s(i,j)) + t(i,j) * (b1 + t(i,j)*((b2 + b3*t(i,j))) + b5*s(i,j))
      lambda_2d(i,j) = (c0 +c4*s(i,j)) + t(i,j) * (c1 + t(i,j)*((c2 + c3*t(i,j))) + c5*s(i,j))

      al0 = al0_2d(i,j) ; p0 = p0_2d(i,j) ; lambda = lambda_2d(i,j)
      dp = p_b(i,j) - p_t(i,j)
      p_ave = 0.5*(p_t(i,j)+p_b(i,j))

      eps = 0.5 * dp / (p0 + p_ave) ; eps2 = eps*eps
      alpha_anom = al0 + lambda / (p0 + p_ave) - alpha_ref
      rem = lambda * eps2 * (c1_3 + eps2*(0.2 + eps2*(c1_7 + c1_9*eps2)))
      dza(i,j) = alpha_anom*dp + 2.0*eps*rem
      intp_dza(i,j) = 0.5*alpha_anom*dp**2 - dp*(1.0-eps)*rem
    enddo ; enddo
  else
    do j=jsh,jeh ; do i=ish,ieh
      al0_2d(i,j) = (a0 + a1*t(i,j)) + a2*s(i,j)
      p0_2d(i,j) = (b0 + b4*s(i,j)) + t(i,j) * (b1 + t(i,j)*((b2 + b3*t(i,j))) + b5*s(i,j))
      lambda_2d(i,j) = (c0 +c4*s(i,j)) + t(i,j) * (c1 + t(i,j)*((c2 + c3*t(i,j))) + c5*s(i,j))

      al0 = al0_2d(i,j) ; p0 = p0_2d(i,j) ; lambda = lambda_2d(i,j)
      dp = p_b(i,j) - p_t(i,j)
      p_ave = 0.5*(p_t(i,j)+p_b(i,j))

      eps = 0.5 * dp / (p0 + p_ave) ; eps2 = eps*eps
      alpha_anom = al0 + lambda / (p0 + p_ave) - alpha_ref
      rem = lambda * eps2 * (c1_3 + eps2*(0.2 + eps2*(c1_7 + c1_9*eps2)))
      dza(i,j) = alpha_anom*dp + 2.0*eps*rem
    enddo ; enddo
  endif

  if (present(intx_dza)) then ; do j=hi%jsc,hi%jec ; do i=isq,ieq
    intp(1) = dza(i,j) ; intp(5) = dza(i+1,j)
    do m=2,4
      w_left = 0.25*real(5-m) ; w_right = 1.0-w_left
      al0 = w_left*al0_2d(i,j) + w_right*al0_2d(i+1,j)
      p0 = w_left*p0_2d(i,j) + w_right*p0_2d(i+1,j)
      lambda = w_left*lambda_2d(i,j) + w_right*lambda_2d(i+1,j)

      dp = w_left*(p_b(i,j) - p_t(i,j)) + w_right*(p_b(i+1,j) - p_t(i+1,j))
      p_ave = 0.5*(w_left*(p_t(i,j)+p_b(i,j)) + w_right*(p_t(i+1,j)+p_b(i+1,j)))

      eps = 0.5 * dp / (p0 + p_ave) ; eps2 = eps*eps
      intp(m) = (al0 + lambda / (p0 + p_ave) - alpha_ref)*dp + 2.0*eps* &
               lambda * eps2 * (c1_3 + eps2*(0.2 + eps2*(c1_7 + c1_9*eps2)))
    enddo
    ! Use Bode's rule to integrate the values.
    intx_dza(i,j) = c1_90*(7.0*(intp(1)+intp(5)) + 32.0*(intp(2)+intp(4)) + &
                           12.0*intp(3))
  enddo ; enddo ; endif

  if (present(inty_dza)) then ; do j=jsq,jeq ; do i=hi%isc,hi%iec
    intp(1) = dza(i,j) ; intp(5) = dza(i,j+1)
    do m=2,4
      w_left = 0.25*real(5-m) ; w_right = 1.0-w_left
      al0 = w_left*al0_2d(i,j) + w_right*al0_2d(i,j+1)
      p0 = w_left*p0_2d(i,j) + w_right*p0_2d(i,j+1)
      lambda = w_left*lambda_2d(i,j) + w_right*lambda_2d(i,j+1)

      dp = w_left*(p_b(i,j) - p_t(i,j)) + w_right*(p_b(i,j+1) - p_t(i,j+1))
      p_ave = 0.5*(w_left*(p_t(i,j)+p_b(i,j)) + w_right*(p_t(i,j+1)+p_b(i,j+1)))

      eps = 0.5 * dp / (p0 + p_ave) ; eps2 = eps*eps
      intp(m) = (al0 + lambda / (p0 + p_ave) - alpha_ref)*dp + 2.0*eps* &
               lambda * eps2 * (c1_3 + eps2*(0.2 + eps2*(c1_7 + c1_9*eps2)))
    enddo
    ! Use Bode's rule to integrate the values.
    inty_dza(i,j) = c1_90*(7.0*(intp(1)+intp(5)) + 32.0*(intp(2)+intp(4)) + &
                           12.0*intp(3))
  enddo ; enddo ; endif

Here is the caller graph for this function:

Variable Documentation

a0

real, parameter mom_eos_wright::a0 = 7.057924e-4

private

Definition at line 55 of file MOM_EOS_Wright.F90.

Referenced by calculate_compress_wright(), calculate_density_array_wright(), calculate_density_derivs_wright(), int_density_dz_wright(), and int_spec_vol_dp_wright().

real, parameter :: a0 = 7.057924e-4, a1 = 3.480336e-7, a2 = -1.112733e-7

a1

real, parameter mom_eos_wright::a1 = 3.480336e-7

private

Definition at line 55 of file MOM_EOS_Wright.F90.

Referenced by calculate_compress_wright(), calculate_density_array_wright(), calculate_density_derivs_wright(), calculate_specvol_derivs_wright(), int_density_dz_wright(), and int_spec_vol_dp_wright().

a2

real, parameter mom_eos_wright::a2 = -1.112733e-7

private

Definition at line 55 of file MOM_EOS_Wright.F90.

Referenced by calculate_compress_wright(), calculate_density_array_wright(), calculate_density_derivs_wright(), calculate_specvol_derivs_wright(), int_density_dz_wright(), and int_spec_vol_dp_wright().

b0

real, parameter mom_eos_wright::b0 = 5.790749e8

private

Definition at line 56 of file MOM_EOS_Wright.F90.

Referenced by calculate_compress_wright(), calculate_density_array_wright(), calculate_density_derivs_wright(), calculate_specvol_derivs_wright(), int_density_dz_wright(), and int_spec_vol_dp_wright().

real, parameter :: b0 = 5.790749e8,  b1 = 3.516535e6,  b2 = -4.002714e4

b1

real, parameter mom_eos_wright::b1 = 3.516535e6

private

Definition at line 56 of file MOM_EOS_Wright.F90.

Referenced by calculate_compress_wright(), calculate_density_array_wright(), calculate_density_derivs_wright(), calculate_specvol_derivs_wright(), int_density_dz_wright(), and int_spec_vol_dp_wright().

b2

real, parameter mom_eos_wright::b2 = -4.002714e4

private

Definition at line 56 of file MOM_EOS_Wright.F90.

Referenced by calculate_compress_wright(), calculate_density_array_wright(), calculate_density_derivs_wright(), calculate_specvol_derivs_wright(), int_density_dz_wright(), and int_spec_vol_dp_wright().

b3

real, parameter mom_eos_wright::b3 = 2.084372e2

private

Definition at line 57 of file MOM_EOS_Wright.F90.

Referenced by calculate_compress_wright(), calculate_density_array_wright(), calculate_density_derivs_wright(), calculate_specvol_derivs_wright(), int_density_dz_wright(), and int_spec_vol_dp_wright().

real, parameter :: b3 = 2.084372e2,  b4 = 5.944068e5,  b5 = -9.643486e3

b4

real, parameter mom_eos_wright::b4 = 5.944068e5

private

Definition at line 57 of file MOM_EOS_Wright.F90.

Referenced by calculate_compress_wright(), calculate_density_array_wright(), calculate_density_derivs_wright(), calculate_specvol_derivs_wright(), int_density_dz_wright(), and int_spec_vol_dp_wright().

b5

real, parameter mom_eos_wright::b5 = -9.643486e3

private

Definition at line 57 of file MOM_EOS_Wright.F90.

Referenced by calculate_compress_wright(), calculate_density_array_wright(), calculate_density_derivs_wright(), calculate_specvol_derivs_wright(), int_density_dz_wright(), and int_spec_vol_dp_wright().

c0

real, parameter mom_eos_wright::c0 = 1.704853e5

private

Definition at line 58 of file MOM_EOS_Wright.F90.

Referenced by calculate_compress_wright(), calculate_density_array_wright(), calculate_density_derivs_wright(), calculate_specvol_derivs_wright(), int_density_dz_wright(), and int_spec_vol_dp_wright().

real, parameter :: c0 = 1.704853e5,  c1 = 7.904722e2,  c2 = -7.984422

c1

real, parameter mom_eos_wright::c1 = 7.904722e2

private

Definition at line 58 of file MOM_EOS_Wright.F90.

Referenced by calculate_compress_wright(), calculate_density_array_wright(), calculate_density_derivs_wright(), calculate_specvol_derivs_wright(), int_density_dz_wright(), and int_spec_vol_dp_wright().

c2

real, parameter mom_eos_wright::c2 = -7.984422

private

Definition at line 58 of file MOM_EOS_Wright.F90.

Referenced by calculate_compress_wright(), calculate_density_array_wright(), calculate_density_derivs_wright(), calculate_specvol_derivs_wright(), int_density_dz_wright(), and int_spec_vol_dp_wright().

c3

real, parameter mom_eos_wright::c3 = 5.140652e-2

private

Definition at line 59 of file MOM_EOS_Wright.F90.

Referenced by calculate_compress_wright(), calculate_density_array_wright(), calculate_density_derivs_wright(), calculate_specvol_derivs_wright(), int_density_dz_wright(), and int_spec_vol_dp_wright().

real, parameter :: c3 = 5.140652e-2, c4 = -2.302158e2, c5 = -3.079464

c4

real, parameter mom_eos_wright::c4 = -2.302158e2

private

Definition at line 59 of file MOM_EOS_Wright.F90.

Referenced by calculate_compress_wright(), calculate_density_array_wright(), calculate_density_derivs_wright(), calculate_specvol_derivs_wright(), int_density_dz_wright(), and int_spec_vol_dp_wright().

c5

real, parameter mom_eos_wright::c5 = -3.079464

private

Definition at line 59 of file MOM_EOS_Wright.F90.

Referenced by calculate_compress_wright(), calculate_density_array_wright(), calculate_density_derivs_wright(), calculate_specvol_derivs_wright(), int_density_dz_wright(), and int_spec_vol_dp_wright().