Mike1DControllerRRCalibrate Class

The Mike1DController is the entry point for automatic RR calibration.

It will loop through all catchments that has auto calibration enabled, and calibrate each of these individually. When the controller is done, it will update the catchment parameters to contain the optimal parameters.

Inheritance Hierarchy

SystemObject
DHI.Mike1D.Mike1DDataAccessAbstractMike1DController
DHI.Mike1D.Mike1DDataAccessMike1DControllerRRCalibrate

Namespace: DHI.Mike1D.Mike1DDataAccess
Assembly: DHI.Mike1D.Mike1DDataAccess (in DHI.Mike1D.Mike1DDataAccess.dll) Version: 19.0.0.0 (11.1.1.1111)

Syntax

C++

Copy

public class Mike1DControllerRRCalibrate : AbstractMike1DController

Public Class Mike1DControllerRRCalibrate
	Inherits AbstractMike1DController

public ref class Mike1DControllerRRCalibrate : public AbstractMike1DController

The Mike1DControllerRRCalibrate type exposes the following members.

Constructors

	Name	Description
	Mike1DControllerRRCalibrate	Base constructor
	Mike1DControllerRRCalibrate(DiagnosticsHandler)	Base constructor

Top

Properties

	Name	Description
	CurrentTime	Current time of simulation (Inherited from AbstractMike1DController.)
	DiagnosticsHandler	Handler, taking care of diagnostics messages. (Inherited from AbstractMike1DController.)
	EngineNet	The enginenet used for the simulation (Inherited from AbstractMike1DController.)
	IsFailed	Bool indicating that the controller is in a failed state (Inherited from AbstractMike1DController.)
	Mike1DData	The Mike1DData that defines the simulation setup (Inherited from AbstractMike1DController.)
	MinSecondsBetweenProgressEvent	Minimum number of seconds between the ControllerProgressEvent is triggered. (Inherited from AbstractMike1DController.)
	Progress	Progress object for calibrator
	ProgressState	Progress state of the controller, specifying how far the controller has progressed. One of Initialized,Prepared,Running. (Inherited from AbstractMike1DController.)
	ResultDataList	List of all result data components associated with (Inherited from AbstractMike1DController.)
	RuntimeDiagnostics	Diagnostics that are used during the simulation (prepare, run) (Inherited from AbstractMike1DController.)
	SimulationType	String to indicate the type of simulation being run. Used for user output only. (Overrides AbstractMike1DControllerSimulationType.)
	State	Current state of the controller (Inherited from AbstractMike1DController.)
	Timings	Detailed timings of the different parts of the simulation. (Inherited from AbstractMike1DController.)

Top

Methods

	Name	Description
	ChangeControllerState	Change the state of the controller. Also triggers the ControllerEvent (Inherited from AbstractMike1DController.)
	DoFinish	Finish and clean up (Overrides AbstractMike1DControllerDoFinish.)
	DoInitialize	Initialize the engine. Initialize sets up the engine net. When done, the EngineNet will be ready to inform on what data is available (Overrides AbstractMike1DControllerDoInitialize(IDiagnostics).)
	DoPrepare	Prepare the engine. This is called just before run is called. (Overrides AbstractMike1DControllerDoPrepare.)
	DoRun	Run the engine (Overrides AbstractMike1DControllerDoRun.)
	DoRunUntil	Do RunUntil. Virtual method that must be overridden (Inherited from AbstractMike1DController.)
	DoStopSimulation	Calling this function will end the simulation after the current timestep has been completed (Overrides AbstractMike1DControllerDoStopSimulation.)
	DoValidate	Validate that the Controller does not have any errors/warnings (Overrides AbstractMike1DControllerDoValidate.)
	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.)
	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 (Overrides AbstractMike1DControllerInitTimings.)
	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.)
	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.)
	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. This is required for correctly transferring the engine to the run state before taking the time step. (Inherited from AbstractMike1DController.)
	RunUntil	Run the engine until endTime. endTime should not exceed the simulation end time. (Inherited from AbstractMike1DController.)
	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.)

Top

Events

	Name	Description
	ControllerEvent	Event that is raised while the controller is running. It is raised whenever the State of the controller changes. (Inherited from AbstractMike1DController.)
	ControllerProgressEvent	Controller progress event, triggered whenever the controller has progressed, though no more often than MinSecondsBetweenProgressEvent (Inherited from AbstractMike1DController.)
	SpecialEvent	Event that is raised for special events (Inherited from AbstractMike1DController.)

Top

Fields

	Name	Description
	_engineNet	EngineNet (Inherited from AbstractMike1DController.)
	_engineNetGlobal	Global (entire) EngineNet. Used when decomposing setup into several domains, where this contains the full EngineNet (Inherited from AbstractMike1DController.)
	_mike1DData	MIKE 1D data object (Inherited from AbstractMike1DController.)
	_resultDataList	Active result data objects (Inherited from AbstractMike1DController.)
	_runtimeDiagnostics	Diagnostics object used during runtime (Inherited from AbstractMike1DController.)
	_state	Current state of controller (Inherited from AbstractMike1DController.)
	_suppressUnknownExceptions	Flag indicating whether to suppress unknown exception. (Inherited from AbstractMike1DController.)
	_timings	Timings used in controller (Inherited from AbstractMike1DController.)

Top

Reference

DHI.Mike1D.Mike1DDataAccess Namespace