Detailed Description

Calculates the second derivatives of density with various combinations of temperature, salinity, and pressure from T, S and P.

Definition at line 93 of file MOM_EOS.F90.

Private functions
subroutine	calculate_density_second_derivs_scalar (T, S, pressure, drho_dS_dS, drho_dS_dT, drho_dT_dT, drho_dS_dP, drho_dT_dP, EOS, scale)
	Calls the appropriate subroutine to calculate density second derivatives for scalar nputs. More...

subroutine	calculate_density_second_derivs_array (T, S, pressure, drho_dS_dS, drho_dS_dT, drho_dT_dT, drho_dS_dP, drho_dT_dP, start, npts, EOS, scale)
	Calls the appropriate subroutine to calculate density second derivatives for 1-D array inputs. More...

Detailed Description

Calculates the second derivatives of density with various combinations of temperature, salinity, and pressure from T, S and P.

Definition at line 93 of file MOM_EOS.F90.

Functions and subroutines

◆ calculate_density_second_derivs_array()

subroutine mom_eos::calculate_density_second_derivs::calculate_density_second_derivs_array	(	real, dimension(:), intent(in)	T,
		real, dimension(:), intent(in)	S,
		real, dimension(:), intent(in)	pressure,
		real, dimension(:), intent(inout)	drho_dS_dS,
		real, dimension(:), intent(inout)	drho_dS_dT,
		real, dimension(:), intent(inout)	drho_dT_dT,
		real, dimension(:), intent(inout)	drho_dS_dP,
		real, dimension(:), intent(inout)	drho_dT_dP,
		integer, intent(in)	start,
		integer, intent(in)	npts,
		type(eos_type), pointer	EOS,
		real, intent(in), optional	scale
	)

private

Calls the appropriate subroutine to calculate density second derivatives for 1-D array 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]
[in,out]	drho_ds_ds	Partial derivative of beta with respect to S [kg m-3 ppt-2] or [R ppt-2 ~> kg m-3 ppt-2]
[in,out]	drho_ds_dt	Partial derivative of beta with respect to T [kg m-3 ppt-1 degC-1] or [R ppt-1 degC-1 ~> kg m-3 ppt-1 degC-1]
[in,out]	drho_dt_dt	Partial derivative of alpha with respect to T [kg m-3 degC-2] or [R degC-2 ~> kg m-3 degC-2]
[in,out]	drho_ds_dp	Partial derivative of beta with respect to pressure [kg m-3 ppt-1 Pa-1] or [R ppt-1 Pa-1 ~> kg m-3 ppt-1 Pa-1]
[in,out]	drho_dt_dp	Partial derivative of alpha with respect to pressure [kg m-3 degC-1 Pa-1] or [R degC-1 Pa-1 ~> kg m-3 degC-1 Pa-1]
[in]	start	Starting index within the array
[in]	npts	The number of values to calculate
	eos	Equation of state structure
[in]	scale	A multiplicative factor by which to scale density in combination with scaling given by US [various]

