IModule Interface

Interface to Engine modules

Definition

Namespace: DHI.Mike1D.Engine
Assembly: DHI.Mike1D.Engine (in DHI.Mike1D.Engine.dll) Version: 24.0.0.0 (11.1.1.1111)
C#
public interface IModule

Properties

Id Id of module
Order Order of module. Modules are processed in order.

Methods

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

See Also