IOpenSourceBoundary Interface |
Interface to a OpenSourceBoundary
Note: Needed for COM interop only - do not use from .Net
Namespace: DHI.Mike1D.BoundaryModule
Assembly: DHI.Mike1D.BoundaryModule (in DHI.Mike1D.BoundaryModule.dll) Version: 19.0.0.0 (11.1.1.1111)
SyntaxThe IOpenSourceBoundary type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | BoundaryID |
ID of boundary. Used for searching and connecting sources and items, when required. Not used by the engine.
(Inherited from IBoundarySource.) |
| Components |
A list of all components sources attached to the source. Each component may include more than
one entry in this list.
(Inherited from IBoundaryWithComponents.) |
| FlushFromBoundary |
If true, at water level boundaries, the initial boundary water level will be "flushed"
into the model as far as possible, and used as boundary conditions.
|
| MixHalvingTime |
MixHalvingTime is time constant used to calculate boundary concentration mixing in
case of flow reversal at the boundary,
It specifies the the time it takes to half the influence of a previous outflow. A value of zero is undefined, and will disable mixing. Default value: 3600. Unit: [s] |
| Modifier |
A modifier that you can assign run-time to the setup, to handle
e.g. putting noise to the model or in other ways change the value.
(Inherited from IBoundarySource.)Default is null The value is provided in the engine unit and must be returned in the engine unit. |
| NodeLocations |
A list of all NodeLocations
(Inherited from IAbstractLocationSourceBoundary.) |
| OpenSourceBoundaryType |
Type of OpenSourceBoundary
|
| PointLocations |
A list of all PointLocations
(Inherited from IAbstractLocationSourceBoundary.) |
| UseMixing |
If true, then the AD module uses mixing when calculating boundary concentration in case of flow reversal at the boundary.
|
Methods| Name | Description | |
|---|---|---|
 | GetAccumulatedValue(DateTime, DateTime) |
Get accumulated value for this source at the given time span
(Inherited from IBoundarySource.) |
| GetAccumulatedValue(Int32, DateTime, DateTime) |
Get accumulated value for component at given index at the given time span
(Inherited from IBoundaryWithComponents.) |
| GetNextTransitionTime |
Gets the next time for which there is a different value in the boundary source.
(Inherited from IBoundarySource.) |
| GetScaleFactor(String) |
Get the scale factor for a given NodeLocation
(Inherited from IAbstractLocationSourceBoundary.) |
| GetScaleFactor(ILocation) |
Get the scale factor for a given PointLocation
(Inherited from IAbstractLocationSourceBoundary.) |
| GetValue(DateTime) |
Get value for this source at the given time
(Inherited from IBoundarySource.) |
| GetValue(Int32, DateTime) |
Get value for component at given at the given time
(Inherited from IBoundaryWithComponents.) |
| GetValueWithoutDWF |
Get value for this source at the given time excluding items marked as dry weather flow
(Inherited from IBoundarySource.) |
| Prepare |
Prepare source.
(Inherited from IBoundarySource.) |
| SetScaleFactor(String, Double, IDiagnostics) |
Set the scale factor for a NodeLocation. By default all scale factors
are 1.0.
(Inherited from IAbstractLocationSourceBoundary.) |
| SetScaleFactor(ILocation, Double, IDiagnostics) |
Set the scale factor for a PointLocation. By default all scale factors
are 1.0.
(Inherited from IAbstractLocationSourceBoundary.) |
| Validate |
Validate whether this source is correctly setup
(Inherited from IBoundarySource.) |
Extension Methods| Name | Description | |
|---|---|---|
 | FindTimeNextValue |
Findes the time where the boundary source has a value that is non-zero. The
time interval is within the provided limits.
(Defined by BoundaryExtensions.) |
See Also