| AreaMinimal | The smallest area allowed. |
| ConvectionTermReductionCoefficient |
Reduction coefficient for convection terms (kinetic energy terms) in energy equation.
This coefficient is applied when the difference between inflow kinetic energy and outflow kinetic energy
(or more precisely, velocity head difference measured in meters) becomes larger than the total head loss.
0 corresponds to no reduction (default) whereas 1 corresponds to removing the upstream and
downstream convective terms.
(Inherited from AbstractHeadLossStructure) |
| CriticalFlow |
Flag indicating of flow is critical through the structure, and the head loss/energy loss equation is not active.
(Inherited from AbstractHeadLossStructure) |
| CriticalFlowConditions | Critical flow conditions depending on flow direction. (Inherited from AbstractHeadLossStructure) |
| CriticalFlowConditionsCalculation |
Flag specifying that calculations are performed when generating
critical flow condition tables.
(Inherited from AbstractHeadLossStructure) |
| CriticalFlowConditionsNegative | Critical flow conditions for negative flow. (Inherited from AbstractHeadLossStructure) |
| CriticalFlowConditionsPositive | Critical flow conditions for positive flow. (Inherited from AbstractHeadLossStructure) |
| 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 |
| dHeadLossDischarge |
Head loss derivative with respect to discharge
(Inherited from AbstractHeadLossStructure) |
| Discharge |
Calculated Discharge. The value is calculated by SetWaterLevels.
Unit: [m^3/s]
(Inherited from Structure) |
| DischargeCriticalForTableCalculation |
Critical discharge when performing table calculations.
(Inherited from AbstractHeadLossStructure) |
| DischargeEnergyEquation | Discharge calculated after solving energy equation (Inherited from AbstractHeadLossStructure) |
| DownstreamCrossSection |
Downstream cross section data. The cross section data is the processed level, with, area.
(Inherited from AbstractHeadLossStructure) |
| DownstreamExternalEnergyLevel |
Flag indicating to use downstream external energy level.
For false the downstream energy level is calculated as part of the internal solution. It is more stable to set DownstreamExternalEnergyLevel to true. (Inherited from AbstractHeadLossStructure) |
| 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) |
| EnableCheckFlowDirectionOscillations |
Flag indicating whether to use special check and damping
for structure discharge oscillating around zero.
(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 in the structure. Uses WaterLevelInStructure which is updated when
SetWaterLevels() is called.
(Overrides StructureFlowArea) |
| FlowFactor |
The discharge (and discharge derivatives) are scaled by the flow factor.
(Inherited from Structure) |
| GenerateCriticalFlowConditions |
Flag specifying to generate critical flow condition tables
when the whole composite structure is taken into account.
(Inherited from AbstractHeadLossStructure) |
| HeadLoss |
Calculated Head loss for the current flow conditions.
Unit: [m]
(Inherited from AbstractHeadLossStructure) |
| HeadLossCoefficient |
Calculated Head loss coefficient for the current flow conditions.
Unit: [1/m^4]
(Inherited from AbstractHeadLossStructure) |
| HeadLossFreeOverflowNegativeFlow | Free overflow factor for negative flow. Unit: [] Default: 1 |
| HeadLossFreeOverflowPositiveFlow | Free overflow factor for positive flow. Unit: [] Default: 1 |
| HeadLossInflowNegativeFlow | Inflow head loss factor for negative flow. Unit: [] Default: 0.5 |
| HeadLossInflowPositiveFlow | Inflow head loss factor for positive flow. Unit: [] Default: 0.5 |
| HeadLossMode |
Flag indicating whether to use head loss calculations.
(Inherited from AbstractHeadLossStructure) |
| HeadLossOutflowNegativeFlow | Outflow head loss factor for negative flow. Unit: [] Default: 1 |
| HeadLossOutflowPositiveFlow | Outflow head loss factor for positive flow. Unit: [] Default: 1 |
| 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
(Inherited from Structure) |
| InvertLevelUpstream |
Invert level up stream
(Inherited from Structure) |
| IsCriticalForTableCalculation |
Flag specifying that structure is critical when performing composite structure
critical flow conditions calculations.
(Inherited from AbstractHeadLossStructure) |
| IterationTolerance | Iteration tolerance. Default: 0.0001 |
| Length |
Length of the structure.
Unit: [m]
Default value: 0m
(Inherited from Structure) |
| Location |
Location property.
(Inherited from Structure) |
| MaximumIterations |
Maximum number of iterations in a structure to obtain convergence of the discharge.
Default: 100
Currently this is set for all structures from the MaximumIterationsInStructure, but it is prepared for individual structure values. |
| MinimumHeadloss |
Minimum headloss across a structure.
Unit: []
Default: 0.1
Currently this is set for all head loss structures from the MinimumHeadloss, but it is prepared for individual structure values. |
| ModifyWaterLevels |
Flag specifying to modify water levels by friction loss.
(Inherited from AbstractHeadLossStructure) |
| PartOfCompositeFlow |
Part of the flow in a parallel structure that passes through this structure.
(Inherited from AbstractHeadLossStructure) |
| PartOfCompositeFlowMinimal |
Limit for part of composite flow below which it is assumed
that structure has no flow.
(Inherited from AbstractHeadLossStructure) |
| Residual |
Residual after solving the energy equation.
Relevant only for Levenberg-Marquardt type of solvers. (Inherited from AbstractHeadLossStructure) |
| RunTimeDiagnostics |
The getter is used to get a list of errors.
(Inherited from Structure) |
| SideStructureBank |
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). (Inherited from Structure) |
| SideStructureReservoir |
Reservoir at end of side structure. Null if not side structure, or no reservoir is defined
(Inherited from Structure) |
| SkipInitialGuess |
Flag specifying to skip initial guess in the energy equation solver.
(Inherited from AbstractHeadLossStructure) |
| SkipPartOfCompositeFlow |
Flag specifying to use part of composite flow equal to one
for all structures in the composite structure.
(Inherited from AbstractHeadLossStructure) |
| SmoothingFactor |
Exponential smoothing factor for structure discharge.
The smoothing factor is the weight of the previous discharge on the new discharge:
q = (1 - SmoothingFactor) * qStructure + SmoothingFactor * qPrevious
(Inherited from Structure) |
| SolverMethod |
Solution method for solving the energy equations.
(Inherited from AbstractHeadLossStructure) |
| StationaryStateCalculation |
Flag specifying that stationary state calculations are performed.
(Inherited from AbstractHeadLossStructure) |
| StructureIterationCentering | Used when making relaxation when iterating to find the subcritical solution for structures solved using the energy equation. When it equals 1 no relaxation is made. |
| StructureType |
Type of structure
(Inherited from Structure) |
| TopoID |
String used to identified cross sections
(Inherited from Structure) |
| Type |
Structure type, unique for each type structure.
(Inherited from Structure) |
| UpstreamCrossSection |
Upstream cross section data. The cross section data is the processed level, with, area.
(Inherited from AbstractHeadLossStructure) |
| UpstreamExternalEnergyLevel |
Flag indicating to use upstream external energy level.
For false the upstream energy level is calculated as part of the internal solution. It is more stable to set UpstreamExternalEnergyLevel to true. (Inherited from AbstractHeadLossStructure) |
| 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) |
| UseFrictionFromHD |
Use friction in energy equation from HD module.
(Inherited from AbstractHeadLossStructure) |
| Valve |
Type of the valve
Default: None
(Inherited from AbstractHeadLossStructureValved) |
| WaterLevelDifferenceMinimal |
Water level difference below which it is assumed
that structure has no flow.
(Inherited from Structure) |
| WaterLevelInStructure | Water level in the structure at the latest call to SetWaterLevels() |
| ZeroFlow |
Flag indicating no flow through structure (upstream water level below invert level).
(Inherited from AbstractHeadLossStructure) |