mom_eos_wright Module Reference

Detailed Description

The equation of state using the Wright 1997 expressions.

Data Types
interface	calculate_density_derivs_wright
	For a given thermodynamic state, return the derivatives of density with temperature and salinity. More...
interface	calculate_density_second_derivs_wright
	For a given thermodynamic state, return the second derivatives of density with various combinations of temperature, salinity, and pressure. More...
interface	calculate_density_wright
	Compute the in situ density of sea water (in [kg m-3]), or its anomaly with respect to a reference density, from salinity (in psu), potential temperature (in deg C), and pressure [Pa], using the expressions from Wright, 1997, J. Atmos. Ocean. Tech., 14, 735-740. More...
interface	calculate_spec_vol_wright
	Compute the in situ specific volume of sea water (in [m3 kg-1]), or an anomaly with respect to a reference specific volume, from salinity (in psu), potential temperature (in deg C), and pressure [Pa], using the expressions from Wright, 1997, J. Atmos. Ocean. Tech., 14, 735-740. More...
real, parameter	a0 = 7.057924e-4
	Parameters in the Wright equation of state. More...
real, parameter	a1 = 3.480336e-7
	Parameters in the Wright equation of state. More...
real, parameter	a2 = -1.112733e-7
	Parameters in the Wright equation of state. More...
real, parameter	b0 = 5.790749e8
	Parameters in the Wright equation of state. More...
real, parameter	b1 = 3.516535e6
	Parameters in the Wright equation of state. More...
real, parameter	b2 = -4.002714e4
	Parameters in the Wright equation of state. More...
real, parameter	b3 = 2.084372e2
	Parameters in the Wright equation of state. More...
real, parameter	b4 = 5.944068e5
	Parameters in the Wright equation of state. More...
real, parameter	b5 = -9.643486e3
	Parameters in the Wright equation of state. More...
real, parameter	c0 = 1.704853e5
	Parameters in the Wright equation of state. More...
real, parameter	c1 = 7.904722e2
	Parameters in the Wright equation of state. More...
real, parameter	c2 = -7.984422
	Parameters in the Wright equation of state. More...
real, parameter	c3 = 5.140652e-2
	Parameters in the Wright equation of state. More...
real, parameter	c4 = -2.302158e2
	Parameters in the Wright equation of state. More...
real, parameter	c5 = -3.079464
	Parameters in the Wright equation of state. More...
subroutine	calculate_density_scalar_wright (T, S, pressure, rho, rho_ref)
	This subroutine computes the in situ density of sea water (rho in [kg m-3]) from salinity (S [PSU]), potential temperature (T [degC]), and pressure [Pa]. It uses the expression from Wright, 1997, J. Atmos. Ocean. Tech., 14, 735-740. More...
subroutine	calculate_density_array_wright (T, S, pressure, rho, start, npts, rho_ref)
	This subroutine computes the in situ density of sea water (rho in [kg m-3]) from salinity (S [PSU]), potential temperature (T [degC]), and pressure [Pa]. It uses the expression from Wright, 1997, J. Atmos. Ocean. Tech., 14, 735-740. More...
subroutine	calculate_spec_vol_scalar_wright (T, S, pressure, specvol, spv_ref)
	This subroutine computes the in situ specific volume of sea water (specvol in [m3 kg-1]) from salinity (S [PSU]), potential temperature (T [degC]) and pressure [Pa]. It uses the expression from Wright, 1997, J. Atmos. Ocean. Tech., 14, 735-740. If spv_ref is present, specvol is an anomaly from spv_ref. More...
subroutine	calculate_spec_vol_array_wright (T, S, pressure, specvol, start, npts, spv_ref)
	This subroutine computes the in situ specific volume of sea water (specvol in [m3 kg-1]) from salinity (S [PSU]), potential temperature (T [degC]) and pressure [Pa]. It uses the expression from Wright, 1997, J. Atmos. Ocean. Tech., 14, 735-740. If spv_ref is present, specvol is an anomaly from spv_ref. More...
subroutine	calculate_density_derivs_array_wright (T, S, pressure, drho_dT, drho_dS, start, npts)
	For a given thermodynamic state, return the thermal/haline expansion coefficients. More...
subroutine	calculate_density_derivs_scalar_wright (T, S, pressure, drho_dT, drho_dS)
	The scalar version of calculate_density_derivs which promotes scalar inputs to a 1-element array and then demotes the output back to a scalar. More...
subroutine	calculate_density_second_derivs_array_wright (T, S, P, drho_ds_ds, drho_ds_dt, drho_dt_dt, drho_ds_dp, drho_dt_dp, start, npts)
	Second derivatives of density with respect to temperature, salinity, and pressure. More...
subroutine	calculate_density_second_derivs_scalar_wright (T, S, P, drho_ds_ds, drho_ds_dt, drho_dt_dt, drho_ds_dp, drho_dt_dp)
	Second derivatives of density with respect to temperature, salinity, and pressure for scalar inputs. Inputs promoted to 1-element array and output demoted to scalar. More...
