moment_derivation_class Module

Houses moment derivation class handling derivations of the form constproduct(fluidVariablespowers) m-th moment of h-th harmonic of f * g, where g is an optional constant velocity vector


Uses

Used by


Interfaces

interface

  • private module function calculateMomentDeriv(this, inputArray, indices) result(output)

    Arguments

    Type IntentOptional Attributes Name
    class(MomentDerivation), 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 initMomentDeriv(this, mOrder, h, refVSpace, varPowers, g, multConst)

    Initialize moment derivation object

    Arguments

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

    Moment order

    integer(kind=ik), intent(in) :: h

    Harmonic to take moment of
    type(VSpace), intent(in) :: refVSpace

    Velocity space object to make copy of
    real(kind=rk), intent(in), optional, dimension(:) :: varPowers

    Optional fluid variable powers
    real(kind=rk), intent(in), optional, dimension(:) :: g

    Optional velocity space vector
    real(kind=rk), intent(in), optional :: multConst

    Optional multiplicative constant - default 1

Derived Types

type, public, extends(Derivation) ::  MomentDerivation

Moment derivation object. First step in derivation is taking the mOrder-th moment of the h-th harmonic of the first passed variable (assumes that it is a distribution), optionally multiplied by constant velocity space vector g. The results is then optionally multiplied by a constant and a product of fluid variables raised to powers (as in SimpleDerivation).

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

Powers corresponding to each fluid variable - indices in calculate must conform size of this + 1
real(kind=rk), private :: multConst

Multiplicative constant - default 1
integer(kind=ik), private :: mOrder

Moment order

integer(kind=ik), private :: h

Harmonic to take moment of
real(kind=rk), private, allocatable, dimension(:) :: g

Optional velocity space vector
type(VSpace), private :: vSpaceCopy

Copy of velocity space object used to take the moment (NOTE: this might cause performance issues if many momentDerivations are present at once)

Type-Bound Procedures

procedure, public :: isDefined => isDefinedObject
procedure, public :: makeDefined => makeDefinedObject
procedure, public :: makeUndefined => makeUndefinedObject
procedure, public :: init => initMomentDeriv
procedure, public :: calculate => calculateMomentDeriv