Orifice Properties

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]

Set scale factor for total discharge through orifice

Set downstream bottom level.

On a structure reach, if this is not set, (i.e. if having the default value of MinValue), the bottom level of the downstream node is used.

Also disable UseUpAndDownstreamCrossSection to enable this

Set downstream cross section

Set downstream top level.

On a structure reach, if this is not set, (i.e. if having the default value of MinValue), the ground level of the downstream node is used, and the downstream node must be a node with volume.

Also disable UseUpAndDownstreamCrossSection to enable this

Downstream water level.Downstream refers to the direction of chainage. 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

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.

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

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]

Invert level down stream

Invert level up stream

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

Location property.

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.

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

String used to identified cross sections

Structure type, unique for each type structure.

Set upstream bottom level.

On a structure reach, if this is not set, (i.e. if having the default value of MinValue), the bottom level of the upstream node is used.

Also disable UseUpAndDownstreamCrossSection to enable this

Set upstream cross section

Set downstream top level. Not used if _useUpAndDownstreamCrossSection

On a structure reach, if this is not set, (i.e. if having the default value of MinValue), the ground level of the upstream node is used, and the upstream node must be a node with volume.

Also disable UseUpAndDownstreamCrossSection to enable this

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

Flag specifying whether to use upstream and downstream cross section for geometry, or whether to use the 4 geometry parameters: UpstreamBottomLevel, DownstreamBottomLevel, UpstreamTopLevel, DownstreamTopLevel.

If setting this to false, all the 4 geometry parameters must be set manually

Type of the valve Default: None