EngineNode Class

A general node without volume (river node).

Definition

Namespace: DHI.Mike1D.Engine
Assembly: DHI.Mike1D.Engine (in DHI.Mike1D.Engine.dll) Version: 24.0.0.0 (11.1.1.1111)
C#
public class EngineNode : INetworkNode
Inheritance
Object    EngineNode
Derived
Implements
INetworkNode

Constructors

Properties

AutoGenerated Flag specifying that the node was autogenerated.
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.

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.

GroundLevel Ground level

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

HasVolume Boolean specifying whether the enginenode has a volume.

Must be overwritten for enginenodes with a volume

HeadLossCalculator Head loss calculator
ID Node ID string. (Not associated with the reach ID's)
InfiltrationCalculator Infiltration calculator
InternalNode Returns true if the node is internal, i.e., not a boundary node.
Location 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.
Obsolete
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.

NodeMaxInflowReservoir Node max inflow reservoir
OpenBoundarySubType Sub type of open boundary.
OpenBoundaryType Type of open boundary. Check if node is an open boundary using InternalNode before accessing this property.
OpenSourceBoundary Get the IOpenSourceBoundary for the node. Null when node is an internal node (not an open boundary node)
PressureReachNodeType This nodes relation to pressurized sections of the network
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.

ShadowNode Returns true if the node is a shadow node, i.e. only representing a node from another domain (MPI)
XCoordinate X coordinate of node
YCoordinate Y coordinate of node

Methods

AssignBoundary Assign a water level boundary to this node. Only one open boundary type can be assigned to each node
CalculateInfiltrationFluxSuppression Slot-like functionality, scaling positive infiltrationFlux below delh such that infiltrationFlux becomes zero at _engineNode.BottomLevel. Negative infiltration (water entering node) is left unchanged.
EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetStorageArea Return the storage area for a given water level Compared to surface area, storage area takes porosity into account
GetSurfaceArea Return the surface area for a given water level
GetTypeGets the Type of the current instance.
(Inherited from Object)
IDEquals Checks whether the otherId matches this nodes ID.
Initialize Called in Initialize step
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Prepare Called in prepare step
SetHeadloss Set head loss calculator, for user defined head loss calculations
Obsolete
ToString Returns a String that represents the current Object.
(Overrides ObjectToString)
UpdateBottomLevelOfStructureReaches Update bottom level of all structure reaches connected to the node to the same bottom level as the node.

Fields

_bottomLevel Bottom level
_groundLevel Ground level
_id Node ID string.
_openBoundaryType Type of open boundary. Check if node is an open boundary using InternalNode before accessing this property.
NodeListIndex Index of this node in the list of nodes. Optimization for fast lookup in the lists (instead of using find).
Reaches List of engineReaches connected to this node.

Extension Methods

GetWettedAreaBox Calculates the wetted area for the node assuming it is either a box or a cylinger shape.
(Defined by EngineExtensions)
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)

See Also