HDWaterMaxVolumeCalculator Class |
Engine data item that can provide the maximum volume in the network.
The maximum volume is only calculated once (ie the network is assumed to be static)
Pull version only calculates values on request.
Inheritance HierarchySystem.Object
DHI.Mike1D.Engine.ModuleData.EngineDataItemAll<Double>
DHI.Mike1D.Engine.AddOns.HDWaterMaxVolumeCalculator
DHI.Mike1D.Engine.ModuleData.EngineDataItemAll<Double>
DHI.Mike1D.Engine.AddOns.HDWaterMaxVolumeCalculator
Namespace: DHI.Mike1D.Engine.AddOns
Assembly: DHI.Mike1D.Engine (in DHI.Mike1D.Engine.dll) Version: 16.0.0.0 (11.1.1.1111)
SyntaxC#
public class HDWaterMaxVolumeCalculator : EngineDataItemAll<double>
The HDWaterMaxVolumeCalculator type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | DataGeneric |
Get engine data for the specified index reference.
(Inherited from EngineDataItemAll<T>.) |
| Detailed |
Indicating whether detailed volume data are calculated.
|
| M11Compatibility |
If true, then water volume is calculated from water level at time nph. If false, then
water level at np1 is used.
|
| Quantity |
Quantity of the data in this IEngineDataItem<T> (Inherited from EngineDataItemAll<T>.) |
Methods| Name | Description | |
|---|---|---|
 | ContainsDataGeneric |
Check whether there is data for the index reference
(Inherited from EngineDataItemAll<T>.) |
| ContainsDataNode |
Check whether there is data for the specified node
(Inherited from EngineDataItemAll<T>.) |
| ContainsDataReach |
Check whether there is data for the specified reach
(Inherited from EngineDataItemAll<T>.) |
| ContainsDataReachGeneric |
Check whether there is generic data for the specified reach
(Inherited from EngineDataItemAll<T>.) |
 | Create |
Create helper class for calculating the maximum volume in a reach
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetDataNode |
Get engine data for the specified node.
(Inherited from EngineDataItemAll<T>.) |
| GetDataReach |
Get engine data for the specified reach.
(Inherited from EngineDataItemAll<T>.) |
| GetDataReachGeneric |
Get generic engine data for the specified reach.
(Inherited from EngineDataItemAll<T>.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| Prepare |
Prepare for new simulation
(Overrides EngineDataItemAll<T>.Prepare().) |
| SetupDataForNodes(EngineNet) |
Setup data for all nodes
(Inherited from EngineDataItemAll<T>.) |
| SetupDataForNodes(EngineNet, EngineDataItemAll<T>.DCreateNodeData<T>) |
Setup data for all nodes
(Inherited from EngineDataItemAll<T>.) |
| SetupDataForReaches(EngineNet) |
Set up reach data, data on all gridpoints
(Inherited from EngineDataItemAll<T>.) |
| SetupDataForReaches(EngineNet, EngineDataItemAll<T>.DCreateReachData<T>) |
Set up reach data, based on delegate
(Inherited from EngineDataItemAll<T>.) |
 | SetupDataForReaches(EngineNet, Predicate<GridPoint>) |
Set up reach data, data on all gridpoints of a given instance type
(Inherited from EngineDataItemAll<T>.) |
| SetupDataForReaches(EngineNet, Type) |
Set up reach data, data on all gridpoints of a given instance type
(Inherited from EngineDataItemAll<T>.) |
| SetupDataForReaches(EngineNet, List<Int32>, List<Double>, List<Double>, Predicate<GridPoint>) |
Set up reach data, data on all gridpoints of a given instance type
(Inherited from EngineDataItemAll<T>.) |
| SetupDetailed |
Enable detailed calculations, for all nodes and grid points in the network
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| UpdateValues |
Update values of all pull items
(Overrides EngineDataItemAll<T>.UpdateValues().) |
Fields| Name | Description | |
|---|---|---|
 | GenericData |
Generic data
(Inherited from EngineDataItemAll<T>.) |
| NodesData |
Data on nodes
(Inherited from EngineDataItemAll<T>.) |
| ReachesData |
Data on reaches
(Inherited from EngineDataItemAll<T>.) |
| ReachGenericData |
Generic data on reaches
(Inherited from EngineDataItemAll<T>.) |
See Also