AbstractMike1DController Methods

Methods

ChangeControllerState Change the state of the controller. Also triggers the ControllerEvent
DoFinish Do finish simulation. Abstract method that must be overridden
DoInitialize Do Initialize. Abstract method that must be overridden
DoPrepare Do Prepare. Abstract method that must be overridden
DoRun Do Run. Abstract method that must be overridden
DoRunUntil Do RunUntil. Virtual method that must be overridden
DoStopSimulation Do Stop simulation. Abstract method that must be overridden
DoValidate Do Validate. Abstract method that must be overridden
EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Finish Finish and clean up.
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetTypeGets the Type of the current instance.
(Inherited from Object)
Initialize Initialize the engine. Initialize sets up the engine net. When done, the EngineNet will be ready to inform on what data is available
InitTimings Initiate timings
InvokeControllerProgressEvent Call to invoke a progress event
IsInActiveState Returns true if the controller is in an active state and currently executing.
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Prepare Prepare the engine. This is called just before run is called. I will set the initial state (initial conditions), open output files etc.
RaiseControllerFailedEvent Put controller in a failed state, and issue a failed event on ControllerEvent
RaiseSpecialEvent Trigger a custom special event
Run Run the engine
RunManual 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.

RunUntil Run the engine until endTime.

endTime should not exceed the simulation end time.

StopSimulation Calling this function will end the simulation after the current timestep has been completed
ToStringReturns a string that represents the current object.
(Inherited from Object)
Validate Validate that the Controller/data access modules does not have any errors/warnings. Can be called before Initialize(IDiagnostics).

Extension Methods

CanWriteHtmlSummary Check if controller is in a state to write HTML summary
(Defined by ControllerExtensions)

See Also