DHI.Mike1D.FloodMap Namespace

Library for calculating extent of river in projection coordiantes. A river is defined by a center line and cross sections, and this library can calculate river bank lines from the center line and the cross sections.

Classes

CrossLineCreator Class for creating CrossLineData along reaches of a network.

Along the river reaches a number of CrossLineData is created, defining the coordinates for the river cross lines / cross sections.

CrossLineData A cross line is a line perpendicular to the river and the flow direction.

For a location on the river, it contains coordinates for the CenterCoor and the left and right river bank, and also left and right low-flow bank, if present.

Cross lines at locations where cross sections exist follows the coordinates of the cross section.

CrossLineWriter Class for writing cross lines to file
FloodMapCalculator a FloodMapCalculator calculates one or more outputs within a flood map area.

The ItemCalculators does the calculation of the individual items, while this contains common data for a flood map area.

FloodMapCrossSectionAdapter Class for wrapping an ICrossSection into an IFloodMapCrossSection
FloodMapCrossSectionAdapterHub A IFloodMapCrossSectionAdapterHub for cross sections in a INetworkReach object coming from either the engine or a ResultData object. It is assuming the CrossSection is effectively an ICrossSection implementation or IRes1DOpenCrossSection implementation.
FloodMapCrossSectionClosed Class for a closed cross section, for which flood maps cannot be created.
FloodMapCrossSectionDataAdapterHub A IFloodMapCrossSectionAdapterHub for cross sections in a CrossSectionData object
FloodMapDemData Class to encapsulate the access data for the DEM input files
FloodMapDfs2File Class that handles one DFS2 file with flood map information
FloodMapExtensions Extension class containing a number of helper function.
FloodMapFlowDistributionCalculator Class for calculating flow velocity / current speed at any point in the river flood map.
FloodMapGrid Class that handles a grid with flood map information
FloodMapGridSpecification Specification of a grid
FloodMapHSpan A FloodMapHSpan is a span between two H points. It can be shared by many MapBox's, in case digipoints are present in between or close to the two H points.

It also contains pointers to upstream/downstream nearest H points with a non-interpolated open cross section.

FloodMapHSpanData Data for a HSpan required by the calculator
FloodMapHSpanPoint A point inside the river h span, between two H points. It contains HSpan, and (u,v) relative H-span mapping box coordinates, an ij linear index and bottom level at center of cell.
FloodMapItemCalculatorFlowDistFac Item calculator outputting the flow distribution factor
FloodMapItemCalculatorHPoints An item calculator that interpolates values between H points.

Can be used for component concentrations and the likes.

FloodMapItemCalculatorHPQ An item calculator that produces H-P-Q output.
FloodMapItemCalculatorVelocity Item calculator to calculate current speed / flow velocity.

It can also be used for other types of Discharge-to-velocity outputs, like AD Transport to AD flux. This is achieved by setting the DataQuantity to the engine quantity to load and/or setting the OutputQuantity to the "velocity" quantity matching the DataQuantity.

If used for mapping dynamic velocity: Keep default options

If used for mapping dynamic AD component flux: Set the DataQuantity to the AD component transport quantity.

If used for mapping maximum velocity: The water level and discharge is stored on H points at the time of maximum velocity. Set both: WaterLevelQuantity and DataQuantity (discharge quantity), and QonH must be set to true.

FloodMapItemCalculatorWaterDepth Calculates water depths within flood map area
FloodMapItemCalculatorWaterLevel Calculates water levels within flood map area
FloodMapItemCalculatorWlDepthMinMax An item calculator that interpolates values between H points.

Can be used for component concentrations and the likes.

FloodMapMain Class to run flood map tools from command line
FloodMapRes1DCrossSectionAdapter Class for wrapping an IRes1DOpenCrossSection into an IFloodMapCrossSection
MapBox A MapBox is a box between two cross section lines. The box is split up into a number of quadrilaterals, with at least one left and one right of the river center line. The two inner most quads share the river centre line as the baseline, while more outer-laying quads share base line with the more inner quad top line.

In cases where the cross section lines intersects, the quads either becomes a triangle, or degenerates and must be discarded.

MapBoxQuad A MapBoxQuad is a quadrilateral containing mapping between an (x,y) coordinate within the quad to the local quadrilateral coordinate system (u,v).

To handle cases where the mapping box contains bank lines, the relative v coordinate can vary in the upstream and the downstream end.

ResultDataMapper Helper class for creating map files from Result Data objects
RiverMapper Class that sets up the mapping between (x,y) points (coordinates) and the river coordinate system, and sets up interpolation of values in the river coordinate system.

It sets up a number of FloodMapHSpan in NetworkHSpans, and a number of MapBoxes in MapBoxSearch.

Structures

Interfaces

IFloodMapCrossSection 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.

IFloodMapCrossSectionAdapterHub Class for getting IFloodMapCrossSection from a generic INetworkHGridPoint
IFloodMapItemCalculator Interface for special item calculators

Enumerations

CrossLineLocations Enum indicating where to produce cross lines, and eventually also map boxes.
CrossLineType Type of cross line.
CrossLineWriterOutputFormats Types of text output formats supported
CrossLineWriterOutputLineTypes Type of output lines
DirectionVectorTypes Types specifying how to calculate a direction unit
FloodMapDfs2FileFileTypes Type of DFS2 file
MapBoxPointPrecedence If two or more map-boxes overlap at a given point, which should take precedence