ICompositStructure Interface |
Collection of structures at the same location. Interface used by the engines.
Namespace: DHI.Mike1D.StructureModule
Assembly: DHI.Mike1D.StructureModule (in DHI.Mike1D.StructureModule.dll) Version: 19.0.0.0 (11.1.1.1111)
SyntaxThe ICompositStructure type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | dDischargedDownStreamWaterLevel |
Calculated Discharge derivative with UpStreamWaterLevel. Upstream is relative to the direction of chainage.
Unit: [m^2/s]
|
| dDischargedUpStreamWaterLevel |
Calculated Discharge derivative with DownStreamWaterLevel. Downstream is relative to the direction of chainage.
Unit: [m^2/s]
|
| Diagnostics |
The getter is used to get a list of errors.
|
| Discharge |
Get discharge across structure. SetWaterLevels() calculates the discharge so it must be called first.
|
| ID | |
| InvertLevelDownstream |
Invert level downstream
Unit: [m]
|
| InvertLevelUpstream |
Invert level upstream
Unit: [m]
|
| Location |
Location of the structure
|
| Structures |
Getter to the list of structures
|
| TotalIterations |
Total number of composit structure iterations.
|
Methods| Name | Description | |
|---|---|---|
 | Prepare |
Prepare for simulation
|
| 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.
|
| Validate |
Writes errors, warnings and hints into their respective member classes. The member objects are initially cleared.
|
See Also