IModule Interface

Interface to Engine modules

Namespace: DHI.Mike1D.Engine
Assembly: DHI.Mike1D.Engine (in DHI.Mike1D.Engine.dll) Version: 16.0.0.0 (11.1.1.1111)

Syntax

public interface IModule : IProxyProvider

The IModule type exposes the following members.

Properties

	Name	Description
	Order	Order of module. Modules are processed in order.

Methods

	Name	Description
	FinalizeTimestep	FinalizeTimeStep allows the modules to do operations required when a time step has successfully completed
	Finish	Finishes the module and releases any license
	GetProxy	Get a proxy for generic/global data (Inherited from IProxyProvider.)
	GetProxy(EngineNode)	Get a proxy for the node (Inherited from IProxyProvider.)
	GetProxy(EngineReach)	Get a proxy for the reach, covering a number of gridpoints (Inherited from IProxyProvider.)
	GetProxy(EngineReach, Int32)	Get a proxy for the gridpoint in the reach (Inherited from IProxyProvider.)
	GetProxyReachGeneric	Get a proxy for the reach, generic data (not gridpoint associated) (Inherited from IProxyProvider.)
	PerformTimestep	Perform timestep and return true if solution is accepted. Can be called several times for different values of Dt.
	PreferredTimeStep	Returns the preferred time step for the current state. It is called between every time step and can increase as well as decrease the time step. Used when AdaptiveTimeSteppingActivated is true. Do return the maximum of the allowed time step; in case a buffer is required, this is handled by a time step controller.
	Prepare	Prepare module for first time step.
	PrepareForTimeStep	Prepare module for time step (set state(n+1) = state(n)).