BoundarySourceComponent Class

Boundary source for a component, containing either a concentration type source, a load type source, or a specific quantity.

The component sources are used by other than inflow boundaries, as e.g. a wind having a direction and a velocity component. These special types of component sources may require the components in a special order. They are identified by their Quantity value.

The connection to the AD components is defined by the ComponentId value. If that is null or empty, it is not an AD component.

Inheritance Hierarchy

SystemObject
DHI.Mike1D.BoundaryModuleBoundarySourceComponent

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 BoundarySourceComponent

Public Class BoundarySourceComponent

public ref class BoundarySourceComponent

The BoundarySourceComponent type exposes the following members.

Constructors

	Name	Description
	BoundarySourceComponent	Default constructor

Top

Properties

	Name	Description
	ComponentId	The component id to use when coupling to the AD/ST module If this is null then this is not an AD/ST component
	EumQuantity	The eum-quantity of the returned values. Used by engine to handle unit conversion of the values from the boundary to the engine.
	Items	A list of all items attached to the source
	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.
	Quantity	Short-cut for setting ComponentId and EumQuantity
	Type	Type of component source.

Top

Methods

	Name	Description
	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.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetValue	Get value of the component.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	TryModify	Try modify boundary value, if Modifier is not null

Top

Extension Methods

	Name	Description
	IsLoad	Check if boundary source component is a load (Defined by BoundaryExtensions.)

Top

Reference

DHI.Mike1D.BoundaryModule Namespace