Click or drag to resize

Gate Fields

The Gate type exposes the following members.

Fields
  NameDescription
Protected field_accepts
List of quantities that are accepted
(Inherited from Structure.)
Protected field_actualGateLevel
Gate level. Type: River Structure Geometry Unit: [m] Default: 0
Protected field_controlStategyId
If the structure is being controlled, then _controlStategyId contains the ID of the active control strategy
(Inherited from Structure.)
Protected field_downstreamWaterLevel
Downstream water level, as set by SetWaterLevels(Double, Double) Unit: [m]
(Inherited from Structure.)
Protected field_dqdhDownstream
The derivative of flow through the structure with downstream water level. The flow is calculated in the derived classes when the SetWaterLevels method is called. Unit: [m2/sec]
(Inherited from Structure.)
Protected field_dqdhUpstream
The derivative of flow through the structure with upstream water level. The flow is calculated in the derived classes when the SetWaterLevels method is called. Unit: [m2/sec]
(Inherited from Structure.)
Protected field_dynamicMaxGateLevel
Controllable minimum gate level
Protected field_dynamicMinGateLevel
Controllable maximum gate level
Protected field_flowArea
Flow area through structure. Used by most (but not all) structures.
(Inherited from Structure.)
Protected field_flowDir
FlowDir is used to determine which parameters to use for the flow calculations. Derived by the SetWaterLevels(Double, Double).
(Inherited from Structure.)
Protected field_id
Identification name of the structure
(Inherited from Structure.)
Protected field_implicit
If _implicit == false, then the derivatives are always zero. Default value: true.
(Inherited from Structure.)
Protected field_initialGateLevel
Initial value of the gate level. Type: River Structure Geometry Unit: [m] Default: 0
Protected field_location
Location in the network
(Inherited from Structure.)
Protected field_maxSpeed
The maximum allowed rate of change of the gate level. Type: River Structure Geometry / Time Unit: [m] Default: 0.001
Protected field_maxValue
Maximum gate level. The gate can not be raised above this level. Type: River Structure Geometry Unit: [m] Default: 0
Protected field_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
Protected field_offers
List of quantities that are offered
(Inherited from Structure.)
Protected field_previousGateLevel
Previous gate level. Used when control is active, to assure the correct speed of the gate.
Protected field_q
Flow through the structure. The flow is calculated in the derived classes when the SetWaterLevels method is called. Unit: [m3/sec]
(Inherited from Structure.)
Protected field_runTimeDiagnostics
Diagnostics are written into this Diagnostics during calculations. Set during Initialize(IDiagnostics)
(Inherited from Structure.)
Protected field_sillLevel
Level of the sill of the gate.
Protected field_timeOfPreviousGateLevelChange
Time of previous gate level change
Protected field_topoID
Identification used to find referenced cross sections
(Inherited from Structure.)
Protected field_upstreamWaterLevel
Upstream water level, as set by SetWaterLevels(Double, Double) Unit: [m]
(Inherited from Structure.)
Protected field_useDynamicMaxGateLevel
Use the controllable maximum gate level
Protected field_useDynamicMinGateLevel
Use the controllable minimum gate level
Protected field_useMaxValue
Flag telling if the maximum gate level specified in _maxValue should be used Type: boolean Unit: [m] Default: false
Protected field_width
Width of the weir opening. Width is perpendicular to the flow direction, i.e. "across the river"
Top
See Also