LocValExtractorDerivation Derived Type

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

  • interface

    private pure module function isDefinedObject(this) result(defined)

    Getter for userDefined

    Arguments

    Type IntentOptional Attributes Name
    class(Object), intent(in) :: this

    Return Value logical

procedure, public :: makeDefined => makeDefinedObject

  • interface

    private pure module subroutine makeDefinedObject(this)

    Set userDefined to .true.

    Arguments

    Type IntentOptional Attributes Name
    class(Object), intent(inout) :: this

procedure, public :: makeUndefined => makeUndefinedObject

  • interface

    private pure module subroutine makeUndefinedObject(this)

    Set userDefined to .false.

    Arguments

    Type IntentOptional Attributes Name
    class(Object), intent(inout) :: this

procedure, public :: init => initLocValDeriv

  • 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

procedure, public :: calculate => calculateLocVal

  • 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(:)