Definition at line 844 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] or [R L2 T-2 ~> Pa]
   real, dimension(:), intent(inout) :: drho_ds_ds !< Partial derivative of beta with respect to S
                                                   !!  [kg m-3 ppt-2] or [R ppt-2 ~> kg m-3 ppt-2]
   real, dimension(:), intent(inout) :: drho_ds_dt !< Partial derivative of beta with respect to T
                                                   !! [kg m-3 ppt-1 degC-1] or [R ppt-1 degC-1 ~> kg m-3 ppt-1 degC-1]
   real, dimension(:), intent(inout) :: drho_dt_dt !< Partial derivative of alpha with respect to T
                                                   !! [kg m-3 degC-2] or [R degC-2 ~> kg m-3 degC-2]
   real, dimension(:), intent(inout) :: drho_ds_dp !< Partial derivative of beta with respect to pressure
                                                   !! [kg m-3 ppt-1 Pa-1] or [R ppt-1 Pa-1 ~> kg m-3 ppt-1 Pa-1]
   real, dimension(:), intent(inout) :: drho_dt_dp !< Partial derivative of alpha with respect to pressure
                                                   !! [kg m-3 degC-1 Pa-1] or [R degC-1 Pa-1 ~> kg m-3 degC-1 Pa-1]
   integer,            intent(in)  :: start !< Starting index within the array
   integer,            intent(in)  :: npts  !< The number of values to calculate
   type(eos_type),     pointer     :: eos   !< Equation of state structure
   real,                  optional, intent(in) :: scale !< A multiplicative factor by which to scale density
                                                   !! in combination with scaling given by US [various]
   ! Local variables
   real, dimension(size(pressure)) :: pres  ! Pressure converted to [Pa]
   real :: rho_scale ! A factor to convert density from kg m-3 to the desired units [R m3 kg-1 ~> 1]
   real :: p_scale   ! A factor to convert pressure to units of Pa [Pa T2 R-1 L-2 ~> 1]
   real :: i_p_scale ! The inverse of the factor to convert pressure to units of Pa [R L2 T-2 Pa-1 ~> 1]
   integer :: j
 
   if (.not.associated(eos)) call mom_error(fatal, &
     "calculate_density_derivs called with an unassociated EOS_type EOS.")
 
   p_scale = eos%RL2_T2_to_Pa
 
   if (p_scale == 1.0) then
     select case (eos%form_of_EOS)
       case (eos_linear)
         call calculate_density_second_derivs_linear(t, s, pressure, drho_ds_ds, drho_ds_dt, &
                                                     drho_dt_dt, drho_ds_dp, drho_dt_dp, start, npts)
       case (eos_wright)
         call calculate_density_second_derivs_wright(t, s, pressure, drho_ds_ds, drho_ds_dt, &
                                                     drho_dt_dt, drho_ds_dp, drho_dt_dp, start, npts)
       case (eos_teos10)
         call calculate_density_second_derivs_teos10(t, s, pressure, drho_ds_ds, drho_ds_dt, &
                                                     drho_dt_dt, drho_ds_dp, drho_dt_dp, start, npts)
       case default
         call mom_error(fatal, "calculate_density_derivs: EOS%form_of_EOS is not valid.")
     end select
   else
     do j=start,start+npts-1 ; pres(j) = p_scale * pressure(j) ; enddo
     select case (eos%form_of_EOS)
       case (eos_linear)
         call calculate_density_second_derivs_linear(t, s, pres, drho_ds_ds, drho_ds_dt, &
                                                     drho_dt_dt, drho_ds_dp, drho_dt_dp, start, npts)
       case (eos_wright)
         call calculate_density_second_derivs_wright(t, s, pres, drho_ds_ds, drho_ds_dt, &
                                                     drho_dt_dt, drho_ds_dp, drho_dt_dp, start, npts)
       case (eos_teos10)
         call calculate_density_second_derivs_teos10(t, s, pres, drho_ds_ds, drho_ds_dt, &
                                                     drho_dt_dt, drho_ds_dp, drho_dt_dp, start, npts)
       case default
         call mom_error(fatal, "calculate_density_derivs: EOS%form_of_EOS is not valid.")
     end select
   endif
 
   rho_scale = eos%kg_m3_to_R
   if (present(scale)) rho_scale = rho_scale * scale
   if (rho_scale /= 1.0) then ; do j=start,start+npts-1
     drho_ds_ds(j) = rho_scale * drho_ds_ds(j)
     drho_ds_dt(j) = rho_scale * drho_ds_dt(j)
     drho_dt_dt(j) = rho_scale * drho_dt_dt(j)
     drho_ds_dp(j) = rho_scale * drho_ds_dp(j)
     drho_dt_dp(j) = rho_scale * drho_dt_dp(j)
   enddo ; endif
 
   if (p_scale /= 1.0) then
     i_p_scale = 1.0 / p_scale
     do j=start,start+npts-1
       drho_ds_dp(j) = i_p_scale * drho_ds_dp(j)
       drho_dt_dp(j) = i_p_scale * drho_dt_dp(j)
     enddo
   endif
 

◆ calculate_density_second_derivs_scalar()

subroutine mom_eos::calculate_density_second_derivs::calculate_density_second_derivs_scalar	(	real, intent(in)	T,
		real, intent(in)	S,
		real, intent(in)	pressure,
		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,
		type(eos_type), pointer	EOS,
		real, intent(in), optional	scale
	)

private

