Mike1DControllerEM Methods |
The Mike1DControllerEM type exposes the following members.
Name | Description | |
---|---|---|
ChangeControllerState |
Change the state of the controller. Also triggers the ControllerEvent (Inherited from AbstractMike1DController.) | |
DoFinish |
Finish and clean up
(Inherited from Mike1DController.) | |
DoInitialize |
Initialize the engine. Initialize sets up the engine net. When done, the EngineNet
will be ready to inform on what data is available
(Inherited from Mike1DController.) | |
DoPrepare |
Prepare the engine. This is called just before run is called.
(Inherited from Mike1DController.) | |
DoPrepareBoundaryData |
Prepares boundary data.
(Inherited from Mike1DController.) | |
DoPrepareCatchmentResultFiles |
Prepares catchment result files.
(Inherited from Mike1DController.) | |
DoPrepareDiagnostics |
Prepares runtime diagnostics.
(Inherited from Mike1DController.) | |
DoPrepareLTSModule |
Prepares LTS module.
(Inherited from Mike1DController.) | |
DoPrepareResultFileFolder |
Prepares result file folder.
(Inherited from Mike1DController.) | |
DoRun |
Run the engine to end of simulation.
(Inherited from Mike1DController.) | |
DoRunUntil |
Run the engine to specified end time.
(Inherited from Mike1DController.) | |
DoStopSimulation |
Calling this function will end the simulation after the current timestep has been completed
(Inherited from Mike1DController.) | |
DoValidate |
Validate that the Controller does not have any errors/warnings
(Inherited from Mike1DController.) | |
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
Finalize | Allows 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.
(Inherited from AbstractMike1DController.) | |
GetHashCode | Serves as the default hash function. (Inherited from Object.) | |
GetLTSResultSpecifications |
Produces LTS result specification.
(Inherited from Mike1DController.) | |
GetType | Gets 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
(Inherited from AbstractMike1DController.) | |
InitTimings | Initiate timings (Inherited from Mike1DController.) | |
InvokeControllerProgressEvent |
Call to invoke a progress event
(Inherited from AbstractMike1DController.) | |
IsInActiveState |
Returns true if the controller is in an active
state and currently executing.
(Inherited from AbstractMike1DController.) | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
Open |
Open the file specified by the connection.
(Inherited from Mike1DController.) | |
Prepare |
Prepare the engine. This is called just before run is called. I will
set the initial state (initial conditions), open output files etc.
(Inherited from AbstractMike1DController.) | |
RaiseControllerFailedEvent |
Put controller in a failed state, and issue a failed event on ControllerEvent (Inherited from AbstractMike1DController.) | |
RaiseSpecialEvent |
Trigger a custom special event
(Inherited from AbstractMike1DController.) | |
ReadStartStates |
Ensemble member controllers reads the start state through the Main DA module and not through the controller.
(Overrides Mike1DControllerReadStartStates.) | |
ReadState |
Reading starting state of a MIKE 1D controller from a state file.
Used when a reader is already defined - could ex. be used to read the starting state of DA ensemble member
(Inherited from Mike1DController.) | |
Run |
Run the engine
(Inherited from AbstractMike1DController.) | |
RunManual |
Must be called when running the engine manually, timestep by timestep, i.e. when not using the
Run or RunUntil(DateTime) methods.
(Inherited from AbstractMike1DController.)This is required for correctly transferring the engine to the run state before taking the time step. | |
RunUntil |
Run the engine until endTime.
(Inherited from AbstractMike1DController.)endTime should not exceed the simulation end time. | |
SetupStateWriting |
Ensemble member controllers writes the controller state through the Main DA module and not through the controller.
(Overrides Mike1DControllerSetupStateWriting.) | |
StopSimulation |
Calling this function will end the simulation after the current timestep has been completed
(Inherited from AbstractMike1DController.) | |
ToString | Returns 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).
(Inherited from AbstractMike1DController.) | |
WriteState |
Writing current state of a MIKE 1D controller to a state file.
Used when a writer is already defined - could ex. be used to write the DA ensemble member
(Inherited from Mike1DController.) |