Click or drag to resize

SourceLink Class

A Source can connect to an outlet or to a manhole.

When connected to an outlet, it works as a standard link

When connected to a manhole, water is exchanged through the top of the manhole, using a weir-type calculation.

Inheritance Hierarchy

Namespace:  DHI.Mike1D.Engine.Couplings
Assembly:  DHI.Mike1D.Engine (in DHI.Mike1D.Engine.dll) Version: 19.0.0.0 (11.1.1.1111)
Syntax
public class SourceLink : StandardLink

The SourceLink type exposes the following members.

Constructors
  NameDescription
Public methodSourceLink
Initializes a new instance of the SourceLink class
Top
Properties
  NameDescription
Public propertyAllowBackflow
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.

Public propertyDischargeBoundaryType
Type of discharge transfer applied for standard links. Default is Coupled
(Inherited from StandardLink.)
Public propertyExternalGroundLevel
External (surface) ground level/bottom level Unit: [m] Default:
(Inherited from StandardLink.)
Public propertyExternalVolume
Public propertyExternalWaterLevel
External (surface) water level Unit: [m] Default:
(Inherited from StandardLink.)
Public propertyIsAdLink
Bool indicating if this will transfer AD
(Inherited from LinkBase.)
Public propertyIsSideStructure (Inherited from StandardLink.)
Public propertyLinkLocation
Original location of link, or null if link is based on a node or structure id. Used for error reporting only
(Inherited from StandardLink.)
Public propertySmoothingFactor
Smoothing factor for exponential smoothing.
(Inherited from LinkBase.)
Public propertyWaterLevelBoundaryType
Type of water level boundary applied for standard links. Default is Coupled
(Inherited from StandardLink.)
Top
Methods
  NameDescription
Public methodAdjustWaterLevelBoundaryValue
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.)
Public methodApplyCouplingForcing
This function is called by the perform time step routine, and it implements the interaction (water flows) coming from M21
Public methodApplyExponentialSmoothing
Apply smoothing on the water level value.

Smoothing must be applied after calling AdjustWaterLevelBoundaryValue.

