Structure Properties |
The Structure type exposes the following members.
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]
| |
Discharge |
Calculated Discharge. The value is calculated by SetWaterLevels.
Unit: [m^3/s]
| |
DownstreamWaterLevel |
Downstream water level.Downstream refers to the direction of chainage. The water level is set by use of
SetWaterLevels
Unit: [m]
| |
ExtensionData |
Property used by (de)serializer, when it can not find proper target for
a data field. Support of forward compatible data contracts.
| |
FlowArea |
Flow area through structure. Used by most (but not all) structures.
| |
FlowFactor |
The discharge (and discharge derivatives) are scaled by the flow factor.
| |
ID |
Structure ID
| |
IDInUserUnit |
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
| |
InvertLevelUpstream |
Invert level up stream
| |
Length |
Length of the structure.
Unit: [m]
Default value: 0m
| |
Location |
Location property.
| |
RunTimeDiagnostics |
The getter is used to get a list of errors.
| |
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 |
String used to identified cross sections
| |
Type |
Structure type, unique for each type structure.
| |
UpstreamWaterLevel |
Upstream water level. Upstream refers to the direction of chainage. The water level is set by use of
SetWaterLevels
Unit: [m]
|