DHI.Mike1D.StructureModule Namespace

Abstract class that holds some of the more general broad crested weir algorithms.

ArchPierBridgeGeometry

Area of Intersection of Polygons Algorithm based on http://cap-lore.com/MathPhys/IP/ This version was translated from the java version at http://www.cap-lore.com/MathPhys/IP/PolygonIntersect.java

BieryDelleurBridge structures, supporting the following type of tables:

• Q = f(Hups, Hdws)

The arguments ([!:BridgeBase.RowHeader]) and ([!:BridgeBase.ColumnHeader]) will always contain water levels, while the output ([!:BridgeBase.Table]) will be discharge values.

BridgeBase structures, supporting the following type of tables:

• Q = f(Hups, Hdws)

The arguments (RowHeader) and (ColumnHeader) will always contain water levels, while the output (Table) will be discharge values.

BridgeGeometry

Overflow

Submergence

Tabulated bridge structure, having only the table of discharges and no geometry.:

• Q = f(Hups, Hdws)

The arguments ([!:BridgeBase.RowHeader]) and ([!:BridgeBase.ColumnHeader]) will always contain water levels, while the output ([!:BridgeBase.Table]) will be discharge values.

The class models a broad crested weir. The flow is either critical flow in which case the downstream condition has no influence on the flow or is submerged flow in which case the flow depends on both the upstream and the downstream water level. The special weir is a special version of the broad crested weir. Conversely to the broad crested weir, the special weir does not offer calculation of the critical flow conditions from the weir geometry. The special weir always has Q/h relations specified by the user. For the special weir, the SpecialWeir. The flow through the structure is governed by the energy loss due to the flow contraction on the upstream side of the weir and by the energy loss due to flow expansion on the downstream side.

Cross section

Composit structure is a structure which contains one or more structures at the same location. Uses the Composite Pattern.

List of composite structures

CrossSectionBridgeGeometry

Models the flow through typically longer pipe between limiting cross sections (up- and down- stream). The pipe my have any cross section geometry and may be either closed or open.

See ICulvert for parameters for setting up a culvert.

The culvert such that critical flow conditions are calculated prior to calculation of the actual flow. The critical flow conditions are typically by activating the CalcCriticalConditions method from a user interface The result of this procedure is stored as part of the culvert specification. See CalculateFreeOverFlowQhRelation for more detail.

Helper class for computing culvert flow conditions, i.e.

• HydraulicParameters
• QhFlowtypeRelationsPositiveFlow
• QhFlowtypeRelationsNegativeFlow

It may also update

• OrificeFlowCoefficientsPositiveFlow
• OrificeFlowCoefficientsNegativeFlow

Common class containing data for all culvert geometry types.

Dambreak class.

Base class for DamBreak and DamBreakNWS

Dambreak class.

Simple constant discharge structure.

EnergyBridge structures, supporting the following type of tables:

• Q = f(Hups, Hdws)

The arguments ([!:BridgeBase.RowHeader]) and ([!:BridgeBase.ColumnHeader]) will always contain water levels, while the output ([!:BridgeBase.Table]) will be discharge values.

Calculation of the flow at energy loss structures.

Describes flow through a weir with and a set of formulas that is an extension of the formulas used for the HonmaWeir.

FHWABridge structures, supporting the following type of tables:

• Q = f(Hups, Hdws)

The arguments ([!:BridgeBase.RowHeader]) and ([!:BridgeBase.ColumnHeader]) will always contain water levels, while the output ([!:BridgeBase.Table]) will be discharge values.

FHWABridgeGeometry

Represents the table of free overflow data for the special weir.

Represents free over flow data for one level.

Abstract gate. The gate is a controllable structure.

The HonmaWeir (Weir formula 2) class describes weir flow modelled with the Honma formula.

HRBridge structures, supporting the following type of tables:

• Q = f(Hups, Hdws)

The arguments ([!:BridgeBase.RowHeader]) and ([!:BridgeBase.ColumnHeader]) will always contain water levels, while the output ([!:BridgeBase.Table]) will be discharge values.

Table of corresponding depths, areas, hydraulic radi and conveyances.

Represents the "Hydraulic Parameters" table of a culvert. The table stores relations between depth at invert, area, radius and conveyance. The table must be kept in sync with the QhFlowtypeRelation table.

One level-width data point. Can also be depth-width.

Table of corresponding levels and widths. Can also be depths and widths.

NaglerBridge structures, supporting the following type of tables:

• Q = f(Hups, Hdws)

The arguments ([!:BridgeBase.RowHeader]) and ([!:BridgeBase.ColumnHeader]) will always contain water levels, while the output ([!:BridgeBase.Table]) will be discharge values.

The Nwk11 bridge is used for reading and writing data from the Mike11 network file.

