Click or drag to resize

HDDataItems Class

Class that contains data items (HD add-ons) that can be reused.
Inheritance Hierarchy
SystemObject
  DHI.Mike1D.Engine.ModuleHDHDDataItems

Namespace:  DHI.Mike1D.Engine.ModuleHD
Assembly:  DHI.Mike1D.Engine (in DHI.Mike1D.Engine.dll) Version: 19.0.0.0 (11.1.1.1111)
Syntax
public class HDDataItems

The HDDataItems type exposes the following members.

Properties
  NameDescription
Public propertyBedShearStressCalculator
Bed shear stress calculator. To override the default build-in calculator, add your own here just after the HD module has been created.
Top
Methods
  NameDescription
Public methodBedShearStress
BEd Shear Stress for the current time step
Public methodDischargeHPoints
Interpolate discharge on H points
Public methodEnergyLevel
Energy Level for the current time step
Public methodEnergyLevelSlope
Energy Level Slope for the current time step
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodFloodedAreaTotal
Total flooded area in network for the current time step
Public methodFroude
Froude number for the current time step
Public methodFroude(Boolean, Boolean)
Froude number for the current time step
Public methodFroudeEnd
Froude number for the current time step at the end of the reach
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodMassError
Mass error for the current time step
Public methodMassErrorAccumulated
Mass error accumulated (with sign) since the start of the simulation, i.e. total generated water.
Public methodMassErrorAccumulatedCheckSum
Mass error check sum since start of simulation, must equal zero (order of round of errors). Only total value, not detailed
Public methodMassErrorCheckSum
Mass error check sum, must equal zero (order of round of errors). Only total value, not detailed
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodTimestepInflow
Inflow into the network for current time step
Public methodTimestepOutflow
Outflow out of the network for current time step
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodTotalInflow
Total inflow into the network from the start of the simulation
Public methodTotalOutflow
Total outflow out of the network from the start of the simulation
Public methodVelocity
Velocity for the current time step
Public methodVelocity(Boolean, Boolean)
Velocity for the current time step
Public methodVelocityEnd
Velocity for the current time step in the end of the reach
Public methodVolume
Volume in network for the current time step
Public methodVolumeChange
Change in volume for the current time step
Public methodVolumeInNodesAboveGround
Volume in network for the current time step in nodes above ground
Public methodWaterFlowRateAboveGround
Volume in network for the current time step in nodes above ground
Public methodWaterLevelMinMax
Min and max water level in gridpoints of reach
Public methodWaterLevelSlope
Water Level Slope for the current time step
Top
Fields
  NameDescription
Protected field_bedShearStress
Bed shear stress data item
Top
Remarks
This class is intended to avoid several versions of the same data item (HD add-ons) are created, if e.g. you need to calculate the total volume in more than one location, the same volume calculator is used.
See Also