(Inherited from StandardLink.)
Public methodAssignExternalConcentrationsToOutletBoundary
Assign external concentrations to outlet boundary.
(Inherited from StandardLink.)
Public methodAssignExternalWaterLevelToOutletBoundary
Assign water level to outlet boundary.
(Inherited from StandardLink.)
Public methodCheckGroundLevels
Check that ground levels match. This is valid for inlet links
Public methodCheckLinkBottomLevels
Check bottom levels of outlet and surface, and produce a warning if there is a mismatch.
(Inherited from StandardLink.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodEvaluateRunoffDischarge
Discharge from runoff out of link and into external model.
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 methodGetComponentMassInReservoir
Public methodGetDischarge
Discharge out of link into external model, positive into external model.
(Overrides StandardLinkGetDischarge.)
Public methodGetExternalConcentration
Set boundary concentration for component at index compj, i.e. concentration on the outside of the network.
(Inherited from StandardLink.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetInternalConcentration
Outflow concentration, concentration in MIKE 1D.
(Inherited from StandardLink.)
Public methodGetLinkNode
Get outlet/link node
(Inherited from StandardLink.)
Public methodGetM1DGroundLevel
Internal ground level
(Inherited from StandardLink.)
Public methodGetManholeConcentrations
Public methodGetOutflowDirectionAngle
Get compass heading in degrees of outlet outflow direction.
(Inherited from StandardLink.)
Public methodGetRunOffDischarge
Discharge from runoff out of link and into external model.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetWaterLevel
Water level on the internal side of the link
(Inherited from StandardLink.)
Public methodGetWaterLevelBoundaryValue
Get value of the water level that was applied to the outlet boundary
(Inherited from StandardLink.)
Public methodInitialize
Initialize standard link
(Inherited from StandardLink.)
Protected methodInitializeDischargeGetters (Inherited from StandardLink.)
Public methodInitializeInlet
Initialize inlet link
Protected methodInitializeOutletBoundary (Inherited from StandardLink.)
Public methodInitializeStandardLink
Initialize standard link
Public methodInitializeWaterLevelGetter (Inherited from StandardLink.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodPrepareAD
Prepare running with AD. Setting up AD boundaries on outlet.
(Inherited from StandardLink.)
Public methodPrepareADInlet
Prepare running with AD. Setting up AD boundaries on inlet.
Public methodPrepareForTimeStep
Prepare for next time step. Calculates discharge through link
Public methodPrepareHD
Prepare link, reassing boundary to network
(Inherited from StandardLink.)
Public methodQInflowFromCoupling
M21 to inlet calculates the exchange discharge and introduces it in the appropriate man hole. Exponential smoothing is used for the water level transferred from MIKE 21. Further an upper limit is placed on the discharge in the form of the Qmax which is a user parameter. These parameters along with a number of others parameters are read by M1D but not passed back to M21 e.g. crest width, discharge coefficient etc. Note that the discharge passed to Mouse consists of two contributions namely RR and the overland flow. The sum of these two are confined by the Qmax. If the sum of contributions is greater than Qmax then the limitation is applied to overland flow first and then to the RR contribution. If the latter is also restricted by Qmax then the excess is transferred into the MIKE 21 model i.e. the manhole is surcharged and the flow may spill into MIKE 21 against a possible water level difference.
Protected methodSet1DBottomLevel (Inherited from StandardLink.)
Protected methodSet1DGroundLevel (Inherited from StandardLink.)
Public methodSetDt
Public methodSetExternalConcentration
Set boundary concentration for component at index compj, i.e. concentration on the outside of the network.
(Inherited from StandardLink.)
Public methodSetExternalConcentrations
Set external concentrations for all components
(Inherited from StandardLink.)
Public methodSetExternalCoupledArea
Set the external coupled area
(Inherited from StandardLink.)
Public methodSetExternalGroundLevel
Set the external ground level
(Inherited from StandardLink.)
Public methodSetExternalVolume
Public methodSetExternalWaterLevel
Set external water level
(Inherited from StandardLink.)
Public methodSetInternalComponentInfo
Id of internal components.

Required for setting up the internal boundary condition.

(Inherited from StandardLink.)
Public methodSetLinkNode
Set outlet/link node.
(Inherited from StandardLink.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodTransferState
Prepare for time step, transferring current values to "old" values state
(Inherited from StandardLink.)
Top
Fields
  NameDescription
Protected field_constantWaterLevelBoundaryItem
Boundary item for _bnd water level boundary which the water leevl is applied on
(Inherited from StandardLink.)
Protected field_constComponentBoundaryItems (Inherited from StandardLink.)
Protected field_couplingQ
Protected field_deltaH
Protected field_dischargeGetter
Getter for discharge out of the link
(Inherited from StandardLink.)
Protected field_dqdh
Protected field_externalConcentrations
Inflow/outside concentration
(Inherited from LinkBase.)
Protected field_externalGroundLevel (Inherited from StandardLink.)
Protected field_externalWL (Inherited from StandardLink.)
Protected field_externalWlOld (Inherited from StandardLink.)
Protected field_hasExternalWlOld (Inherited from StandardLink.)
Protected field_internalAdComponentSource
Concentration inside the MIKE 1D model
(Inherited from StandardLink.)
Protected field_m1DBottomLevel (Inherited from StandardLink.)
Protected field_smoothingFact
Smoothing factor for exponential smoothing.
(Inherited from LinkBase.)
Protected field_waterLevelBoundaryValue (Inherited from StandardLink.)
Protected field_waterLevelGetter (Inherited from StandardLink.)
Protected fieldLinkNode
Node that link is connected to.
(Inherited from StandardLink.)
Public fieldManHolesInflowSource
Inflow source, when SourceLinkType is UrbanInlet.
Public fieldSourceLinkType
Type of source link
Public fieldUrbanInletParameters
Parameters for UrbanInlet.
Top
See Also