subroutine, public	calculate_specvol_derivs_wright (T, S, pressure, dSV_dT, dSV_dS, start, npts)
	For a given thermodynamic state, return the partial derivatives of specific volume with temperature and salinity. More...
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 [kg m-3]) and the compressibility (drho/dp = C_sound^-2) (drho_dp [s2 m-2]) from salinity (sal in psu), potential temperature (T [degC]), and pressure [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, bathyT, dz_neglect, useMassWghtInterp)
	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, spv_ref, HI, dza, intp_dza, intx_dza, inty_dza, halo_size, bathyP, dP_neglect, useMassWghtInterp)
	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...

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 [kg m-3]) and the compressibility (drho/dp = C_sound^-2) (drho_dp [s2 m-2]) from salinity (sal in psu), potential temperature (T [degC]), and pressure [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 [degC].
[in]	s	Salinity [PSU].
[in]	pressure	pressure [Pa].
[out]	rho	In situ density [kg m-3].
[out]	drho_dp	The partial derivative of density with pressure (also the inverse of the square of sound speed) [s2 m-2].
[in]	start	The starting point in the arrays.
[in]	npts	The number of values to calculate.

Definition at line 380 of file MOM_EOS_Wright.F90.

  real,    intent(in),  dimension(:) :: T        !< Potential temperature relative to the surface [degC].
  real,    intent(in),  dimension(:) :: S        !< Salinity [PSU].
  real,    intent(in),  dimension(:) :: pressure !< pressure [Pa].
  real,    intent(out), dimension(:) :: rho      !< In situ density [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)
                                                 !! [s2 m-2].
  integer, intent(in)                :: start    !< The starting point in the arrays.
  integer, intent(in)                :: npts     !< The number of values to calculate.
 
  ! Coded by R. Hallberg, 1/01
  ! Local variables
  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

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

calculate_density_array_wright()

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

private

This subroutine computes the in situ density of sea water (rho in [kg m-3]) from salinity (S [PSU]), potential temperature (T [degC]), and pressure [Pa]. It uses the expression from Wright, 1997, J. Atmos. Ocean. Tech., 14, 735-740.

Parameters

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

Definition at line 111 of file MOM_EOS_Wright.F90.

  real, dimension(:), intent(in)  :: T        !< potential temperature relative to the surface [degC].
  real, dimension(:), intent(in)  :: S        !< salinity [PSU].
  real, dimension(:), intent(in)  :: pressure !< pressure [Pa].
  real, dimension(:), intent(out) :: rho      !< in situ density [kg m-3].
  integer,            intent(in)  :: start    !< the starting point in the arrays.
  integer,            intent(in)  :: npts     !< the number of values to calculate.
  real,     optional, intent(in)  :: rho_ref  !< A reference density [kg m-3].
 
  ! Original coded by R. Hallberg, 7/00, anomaly coded in 3/18.
  ! Local variables
  real :: al0, p0, lambda
  real :: al_TS, p_TSp, lam_TS, pa_000
  integer :: j
 
  if (present(rho_ref)) pa_000 = (b0*(1.0 - a0*rho_ref) - rho_ref*c0)
  if (present(rho_ref)) then ; do j=start,start+npts-1
    al_ts = a1*t(j) +a2*s(j)
    al0 = a0 + al_ts
    p_tsp = pressure(j) + (b4*s(j) + t(j) * (b1 + (t(j)*(b2 + b3*t(j)) + b5*s(j))))
    lam_ts = c4*s(j) + t(j) * (c1 + (t(j)*(c2 + c3*t(j)) + c5*s(j)))
 
    ! The following two expressions are mathematically equivalent.
    ! rho(j) = (b0 + p0_TSp) / ((c0 + lam_TS) + al0*(b0 + p0_TSp)) - rho_ref
    rho(j) = (pa_000 + (p_tsp - rho_ref*(p_tsp*al0 + (b0*al_ts + lam_ts)))) / &
             ( (c0 + lam_ts) + al0*(b0 + p_tsp) )
  enddo ; else ; 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 ; endif
 

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

Referenced by calculate_density_scalar_wright().

Here is the caller graph for this function:

calculate_density_derivs_array_wright()

subroutine mom_eos_wright::calculate_density_derivs_array_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  )

private

For a given thermodynamic state, return the thermal/haline expansion coefficients.

Parameters

