Gate 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 DownStreamWaterLevel. Downstream is relative to the direction of chainage. The value is calculated by SetWaterLevels. Unit: [m^2/s]

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

Calculated Discharge. The value is calculated by SetWaterLevels. Unit: [m^3/s]

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

Controllable maximum gate level

Controllable minimum gate level

Property used by (de)serializer, when it can not find proper target for a data field. Support of forward compatible data contracts.

Flow area through structure. Used by most (but not all) structures.

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

Structure ID

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 dicharge are always zero. Default value: true

Initial value of the gate level. Type: River Structure Geometry Unit: [m] Default: 0

Invert level down stream

Invert level up stream

Length of the structure. Unit: [m] Default value: 0m

Location property.

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.

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

String used to identified cross sections

Structure type, unique for each type structure.

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

Use the controllable maximum gate level

Use the controllable minimum gate level

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

Flag to de-activate structure completely. If this flag is set, then the momentum equation will be used to set the coefficents in HDStructureGridPoint instead of the structure. The flag is cleared the next time Control() is called.

This is used in HDStructureGridPoint to determine if the structure should be active or or if the coefficients should be set using a HDQGridPoint.

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