entrainment_mod Module

  1. entrainment.F90
  2. entrainment_mod

Provides an abstract data type to model entrainment into a vertically integrated plume.


Uses

  • module~~entrainment_mod~~UsesGraph module~entrainment_mod entrainment_mod factual_mod factual_mod module~entrainment_mod->factual_mod iso_fortran_env iso_fortran_env module~entrainment_mod->iso_fortran_env

Used by

  • module~~entrainment_mod~~UsedByGraph module~entrainment_mod entrainment_mod module~jenkins1991_entrainment_mod jenkins1991_entrainment_mod module~jenkins1991_entrainment_mod->module~entrainment_mod module~kochergin1987_entrainment_mod kochergin1987_entrainment_mod module~kochergin1987_entrainment_mod->module~entrainment_mod module~asymmetric_plume_mod asymmetric_plume_mod module~asymmetric_plume_mod->module~entrainment_mod module~asymmetric_plume_mod->module~jenkins1991_entrainment_mod module~static_plume_mod static_plume_mod module~static_plume_mod->module~entrainment_mod module~static_plume_mod->module~jenkins1991_entrainment_mod module~plume_mod plume_mod module~plume_mod->module~entrainment_mod module~plume_mod->module~jenkins1991_entrainment_mod

Contents

Abstract Interfaces

Derived Types


Abstract Interfaces

abstract interface

  • private function get_entrainment(this, velocity, thickness, depth, density_diff, time) result(property)

    Arguments

    Type IntentOptional AttributesName
    class(abstract_entrainment), intent(in) :: this
    class(vector_field), intent(in) :: velocity

    The velocity field of the plume into which fluid is being entrained.
    class(scalar_field), intent(in) :: thickness

    The thickness of the plume into which fluid is being entrained
    class(scalar_field), intent(in) :: depth

    The depth of the upper surface of the plume into which fluid is being entrained
    class(scalar_field), intent(in) :: density_diff

    The difference between the ambient density and the density of the plume into which the ambient fluid is being entrained.
    real(kind=r8), intent(in), optional :: time

    The time at which the entrainment is being calculated. If not present then assumed to be same as previous value passed.

    Return Value class(scalar_field), pointer

    The value of the entrainment


Derived Types

type, public, abstract :: abstract_entrainment

An abstract data type for calculating entrainment of ambient ocean water into a vertically integrated plume.

Type-Bound Procedures

procedure(get_entrainment), public :: entrainment_rate

Returns the entrainment rate for ambient water into the plume.