[in]	t	Potential temperature relative to the surface [degC].
[in]	s	Salinity [PSU].
[in]	pressure	pressure [Pa].
[out]	drho_dt	The partial derivative of density with potential temperature [kg m-3 degC-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 200 of file MOM_EOS_Wright.F90.

  real,    intent(in),  dimension(:) :: T        !< Potential temperature relative to the
                                                 !! surface [degC].
  real,    intent(in),  dimension(:) :: S        !< Salinity [PSU].
  real,    intent(in),  dimension(:) :: pressure !< pressure [Pa].
  real,    intent(out), dimension(:) :: drho_dT  !< The partial derivative of density with potential
                                                 !! temperature [kg m-3 degC-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.
 
  ! Local variables
  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
 

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

Referenced by calculate_density_derivs_scalar_wright().

Here is the caller graph for this function:

calculate_density_derivs_scalar_wright()

subroutine mom_eos_wright::calculate_density_derivs_scalar_wright ( real, intent(in)  T, real, intent(in)  S, real, intent(in)  pressure, real, intent(out)  drho_dT, real, intent(out)  drho_dS  )

private

The scalar version of calculate_density_derivs which promotes scalar inputs to a 1-element array and then demotes the output back to a scalar.

Parameters

[in]	t	Potential temperature relative to the surface [degC].
[in]	s	Salinity [PSU].
[in]	pressure	pressure [Pa].
[out]	drho_dt	The partial derivative of density with potential temperature [kg m-3 degC-1].
[out]	drho_ds	The partial derivative of density with salinity, in [kg m-3 PSU-1].

Definition at line 235 of file MOM_EOS_Wright.F90.

  real,    intent(in)  :: T        !< Potential temperature relative to the surface [degC].
  real,    intent(in)  :: S        !< Salinity [PSU].
  real,    intent(in)  :: pressure !< pressure [Pa].
  real,    intent(out) :: drho_dT  !< The partial derivative of density with potential
                                   !! temperature [kg m-3 degC-1].
  real,    intent(out) :: drho_dS  !< The partial derivative of density with salinity,
                                   !! in [kg m-3 PSU-1].
 
  ! Local variables needed to promote the input/output scalars to 1-element arrays
  real, dimension(1) :: T0, S0, P0
  real, dimension(1) :: drdt0, drds0
 
  t0(1) = t
  s0(1) = s
  p0(1) = pressure
  call calculate_density_derivs_array_wright(t0, s0, p0, drdt0, drds0, 1, 1)
  drho_dt = drdt0(1)
  drho_ds = drds0(1)
 

References calculate_density_derivs_array_wright().

Here is the call graph for this function:

calculate_density_scalar_wright()

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

private

This subroutine computes the in situ density of sea water (rho in [kg m-3]) from salinity (S [PSU]), potential temperature (T [degC]), and pressure [Pa]. It uses the expression from Wright, 1997, J. Atmos. Ocean. Tech., 14, 735-740.

Parameters

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

Definition at line 81 of file MOM_EOS_Wright.F90.

  real,           intent(in)  :: T        !< Potential temperature relative to the surface [degC].
  real,           intent(in)  :: S        !< Salinity [PSU].
  real,           intent(in)  :: pressure !< pressure [Pa].
  real,           intent(out) :: rho      !< In situ density [kg m-3].
  real, optional, intent(in)  :: rho_ref  !< A reference density [kg m-3].
 
! *====================================================================*
! *  This subroutine computes the in situ density of sea water (rho in *
! *  [kg m-3]) from salinity (S [PSU]), potential temperature  *
! *  (T [degC]), and pressure [Pa].  It uses the expression from    *
! *  Wright, 1997, J. Atmos. Ocean. Tech., 14, 735-740.                *
! *  Coded by R. Hallberg, 7/00                                        *
! *====================================================================*
 
  real, dimension(1) :: T0, S0, pressure0, rho0
 
  t0(1) = t
  s0(1) = s
  pressure0(1) = pressure
 
  call calculate_density_array_wright(t0, s0, pressure0, rho0, 1, 1, rho_ref)
  rho = rho0(1)
 

References calculate_density_array_wright().

Here is the call graph for this function:

calculate_density_second_derivs_array_wright()

subroutine mom_eos_wright::calculate_density_second_derivs_array_wright ( real, dimension(:), intent(in)  T, real, dimension(:), intent(in)  S, real, dimension(:), intent(in)  P, real, dimension(:), intent(out)  drho_ds_ds, real, dimension(:), intent(out)  drho_ds_dt, real, dimension(:), intent(out)  drho_dt_dt, real, dimension(:), intent(out)  drho_ds_dp, real, dimension(:), intent(out)  drho_dt_dp, integer, intent(in)  start, integer, intent(in)  npts  )

private

Second derivatives of density with respect to temperature, salinity, and pressure.

Parameters

[in]	t	Potential temperature referenced to 0 dbar [degC]
[in]	s	Salinity [PSU]
[in]	p	Pressure [Pa]
[out]	drho_ds_ds	Partial derivative of beta with respect to S [kg m-3 PSU-2]
[out]	drho_ds_dt	Partial derivative of beta with respcct to T [kg m-3 PSU-1 degC-1]
[out]	drho_dt_dt	Partial derivative of alpha with respect to T [kg m-3 degC-2]
[out]	drho_ds_dp	Partial derivative of beta with respect to pressure [kg m-3 PSU-1 Pa-1]
[out]	drho_dt_dp	Partial derivative of alpha with respect to pressure [kg m-3 degC-1 Pa-1]
[in]	start	Starting index in T,S,P
[in]	npts	Number of points to loop over

Definition at line 259 of file MOM_EOS_Wright.F90.

  real, dimension(:), intent(in   ) :: T !< Potential temperature referenced to 0 dbar [degC]
  real, dimension(:), intent(in   ) :: S !< Salinity [PSU]
  real, dimension(:), intent(in   ) :: P !< Pressure [Pa]
  real, dimension(:), intent(  out) :: drho_ds_ds !< Partial derivative of beta with respect
                                                  !! to S [kg m-3 PSU-2]
  real, dimension(:), intent(  out) :: drho_ds_dt !< Partial derivative of beta with respcct
                                                  !! to T [kg m-3 PSU-1 degC-1]
  real, dimension(:), intent(  out) :: drho_dt_dt !< Partial derivative of alpha with respect
                                                  !! to T [kg m-3 degC-2]
  real, dimension(:), intent(  out) :: drho_ds_dp !< Partial derivative of beta with respect
                                                  !! to pressure [kg m-3 PSU-1 Pa-1]
  real, dimension(:), intent(  out) :: drho_dt_dp !< Partial derivative of alpha with respect
                                                  !! to pressure [kg m-3 degC-1 Pa-1]
  integer,            intent(in   ) :: start !< Starting index in T,S,P
  integer,            intent(in   ) :: npts  !< Number of points to loop over
 
  ! Local variables
  real :: z0, z1, z2, z3, z4, z5, z6 ,z7, z8, z9, z10, z11, z2_2, z2_3
  integer :: j
  ! Based on the above expression with common terms factored, there probably exists a more numerically stable
  ! and/or efficient expression
 
  do j = start,start+npts-1
    z0 = t(j)*(b1 + b5*s(j) + t(j)*(b2 + b3*t(j)))
    z1 = (b0 + p(j) + b4*s(j) + z0)
    z3 = (b1 + b5*s(j) + t(j)*(2.*b2 + 2.*b3*t(j)))
    z4 = (c0 + c4*s(j) + t(j)*(c1 + c5*s(j) + t(j)*(c2 + c3*t(j))))
    z5 = (b1 + b5*s(j) + t(j)*(b2 + b3*t(j)) + t(j)*(b2 + 2.*b3*t(j)))
    z6 = c1 + c5*s(j) + t(j)*(c2 + c3*t(j)) + t(j)*(c2 + 2.*c3*t(j))
    z7 = (c4 + c5*t(j) + a2*z1)
    z8 = (c1 + c5*s(j) + t(j)*(2.*c2 + 3.*c3*t(j)) + a1*z1)
    z9 = (a0 + a2*s(j) + a1*t(j))
    z10 = (b4 + b5*t(j))
    z11 = (z10*z4 - z1*z7)
    z2 = (c0 + c4*s(j) + t(j)*(c1 + c5*s(j) + t(j)*(c2 + c3*t(j))) + z9*z1)
    z2_2 = z2*z2
    z2_3 = z2_2*z2
 
    drho_ds_ds(j) = (z10*(c4 + c5*t(j)) - a2*z10*z1 - z10*z7)/z2_2 - (2.*(c4 + c5*t(j) + z9*z10 + a2*z1)*z11)/z2_3
    drho_ds_dt(j) = (z10*z6 - z1*(c5 + a2*z5) + b5*z4 - z5*z7)/z2_2 - (2.*(z6 + z9*z5 + a1*z1)*z11)/z2_3
    drho_dt_dt(j) = (z3*z6 - z1*(2.*c2 + 6.*c3*t(j) + a1*z5) + (2.*b2 + 4.*b3*t(j))*z4 - z5*z8)/z2_2 - &
                    (2.*(z6 + z9*z5 + a1*z1)*(z3*z4 - z1*z8))/z2_3
    drho_ds_dp(j) = (-c4 - c5*t(j) - 2.*a2*z1)/z2_2 - (2.*z9*z11)/z2_3
    drho_dt_dp(j) = (-c1 - c5*s(j) - t(j)*(2.*c2 + 3.*c3*t(j)) - 2.*a1*z1)/z2_2 - (2.*z9*(z3*z4 - z1*z8))/z2_3
  enddo
 

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

Referenced by calculate_density_second_derivs_scalar_wright().

Here is the caller graph for this function:

calculate_density_second_derivs_scalar_wright()

subroutine mom_eos_wright::calculate_density_second_derivs_scalar_wright ( real, intent(in)  T, real, intent(in)  S, real, intent(in)  P, real, intent(out)  drho_ds_ds, real, intent(out)  drho_ds_dt, real, intent(out)  drho_dt_dt, real, intent(out)  drho_ds_dp, real, intent(out)  drho_dt_dp  )

private

Second derivatives of density with respect to temperature, salinity, and pressure for scalar inputs. Inputs promoted to 1-element array and output demoted to scalar.

Parameters

[in]	t	Potential temperature referenced to 0 dbar
[in]	s	Salinity [PSU]
[in]	p	pressure [Pa]
[out]	drho_ds_ds	Partial derivative of beta with respect to S [kg m-3 PSU-2]
[out]	drho_ds_dt	Partial derivative of beta with respcct to T [kg m-3 PSU-1 degC-1]
[out]	drho_dt_dt	Partial derivative of alpha with respect to T [kg m-3 degC-2]
[out]	drho_ds_dp	Partial derivative of beta with respect to pressure [kg m-3 PSU-1 Pa-1]
[out]	drho_dt_dp	Partial derivative of alpha with respect to pressure [kg m-3 degC-1 Pa-1]

Definition at line 311 of file MOM_EOS_Wright.F90.

  real, intent(in   ) :: T          !< Potential temperature referenced to 0 dbar
  real, intent(in   ) :: S          !< Salinity [PSU]
  real, intent(in   ) :: P          !< pressure [Pa]
  real, intent(  out) :: drho_ds_ds !< Partial derivative of beta with respect
                                    !! to S [kg m-3 PSU-2]
  real, intent(  out) :: drho_ds_dt !< Partial derivative of beta with respcct
                                    !! to T [kg m-3 PSU-1 degC-1]
  real, intent(  out) :: drho_dt_dt !< Partial derivative of alpha with respect
                                    !! to T [kg m-3 degC-2]
  real, intent(  out) :: drho_ds_dp !< Partial derivative of beta with respect
                                    !! to pressure [kg m-3 PSU-1 Pa-1]
  real, intent(  out) :: drho_dt_dp !< Partial derivative of alpha with respect
                                    !! to pressure [kg m-3 degC-1 Pa-1]
  ! Local variables
  real, dimension(1) :: T0, S0, P0
  real, dimension(1) :: drdsds, drdsdt, drdtdt, drdsdp, drdtdp
 
  t0(1) = t
  s0(1) = s
  p0(1) = p
  call calculate_density_second_derivs_array_wright(t0, s0, p0, drdsds, drdsdt, drdtdt, drdsdp, drdtdp, 1, 1)
  drho_ds_ds = drdsds(1)
  drho_ds_dt = drdsdt(1)
  drho_dt_dt = drdtdt(1)
  drho_ds_dp = drdsdp(1)
  drho_dt_dp = drdtdp(1)
 

References calculate_density_second_derivs_array_wright().

Here is the call graph for this function:

calculate_spec_vol_array_wright()

subroutine mom_eos_wright::calculate_spec_vol_array_wright ( 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, real, intent(in), optional  spv_ref  )

private

This subroutine computes the in situ specific volume of sea water (specvol in [m3 kg-1]) from salinity (S [PSU]), potential temperature (T [degC]) and pressure [Pa]. It uses the expression from Wright, 1997, J. Atmos. Ocean. Tech., 14, 735-740. If spv_ref is present, specvol is an anomaly from spv_ref.

Parameters

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

Definition at line 172 of file MOM_EOS_Wright.F90.

  real, dimension(:), intent(in)  :: T        !< potential temperature relative to the
                                              !! surface [degC].
  real, dimension(:), intent(in)  :: S        !< salinity [PSU].
  real, dimension(:), intent(in)  :: pressure !< pressure [Pa].
  real, dimension(:), intent(out) :: specvol  !< in situ specific volume [m3 kg-1].
  integer,            intent(in)  :: start    !< the starting point in the arrays.
  integer,            intent(in)  :: npts     !< the number of values to calculate.
  real,     optional, intent(in)  :: spv_ref  !< A reference specific volume [m3 kg-1].
 
  ! Local variables
  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))
 
    if (present(spv_ref)) then
      specvol(j) = (lambda + (al0 - spv_ref)*(pressure(j) + p0)) / (pressure(j) + p0)
    else
      specvol(j) = (lambda + al0*(pressure(j) + p0)) / (pressure(j) + p0)
    endif
  enddo

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

