DistributedSourceBoundary Class

A distributed source is a source that is applied on a part of the network. It can be a combination of LocationSpans and Links. TODO: Check whether the links are necessary or whether they are just a simpel version of a LocationSpan.

Inheritance Hierarchy

SystemObject
DHI.Mike1D.BoundaryModuleAbstractSourceBoundary
DHI.Mike1D.BoundaryModuleDistributedSourceBoundary

Namespace: DHI.Mike1D.BoundaryModule
Assembly: DHI.Mike1D.BoundaryModule (in DHI.Mike1D.BoundaryModule.dll) Version: 19.0.0.0 (11.1.1.1111)

Syntax

C++

Copy

public class DistributedSourceBoundary : AbstractSourceBoundary, 
	IDistributedSourceBoundary, IBoundarySource, IBoundaryWithComponents, IExtensibleDataObject

Public Class DistributedSourceBoundary
	Inherits AbstractSourceBoundary
	Implements IDistributedSourceBoundary, IBoundarySource, IBoundaryWithComponents, IExtensibleDataObject

public ref class DistributedSourceBoundary : public AbstractSourceBoundary, 
	IDistributedSourceBoundary, IBoundarySource, IBoundaryWithComponents, IExtensibleDataObject

The DistributedSourceBoundary type exposes the following members.

Constructors

	Name	Description
	DistributedSourceBoundary	Initializes a new instance of the DistributedSourceBoundary class

Top

Properties

	Name	Description
	BoundaryID	ID of boundary (Inherited from AbstractSourceBoundary.)
	BoundarySourceType	Boundary source type, always DistributedSource (Overrides AbstractSourceBoundaryBoundarySourceType.)
	CatchmentArea	Area of the connected catchment. For distributed boundaries of type RainfallRunoffInflow we need the area of the connected catchment. Zero and unused for all other types of distributed boundaries
	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.)
	DistributedSourceType	Type of DistributedSource
	DistributionType	How the value of the source is distributed along the location spans/links
	ExtensionData	Data from an extended DataContract not recognized here
	Items	A list of all items attached to the source (Inherited from AbstractSourceBoundary.)
	LinkIds	A list of all LinkIds
	LocationSpans	A list of all LocationSpans
	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.)

Top

Methods

	Name	Description
	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.)
	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.)
	GetAccumulatedValue(DateTime, DateTime)	Get accumulated value for this source at the given time span (Overrides AbstractSourceBoundaryGetAccumulatedValue(DateTime, DateTime).)
	GetAccumulatedValue(Int32, DateTime, DateTime)	Get accumulated value for component at given index at the given time span (Inherited from AbstractSourceBoundary.)
	GetHashCode	Serves 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	Gets the next time for which there is a different value in the boundary source. (Inherited from AbstractSourceBoundary.)
	GetScaleFactor(String)	Get scale factor for link (reach id)
	GetScaleFactor(ILocationSpan)	Get scale factor for location span
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetValue(DateTime)	Get value for this source (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	Get value for this source without items marked as dry weather flow (Inherited from AbstractSourceBoundary.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Prepare	Prepare source. (Inherited from AbstractSourceBoundary.)
	SetScaleFactor(String, Double)	Set scale factor for link (reach id)
	SetScaleFactor(ILocationSpan, Double)	Set scale factor for location span
	ToString	Returns a string that represents the current object. (Overrides ObjectToString.)
	TryModify(Double, DateTime)	Try modify boundary value, if Modifier is not null (Inherited from AbstractSourceBoundary.)
	Validate	Validate whether this source is correctly setup (Overrides AbstractSourceBoundaryValidate(DateTime, DateTime).)
	ValidateItems	Validate _iItems of BoundarySource (Inherited from AbstractSourceBoundary.)

Top

Fields

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

Top

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.)

Top

Reference

DHI.Mike1D.BoundaryModule Namespace