EngineNodeStructure Class

Constructor

Bottom level

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

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.

Ground level

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

Boolean specifying whether the enginenode has a volume.

Must be overwritten for enginenodes with a volume

Head loss calculator

Node ID string. (Not associated with the reach ID's)

Infiltration calculator

Returns true if the node is internal, i.e., not a boundary node.

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.

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.

Node max inflow reservoir

Sub type of open boundary.

Type of open boundary. Check if node is an open boundary using InternalNode before accessing this property.

Get the IOpenSourceBoundary for the node. Null when node is an internal node (not an open boundary node)

ID of outlet structure

This nodes relation to pressurized sections of the network

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.

Returns true if the node is a shadow node, i.e. only representing a node from another domain (MPI)

Node structure

X coordinate of node

Y coordinate of node

Assign a water level boundary to this node. Only one open boundary type can be assigned to each node

Determines whether the specified object is equal to the current object.

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.

Serves as the default hash function.

Return the storage area for a given water level Compared to surface area, storage area takes porosity into account

Return the surface area for a given water level

Gets the Type of the current instance.

Checks whether the otherId matches this nodes ID.

Called in Initialize step

Creates a shallow copy of the current Object.

Called in prepare step

Set head loss calculator, for user defined head loss calculations

Returns a String that represents the current Object.

Update bottom level of all structure reaches connected to the node to the same bottom level as the node.

Bottom level

Ground level

Node ID string.

Type of open boundary. Check if node is an open boundary using InternalNode before accessing this property.

Index of this node in the list of nodes. Optimization for fast lookup in the lists (instead of using find).

List of engineReaches connected to this node.

If node is automatically created. This happens when reach start/end connections are based on locations.

Returns true if the engine node is in a pressurized section

If node is spilling node, i.e. is a volume node, and has a cover that supports spilling

Returns true if the engine node is a structure outlet