Click or drag to resize

AbstractMike1DController Methods

The AbstractMike1DController type exposes the following members.

Methods
  NameDescription
Protected methodChangeControllerState
Change the state of the controller. Also triggers the ControllerEvent
Protected methodDoFinish
Do finish simulation. Abstract method that must be overridden
Protected methodDoInitialize
Do Initialize. Abstract method that must be overridden
Protected methodDoPrepare
Do Prepare. Abstract method that must be overridden
Protected methodDoRun
Do Run. Abstract method that must be overridden
Protected methodDoRunUntil
Do RunUntil. Virtual method that must be overridden
Protected methodDoStopSimulation
Do Stop simulation. Abstract method that must be overridden
Protected methodDoValidate
Do Validate. Abstract method that must be overridden
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodFinish
Finish and clean up.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodInitialize
Initialize the engine. Initialize sets up the engine net. When done, the EngineNet will be ready to inform on what data is available
Protected methodInitTimings
Initiate timings
Protected methodInvokeControllerProgressEvent
Call to invoke a progress event
Public methodIsInActiveState
Returns true if the controller is in an active state and currently executing.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodPrepare
Prepare the engine. This is called just before run is called. I will set the initial state (initial conditions), open output files etc.
Protected methodRaiseControllerFailedEvent
Put controller in a failed state, and issue a failed event on ControllerEvent
Public methodRaiseSpecialEvent
Trigger a custom special event
Public methodRun
Run the engine
Public methodRunManual
Must be called when running the engine manually, timestep by timestep, i.e. when not using the Run or RunUntil(DateTime) methods.

This is required for correctly transferring the engine to the run state before taking the time step.

Public methodRunUntil
Run the engine until endTime.

endTime should not exceed the simulation end time.

Public methodStopSimulation
Calling this function will end the simulation after the current timestep has been completed
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodValidate
Validate that the Controller/data access modules does not have any errors/warnings. Can be called before Initialize(IDiagnostics).
Top
Extension Methods
  NameDescription
Public Extension MethodCanWriteHtmlSummary
Check if controller is in a state to write HTML summary
(Defined by ControllerExtensions.)
Top
See Also