scalar_bound Function

  1. plume_boundary.F90
  2. plume_boundary_mod
  3. scalar_bound

private function scalar_bound(this, location)

Returns a field containing the boundary values for the specified boundary location.

Arguments

Type IntentOptional AttributesName
class(plume_boundary), intent(in) :: this
integer, intent(in) :: location

Which boundary information is to be provided for. The boundary will be the one normal to dimension of number abs(boundary). If the argument is negative, then the lower boundary is returned. If positive, then the upper boundary is returned.

Return Value class(scalar_field), pointer


Calls

proc~~scalar_bound~~CallsGraph proc~scalar_bound scalar_bound uniform_scalar_field uniform_scalar_field proc~scalar_bound->uniform_scalar_field

Contents

Source Code

scalar_bound

Source Code

  function scalar_bound(this, location)
    !* Author: Chris MacMackin
    !  Date: March 2017
    !
    ! Returns a field containing the boundary values for the specified
    ! boundary location.
    !
    class(plume_boundary), intent(in) :: this
    integer, intent(in)               :: location
      !! Which boundary information is to be provided for.  The
      !! boundary will be the one normal to dimension of number
      !! `abs(boundary)`. If the argument is negative, then the lower
      !! boundary is returned. If positive, then the upper boundary is
      !! returned.
    class(scalar_field), pointer :: scalar_bound
    type(uniform_scalar_field) :: dummy
    call dummy%allocate_scalar_field(scalar_bound)
    scalar_bound = uniform_scalar_field(0.0_r8)
  end function scalar_bound