SquaredGatedBCWeir 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]

Linear flow variation. For water level differences less than delhs use a linear Q variation between h1-h2=delhs and h1-h2=0. This is to avoid stability problems for small water level differences where dQdh goes to infinity. Unit: [m] Default: 0.01

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

Downstream cross section data. The cros section data is the processed level, with, area. Set up during initialize, from cross section database.

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

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

Flow area in the structure. Uses WaterLevelInStructure which is updated when SetWaterLevels() is called.

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

Free overflow factor for negative flow. Default value = 1.

Free overflow factor for positive flow. Default value = 1.

Inflow head loss factor for positive flow. Default value = 0.5.

Inflow head loss factor for positive flow. Default value = 0.5.

Free overflow factor for negative flow. Default value = 1.

Outflow head loss factor for positive flow. Default value = 1.

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

Gate level. Type: River Structure Geometry Unit: [m] Default: 0

Invert level down stream

Invert level up stream

Iteration tolerance. Default 0.0001

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

Location property.

Maximum number of iterations in a structure to obtain convergence of the discharge. Default value = 100

Currently this is set for all structures from the MaximumIterationsInStructure, but it is prepared for individual structure values.

Maximum speed of gate movement

Maximum value of gate level that a control can set in Control()

Minimum headloss across a structure. Default value = 0.1

Currently this is set for all head loss structures from the MinimumHeadloss, but it is prepared for individual structure values.

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

When the culvert is part of a composite structure Q1=Q2 will differ from Qs. Qs=Q1*_partOfCompositeFlow;

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

Sill level

Free overflow factor for negative flow. Default value = 1.

Type of structure

String used to identified cross sections

Structure type, unique for each structure.

Upstream cross section data. The cros section data is the processed level, with, area. Set up during initialize, from cross section database.

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

True if gate level should be restricted by MaxValue in Control()

Type of the valve Default: None

Water level in the structure at the latest call to SetWaterLevels()

Width of ther squared broad crested weir