EngineRoutingReach Class

A reach that calculates the flow based on some routing scheme instead of a dynamic scheme.

A routing reach contains a number of Elements which defines routing method, and optionally how to calculate water levels. It also contains a number of RoutingGridPoint in the GridPoints list. There may be more grid points than routing elements.

Inheritance Hierarchy

SystemObject
DHI.Mike1D.EngineEngineReach
DHI.Mike1D.EngineEngineRoutingReach

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 EngineRoutingReach : EngineReach

Public Class EngineRoutingReach
	Inherits EngineReach

public ref class EngineRoutingReach : public EngineReach

The EngineRoutingReach type exposes the following members.

Constructors

	Name	Description
	EngineRoutingReach	Initializes a new instance of the EngineRoutingReach class

Top

Properties

	Name	Description
	DigiPoints	(Inherited from EngineReach.)
	Elements	Elements
	EndNode	End node (Inherited from EngineReach.)
	GridPoints	List of gridpoints within reach, in order from start to end of reach. (Inherited from EngineReach.)
	HasStructures	True if reach contains structures. (Inherited from EngineReach.)
	IndexListH	Indices of H grid points in reach (Inherited from EngineReach.)
	IndexListQ	Indices of Q grid points in reach (Inherited from EngineReach.)
	IsPressureReach	A pressure reach is a reach that is always under pressure. Pressure reaches have zero slope. Sections of the network can consist of pressure reaches. Downstream of these sections there are pumps, and upstream there are special tail nodes that function as a weir at the boundary to the normal reaches. (Inherited from EngineReach.)
	IsRegulatedReach	Regulate reach with a discharge structure on first q-grid point. This is used for MU setups to limit Q to a QMax(H) and QMax(dH). QMax is set by a control in the control module (Inherited from EngineReach.)
	IsStructureReach	A structure reach is an h-q-h reach where the q point is a structure point. A structure reach does not contain any volume, and the h points have no cross sections. (Inherited from EngineReach.)
	LocationSpan	Location span that covers this reach. (Inherited from EngineReach.)
	MaximumDx	The maximal allowed distance between two points of the same type? (Inherited from EngineReach.)
	NonReturn	Restrict flow in the first q-grid point to be positive only. Default is false (Inherited from EngineReach.)
	ReverseDirection	Reverse the positive flow direction of the reach. Default is false (Inherited from EngineReach.)
	StartNode	Start node (Inherited from EngineReach.)
	TopoID	Id for the cross section topologi that is to be used for the reach If no TopoID is used, set to empty string (null will be handled as the empty string). (Inherited from EngineReach.)

Top

Methods

	Name	Description
	CreateNewReach	Create new routing reach (Overrides EngineReachCreateNewReach.)
	DivideAt	Divide reach at location, cut away the piece of the reach that is after location and returns the cut away piece as a new reach. node is used for connecting the two. (Overrides EngineReachDivideAt(ILocation, EngineNode, IDiagnostics).)
	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.)
	GetClosestDownstreamGridPoint(Double, PredicateGridPoint, Boolean)	Find the specified type of gridpoint which is closest to the given location upstream. It is assumed that the EngineReach max and min chainages are containing the given chainage, otherwise null is returned. (Inherited from EngineReach.)
	GetClosestDownstreamGridPointT(ILocation)	Obsolete. Find the specified type of gridpoint which is closest to the given location downstream. It is assumed that the EngineReach max and mean chainages are containing the given location (same location ID and overlapping chainage). (Inherited from EngineReach.)
	GetClosestGridPointT	Find the specified type of gridpoint which is closest to the given location. It is assumed that the EngineReach max and mean chainages are containing the given location (same location ID and overlapping chainage). (Inherited from EngineReach.)
	GetClosestUpstreamGridPoint(Double, PredicateGridPoint, Boolean)	Find the specified type of gridpoint which is closest to the given location upstream. It is assumed that the EngineReach max and min chainages are containing the given chainage, otherwise null is returned. (Inherited from EngineReach.)
	GetClosestUpstreamGridPointT(ILocation)	Obsolete. Find the specified type of gridpoint which is closest to the given location upstream. It is assumed that the EngineReach max and mean chainages are containing the given location (same location ID and overlapping chainage). (Inherited from EngineReach.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetHPointToHPointLocationSpans	Returns the location span from HGridPoint[0] to HGridPoint[1], HGridPoint[1] to HGridPoint[2] and so on. They are returned as ZLocationSpan to provide linear interpolation in Z between the two h-points (Inherited from EngineReach.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Prepare	Called as a part of the prepare step. Calls on to each gridpoint in the reach. (Inherited from EngineReach.)
	ToString	Returns a String that represents the current Object. (Inherited from EngineReach.)

Top

Fields

	Name	Description
	ReachListIndex	Index of this reach in the list of reaches. Optimization for fast lookup in the lists (instead of using find). (Inherited from EngineReach.)

Top

Extension Methods

	Name	Description
	Digipoints	Overloaded. Get the digipoints of the reach (Defined by EngineExtensions.)
	Digipoints(Int32)	Overloaded. Get the ith digipoint of the reach (Defined by EngineExtensions.)
	DirectionUnitVector	Calculates the direction vector of the reach at the given gridpoint, as the average from the last to the next gridpoint. (Defined by EngineExtensions.)
	GridPointSpanChainageEnd	End-chainage of the span of the grid point in the index. (Defined by EngineFindExtensions.)
	GridPointSpanChainageStart	Start-chainage of the span of the grid point in the index. (Defined by EngineFindExtensions.)
	IsHdReach	Returns true if the engine reach is a HD reach (Defined by EngineExtensions.)
	IsRoutingReach	Returns true if the engine reach is a routing reach (Defined by EngineExtensions.)

Top

Remarks

An EngineRoutingReach deliberately extends from an EngineReach, since the type of reach can not be changed during the simulation.

Reference

DHI.Mike1D.Engine Namespace