DischargeStructure Properties |
The DischargeStructure type exposes the following members.
Name | Description | |
---|---|---|
![]() | ActualDischarge |
Discharge for a single structure.
|
![]() | ControlledMaxDischarge |
Maximum limit on discharge controllable from outside.
Only used if _useControlledMaxDischarge == true
|
![]() | ControlledMinDischarge |
Minimum limit on discharge controllable from outside.
Only used if _useControlledMinDischarge == true
|
![]() | dDischargedDownStreamWaterLevel |
Calculated Discharge derivative with DownStreamWaterLevel. Downstream is relative to the direction of chainage.
The value is calculated by SetWaterLevels.
Unit: [m^2/s]
(Inherited from Structure.) |
![]() | dDischargedUpStreamWaterLevel |
Calculated Discharge derivative with UpStreamWaterLevel. Upstream is relative to the direction of chainage.
The value is calculated by SetWaterLevels.
Unit: [m^2/s]
(Inherited from Structure.) |
![]() | Discharge |
Calculated Discharge. The value is calculated by SetWaterLevels.
Unit: [m^3/s]
(Inherited from Structure.) |
![]() | DownstreamWaterLevel |
Downstream water level.Downstream refers to the direction of chainage. The water level is set by use of
SetWaterLevels
Unit: [m]
(Inherited from Structure.) |
![]() | ExtensionData |
Property used by (de)serializer, when it can not find proper target for
a data field. Support of forward compatible data contracts.
(Inherited from Structure.) |
![]() | FlowArea |
Flow area through structure. Used by most (but not all) structures.
(Inherited from Structure.) |
![]() | FlowFactor |
The discharge (and discharge derivatives) are scaled by the flow factor.
(Inherited from Structure.) |
![]() | ID |
Structure ID
(Inherited from Structure.) |
![]() | 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.
(Inherited from Structure.) |
![]() | 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
(Inherited from Structure.) |
![]() | InitialDischarge |
Initial value of the discharge.
Default: 0
|
![]() | InvertLevelDownstream |
Invert level down stream
(Overrides StructureInvertLevelDownstream.) |
![]() | InvertLevelUpstream |
Invert level up stream
(Overrides StructureInvertLevelUpstream.) |
![]() | Length |
Length of the structure.
Unit: [m]
Default value: 0m
(Inherited from Structure.) |
![]() | Location |
Location property.
(Inherited from Structure.) |
![]() | MaxDischarge |
Maximum discharge. The discharge (absolute value) can not be raised above this level.
Default: double.MaxValue
|
![]() | MaxDischargeSpeed |
The maximum allowed rate of change of the discharge level.
Default: double.MaxValue
|
![]() | Multiplicator |
Multiplicator or "number of structures" of this type.
Used for modelling more structures at the same
location with the same geometry in one go.
Unit: []
Default: 1
|
![]() | RunTimeDiagnostics |
The getter is used to get a list of errors.
(Inherited from Structure.) |
![]() | SideStructureBank |
Bank side that side-structure is located on
(Inherited from Structure.)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
(Inherited from Structure.) |
![]() | StructureType |
Type of structure
(Inherited from Structure.) |
![]() | TopoID |
String used to identified cross sections
(Inherited from Structure.) |
![]() | Type |
Structure type, unique for each structure.
(Overrides StructureType.) |
![]() | UpstreamWaterLevel |
Upstream water level. Upstream refers to the direction of chainage. The water level is set by use of
SetWaterLevels
Unit: [m]
(Inherited from Structure.) |
![]() | UseControlledMaxDischarge |
Use the controllable maximum discharge
Automatically set when controlling maximum discharge |
![]() | UseControlledMinDischarge |
Use the controllable minimum discharge
Automatically set when controlling minimum discharge |
![]() | UseMaxDischarge |
Use the controllable maximum discharge level
|