IOverFlowFormula Interface |
Sluice gate interface
Namespace: DHI.Mike1D.StructureModule
Assembly: DHI.Mike1D.StructureModule (in DHI.Mike1D.StructureModule.dll) Version: 19.0.0.0 (11.1.1.1111)
SyntaxThe IOverFlowFormula type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | CrestLevel |
The level of the weir crest.
Type: River Structure Geometry
Unit: [m]
Default: 0
|
| CrestType |
Crest type
|
| CrestWidth |
The width of the weir.
Type: River Structure Geometry
Unit: [m]
Default: 0
|
| DataSetID |
ID of the table where the Q-h relation is located.
|
| 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.) |
| 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.) |
| FlowFactor |
The discharge (and discharge derivatives) are scaled by the flow factor.
(Inherited from IStructure.) |
| 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.) |
| Kc |
Coeffcient used to determine overall flow coefficient when weir coefficient is not used.
Type: Undefined
Unit: []
Default: Undefined
|
| Length | Obsolete.
Length of the structure.
Unit: [m]
(Inherited from IStructure.) |
| Location |
Location of structure.
(Inherited from IStructure.) |
| MaxCrestLevel |
Maximum crest level
Used only when the OverFlowFormula is controlled |
| MaxCrestLevelDecreaseSpeed |
Maximum crest level decrease speed
Used only when the OverFlowFormula is controlled |
| MaxCrestLevelIncreaseSpeed |
Maximum crest level increase speed
Used only when the OverFlowFormula is controlled |
| MethodNumber |
Calculation method: 1 for a Q-h table and 2 for weir formula
Default: 2
|
| MinCrestLevel |
Minimum crest level
Used only when the OverFlowFormula is controlled |
| Outlet |
Flag specifying whether the downstream end is out of the system
(outlet boundary). If true, flow out of the system is always free
outflow (critical flow conditions)
|
| 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.) |
| StructureType |
Type of structure
(Inherited from IStructure.) |
| TopoID |
TopoID used when structure is searching for neighboring cross sections in the reach.
(Inherited from IStructure.) |
| TransitionCoefficient |
Coefficient used to make a continuos transistion between
submerged and not submerged flow at the weir. It expands an interval around the crest level
In which the flow is both critical and subcritical
Unit: [meter]
Default: 0.0.
|
| 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.) |
| UseWeirCoeff |
Flag telling if the weir coefficient should be used or the
coefficient should be based on the angle of the weir.
|
| Valve |
Type of valve giving the direction of flow that is possible.
(Inherited from IValvedStructure.) |
| WeirCoefficient |
Flow coeffcient for the weir. If left undefined the flow coeeficient is
calculated based on information on the WeirFlowAngle
Type: Dimensional factor
Unit: []
Default: 0.66
|
| WeirFlowAngle |
The angle of the weir to the flow direction of the branch
Type: Angels
Unit: [degrees]
Default: 0
|
Methods| Name | Description | |
|---|---|---|
 | Accepts |
List of data types that is accepted, i.e., that you can get a ValueSetter for.
(Inherited from IQuantityProxy.) |
| 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.) |
| 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