Detailed Description

Calculates specific volume of sea water from T, S and P.

Definition at line 75 of file MOM_EOS.F90.

Private functions
subroutine	calc_spec_vol_scalar (T, S, pressure, specvol, EOS, spv_ref, scale)
	Calls the appropriate subroutine to calculate specific volume of sea water for scalar inputs. More...

subroutine	calculate_spec_vol_array (T, S, pressure, specvol, start, npts, EOS, spv_ref, scale)
	Calls the appropriate subroutine to calculate the specific volume of sea water for 1-D array inputs. More...

subroutine	calc_spec_vol_1d (T, S, pressure, specvol, EOS, dom, spv_ref, scale)
	Calls the appropriate subroutine to calculate the specific volume of sea water for 1-D array inputs, potentially limiting the domain of indices that are worked on. More...

Detailed Description

Calculates specific volume of sea water from T, S and P.

Definition at line 75 of file MOM_EOS.F90.

Functions and subroutines

◆ calc_spec_vol_1d()

subroutine mom_eos::calculate_spec_vol::calc_spec_vol_1d	(	real, dimension(:), intent(in)	T,
		real, dimension(:), intent(in)	S,
		real, dimension(:), intent(in)	pressure,
		real, dimension(:), intent(inout)	specvol,
		type(eos_type), pointer	EOS,
		integer, dimension(2), intent(in), optional	dom,
		real, intent(in), optional	spv_ref,
		real, intent(in), optional	scale
	)

private

Calls the appropriate subroutine to calculate the specific volume of sea water for 1-D array inputs, potentially limiting the domain of indices that are worked on.

Parameters

[in]	t	Potential temperature referenced to the surface [degC]
[in]	s	Salinity [ppt]
[in]	pressure	Pressure [R L2 T-2 ~> Pa]
[in,out]	specvol	In situ specific volume [R-1 ~> m3 kg-1]
	eos	Equation of state structure
[in]	dom	The domain of indices to work on, taking into account that arrays start at 1.
[in]	spv_ref	A reference specific volume [R-1 ~> m3 kg-1]
[in]	scale	A multiplicative factor by which to scale output specific volume in combination with scaling given by US [various]

Definition at line 571 of file MOM_EOS.F90.

   real, dimension(:),    intent(in)    :: t        !< Potential temperature referenced to the surface [degC]
   real, dimension(:),    intent(in)    :: s        !< Salinity [ppt]
   real, dimension(:),    intent(in)    :: pressure !< Pressure [R L2 T-2 ~> Pa]
   real, dimension(:),    intent(inout) :: specvol  !< In situ specific volume [R-1 ~> m3 kg-1]
   type(eos_type),        pointer       :: eos      !< Equation of state structure
   integer, dimension(2), optional, intent(in) :: dom   !< The domain of indices to work on, taking
                                                        !! into account that arrays start at 1.
   real,                  optional, intent(in) :: spv_ref !< A reference specific volume [R-1 ~> m3 kg-1]
   real,                  optional, intent(in) :: scale !< A multiplicative factor by which to scale
                                                        !! output specific volume in combination with
                                                        !! scaling given by US [various]
   ! Local variables
   real, dimension(size(specvol)) :: pres  ! Pressure converted to [Pa]
   real :: p_scale   ! A factor to convert pressure to units of Pa [Pa T2 R-1 L-2 ~> 1]
   real :: spv_unscale ! A factor to convert specific volume from R-1 to m3 kg-1 [m3 kg-1 R ~> 1]
   real :: spv_scale ! A factor to convert specific volume from m3 kg-1 to the desired units [kg m-3 R-1 ~> 1]
   real :: spv_reference ! spv_ref converted to [m3 kg-1]
   integer :: i, is, ie, npts
 
   if (.not.associated(eos)) call mom_error(fatal, &
     "calc_spec_vol_1d called with an unassociated EOS_type EOS.")
 
   if (present(dom)) then
     is = dom(1) ; ie = dom(2) ; npts = 1 + ie - is
   else
     is = 1 ; ie = size(specvol) ; npts = 1 + ie - is
   endif
 
   p_scale = eos%RL2_T2_to_Pa
   spv_unscale = eos%kg_m3_to_R
 
   if ((p_scale == 1.0) .and. (spv_unscale == 1.0)) then
     call calculate_spec_vol_array(t, s, pressure, specvol, is, npts, eos, spv_ref)
   elseif (present(spv_ref)) then ! This is the same as above, but with some extra work to rescale variables.
     do i=is,ie ; pres(i) = p_scale * pressure(i) ; enddo
     spv_reference = spv_unscale*spv_ref
     call calculate_spec_vol_array(t, s, pres, specvol, is, npts, eos, spv_reference)
   else  ! There is rescaling of variables, but spv_ref is not present. Passing a 0 value of spv_ref
         ! changes answers at roundoff for some equations of state, like Wright and UNESCO.
     do i=is,ie ; pres(i) = p_scale * pressure(i) ; enddo
     call calculate_spec_vol_array(t, s, pres, specvol, is, npts, eos)
   endif
 
   spv_scale = eos%R_to_kg_m3
   if (present(scale)) spv_scale = spv_scale * scale
   if (spv_scale /= 1.0) then ; do i=is,ie
     specvol(i) = spv_scale * specvol(i)
   enddo ; endif
 

