Click or drag to resize

EngineNodeOutlet Class

An Outlet is a volume free node where water flows out of the system.

An outlet is the only type of open boundary that does not need a boundary condition

An outlet can have a boundary condition (water level/QH), in which case the water can also flow into the system.

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 EngineNodeOutlet : EngineNode

The EngineNodeOutlet type exposes the following members.

Constructors
  NameDescription
Public methodEngineNodeOutlet
Create an EngineNodeOutlet
Top
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.

(Inherited from EngineNode.)
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.

(Inherited from EngineNode.)
Public propertyGroundLevel
Ground level

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

(Inherited from EngineNode.)
Public propertyHasVolume
Boolean specifying whether the enginenode has a volume.

Must be overwritten for enginenodes with a volume

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

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

(Inherited from EngineNode.)
Public propertyShadowNode
Returns true if the node is a shadow node, i.e. only representing a node from another domain (MPI)
(Inherited from EngineNode.)
Public propertyStructureOutlet
Flag indicating if this is a structure outlet.
Public propertyXCoordinate
X coordinate of node
(Inherited from EngineNode.)
Public propertyYCoordinate
Y coordinate of node
(Inherited from EngineNode.)
Top
Methods
  NameDescription
Public methodAssignBoundary
Assign a water level boundary to this node. Only one open boundary type can be assigned to each node
(Inherited from EngineNode.)
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
(Inherited from EngineNode.)
Public methodGetSurfaceArea
Return the surface area for a given water level
(Inherited from EngineNode.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIDEquals
Checks whether the otherId matches this nodes ID.
(Inherited from EngineNode.)
Public methodInitialize
Called in Initialize step
(Inherited from EngineNode.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodPrepare
Called in prepare step
(Inherited from EngineNode.)
Public methodSetHeadloss Obsolete.
Set head loss calculator, for user defined head loss calculations
(Inherited from EngineNode.)
Public methodToString
Returns a String that represents the current Object.
(Inherited from EngineNode.)
Public methodUpdateBottomLevelOfStructureReaches
Update bottom level of all structure reaches connected to the node to the same bottom level as the node.
(Inherited from EngineNode.)
Top
Fields
  NameDescription
Protected field_bottomLevel
Bottom level
(Inherited from EngineNode.)
Protected field_groundLevel
Ground level
(Inherited from EngineNode.)
Protected field_id
Node ID string.
(Inherited from EngineNode.)
Protected field_openBoundaryType
Type of open boundary. Check if node is an open boundary using InternalNode before accessing this property.
(Inherited from EngineNode.)
Public fieldNodeListIndex
Index of this node in the list of nodes. Optimization for fast lookup in the lists (instead of using find).
(Inherited from EngineNode.)
Public fieldReaches
List of engineReaches connected to this node.
(Inherited from EngineNode.)
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