ambient_conditions Derived Type

type, public, abstract :: ambient_conditions

An abstract type to which procedures for getting the ambient ocean conditions are to be specified. The descendent types can contain whatever data is needed to compute the result.


Inherited by

type~~ambient_conditions~~InheritedByGraph type~ambient_conditions ambient_conditions type~plume plume type~plume->type~ambient_conditions ambient_conds type~static_plume static_plume type~static_plume->type~ambient_conditions ambient_conds type~uniform_ambient_conditions uniform_ambient_conditions type~uniform_ambient_conditions->type~ambient_conditions type~asym_plume asym_plume type~asym_plume->type~ambient_conditions ambient_conds

Contents

Source Code


Type-Bound Procedures

procedure(get_property), public, deferred :: ambient_temperature

Returns the ambient ocean temperature

  • function get_property(this, depth, t) result(property) Prototype

    Arguments

    Type IntentOptional AttributesName
    class(ambient_conditions), intent(in) :: this
    class(scalar_field), intent(in) :: depth

    A field containing the depths at which the ambient conditions are to be calculated.

    real(kind=r8), intent(in) :: t

    The time at which the ambient conditions are to be calculated.

    Return Value class(scalar_field), pointer

    A field containing the ambient conditions at the depth specified for each location.

procedure(get_property), public, deferred :: ambient_salinity

Returns the ambient ocean temperature

  • function get_property(this, depth, t) result(property) Prototype

    Arguments

    Type IntentOptional AttributesName
    class(ambient_conditions), intent(in) :: this
    class(scalar_field), intent(in) :: depth

    A field containing the depths at which the ambient conditions are to be calculated.

    real(kind=r8), intent(in) :: t

    The time at which the ambient conditions are to be calculated.

    Return Value class(scalar_field), pointer

    A field containing the ambient conditions at the depth specified for each location.

Source Code

  type, abstract, public :: ambient_conditions
    !* Author: Chris MacMackin
    !  Date: April 2016
    !
    ! An abstract type to which procedures for getting the ambient ocean
    ! conditions are to be specified. The descendent types can contain
    ! whatever data is needed to compute the result.
    !
  contains
    procedure(get_property), deferred :: ambient_temperature
      !! Returns the ambient ocean temperature
    procedure(get_property), deferred :: ambient_salinity
      !! Returns the ambient ocean temperature
  end type ambient_conditions