HDVelocityCalculator Class |
Pull version of calculating velocity on grid points
Data is calculated when GetValues are called
Inheritance HierarchySystemObject
DHI.Mike1D.Engine.ModuleDataAbstractEngineDataReach
DHI.Mike1D.Engine.AddOnsHDVelocityCalculator
DHI.Mike1D.Engine.ModuleDataAbstractEngineDataReach
DHI.Mike1D.Engine.AddOnsHDVelocityCalculator
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 HDVelocityCalculator : AbstractEngineDataReach
The HDVelocityCalculator type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | HDVelocityCalculator | Initializes a new instance of the HDVelocityCalculator class |
Properties| Name | Description | |
|---|---|---|
 | ElementCount |
Number of element values
(Inherited from AbstractEngineDataReach.) |
| ElementValues |
element values
(Inherited from AbstractEngineDataReach.) |
| GridPointIndices |
Indices of gridpoints that data belongs to
(Inherited from AbstractEngineDataReach.) |
| Item |
Element value by index
(Inherited from AbstractEngineDataReach.) |
Methods| Name | Description | |
|---|---|---|
 | BuildIndexListForEndPoints |
Build the indexlist for the specified gridpoints
(Inherited from AbstractEngineDataReach.) |
| BuildIndexListForGridPoints(Boolean, Boolean) |
Build the indexlist for the specified gridpoints using the _hdreach list.
|
| BuildIndexListForGridPoints(EngineReach, Boolean, Boolean) |
Build the indexlist for the specified gridpoints
(Inherited from AbstractEngineDataReach.) |
 | CreateDataItemForEndPoints |
Factory method for creating a dataitem that calculates velocities for HDModule for the
first and/or last gridpoint.
|
| CreateDataItemForGridPoints |
Factory method for creating a dataitem that calculates velocities for HDModule for the
gridpoints specified
|
| CreateForEndPoints |
Factory class for creating velocity data structures on reach end points
|
| CreateForGridPoints(EngineNet, Int32, ListInt32) |
Factory class for creating velocity data structures on h- and/or q-points
|
| CreateForGridPoints(EngineNet, Int32, Boolean, Boolean) |
Factory class for creating velocity data structures on h- and/or q-points
|
| 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.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GetValue |
Get the current values.
(Overrides AbstractEngineDataReachGetValue(Int32).) |
| GetValues |
Get the current values of the velocities. A new array will be returned every time called.
(Overrides AbstractEngineDataReachGetValues.) |
| GetValues(Double) |
Get the current values of the velocities.
(Overrides AbstractEngineDataReachGetValues(Double).) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| Prepare |
Prepare for new simulation. For pull versions, this is the empty function.
(Inherited from AbstractEngineDataReach.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Fields| Name | Description | |
|---|---|---|
 | _indexList |
List of indexes into points in a reach
(Inherited from AbstractEngineDataReach.) |
Remarks
To build the index list, use the engineReach, since the hdReach
does not have gridpoints before prepare is called, and we need
to insert this before prepare (otherwise ResultData will not
find it).
See Also