IBridgeStructure Interface |
Bridge structure interface
Namespace: DHI.Mike1D.StructureModule
Assembly: DHI.Mike1D.StructureModule (in DHI.Mike1D.StructureModule.dll) Version: 19.0.0.0 (11.1.1.1111)
SyntaxThe IBridgeStructure type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | Alpha |
Alpha tables
|
| BackRat |
Back water ratio table
|
| BaseCoef |
BaseCoefficient tables
|
| Beta |
Beta tables
|
| Bottomlevel |
Bottom level
|
| BridgeGeometry |
BridgeGeometry
|
| BridgeOverflow |
Overflow
|
| BridgeSubmergence |
Submergence
|
| BridgeTableFilePath |
Holds the smoothed table
Type : Water level or discharge depending on the chosen calculation mode
Unit: [m3/s] or [meter]
Default: 0.0
|
| ColumnHeader |
Holds the header for the columns
Type : Water level
Unit: [meter]
Default: 0.0
|
| ConvTubeNumber |
Number of tubes for conveyance tube analyses.
|
| CulvertID |
The culvert used otherwise null
|
| dDischargedDownStreamWaterLevel |
Calculated Discharge derivative with UpStreamWaterLevel. Upstream is relative to the direction of chainage.
Unit: [m^2/s]
(Inherited from IStructure.) |
| dDischargedUpStreamWaterLevel |
Calculated Discharge derivative with DownStreamWaterLevel. Downstream is relative to the direction of chainage.
Unit: [m^2/s]
(Inherited from IStructure.) |
| Delhs |
Level from where the variation is forced to be linear.
(Inherited from ILinearZeroVariation.) |
| Discharge |
Calculated Discharge
Unit: [m^3/s]
(Inherited from IStructure.) |
| DisCoefType |
Loss factor Ratio Dis Coef Type, 0 - Contraction m = (1-M), 1 - Opening m = M
|
| DownstreamWaterLevel |
Downstream water level.Downstream refers to the direction of chainge. The water level is set by use of
SetWaterLevels
Unit: [m]
(Inherited from IStructure.) |
| Dykes1 |
Dykes1 tables
|
| Dykes2 |
Dykes2 tables
|
| Eccentricity |
Eccentricity tables
|
| EnchroachmentRegenerate |
Boolean telling if Enchroachment regenerate
|
| Entrance |
Entrance tables
|
| FlowFactor |
The discharge (and discharge derivatives) are scaled by the flow factor.
(Inherited from IStructure.) |
| Froude |
Froude tables
|
| GridSizeDownStream |
Slotsize of table downstream
|
| GridSizeUpStream |
Slotsize of table upstream
|
| ID |
Name of the structure.
(Inherited from IStructure.) |
| IDInUserUnit | Obsolete.
Used to get a consistent description of the structure. The ID comes in user units. Used e.g. when
reporting errors, warnings and hints.
(Inherited from IStructure.) |
| Implicit |
Flag to control if the structure is implicit or explicit. If the structure is explicit
(Implicit == false) then the derivatives of the discharge are always zero.
Default value: true
(Inherited from IStructure.) |
| InvertLevelDownstream |
Invert level down stream
The invert level is the level where water starts
flowing in to the structure from the downstream side.
It does not necessarily flow through the structure.
(Inherited from IStructure.) |
| InvertLevelUpstream |
Invert level up stream.
The invert level is the level where water starts
flowing in to the structure from the upstream side.
It does not necessarily flow through the structure.
(Inherited from IStructure.) |
| IsAsymmetric |
Boolean telling whether to use IsAsymmetric
|
| IsMultiWayOpen |
Boolean telling whether to use IsMultiWayOpen
|
| Length | Obsolete.
Length of the structure.
Unit: [m]
(Inherited from IStructure.) |
| Location |
Location of structure.
(Inherited from IStructure.) |
| MaximumWaterDepthAboveXSFactor | |
| Method |
Bridge Method - FHWA, USBPR, Energy, HR, Nagler, Yarnell
|
| Piers |
Piers tables
|
| Road1 |
Road1 tables
|
| Road2 |
Road2 tables
|
| RowHeader |
Holds the header for the rows
Type : Water level
Unit: [meter]
Default: 0.0
|
| RunTimeDiagnostics |
The getter is used to get a list of errors. OBSOLETE
(Inherited from IStructure.) |
| SideStructureBank |
Bank side that side-structure is located on
(Inherited from IStructure.)If side structure contains reservoir, and has the Coordinate set, this is not used (and should be set to Undefined). |
| SideStructureReservoir |
Reservoir at end of side structure. Null if not side structure, or no reservoir is defined
(Inherited from IStructure.) |
| Skew |
Skew tables
|
| SmoothBridgeSurface |
Enum describing Bridge Table smoothing filer, 0 - no filter, 1-3 different filters, -1 - Max filter
|
| SmoothBridgeSurfaceIterations |
Number of iterations the smoothing filter is applied
|
| StructureType |
Type of structure
(Inherited from IStructure.) |
| SubFac |
SubFac tables
|
| Submerged |
Submerged tables
|
| Table |
Holds the table
Type : Discharge
Unit: [m3/s]
Default: 0.0
|
| TableIteration |
Variable defining maximum number of iterations for precalculating tables.
|
| TablesGenerated |
Boolean telling if the tables are generated
|
| TableSmooth |
Holds the smoothed table
Type : Water level or discharge depending on the chosen calculation mode
Unit: [m3/s] or [meter]
Default: 0.0
|
| TableType |
Table input filetype
0 - DFS2
1 - ASCII
Default: 0
|
| Theta |
Theta tables
|
| Toplevel |
Top level
|
| TopoID |
TopoID used when structure is searching for neighboring cross sections in the reach.
(Inherited from IStructure.) |
| Type |
Structure type, unique for each type of structure.
(Inherited from IStructure.) |
| UpstreamWaterLevel |
Upstream water level. Upstream refers to the direction of chainage. The water level is set by use of
SetWaterLevels
Unit: [m]
(Inherited from IStructure.) |
| UseAlpha |
The velocity distribution coefficient for bridge calculations is set to unity per default.
The coefficient may be calculated based on conveyance distribution.
Default value: false
|
| UseEccentricity |
Boolean telling whether to use Eccentricity
|
| UseFHWAReachLength |
The reach length for the FHWA method is determined based on an equal
conveyance tube analysis. If the reach length should only be based on
the physical distance from the adjacent cross section to the bridge
the variable 'USE_FHWA_REACH_LENGTH' may be used.
|
| UseOverflow |
Boolean telling whether to use overflow
|
| UsePiers |
Boolean telling whether to use Piers
|
| UsePiersPiles |
Boolean telling wheter to use Piers Piles
|
| UsePreProcessedBridgeTable |
Use preprocessed bridge tables
|
| UseSkewness |
Boolean telling whether to use Skewness
|
| UseSpurDykes |
Boolean telling whether to use SpurDykes
|
| UseSubmergence |
Boolean telling whether to use submergence
|
| WaterLevelDatum |
Datum to be applied to all water levels specified in the table.
Type: water level
Unit: [meter]
Default: 0.0
|
| WeirID |
The weir used otherwise null
|
Methods| Name | Description | |
|---|---|---|
 | Accepts |
