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

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]

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.

Free overflow factor for negative flow.

Free overflow factor for positive flow.

Inflow head loss factor for negative flow.

Inflow head loss factor for positive flow.

Outflow head loss factor for negative flow.

Outflow head loss factor for positive flow.

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.

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

Used when making relaxation when iterating to find the subcritical solution for structures solved using the energy equation. When it equals 1 no relaxation is made.

Type of structure

Coefficient used to avoid instabilities when switching from subcritical to critical. Type: Dimensionless factor Unit: [] Default: 0.0

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

Structure type, unique for each type of structure.

Contraction coefficient. Type: Dimensionless factor Unit: [] Default: 0.63

Coefficient used to avoid instabilities when switching from submerged gate to not submerged gate. Type: Dimensionless factor Unit: [] Default: 0.0

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

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

Type of valve giving the direction of flow that is possible.

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