ModelboundData Derived Type

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

Abstract general modelbound data object used to build classes that contain data for updating terms


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(dataCalculation), public, deferred :: update

  • subroutine dataCalculation(this, hostModel, inputVars, updatePriority) Prototype

    Arguments

    Type IntentOptional Attributes Name
    class(ModelboundData), intent(inout) :: this
    class(ModelSurrogate), intent(in) :: hostModel
    class(VariableContainer), intent(in) :: inputVars
    integer(kind=ik), intent(in), optional :: updatePriority

procedure(retrieveData), public, deferred :: copyData

  • subroutine retrieveData(this, name, container) Prototype

    Arguments

    Type IntentOptional Attributes Name
    class(ModelboundData), intent(in) :: this
    character(len=*), intent(in) :: name
    real(kind=rk), intent(inout), allocatable, dimension(..) :: container

procedure(getDataDimensionality), public, deferred :: getDataDim

  • function getDataDimensionality(this, name) result(dim) Prototype

    Arguments

    Type IntentOptional Attributes Name
    class(ModelboundData), intent(in) :: this
    character(len=*), intent(in) :: name

    Return Value integer(kind=ik)