UrbanRiverLink Class

An Urban-River links connects two 1D models, typically an urban and a river model, but it can also connect two river models or two urban models.

On the one side the link is connected to an outlet. On the other side the link is connected to a source point. The link provides the outlet with a water level boundary value from the "source" side. The outlet provides a discharge back to the source as inflow.

In river context, an outlet is an open water level boundary.

The "internal" side of the link is the outlet side. The "external" side is the source point.

On the urban side, the link is connected to an outlet, manhole or structure.

On the river side, the link is connected to any connection to the reach.

Inheritance Hierarchy

SystemObject
  DHI.Mike1D.Engine.CouplingsLinkBase
    DHI.Mike1D.Engine.CouplingsStandardLink
      DHI.Mike1D.Engine.CouplingsUrbanRiverLink

Namespace: DHI.Mike1D.Engine.Couplings
Assembly: DHI.Mike1D.Engine (in DHI.Mike1D.Engine.dll) Version: 19.0.0.0 (11.1.1.1111)

Syntax

C++

Copy

public class UrbanRiverLink : StandardLink

Public Class UrbanRiverLink
	Inherits StandardLink

public ref class UrbanRiverLink : public StandardLink

The UrbanRiverLink type exposes the following members.

Constructors

	Name	Description
	UrbanRiverLink	Initializes a new instance of the UrbanRiverLink class

Top

Properties

	Name	Description
	AllowBackflow	Flag indicating if backflow is allowed, i.e. flow from source into outlet. Flag is true by default, but historically disabled for urban-weir outlet and urban-pump outlet.
	DischargeBoundaryType	Type of discharge transfer applied for standard links. Default is Coupled (Inherited from StandardLink.)
	ExternalGroundLevel	External (surface) ground level/bottom level Unit: [m] Default: (Inherited from StandardLink.)
	ExternalWaterLevel	External (surface) water level Unit: [m] Default: (Inherited from StandardLink.)
	IsAdLink	Bool indicating if this will transfer AD (Inherited from LinkBase.)
	IsSideStructure	(Inherited from StandardLink.)
	LinkLocation	Original location of link, or null if link is based on a node or structure id. Used for error reporting only (Inherited from StandardLink.)
	SmoothingFactor	Smoothing factor for exponential smoothing. (Inherited from LinkBase.)
	SourceBottomLevel
	SourceGridPoint
	SourceNode
	SourceReach
	WaterLevelBoundaryType	Type of water level boundary applied for standard links. Default is Coupled (Inherited from StandardLink.)

Top

