public interface IADModule : IModule,
IModuleNetwork, IModuleNetwork<IADNode, IADReach>, IModelStateReadWrite,
IProxyProvider, IDoubleNetworkProxy, ISourcePointProxyProvider| Id |
Id of module
(Inherited from IModule) |
| Nodes | (Inherited from IModuleNetwork) |
| Order |
Order of module. Modules are processed in order.
(Inherited from IModule) |
| Reaches | (Inherited from IModuleNetwork) |
| FinalizeTimestep |
FinalizeTimeStep allows the modules to do operations required when
a time step has successfully completed
(Inherited from IModule) |
| Finish |
Finishes the module and releases any license
(Inherited from IModule) |
| GetProxy |
Get a proxy for generic/global data
(Inherited from IProxyProvider) |
| GetProxy(EngineNode) |
Get a proxy for the node
(Inherited from IProxyProvider) |
| GetProxy(EngineReach) |
Get a proxy for the reach, covering a number of gridpoints
(Inherited from IProxyProvider) |
| GetProxy(INetworkNode) |
Get a proxy for the node
(Inherited from IDoubleNetworkProxy) |
| GetProxy(INetworkReach) |
Get a proxy for the reach, covering a number of gridpoints
(Inherited from IDoubleNetworkProxy) |
| GetProxy(EngineReach, Int32) |
Get a proxy for the gridpoint in the reach
(Inherited from IProxyProvider) |
| GetProxy(INetworkReach, Int32) |
Get a proxy for the gridpoint in the reach
(Inherited from IDoubleNetworkProxy) |
| GetProxyReachGeneric(EngineReach) |
Get a proxy for the reach, generic data (not gridpoint associated)
(Inherited from IProxyProvider) |
| GetProxyReachGeneric(INetworkReach) |
Get a proxy for the reach, generic data (not gridpoint associated)
(Inherited from IDoubleNetworkProxy) |
| GetSourcePointProxy(EngineNode) |
Get a source point proxy for the node.
Usually this can only be called after the Prepare(Diagnostics) function has been called. (Inherited from ISourcePointProxyProvider) |
| 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. (Inherited from ISourcePointProxyProvider) |
| PerformTimestep |
Perform timestep and return true if solution is accepted.
Can be called several times for different values of Dt.
(Inherited from IModule) |
| PreferredTimeStep |
Returns the preferred time step for the current state. It is called between every time step
and can increase as well as decrease the time step.
Used when AdaptiveTimeSteppingActivated is true. Do return the maximum of the allowed time step; in case a buffer is required, this is handled by a time step controller. (Inherited from IModule) |
| Prepare |
Prepare module for first time step.
(Inherited from IModule) |
| PrepareForTimeStep |
Prepare module for time step (set state(n+1) = state(n)).
(Inherited from IModule) |
| ReadState |
Read state and apply to module.
Returns true if state was successfully read.
(Inherited from IModelStateReadWrite) |
| WriteState |
Write current state of module
(Inherited from IModelStateReadWrite) |
| GetProxy | (Defined by EngineExtensions) |
| GetProxy | (Defined by EngineExtensions) |
| GetProxy | (Defined by EngineExtensions) |
| GetProxy | (Defined by EngineExtensions) |
| GetProxyReachGeneric | (Defined by EngineExtensions) |