get_entrainment Abstract Interface

  1. entrainment.F90
  2. entrainment_mod
  3. get_entrainment

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