Click or drag to resize

DHI.Mike1D.Engine.ModuleHD Namespace

HD Module
Classes
  ClassDescription
Public classAdaptiveTSCheckSolutionConstraints
Apply constraints on time steps
Public classHDCouplingUtil Obsolete.
Utility classes for HD Couplings - only used by old coupling routines
Public classHDCouplingUtilStandardLinkHelper
Utility class for a standard link
Public classHDDataItems
Class that contains data items (HD add-ons) that can be reused.
Public classHDModule
HDModule solves the HD equations on a EngineNet, and keeps track of state for the HDModule.

The HDModule also implements the IGraph interface, defining only the part of the HD network in the graph.

Public classHeadLossCalculator
Standard head loss calculation class
Public classInfiltrationCalculator
Standard infiltration calculator, implementing bottom and box infiltration
Public classModuleHDExtensions
Class with extension methods for the HD module
Public classNodeDischargeAvailable
Helper class calculating discharge available in node.

this is not intended for parallel pumps - if there are more than one pump connected to a node, this will not do as intended, reporting total available volume to both/all pumps.

This is used in the parallel part of the code, in the loop over reaches, and this may access data in other reaches (which other threads can be working on), so it is important that this class only accesses properties of the reach that does not change - especially calling hdh-gridpoint cross section functionality is not allowed (race condition on the cross section buffer values / hdReachConnection.ReachNodeFlowType)

Structures
  StructureDescription
Public structureAdaptiveTSCheckSolutionConstraintsAdaptiveTSBoundary
Structure containing boundaries and reference value. Used with adaptive time stepping
Interfaces
  InterfaceDescription
Public interfaceIHDHGridPoint
HD Storage point. Represents the volume between the Q-points before and after.

The HD H grid point contains water level (state) and volume.

Public interfaceIHDNode
HD node contains HD state for a node.
Public interfaceIHDQGridPoint
HD flow/discharge point. Represents the discharge between two H points.

The HD Q grid point contains discharge.

Public interfaceIHDReach
HD reach contains HD state for a reach. The actual state is present in a series of grid points.
Public interfaceIHDReachConnection
A HD reach connection is used by the nodes, when listing which reaches that is connected to a node.
Public interfaceIHDStructureGridPoint
A Q grid point containing a structure.
Public interfaceIHDStructureNode
HD structure node contains an EngineNodeStructure with a INodeStructure.
Public interfaceIHeadLossCalculator
General interface for head loss calculations
Public interfaceIInfiltrationCalculator
Base interface for an infiltration calculator.
Delegates
  DelegateDescription
Public delegateHDModuleApplyExternalIntervalSource
Event for applying external sources. Called once for each time step.
Public delegateHDModuleApplyExternalSources
Event for applying external sources. Called once for each time step.
Public delegateHDModuleIterationDelegate
Delegate that is used when triggering a PreIterationEvent event.
Enumerations
  EnumerationDescription
Public enumerationReachNodeFlowTypes
Enumeration defining the flow between a node and a reach.