Calculate the derivatives of specific volume with temperature and salinity from T, S, and P. More...

Private Member Functions
subroutine	calculate_spec_vol_derivs_array (T, S, pressure, dSV_dT, dSV_dS, start, npts, EOS)
	Calls the appropriate subroutine to calculate specific volume derivatives for an array. More...

subroutine	calc_spec_vol_derivs_1d (T, S, pressure, dSV_dT, dSV_dS, EOS, dom, scale)
	Calls the appropriate subroutine to calculate specific volume derivatives for 1-d array inputs, potentially limiting the domain of indices that are worked on. More...

Detailed Description

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

Definition at line 87 of file MOM_EOS.F90.

Member Function/Subroutine Documentation

◆ calc_spec_vol_derivs_1d()

subroutine mom_eos::calculate_specific_vol_derivs::calc_spec_vol_derivs_1d	(	real, dimension(:), intent(in)	T,
		real, dimension(:), intent(in)	S,
		real, dimension(:), intent(in)	pressure,
		real, dimension(:), intent(inout)	dSV_dT,
		real, dimension(:), intent(inout)	dSV_dS,
		type(eos_type), pointer	EOS,
		integer, dimension(2), intent(in), optional	dom,
		real, intent(in), optional	scale
	)

private

Calls the appropriate subroutine to calculate specific volume derivatives 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]	dsv_dt	The partial derivative of specific volume with potential temperature [R-1 degC-1 ~> m3 kg-1 degC-1]
[in,out]	dsv_ds	The partial derivative of specific volume with salinity [R-1 ppt-1 ~> m3 kg-1 ppt-1]
	eos	Equation of state structure
[in]	dom	The domain of indices to work on, taking into account that arrays start at 1.
[in]	scale	A multiplicative factor by which to scale specific volume in combination with scaling given by US [various]

Definition at line 1040 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) :: dsv_dt   !< The partial derivative of specific volume with potential
                                                 !! temperature [R-1 degC-1 ~> m3 kg-1 degC-1]
   real, dimension(:), intent(inout) :: dsv_ds   !< The partial derivative of specific volume with salinity
                                                 !! [R-1 ppt-1 ~> m3 kg-1 ppt-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) :: scale !< A multiplicative factor by which to scale specific
                                                 !! volume in combination with scaling given by US [various]
 
   ! Local variables
   real, dimension(size(dSV_dT)) :: press   ! Pressure converted to [Pa]
   real :: spv_scale ! A factor to convert specific volume from m3 kg-1 to the desired units [kg R-1 m-3 ~> 1]
   real :: p_scale   ! A factor to convert pressure to units of Pa [Pa T2 R-1 L-2 ~> 1]
   integer :: i, is, ie, npts
 
   if (.not.associated(eos)) call mom_error(fatal, &
     "calculate_spec_vol_derivs_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(dsv_dt) ; npts = 1 + ie - is
   endif
   p_scale = eos%RL2_T2_to_Pa
 
   if (p_scale == 1.0) then
     call calculate_spec_vol_derivs_array(t, s, pressure, dsv_dt, dsv_ds, is, npts, eos)
   else
     do i=is,ie ; press(i) = p_scale * pressure(i) ; enddo
     call calculate_spec_vol_derivs_array(t, s, press, dsv_dt, dsv_ds, 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
     dsv_dt(i) = spv_scale * dsv_dt(i)
     dsv_ds(i) = spv_scale * dsv_ds(i)
   enddo ; endif
 

◆ calculate_spec_vol_derivs_array()

subroutine mom_eos::calculate_specific_vol_derivs::calculate_spec_vol_derivs_array	(	real, dimension(:), intent(in)	T,
		real, dimension(:), intent(in)	S,
		real, dimension(:), intent(in)	pressure,
		real, dimension(:), intent(inout)	dSV_dT,
		real, dimension(:), intent(inout)	dSV_dS,
		integer, intent(in)	start,
		integer, intent(in)	npts,
		type(eos_type), pointer	EOS
	)

private

Calls the appropriate subroutine to calculate specific volume derivatives for an array.

Parameters

[in]	t	Potential temperature referenced to the surface [degC]
[in]	s	Salinity [ppt]
[in]	pressure	Pressure [Pa]
[in,out]	dsv_dt	The partial derivative of specific volume with potential temperature [m3 kg-1 degC-1]
[in,out]	dsv_ds	The partial derivative of specific volume with salinity [m3 kg-1 ppt-1]
[in]	start	Starting index within the array
[in]	npts	The number of values to calculate
	eos	Equation of state structure

Definition at line 988 of file MOM_EOS.F90.

   real, dimension(:), intent(in)  :: t !< Potential temperature referenced to the surface [degC]
   real, dimension(:), intent(in)  :: s !< Salinity [ppt]
   real, dimension(:), intent(in)  :: pressure !< Pressure [Pa]
   real, dimension(:), intent(inout) :: dsv_dt !< The partial derivative of specific volume with potential
                                               !! temperature [m3 kg-1 degC-1]
   real, dimension(:), intent(inout) :: dsv_ds !< The partial derivative of specific volume with salinity
                                               !! [m3 kg-1 ppt-1]
   integer,            intent(in)  :: start  !< Starting index within the array
   integer,            intent(in)  :: npts   !< The number of values to calculate
   type(eos_type),     pointer     :: eos    !< Equation of state structure
 
   ! Local variables
   real, dimension(size(T)) :: press   ! Pressure converted to [Pa]
   real, dimension(size(T)) :: rho     ! In situ density [kg m-3]
   real, dimension(size(T)) :: drho_dt ! Derivative of density with temperature [kg m-3 degC-1]
   real, dimension(size(T)) :: drho_ds ! Derivative of density with salinity [kg m-3 ppt-1]
   integer :: j
 
   if (.not.associated(eos)) call mom_error(fatal, &
     "calculate_spec_vol_derivs_array called with an unassociated EOS_type EOS.")
 
   select case (eos%form_of_EOS)
     case (eos_linear)
       call calculate_specvol_derivs_linear(t, s, pressure, dsv_dt, dsv_ds, start, &
                                            npts, eos%Rho_T0_S0, eos%dRho_dT, eos%dRho_dS)
     case (eos_unesco)
       call calculate_density_unesco(t, s, pressure, rho, start, npts)
       call calculate_density_derivs_unesco(t, s, pressure, drho_dt, drho_ds, start, npts)
       do j=start,start+npts-1
         dsv_dt(j) = -drho_dt(j)/(rho(j)**2)
         dsv_ds(j) = -drho_ds(j)/(rho(j)**2)
       enddo
     case (eos_wright)
       call calculate_specvol_derivs_wright(t, s, pressure, dsv_dt, dsv_ds, start, npts)
     case (eos_teos10)
       call calculate_specvol_derivs_teos10(t, s, pressure, dsv_dt, dsv_ds, start, npts)
     case (eos_nemo)
       call calculate_density_nemo(t, s, pressure, rho, start, npts)
       call calculate_density_derivs_nemo(t, s, pressure, drho_dt, drho_ds, start, npts)
       do j=start,start+npts-1
         dsv_dt(j) = -drho_dt(j)/(rho(j)**2)
         dsv_ds(j) = -drho_ds(j)/(rho(j)**2)
       enddo
     case default
       call mom_error(fatal, "calculate_spec_vol_derivs_array: EOS%form_of_EOS is not valid.")
   end select
 

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

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

Private Member Functions

Detailed Description

Member Function/Subroutine Documentation

◆ calc_spec_vol_derivs_1d()

◆ calculate_spec_vol_derivs_array()