HDDomain Class |
A HD Domain is a subset of a network, used when domain decomposing the solution
Inheritance HierarchyNamespace: DHI.Mike1D.Engine.ModuleHD
Assembly: DHI.Mike1D.Engine (in DHI.Mike1D.Engine.dll) Version: 16.0.0.0 (11.1.1.1111)
SyntaxC#
public class HDDomain
The HDDomain type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | HDDomain |
Constructor creating a new HDModule and initializing it with the given EngineNet and
HD parameters.
|
Properties| Name | Description | |
|---|---|---|
 | IterationNumber |
Iteration number. Access to the iteration number is needed in the control module (via a sensor)
|
| Nodes |
List of all HD nodes in network.
Need not include all Engine nodes, use the GetHDNode(EngineNode) to check if a given engine node also has a corresponding HD node. |
| Reaches |
List of all HD reaches in network.
Need not include all Engine reaches, use the GetReach(EngineReach) to check if a given engine reach also has a corresponding HD reach. |
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.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| 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 one time step. Return true if time step succeeded, or false if it failed.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Events| Name | Description | |
|---|---|---|
 | PreIterationEvent |
An event that is called everytime a timestep was successfully performed.
|
See Also