IRadialGate Properties |
The IRadialGate type exposes the following members.
Name | Description | |
---|---|---|
ActualGateLevel |
Actual gate level.
Type: River Structure Geometry
Unit: [m]
Default: 0
(Inherited from IGate.)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 UpStreamWaterLevel. Upstream is relative to the direction of chainage.
Unit: [m^2/s]
(Inherited from IStructure.) | |
dDischargedUpStreamWaterLevel |
Calculated Discharge derivative with DownStreamWaterLevel. Downstream is relative to the direction of chainage.
Unit: [m^2/s]
(Inherited from IStructure.) | |
Delhs |
Level from where the variation is forced to be linear.
(Inherited from ILinearZeroVariation.) | |
Discharge |
Calculated Discharge
Unit: [m^3/s]
(Inherited from IStructure.) | |
DownstreamWaterLevel |
Downstream water level.Downstream refers to the direction of chainge. The water level is set by use of
SetWaterLevels
Unit: [m]
(Inherited from IStructure.) | |
FlowFactor |
The discharge (and discharge derivatives) are scaled by the flow factor.
(Inherited from IStructure.) | |
Height |
Height above sill of the overflow crest of the gate when the gate is closed.
Type: River Structure Geometry
Unit: [m]
Default: 1
| |
HorizontalOffSetFromMarker2 |
Horizontal offset of the structures compared to its limiting cross sections.
(Inherited from IPlotableStructure.) | |
ID |
Name of the structure.
(Inherited from IStructure.) | |
IDInUserUnit | Obsolete.
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 IStructure.) | |
Implicit |
Flag to control if the structure is implicit or explicit. If the structure is explicit
(Implicit == false) then the derivatives of the discharge are always zero.
Default value: true
(Inherited from IStructure.) | |
InitialGateLevel |
Gate level.
Type: River Structure Geometry
Unit: [m]
Default: 0
(Inherited from IGate.) | |
InvertLevelDownstream |
Invert level down stream
The invert level is the level where water starts
flowing in to the structure from the downstream side.
It does not necessarily flow through the structure.
(Inherited from IStructure.) | |
InvertLevelUpstream |
Invert level up stream.
The invert level is the level where water starts
flowing in to the structure from the upstream side.
It does not necessarily flow through the structure.
(Inherited from IStructure.) | |
Length | Obsolete.
Length of the structure.
Unit: [m]
(Inherited from IStructure.) | |
Location |
Location of structure.
(Inherited from IStructure.) | |
MaxSpeed |
The maximum allowed rate of change of the gate level.
Type: River Structure Geometry / Time
Unit: [m]
Default: 0.001
(Inherited from IGate.) | |
MaxValue |
Maximum gate level. The gate can not be raised above this level.
Type: River Structure Geometry
Unit: [m]
Default: 0
(Inherited from IGate.) | |
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 IGate.) | |
Radius |
Radius of gate.
Type: River Structure Geometry
Unit: [m]
Default: 1
| |
RunTimeDiagnostics |
The getter is used to get a list of errors. OBSOLETE
(Inherited from IStructure.) | |
SideStructureBank |
Bank side that side-structure is located on
(Inherited from IStructure.)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 IStructure.) | |
SillLevel |
Level of the sill of the gate.
Type: River Structure Geometry
Unit: [m]
Default: 0
(Inherited from IGate.) | |
StructureType |
Type of structure
(Inherited from IStructure.) | |
TopoID |
TopoID used when structure is searching for neighboring cross sections in the reach.
(Inherited from IStructure.) | |
TransitionBottom |
Parameter used to define the transition zone between free flow and submerged flow.
Type: River Structure Geometry
Unit: [m]
Default: -0.152
| |
TransitionDepth |
Parameter used to define the transition zone between free flow and submerged flow.
Type: River Structure Geometry
Unit: [m]
Default: 0.304
| |
Trunnion |
Height above sill of centre of gate circle.
Type: River Structure Geometry
Unit: [m]
Default: 1
| |
TuneFactor |
Discharge calibration factor. This factor is used only on the part of the
discharge that flows below the gate.
Type: Dimensional factor
Unit: []
Default: 1
| |
Type |
Structure type, unique for each type of structure.
(Inherited from IStructure.) | |
UpstreamWaterLevel |
Upstream water level. Upstream refers to the direction of chainage. The water level is set by use of
SetWaterLevels
Unit: [m]
(Inherited from IStructure.) | |
UseMaxValue |
Flag telling if the maximum gate level specified in _maxValue should be used
Type: boolean
Unit: [m]
Default: false
(Inherited from IGate.) | |
WeirCoefficient |
Coefficient used when calculating the flow above the gate.
Type: Dimensional factor
Unit: []
Default: 1.838
| |
WeirExponent |
Coefficient used when calculating the flow above the gate
Type: Dimensional factor
Unit: []
Default: 1.5
| |
Width |
Width of the weir opening. Width is perpendicular to the flow direction, i.e. "across the river"
(Inherited from IGate.) |