IStructure Properties |
The IStructure type exposes the following members.
| 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]
| |
| Discharge |
Calculated Discharge
Unit: [m^3/s]
| |
| DownstreamWaterLevel |
Downstream water level.Downstream refers to the direction of chainge. The water level is set by use of
SetWaterLevels
Unit: [m]
| |
| ID |
Name of the structure.
| |
| IDInUserUnit | Obsolete.
Used to get a consistent description of the structure. The ID comes in user units. Used e.g. when
reporting errors, warnings and hints.
| |
| Implicit |
Flag to control if the structure is implicit or explicit. If the structure is explicit
(Implicit == false) then the derivatives of the dicharge are always zero.
Default value: true
| |
| InvertLevelDownstream |
Invert level down stream
The invert level is the level where water starts
flowing in to the structure from the downstream side.
It does not necessarily flow through the structure.
| |
| InvertLevelUpstream |
Invert level up stream.
The invert level is the level where water starts
flowing in to the structure from the upstream side.
It does not necessarily flow through the structure.
| |
| Length | Obsolete.
Length of the structure.
Unit: [m]
| |
| Location |
Location of structure.
| |
| RunTimeDiagnostics |
The getter is used to get a list of errors. OBSOLETE
| |
| SideStructureBank |
Bank side that side-structure is located on
If side structure contains reservoir, and has the Coordinate set, this is not used (and should be set to Undefined). | |
| SideStructureReservoir |
Reservoir at end of side structure. Null if not side structure, or no reservoir is defined
| |
| StructureType |
Type of structure
| |
| TopoID |
TopoID used when structure is searching for neighbouring cross sections in the reach.
| |
| Type |
Structure type, unique for each type of structure.
| |
| UpstreamWaterLevel |
Upstream water level. Upstream refers to the direction of chainage. The water level is set by use of
SetWaterLevels
Unit: [m]
|