vel_tensor_prod_derivation_class Module

Houses derivation that takes calculates the flattened velocity vector and x vector tensor product, resulting in a single harmonic variable



Interfaces

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

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


Derived Types

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