loc_val_extractor_derivation_class Module

Houses derivation that extracts a single positional value for a fluid variable



Interfaces

interface

  • private module function calculateLocVal(this, inputArray, indices) result(output)

    Arguments

    Type IntentOptional Attributes Name
    class(LocValExtractorDerivation), intent(inout) :: this
    type(RealArray), intent(in), dimension(:) :: inputArray
    integer(kind=ik), intent(in), dimension(:) :: indices

    Return Value real(kind=rk), allocatable, dimension(:)

interface

  • private module subroutine initLocValDeriv(this, partObj, numProc, targetX)

    Initialize harmonic extractor derivation

    Arguments

    Type IntentOptional Attributes Name
    class(LocValExtractorDerivation), intent(inout) :: this
    type(Partition), intent(in) :: partObj
    integer(kind=ik), intent(in) :: numProc
    integer(kind=ik), intent(in) :: targetX

    x location to extract from - global indexing


Derived Types

type, public, extends(Derivation) ::  LocValExtractorDerivation

Extracts target location value from a fluid variable as a scalar variable. Expects a single input.

Components

Type Visibility Attributes Name Initial
logical, public :: userDefined = .false.

True only if user explicitly sets it to true

logical, private :: isActive
integer(kind=ik), private :: targetX

x location to extract from - local indexing

integer(kind=ik), private :: locNumX

Type-Bound Procedures

procedure, public :: isDefined => isDefinedObject
procedure, public :: makeDefined => makeDefinedObject
procedure, public :: makeUndefined => makeUndefinedObject
procedure, public :: init => initLocValDeriv
procedure, public :: calculate => calculateLocVal