Click or drag to resize

OverFlowGate Properties

The OverFlowGate type exposes the following members.

Properties
  NameDescription
Public propertyActualGateLevel
Actual gate level. Type: River Structure Geometry Unit: [m] Default: 0

this is not a setup parameter, but a run parameter, which will change during the run (if the gate is controlled). If the gate is not controlled, this can be used to change the gate (manual/user defined control).

(Inherited from SquaredGatedBCWeir.)
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 propertyDelhs
Linear flow variation. For water level differences less than delhs use a linear Q variation between h1-h2=delhs and h1-h2=0. This is to avoid stability problems for small water level differences where dQdh goes to infinity. Unit: [m] Default: 0.01
(Inherited from AbstractBroadCrestedCWeir.)
Public propertyDischarge
Calculated Discharge. The value is calculated by SetWaterLevels. Unit: [m^3/s]
(Inherited from Structure.)
Public propertyDownstreamCrossSection
Downstream cross section data. The cros section data is the processed level, with, area. Set up during initialize, from cross section database.
(Inherited from AbstractBroadCrestedCWeir.)
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 in the structure. Uses WaterLevelInStructure which is updated when SetWaterLevels() is called.
(Inherited from AbstractBroadCrestedCWeir.)
Public propertyFlowFactor
The discharge (and discharge derivatives) are scaled by the flow factor.
(Inherited from Structure.)
Public propertyHeadLossFreeOverflowNegativeFlow
Free overflow factor for negative flow. Default value = 1.
(Inherited from AbstractBroadCrestedCWeir.)
Public propertyHeadLossFreeOverflowPositiveFlow
Free overflow factor for positive flow. Default value = 1.
(Inherited from AbstractBroadCrestedCWeir.)
Public propertyHeadLossInflowNegativeFlow
Inflow head loss factor for positive flow. Default value = 0.5.
(Inherited from AbstractBroadCrestedCWeir.)
Public propertyHeadLossInflowPositiveFlow
Inflow head loss factor for positive flow. Default value = 0.5.
(Inherited from AbstractBroadCrestedCWeir.)
Public propertyHeadLossOutflowNegativeFlow
Free overflow factor for negative flow. Default value = 1.
(Inherited from AbstractBroadCrestedCWeir.)
Public propertyHeadLossOutflowPositiveFlow
Outflow head loss factor for positive flow. Default value = 1.
(Inherited from AbstractBroadCrestedCWeir.)
Public propertyHorizontalOffSetFromMarker2
Value used when plotting the structue Unit: [m] Defualt: 0
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 propertyInitialGateLevel
Gate level. Type: River Structure Geometry Unit: [m] Default: 0
(Inherited from SquaredGatedBCWeir.)
Public propertyInvertLevelDownstream
Invert level down stream
(Overrides SquareBroadCrestedWeirInvertLevelDownstream.)
Public propertyInvertLevelUpstream
Invert level up stream
(Overrides SquareBroadCrestedWeirInvertLevelUpstream.)
Public propertyIterationTolerance
Iteration tolerance. Default 0.0001
(Inherited from AbstractBroadCrestedCWeir.)
Public propertyLength
Length of the structure. Unit: [m] Default value: 0m
(Inherited from Structure.)
Public propertyLocation
Location property.
(Inherited from Structure.)
Public propertyMaximumIterations
Maximum number of iterations in a structure to obtain convergence of the discharge. Default value = 100

Currently this is set for all structures from the MaximumIterationsInStructure, but it is prepared for individual structure values.

(Inherited from AbstractBroadCrestedCWeir.)
Public propertyMaxSpeed
Maximum speed of gate movement
(Inherited from SquaredGatedBCWeir.)
Public propertyMaxValue
Maximum value of gate level that a control can set in Control()
(Inherited from SquaredGatedBCWeir.)
Public propertyMinimumHeadloss
Minimum headloss across a structure. Default value = 0.1

Currently this is set for all head loss structures from the MinimumHeadloss, but it is prepared for individual structure values.

(Inherited from AbstractBroadCrestedCWeir.)
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
(Inherited from SquaredGatedBCWeir.)
Public propertyPartOfCompositeFlow
When the culvert is part of a composite structure Q1=Q2 will differ from Qs. Qs=Q1*_partOfCompositeFlow;
(Inherited from AbstractBroadCrestedCWeir.)
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 propertySillLevel
Sill level
(Inherited from SquareBroadCrestedWeir.)
Public propertyStructureIterationCentering
Free overflow factor for negative flow. Default value = 1.
(Inherited from AbstractBroadCrestedCWeir.)
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 SquareBroadCrestedWeirType.)
Public propertyUpstreamCrossSection
Upstream cross section data. The cros section data is the processed level, with, area. Set up during initialize, from cross section database.
(Inherited from AbstractBroadCrestedCWeir.)
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 propertyUseMaxValue
True if gate level should be restricted by MaxValue in Control()
(Inherited from SquaredGatedBCWeir.)
Public propertyValve
Type of the valve Default: None
(Inherited from ValvedStructure.)
Public propertyWaterLevelInStructure
Water level in the structure at the latest call to SetWaterLevels()
(Inherited from AbstractBroadCrestedCWeir.)
Public propertyWidth
Width of ther squared broad crested weir
(Inherited from SquareBroadCrestedWeir.)
Top
See Also