IOrifice Properties

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]

Scale factor for total discharge through orifice

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

Set downstream cross section displacement A positive value displaces the cross section to the right when looking from the upstream direction

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

Actual gate level. Type: River Structure Geometry Unit: [m]

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 explicitly controlled, this can be used to change the gate (manual/user defined control).

Shape of gates as polygons. Gate polygons can move in between MinGateLevel and MaxGateLevel.

Y coordinates of gate polygons are relative to MinGateLevel

If changing gate level properties during runtime, be sure to update internal state by calling PrepareForGate

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.

Maximum allowed gate level

If changing gate level properties during runtime, be sure to update internal state by calling PrepareForGate

Maximum speed of lowering gate/weir

Maximum speed of rising gate/weir

Minimum allowed gate level

If changing gate level properties during runtime, be sure to update internal state by calling PrepareForGate

Shape of the opening

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

Type of structure

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

Structure type, unique for each type of structure.

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

Set upstream cross section displacement A positive value displaces the cross section to the right when looking from the upstream direction

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