explicit_term_abstract_class Module

Houses abstract explicit term interfaces


Uses

Used by


Interfaces

interface

  • private pure module function unityFun(this, varCont, indexingData) result(res)

    Default multiplicative function - returns a real vector of ones based on evolvedVarName. In general should use passed variable container and indexing data to construct a vector conforming to the evolved variable

    Arguments

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

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

interface

  • private pure module function getNormalizationConst(this) result(norm)

    Getter for normalizationConst

    Arguments

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

    Return Value real(kind=rk)

interface

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

    Evaluates the term as multConst * multFun [* operatorTerm%actOn()] 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(:)

interface

  • private pure module function getMultConst(this) result(multConst)

    Getter for multConst

    Arguments

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

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

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

interface

  • private module subroutine simpleUpdate(this, varCont, modelData, hostModel)

    Default update function - just calls update on Operator if allocated

    Arguments

    Type IntentOptional Attributes Name
    class(ExplicitTerm), 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

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

interface

  • private pure module subroutine setNormalizationConst(this, norm)

    Setter for normalizationConst

    Arguments

    Type IntentOptional Attributes Name
    class(ExplicitTerm), intent(inout) :: this
    real(kind=rk), intent(in) :: norm

interface

  • private pure module subroutine setReqVars(this, reqVars, varCont)

    Set variable names required by the multiplicative function and find their indices in variable container

    Arguments

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

interface

  • private pure module subroutine setEvolvedAndOperatedVar(this, evolvedVarName, operatedVarName)

    Set evolved and operated (if applicable) variable names

    Arguments

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

interface

  • private pure module subroutine setMultConst(this, multConst)

    Setter for multConst

    Arguments

    Type IntentOptional Attributes Name
    class(ExplicitTerm), intent(inout) :: this
    real(kind=rk), intent(in), dimension(:) :: multConst

Derived Types

type, public ::  ExplicitTermIndexingData

Indexing data used by the default abstract explicit term

Components

Type Visibility Attributes Name Initial
integer(kind=ik), public, allocatable, dimension(:) :: reqVarIndices

Indices of variables required by the multiplicative function
character(len=:), public, allocatable :: evolvedVarName

Name of evolved variable
character(len=:), public, allocatable :: operatedVarName

Name of variable to which the term's operator should be applied

type, public, abstract, extends(Term) ::  ExplicitTerm

Abstract term providing basic interfaces for build terms used in explicit timestepping

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

Multiplicative constant with size conforming to the variable being evolved
real(kind=rk), private :: normalizationConst = real(1.0d0, kind=rk)

Normalization constant of this term

type(ExplicitTermIndexingData), private :: indexingData

Indexing data used by this term

class(Operator), private, allocatable :: termOperator

Optional operator used by this term

Type-Bound Procedures

procedure, public :: isDefined => isDefinedObject
procedure, public :: makeDefined => makeDefinedObject
procedure, public :: makeUndefined => makeUndefinedObject
procedure, public :: setOperator
procedure, public :: setNormalizationConst
procedure, public :: getNormalizationConst
procedure, public :: setReqVars
procedure, public :: setEvolvedAndOperatedVar
procedure, public :: evaluate => evaluateExpTerm
procedure, public :: getMultConst
procedure, public :: setMultConst
procedure, private :: multFun => unityFun
procedure, public :: update => simpleUpdate
procedure, public :: getVarName => getEvolvedVarName