HDDataItems Class

Class that contains data items (HD add-ons) that can be reused.

Definition

Namespace: DHI.Mike1D.Engine.ModuleHD
Assembly: DHI.Mike1D.Engine (in DHI.Mike1D.Engine.dll) Version: 24.0.0.0 (11.1.1.1111)
C#
public class HDDataItems
Inheritance
Object    HDDataItems

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.

Properties

BedShearStressCalculator Bed shear stress calculator. To override the default build-in calculator, add your own here just after the HD module has been created.

Methods

BedShearStress BEd Shear Stress for the current time step
DischargeHPoints Interpolate discharge on H points
DischargeVolume Discharge Volume, discharge accumulated over time
EnergyLevel Energy Level for the current time step
EnergyLevelSlope Energy Level Slope for the current time step
EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
FloodedAreaTotal Total flooded area in network for the current time step
Froude Froude number for the current time step
Froude(Boolean, Boolean) Froude number for the current time step
FroudeEnd Froude number for the current time step at the end of the reach
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetTypeGets the Type of the current instance.
(Inherited from Object)
IntegratingCalculator Calculator doing time integration of quantity
MassError Mass error for the current time step
MassErrorAccumulated Mass error accumulated (with sign) since the start of the simulation, i.e. total generated water.
MassErrorAccumulatedCheckSum Mass error check sum since start of simulation, must equal zero (order of round of errors). Only total value, not detailed
MassErrorCheckSum Mass error check sum, must equal zero (order of round of errors). Only total value, not detailed
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
StatisticsCalculator Calculator doing statistics of quantity
TimestepInflow Inflow into the network for current time step
TimestepOutflow Outflow out of the network for current time step
ToStringReturns a string that represents the current object.
(Inherited from Object)
TotalInflow Total inflow into the network from the start of the simulation
TotalOutflow Total outflow out of the network from the start of the simulation
Velocity Velocity for the current time step
Velocity(Boolean, Boolean) Velocity for the current time step
VelocityEnd Velocity for the current time step in the end of the reach
VelocityMinMax Velocity for the current time step
Volume Volume in network for the current time step
VolumeChange Change in volume for the current time step
VolumeInNodesAboveGround Volume in network for the current time step in nodes above ground
WaterFlowRateAboveGround Volume in network for the current time step in nodes above ground
WaterLevelMinMax Min and max water level in gridpoints of reach
WaterLevelMinMax(Boolean, Boolean) Min and max water level in grid-points of reach and nodes
WaterLevelSlope Water Level Slope for the current time step

Fields

_bedShearStress Bed shear stress data item

See Also