Referenced by calculate_spec_vol_scalar_wright().

Here is the caller graph for this function:

calculate_spec_vol_scalar_wright()

subroutine mom_eos_wright::calculate_spec_vol_scalar_wright ( real, intent(in)  T, real, intent(in)  S, real, intent(in)  pressure, real, intent(out)  specvol, real, intent(in), optional  spv_ref  )

private

This subroutine computes the in situ specific volume of sea water (specvol in [m3 kg-1]) from salinity (S [PSU]), potential temperature (T [degC]) and pressure [Pa]. It uses the expression from Wright, 1997, J. Atmos. Ocean. Tech., 14, 735-740. If spv_ref is present, specvol is an anomaly from spv_ref.

Parameters

[in]	t	potential temperature relative to the surface [degC].
[in]	s	salinity [PSU].
[in]	pressure	pressure [Pa].
[out]	specvol	in situ specific volume [m3 kg-1].
[in]	spv_ref	A reference specific volume [m3 kg-1].

Definition at line 151 of file MOM_EOS_Wright.F90.

  real,           intent(in)  :: T        !< potential temperature relative to the surface [degC].
  real,           intent(in)  :: S        !< salinity [PSU].
  real,           intent(in)  :: pressure !< pressure [Pa].
  real,           intent(out) :: specvol  !< in situ specific volume [m3 kg-1].
  real, optional, intent(in)  :: spv_ref  !< A reference specific volume [m3 kg-1].
 
  ! Local variables
  real, dimension(1) :: T0, S0, pressure0, spv0
 
  t0(1) = t ; s0(1) = s ; pressure0(1) = pressure
 
  call calculate_spec_vol_array_wright(t0, s0, pressure0, spv0, 1, 1, spv_ref)
  specvol = spv0(1)

