Term Derived Type

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

General abstract term object


Components

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

True only if user explicitly sets it to true

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 :: update => noUpdate

  • interface

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

    Default Term update function - does nothing

    Arguments

    Type IntentOptional Attributes Name
    class(Term), intent(inout) :: this
    type(VariableContainer), intent(in) :: varCont
    class(ModelboundData), intent(in), optional :: modelData
    class(ModelSurrogate), intent(in), optional :: hostModel

procedure(evaluateTerm), public, deferred :: evaluate

  • pure function evaluateTerm(this, varCont) result(res) Prototype

    Get explicit value for the term

    Arguments

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

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

procedure(getEvolvedVar), public, deferred :: getVarName

  • pure function getEvolvedVar(this) result(name) Prototype

    Get name of the evolved variable of this term

    Arguments

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

    Return Value character(len=:), allocatable