HDModule Methods |
The HDModule type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | AddBoundaryToAdaptiveTimeStepCheck |
Add a boundary source to the adaptive time series check
|
| AddToAdaptiveTimeStepCheck |
Add a boundary source to the adaptive time series check
|
| 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.) |
| FinalizeTimestep |
FinalizeTimeStep allows the modules to do operations required when
a time step has successfully completed
|
| Finish |
Release any license and clean up
|
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetImplicitSourcePoint(EngineNode) |
Get an implicit source point proxy for the node.
This can only be called after the Prepare(Diagnostics) function has been called. |
| GetImplicitSourcePoint(EngineReach, Int32) |
Get an implicit source point proxy for the gridpoint in the reach.
This can only be called after the Prepare(Diagnostics) function has been called. |
| GetNode |
Maps an EngineNode to the corresponding HD Node
|
| GetProxy |
Get a proxy for generic/global data
|
| GetProxy(EngineNode) |
Get a proxy for the node
|
| GetProxy(EngineReach) |
Get a proxy for the reach, covering a number of gridpoints
|
| GetProxy(EngineReach, Int32) |
Get a proxy for the gridpoint in the reach
|
| GetProxyReachGeneric |
Get a proxy for the reach, generic data (not gridpoint associated)
|
| GetReach | Maps an EngineReach to the corresponding HD Reach |
| GetSourcePoint(EngineReach, Int32) | Obsolete.
Get a source point for the gridpoint in the reach.
Usually this can only be called after the Prepare(Diagnostics) function has been called.
|
| GetSourcePoint(EngineReach, Type) | Obsolete.
Get a source point covering all gridpoints in the reach of the specified type
Usually this can only be called after the Prepare(Diagnostics) function has been called.
|
| GetSourcePoint(EngineReach, Type, ILocationSpan) | Obsolete.
Get a source point covering all gridpoints in the span of the specified type
Usually this can only be called after the Prepare(Diagnostics) function has been called.
|
| GetSourcePointProxy(EngineNode) |
Get a source point proxy for the node.
Usually this can only be called after the Prepare(Diagnostics) function has been called. |
| GetSourcePointProxy(EngineReach, Int32) |
Get a source point proxy for the gridpoint in the reach.
Usually this can only be called after the Prepare(Diagnostics) function has been called. |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| PerformTimestep |
Perform one time step. Return true if time step succeeded, or false if it failed.
|
| PreferredTimeStep | |
| Prepare |
Prepare HDModule for first time step.
|
| PrepareForTimeStep |
Prepare nodes and reaches for next time step.
- first time: Updates states, n to n+1 and nph. Derived variables depending
on only local state at n, n+1 and nph may also be updated
- Subsequent times: Resets the external source contributions.
|
| ReadState |
Read state and apply to module.
Returns true if state was successfully read.
|
| Reset |
Resets some of the HD module variables to initial values.
|
| SetInitialValues |
Set initial conditions, the water levels and discharges in all grid points and nodes to prepare for the first iteration.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| WriteState |
Write current state of module
|
Extension Methods| Name | Description | |
|---|---|---|
 | GetProxy | Overloaded. (Defined by EngineExtensions.) |
| GetProxy(EngineNode) | Overloaded. (Defined by EngineExtensions.) |
| GetProxy(EngineReach) | Overloaded. (Defined by EngineExtensions.) |
| GetProxy(EngineReach, Int32) | Overloaded. (Defined by EngineExtensions.) |
| GetProxyReachGeneric | (Defined by EngineExtensions.) |
See Also