BridgeBase Class |
Namespace: DHI.Mike1D.StructureModule
The BridgeBase type exposes the following members.
Name | Description | |
---|---|---|
BridgeBase |
Constructor method for the BridgeBase structure
| |
BridgeBase(String) |
Constructor method for the BridgeBase structure
| |
BridgeBase(BridgeType) |
Constructor method for the BridgeBase structure
|
Name | Description | |
---|---|---|
Alpha | ||
BackRat |
Back water ratio table
| |
BaseCoef | ||
Beta | ||
Bottomlevel | ||
BridgeGeometry |
BridgeGeometry
| |
BridgeOverflow |
Overflow
| |
BridgeSubmergence |
Submergence
| |
BridgeTableFilePath |
Holds the filename and path of the bridge table file
(Inherited from BridgeTabulated.) | |
ColumnHeader |
Holds the header for the columns, the upstream water levels.
Type : Water level
Unit: [meter]
Default: 0.0
(Inherited from BridgeTabulated.) | |
ConvTubeNumber |
Number of tubes for conveyance tube analyses.
| |
CulvertID | ||
dDischargedDownStreamWaterLevel |
Calculated Discharge derivative with DownStreamWaterLevel. Downstream is relative to the direction of chainage.
The value is calculated by SetWaterLevels.
Unit: [m^2/s]
(Inherited from Structure.) | |
dDischargedUpStreamWaterLevel |
Calculated Discharge derivative with UpStreamWaterLevel. Upstream is relative to the direction of chainage.
The value is calculated by SetWaterLevels.
Unit: [m^2/s]
(Inherited from Structure.) | |
Delhs |
Linear flow variation.
For water level differences less than delhs use a linear Q variation
between h1-h2=delhs and h1-h2=0. This is to avoid stability problems
for small water level differences where dQdh goes to infinity.
Unit: [m]
Default: 0.01
(Inherited from BridgeTabulated.) | |
Discharge |
Calculated Discharge. The value is calculated by SetWaterLevels.
Unit: [m^3/s]
(Inherited from Structure.) | |
DisCoefType | ||
DownstreamWaterLevel |
Downstream water level.Downstream refers to the direction of chainage. The water level is set by use of
SetWaterLevels
Unit: [m]
(Inherited from Structure.) | |
Dykes1 | ||
Dykes2 | ||
Eccentricity | ||
EnchroachmentRegenerate |
Boolean telling if Enchroachment regenerate
| |
Entrance | ||
ExtensionData |
Property used by (de)serializer, when it can not find proper target for
a data field. Support of forward compatible data contracts.
(Inherited from Structure.) | |
FlowArea |
Flow area through structure. Used by most (but not all) structures.
(Inherited from Structure.) | |
FlowFactor |
The discharge (and discharge derivatives) are scaled by the flow factor.
(Inherited from Structure.) | |
Froude | ||
GridSizeDownStream |
Slotsize of table downstream
| |
GridSizeUpStream |
Slotsize of table upstream
| |
ID |
Structure ID
(Inherited from Structure.) | |
IDInUserUnit |
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 Structure.) | |
Implicit |
Flag to control if the structure is implicit or explicit. If the structure is explicit
(Implicit == false) then the derivatives of the dicharge are always zero.
Default value: true
(Inherited from Structure.) | |
invert | ||
InvertLevelDownstream | (Overrides BridgeTabulatedInvertLevelDownstream.) | |
InvertLevelUpstream | (Overrides BridgeTabulatedInvertLevelUpstream.) | |
IsAsymmetric |
Boolean telling whether to use IsAsymmetric
| |
IsMultiWayOpen |
Boolean telling whether to use IsMultiWayOpen
| |
Length |
Length of the structure.
Unit: [m]
Default value: 0m
(Inherited from Structure.) | |
Location |
Location property.
(Inherited from Structure.) | |
MaximumWaterDepthAboveXSFactor | ||
Method |
Enum BridgeType defining the Bridge method used
| |
NumberOfCols |
Number of columns in the table
(Inherited from BridgeTabulated.) | |
NumberOfRows |
Number of rows in the table
(Inherited from BridgeTabulated.) | |
Piers | ||
Road1 | ||
Road2 | ||
RowHeader |
Holds the header for the rows, the downstream water levels.
Type : Water level
Unit: [meter]
Default: 0.0
(Inherited from BridgeTabulated.) | |
RunTimeDiagnostics |
The getter is used to get a list of errors.
(Inherited from Structure.) | |
SideStructureBank |
Bank side that side-structure is located on
(Inherited from Structure.)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 Structure.) | |
Skew | ||
SmoothBridgeSurface | ||
SmoothBridgeSurfaceIterations | ||
StructureType |
Type of structure
(Inherited from Structure.) | |
SubFac | ||
Submerged | ||
Table |
Holds the discharge table
Type : Discharge
Unit: [m3/s]
(Inherited from BridgeTabulated.) | |
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
(Inherited from BridgeTabulated.) | |
Theta | ||
Toplevel | ||
TopoID |
String used to identified cross sections
(Inherited from Structure.) | |
Type |
Structure type, unique for each type structure.
(Inherited from BridgeTabulated.) | |
UpstreamWaterLevel |
Upstream water level. Upstream refers to the direction of chainage. The water level is set by use of
SetWaterLevels
Unit: [m]
(Inherited from Structure.) | |
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 |
Online or offline bridge equations.
(calculate on the fly or read from table)
Default: true
| |
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
(Inherited from BridgeTabulated.) | |
WeirID |
Name | Description | |
---|---|---|
Accepts |
List of data types that is accepted, i.e., that you can get a ValueSetter for.
(Inherited from Structure.) | |
AllocateTable |
Allocate table of certain sizes
(Overrides BridgeTabulatedAllocateTable(Int32, Int32).) | |
ApplyFlowFactor |
Applies flow factor to discharge and it's derivatives
(Inherited from Structure.) | |
CalcBridgeTable | ||
CheckBridgeCombinations |
Check bridge combinations
| |
ControlSetFlowFactor |
Set flow factor to specified value
(Inherited from Structure.) | |
Description |
Return a string that describes this structure. Includes structure type and ID
(Inherited from Structure.) | |
DetermineBridgeFlow | ||
Dispose |
Frees the licenses held.
(Inherited from Structure.) | |
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
ExplicitStructureSupport |
DEBUG: This method is called from Validate() if _implitcit == false to check if
the structure supports being Explicit.
Once all structures support explicit operation this method can be deleted.
(Inherited from Structure.) | |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | |
GenerateBridgeTable | ||
GetControlAction |
Get control action for the specified id. It always returns one of
the ActionControl delegates. It will return null if
controlActionId is not valid.
(Inherited from Structure.)Base implementation for IControllable | |
GetCurrentValue |
Get the current value of the control for the specified id.
(Inherited from Structure.)Base implementation for IControllable | |
GetHashCode | Serves as the default hash function. (Inherited from Object.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
Initialize(IDiagnostics) |
Set up structure and set runtime diagnostics object
(Inherited from Structure.) | |
Initialize(ICrossSection, ICrossSection, Boolean, IDiagnostics) | (Overrides StructureInitialize(ICrossSection, ICrossSection, Boolean, IDiagnostics).) | |
LookUp2DTable | ||
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
Offers |
A list of quantities available from this structure
(Inherited from Structure.) | |
Prepare(HDParameterData, IDiagnostics) | (Overrides StructurePrepare(HDParameterData, IDiagnostics).) | |
Prepare(DateTime, HDParameterData, IDiagnostics) |
Set up structure and set runtime diagnostics object
(Inherited from Structure.) | |
ReadBridgeTable |
Read bridge table from file
(Inherited from BridgeTabulated.) | |
ReadBridgeTableASCII |
Read bridge table from file
(Inherited from BridgeTabulated.) | |
ReadBridgeTableDFS2 |
Read bridge table from file
(Inherited from BridgeTabulated.) | |
ResetControlledState |
Reset internal state (if any) used by controlling class.
Called after a controlling class has performed a control sequence,
and simulation is restarted.
(Inherited from Structure.)Base implementation for IControllable | |
SetControlStrategyId |
Set control strategy ID manually.
(Inherited from Structure.)Base implementation for IControllable | |
SetInputWaterLevels | (Inherited from Structure.) | |
SetInvertLevel |
Set up invert level
| |
Setup | ||
SetWaterLevels |
Sets up- and down- stream water level and forces the calculation of the discharge and its derivatives.
(Inherited from BridgeTabulated.) | |
SetZeroFlow |
Sets the conditions for zero flow
(Inherited from Structure.) | |
ToString | Returns a string that represents the current object. (Inherited from Object.) | |
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 Structure.) | |
Validate |
Validation of data for a BridgeBase structure.
(Overrides StructureValidate.) | |
ValueGetter |
Get value setter for the specified data quantity
(Overrides StructureValueGetter(Int32).) | |
ValueSetter |
Get value setter for the specified data type
(Inherited from Structure.) |
Name | Description | |
---|---|---|
_accepts |
List of quantities that are accepted
(Inherited from Structure.) | |
_columnHeader | (Inherited from BridgeTabulated.) | |
_controlStategyId |
If the structure is being controlled, then _controlStategyId contains the ID of the
active control strategy
(Inherited from Structure.) | |
_downstreamWaterLevel |
Downstream water level, as set by SetWaterLevels(Double, Double)
Unit: [m]
(Inherited from Structure.) | |
_dqdhDownstream |
The derivative of flow through the structure with downstream water level. The flow is
calculated in the derived classes when the SetWaterLevels method is called.
Unit: [m2/sec]
(Inherited from Structure.) | |
_dqdhUpstream |
The derivative of flow through the structure with upstream water level. The flow is
calculated in the derived classes when the SetWaterLevels method is called.
Unit: [m2/sec]
(Inherited from Structure.) | |
_flowArea |
Flow area through structure. Used by most (but not all) structures.
(Inherited from Structure.) | |
_flowDir |
FlowDir is used to determine which parameters to use for the flow calculations.
Derived by the SetWaterLevels(Double, Double).
(Inherited from Structure.) | |
_gridSizeDownStream | ||
_gridSizeUpStream | ||
_id |
Identification name of the structure
(Inherited from Structure.) | |
_implicit |
If _implicit == false, then the derivatives are always zero.
Default value: true.
(Inherited from Structure.) | |
_location |
Location in the network
(Inherited from Structure.) | |
_offers |
List of quantities that are offered
(Inherited from Structure.) | |
_q |
Flow through the structure. The flow is calculated in the derived classes when the
SetWaterLevels method is called.
Unit: [m3/sec]
(Inherited from Structure.) | |
_rowHeader | (Inherited from BridgeTabulated.) | |
_runTimeDiagnostics |
Diagnostics are written into this Diagnostics during calculations.
Set during Initialize(IDiagnostics) (Inherited from Structure.) | |
_table | (Inherited from BridgeTabulated.) | |
_topoID |
Identification used to find referenced cross sections
(Inherited from Structure.) | |
_upstreamWaterLevel |
Upstream water level, as set by SetWaterLevels(Double, Double)
Unit: [m]
(Inherited from Structure.) | |
_waterLevelDatum | (Inherited from BridgeTabulated.) |
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. |