EnergyLoss Properties |
The EnergyLoss type exposes the following members.
| Name | Description | |
|---|---|---|
| AbruptAlignmentChange |
Angle in degress describing abrupt change in river alignment
Type: angle
Unit: [degress]
Default: 0.0
| |
| dDischargedDownStreamWaterLevel |
Calculated Discharge derivative with DownStreamWaterLevel. Downstream is relative to the direction of chainage.
The value is calculated by SetWaterLevels.
Unit: [m^2/s]
(Inherited from Structure.) | |
| dDischargedUpStreamWaterLevel |
Calculated Discharge derivative with UpStreamWaterLevel. Upstream is relative to the direction of chainage.
The value is calculated by SetWaterLevels.
Unit: [m^2/s]
(Inherited from Structure.) | |
| Delhs |
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
| |
| Discharge |
Calculated Discharge. The value is calculated by SetWaterLevels.
Unit: [m^3/s]
(Inherited from Structure.) | |
| DownstreamCrossSection |
Downstream cross section data. The cross section data is the processed level, with, area.
| |
| DownstreamWaterLevel |
Downstream water level.Downstream refers to the direction of chainage. The water level is set by use of
SetWaterLevels
Unit: [m]
(Inherited from Structure.) | |
| ExtensionData |
Property used by (de)serializer, when it can not find proper target for
a data field. Support of forward compatible data contracts.
(Inherited from Structure.) | |
| FlowArea |
Flow area through structure. Used by most (but not all) structures.
(Inherited from Structure.) | |
| FrictionFactor |
Frictionfactor used to calculate the energy loss caused by ordinary friction.
Type: Dimensional factor
Unit: [s2/m6]
Default: 0.001
| |
| GradualAlignmentChange |
Angle in degress describing gradual change in river alignment
Type: angle
Unit: [degress]
Default: 0.0
| |
| HorizontalOffSetFromMarker2 |
Value used when plotting the structue
Unit: [m]
Defualt: 0
| |
| ID |
Structure ID
(Inherited from Structure.) | |
| IDInUserUnit |
Used to get a consistent description of the structure. The ID comes in user units. Used e.g. when
reporting errors, warnings and hints.
(Inherited from Structure.) | |
| Implicit |
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
(Inherited from Structure.) | |
| InvertLevelDownstream |
Invert level down stream
(Overrides StructureInvertLevelDownstream.) | |
| InvertLevelUpstream |
Invert level up stream
(Overrides StructureInvertLevelUpstream.) | |
| Length |
Length of the structure.
Unit: [m]
Default value: 0m
(Inherited from Structure.) | |
| Location |
Location property.
(Inherited from Structure.) | |
| MinimumHeadloss |
Minimum head loss across a structure.
Default value = 0.01
| |
| NegContraction |
Energy loss coefficient for negative flow at flow contraction losses
Type: Dimensional factor
Unit: []
Default: 0.0
| |
| NegExpansion |
Energy loss coefficient for negative flow at flow expansion losses
Type: Dimensional factor
Unit: []
Default: 0.0
| |
| NegUserDefined |
Energy loss coefficient for negative flow at user defined energy losses
Type: Dimensional factor
Unit: []
Default: 0.0
| |
| PartOfCompositeFlow |
Part of the flow in a parallel strucutre that passes through this structure.
| |
| PosContraction |
Energy loss coefficient for positive flow at flow contraction losses
Type: Dimensional factor
Unit: []
Default: 0.0
| |
| PosExpansion |
Energy loss coefficient for positive flow at flow expansion losses
Type: Dimensional factor
Unit: []
Default: 0.0
| |
| PosUserDefined |
Energy loss coefficient for positive flow at user defined energy losses
Type: Dimensional factor
Unit: []
Default: 0.0
| |
| Roughness |
Roughness for gradual change in river alignment
Type: Dimensional factor
Unit: []
Default: 0.0
| |
| RunTimeDiagnostics |
The getter is used to get a list of errors.
(Inherited from Structure.) | |
| SideStructureBank |
Bank side that side-structure is located on
(Inherited from Structure.)If side structure contains reservoir, and has the Coordinate set, this is not used (and should be set to Undefined). | |
| SideStructureReservoir |
Reservoir at end of side structure. Null if not side structure, or no reservoir is defined
(Inherited from Structure.) | |
| StructureCrossSection |
Structure cross section data. The cross section data is the processed level, with, area.
| |
| StructureType |
Type of structure
(Inherited from Structure.) | |
| TopoID |
String used to identified cross sections
(Inherited from Structure.) | |
| Type |
Structure type, unique for each structure.
(Overrides StructureType.) | |
| UpstreamCrossSection |
Upstream cross section data. The cross section data is the processed level, with, area.
| |
| UpstreamWaterLevel |
Upstream water level. Upstream refers to the direction of chainage. The water level is set by use of
SetWaterLevels
Unit: [m]
(Inherited from Structure.) | |
| UseAbruptChange |
Flag telling if there is energy loss due to an abrupt change in river alingment
Type: boolean
Default: false
| |
| UseContractionLoss |
Flag telling if there is an energy loss due to a contraction
Type: boolean
Default: false
| |
| UseExpansionLoss |
Flag telling if there is an energy loss due to a expansion
Type: boolean
Default: false
| |
| UseGradualChange |
Flag telling if there is energy loss due to a gradual change in river alingment
Type: boolean
Default: false
| |
| UseUserDefined |
Flag telling if there is an user defined energy loss
Type: boolean
Default: false
| |
| WaterLevel |
Water level at the structure
|