linear_eos Derived Type

  1. linear_eos.F90
  2. linear_eos_mod
  3. linear_eos

type, public, extends(equation_of_state) :: linear_eos

A linearised implementation of the equation of state, of the form


Inherits

type~~linear_eos~~InheritsGraph type~linear_eos linear_eos type~equation_of_state equation_of_state type~linear_eos->type~equation_of_state

Contents

Variables

Constructor

Type-Bound Procedures

Source Code

linear_eos

Components

TypeVisibility AttributesNameInitial
real(kind=r8), private :: ref_rho =1.0_r8

The density for the temperature and salinity about which the equation of state was linearised, .
real(kind=r8), private :: ref_t =0.0_r8

The temperature about which the equation of state was linearised, .
real(kind=r8), private :: ref_s =0.0_r8

The salinity about which the equation of state was linearised, .
real(kind=r8), private :: beta_t =0.0_r8

The thermal contraction coefficient, .
real(kind=r8), private :: beta_s =1.0_r8

The haline contraction coefficient, .

Constructor

public interface linear_eos

  • private pure function constructor(ref_rho, ref_t, ref_s, beta_t, beta_s) result(this)

    Arguments

    Type IntentOptional AttributesName
    real(kind=r8), intent(in) :: ref_rho

    The density for the temperature and salinity about which the equation of state was linearised, .
    real(kind=r8), intent(in) :: ref_t

    The temperature about which the equation of state was linearised, .
    real(kind=r8), intent(in) :: ref_s

    The salinity about which the equation of state was linearised, .
    real(kind=r8), intent(in) :: beta_t

    The thermal contraction coefficient, .
    real(kind=r8), intent(in) :: beta_s

    The haline contraction coefficient, .

    Return Value type(linear_eos)


Type-Bound Procedures

procedure, public :: water_density => linear_water_density

  • private function linear_water_density(this, temperature, salinity) result(density)

    Author
    Chris MacMackin
    Date
    November 2016

    Calculates the density of the water from the temperature and salinity, using a linear equatino of state,

    Arguments

    Type IntentOptional AttributesName
    class(linear_eos), intent(in) :: this
    class(scalar_field), intent(in) :: temperature

    A field containing the temperature of the water
    class(scalar_field), intent(in) :: salinity

    A field containing the salinity of the water

    Return Value class(scalar_field), pointer

    A field containing the density of the water

procedure, public :: water_density_derivative => linear_water_deriv

  • private function linear_water_deriv(this, temperature, d_temperature, salinity, d_salinity, dir) result(d_density)

    Author
    Chris MacMackin
    Date
    November 2016

    Calculates the derivative of the water density from the temperature and salinity, using a linear equatino of state,

    Arguments

    Type IntentOptional AttributesName
    class(linear_eos), intent(in) :: this
    class(scalar_field), intent(in) :: temperature

    A field containing the temperature of the water
    class(scalar_field), intent(in) :: d_temperature

    A field containing the derivative of the temperature of the water, in teh same direction as dir
    class(scalar_field), intent(in) :: salinity

    A field containing the salinity of the water
    class(scalar_field), intent(in) :: d_salinity

    A field containing the derivative of the salinity of the water, in the same direction as dir
    integer, intent(in) :: dir

    The direction in which to take the derivative

    Return Value class(scalar_field), pointer

    A field containing the density of the water

procedure, public :: haline_contraction => linear_haline_contraction

  • private function linear_haline_contraction(this, temperature, salinity) result(coef)

    Author
    Chris MacMackin
    Date
    June 2017

    Returns the haline contraction coefficient.

    Arguments

    Type IntentOptional AttributesName
    class(linear_eos), intent(in) :: this
    class(scalar_field), intent(in) :: temperature
    class(scalar_field), intent(in) :: salinity

    Return Value class(scalar_field), allocatable

procedure, public :: thermal_contraction => linear_thermal_contraction

  • private function linear_thermal_contraction(this, temperature, salinity) result(coef)

    Author
    Chris MacMackin
    Date
    June 2017

    Returns the thermal contraction coefficient.

    Arguments

    Type IntentOptional AttributesName
    class(linear_eos), intent(in) :: this
    class(scalar_field), intent(in) :: temperature
    class(scalar_field), intent(in) :: salinity

    Return Value class(scalar_field), allocatable

Source Code

  type, extends(equation_of_state), public :: linear_eos
    !* Author: Chris MacMackin
    !  Date: April 2016
    !
    ! A linearised implementation of the equation of state, of the
    ! form $$ \rho = \rho_0[1-\beta_T(T-T_0) + \beta_S(S-S_0)]. $$
    !
    private
    real(r8) :: ref_rho = 1.0_r8
      !! The density for the temperature and salinity about which the
      !! equation of state was linearised, \(\rho_0\).
    real(r8) :: ref_t = 0.0_r8
      !! The temperature about which the equation of state was
      !! linearised, \(T_0\).
    real(r8) :: ref_s = 0.0_r8
      !! The salinity about which the equation of state was
      !! linearised, \(S_0\).
    real(r8) :: beta_t = 0.0_r8
      !! The thermal contraction coefficient, \(\beta_T\).
    real(r8) :: beta_s = 1.0_r8
      !! The haline contraction coefficient, \(\beta_S\).
  contains
    procedure :: water_density => linear_water_density
    procedure :: water_density_derivative => linear_water_deriv
    procedure :: haline_contraction => linear_haline_contraction
    procedure :: thermal_contraction => linear_thermal_contraction
  end type linear_eos