HExtractorDerivation Derived Type

type, public, extends(Derivation) :: HExtractorDerivation

Extracts target harmonic from distribution variable


Components

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

True only if user explicitly sets it to true
integer(kind=ik), private :: numH

Total number of harmonics

integer(kind=ik), private :: numV

Velocity grid size
integer(kind=ik), private :: targetH

Harmonic to extract

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 => initHEDerivation

  • interface

    private module subroutine initHEDerivation(this, vSpaceObj, targetH)

    Initialize harmonic extractor derivation

    Arguments

    Type IntentOptional Attributes Name
    class(HExtractorDerivation), intent(inout) :: this
    type(VSpace), intent(in) :: vSpaceObj
    integer(kind=ik), intent(in) :: targetH

    Harmonic to extract

procedure, public :: calculate => calculateHE

  • interface

    private module function calculateHE(this, inputArray, indices) result(output)

    Arguments

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

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