ISluiceGate Properties

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).

Factor used when calculating Yc for controlled free flow Type: Dimensional factor Unit: [] Default: 0.89

Exponent used when calculating Yc for controlled free flow Type: Dimensional factor Unit: [] Default: 0.17

Factor used when calculating Yc for controlled submerged flow Type: Dimensional factor Unit: [] Default: 1.12

Exponent used when calculating Yc for controlled submerged flow Type: Dimensional factor Unit: [] Default: 0.21

Calculated Discharge derivative with UpStreamWaterLevel. Upstream is relative to the direction of chainage. Unit: [m^2/s]

Calculated Discharge derivative with DownStreamWaterLevel. Downstream is relative to the direction of chainage. Unit: [m^2/s]

Level from where the variation is forced to be linear.

Calculated Discharge Unit: [m^3/s]

Downstream water level.Downstream refers to the direction of chainge. The water level is set by use of SetWaterLevels Unit: [m]

The discharge (and discharge derivatives) are scaled by the flow factor.

The height of the gate. This is used to evaluate if over topping can occur. Type: River Structure Geometry Unit: [m] Default: 0

Horizontal offset of the structures compared to its limiting cross sections.

Name of the structure.

Used to get a consistent description of the structure. The ID comes in user units. Used e.g. when reporting errors, warnings and hints.

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

Gate level. Type: River Structure Geometry Unit: [m] Default: 0

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.

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.

Length of the structure. Unit: [m]

Location of structure.

Lower limit between controlled submerged flow and controlled free flow Type: Dimensional factor Unit: [] Default: 0.95

Lower limit between controlled free flow and uncontrolled submerged flow Type: Dimensional factor Unit: [] Default: 1.45

Lower limit between uncontrolled submerged flow and uncontrolled free flow Type: Dimensional factor Unit: [] Default: 0.6

The maximum allowed rate of change of the gate level. Type: River Structure Geometry / Time Unit: [m] Default: 0.001

Maximum gate level. The gate can not be raised above this level. Type: River Structure Geometry Unit: [m] Default: 0

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

The getter is used to get a list of errors. OBSOLETE

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).

Reservoir at end of side structure. Null if not side structure, or no reservoir is defined

Level of the sill of the gate. Type: River Structure Geometry Unit: [m] Default: 0

Type of structure

TopoID used when structure is searching for neighboring cross sections in the reach.

Structure type, unique for each type of structure.

Factor used when calculating Yc for uncontrolled free flow and overtopping flow Type: Dimensional factor Unit: [] Default: 0.77

Upper limit between controlled submerged flow and controlled free flow Type: Dimensional factor Unit: [] Default: 1.05

Upper limit between controlled free flow and uncontrolled submerged flow Type: Dimensional factor Unit: [] Default: 1.55

Upper limit between uncontrolled submerged flow and uncontrolled free flow Type: Dimensional factor Unit: [] Default: 0.7

Upstream water level. Upstream refers to the direction of chainage. The water level is set by use of SetWaterLevels Unit: [m]

Factor used when calculating Yc for uncontrolled submerged flow Type: Dimensional factor Unit: [] Default: 0.86

Exponent used when calculating Yc for uncontrolled submerged flow Type: Dimensional factor Unit: [] Default: 0.38

Flag telling if the maximum gate level specified in _maxValue should be used Type: boolean Unit: [m] Default: false

Width of the weir opening. Width is perpendicular to the flow direction, i.e. "across the river"