VelContracDerivation Derived Type

type, public, extends(Derivation) :: VelContracDerivation

Derivation that calculates the contraction of velocity vector g with h'th harmonic of single passed 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 :: h

Harmonic to contract with
real(kind=rk), private, allocatable, dimension(:) :: g

Velocity space vector

integer(kind=ik), private :: numH

Local copy of number of harmonics

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

  • interface

    private module subroutine initContracDeriv(this, h, g, refVSpace, expH)

    Initialize velocity contraction derivation object

    Arguments

    Type IntentOptional Attributes Name
    class(VelContracDerivation), intent(inout) :: this
    integer(kind=ik), intent(in) :: h

    Harmonic to contract with
    real(kind=rk), intent(in), dimension(:) :: g

    Velocity space vector

    type(VSpace), intent(in) :: refVSpace

    Reference velocity space
    integer(kind=ik), intent(in), optional :: expH

    Expected number of harmonics (defaults to total number of harmonics)

procedure, public :: calculate => calculateContracDeriv

  • interface

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

    Arguments

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

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