DataModule Class |
The DataModule contains a set of IEngineDataItem with each their IQuantity.
It implements the IModule interface, however, it has no timestepping functionality.
Inheritance HierarchyNamespace: DHI.Mike1D.Engine.ModuleData
Assembly: DHI.Mike1D.Engine (in DHI.Mike1D.Engine.dll) Version: 19.0.0.0 (11.1.1.1111)
SyntaxThe DataModule type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | DataModule | Initializes a new instance of the DataModule class |
Properties| Name | Description | |
|---|---|---|
 | Id |
Id of module
|
| Order |
Order of module. Modules are processed in order.
|
| WaterVolumeInNetworkAtStart |
Get and set the water volume at the start of the simulations
|
Methods| Name | Description | |
|---|---|---|
| AddDataItem(IEngineDataItemDouble) |
Add a dataset to the datamodule
|
| AddDataItem(IEngineDataItemInt32) |
Add a dataset to the datamodule
|
| AddDataItem(IEngineDataItemTimeSpan) |
Add a dataset to the datamodule
|
| AddDataItem(IEngineDataItemMinMaxValueContainer) |
Add a dataset to the datamodule
|
| 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 |
Release any license and clean up
|
| GetDataItem |
Get a dataset from the datamodule
|
| GetDataItemInt |
Get a dataset from the datamodule
|
| GetDataItemMinMax |
Get a dataset from the datamodule
|
| GetDataItemTimeSpan |
Get a dataset from the datamodule
|
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| 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(EngineReach, Int32) |
Get a proxy for the gridpoint in the reach
|
| GetProxyReachGeneric |
Get a proxy for the reach, generic data (not gridpoint associated)
|
| 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.
|
| 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.
|
| 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.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| Inititalize |
Initialize module
|
| 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.
|
| PreferredTimeStep |
Increase time step after PerformTimestep() returned true. If possible,
the time step is increased before next PerformTimestep().
|
| Prepare |
Prepare module for first time step.
|
| PrepareForTimeStep |
Prepare module for next time step (set state(n+1) = state(n)).
|
| RemoveDataItem(IEngineDataItemDouble) |
Remove a dataset from the datamodule
|
| RemoveDataItem(IEngineDataItemInt32) |
Remove a dataset from the datamodule
|
| RemoveDataItem(IEngineDataItemTimeSpan) |
Remove a dataset from the datamodule
|
| RemoveDataItem(IEngineDataItemMinMaxValueContainer) |
Remove a dataset from the datamodule
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| WriteState |
Extension Methods| Name | Description | |
|---|---|---|
 | GetProxy | Overloaded. (Defined by EngineExtensions.) |
| GetProxy(EngineNode) | Overloaded. (Defined by EngineExtensions.) |
| GetProxy(EngineReach) | Overloaded. (Defined by EngineExtensions.) |
| GetProxy(EngineReach, Int32) | Overloaded. (Defined by EngineExtensions.) |
| GetProxyReachGeneric | (Defined by EngineExtensions.) |
See Also