Click or drag to resize

Reach Class

Base class for Link and Branch
Inheritance Hierarchy

Namespace:  DHI.Mike1D.NetworkDataAccess
Assembly:  DHI.Mike1D.NetworkDataAccess (in DHI.Mike1D.NetworkDataAccess.dll) Version: 19.0.0.0 (11.1.1.1111)
Syntax
public class Reach : IReach, INetworkReach

The Reach type exposes the following members.

Constructors
  NameDescription
Public methodReach
Initializes a new instance of the Reach class
Top
Properties
  NameDescription
Public property__TopoID
For backwards compatibility after fixing spelling error.
Public propertyDescription
User's descriptive information related to the link
Public propertyEndConnection
Specifies where the reach is connected at its end point (high chainage). Must be null if not connected.
Public propertyIsPressureReach
True if the reach should always be pressurized (MU special reach with slope=0 and "weir" at transition to normal reach.)
Public propertyIsRegulatedReach
Regulate reach with a discharge structure on first q-grid point. This is used for MU setups to limit Q to a QMax(H) og QMax(dH). QMax is set by a control in the control module
Public propertyLocationSpan
A Reach is a generalization of the link and branch concepts from sewer and river models.

Specification of connection as 'start' and 'end' does not have any impact on the computations, apart that positive flow is considered from start to end. Therefore, it is recommended to specify the start-end in the direction of predominant flows, or to set the ReverseDirection flag.

The type of the reach is specified by the cross section for that reach. It may take the form of one of the 'standard' pipes (Circular, Rectangular, O Shaped, Egg-Shaped), or any closed or open cross section shape (CRS/Natural Channels).

The LocationSpan defines the geographical position of the reach.

Typical types of reaches are the sewer link and the river branch.

A sewer link is featured by:

  • Connected in each end by specifying a node.
  • Constant cross-section geometry, and constant friction properties along the entire length.
  • It is specified as a conduit between two nodes. A link is considered as either a straight line or a drawn polyline between two nodes.
  • Usually a link connects to the adjacent nodes at their bottom levels, but it may also connect above their bottom level. This is called the invert level. The start- and the end- invert level must be specified in the first and last coordinates of the LocationSpan. Specified levels below bottom level of the connecting nodes is not valid.
  • A link is often characterised by material, which determines the Manning friction coefficient (Manning) or the Colebrook White coefficient (Equivalent roughness). The material is is as such not represented, though the friction formulation is specified in the cross section module.

A river branch is featured by:

  • Connected to other reaches by specifying a location. Nodes usually are not specified explicitly in the setup, but created on the fly when required (at all junctions).
  • Varying cross-section geometry, and varying friction properties along reach.
  • At connection points, river branches usually define cross section bottom levels that equals. However, if "free outflow" properties from a tributary branch is desired, this can be achieved by specifying a higher cross section bottom level in the tributary connection end (at least 0.5 cm difference).

Public propertyMaximumDx
The maximal allowed distance between two points of the same type?
Public propertyNonReturnReach
Restrict flow in the first q-grid point to be positive only. Default is false
Public propertyReverseDirection
Reverse the positive flow direction of the reach. Default is false
Public propertyStartConnection
Specifies where the reach is connected at its start point (low chainage). Must be null if not connected.
Public propertyTopoID
Id for the cross section topologi that is to be used for the Link / Branch. If TopoID is not used, set to empty string (null will be handled as the empty string).
Top
Methods
  NameDescription
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 methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
For debug purposes
(Overrides ObjectToString.)
Public methodValidate
Validate reach
Top
Fields
  NameDescription
Protected field_endConnection
End connection
Protected field_locationSpan
Span of reach
Protected field_startConnection
Start connection
Top
Extension Methods
  NameDescription
Public Extension MethodIsStructureReach
Returns true when reach is an IStructureReach
(Defined by NetworkExtensions.)
Top
See Also