DerivationTerm Derived Type

type, public, extends(ExplicitTerm) :: DerivationTerm

Term of the form modelbound variable * derivation result, where the modelbound variable is optional


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

Buffer holding the result
logical, private :: isActive
logical, private :: kineticRow

True if row variable is a distribution
character(len=:), private, allocatable :: mbVarName

Name of the mb variable to multiply de derivation result with
class(Derivation), private, allocatable :: derivObj

The main derivaiton object

integer(kind=ik), private, dimension(:), allocatable :: derivReqIndices

Required indices for the derivation object
integer(kind=ik), private :: locNumX

Local number of spatial cells - used when handling modelbound data

integer(kind=ik), private :: numH

Local number of harmonics - used when handling modelbound data

integer(kind=ik), private :: numV

Local number of velocity cells - used when handling modelbound data


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 :: setOperator

  • interface

    private pure module subroutine setOperator(this, op)

    Setter for termOperator

    Arguments

    Type IntentOptional Attributes Name
    class(ExplicitTerm), intent(inout) :: this
    class(Operator), intent(in) :: op

procedure, public :: setEvolvedVar

  • interface

    private pure module subroutine setEvolvedVar(this, evolvedVarName)

    Set evolved variable name

    Arguments

    Type IntentOptional Attributes Name
    class(ExplicitTerm), intent(inout) :: this
    character(len=*), intent(in) :: evolvedVarName

procedure, public :: evaluate => evaluateExpTerm

  • interface

    private module function evaluateExpTerm(this, varCont) result(res)

    Evaluates the term as outerFun * [* operatorTerm%actOn(innerFun)] depending on whether the Operator is allocated

    Arguments

    Type IntentOptional Attributes Name
    class(ExplicitTerm), intent(in) :: this
    type(VariableContainer), intent(in) :: varCont

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

procedure, public :: getVarName => getEvolvedVarName

  • interface

    private pure module function getEvolvedVarName(this) result(name)

    Get name of the evolved variable of this term

    Arguments

    Type IntentOptional Attributes Name
    class(ExplicitTerm), intent(in) :: this

    Return Value character(len=:), allocatable

procedure, public :: update => updateDerivationTerm

  • interface

    private module subroutine updateDerivationTerm(this, varCont, modelData, hostModel)

    Update function, does not call update on operator, assuming it is never set. Only updates the modelbound data buffer if required, and calculates the result buffer

    Arguments

    Type IntentOptional Attributes Name
    class(DerivationTerm), intent(inout) :: this
    type(VariableContainer), intent(in) :: varCont

    Variable container used in update

    class(ModelboundData), intent(in), optional :: modelData

    Reference model data - unused
    class(ModelSurrogate), intent(in), optional :: hostModel

    Host model - unused

procedure, public :: outerFun => derivationOuterFun

  • interface

    private module function derivationOuterFun(this, varCont) result(res)

    Outer function simply returning the stored result buffer

    Arguments

    Type IntentOptional Attributes Name
    class(DerivationTerm), intent(in) :: this
    type(VariableContainer), intent(in) :: varCont

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

procedure, public :: init => initDerivationTerm

  • interface

    private module subroutine initDerivationTerm(this, gridObj, partitionObj, procRank, evolvedVar, varCont, derivObj, derivIndices, mbVarName)

    Explicit derivation term initialization routine

    Arguments

    Type IntentOptional Attributes Name
    class(DerivationTerm), intent(inout) :: this
    type(Grid), intent(in) :: gridObj
    type(Partition), intent(in) :: partitionObj

    Parition object used to determine local number of DoF
    integer(kind=ik), intent(in) :: procRank

    Current processor rank
    character(len=*), intent(in) :: evolvedVar

    Name of evolved variable
    type(VariableContainer), intent(in) :: varCont

    Reference variable container
    class(Derivation), intent(in) :: derivObj

    Derivation object used by the term

    integer(kind=ik), intent(in), dimension(:) :: derivIndices

    Required variable indices for the derivation object
    character(len=*), intent(in), optional :: mbVarName

    Optional modelbound variable with which to multiply the derivation result