PointSourceBoundary Class

A source located at a specific point in the network. A PointSourceBoundary is always an inflow (a forcing).

Inheritance Hierarchy

SystemObject
  DHI.Mike1D.BoundaryModuleAbstractSourceBoundary
    DHI.Mike1D.BoundaryModuleAbstractLocationSourceBoundary
      DHI.Mike1D.BoundaryModulePointSourceBoundary

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 PointSourceBoundary : AbstractLocationSourceBoundary, 
	IPointSourceBoundary, IAbstractLocationSourceBoundary, IBoundarySource, IBoundaryWithComponents, IBoundaryAdaptive, 
	IExtensibleDataObject

Public Class PointSourceBoundary
	Inherits AbstractLocationSourceBoundary
	Implements IPointSourceBoundary, IAbstractLocationSourceBoundary, IBoundarySource, IBoundaryWithComponents, 
	IBoundaryAdaptive, IExtensibleDataObject

public ref class PointSourceBoundary : public AbstractLocationSourceBoundary, 
	IPointSourceBoundary, IAbstractLocationSourceBoundary, IBoundarySource, IBoundaryWithComponents, IBoundaryAdaptive, 
	IExtensibleDataObject

The PointSourceBoundary type exposes the following members.

Constructors

	Name	Description
	PointSourceBoundary	Initializes a new instance of the PointSourceBoundary class

Top

Properties

	Name	Description
	BoundaryID	ID of boundary (Inherited from AbstractSourceBoundary.)
	BoundarySourceType	Type of BoundarySource - always PointSource (Overrides AbstractSourceBoundaryBoundarySourceType.)
	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.)
	NodeLocations	A list of all NodeLocations (Inherited from AbstractLocationSourceBoundary.)
	PointLocations	A list of all PointLocations (Inherited from AbstractLocationSourceBoundary.)
	PointSourceBoundaryInflowType	Type of PointSourceBoundary. Used to limit the total inflow of a specific type.
	PointSourceType	Type of Point source boundary. Default is Inflow

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.)
	Description	Create a description of boundary, return as diagnostics item. Used as description when creating new diagnostics.
	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 value for this source (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.)
	GetPreferredTimeStep	Get preferred time step, which should not vary more than maxRelChange within the given time step.
	GetScaleFactor(String)	Get the scale factor for a given NodeLocation (Inherited from AbstractLocationSourceBoundary.)
	GetScaleFactor(ILocation)	Get the scale factor for a given PointLocation (Inherited from AbstractLocationSourceBoundary.)
	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 (Overrides AbstractSourceBoundaryGetValueWithoutDWF(DateTime).)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Prepare	Prepare source. (Inherited from AbstractSourceBoundary.)
	SetScaleFactor(String, Double, IDiagnostics)	Set the scale factor for a NodeLocation. By default all scale factors are 1.0. (Inherited from AbstractLocationSourceBoundary.)
	SetScaleFactor(ILocation, Double, IDiagnostics)	Set the scale factor for a PointLocation. By default all scale factors are 1.0. (Inherited from AbstractLocationSourceBoundary.)
	ToString	Custom textual representation (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.)
	ValidateLocations	Validate locations and scalefactors (Inherited from AbstractLocationSourceBoundary.)

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