IModule Interface |
Interface to Engine modules
Namespace: DHI.Mike1D.Engine
Assembly: DHI.Mike1D.Engine (in DHI.Mike1D.Engine.dll) Version: 19.0.0.0 (11.1.1.1111)
SyntaxThe IModule type exposes the following members.
Properties
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
|
| 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)).
|
Extension Methods| Name | Description | |
|---|---|---|
 | GetProxy | Overloaded. (Defined by EngineExtensions.) |
| GetProxy(EngineNode) | Overloaded. (Defined by EngineExtensions.) |
| GetProxy(EngineReach) | Overloaded. (Defined by EngineExtensions.) |
| GetProxy(EngineReach, Int32) | Overloaded. (Defined by EngineExtensions.) |
| GetProxyReachGeneric | (Defined by EngineExtensions.) |
See Also