public abstract class ADModule : IADModule,
IModule, IModuleNetwork, IModuleNetwork<IADNode, IADReach>,
IModelStateReadWrite, IProxyProvider, IDoubleNetworkProxy, ISourcePointProxyProvider| ADModule | Initializes a new instance of the ADModule class |
| ADScope | The component scope of the AD module. |
| Components | AD components, shortcut to AD Data components list |
| Id | Id of module |
| Nodes | List of AD Nodes |
| Order | Order of module. Modules are processed in order. The AD module must run after the corresponding IFlowModule (for example, HD module, which has order 200). |
| Reaches | List of AD Reaches |
| Create | Create an ADModule based on input modules like HDModule or AirModule. |
| 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 | Finishes the module and releases any license |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetNode | Maps an EngineNode to the corresponding AD 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 AD Reach |
| 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 timestep and return true if solution is accepted. Can be called several times for different values of Dt. |
| PerformTimestep(Int32) | Perform a time step only for active components. |
| 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. |
| Prepare | Prepare module for first time step. |
| PrepareForTimeStep | Prepare module for time step (set state(n+1) = state(n)). |
| ReadState | Read state and apply to module. Returns true if state was successfully read. |
| SetInitialValues | Set initial values for AD module |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| WriteState | Write current state of module |
| STWaterVolumeErrorConcentrationCorrection | Flag indicating how water volume errors are handled for suspended ST components. When true, the concentration is kept constant, and mass is added/removed matching the volume error. When false, the mass is kept constant, and the concentration changes with the volume error. Default is false |
| WaterVolumeErrorConcentrationCorrection | Flag indicating how water volume errors are handled for AD components. When true, the concentration is kept constant, and mass is added/removed matching the volume error. When false, the mass is kept constant, and the concentration changes with the volume error. Default is true |
| GetProxy | (Defined by EngineExtensions) |
| GetProxy | (Defined by EngineExtensions) |
| GetProxy | (Defined by EngineExtensions) |
| GetProxy | (Defined by EngineExtensions) |
| GetProxyReachGeneric | (Defined by EngineExtensions) |