OverFlowGate Properties |
The OverFlowGate type exposes the following members.
Name | Description | |
---|---|---|
ActualGateLevel |
Actual gate level.
Type: River Structure Geometry
Unit: [m]
Default: 0
(Inherited from SquaredGatedBCWeir.)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). | |
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.) | |
Delhs |
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.) | |
Discharge |
Calculated Discharge. The value is calculated by SetWaterLevels.
Unit: [m^3/s]
(Inherited from Structure.) | |
DownstreamCrossSection |
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.) | |
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 in the structure. Uses WaterLevelInStructure which is updated when
SetWaterLevels() is called.
(Inherited from AbstractBroadCrestedCWeir.) | |
FlowFactor |
The discharge (and discharge derivatives) are scaled by the flow factor.
(Inherited from Structure.) | |
HeadLossFreeOverflowNegativeFlow |
Free overflow factor for negative flow.
Default value = 1.
(Inherited from AbstractBroadCrestedCWeir.) | |
HeadLossFreeOverflowPositiveFlow |
Free overflow factor for positive flow.
Default value = 1.
(Inherited from AbstractBroadCrestedCWeir.) | |
HeadLossInflowNegativeFlow |
Inflow head loss factor for positive flow.
Default value = 0.5.
(Inherited from AbstractBroadCrestedCWeir.) | |
HeadLossInflowPositiveFlow |
Inflow head loss factor for positive flow.
Default value = 0.5.
(Inherited from AbstractBroadCrestedCWeir.) | |
HeadLossOutflowNegativeFlow |
Free overflow factor for negative flow.
Default value = 1.
(Inherited from AbstractBroadCrestedCWeir.) | |
HeadLossOutflowPositiveFlow |
Outflow head loss factor for positive flow.
Default value = 1.
(Inherited from AbstractBroadCrestedCWeir.) | |
HorizontalOffSetFromMarker2 |
Value used when plotting the structue
Unit: [m]
Defualt: 0
| |
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.) | |
InitialGateLevel |
Gate level.
Type: River Structure Geometry
Unit: [m]
Default: 0
(Inherited from SquaredGatedBCWeir.) | |
InvertLevelDownstream |
Invert level down stream
(Overrides SquareBroadCrestedWeirInvertLevelDownstream.) | |
InvertLevelUpstream |
Invert level up stream
(Overrides SquareBroadCrestedWeirInvertLevelUpstream.) | |
IterationTolerance |
Iteration tolerance.
Default 0.0001
(Inherited from AbstractBroadCrestedCWeir.) | |
Length |
Length of the structure.
Unit: [m]
Default value: 0m
(Inherited from Structure.) | |
Location |
Location property.
(Inherited from Structure.) | |
MaximumIterations |
Maximum number of iterations in a structure to obtain convergence of the discharge.
Default value = 100
(Inherited from AbstractBroadCrestedCWeir.)Currently this is set for all structures from the MaximumIterationsInStructure, but it is prepared for individual structure values. | |
MaxSpeed |
Maximum speed of gate movement
(Inherited from SquaredGatedBCWeir.) | |
MaxValue |
Maximum value of gate level that a control can set in Control()
(Inherited from SquaredGatedBCWeir.) | |
MinimumHeadloss |
Minimum headloss across a structure.
Default value = 0.1
(Inherited from AbstractBroadCrestedCWeir.)Currently this is set for all head loss structures from the MinimumHeadloss, but it is prepared for individual structure values. | |
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
(Inherited from SquaredGatedBCWeir.) | |
PartOfCompositeFlow |
When the culvert is part of a composite structure Q1=Q2 will differ from Qs.
Qs=Q1*_partOfCompositeFlow;
(Inherited from AbstractBroadCrestedCWeir.) | |
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.) | |
SillLevel |
Sill level
(Inherited from SquareBroadCrestedWeir.) | |
StructureIterationCentering |
Free overflow factor for negative flow.
Default value = 1.
(Inherited from AbstractBroadCrestedCWeir.) | |
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 SquareBroadCrestedWeirType.) | |
UpstreamCrossSection |
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.) | |
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.) | |
UseMaxValue |
True if gate level should be restricted by MaxValue in Control()
(Inherited from SquaredGatedBCWeir.) | |
Valve |
Type of the valve
Default: None
(Inherited from ValvedStructure.) | |
WaterLevelInStructure |
Water level in the structure at the latest call to SetWaterLevels()
(Inherited from AbstractBroadCrestedCWeir.) | |
Width |
Width of ther squared broad crested weir
(Inherited from SquareBroadCrestedWeir.) |