LateralLink Class |
A lateral link computes the exchange through a set of link-Faces.
Inheritance HierarchyNamespace: DHI.Mike1D.Engine.Couplings
Assembly: DHI.Mike1D.Engine (in DHI.Mike1D.Engine.dll) Version: 19.0.0.0 (11.1.1.1111)
SyntaxThe LateralLink type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | LateralLink |
Default constructor
|
| LateralLink(LocationSpan) |
Default constructor
|
Properties| Name | Description | |
|---|---|---|
 | CurrentTime | Current time of simulation |
| IsAdLink | Bool indicating if this will transfer AD (Inherited from LinkBase.) |
| LinkSpan | Span that this lateral link covers |
| NumberOfFaces | Number of faces in link |
| SmoothingFactor |
Smoothing factor for exponential smoothing.
(Inherited from LinkBase.) |
| StartTime | Start time of simulation |
Methods| Name | Description | |
|---|---|---|
| AddCouplingCrestLevels | |
| AddRiverCrestLevelValues | |
| AddSurfaceCrestLevels | |
| ApplyADCouplingForcing |
This function is called by the perform time step routine,
It evaluates the discharges of each face (lateral link structure)
to calculate the actual discharges, and use those to
add component contributions (AD) to MIKE 1D
(after HD timestep, but before AD time step)
|
| ApplyCouplingForcing |
This function is called by the perform time step routine,
and adds the discharge of each face (lateral link structure) to
MIKE 1D as an implicit source contribution
|
| ApplyExponentialSmoothing |
Apply exponential smoothing on the water level inputs
|
| CalculateFaceDischarges |
Calculate face discharges
|
| 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.) |
| GetDischarges |
Get discharge for all faces
|
| GetFacesOutflowConcentrations |
Get outflow concentration for each face for specified component
|
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GetWeirCrestLevel | |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| PrepareAD |
Prepare link for AD.
|
| PrepareForTimeStep |
Prepare for time step. Also read external levee file data.
|
| PrepareHD |
Prepare link for HD, creating faces and structures
|
| SetCurrentTime | Set Current time |
| SetDt |
Set current simulation time step
|
| SetFacesCoordinates |
Set face coordinates, (x, y, chainage) for start and end of each face
|
| SetLinkDryingDepth |
Set drying depth of link
|
| SetNumberOfFaces |
Set number of faces that the lateral link is connected to
|
| SetStartTime |
Set start time of simulation.
|
| SetSurfaceConcentrationOnFaces |
Set external concentrations on each face for the specified component
|
| SetSurfaceVolumes |
Set surface volumes to all faces
|
| SetSurfaceWaterLevel |
Set surface water level and depth to all faces and propagate to all weirs
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| UpdateCrestLevels | Update crest levels for all lateral link structures |
| WriteLatlinkConnectionData |
Fields| Name | Description | |
|---|---|---|
 | _externalConcentrations | Inflow/outside concentration (Inherited from LinkBase.) |
| _smoothingFact | Smoothing factor for exponential smoothing. (Inherited from LinkBase.) |
 | CrestSource | Source of crest level for the structures |
| Faces | Faces in the lateral link |
| LateralLinkReaches | Reaches that this lateral link overlaps |
| LatLinkLevee | |
| SideOfRiver |
Side of river that the lateral links is appled to.
Side of river is when walking in positive chainage direction. |
| StructureDelh |
Delh parameter for structures in the faces of the lateral link. Only applies to some structures.
|
| StructureType | Type of structure in faces |
| WeirCoefficient | Weir coefficient for the VillemonteWeir and HonmaWeir. |
See Also