Mike1DController Class

Default constructor

The logfilewriter will be created based on the input file name, or connection properties, when calling the Open(IConnection, IDiagnostics) method.

Make a controller that uses the provided diagnosticsHandler for handling diagnostics messages. This is convenient if the diagnosticsHandler is to be resued by more than one controller.

Current time of simulation

Handler, taking care of diagnostics messages.

The enginenet used for the simulation

Bool indicating that the controller is in a failed state

The Mike1DData that defines the simulation setup

Minimum number of seconds between the ControllerProgressEvent is triggered.

Progress state of the controller, specifying how far the controller has progressed. One of Initialized,Prepared,Running.

List of all result data components associated with

Diagnostics that are used during the simulation (prepare, run)

String to indicate the type of simulation being run. Used for user output only.

Current state of the controller

State writer, if enabled. Available after Prepare

Detailed timings of the different parts of the simulation.

Change the state of the controller. Also triggers the ControllerEvent

Finish and clean up

Initialize the engine. Initialize sets up the engine net. When done, the EngineNet will be ready to inform on what data is available

Prepare the engine. This is called just before run is called.

Prepares boundary data.

Prepares catchment result files.

Prepares runtime diagnostics.

Prepares LTS module.

Prepares result file folder.

Run the engine to end of simulation.

Run the engine to specified end time.

Calling this function will end the simulation after the current timestep has been completed

Validate that the Controller does not have any errors/warnings

Determines whether the specified object is equal to the current object.

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.

Finish and clean up.

Serves as the default hash function.

Produces LTS result specification.

Gets the Type of the current instance.

Initialize the engine. Initialize sets up the engine net. When done, the EngineNet will be ready to inform on what data is available

Initiate timings

Call to invoke a progress event

Returns true if the controller is in an active state and currently executing.

Creates a Mike1DController and loads the setup. The setup is loaded with all default parameters.

In case of errors when loading the setup, a Mike1DException is thrown. Errors can be examined by extracting the IDiagnostics object stored in Data using string key "Diagnostics".

Creates a Mike1DController and loads the setup. The setup is loaded with all default parameters

Creates a shallow copy of the current Object.

Open the file specified by the connection.

Prepare the engine. This is called just before run is called. I will set the initial state (initial conditions), open output files etc.

Put controller in a failed state, and issue a failed event on ControllerEvent

Trigger a custom special event

Read the controller start state. It is in a method to let the Mike1DControllerEM objects skip this part

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

Run the engine

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.

Run the engine until endTime.

endTime should not exceed the simulation end time.

Setup writing of the controller state. It is in a method to let the Mike1DControllerEM objects skip this part

Calling this function will end the simulation after the current timestep has been completed

Returns a string that represents the current object.

Validate that the Controller/data access modules does not have any errors/warnings. Can be called before Initialize(IDiagnostics).

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

Event that is raised while the controller is running. It is raised whenever the State of the controller changes.

Controller progress event, triggered whenever the controller has progressed, though no more often than MinSecondsBetweenProgressEvent

Event that is raised for special events

EngineNet

Global (entire) EngineNet. Used when decomposing setup into several domains, where this contains the full EngineNet

MIKE 1D data object

Active result data objects

Diagnostics object used during runtime

Current state of controller

Flag indicating whether to suppress unknown exception.

Timings used in controller

Timings used during prepare

Timings used during runtime

Maximum number of threads, set by the user.

Use Threaded domain decomposition

Check if controller is in a state to write HTML summary