References calculate_spec_vol_array_wright().

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
	)

For a given thermodynamic state, return the partial derivatives of specific volume with temperature and salinity.

Parameters

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

Definition at line 343 of file MOM_EOS_Wright.F90.

  real,    intent(in),  dimension(:) :: T        !< Potential temperature relative to the surface [degC].
  real,    intent(in),  dimension(:) :: S        !< Salinity [PSU].
  real,    intent(in),  dimension(:) :: pressure !< pressure [Pa].
  real,    intent(out), dimension(:) :: dSV_dT   !< The partial derivative of specific volume with
                                                 !! potential temperature [m3 kg-1 degC-1].
  real,    intent(out), dimension(:) :: dSV_dS   !< The partial derivative of specific volume with
                                                 !! salinity [m3 kg-1 / Pa].
  integer, intent(in)                :: start    !< The starting point in the arrays.
  integer, intent(in)                :: npts     !< The number of values to calculate.
 
  ! Local variables
  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
 

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

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,
		real, dimension(hii%isd:hii%ied,hii%jsd:hii%jed), intent(in), optional	bathyT,
		real, intent(in), optional	dz_neglect,
		logical, intent(in), optional	useMassWghtInterp
	)

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]	hii	The horizontal index type for the input arrays.
[in]	hio	The horizontal index type for the output arrays.
[in]	t	Potential temperature relative to the surface
[in]	s	Salinity [PSU].
[in]	z_t	Height at the top of the layer in depth units [Z ~> m].
[in]	z_b	Height at the top of the layer [Z ~> m].
[in]	rho_ref	A mean density [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 [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 [m2 Z-1 s-2 ~> 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
[in]	bathyt	The depth of the bathymetry [Z ~> m].
[in]	dz_neglect	A miniscule thickness change [Z ~> m].
[in]	usemasswghtinterp	If true, uses mass weighting to interpolate T/S for top and bottom integrals.

Definition at line 412 of file MOM_EOS_Wright.F90.

  type(hor_index_type), intent(in)  :: HII      !< The horizontal index type for the input arrays.
  type(hor_index_type), intent(in)  :: HIO      !< The horizontal index type for the output arrays.
  real, dimension(HII%isd:HII%ied,HII%jsd:HII%jed), &
                        intent(in)  :: T        !< Potential temperature relative to the surface
                                                !! [degC].
  real, dimension(HII%isd:HII%ied,HII%jsd:HII%jed), &
                        intent(in)  :: S        !< Salinity [PSU].
  real, dimension(HII%isd:HII%ied,HII%jsd:HII%jed), &
                        intent(in)  :: z_t      !< Height at the top of the layer in depth units [Z ~> m].
  real, dimension(HII%isd:HII%ied,HII%jsd:HII%jed), &
                        intent(in)  :: z_b      !< Height at the top of the layer [Z ~> m].
  real,                 intent(in)  :: rho_ref  !< A mean density [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 [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 [m2 Z-1 s-2 ~> 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 [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 [Pa Z ~> 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 [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 [Pa].
  real, dimension(HII%isd:HII%ied,HII%jsd:HII%jed), &
              optional, intent(in)  :: bathyT   !< The depth of the bathymetry [Z ~> m].
  real,       optional, intent(in)  :: dz_neglect !< A miniscule thickness change [Z ~> m].
  logical,    optional, intent(in)  :: useMassWghtInterp !< If true, uses mass weighting to
                                                !! interpolate T/S for top and bottom integrals.
 
  ! Local variables
  real, dimension(HII%isd:HII%ied,HII%jsd:HII%jed) :: al0_2d, p0_2d, lambda_2d
  real :: al0, p0, lambda
  real :: rho_anom   ! The density anomaly from rho_ref [kg m-3].
  real :: eps, eps2, rem
  real :: GxRho, I_Rho
  real :: p_ave, I_al0, I_Lzz
  real :: dz         ! The layer thickness [Z ~> m].
  real :: hWght      ! A pressure-thickness below topography [Z ~> m].
  real :: hL, hR     ! Pressure-thicknesses of the columns to the left and right [Z ~> m].
  real :: iDenom     ! The inverse of the denominator in the weights [Z-2 ~> m-2].
  real :: hWt_LL, hWt_LR ! hWt_LA is the weighted influence of A on the left column [nondim].
  real :: hWt_RL, hWt_RR ! hWt_RA is the weighted influence of A on the right column [nondim].
  real :: wt_L, wt_R ! The linear weights of the left and right columns [nondim].
  real :: wtT_L, wtT_R ! The weights for tracers from the left and right columns [nondim].
  real :: intz(5)    ! The integrals of density with height at the
                     ! 5 sub-column locations [Pa].
  logical :: do_massWeight ! Indicates whether to do mass weighting.
  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 :: 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_massweight = .false.
  if (present(usemasswghtinterp)) then ; if (usemasswghtinterp) then
    do_massweight = .true.
  ! if (.not.present(bathyT)) call MOM_error(FATAL, "int_density_dz_generic: "//&
  !     "bathyT must be present if useMassWghtInterp is present and true.")
  ! if (.not.present(dz_neglect)) call MOM_error(FATAL, "int_density_dz_generic: "//&
  !     "dz_neglect must be present if useMassWghtInterp is present and true.")
  endif ; endif
 
  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
    ! hWght is the distance measure by which the cell is violation of
    ! hydrostatic consistency. For large hWght we bias the interpolation of
    ! T & S along the top and bottom integrals, akin to thickness weighting.
    hwght = 0.0
    if (do_massweight) &
      hwght = max(0., -bathyt(i,j)-z_t(i+1,j), -bathyt(i+1,j)-z_t(i,j))
    if (hwght > 0.) then
      hl = (z_t(i,j) - z_b(i,j)) + dz_neglect
      hr = (z_t(i+1,j) - z_b(i+1,j)) + dz_neglect
      hwght = hwght * ( (hl-hr)/(hl+hr) )**2
      idenom = 1.0 / ( hwght*(hr + hl) + hl*hr )
      hwt_ll = (hwght*hl + hr*hl) * idenom ; hwt_lr = (hwght*hr) * idenom
      hwt_rr = (hwght*hr + hr*hl) * idenom ; hwt_rl = (hwght*hl) * idenom
    else
      hwt_ll = 1.0 ; hwt_lr = 0.0 ; hwt_rr = 1.0 ; hwt_rl = 0.0
    endif
 
    intz(1) = dpa(i-ioff,j-joff) ; intz(5) = dpa(i+1-ioff,j-joff)
    do m=2,4
      wt_l = 0.25*real(5-m) ; wt_r = 1.0-wt_l
      wtt_l = wt_l*hwt_ll + wt_r*hwt_rl ; wtt_r = wt_l*hwt_lr + wt_r*hwt_rr
 
      al0 = wtt_l*al0_2d(i,j) + wtt_r*al0_2d(i+1,j)
      p0 = wtt_l*p0_2d(i,j) + wtt_r*p0_2d(i+1,j)
      lambda = wtt_l*lambda_2d(i,j) + wtt_r*lambda_2d(i+1,j)
 
      dz = wt_l*(z_t(i,j) - z_b(i,j)) + wt_r*(z_t(i+1,j) - z_b(i+1,j))
      p_ave = -0.5*gxrho*(wt_l*(z_t(i,j)+z_b(i,j)) + &
                          wt_r*(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
    ! hWght is the distance measure by which the cell is violation of
    ! hydrostatic consistency. For large hWght we bias the interpolation of
    ! T & S along the top and bottom integrals, akin to thickness weighting.
    hwght = 0.0
    if (do_massweight) &
      hwght = max(0., -bathyt(i,j)-z_t(i,j+1), -bathyt(i,j+1)-z_t(i,j))
    if (hwght > 0.) then
      hl = (z_t(i,j) - z_b(i,j)) + dz_neglect
      hr = (z_t(i,j+1) - z_b(i,j+1)) + dz_neglect
      hwght = hwght * ( (hl-hr)/(hl+hr) )**2
      idenom = 1.0 / ( hwght*(hr + hl) + hl*hr )
      hwt_ll = (hwght*hl + hr*hl) * idenom ; hwt_lr = (hwght*hr) * idenom
      hwt_rr = (hwght*hr + hr*hl) * idenom ; hwt_rl = (hwght*hl) * idenom
    else
      hwt_ll = 1.0 ; hwt_lr = 0.0 ; hwt_rr = 1.0 ; hwt_rl = 0.0
    endif
 
    intz(1) = dpa(i-ioff,j-joff) ; intz(5) = dpa(i-ioff,j+1-joff)
    do m=2,4
      wt_l = 0.25*real(5-m) ; wt_r = 1.0-wt_l
      wtt_l = wt_l*hwt_ll + wt_r*hwt_rl ; wtt_r = wt_l*hwt_lr + wt_r*hwt_rr
 
      al0 = wtt_l*al0_2d(i,j) + wtt_r*al0_2d(i,j+1)
      p0 = wtt_l*p0_2d(i,j) + wtt_r*p0_2d(i,j+1)
      lambda = wtt_l*lambda_2d(i,j) + wtt_r*lambda_2d(i,j+1)
 
      dz = wt_l*(z_t(i,j) - z_b(i,j)) + wt_r*(z_t(i,j+1) - z_b(i,j+1))
      p_ave = -0.5*gxrho*(wt_l*(z_t(i,j)+z_b(i,j)) + &
                          wt_r*(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

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

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)	spv_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,
		real, dimension(hi%isd:hi%ied,hi%jsd:hi%jed), intent(in), optional	bathyP,
		real, intent(in), optional	dP_neglect,
		logical, intent(in), optional	useMassWghtInterp
	)

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]	hi	The ocean's horizontal index type.
[in]	t	Potential temperature relative to the surface
[in]	s	Salinity [PSU].
[in]	p_t	Pressure at the top of the layer [Pa].
[in]	p_b	Pressure at the top of the layer [Pa].
[in]	spv_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 spv_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.
[in]	bathyp	The pressure at the bathymetry [Pa]
[in]	dp_neglect	A miniscule pressure change with the same units as p_t [Pa]
[in]	usemasswghtinterp	If true, uses mass weighting to interpolate T/S for top and bottom integrals.

Definition at line 617 of file MOM_EOS_Wright.F90.

  type(hor_index_type), intent(in)  :: HI        !< The ocean's horizontal index type.
  real, dimension(HI%isd:HI%ied,HI%jsd:HI%jed), &
                        intent(in)  :: T         !< Potential temperature relative to the surface
                                                 !! [degC].
  real, dimension(HI%isd:HI%ied,HI%jsd:HI%jed), &
                        intent(in)  :: S         !< Salinity [PSU].
  real, dimension(HI%isd:HI%ied,HI%jsd:HI%jed), &
                        intent(in)  :: p_t       !< Pressure at the top of the layer [Pa].
  real, dimension(HI%isd:HI%ied,HI%jsd:HI%jed), &
                        intent(in)  :: p_b       !< Pressure at the top of the layer [Pa].
  real,                 intent(in)  :: spv_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 spv_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 [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 [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 [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 [m2 s-2].
  integer,    optional, intent(in)  :: halo_size !< The width of halo points on which to calculate
                                                 !! dza.
  real, dimension(HI%isd:HI%ied,HI%jsd:HI%jed), &
              optional, intent(in)  :: bathyP    !< The pressure at the bathymetry [Pa]
  real,       optional, intent(in)  :: dP_neglect !< A miniscule pressure change with
                                                 !! the same units as p_t [Pa]
  logical,    optional, intent(in)  :: useMassWghtInterp !< If true, uses mass weighting
                            !! to interpolate T/S for top and bottom integrals.
 
  ! Local variables
  real, dimension(HI%isd:HI%ied,HI%jsd:HI%jed) :: al0_2d, p0_2d, lambda_2d
  real :: al0, p0, lambda
  real :: p_ave
  real :: rem, eps, eps2
  real :: alpha_anom ! The depth averaged specific volume anomaly [m3 kg-1].
  real :: dp         ! The pressure change through a layer [Pa].
  real :: hWght      ! A pressure-thickness below topography [Pa].
  real :: hL, hR     ! Pressure-thicknesses of the columns to the left and right [Pa].
  real :: iDenom     ! The inverse of the denominator in the weights [Pa-2].
  real :: hWt_LL, hWt_LR ! hWt_LA is the weighted influence of A on the left column [nondim].
  real :: hWt_RL, hWt_RR ! hWt_RA is the weighted influence of A on the right column [nondim].
  real :: wt_L, wt_R ! The linear weights of the left and right columns [nondim].
  real :: wtT_L, wtT_R ! The weights for tracers from the left and right columns [nondim].
  real :: intp(5)    ! The integrals of specific volume with pressure at the
                     ! 5 sub-column locations [m2 s-2].
  logical :: do_massWeight ! Indicates whether to do mass weighting.
  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
 
  do_massweight = .false.
  if (present(usemasswghtinterp)) then ; if (usemasswghtinterp) then
    do_massweight = .true.
!    if (.not.present(bathyP)) call MOM_error(FATAL, "int_spec_vol_dp_generic: "//&
!        "bathyP must be present if useMassWghtInterp is present and true.")
!    if (.not.present(dP_neglect)) call MOM_error(FATAL, "int_spec_vol_dp_generic: "//&
!        "dP_neglect must be present if useMassWghtInterp is present and true.")
  endif ; endif
 
  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) - spv_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
    if (present(intp_dza)) &
      intp_dza(i,j) = 0.5*alpha_anom*dp**2 - dp*(1.0-eps)*rem
  enddo ; enddo
 
  if (present(intx_dza)) then ; do j=hi%jsc,hi%jec ; do i=isq,ieq
    ! hWght is the distance measure by which the cell is violation of
    ! hydrostatic consistency. For large hWght we bias the interpolation of
    ! T & S along the top and bottom integrals, akin to thickness weighting.
    hwght = 0.0
    if (do_massweight) &
      hwght = max(0., bathyp(i,j)-p_t(i+1,j), bathyp(i+1,j)-p_t(i,j))
    if (hwght > 0.) then
      hl = (p_b(i,j) - p_t(i,j)) + dp_neglect
      hr = (p_b(i+1,j) - p_t(i+1,j)) + dp_neglect
      hwght = hwght * ( (hl-hr)/(hl+hr) )**2
      idenom = 1.0 / ( hwght*(hr + hl) + hl*hr )
      hwt_ll = (hwght*hl + hr*hl) * idenom ; hwt_lr = (hwght*hr) * idenom
      hwt_rr = (hwght*hr + hr*hl) * idenom ; hwt_rl = (hwght*hl) * idenom
    else
      hwt_ll = 1.0 ; hwt_lr = 0.0 ; hwt_rr = 1.0 ; hwt_rl = 0.0
    endif
 
    intp(1) = dza(i,j) ; intp(5) = dza(i+1,j)
    do m=2,4
      wt_l = 0.25*real(5-m) ; wt_r = 1.0-wt_l
      wtt_l = wt_l*hwt_ll + wt_r*hwt_rl ; wtt_r = wt_l*hwt_lr + wt_r*hwt_rr
 
      ! T, S, and p are interpolated in the horizontal.  The p interpolation
      ! is linear, but for T and S it may be thickness wekghted.
      al0 = wtt_l*al0_2d(i,j) + wtt_r*al0_2d(i+1,j)
      p0 = wtt_l*p0_2d(i,j) + wtt_r*p0_2d(i+1,j)
      lambda = wtt_l*lambda_2d(i,j) + wtt_r*lambda_2d(i+1,j)
 
      dp = wt_l*(p_b(i,j) - p_t(i,j)) + wt_r*(p_b(i+1,j) - p_t(i+1,j))
      p_ave = 0.5*(wt_l*(p_t(i,j)+p_b(i,j)) + wt_r*(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) - spv_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
    ! hWght is the distance measure by which the cell is violation of
    ! hydrostatic consistency. For large hWght we bias the interpolation of
    ! T & S along the top and bottom integrals, akin to thickness weighting.
    hwght = 0.0
    if (do_massweight) &
      hwght = max(0., bathyp(i,j)-p_t(i,j+1), bathyp(i,j+1)-p_t(i,j))
    if (hwght > 0.) then
      hl = (p_b(i,j) - p_t(i,j)) + dp_neglect
      hr = (p_b(i,j+1) - p_t(i,j+1)) + dp_neglect
      hwght = hwght * ( (hl-hr)/(hl+hr) )**2
      idenom = 1.0 / ( hwght*(hr + hl) + hl*hr )
      hwt_ll = (hwght*hl + hr*hl) * idenom ; hwt_lr = (hwght*hr) * idenom
      hwt_rr = (hwght*hr + hr*hl) * idenom ; hwt_rl = (hwght*hl) * idenom
    else
      hwt_ll = 1.0 ; hwt_lr = 0.0 ; hwt_rr = 1.0 ; hwt_rl = 0.0
    endif
 
    intp(1) = dza(i,j) ; intp(5) = dza(i,j+1)
    do m=2,4
      wt_l = 0.25*real(5-m) ; wt_r = 1.0-wt_l
      wtt_l = wt_l*hwt_ll + wt_r*hwt_rl ; wtt_r = wt_l*hwt_lr + wt_r*hwt_rr
 
      ! T, S, and p are interpolated in the horizontal.  The p interpolation
      ! is linear, but for T and S it may be thickness wekghted.
      al0 = wt_l*al0_2d(i,j) + wt_r*al0_2d(i,j+1)
      p0 = wt_l*p0_2d(i,j) + wt_r*p0_2d(i,j+1)
      lambda = wt_l*lambda_2d(i,j) + wt_r*lambda_2d(i,j+1)
 
      dp = wt_l*(p_b(i,j) - p_t(i,j)) + wt_r*(p_b(i,j+1) - p_t(i,j+1))
      p_ave = 0.5*(wt_l*(p_t(i,j)+p_b(i,j)) + wt_r*(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) - spv_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

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

Variable Documentation

a0

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

private

Parameters in the Wright equation of state.

Definition at line 67 of file MOM_EOS_Wright.F90.

real, parameter :: a0 = 7.057924e-4, a1 = 3.480336e-7, a2 = -1.112733e-7 ! a0/a1 ~= 2028 ; a0/a2 ~= -6343

Referenced by calculate_compress_wright(), calculate_density_array_wright(), calculate_density_derivs_array_wright(), calculate_density_second_derivs_array_wright(), calculate_spec_vol_array_wright(), int_density_dz_wright(), and int_spec_vol_dp_wright().

a1

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

private

Parameters in the Wright equation of state.

Definition at line 67 of file MOM_EOS_Wright.F90.

Referenced by calculate_compress_wright(), calculate_density_array_wright(), calculate_density_derivs_array_wright(), calculate_density_second_derivs_array_wright(), calculate_spec_vol_array_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

Parameters in the Wright equation of state.

Definition at line 67 of file MOM_EOS_Wright.F90.

Referenced by calculate_compress_wright(), calculate_density_array_wright(), calculate_density_derivs_array_wright(), calculate_density_second_derivs_array_wright(), calculate_spec_vol_array_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

Parameters in the Wright equation of state.

Definition at line 68 of file MOM_EOS_Wright.F90.

real, parameter :: b0 = 5.790749e8,  b1 = 3.516535e6,  b2 = -4.002714e4  ! b0/b1 ~= 165  ; b0/b4 ~= 974

Referenced by calculate_compress_wright(), calculate_density_array_wright(), calculate_density_derivs_array_wright(), calculate_density_second_derivs_array_wright(), calculate_spec_vol_array_wright(), calculate_specvol_derivs_wright(), int_density_dz_wright(), and int_spec_vol_dp_wright().

b1

real, parameter mom_eos_wright::b1 = 3.516535e6

private

Parameters in the Wright equation of state.

Definition at line 68 of file MOM_EOS_Wright.F90.

Referenced by calculate_compress_wright(), calculate_density_array_wright(), calculate_density_derivs_array_wright(), calculate_density_second_derivs_array_wright(), calculate_spec_vol_array_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

Parameters in the Wright equation of state.

Definition at line 68 of file MOM_EOS_Wright.F90.

Referenced by calculate_compress_wright(), calculate_density_array_wright(), calculate_density_derivs_array_wright(), calculate_density_second_derivs_array_wright(), calculate_spec_vol_array_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

Parameters in the Wright equation of state.

Definition at line 69 of file MOM_EOS_Wright.F90.

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

Referenced by calculate_compress_wright(), calculate_density_array_wright(), calculate_density_derivs_array_wright(), calculate_density_second_derivs_array_wright(), calculate_spec_vol_array_wright(), calculate_specvol_derivs_wright(), int_density_dz_wright(), and int_spec_vol_dp_wright().

b4

real, parameter mom_eos_wright::b4 = 5.944068e5

private

Parameters in the Wright equation of state.

Definition at line 69 of file MOM_EOS_Wright.F90.

Referenced by calculate_compress_wright(), calculate_density_array_wright(), calculate_density_derivs_array_wright(), calculate_density_second_derivs_array_wright(), calculate_spec_vol_array_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

Parameters in the Wright equation of state.

Definition at line 69 of file MOM_EOS_Wright.F90.

Referenced by calculate_compress_wright(), calculate_density_array_wright(), calculate_density_derivs_array_wright(), calculate_density_second_derivs_array_wright(), calculate_spec_vol_array_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

Parameters in the Wright equation of state.

Definition at line 70 of file MOM_EOS_Wright.F90.

real, parameter :: c0 = 1.704853e5,  c1 = 7.904722e2,  c2 = -7.984422    ! c0/c1 ~= 216  ; c0/c4 ~= -740

Referenced by calculate_compress_wright(), calculate_density_array_wright(), calculate_density_derivs_array_wright(), calculate_density_second_derivs_array_wright(), calculate_spec_vol_array_wright(), calculate_specvol_derivs_wright(), int_density_dz_wright(), and int_spec_vol_dp_wright().

c1

real, parameter mom_eos_wright::c1 = 7.904722e2

private

Parameters in the Wright equation of state.

Definition at line 70 of file MOM_EOS_Wright.F90.

Referenced by calculate_compress_wright(), calculate_density_array_wright(), calculate_density_derivs_array_wright(), calculate_density_second_derivs_array_wright(), calculate_spec_vol_array_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

Parameters in the Wright equation of state.

Definition at line 70 of file MOM_EOS_Wright.F90.

Referenced by calculate_compress_wright(), calculate_density_array_wright(), calculate_density_derivs_array_wright(), calculate_density_second_derivs_array_wright(), calculate_spec_vol_array_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

Parameters in the Wright equation of state.

Definition at line 71 of file MOM_EOS_Wright.F90.

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

Referenced by calculate_compress_wright(), calculate_density_array_wright(), calculate_density_derivs_array_wright(), calculate_density_second_derivs_array_wright(), calculate_spec_vol_array_wright(), calculate_specvol_derivs_wright(), int_density_dz_wright(), and int_spec_vol_dp_wright().

c4

real, parameter mom_eos_wright::c4 = -2.302158e2

private

Parameters in the Wright equation of state.

Definition at line 71 of file MOM_EOS_Wright.F90.

Referenced by calculate_compress_wright(), calculate_density_array_wright(), calculate_density_derivs_array_wright(), calculate_density_second_derivs_array_wright(), calculate_spec_vol_array_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

Parameters in the Wright equation of state.

Definition at line 71 of file MOM_EOS_Wright.F90.

Referenced by calculate_compress_wright(), calculate_density_array_wright(), calculate_density_derivs_array_wright(), calculate_density_second_derivs_array_wright(), calculate_spec_vol_array_wright(), calculate_specvol_derivs_wright(), int_density_dz_wright(), and int_spec_vol_dp_wright().