IEnergyLoss Properties

Angle in degress describing abrupt change in river alignment Type: angle Unit: [degress] Default: 0.0

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.

Frictionfactor used to calculate the energy loss caused by ordinary friction. Type: Dimensional factor Unit: [s2/m6] Default: 0.001

Angle in degress describing gradual change in river alignment Type: angle Unit: [degress] Default: 0.0

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.

Length of the structure. Unit: [m]

Location of structure.

Minimum head loss across a structure. Default value = 0.01

Energy loss coefficient for negative flow at flow contraction losses Type: Dimensional factor Unit: [] Default: 0.0

Energy loss coefficient for negative flow at flow expansion losses Type: Dimensional factor Unit: [] Default: 0.0

Energy loss coefficient for negative flow at user defined energy losses Type: Dimensional factor Unit: [] Default: 0.0

Part of the flow in a parallel strucutre that passes through this structure.

Energy loss coefficient for positive flow at flow contraction losses Type: Dimensional factor Unit: [] Default: 0.0

Energy loss coefficient for positive flow at flow expansion losses Type: Dimensional factor Unit: [] Default: 0.0

Energy loss coefficient for positive flow at user defined energy losses Type: Dimensional factor Unit: [] Default: 0.0

Roughness for gradual change in river alignment Type: Dimensional factor Unit: [] Default: 0.0

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]

Flag telling if there is energy loss due to an abrupt change in river alingment Type: boolean Unit: [m] Default: false

Flag telling if there is an energy loss due to a contraction Type: boolean Unit: [m] Default: false

Flag telling if there is an energy loss due to a expansion Type: boolean Unit: [m] Default: false

Flag telling if there is energy loss due to a gradual change in river alingment Type: boolean Unit: [m] Default: false

Flag telling if there is an user defined energy loss Type: boolean Unit: [m] Default: false