An orifice is a structure of arbitrary shape.

Table of orifice flow coefficients for culvert specification.

Orifice flow coefficients for one water level. Part of culvert input specification.

Calculation of the flow at energy loss structures.

Description of an overflow gate. An overflow gate is in this context a broad crested weir with a rectangular opening. The over flow gate is a controlable structure. It allows the gate level to be varied.

Pump class.

A pump moves water within the network, with the ability to start and stop a specific water levels

A pump by default control itself based on the start/stop levels. These start/stop levels can be fixed, or they can also be controlled. If the start and stop levels are controlled, the MinStopLevel and MaxStartLevel is enforced and must be set. It is possible to explicitly stop the pump (ControlStop(Int32)), which will then disable the self-control based on the start/stop levels, i.e. the pump will not start automatically again.

The actual discharge of the pump can be one of:

• Constant - When PumpType is ConstantFlow
• H-Q-table - When PumpType is HQTable the discharge Q is determined by the upstream water level H
• Delta-H-Q-table - When PumpType is DeltaHQTable the discharge Q is determined by the head difference Delta-H over the pump, i.e. the difference between upstream and downstream water level
• Controlled - When controlled, the pump discharge is set using ControlSetDischarge(Double, Int32). The PumpType must be either HQTable or DeltaHQTable, and the table HQRelation then specifies the maximum pump discharge. A minimum pump discharge can be specified in HQRelationMinimumCapacity.

Relation between depth, critical and flow type.

Represents a table that ties water depth above culvert inlet at upstream cross section to critical discharge and flow type.

QHStructure class. A simple structure where discharge depends on upstream water level. The discharge is tabulated.

The radial gate divides the flow into an underflow part and an overflow part. When specifying gate levels for a radial gate the user should specify the level for the underflow part, i.e. the level of the bottom of the gate. The gate level for the overflow part is then calculated based on geometric considerations. The under flow gate is a controllable structure. It allows the gate level to be varied.

This class contains information about reservoirs connected to structures. In

Calculation of the flow at operational sluice gates using formulas for four different flow regimes and for overtopping as well.

A square broad-crested weir.

Base implementation for a broadcrested weir with a rectangular opening.

Storm water inlet class.

Base class for all structures. The class is abstract since an instance of it wouldn't make sense

Data access model for the structure module.

Factory class for reading and writing structure data to storage

Bridge for reading and writing structure data to xml file

Class with extension methods for structures

Class which contains parameters used during initilization of structures

List of structures.

Tabulated structures, supporting 3 different types of tables:

• Q = f(Hups, Hdws)
• Hups = f(Hdws, Q)
• Hdws = f(Hups, Q)

