public abstract class AbstractHeadLossStructure : Structure,
ISolvesHeadLossEquation, ISolvesEnergyEquation| AbstractHeadLossStructure | Initializes a new instance of the AbstractHeadLossStructure class |
| 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. |
| CriticalFlow | Flag indicating of flow is critical through the structure, and the head loss/energy loss equation is not active. |
| CriticalFlowConditions | Critical flow conditions depending on flow direction. |
| CriticalFlowConditionsCalculation | Flag specifying that calculations are performed when generating critical flow condition tables. |
| CriticalFlowConditionsNegative | Critical flow conditions for negative flow. |
| CriticalFlowConditionsPositive | Critical flow conditions for positive flow. |
| 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) |
| dHeadLossDischarge | Head loss derivative with respect to discharge |
| Discharge |
Calculated Discharge. The value is calculated by SetWaterLevels.
Unit: [m^3/s]
(Inherited from Structure) |
| DischargeCriticalForTableCalculation | Critical discharge when performing table calculations. |
| DischargeEnergyEquation | Discharge calculated after solving energy equation |
| DownstreamCrossSection | Downstream cross section data. The cross section data is the processed level, with, area. |
| 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. |
| 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 through structure. Used by most (but not all) structures.
(Inherited from Structure) |
| 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. |
| HeadLoss | Calculated Head loss for the current flow conditions. Unit: [m] |
| HeadLossCoefficient | Calculated Head loss coefficient for the current flow conditions. Unit: [1/m^4] |
| HeadLossMode | Flag indicating whether to use head loss calculations. |
| 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. |
| Length |
Length of the structure.
Unit: [m]
Default value: 0m
(Inherited from Structure) |
| Location |
Location property.
(Inherited from Structure) |
| ModifyWaterLevels | Flag specifying to modify water levels by friction loss. |
| PartOfCompositeFlow | Part of the flow in a parallel structure that passes through this structure. |
| PartOfCompositeFlowMinimal | Limit for part of composite flow below which it is assumed that structure has no flow. |
| Residual |
Residual after solving the energy equation.
Relevant only for Levenberg-Marquardt type of solvers. |
| 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. |
| SkipPartOfCompositeFlow | Flag specifying to use part of composite flow equal to one for all structures in the composite structure. |
| 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. |
| StationaryStateCalculation | Flag specifying that stationary state calculations are performed. |
| 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. |
| 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. |
| 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. |
| WaterLevelDifferenceMinimal |
Water level difference below which it is assumed
that structure has no flow.
(Inherited from Structure) |
| ZeroFlow | Flag indicating no flow through structure (upstream water level below invert level). |
| Accepts |
List of data types that is accepted, i.e., that you can get a ValueSetter for.
(Inherited from Structure) |
| AddToOffers |
Add additional offers to structure
(Inherited from Structure) |
| ApplyFlowFactor |
Applies flow factor to discharge and it's derivatives
(Inherited from Structure) |
| ControlSetFlowFactor |
Set flow factor to specified value
(Inherited from Structure) |
| Description |
Return a string that describes this structure. Includes structure type and ID
(Inherited from Structure) |
| DetermineCriticalPartOfCompositeFlow | Determines part of composite flow for structure, which was marked as having critical flow with initial estimate of part of composite flow. |
| Dispose |
Frees the licenses held.
(Inherited from Structure) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| Evaluate(StructureParametersFromHD) | Sets up- and down-stream water level and discharge and calculates the headloss and its derivatives. |
| Evaluate(Double, Double, Double) | Sets up- and down-stream water level and discharge and calculates the headloss and its derivatives. |
| ExplicitStructureSupport |
DEBUG: This method is called from Validate() if _implitcit == false to check if
the structure supports being Explicit.
Once all structures support explicit operation this method can be deleted.
(Inherited from Structure) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| GetActionInfos |
List of control action infos
(Inherited from Structure) |
| GetControlAction |
Get control action for the specified id. It always returns one of
the ActionControl delegates. It will return null if
controlActionId is not valid.
Base implementation for IControllable (Inherited from Structure) |
| GetCurrentValue |
Get the current value of the control for the specified id.
Base implementation for IControllable (Inherited from Structure) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetPartOfCompositeFlowEstimateFactor | Provides an estimate factor for part of composite flow. Presently it is upstream structure cross-section to upstream cross-section flow area ratio. |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| Initialize(IDiagnostics) |
Set up structure and set runtime diagnostics object
(Inherited from Structure) |
| Initialize(ICrossSection, ICrossSection, Boolean, IDiagnostics) |
Set up structure and set runtime diagnostics object
(Inherited from Structure) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| Offers |
A list of quantities available from this structure
(Inherited from Structure) |
| Prepare(HDParameterData, IDiagnostics) |
Set up structure and set runtime diagnostics object
(Inherited from Structure) |
| Prepare(DateTime, HDParameterData, IDiagnostics) |
Set up structure and set runtime diagnostics object
(Inherited from Structure) |
| ResetControlledState |
Reset internal state (if any) used by controlling class.
Called after a controlling class has performed a control sequence,
and simulation is restarted.
Base implementation for IControllable (Inherited from Structure) |
| SetControlStrategyId |
Set control strategy ID manually.
Base implementation for IControllable (Inherited from Structure) |
| SetInputWaterLevels |
Set the _upstreamWaterLevel, _downstreamWaterLevel and _flowDir (Inherited from Structure) |
| SetWaterLevels(StructureParametersFromHD) | Sets up- and down-stream water level and forces the calculation of the discharge and its derivatives. |
| SetWaterLevels(Double, Double) |
Sets up- and down- stream water level and forces the calculation of the discharge and its derivatives.
Override in extending classes to do something useful. (Overrides StructureSetWaterLevels(Double, Double)) |
| SetWaterLevels(Double, Double, Double, Double) | Sets up- and down-stream water level and forces the calculation of the discharge and its derivatives. |
| SetZeroFlow |
Sets the conditions for zero flow
(Overrides StructureSetZeroFlow) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| UpdatedWaterLevels |
After a time step (or iteration) has finished, update the discharge to the actual value, based
on the final water levels and the discharge derivatives.
(Inherited from Structure) |
| Validate |
Writes errors, warnings and hints into their respective member classes. The member objects are initially cleared.
(Inherited from Structure) |
| ValueGetter |
Get value setter for the specified data quantity
(Inherited from Structure) |
| ValueSetter |
Get value setter for the specified data type
(Inherited from Structure) |
| _accepts |
List of quantities that are accepted
(Inherited from Structure) |
| _controlStategyId |
If the structure is being controlled, then _controlStategyId contains the ID of the
active control strategy
(Inherited from Structure) |
| _crossSection1 | Help variable for the upstream cross section relative to the actual flow. |
| _crossSection2 | Help variable for the downstream cross section relative to the actual flow. |
| _downstreamCrossSection | Downstream cross section data. The cross section data is the processed level, with, area. |
| _downstreamWaterLevel |
Downstream water level, as set by SetWaterLevels(Double, Double)
Unit: [m]
(Inherited from Structure) |
| _dqdhDownstream |
The derivative of flow through the structure with downstream water level. The flow is
calculated in the derived classes when the SetWaterLevels method is called.
Unit: [m2/sec]
(Inherited from Structure) |
| _dqdhUpstream |
The derivative of flow through the structure with upstream water level. The flow is
calculated in the derived classes when the SetWaterLevels method is called.
Unit: [m2/sec]
(Inherited from Structure) |
| _flowArea |
Flow area through structure. Used by most (but not all) structures.
(Inherited from Structure) |
| _flowDir |
FlowDir is used to determine which parameters to use for the flow calculations.
Derived by the SetWaterLevels(Double, Double).
(Inherited from Structure) |
| _flowRegime | Flow regime for discharge mode. |
| _flowRegimeHeadLoss | Flow regime for head loss mode. |
| _h1 | Water level at cross section upstream (relative to actual flow direction) |
| _h2 | Water level at cross section downstream (relative to actual flow direction) |
| _id |
Identification name of the structure
(Inherited from Structure) |
| _implicit |
If _implicit == false, then the derivatives are always zero.
Default value: true.
(Inherited from Structure) |
| _location |
Location in the network
(Inherited from Structure) |
| _offers |
List of quantities that are offered
(Inherited from Structure) |
| _parameters | A class which contains parameters passed from HD module to Structure module during the run of the simulation. |
| _partOfCompositeFlow | Part of the flow in a parallel structure that passes through this structure. |
| _q |
Flow through the structure. The flow is calculated in the derived classes when the
SetWaterLevels method is called.
Unit: [m3/sec]
(Inherited from Structure) |
| _qEnergyEquation | Discharge calculated after solving energy equation |
| _qSaintVenant | Discharge leading to a head loss (used when HeadLossMode=true) |
| _qSaintVenantFull | Discharge leading to a head loss without part of composite flow (used when HeadLossMode=true) |
| _runTimeDiagnostics |
Diagnostics are written into this Diagnostics during calculations.
Set during Initialize(IDiagnostics) (Inherited from Structure) |
| _topoID |
Identification used to find referenced cross sections
(Inherited from Structure) |
| _upstreamCrossSection | Upstream cross section data. The cross section data is the processed level, with, area. |
| _upstreamWaterLevel |
Upstream water level, as set by SetWaterLevels(Double, Double)
Unit: [m]
(Inherited from Structure) |
| _v1 | Velocity estimate upstream relative to actual flow direction of the structure. |
| _v2 | Velocity estimate at cross section downstream (relative to actual flow direction). |
| _zeroFlow | Flag indicating no flow through structure (upstream water level below invert level). |