Click or drag to resize

EngineNode Class

A general node without volume (river node).
Inheritance Hierarchy

Namespace:  DHI.Mike1D.Engine
Assembly:  DHI.Mike1D.Engine (in DHI.Mike1D.Engine.dll) Version: 19.0.0.0 (11.1.1.1111)
Syntax
public class EngineNode : INetworkNode

The EngineNode type exposes the following members.

Constructors
Properties
  NameDescription
Public propertyBottomLevel
Bottom level

For a junction node (node without volume (in a river setup)), this is set to the smallest bottomlevel of the surrounding reaches.

Public propertyExternalCoupledArea
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.

Public propertyGroundLevel
Ground level

For a junction node (node without volume (in a river setup)), this is not set, having value of MaxValue.

Public propertyHasVolume
Boolean specifying whether the enginenode has a volume.

Must be overwritten for enginenodes with a volume

Public propertyHeadLossCalculator
Head loss calculator
Public propertyID
Node ID string. (Not associated with the reach ID's)
Public propertyInfiltrationCalculator
Infiltration calculator
Public propertyInternalNode
Returns true if the node is internal, i.e., not a boundary node.
Public propertyLocation 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.
Public propertyMaxInflowFromSurface
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.

Public propertyNodeMaxInflowReservoir
Node max inflow reservoir
Public propertyOpenBoundarySubType
Sub type of open boundary.
Public propertyOpenBoundaryType
Type of open boundary. Check if node is an open boundary using InternalNode before accessing this property.
Public propertyOpenSourceBoundary
Get the IOpenSourceBoundary for the node. Null when node is an internal node (not an open boundary node)
Public propertyPressureReachNodeType
This nodes relation to pressurized sections of the network
Public propertyPressureReachTailCrestLevel
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.

Public propertyShadowNode
Returns true if the node is a shadow node, i.e. only representing a node from another domain (MPI)
Public propertyXCoordinate
X coordinate of node
Public propertyYCoordinate
Y coordinate of node
Top
Methods
  NameDescription
Public methodAssignBoundary
Assign a water level boundary to this node. Only one open boundary type can be assigned to each node
Public methodStatic memberCalculateInfiltrationFluxSuppression
Slot-like functionality, scaling positive infiltrationFlux below delh such that infiltrationFlux becomes zero at _engineNode.BottomLevel. Negative infiltration (water entering node) is left unchanged.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetStorageArea
Return the storage area for a given water level Compared to surface area, storage area takes porosity into account
Public methodGetSurfaceArea
Return the surface area for a given water level
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIDEquals
Checks whether the otherId matches this nodes ID.
Public methodInitialize
Called in Initialize step
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodPrepare
Called in prepare step
Public methodSetHeadloss Obsolete.
Set head loss calculator, for user defined head loss calculations
Public methodToString
Returns a String that represents the current Object.
(Overrides ObjectToString.)
Public methodUpdateBottomLevelOfStructureReaches
Update bottom level of all structure reaches connected to the node to the same bottom level as the node.
Top
Fields
  NameDescription
Protected field_bottomLevel
Bottom level
Protected field_groundLevel
Ground level
Protected field_id
Node ID string.
Protected field_openBoundaryType
Type of open boundary. Check if node is an open boundary using InternalNode before accessing this property.
Public fieldNodeListIndex
Index of this node in the list of nodes. Optimization for fast lookup in the lists (instead of using find).
Public fieldReaches
List of engineReaches connected to this node.
Top
Extension Methods
  NameDescription
Public Extension MethodIsAutoCreated
If node is automatically created. This happens when reach start/end connections are based on locations.
(Defined by EngineExtensions.)
Public Extension MethodIsPressureNode
Returns true if the engine node is in a pressurized section
(Defined by EngineExtensions.)
Public Extension MethodIsSpillingNode
If node is spilling node, i.e. is a volume node, and has a cover that supports spilling
(Defined by EngineExtensions.)
Public Extension MethodIsStructureOutlet
Returns true if the engine node is a structure outlet
(Defined by EngineExtensions.)
Top
See Also