VelTProdDerivation Derived Type

type, public, extends(Derivation) :: VelTProdDerivation

Derivation that calculates the flattened tensor product of vector v with a fluid variable, optionally shifting v by a second fluid variable and raising the shifted values to a power


Components

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

True only if user explicitly sets it to true
real(kind=rk), private, allocatable, dimension(:) :: v

Velocity space vector

real(kind=rk), private :: power

Power to raise the shifted velocity values to

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

  • interface

    private module subroutine initVTProdDeriv(this, refVSpace, velVec, power)

    Initialize velocity tensor product derivation object

    Arguments

    Type IntentOptional Attributes Name
    class(VelTProdDerivation), intent(inout) :: this
    type(VSpace), intent(in) :: refVSpace

    Reference velocity space
    real(kind=rk), intent(in), optional, dimension(:) :: velVec

    Optional velocity space vector. Defaults to velcity grid values
    real(kind=rk), intent(in), optional :: power

    Optional power to raise the shifted velocity vector to. Defaults to 1

procedure, public :: calculate => calculateVTProdDeriv

  • interface

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

    Arguments

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

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