CompositeManipulator Derived Type

type, public, extends(Object) :: CompositeManipulator

Composite manipulator object allowing for application of multiple manipulators in series based on their priority


Components

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

True only if user explicitly sets it to true
type(ManipulatorContainer), private, allocatable, dimension(:) :: manipulators

Manipulators contained in this composite manipulator
integer(kind=ik), private, allocatable, dimension(:) :: manipulatorPriority

Manipulator priority for each manipulator object
integer(kind=ik), private :: numManipulatorsAdded

Counter keeping track of how many integrators have been added
logical, private :: allManipulatorsAdded

True when all manipulators have been allocated

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

  • interface

    private module subroutine manipulate(this, manipulatedModeller, outputVars, inputVars, priority)

    Call affect routines of all manipulators whose manipulatorPriority <= priority

    Arguments

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

    Modeller object used in callback
    class(VariableContainer), intent(inout) :: outputVars

    Container for manipulation output
    class(VariableContainer), intent(in) :: inputVars

    Manipulation input variables
    integer(kind=ik), intent(in) :: priority

    Priority for this call

procedure, public :: addManipulator

  • interface

    private pure module subroutine addManipulator(this, manip, priority)

    Add Manipulator object to composite manipulator

    Arguments

    Type IntentOptional Attributes Name
    class(CompositeManipulator), intent(inout) :: this
    class(Manipulator), intent(in) :: manip
    integer(kind=ik), intent(in) :: priority

procedure, public :: init => initCompositeManipulator

  • interface

    private pure module subroutine initCompositeManipulator(this, numManipulators)

    Compostite manipulator initialization routine

    Arguments

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

    Number of manipulators expected