ModelboundDataExtractor Derived Type

type, public, extends(Manipulator) :: ModelboundDataExtractor

Manipulator that extracts a (rank 1!) modelbound data variable from a model into a variable


Components

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

True only if user explicitly sets it to true
integer(kind=ik), private :: resultVarIndex

Variable index where the data should be copied into (must be compatible with the data)
integer(kind=ik), private :: modelIndex

Index of the model whose modelbound data should be copied
character(len=:), private, allocatable :: modelboundDataName

Name of the (rank 1) data requested from 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 :: init => initExtractor

  • interface

    private pure module subroutine initExtractor(this, resultVarIndex, modelIndex, modelboundDataName)

    ModelboundDataExtractor initialization routine

    Arguments

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

    Index of variable to write the result in
    integer(kind=ik), intent(in) :: modelIndex

    Index of model housing required modelbound data
    character(len=*), intent(in) :: modelboundDataName

    Name of data to extract

procedure, public :: affect => extract

  • interface

    private module subroutine extract(this, manipulatedModeller, outputVars, inputVars)

    Implementation of abstract manipulate routine for the evaluator

    Arguments

    Type IntentOptional Attributes Name
    class(ModelboundDataExtractor), intent(inout) :: this
    class(ModellerSurrogate), intent(inout) :: manipulatedModeller

    Modeller to be used in callbacks during manipulation
    class(VariableContainer), intent(inout) :: outputVars

    VariableContainer object to store the manipulation output

    class(VariableContainer), intent(in) :: inputVars

    VariableContainer object housing input data for the manipulation routine