CatchmentSourceBoundary Class

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

Inheritance Hierarchy

SystemObject
DHI.Mike1D.BoundaryModuleAbstractSourceBoundary
DHI.Mike1D.BoundaryModuleCatchmentSourceBoundary

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 CatchmentSourceBoundary : AbstractSourceBoundary, 
	ICatchmentSourceBoundary, IBoundarySource, IBoundaryWithComponents, IExtensibleDataObject

Public Class CatchmentSourceBoundary
	Inherits AbstractSourceBoundary
	Implements ICatchmentSourceBoundary, IBoundarySource, IBoundaryWithComponents, IExtensibleDataObject

public ref class CatchmentSourceBoundary : public AbstractSourceBoundary, 
	ICatchmentSourceBoundary, IBoundarySource, IBoundaryWithComponents, IExtensibleDataObject

The CatchmentSourceBoundary type exposes the following members.

Constructors

	Name	Description
	CatchmentSourceBoundary	Initializes a new instance of the CatchmentSourceBoundary class

Top

Properties

	Name	Description
	BoundaryID	ID of boundary (Inherited from AbstractSourceBoundary.)
	BoundarySourceType	Boundary source type is always CatchmentSource (Overrides AbstractSourceBoundaryBoundarySourceType.)
	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.
	CatchmentSourceBoundaryType	CatchmentSource Type - currently only Discharge is implemented
	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
	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.)

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 accumukated 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 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.)
	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.)
	ToString	Custom ToString - a textual representation of the BoundarySource (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