public class ADModuleSinglePhase : ADModule| ADScope |
The component scope of the AD module.
(Inherited from ADModule) |
| Components | AD components, shortcut to AD Data components list (Inherited from ADModule) |
| Id |
Id of module
(Inherited from ADModule) |
| Nodes | List of AD Nodes (Inherited from ADModule) |
| 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).
(Inherited from ADModule) |
| Reaches | List of AD Reaches (Inherited from ADModule) |
| 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
(Overrides ADModuleFinalizeTimestep) |
| Finish |
Finishes the module and releases any license
(Overrides ADModuleFinish) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetNode |
Maps an EngineNode to the corresponding AD Node
(Inherited from ADModule) |
| GetProxy |
Get a proxy for generic/global data
(Inherited from ADModule) |
| GetProxy(EngineNode) |
Get a proxy for the node
(Inherited from ADModule) |
| GetProxy(EngineReach) |
Get a proxy for the reach, covering a number of gridpoints
(Inherited from ADModule) |
| GetProxy(INetworkNode) |
Get a proxy for the node
(Inherited from ADModule) |
| GetProxy(INetworkReach) |
Get a proxy for the reach, covering a number of gridpoints
(Inherited from ADModule) |
| GetProxy(EngineReach, Int32) |
Get a proxy for the gridpoint in the reach
(Inherited from ADModule) |
| GetProxy(INetworkReach, Int32) |
Get a proxy for the gridpoint in the reach
(Inherited from ADModule) |
| GetProxyReachGeneric(EngineReach) |
Get a proxy for the reach, generic data (not gridpoint associated)
(Inherited from ADModule) |
| GetProxyReachGeneric(INetworkReach) |
Get a proxy for the reach, generic data (not gridpoint associated)
(Inherited from ADModule) |
| GetReach |
Maps an EngineReach to the corresponding AD Reach
(Inherited from ADModule) |
| 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 ADModule) |
| 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 ADModule) |
| 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.
(Overrides ADModulePerformTimestep) |
| PerformTimestep(Int32) |
Perform timestep and return true if solution is accepted.
Can be called several times for different values of Dt.
(Overrides ADModulePerformTimestep(Int32)) |
| 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. (Overrides ADModulePreferredTimeStep(Boolean, TimeSpan)) |
| Prepare |
Prepare module for first time step.
(Overrides ADModulePrepare(Diagnostics)) |
| PrepareForTimeStep |
Prepare module for time step (set state(n+1) = state(n)).
(Overrides ADModulePrepareForTimeStep(Int32)) |
| ReadState |
Read state and apply to module.
Returns true if state was successfully read.
(Inherited from ADModule) |
| SetInitialValues | (Overrides ADModuleSetInitialValues) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| WriteState |
Write current state of module
(Inherited from ADModule) |
| 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
(Inherited from ADModule) |
| 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
(Inherited from ADModule) |