CatchmentSourceWeightingBoundary Class

Catchment source boundary. All catchments are identified by a catchment ID, string.

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 CatchmentSourceWeightingBoundary : CatchmentSourceBoundary
Inheritance
Object    AbstractSourceBoundary    CatchmentSourceBoundary    CatchmentSourceWeightingBoundary

Constructors

CatchmentSourceWeightingBoundaryInitializes a new instance of the CatchmentSourceWeightingBoundary class

Properties

Boundaries Pointers to boundaries
BoundaryID ID of boundary
(Inherited from AbstractSourceBoundary)
BoundaryIds Boundary ids which are weighed
BoundarySourceType Boundary source type is always CatchmentSource
(Inherited from CatchmentSourceBoundary)
CatchmentIds A list of all Catchment ID's associated with this Source. It can be empty, then the source is assumed to be globally valid.
(Inherited from CatchmentSourceBoundary)
CatchmentSourceBoundaryType CatchmentSource Type - currently only Discharge is implemented
(Inherited from CatchmentSourceBoundary)
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)
ExtensionData Data from an extended DataContract not recognized here
(Inherited from CatchmentSourceBoundary)
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)
Weights Weights for different items

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) Get accumulated value of the catchment source boundary between the start and end time. The result is set to a negative value for Evaporation and Abstraction boundary types.
(Overrides CatchmentSourceBoundaryGetAccumulatedValue(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) Get accumulated value for component at given index at the given time span
(Inherited from AbstractSourceBoundary)
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
(Overrides AbstractSourceBoundaryGetNextTransitionTime(DateTime))
GetTypeGets the Type of the current instance.
(Inherited from Object)
GetValue(DateTime) Get value for this source
(Overrides CatchmentSourceBoundaryGetValue(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 Get value for this source without items marked as dry weather flow
(Inherited from AbstractSourceBoundary)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Prepare Prepare source.
(Inherited from AbstractSourceBoundary)
ToString Custom ToString - a textual representation of the BoundarySource
(Inherited from CatchmentSourceBoundary)
TryModify(Double, DateTime) Try modify boundary value, if Modifier is not null
(Inherited from AbstractSourceBoundary)
Validate Validate whether this source is correctly setup
(Overrides CatchmentSourceBoundaryValidate(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