Calls the appropriate subroutine to calculate density second derivatives for scalar nputs.

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]	drho_ds_ds	Partial derivative of beta with respect to S [kg m-3 ppt-2] or [R ppt-2 ~> kg m-3 ppt-2]
[out]	drho_ds_dt	Partial derivative of beta with respect to T [kg m-3 ppt-1 degC-1] or [R ppt-1 degC-1 ~> kg m-3 ppt-1 degC-1]
[out]	drho_dt_dt	Partial derivative of alpha with respect to T [kg m-3 degC-2] or [R degC-2 ~> kg m-3 degC-2]
[out]	drho_ds_dp	Partial derivative of beta with respect to pressure [kg m-3 ppt-1 Pa-1] or [R ppt-1 Pa-1 ~> kg m-3 ppt-1 Pa-1]
[out]	drho_dt_dp	Partial derivative of alpha with respect to pressure [kg m-3 degC-1 Pa-1] or [R degC-1 Pa-1 ~> kg m-3 degC-1 Pa-1]
	eos	Equation of state structure
[in]	scale	A multiplicative factor by which to scale density in combination with scaling given by US [various]

Definition at line 928 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) :: drho_ds_ds !< Partial derivative of beta with respect to S
                                   !! [kg m-3 ppt-2] or [R ppt-2 ~> kg m-3 ppt-2]
   real, intent(out) :: drho_ds_dt !< Partial derivative of beta with respect to T
                                   !! [kg m-3 ppt-1 degC-1] or [R ppt-1 degC-1 ~> kg m-3 ppt-1 degC-1]
   real, intent(out) :: drho_dt_dt !< Partial derivative of alpha with respect to T
                                   !! [kg m-3 degC-2] or [R degC-2 ~> kg m-3 degC-2]
   real, intent(out) :: drho_ds_dp !< Partial derivative of beta with respect to pressure
                                   !! [kg m-3 ppt-1 Pa-1] or [R ppt-1 Pa-1 ~> kg m-3 ppt-1 Pa-1]
   real, intent(out) :: drho_dt_dp !< Partial derivative of alpha with respect to pressure
                                   !! [kg m-3 degC-1 Pa-1] or [R degC-1 Pa-1 ~> kg m-3 degC-1 Pa-1]
   type(eos_type), pointer    :: eos !< Equation of state structure
   real, optional, intent(in) :: scale !< A multiplicative factor by which to scale density
                                   !! in combination with scaling given by US [various]
   ! Local variables
   real :: rho_scale ! A factor to convert density from kg m-3 to the desired units [R m3 kg-1 ~> 1]
   real :: p_scale   ! A factor to convert pressure to units of Pa [Pa T2 R-1 L-2 ~> 1]
   real :: i_p_scale ! The inverse of the factor to convert pressure to units of Pa [R L2 T-2 Pa-1 ~> 1]
 
   if (.not.associated(eos)) call mom_error(fatal, &
     "calculate_density_derivs called with an unassociated EOS_type EOS.")
 
   p_scale = eos%RL2_T2_to_Pa
 
   select case (eos%form_of_EOS)
     case (eos_linear)
       call calculate_density_second_derivs_linear(t, s, p_scale*pressure, drho_ds_ds, drho_ds_dt, &
                                                   drho_dt_dt, drho_ds_dp, drho_dt_dp)
     case (eos_wright)
       call calculate_density_second_derivs_wright(t, s, p_scale*pressure, drho_ds_ds, drho_ds_dt, &
                                                   drho_dt_dt, drho_ds_dp, drho_dt_dp)
     case (eos_teos10)
       call calculate_density_second_derivs_teos10(t, s, p_scale*pressure, drho_ds_ds, drho_ds_dt, &
                                                   drho_dt_dt, drho_ds_dp, drho_dt_dp)
     case default
       call mom_error(fatal, "calculate_density_derivs: EOS%form_of_EOS is not valid.")
   end select
 
   rho_scale = eos%kg_m3_to_R
   if (present(scale)) rho_scale = rho_scale * scale
   if (rho_scale /= 1.0) then
     drho_ds_ds = rho_scale * drho_ds_ds
     drho_ds_dt = rho_scale * drho_ds_dt
     drho_dt_dt = rho_scale * drho_dt_dt
     drho_ds_dp = rho_scale * drho_ds_dp
     drho_dt_dp = rho_scale * drho_dt_dp
   endif
 
   if (p_scale /= 1.0) then
     i_p_scale = 1.0 / p_scale
     drho_ds_dp = i_p_scale * drho_ds_dp
     drho_dt_dp = i_p_scale * drho_dt_dp
   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

◆ calculate_density_second_derivs_array()

◆ calculate_density_second_derivs_scalar()