IOverFlowGate 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.
Namespace: DHI.Mike1D.StructureModule
Assembly: DHI.Mike1D.StructureModule (in DHI.Mike1D.StructureModule.dll) Version: 19.0.0.0 (11.1.1.1111)
SyntaxThe IOverFlowGate type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | ActualGateLevel |
Actual gate level.
Type: River Structure Geometry
Unit: [m]
Default: 0
(Inherited from IGate.)this is not a setup parameter, but a run parameter, which will change during the run (if the gate is controlled). If the gate is not controlled, this can be used to change the gate (manual/user defined control). |
| 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.) |
| 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.) |
| HeadLossFreeOverflowNegativeFlow |
Free overflow factor for negative flow.
(Inherited from IHeadLossStructure.) |
| HeadLossFreeOverflowPositiveFlow |
Free overflow factor for positive flow.
(Inherited from IHeadLossStructure.) |
| HeadLossInflowNegativeFlow |
Inflow head loss factor for negative flow.
(Inherited from IHeadLossStructure.) |
| HeadLossInflowPositiveFlow |
Inflow head loss factor for positive flow.
(Inherited from IHeadLossStructure.) |
| HeadLossOutflowNegativeFlow |
Outflow head loss factor for negative flow.
(Inherited from IHeadLossStructure.) |
| HeadLossOutflowPositiveFlow |
Outflow head loss factor for positive flow.
(Inherited from IHeadLossStructure.) |
| HorizontalOffSetFromMarker2 |
Horizontal offset of the structures compared to its limiting cross sections.
(Inherited from IPlotableStructure.) |
| 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.) |
| InitialGateLevel |
Gate level.
Type: River Structure Geometry
Unit: [m]
Default: 0
(Inherited from IGate.) |
| 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.) |
| Length | Obsolete.
Length of the structure.
Unit: [m]
(Inherited from IStructure.) |
| Location |
Location of structure.
(Inherited from IStructure.) |
| MaxSpeed |
The maximum allowed rate of change of the gate level.
Type: River Structure Geometry / Time
Unit: [m]
Default: 0.001
(Inherited from IGate.) |
| MaxValue |
Maximum gate level. The gate can not be raised above this level.
Type: River Structure Geometry
Unit: [m]
Default: 0
(Inherited from IGate.) |
| Multiplicator |
Multiplicator or "number of structures" of this type.
Used for modelling more structures at the same
location with the same geometry in one go.
Unit: []
Default: 1
(Inherited from IGate.) |
| 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.) |
| SillLevel |
Level of the sill of the gate.
Type: River Structure Geometry
Unit: [m]
Default: 0
(Inherited from IGate.) |
| StructureIterationCentering |
Used when making relaxation when iterating to find the subcritical solution for structures solved using the energy equation.
When it equals 1 no relaxation is made.
(Inherited from IHeadLossStructure.) |
| StructureType |
Type of structure
(Inherited from IStructure.) |
| 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.) |
| UseMaxValue |
Flag telling if the maximum gate level specified in _maxValue should be used
Type: boolean
Unit: [m]
Default: false
(Inherited from IGate.) |
| Valve |
Type of valve giving the direction of flow that is possible.
(Inherited from IValvedStructure.) |
| Width |
Width of the weir opening. Width is perpendicular to the flow direction, i.e. "across the river"
(Inherited from IGate.) |
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.) |
| 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 IControllable.) |
| GetCurrentValue |
Get the current value of the control for the specified id.
(Inherited from IControllable.) |
| 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.) |
| 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 IControllable.) |
| SetControlStrategyId |
Set control strategy id manually
(Inherited from IControllable.) |
| 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