CatchmentComponentSourceBoundary Class

A special kind of boundary, only used when AD module is enabled, which provides component concentrations for catchment inflows.

Definition

Namespace: DHI.Mike1D.BoundaryModule
Assembly: DHI.Mike1D.BoundaryModule (in DHI.Mike1D.BoundaryModule.dll) Version: 24.0.0.0 (11.1.1.1111)
C#
public class CatchmentComponentSourceBoundary : AbstractSourceBoundary
Inheritance
Object    AbstractSourceBoundary    CatchmentComponentSourceBoundary

Constructors

CatchmentComponentSourceBoundaryInitializes a new instance of the CatchmentComponentSourceBoundary class

Properties

BoundaryID ID of boundary
(Inherited from AbstractSourceBoundary)
BoundarySourceType Not supported
(Overrides AbstractSourceBoundaryBoundarySourceType)
CatchmentIds List of catchment ID's that this is attached to.
CatchmentQuantity Quantity of catchment flow that the component is related to.

Default is Quantity.Create(PredefinedQuantity.TotalRunOff) though by changing this, the component can be attached to NetRainfall or OverlandFlow or similar.

Components A list of all components sources attached to the source. Each component may have more than one entry in this list.
(Inherited from AbstractSourceBoundary)
Items A list of all items attached to the source
(Inherited from AbstractSourceBoundary)
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.

Default is null

The value is provided in the engine unit and must be returned in the engine unit.


(Inherited from AbstractSourceBoundary)

Methods

CalculateVariation Calculate variation (as difference from linear interpolation between start and end)

This method estimates the variation by checking values at 3 intermediate points within the interval.

Since this looks up in the time series 5 times, there may be performance issues with this, so use with care.


(Inherited from AbstractSourceBoundary)
EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GetAccumulatedValue(DateTime, DateTime) Not supported
(Overrides AbstractSourceBoundaryGetAccumulatedValue(DateTime, DateTime))
GetAccumulatedValue(DateTime, DateTime, TimeSpan) Get accumulated value, and the span for which the values are not delete values.
(Inherited from AbstractSourceBoundary)
GetAccumulatedValue(Int32, DateTime, DateTime) Not supported
(Overrides AbstractSourceBoundaryGetAccumulatedValue(Int32, DateTime, DateTime))
GetDeleteValue Return the delete value for this boundary.
(Inherited from AbstractSourceBoundary)
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetNextComponentTransitionTime Gets the next time for which there is a different value in the component boundary source.
(Inherited from AbstractSourceBoundary)
GetNextTransitionTime Not supported
(Overrides AbstractSourceBoundaryGetNextTransitionTime(DateTime))
GetTypeGets the Type of the current instance.
(Inherited from Object)
GetValue(DateTime) Not supported
(Overrides AbstractSourceBoundaryGetValue(DateTime))
GetValue(Int32, DateTime) Get value of the component in the boundary on the provided index.

The index is NOT into global index of AD components.


(Inherited from AbstractSourceBoundary)
GetValueWithoutDWF Not supported
(Overrides AbstractSourceBoundaryGetValueWithoutDWF(DateTime))
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Prepare Prepare source.
(Overrides AbstractSourceBoundaryPrepare(DateTime, DateTime, IDiagnostics))
ToStringReturns a string that represents the current object.
(Inherited from Object)
TryModify(Double, DateTime) Try modify boundary value, if Modifier is not null
(Inherited from AbstractSourceBoundary)
Validate Not supported
(Overrides AbstractSourceBoundaryValidate(DateTime, DateTime))
ValidateItems Validate _iItems of BoundarySource
(Inherited from AbstractSourceBoundary)

Fields

_boundaryID See BoundaryID
(Inherited from AbstractSourceBoundary)
_iItems A list of all items attached to the source
(Inherited from AbstractSourceBoundary)

See Also