mom_eos::calculate_tfreeze Interface Reference

Detailed Description

Calculates the freezing point of sea water from T, S and P.

Definition at line 98 of file MOM_EOS.F90.

Private functions
subroutine	calculate_tfreeze_scalar (S, pressure, T_fr, EOS, pres_scale)
	Calls the appropriate subroutine to calculate the freezing point for scalar inputs. More...
subroutine	calculate_tfreeze_array (S, pressure, T_fr, start, npts, EOS, pres_scale)
	Calls the appropriate subroutine to calculate the freezing point for a 1-D array. More...

Detailed Description

Calculates the freezing point of sea water from T, S and P.

Definition at line 98 of file MOM_EOS.F90.

Functions and subroutines

calculate_tfreeze_array()

subroutine mom_eos::calculate_tfreeze::calculate_tfreeze_array ( real, dimension(:), intent(in)  S, real, dimension(:), intent(in)  pressure, real, dimension(:), intent(inout)  T_fr, integer, intent(in)  start, integer, intent(in)  npts, type(eos_type), pointer  EOS, real, intent(in), optional  pres_scale  )

private

Calls the appropriate subroutine to calculate the freezing point for a 1-D array.

Parameters

[in]	s	Salinity [ppt]
[in]	pressure	Pressure [Pa] or [other]
[in,out]	t_fr	Freezing point potential temperature referenced to the surface [degC]
[in]	start	Starting index within the array
[in]	npts	The number of values to calculate
	eos	Equation of state structure
[in]	pres_scale	A multiplicative factor to convert pressure into Pa.

Definition at line 656 of file MOM_EOS.F90.

  real, dimension(:), intent(in)    :: S        !< Salinity [ppt]
  real, dimension(:), intent(in)    :: pressure !< Pressure [Pa] or [other]
  real, dimension(:), intent(inout) :: T_fr     !< Freezing point potential temperature referenced
                                                !! to the surface [degC]
  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)    :: pres_scale !< A multiplicative factor to convert pressure into Pa.
 
  ! Local variables
  real, dimension(size(pressure)) :: pres  ! Pressure converted to [Pa]
  real :: p_scale ! A factor to convert pressure to units of Pa.
  integer :: j
 
  if (.not.associated(eos)) call mom_error(fatal, &
    "calculate_TFreeze_scalar called with an unassociated EOS_type EOS.")
 
  p_scale = 1.0 ; if (present(pres_scale)) p_scale = pres_scale
 
  if (p_scale == 1.0) then
    select case (eos%form_of_TFreeze)
      case (tfreeze_linear)
        call calculate_tfreeze_linear(s, pressure, t_fr, start, npts, &
                                      eos%TFr_S0_P0, eos%dTFr_dS, eos%dTFr_dp)
      case (tfreeze_millero)
        call calculate_tfreeze_millero(s, pressure, t_fr, start, npts)
      case (tfreeze_teos10)
        call calculate_tfreeze_teos10(s, pressure, t_fr, start, npts)
      case default
        call mom_error(fatal, "calculate_TFreeze_scalar: form_of_TFreeze is not valid.")
    end select
  else
    do j=start,start+npts-1 ; pres(j) = p_scale * pressure(j) ; enddo
    select case (eos%form_of_TFreeze)
      case (tfreeze_linear)
        call calculate_tfreeze_linear(s, pres, t_fr, start, npts, &
                                      eos%TFr_S0_P0, eos%dTFr_dS, eos%dTFr_dp)
      case (tfreeze_millero)
        call calculate_tfreeze_millero(s, pres, t_fr, start, npts)
      case (tfreeze_teos10)
        call calculate_tfreeze_teos10(s, pres, t_fr, start, npts)
      case default
        call mom_error(fatal, "calculate_TFreeze_scalar: form_of_TFreeze is not valid.")
    end select
  endif
 

calculate_tfreeze_scalar()

subroutine mom_eos::calculate_tfreeze::calculate_tfreeze_scalar ( real, intent(in)  S, real, intent(in)  pressure, real, intent(out)  T_fr, type(eos_type), pointer  EOS, real, intent(in), optional  pres_scale  )

private

Calls the appropriate subroutine to calculate the freezing point for scalar inputs.

Parameters

[in]	s	Salinity [ppt]
[in]	pressure	Pressure [Pa] or [other]
[out]	t_fr	Freezing point potential temperature referenced to the surface [degC]
	eos	Equation of state structure
[in]	pres_scale	A multiplicative factor to convert pressure into Pa

Definition at line 625 of file MOM_EOS.F90.

  real,           intent(in)  :: S !< Salinity [ppt]
  real,           intent(in)  :: pressure !< Pressure [Pa] or [other]
  real,           intent(out) :: T_fr !< Freezing point potential temperature referenced
                                      !! to the surface [degC]
  type(EOS_type), pointer     :: EOS !< Equation of state structure
  real, optional, intent(in)  :: pres_scale !< A multiplicative factor to convert pressure into Pa
 
  ! Local variables
  real :: p_scale ! A factor to convert pressure to units of Pa.
 
  if (.not.associated(eos)) call mom_error(fatal, &
    "calculate_TFreeze_scalar called with an unassociated EOS_type EOS.")
 
  p_scale = 1.0 ; if (present(pres_scale)) p_scale = pres_scale
 
  select case (eos%form_of_TFreeze)
    case (tfreeze_linear)
      call calculate_tfreeze_linear(s, p_scale*pressure, t_fr, eos%TFr_S0_P0, &
                                    eos%dTFr_dS, eos%dTFr_dp)
    case (tfreeze_millero)
      call calculate_tfreeze_millero(s, p_scale*pressure, t_fr)
    case (tfreeze_teos10)
      call calculate_tfreeze_teos10(s, p_scale*pressure, t_fr)
    case default
      call mom_error(fatal, "calculate_TFreeze_scalar: form_of_TFreeze is not valid.")
  end select
 

---

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

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