TimestepController Derived Type

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

Abstract timestep controller 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(timestepCalc), public, deferred :: evaluateTimestep

  • function timestepCalc(this, inputVars, currentTimestep) result(timestep) Prototype

    Calculate timestep in accordance with timestep controller rules and using current timestep and input variables

    Arguments

    Type IntentOptional Attributes Name
    class(TimestepController), intent(inout) :: this
    class(VariableContainer), intent(in) :: inputVars

    Variable container used to calculate timestep
    real(kind=rk), intent(in) :: currentTimestep

    Current timestep to be used if the controller rescales timesteps

    Return Value real(kind=rk)