Click or drag to resize

Mike1DControllerLTS Methods

The Mike1DControllerLTS type exposes the following members.

Methods
  NameDescription
Protected methodChangeControllerState
Change the state of the controller. Also triggers the ControllerEvent
(Inherited from AbstractMike1DController.)
Protected methodDoFinish
Finish and clean up
(Inherited from Mike1DController.)
Protected methodDoInitialize
Initialize the engine. Initialize sets up the engine net. When done, the EngineNet will be ready to inform on what data is available
(Overrides Mike1DControllerDoInitialize(IDiagnostics).)
Protected methodDoPrepare
Prepare the engine. This is called just before run is called.
(Overrides Mike1DControllerDoPrepare.)
Protected methodDoPrepareBoundaryData
Prepares boundary data.
(Inherited from Mike1DController.)
Protected methodDoPrepareCatchmentResultFiles
Prepares catchment result files.
(Inherited from Mike1DController.)
Protected methodDoPrepareDiagnostics
Prepares runtime diagnostics.
(Inherited from Mike1DController.)
Protected methodDoPrepareLTSModule
Prepares LTS module.
(Overrides Mike1DControllerDoPrepareLTSModule.)
Protected methodDoPrepareResultFileFolder
Prepares result file folder.
(Inherited from Mike1DController.)
Protected methodDoRun
Run the engine to end of simulation.
(Overrides Mike1DControllerDoRun.)
Protected methodDoRunUntil
Run the engine to specified end time.
(Inherited from Mike1DController.)
Protected methodDoStopSimulation
Calling this function will end the simulation after the current timestep has been completed
(Overrides Mike1DControllerDoStopSimulation.)
Protected methodDoValidate
Validate that the Controller does not have any errors/warnings
(Overrides Mike1DControllerDoValidate.)
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.
(Inherited from AbstractMike1DController.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Protected methodGetLTSResultSpecifications
Produces LTS result specification.
(Overrides Mike1DControllerGetLTSResultSpecifications.)
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
(Inherited from AbstractMike1DController.)
Protected methodInitTimings
Initiate timings
(Inherited from Mike1DController.)
Protected methodInvokeControllerProgressEvent
Call to invoke a progress event
(Inherited from AbstractMike1DController.)
Public methodIsInActiveState
Returns true if the controller is in an active state and currently executing.
(Inherited from AbstractMike1DController.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodOpen
Open the file specified by the connection.
(Inherited from Mike1DController.)
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.
(Inherited from AbstractMike1DController.)
Protected methodRaiseControllerFailedEvent
Put controller in a failed state, and issue a failed event on ControllerEvent
(Inherited from AbstractMike1DController.)
Public methodRaiseSpecialEvent
Trigger a custom special event
(Inherited from AbstractMike1DController.)
Protected methodReadStartStates
Read the controller start state. It is in a method to let the Mike1DControllerEM objects skip this part
(Inherited from Mike1DController.)
Public methodReadState
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.)
Public methodRun
Run the engine
(Inherited from AbstractMike1DController.)
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.

(Inherited from AbstractMike1DController.)
Public methodRunUntil
Run the engine until endTime.

endTime should not exceed the simulation end time.

(Inherited from AbstractMike1DController.)
Protected methodSetupStateWriting
Setup writing of the controller state. It is in a method to let the Mike1DControllerEM objects skip this part
(Inherited from Mike1DController.)
Public methodStopSimulation
Calling this function will end the simulation after the current timestep has been completed
(Inherited from AbstractMike1DController.)
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).
(Inherited from AbstractMike1DController.)
Public methodWriteState
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.)
Top
See Also