HDSteadyModule Class |
Steady state module.
Inheritance HierarchyNamespace: DHI.Mike1D.Engine.ModuleSteady
Assembly: DHI.Mike1D.Engine (in DHI.Mike1D.Engine.dll) Version: 16.0.0.0 (11.1.1.1111)
SyntaxC#
public class HDSteadyModule : IModule, IProxyProvider
The HDSteadyModule type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | HDSteadyModule |
Constructor
|
Properties| Name | Description | |
|---|---|---|
 | EngineNet |
Engine net
|
| Order |
Order of module. Modules are processed in order.
|
| Time |
Simulation time
|
Methods| Name | Description | |
|---|---|---|
| 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.) |
| FinalizeTimestep |
FinalizeTimeStep allows the modules to do operations required when
a time step has successfully completed
|
| Finish |
Release any license and clean up
|
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetProxy |
Get a proxy for generic/global data
|
| GetProxy(EngineNode) |
Get a proxy for the node
|
| GetProxy(EngineReach) |
Get a proxy for the reach, covering a number of gridpoints
|
| GetProxy(EngineReach, Int32) |
Get a proxy for the gridpoint in the reach
|
| GetProxyReachGeneric |
Get a proxy for the reach, generic data (not gridpoint associated)
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| 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)).
|
| Setup |
Setup module
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See Also