EngineNodeBasin Class

Basin node

Inheritance Hierarchy

SystemObject
  DHI.Mike1D.EngineEngineNode
    DHI.Mike1D.EngineEngineNodeVolume
      DHI.Mike1D.EngineEngineNodeBasin

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

Syntax

C++

Copy

public class EngineNodeBasin : EngineNodeVolume

Public Class EngineNodeBasin
	Inherits EngineNodeVolume

public ref class EngineNodeBasin : public EngineNodeVolume

The EngineNodeBasin type exposes the following members.

Constructors

	Name	Description
	EngineNodeBasin	Create EngineNodeBasin

Top

Properties

	Name	Description
	BottomLevel	Bottom level For a junction node (node without volume (in a river setup)), this is set to the smallest bottomlevel of the surrounding reaches. (Inherited from EngineNode.)
	Cover	Cover on this node (Inherited from EngineNodeVolume.)
	CriticalLevel	Obsolete. Used in result presentation. Passed directly to the result file. Unit: [m] Default: 0 (Inherited from EngineNodeVolume.)
	Delh	The Delh controls the height of the bottom slot (Inherited from EngineNodeVolume.)
	ExternalCoupledArea	When coupled to an external water level, the effect of changing the water level in the network model also affects the external water level. By specifying the external coupled area, the actual water level boundary is modified to take the change in this external coupled area into account. It effectively has a smoothing effect on a coupling. The smaller coupled area, the more smoothing effect is applied. Setting the coupled area to 0 disables the procedure. (Inherited from EngineNode.)
	Geometry	Basin geometry, with water level, flow area, and surface area data
	GroundLevel	Ground level For a junction node (node without volume (in a river setup)), this is not set, having value of MaxValue. (Inherited from EngineNode.)
	HasVolume	Boolean specifying whether the enginenode has a volume. (Inherited from EngineNodeVolume.)
	HeadLossCalculator	Head loss calculator (Inherited from EngineNode.)
	ID	Node ID string. (Not associated with the reach ID's) (Inherited from EngineNode.)
	InfiltrationCalculator	Infiltration calculator (Inherited from EngineNode.)
	InfiltrationParameters	Infiltration parameters
	InternalNode	Returns true if the node is internal, i.e., not a boundary node. (Inherited from EngineNode.)
	IsClosed	Flag indicating if basin is closed. If the basin is closed, then surface area is not restricted to be monotonically increasing. Open basins counts in flooded area.
	IsSpillingNode	Return true is this is node has a spilling cover (Inherited from EngineNodeVolume.)
	Location	Obsolete. The Location of the node. A node can be placed at more than one location. This only handles one location. Used for searching for initial conditions. (Inherited from EngineNode.)
	MaxInflowFromSurface	Maximum inflow from the surface, i.e. rainfall runoff type inflows. This is only relevant for sewer type nodes, where the inflow is limited by a surface opening like a sewer grate. (Inherited from EngineNode.)
	NodeMaxInflowReservoir	Node max inflow reservoir (Inherited from EngineNode.)
	OpenBoundarySubType	Sub type of open boundary. (Inherited from EngineNode.)
	OpenBoundaryType	Type of open boundary. Check if node is an open boundary using InternalNode before accessing this property. (Inherited from EngineNode.)
	OpenSourceBoundary	Get the IOpenSourceBoundary for the node. Null when node is an internal node (not an open boundary node) (Inherited from EngineNode.)
	PressureReachNodeType	This nodes relation to pressurized sections of the network (Inherited from EngineNode.)
	PressureReachTailCrestLevel	Minimum water level in the outflow from pressurized sections, and hence also minimum water level in the pressurized section Only applicable when PressureReachNodeType is Tail. (Inherited from EngineNode.)
	ShadowNode	Returns true if the node is a shadow node, i.e. only representing a node from another domain (MPI) (Inherited from EngineNode.)
	XCoordinate	X coordinate of node (Inherited from EngineNode.)
	YCoordinate	Y coordinate of node (Inherited from EngineNode.)

Top

Methods

	Name	Description
	AssignBoundary	Assign a water level boundary to this node. Only one open boundary type can be assigned to each node (Inherited from EngineNode.)
	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.)
	GetFlowArea	Calculate the flow area (area perpendicular to flow direction) for a given water level (Overrides EngineNodeVolumeGetFlowArea(Double).)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetStorageArea	Return the surface area for a given water level (Overrides EngineNodeGetStorageArea(Double).)
	GetStorageWidth	Calculate the storage width for a given water level. Calculated as the diameter of a circle with the same surface area as the basin at the give water level. (Overrides EngineNodeVolumeGetStorageWidth(Double).)
	GetSurfaceArea	Return the surface area for a given water level (Overrides EngineNodeGetSurfaceArea(Double).)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetVolume(Double)	Calculate volume in node for given water level (Overrides EngineNodeVolumeGetVolume(Double).)
	GetVolume(Double, Boolean)	Calculate volume in node for given water level
	IDEquals	Checks whether the otherId matches this nodes ID. (Inherited from EngineNode.)
	Initialize	(Overrides EngineNodeInitialize(IDiagnostics).)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Prepare	Called in prepare step (Inherited from EngineNode.)
	SetHeadloss	Obsolete. Set head loss calculator, for user defined head loss calculations (Inherited from EngineNode.)
	ToString	Returns a String that represents the current Object. (Inherited from EngineNode.)
	UpdateBottomLevelOfStructureReaches	Update bottom level of all structure reaches connected to the node to the same bottom level as the node. (Inherited from EngineNode.)

Top

Fields

	Name	Description
	_bottomLevel	Bottom level (Inherited from EngineNode.)
	_cover	Cover on this node (Inherited from EngineNodeVolume.)
	_criticalLevel	Used in result presentation. Passed directly to the result file. (Inherited from EngineNodeVolume.)
	_delh	The Delh controls the height of the bottom slot (Inherited from EngineNodeVolume.)
	_groundLevel	Ground level (Inherited from EngineNode.)
	_id	Node ID string. (Inherited from EngineNode.)
	_openBoundaryType	Type of open boundary. Check if node is an open boundary using InternalNode before accessing this property. (Inherited from EngineNode.)
	NodeListIndex	Index of this node in the list of nodes. Optimization for fast lookup in the lists (instead of using find). (Inherited from EngineNode.)
	Reaches	List of engineReaches connected to this node. (Inherited from EngineNode.)

Top

Extension Methods

	Name	Description
	IsAutoCreated	If node is automatically created. This happens when reach start/end connections are based on locations. (Defined by EngineExtensions.)
	IsPressureNode	Returns true if the engine node is in a pressurized section (Defined by EngineExtensions.)
	IsSpillingNode	If node is spilling node, i.e. is a volume node, and has a cover that supports spilling (Defined by EngineExtensions.)
	IsStructureOutlet	Returns true if the engine node is a structure outlet (Defined by EngineExtensions.)

Top

Reference

DHI.Mike1D.Engine Namespace