IFloodMapCrossSection Interface

Interface for a cross section, with the data required for creating CrossLineData and flood maps.

If Points are defined, and the cross section is open (IsOpen), then also the LeftLeveeBank andRightLeveeBank must be defined. The LowestPoint indicate the center of the river, and need not be the lowest point, though it usually is. If not defined, the mid-point in the main river is used.

If cross section is closed (IsOpen is false), or the Points are not defined, the MaxWidth is used as geometric extension.

Definition

Namespace: DHI.Mike1D.FloodMap
Assembly: DHI.Mike1D.FloodMap (in DHI.Mike1D.FloodMap.dll) Version: 24.0.0.0 (11.1.1.1111)
C#
public interface IFloodMapCrossSection

Properties

BottomLevel 
Coordinates List for the points defining the cross section. If null, cross section is assumed to be perpendicular to the river.
IsOpen Flag specifying if cross section is an open cross section.
LeftLeveeBank The left levee bank (marker 1) - index into Points. Must be set for open cross section with Points
LeftLowFlowBank The left low flow bank (marker 4) - index into Points, negative if undefined
Location Location of the current cross section. The Z-coordinate is the bottom level of the cross section (unless defined by the raw data (the open cross sections)).
LowestPoint Lowest point in the channel (marker 2) - index into Points. Must be set for open cross section with Points
MaxWidth Maximum width of cross section. For open cross section it is the width at the top of the cross section
Points List of the points defining the geometry of the cross section. Null if geometry is not explicitly defined (defined by processed data only)
RightLeveeBank The right levee bank (marker 3) - index into Points. Must be set for open cross section with Points
RightLowFlowBank The right low flow bank (marker 5) - index into Points, negative if undefined

Methods

GetArea Return the cross sectional geometric area at the given water level.
GetFlowDistributionConveyance Calculates the conveyance K for local flow distribution calculations, working together with the GetLocalFlowDistributionDepthFactor(Double).

The approach is separated in two methods, since this method can be an expensive method (integrating over the entire cross section), to be called once, and the result used many times by the GetLocalFlowDistributionDepthFactor(Double) method.

If not supported, return -1.

GetLocalFlowDistributionDepthFactor Calculates a local flow distribution factor for a given x along the cross sectional profile. The result must be divided by GetFlowDistributionConveyance(Double).

The calculation is based on a parallel canal analysis, and if integrated up, matches the total discharge through the cross section.

If not supported, return 0.

Extension Methods

GetBottomlevel Calculates the local bottom level for the coordinate, by interpolation.

In case more than one cross section line segment contains x, the first is returned.


(Defined by FloodMapExtensions)
GetCrossSectionX Returns the cross-sectional x coordinate at the relative coordinate v of the cross section

Zero is center of river, negative values are left of center, positive values are right of center.


(Defined by FloodMapExtensions)
GetResistance Calculates the local resistance for the coordinate. If resistance does not vary over the cross section, 1 is returned.

In case more than one cross section line segment contains x, the first is returned.


(Defined by FloodMapExtensions)
LeftLeveeBank LeftLeveeBank in cs as an INetworkCrossSectionPoint
(Defined by FloodMapExtensions)
LeftLowFlowBank LeftLowFlowBank in cs as an INetworkCrossSectionPoint
(Defined by FloodMapExtensions)
LowestPoint Lowest point in cs as an INetworkCrossSectionPoint
(Defined by FloodMapExtensions)
RightLeveeBank RightLeveeBank in cs as an INetworkCrossSectionPoint
(Defined by FloodMapExtensions)
RightLowFlowBank RightLowFlowBank in cs as an INetworkCrossSectionPoint
(Defined by FloodMapExtensions)

See Also