QHStructure Properties

Properties

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)
EnableCheckFlowDirectionOscillations Flag indicating whether to use special check and damping for structure discharge oscillating around zero.
(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)
HQRelation QH relation for QH and QdeltaH pumps
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)
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)
Offset Offset on QH relation, subtracted from the water level before looking up in the HQRelation
RunTimeDiagnostics The getter is used to get a list of errors.
(Inherited from Structure)
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).


(Inherited from Structure)
SideStructureReservoir Reservoir at end of side structure. Null if not side structure, or no reservoir is defined
(Inherited from Structure)
SmoothingFactor Exponential smoothing factor for structure discharge. The smoothing factor is the weight of the previous discharge on the new discharge: q = (1 - SmoothingFactor) * qStructure + SmoothingFactor * qPrevious
(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)
WaterLevelDifferenceMinimal Water level difference below which it is assumed that structure has no flow.
(Inherited from Structure)

See Also