public interface IFlowModule : IModule| EngineNet | The EngineNet holds the network that is used for the computations. It is the main entrance to module data/state. |
| EngineTime | NetworkEngine time. |
| FlowNodes | A list of flow nodes. TODO: consider to call it just Nodes. |
| FlowReaches | A list of flow nodes. TODO: consider to call it just Reaches. |
| Id |
Id of module
(Inherited from IModule) |
| Order |
Order of module. Modules are processed in order.
(Inherited from IModule) |
| 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) |
| 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) |
| GetProxy | (Defined by EngineExtensions) |
| GetProxy | (Defined by EngineExtensions) |
| GetProxy | (Defined by EngineExtensions) |
| GetProxy | (Defined by EngineExtensions) |
| GetProxyReachGeneric | (Defined by EngineExtensions) |