Click or drag to resize

HDWaterVolumeRetainedInMaxInflowToNodesCalculator Class

Engine data item that can provide the water volume that is retained in nodes with a restriction in inflow capacity. This will always be zero unless the inflow to a node is restricted.

This version only calculates values on request, using buffering in case values are requested more than once.

Inheritance Hierarchy
SystemObject
  DHI.Mike1D.Engine.ModuleDataEngineDataItemAllBaseDouble
    DHI.Mike1D.Engine.ModuleDataEngineDataItemAllDouble
      DHI.Mike1D.Engine.AddOnsHDWaterVolumeRetainedInMaxInflowToNodesCalculator

Namespace:  DHI.Mike1D.Engine.AddOns
Assembly:  DHI.Mike1D.Engine (in DHI.Mike1D.Engine.dll) Version: 19.0.0.0 (11.1.1.1111)
Syntax
public class HDWaterVolumeRetainedInMaxInflowToNodesCalculator : EngineDataItemAll<double>

The HDWaterVolumeRetainedInMaxInflowToNodesCalculator type exposes the following members.

Properties
Methods
  NameDescription
Public methodContainsDataGeneric
Check whether there is data for the index reference
(Inherited from EngineDataItemAllBaseT.)
Public methodContainsDataNode
Check whether there is data for the specified node
(Inherited from EngineDataItemAllT.)
Public methodContainsDataReach
Check whether there is data for the specified reach
(Inherited from EngineDataItemAllT.)
Public methodContainsDataReachGeneric
Check whether there is generic data for the specified reach
(Inherited from EngineDataItemAllBaseT.)
Public methodStatic memberCreate
Create helper class for calculating total inflow to a reach
Public methodCreateGridPointMap
For every reach, create a mapping from grid point index in reach to grid point index in enginedata item.
(Inherited from EngineDataItemAllT.)
Protected methodCreateReachesData
Create ReachesData, usually array of all reaches
(Inherited from EngineDataItemAllT.)
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 methodGetDataReach
Get engine data for the specified reach.
(Inherited from EngineDataItemAllT.)
Public methodGetDataReachGeneric
Get generic engine data for the specified reach.
(Inherited from EngineDataItemAllBaseT.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetNodeData
Get engine data for the specified node.
(Inherited from EngineDataItemAllT.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetValue
Get engine data for the specified node.
(Inherited from EngineDataItemAllT.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodPrepare (Inherited from EngineDataItemAllBaseT.)
Protected methodSetEngineDataReach
Set reach data to reaches array
(Inherited from EngineDataItemAllT.)
Public methodSetupDataForNodes(EngineNet)
Setup data for all nodes
(Inherited from EngineDataItemAllT.)
Public methodSetupDataForNodes(EngineNet, EngineDataItemAllTDCreateNodeDataT)
Setup data for all nodes
(Inherited from EngineDataItemAllT.)
Public methodSetupDataForReaches(EngineNet)
Set up reach data, data on all gridpoints
(Inherited from EngineDataItemAllBaseT.)
Public methodSetupDataForReaches(EngineNet, EngineDataItemAllTDCreateReachDataT)
Set up reach data, based on delegate
(Inherited from EngineDataItemAllT.)
Public methodCode exampleSetupDataForReaches(EngineNet, PredicateGridPoint)
Set up reach data, data on all gridpoints of a given instance type
(Inherited from EngineDataItemAllT.)
Public methodCode exampleSetupDataForReaches(EngineNet, Type)
Set up reach data, data on all gridpoints of a given instance type
(Inherited from EngineDataItemAllT.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodUpdateValues
Update values of all pull items
(Inherited from EngineDataItemAllBaseT.)
Public methodValueFractionGetter
Valuegetter for engine data for the specified node.
(Inherited from EngineDataItemAllT.)
Public methodValueGetter
Valuegetter for engine data for the specified node.
(Inherited from EngineDataItemAllT.)
Top
Fields
See Also