List of data types that is accepted, i.e., that you can get a ValueSetter for.
(Inherited from IQuantityProxy.) |
| AllocateTable |
allocates Table, RowHeader and
ColumnHeader with the specified sizes.
Furthermore allocated _tableSmooth for smoothing the Table
|
| CheckBridgeCombinations |
Check bridge combinations
|
| Description |
Description of the structure.
(Inherited from IStructure.) |
| Initialize |
Set up structure and set runtime diagnostics object
(Inherited from IStructure.) |
| Offers |
List of data types that is offered, i.e., that you can get a ValueGetter for.
(Inherited from IQuantityProxy.) |
| Prepare |
Set up structure and set runtime diagnostics object
(Inherited from IStructure.) |
| SetInvertLevel |
Set up invert level
|
| SetWaterLevels |
Sets up- and down- stream water level and forces the calculation of the discharge and its derivatives.
(Inherited from IStructure.) |
| UpdatedWaterLevels |
After a time step (or iteration) has finished, update the discharge to the actual value, based
on the final water levels and the discharge derivatives.
(Inherited from IStructure.) |
| Validate |
Writes errors, warnings and hints into their respective member classes. The member objects are initially cleared.
(Inherited from IStructure.) |
| ValueGetter |
Get value setter for the specified data quantity
(Inherited from IDoubleProxy.) |
| ValueSetter |
Get value setter for the specified data type
(Inherited from IDoubleProxy.) |
Extension Methods| Name | Description | |
|---|---|---|
 | Getter | From the proxy, return an FuncTResult for the specified quantity. It returns the first quantity of that type that is offered, and null if the quantity is not offered. |
| Getters |
Returns a set of FuncTResult for the quantity.
We can return several quantities with the same id (usually they will differ in their description).
If the quantity is not offerent, an empty list is returned.
(Defined by ProxyExtensions.) |
| GettersFraction |
Returns a set of FuncT, TResult for the quantity.
We can return several quantities with the same id (usually they will differ in their description).
If the quantity is not offerent, an empty list is returned.
(Defined by ProxyExtensions.) |
| GetterUnboxed | From the proxy, return an FuncTResult for the specified quantity. It returns the first quantity of that type that is offered, and null if the quantity is not offered. |
| Initialize(CrossSectionData, Boolean, IDiagnostics) | Overloaded.
Helper function for some unit tests. Do not use.
(Defined by StructureExtensions.) |
| Initialize(BoundaryData, CrossSectionData, Boolean, IDiagnostics) | Overloaded.
Helper function for some unit tests. Do not use.
(Defined by StructureExtensions.) |
| IsSideStructure |
Returns true if the structure is a side structure
(Defined by StructureExtensions.) |
| Setter | From the proxy, return an IDoubleGetSet for the specified quantity. It returns the first quantity of that type that is accepted, and null if the quantity is not accepted. |
See Also