The first argument (RowHeader) will always contain water levels, while the second argument (ColumnHeader can be either water level or discharge values, and opposite for the output (Table), depending on the CalculationMode.

Description of an underflow gate. An underflow gate is in this context a broad crested weir with a rectangular opening that may be limited upward by the gate. In case the gate is not submerged the gate will act a broad crested weir. The under flow gate is a controlable structure. It allows the gate level to be varied.

USBPRBridge structures, supporting the following type of tables:

• Q = f(Hups, Hdws)

The arguments ([!:BridgeBase.RowHeader]) and ([!:BridgeBase.ColumnHeader]) will always contain water levels, while the output ([!:BridgeBase.Table]) will be discharge values.

Calculation of the flow through a valve

Structure with valve regulation. The valve overrules the otherwise calculated flow.

The VillemonteWeir (Weir formula 1) class describes weir flow modelled with the Villemonte formula.

Bridge structures, supporting 3 different types of tables:

• Q = f(Hups, Hdws)
• Hups = f(Hdws, Q)
• Hdws = f(Hups, Q)

The first argument ([!:RowHeader]) will always contain water levels, while the second argument ([!:ColumnHeader] can be either water level or discharge values, and opposite for the output ([!:Table]), depending on the [!:CalculationMode].

Struct for conversion of units for constants between Nwk11 structure bridge and Sim11 bridge.

Struct for recording errors between Nwk11 structure bridge and Sim11 bridge.

Bridge structure interface

Interface for the special weir. Gives access to the Weir geometry data (Datum and LevelWidth) and to the cross section data for up- and down- stream cross sections.

Specification of the weir geometry

Collection of structures at the same location. Interface used by the engines.

Models the flow through typically longer pipe between limiting cross sections (up- and down- stream). The pipe my have any cross section geometry and may be either closed or open. The culvert such that critical flow conditions are calculated prior to calculation of the actual flow. The critical flow conditions are typically by activating the CalcCriticalConditions method from a user interface The result of this procedure is stored as part of the culvert specification.

Common data interface for culvert sections

Describes a circular culvert section.

Class handling a culvert geometry from cross section database.

Common interface containing data for all culvert geometry types.

Describes a rectangular culvert section.

A table section is either in level-width or depth-width format, decided by the CulvertSectionGeometries value.

Dambreak base parameters.

Parameters for erosion based dam break.

Dambreak data for the NWS dam break class.

Simple constant discharge structure, that may be controlled

Energy loss structure interface

Describes flow through a weir with and a set of formulas that is an extension of the formulas used for the HonmaWeir.

Represents the table of free overflow data for the special weir.

Represents free over flow data for one level.

Common interface for gate structures

Interface implemented by structures that have head loss factors as part of their input.

The HonmaWeir (Weir formula 2) class describes weir flow modelled with the Honma formula.

Table of corresponding depths, areas, hydraulic radi and conveyances.

Represents the "Hydraulic Parameters" table of a culvert. The table stores relations between depth at invert, area, radius and conveyance. The table must be kept in sync with the QhFlowtypeRelation table.

Maximum number of iterations in a structure to obtain convergence of the discharge. Default value = 100

Defines data for single level in a Level/Width table. Level/Width tables are used both for structure geometry and for cross section specifications for structures.

Table of corresponding levels and widths. Can also be depths and widths.

Interface that must be implemented by all structures that uses the Linear zero variation approach. The interface allows setting of Delhs at the collection level.

Interface that must be implemented by all structures that use a minimum headloss. The interface allows setting of the minimum headloss at the collection level.

The Nwk11 bridge is used for reading and writing data from the Mike11 network file.

An orifice is a structure of arbitrary shape, that can include a gate of arbitrary shape.

Table of orifice flow coefficients for culvert specification.

Orifice flow coefficients for one water level. Part of culvert input specification.

Sluice gate interface

Description of an overflow gate. An overflow gate is in this context a broad crested weir with a rectangular opening.

The over flow gate is a controlable structure. It allows the gate level to be varied.

A group of the structures supports structure plotting. Data associated with the plotting only are defined by this interface.

Pump parameters.

A pump moves water within the network, with the ability to start and stop at specific water levels

Relation between depth, critical and flow type.

Represents a table that ties water depth above culvert inlet at upstream cross section to critical discharge and flow type.

QHStructure. A simple structure where discharge depends on upstream water level. The discharge is tabulated.

Description of an overflow gate. An overflow gate is in this context a broad crested weir with a rectangular opening. The over flow gate is a controlable structure. It allows the gate level to be varied.

Optional interface for an IStructure to implement, making it capable of being used as a side structure

A side structure is not put into the reach, but added on side of the reach.

A side structure with reservoir is handled in the engine by adding an additional side structure reach, with a reservoir node (basin) in the other end.

Sluice gate interface

Interface that must be implemented if the structure solves the energy equation and if the structures are to be part of a parallel structure.

Storm water inlet data interface.

Base interface for all structures.

Additional interface for structures that requires boundary data

Data access model for the structure module.

Additional interface for structures that requires knowledge of other structures

Additional interface for structures that requires cross section data

This is only in case cross section data is required for structure geometry. The default Initialize(ICrossSection, ICrossSection, Boolean, IDiagnostics) provides upstream and downstream cross sections, and should not be extracted using this method.

Base interface for all structures.

List of structures.

This interface is explicitly defined for supporting COM interop

Tabulated structure interface

A structure that needs to know time.

This is usually required by controllable structures, in order to i.e. close gate, moving the gate with a specified speed.

Sluice gate interface

Structure with valve regulation. The valve overrules the otherwise calculated flow.

The VillemonteWeir (Weir formula 1) class describes weir flow modelled with the Villemonte formula.

Enumeration describing Bridge Table smoothing filer, 0 - no filter, 1-3 different filters, -1 Max filter

Enumeration indicating the bridge table type.

Enumeration indicating the bridge type.

Ways to solve the energy equations in the culvert

Enumeration for clasification of culvert flow types.

Enumeration indicating what flow regime the solution is in.

Method of how the dam break evolves

Method of how to trigger dam break failure

Enumeration describing Loss factor Ratio Dis Coef Type, 0 - Contraction m = (1-M), 1 - Opening m = M

Solver methods for the energyloss structure.

Enumeration indicating the bridge entrance type.

Method of how to trigger dam break failure

Method of how to trigger dam break failure

FHWABridgeGeometry

FlowDir type. Used for readability of the code.

Enumeration indicating what flow regime the solution is in.

Overflow weir crest types

Enumeration indicating the bridge overflow type.

State of the pump

Type of pump

Position of the side structure, on the left or right bank

Enumeration indicating the bridge spur type.

Type of structure

Enumeration indicating the bridge UseSubmergence type.

Valve type.