Methods

	Name	Description
	AdjustWaterLevelBoundaryValue	Adjust water level boundary value. When external water depth is small, a similar small depth is applied to MIKE 1D, handling differences in external and 1D bottom levels. (Inherited from StandardLink.)
	ApplyExponentialSmoothing	Apply smoothing on the water level value. Smoothing must be applied after calling AdjustWaterLevelBoundaryValue. (Inherited from StandardLink.)
	ApplyWaterLevelBoundary
	AssignExternalConcentrationsToOutletBoundary	Assign external concentrations to outlet boundary. (Inherited from StandardLink.)
	AssignExternalWaterLevelToOutletBoundary	Assign water level to outlet boundary. (Inherited from StandardLink.)
	CheckLinkBottomLevels	Check bottom levels of outlet and surface, and produce a warning if there is a mismatch. (Inherited from StandardLink.)
	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.)
	GetDischarge	Discharge out of link into external model, positive into external model. (Inherited from StandardLink.)
	GetExternalConcentration	Set boundary concentration for component at index compj, i.e. concentration on the outside of the network. (Inherited from StandardLink.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetInternalConcentration	Outflow concentration, concentration in MIKE 1D. (Inherited from StandardLink.)
	GetLinkNode	Get outlet/link node (Inherited from StandardLink.)
	GetM1DGroundLevel	Internal ground level (Inherited from StandardLink.)
	GetOutflowDirectionAngle	Get compass heading in degrees of outlet outflow direction. (Inherited from StandardLink.)
	GetSourcePointConcentration
	GetSourcePointWaterLevel	Get raw water level from source point
	GetSourceWaterLevel	Get water level from source point, and adjust for bottom levels from each side of the link. Water level is stored for later use
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetWaterLevel	Water level on the internal side of the link (Inherited from StandardLink.)
	GetWaterLevelBoundaryValue	Get value of the water level that was applied to the outlet boundary (Inherited from StandardLink.)
	Initialize	Initialize standard link (Inherited from StandardLink.)
	InitializeComponents
	InitializeDischargeGetters	(Inherited from StandardLink.)
	InitializeOutletBoundary	(Inherited from StandardLink.)
	InitializeSourceWaterLevelGetter(EngineNet, EngineNode)
	InitializeSourceWaterLevelGetter(EngineNet, EngineReach, HGridPoint)
	InitializeWaterLevelGetter	(Inherited from StandardLink.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	PrepareAD	Prepare running with AD. Setting up AD boundaries on outlet. (Inherited from StandardLink.)
	PrepareHD	Prepare link, reassing boundary to network (Inherited from StandardLink.)
	Set1DBottomLevel	(Inherited from StandardLink.)
	Set1DGroundLevel	(Inherited from StandardLink.)
	SetExternalConcentration	Set boundary concentration for component at index compj, i.e. concentration on the outside of the network. (Inherited from StandardLink.)
	SetExternalConcentrations	Set external concentrations for all components (Inherited from StandardLink.)
	SetExternalCoupledArea	Set the external coupled area (Inherited from StandardLink.)
	SetExternalGroundLevel	Set the external ground level (Inherited from StandardLink.)
	SetExternalWaterLevel	Set external water level (Inherited from StandardLink.)
	SetInternalComponentInfo	Id of internal components. Required for setting up the internal boundary condition. (Inherited from StandardLink.)
	SetLinkNode	Set outlet/link node. (Inherited from StandardLink.)
	SetSourcePointComponentSource(IComponentSourcePoint)
	SetSourcePointComponentSource(EngineNet, EngineReach, Int32)
	SetupSourceCoupling
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	TransferState	Prepare for time step, transferring current values to "old" values state (Inherited from StandardLink.)

Top

Fields

	Name	Description
	_constantWaterLevelBoundaryItem	Boundary item for _bnd water level boundary which the water leevl is applied on (Inherited from StandardLink.)
	_constComponentBoundaryItems	(Inherited from StandardLink.)
	_dischargeGetter	Getter for discharge out of the link (Inherited from StandardLink.)
	_externalConcentrations	Inflow/outside concentration (Inherited from LinkBase.)
	_externalGroundLevel	(Inherited from StandardLink.)
	_externalWL	(Inherited from StandardLink.)
	_externalWlOld	(Inherited from StandardLink.)
	_hasExternalWlOld	(Inherited from StandardLink.)
	_internalAdComponentSource	Concentration inside the MIKE 1D model (Inherited from StandardLink.)
	_internalComponentIndex	Index of AD component inside the link
	_m1DBottomLevel	(Inherited from StandardLink.)
	_smoothingFact	Smoothing factor for exponential smoothing. (Inherited from LinkBase.)
	_sourcePointComponents	Component source point for source side
	_sourceToInternalComponentConversion	Conversion factor from source to internal component concentrations
	_waterLevelBoundaryValue	(Inherited from StandardLink.)
	_waterLevelGetter	(Inherited from StandardLink.)
	LinkNode	Node that link is connected to. (Inherited from StandardLink.)
	SourcePoint	Source point for river connection, used when the river model is the point source
	SourcePointUrbanManhole	Source point for urban connection, used when the urban model is the point source

Top

Reference

DHI.Mike1D.Engine.Couplings Namespace