CompositStructure Class |
Composit structure is a structure which contains one or more structures at the same location.
Uses the Composite Pattern.
Inheritance HierarchyNamespace: DHI.Mike1D.StructureModule
Assembly: DHI.Mike1D.StructureModule (in DHI.Mike1D.StructureModule.dll) Version: 19.0.0.0 (11.1.1.1111)
SyntaxThe CompositStructure type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | CompositStructure | Initializes a new instance of the CompositStructure class |
Properties| Name | Description | |
|---|---|---|
 | dDischargedDownStreamWaterLevel |
Calculated Discharge derivative with DownStreamWaterLevel. Downstream is relative to the direction of chainage.
The value is calculated by SetWaterLevels.
Unit: [m^2/s]
|
| dDischargedUpStreamWaterLevel |
Calculated Discharge derivative with UpStreamWaterLevel. Upstream is relative to the direction of chainage.
The value is calculated by SetWaterLevels.
Unit: [m^2/s]
|
| Diagnostics |
Validate composite structure
|
| Discharge |
Calculated Discharge. The value is calculated by SetWaterLevels.
Unit: [m^3/s]
|
| ID | |
| InvertLevelDownstream | |
| InvertLevelUpstream | |
| Location |
Location property.
|
| MaximumIterations |
Maximum number of iterations
|
| Structures |
Getter to the list of structures
|
| TotalIterations |
Methods| Name | Description | |
|---|---|---|
| Add | |
| 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 the default hash function. (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.) |
| Prepare | |
| PrepareTimeStep |
Prepare structure for time step
This method need only be called in case structures are being controlled and i.e. a gate is closing with a specified speed and needs to know time. |
| SetWaterLevels(Double, Double) |
Sets up- and down- stream water level and forces the calculation of the discharge and its derivatives.
|
| SetWaterLevels(Double, Double, Double, Double) |
Sets up- and down-stream water level and forces the calculation of the discharge and its derivatives.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Validate |
See Also