◆ calc_spec_vol_scalar()

subroutine mom_eos::calculate_spec_vol::calc_spec_vol_scalar	(	real, intent(in)	T,
		real, intent(in)	S,
		real, intent(in)	pressure,
		real, intent(out)	specvol,
		type(eos_type), pointer	EOS,
		real, intent(in), optional	spv_ref,
		real, intent(in), optional	scale
	)

private

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

Parameters

[in]	t	Potential temperature referenced to the surface [degC]
[in]	s	Salinity [ppt]
[in]	pressure	Pressure [Pa] or [R L2 T-2 ~> Pa]
[out]	specvol	In situ? specific volume [m3 kg-1] or [R-1 ~> m3 kg-1]
	eos	Equation of state structure
[in]	spv_ref	A reference specific volume [m3 kg-1] or [R-1 m3 kg-1]
[in]	scale	A multiplicative factor by which to scale specific volume in combination with scaling given by US [various]

Definition at line 533 of file MOM_EOS.F90.

   real,           intent(in)  :: t        !< Potential temperature referenced to the surface [degC]
   real,           intent(in)  :: s        !< Salinity [ppt]
   real,           intent(in)  :: pressure !< Pressure [Pa] or [R L2 T-2 ~> Pa]
   real,           intent(out) :: specvol  !< In situ? specific volume [m3 kg-1] or [R-1 ~> m3 kg-1]
   type(eos_type), pointer     :: eos      !< Equation of state structure
   real, optional, intent(in)  :: spv_ref  !< A reference specific volume [m3 kg-1] or [R-1 m3 kg-1]
   real, optional, intent(in)  :: scale    !< A multiplicative factor by which to scale specific
                                           !! volume in combination with scaling given by US [various]
 
   real, dimension(1) :: ta, sa, pres, spv  ! Rescaled single element array versions of the arguments.
   real :: spv_reference ! spv_ref converted to [m3 kg-1]
   real :: spv_scale ! A factor to convert specific volume from m3 kg-1 to the desired units [kg R-1 m-3 ~> 1]
 
   if (.not.associated(eos)) call mom_error(fatal, &
     "calc_spec_vol_scalar called with an unassociated EOS_type EOS.")
 
   pres(1) = eos%RL2_T2_to_Pa*pressure
   ta(1) = t ; sa(1) = s
 
   if (present(spv_ref)) then
     spv_reference = eos%kg_m3_to_R*spv_ref
     call calculate_spec_vol_array(ta, sa, pres, spv, 1, 1, eos, spv_reference)
   else
     call calculate_spec_vol_array(ta, sa, pres, spv, 1, 1, eos)
   endif
   specvol = spv(1)
 
   spv_scale = eos%R_to_kg_m3
   if (present(scale)) spv_scale = spv_scale * scale
   if (spv_scale /= 1.0) then
     specvol = spv_scale * specvol
   endif
 

