IOverFlowFormula Properties

The level of the weir crest. Type: River Structure Geometry Unit: [m] Default: 0

Crest type

The width of the weir. Type: River Structure Geometry Unit: [m] Default: 0

ID of the table where the Q-h relation is located.

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.

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

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.

Coeffcient used to determine overall flow coefficient when weir coefficient is not used. Type: Undefined Unit: [] Default: Undefined

Length of the structure. Unit: [m]

Location of structure.

Maximum crest level

Used only when the OverFlowFormula is controlled

Maximum crest level decrease speed

Used only when the OverFlowFormula is controlled

Maximum crest level increase speed

Used only when the OverFlowFormula is controlled

Calculation method: 1 for a Q-h table and 2 for weir formula Default: 2

Minimum crest level

Used only when the OverFlowFormula is controlled

Flag specifying whether the downstream end is out of the system (outlet boundary). If true, flow out of the system is always free outflow (critical flow conditions)

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.

Coefficient used to make a continuos transistion between submerged and not submerged flow at the weir. It expands an interval around the crest level In which the flow is both critical and subcritical Unit: [meter] Default: 0.0.

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]

Flag telling if the weir coefficient should be used or the coefficient should be based on the angle of the weir.

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

Flow coeffcient for the weir. If left undefined the flow coeeficient is calculated based on information on the WeirFlowAngle Type: Dimensional factor Unit: [] Default: 0.66

The angle of the weir to the flow direction of the branch Type: Angels Unit: [degrees] Default: 0