harmonic_extractor_derivation_class Module

Houses derivation that extracts single harmonics from distribution variables


Uses

Used by


Interfaces

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

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

Derived Types

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
procedure, public :: makeDefined => makeDefinedObject
procedure, public :: makeUndefined => makeUndefinedObject
procedure, public :: init => initHEDerivation
procedure, public :: calculate => calculateHE