ISolvesHeadLossEquation Interface

Interface that must be implemented if the structure solves the energy equation and can provide a head loss

Definition

Namespace: DHI.Mike1D.StructureModule
Assembly: DHI.Mike1D.StructureModule (in DHI.Mike1D.StructureModule.dll) Version: 24.0.0.0 (11.1.1.1111)
C#
public interface ISolvesHeadLossEquation : ISolvesEnergyEquation
Implements
ISolvesEnergyEquation

Properties

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 ISolvesEnergyEquation)
CriticalFlow Flag indicating of flow is critical through the structure, and the head loss/energy loss equation is not active.
dHeadLossDischarge Head loss derivative with respect to discharge
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 ISolvesEnergyEquation)
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.
PartOfCompositeFlow Part of the flow in a parallel structure that passes through this structure.
(Inherited from ISolvesEnergyEquation)
SolverMethod Solution method for solving the energy equations.
(Inherited from ISolvesEnergyEquation)
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 ISolvesEnergyEquation)
UseFrictionFromHD Use friction in energy equation from HD module.
(Inherited from ISolvesEnergyEquation)
ZeroFlow Flag indicating no flow through structure (upstream water level below invert level).

Methods

DetermineCriticalPartOfCompositeFlow Determines part of composite flow for structure, which was marked as having critical flow with initial estimate of part of composite flow.
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.
GetPartOfCompositeFlowEstimateFactor Provides an estimate factor for part of composite flow. Presently it is upstream structure cross-section to upstream cross-section flow area ratio.
SetWaterLevels(StructureParametersFromHD) Sets up- and down-stream water level and forces the calculation of the discharge and its derivatives.
(Inherited from ISolvesEnergyEquation)
SetWaterLevels(Double, Double, Double, Double) Sets up- and down-stream water level and forces the calculation of the discharge and its derivatives.
(Inherited from ISolvesEnergyEquation)

See Also