◆ calculate_spec_vol_array()

subroutine mom_eos::calculate_spec_vol::calculate_spec_vol_array	(	real, dimension(:), intent(in)	T,
		real, dimension(:), intent(in)	S,
		real, dimension(:), intent(in)	pressure,
		real, dimension(:), intent(inout)	specvol,
		integer, intent(in)	start,
		integer, intent(in)	npts,
		type(eos_type), pointer	EOS,
		real, intent(in), optional	spv_ref,
		real, intent(in), optional	scale
	)

private

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

Parameters

[in]	t	potential temperature relative to the surface [degC]
[in]	s	salinity [ppt]
[in]	pressure	pressure [Pa]
[in,out]	specvol	in situ specific volume [kg m-3]
[in]	start	the starting point in the arrays.
[in]	npts	the number of values to calculate.
	eos	Equation of state structure
[in]	spv_ref	A reference specific volume [m3 kg-1]
[in]	scale	A multiplicative factor by which to scale specific volume in combination with scaling given by US [various]

Definition at line 486 of file MOM_EOS.F90.

   real, dimension(:), intent(in)    :: t        !< potential temperature relative to the surface [degC]
   real, dimension(:), intent(in)    :: s        !< salinity [ppt]
   real, dimension(:), intent(in)    :: pressure !< pressure [Pa]
   real, dimension(:), intent(inout) :: specvol  !< in situ specific volume [kg m-3]
   integer,            intent(in)    :: start    !< the starting point in the arrays.
   integer,            intent(in)    :: npts     !< the number of values to calculate.
   type(eos_type),     pointer       :: eos      !< Equation of state structure
   real,     optional, intent(in)    :: spv_ref  !< A reference specific volume [m3 kg-1]
   real,     optional, intent(in)    :: scale    !< A multiplicative factor by which to scale specific
                                                 !! volume in combination with scaling given by US [various]
 
   real, dimension(size(specvol))  :: rho   ! Density [kg m-3]
   integer :: j
 
   if (.not.associated(eos)) call mom_error(fatal, &
     "calculate_spec_vol_array called with an unassociated EOS_type EOS.")
 
   select case (eos%form_of_EOS)
     case (eos_linear)
       call calculate_spec_vol_linear(t, s, pressure, specvol, start, npts, &
                eos%rho_T0_S0, eos%drho_dT, eos%drho_dS, spv_ref)
     case (eos_unesco)
       call calculate_spec_vol_unesco(t, s, pressure, specvol, start, npts, spv_ref)
     case (eos_wright)
       call calculate_spec_vol_wright(t, s, pressure, specvol, start, npts, spv_ref)
     case (eos_teos10)
       call calculate_spec_vol_teos10(t, s, pressure, specvol, start, npts, spv_ref)
     case (eos_nemo)
       call calculate_density_nemo(t, s, pressure, rho, start, npts)
       if (present(spv_ref)) then
         specvol(:) = 1.0 / rho(:) - spv_ref
       else
         specvol(:) = 1.0 / rho(:)
       endif
     case default
       call mom_error(fatal, "calculate_spec_vol_array: EOS%form_of_EOS is not valid.")
   end select
 
   if (present(scale)) then ; if (scale /= 1.0) then ; do j=start,start+npts-1
     specvol(j) = scale * specvol(j)
   enddo ; endif ; endif
 

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

/home/cermak/src/MOM6.devrob/src/equation_of_state/MOM_EOS.F90

Detailed Description

Private functions

Detailed Description

Functions and subroutines

◆ calc_spec_vol_1d()

◆ calc_spec_vol_scalar()

◆ calculate_spec_vol_array()