HDModule Methods

Methods

AddBoundaryToAdaptiveTimeStepCheck Add a boundary source to the adaptive time series check
AddToAdaptiveTimeStepCheck Add a boundary source to the adaptive time series check
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)
FinalizeTimestep FinalizeTimeStep allows the modules to do operations required when a time step has successfully completed
Finish Release any license and clean up
GetHashCodeServes 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(INetworkNode) Get a proxy for the node
GetProxy(INetworkReach) Get a proxy for the reach, covering a number of gridpoints
GetProxy(EngineReach, Int32) Get a proxy for the gridpoint in the reach
GetProxy(INetworkReach, Int32) Get a proxy for the gridpoint in the reach
GetProxyReachGeneric(EngineReach) Get a proxy for the reach, generic data (not gridpoint associated)
GetProxyReachGeneric(INetworkReach) Get a proxy for the reach, generic data (not gridpoint associated)
GetReach Maps an EngineReach to the corresponding HD Reach
GetSourcePoint(EngineReach, Int32) Get a source point for the gridpoint in the reach. Usually this can only be called after the Prepare(Diagnostics) function has been called.
Obsolete
GetSourcePoint(EngineReach, Type) 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.
Obsolete
GetSourcePoint(EngineReach, Type, ILocationSpan) 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.
Obsolete
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.

GetTypeGets the Type of the current instance.
(Inherited from Object)
MemberwiseCloneCreates 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.
ToStringReturns a string that represents the current object.
(Inherited from Object)
WriteState Write current state of module

Extension Methods

See Also