Click or drag to resize

DischargeStructure Properties

The DischargeStructure type exposes the following members.

Properties
  NameDescription
Public propertyActualDischarge
Discharge for a single structure.
Public propertyControlledMaxDischarge
Maximum limit on discharge controllable from outside. Only used if _useControlledMaxDischarge == true
Public propertyControlledMinDischarge
Minimum limit on discharge controllable from outside. Only used if _useControlledMinDischarge == true
Public propertydDischargedDownStreamWaterLevel
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.)
Public propertydDischargedUpStreamWaterLevel
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.)
Public propertyDischarge
Calculated Discharge. The value is calculated by SetWaterLevels. Unit: [m^3/s]
(Inherited from Structure.)
Public propertyDownstreamWaterLevel
Downstream water level.Downstream refers to the direction of chainage. The water level is set by use of SetWaterLevels Unit: [m]
(Inherited from Structure.)
Public propertyExtensionData
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.)
Public propertyFlowArea
Flow area through structure. Used by most (but not all) structures.
(Inherited from Structure.)
Public propertyFlowFactor
The discharge (and discharge derivatives) are scaled by the flow factor.
(Inherited from Structure.)
Public propertyID
Structure ID
(Inherited from Structure.)
Public propertyIDInUserUnit
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.)
Public propertyImplicit
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.)
Public propertyInitialDischarge
Initial value of the discharge. Default: 0
Public propertyInvertLevelDownstream
Invert level down stream
(Overrides StructureInvertLevelDownstream.)
Public propertyInvertLevelUpstream
Invert level up stream
(Overrides StructureInvertLevelUpstream.)
Public propertyLength
Length of the structure. Unit: [m] Default value: 0m
(Inherited from Structure.)
Public propertyLocation
Location property.
(Inherited from Structure.)
Public propertyMaxDischarge
Maximum discharge. The discharge (absolute value) can not be raised above this level. Default: double.MaxValue
Public propertyMaxDischargeSpeed
The maximum allowed rate of change of the discharge level. Default: double.MaxValue
Public propertyMultiplicator
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
Public propertyRunTimeDiagnostics
The getter is used to get a list of errors.
(Inherited from Structure.)
Public propertySideStructureBank
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).

(Inherited from Structure.)
Public propertySideStructureReservoir
Reservoir at end of side structure. Null if not side structure, or no reservoir is defined
(Inherited from Structure.)
Public propertyStructureType
Type of structure
(Inherited from Structure.)
Public propertyTopoID
String used to identified cross sections
(Inherited from Structure.)
Public propertyType
Structure type, unique for each structure.
(Overrides StructureType.)
Public propertyUpstreamWaterLevel
Upstream water level. Upstream refers to the direction of chainage. The water level is set by use of SetWaterLevels Unit: [m]
(Inherited from Structure.)
Public propertyUseControlledMaxDischarge
Use the controllable maximum discharge

Automatically set when controlling maximum discharge

Public propertyUseControlledMinDischarge
Use the controllable minimum discharge

Automatically set when controlling minimum discharge

Public propertyUseMaxDischarge
Use the controllable maximum discharge level
Top
See Also