EnergyLoss Class |
Calculation of the flow at energy loss structures.
Inheritance HierarchyNamespace: DHI.Mike1D.StructureModule
Assembly: DHI.Mike1D.StructureModule (in DHI.Mike1D.StructureModule.dll) Version: 19.0.0.0 (11.1.1.1111)
SyntaxThe EnergyLoss type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | EnergyLoss |
Constructor method for the energy losss
|
Properties| 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.) |
| FlowFactor |
The discharge (and discharge derivatives) are scaled by the flow factor.
(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
|
Methods| Name | Description | |
|---|---|---|
| Accepts |
List of data types that is accepted, i.e., that you can get a ValueSetter for.
(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.) |
| Dispose |
Frees the licenses held.
(Inherited from Structure.) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| 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.) |
| 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.
(Inherited from Structure.)Base implementation for IControllable |
| GetCurrentValue |
Get the current value of the control for the specified id.
(Inherited from Structure.)Base implementation for IControllable |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| 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) |
Prepare the weir: Set the cross sections on each side of the weir.
(Overrides StructureInitialize(ICrossSection, ICrossSection, Boolean, IDiagnostics).) |
| 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
(Overrides StructurePrepare(HDParameterData, IDiagnostics).) |
| 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.
(Inherited from Structure.)Base implementation for IControllable |
| SetControlStrategyId |
Set control strategy ID manually.
(Inherited from Structure.)Base implementation for IControllable |
| SetInputWaterLevels | (Inherited from Structure.) |
| Setup |
Set cross section information to structure
|
| SetWaterLevels(Double, Double) |
Sets up- and down- stream water level and forces the calculation of the discharge and its derivatives.
(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
(Inherited from Structure.) |
| 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 |
Validation of data for a energy loss structure.
(Overrides StructureValidate.) |
| ValueGetter |
Get value setter for the specified data quantity
(Inherited from Structure.) |
| ValueSetter |
Get value setter for the specified data type
(Inherited from Structure.) |
Fields| Name | Description | |
|---|---|---|
 | _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.) |
| _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.) |
| _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.) |
| _partOfCompositeFlow |
When the energy loss structure is part of a composite structure Q1=Q2 will differ from Qs.
Qs=Q1*_partOfCompositeFlow;
|
| _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.) |
| _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.) |
| _upstreamWaterLevel |
Upstream water level, as set by SetWaterLevels(Double, Double)
Unit: [m]
(Inherited from Structure.) |
 | SolverMethod |
Solution method for solving the energy equations
|
| UseQCrit |
Flag for the NR solver
|
Extension Methods| Name | Description | |
|---|---|---|
 | Getter | From the proxy, return an FuncTResult for the specified quantity. It returns the first quantity of that type that is offered, and null if the quantity is not offered. |
| Getters |
Returns a set of FuncTResult for the quantity.
We can return several quantities with the same id (usually they will differ in their description).
If the quantity is not offerent, an empty list is returned.
(Defined by ProxyExtensions.) |
| GettersFraction |
Returns a set of FuncT, TResult for the quantity.
We can return several quantities with the same id (usually they will differ in their description).
If the quantity is not offerent, an empty list is returned.
(Defined by ProxyExtensions.) |
| GetterUnboxed | From the proxy, return an FuncTResult for the specified quantity. It returns the first quantity of that type that is offered, and null if the quantity is not offered. |
| Initialize(CrossSectionData, Boolean, IDiagnostics) | Overloaded.
Helper function for some unit tests. Do not use.
(Defined by StructureExtensions.) |
| Initialize(BoundaryData, CrossSectionData, Boolean, IDiagnostics) | Overloaded.
Helper function for some unit tests. Do not use.
(Defined by StructureExtensions.) |
| IsSideStructure |
Returns true if the structure is a side structure
(Defined by StructureExtensions.) |
| Setter | From the proxy, return an IDoubleGetSet for the specified quantity. It returns the first quantity of that type that is accepted, and null if the quantity is not accepted. |
See Also