UnderFlowGate Class |
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.
Inheritance HierarchySystemObject
DHI.Mike1D.StructureModuleStructure
DHI.Mike1D.StructureModuleValvedStructure
DHI.Mike1D.StructureModuleAbstractBroadCrestedCWeir
DHI.Mike1D.StructureModuleSquareBroadCrestedWeir
DHI.Mike1D.StructureModuleSquaredGatedBCWeir
DHI.Mike1D.StructureModuleUnderFlowGate
DHI.Mike1D.StructureModuleStructure
DHI.Mike1D.StructureModuleValvedStructure
DHI.Mike1D.StructureModuleAbstractBroadCrestedCWeir
DHI.Mike1D.StructureModuleSquareBroadCrestedWeir
DHI.Mike1D.StructureModuleSquaredGatedBCWeir
DHI.Mike1D.StructureModuleUnderFlowGate
Namespace: DHI.Mike1D.StructureModule
Assembly: DHI.Mike1D.StructureModule (in DHI.Mike1D.StructureModule.dll) Version: 19.0.0.0 (11.1.1.1111)
SyntaxThe UnderFlowGate type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | UnderFlowGate |
Constructor. Sets the default values.
|
Properties| Name | Description | |
|---|---|---|
 | ActualGateLevel |
Actual gate level.
Type: River Structure Geometry
Unit: [m]
Default: 0
(Inherited from SquaredGatedBCWeir.)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 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 AbstractBroadCrestedCWeir.) |
| Discharge |
Calculated Discharge. The value is calculated by SetWaterLevels.
Unit: [m^3/s]
(Inherited from Structure.) |
| DownstreamCrossSection |
Downstream cross section data. The cros section data is the processed level, with, area.
Set up during initialize, from cross section database.
(Inherited from AbstractBroadCrestedCWeir.) |
| 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.) |
| 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 in the structure. Uses WaterLevelInStructure which is updated when
SetWaterLevels() is called.
(Inherited from AbstractBroadCrestedCWeir.) |
| FlowFactor |
The discharge (and discharge derivatives) are scaled by the flow factor.
(Inherited from Structure.) |
| HeadLossFreeOverflowNegativeFlow |
Free overflow factor for negative flow.
Default value = 1.
(Inherited from AbstractBroadCrestedCWeir.) |
| HeadLossFreeOverflowPositiveFlow |
Free overflow factor for positive flow.
Default value = 1.
(Inherited from AbstractBroadCrestedCWeir.) |
| HeadLossInflowNegativeFlow |
Inflow head loss factor for positive flow.
Default value = 0.5.
(Inherited from AbstractBroadCrestedCWeir.) |
| HeadLossInflowPositiveFlow |
Inflow head loss factor for positive flow.
Default value = 0.5.
(Inherited from AbstractBroadCrestedCWeir.) |
| HeadLossOutflowNegativeFlow |
Free overflow factor for negative flow.
Default value = 1.
(Inherited from AbstractBroadCrestedCWeir.) |
| HeadLossOutflowPositiveFlow |
Outflow head loss factor for positive flow.
Default value = 1.
(Inherited from AbstractBroadCrestedCWeir.) |
| HorizontalOffSetFromMarker2 |
Value used when plotting the structue
Unit: [m]
Defualt: 0
|
| 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.) |
| InitialGateLevel |
Gate level.
Type: River Structure Geometry
Unit: [m]
Default: 0
(Inherited from SquaredGatedBCWeir.) |
| InvertLevelDownstream |
Invert level down stream
(Overrides SquareBroadCrestedWeirInvertLevelDownstream.) |
| InvertLevelUpstream |
Invert level up stream
(Overrides SquareBroadCrestedWeirInvertLevelUpstream.) |
| IterationTolerance |
Iteration tolerance.
Default 0.0001
(Inherited from AbstractBroadCrestedCWeir.) |
| Length |
Length of the structure.
Unit: [m]
Default value: 0m
(Inherited from Structure.) |
| Location |
Location property.
(Inherited from Structure.) |
| MaximumIterations |
Maximum number of iterations in a structure to obtain convergence of the discharge.
Default value = 100
(Inherited from AbstractBroadCrestedCWeir.)Currently this is set for all structures from the MaximumIterationsInStructure, but it is prepared for individual structure values. |
| MaxSpeed |
Maximum speed of gate movement
(Inherited from SquaredGatedBCWeir.) |
| MaxValue |
Maximum value of gate level that a control can set in Control()
(Inherited from SquaredGatedBCWeir.) |
| MinimumHeadloss |
Minimum headloss across a structure.
Default value = 0.1
(Inherited from AbstractBroadCrestedCWeir.)Currently this is set for all head loss structures from the MinimumHeadloss, but it is prepared for individual structure values. |
| 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 SquaredGatedBCWeir.) |
| PartOfCompositeFlow |
When the culvert is part of a composite structure Q1=Q2 will differ from Qs.
Qs=Q1*_partOfCompositeFlow;
(Inherited from AbstractBroadCrestedCWeir.) |
| 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.) |
| SillLevel |
Sill level
(Inherited from SquareBroadCrestedWeir.) |
| StructureIterationCentering |
Free overflow factor for negative flow.
Default value = 1.
(Inherited from AbstractBroadCrestedCWeir.) |
| StructureType |
Type of structure
(Inherited from Structure.) |
| SurchargedUnderflowCoefficient |
Coefficient used to avoid instabilities when switching from subcritical to critical.
Type: Dimensionless factor
Unit: []
Default: 0.0
|
| TopoID |
String used to identified cross sections
(Inherited from Structure.) |
| Type |
Structure type, unique for each structure.
(Overrides SquareBroadCrestedWeirType.) |
| UnderFlowCoefficient |
Contraction coefficient.
Type: Dimensionless factor
Unit: []
Default: 0.63
|
| UnderflowTransitionCoefficient |
Coefficient used to avoid instabillities when switching from submerged gate to not submerged gate.
Type: Dimensionless factor
Unit: []
Default: 0.0
|
| UpstreamCrossSection |
Upstream cross section data. The cros section data is the processed level, with, area.
Set up during initialize, from cross section database.
(Inherited from AbstractBroadCrestedCWeir.) |
| 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.) |
| UseMaxValue |
True if gate level should be restricted by MaxValue in Control()
(Inherited from SquaredGatedBCWeir.) |
| Valve |
Type of the valve
Default: None
(Inherited from ValvedStructure.) |
| WaterLevelInStructure |
Water level in the structure at the latest call to SetWaterLevels()
(Inherited from AbstractBroadCrestedCWeir.) |
| Width |
Width of ther squared broad crested weir
(Inherited from SquareBroadCrestedWeir.) |
Methods| Name | Description | |
|---|---|---|
| Accepts |
List of data types that is accepted, i.e., that you can get a ValueSetter for.
(Inherited from Structure.) |
 | ApplyFlowFactor |
Applies flow factor to discharge and it's derivatives
(Inherited from Structure.) |
| BroadCrestedWeirFlow |
Calculates the flow over a broadcrested weir. The method handels the zero variation issues
and passes the real calculation parts to BroadCrestedWeirFlowInner
(Inherited from AbstractBroadCrestedCWeir.) |
| CalculateCriticalConditions | (Inherited from SquareBroadCrestedWeir.) |
| ControlClose |
Close gate
|
| ControlOpen |
Open gate
|
| ControlSetFlowFactor |
Set flow factor to specified value
(Inherited from Structure.) |
| ControlSetGateLevel |
Set new gate level
(Inherited from SquaredGatedBCWeir.) |
| ControlSetMaxGateLevel |
Set the maximum gate level.
(Inherited from SquaredGatedBCWeir.) |
| ControlSetMinGateLevel |
Set the minimum gate level.
(Inherited from SquaredGatedBCWeir.) |
| ControlSetMinMaxGateLevel |
Set the minimum and maximum gate level.
(Inherited from SquaredGatedBCWeir.) |
| Description |
Return a string that describes this structure. Includes structure type and ID
(Inherited from Structure.) |
| 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.) |
| GetArea |
Returns the flow area at the structure. The result depend on the flow type at the structure
(Overrides SquareBroadCrestedWeirGetArea(Double).) |
| 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.
(Overrides SquaredGatedBCWeirGetControlAction(String).)Base implementation for IControllable |
| GetCurrentValue |
Get the current value of the control for the specified id.
(Inherited from SquaredGatedBCWeir.)Base implementation for IControllable |
| GetDepth |
Returns the depth at the structure. The result depend on the flow type at the structure
(Overrides SquareBroadCrestedWeirGetDepth(Double).) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetInvertLevel |
Returns the sill level of the structure.
(Overrides SquareBroadCrestedWeirGetInvertLevel.) |
| 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) |
Prepare the weir: Set the cross sections on each side of the weir.
(Overrides SquaredGatedBCWeirInitialize(ICrossSection, ICrossSection, Boolean, IDiagnostics).) |
| 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) |
Set up structure and set runtime diagnostics object
(Inherited from SquareBroadCrestedWeir.) |
| Prepare(DateTime, HDParameterData, IDiagnostics) |
Set up structure and set runtime diagnostics object
(Inherited from AbstractBroadCrestedCWeir.) |
| PrepareTimeStep |
Prepare structure for time step
(Inherited from SquaredGatedBCWeir.) |
| ReadState |
Read state and apply to module.
Returns true if state was successfully read.
(Inherited from SquaredGatedBCWeir.) |
| 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 SquaredGatedBCWeir.)Base implementation for IControllable |
| SetControlStrategyId |
Set control strategy ID manually.
(Inherited from Structure.)Base implementation for IControllable |
| SetInputWaterLevels | (Inherited from Structure.) |
| SetWaterLevels(Double, Double) |
Sets up- and down- stream water level and forces the calculation of the discharge and its derivatives.
(Overrides SquareBroadCrestedWeirSetWaterLevels(Double, Double).) |
| SetWaterLevels(Double, Double, Double, Double) |
Sets up- and down-stream water level and forces the calculation of the discharge and its derivatives.
(Inherited from AbstractBroadCrestedCWeir.) |
| 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 an underflow gate.
(Overrides SquaredGatedBCWeirValidate.) |
| ValueGetter |
Get value setter for the specified data quantity
(Overrides SquaredGatedBCWeirValueGetter(Int32).) |
| ValueSetter |
Get value setter for the specified data type
(Inherited from Structure.) |
| ValveDecidesFlow |
Decides whether the valve will decide the flow and sets the flow to zero in case the valve
forbids flow.
(Inherited from ValvedStructure.) |
| WriteState |
Write current state of module
(Inherited from SquaredGatedBCWeir.) |
| ZeroFlowDueToValve |
Decides wheather the valve will prevent flow given the flow direction.
(Inherited from ValvedStructure.) |
Fields| Name | Description | |
|---|---|---|
 | _accepts |
List of quantities that are accepted
(Inherited from Structure.) |
| _actualGateLevel |
Gate level
(Inherited from SquaredGatedBCWeir.) |
| _controlIsActive | Flag indicating if gate control is active, i.e. gate is opening or closing (Inherited from SquaredGatedBCWeir.) |
| _controlledMaxGateLevel |
Controllable maximum gate level
(Inherited from SquaredGatedBCWeir.) |
| _controlledMinGateLevel |
Controllable minimum gate level
(Inherited from SquaredGatedBCWeir.) |
| _controlStategyId |
If the structure is being controlled, then _controlStategyId contains the ID of the
active control strategy
(Inherited from Structure.) |
| _controlTargetGateLevel | Target level of gate, i.e. the level that the gate currently approaches. (Inherited from SquaredGatedBCWeir.) |
| _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 AbstractBroadCrestedCWeir.) |
| _downstreamCrossSection |
Downstream cross section data. The cross section data is the processed level, with, area.
(Inherited from AbstractBroadCrestedCWeir.) |
| _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.) |
| _headLossFreeOverflowNegativeFlow |
Free overflow factor for negative flow.
Default value = 1.
(Inherited from AbstractBroadCrestedCWeir.) |
| _headLossFreeOverflowPositiveFlow |
Free overflow factor for positive flow.
Default value = 1.
(Inherited from AbstractBroadCrestedCWeir.) |
| _headLossInflowNegativeFlow |
Inflow head loss factor for negative flow.
Default value = 0.5.
(Inherited from AbstractBroadCrestedCWeir.) |
| _headLossInflowPositiveFlow |
Inflow head loss factor for positive flow.
Default value = 0.5.
(Inherited from AbstractBroadCrestedCWeir.) |
| _headLossOutflowNegativeFlow |
Outflow head loss factor for negative flow.
Default value = 1.
(Inherited from AbstractBroadCrestedCWeir.) |
| _headLossOutflowPositiveFlow |
Outflow head loss factor for positive flow.
Default value = 1.
(Inherited from AbstractBroadCrestedCWeir.) |
| _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.) |
| _maxValue |
Maximum value of gate level that a control can set in Control()
(Inherited from SquaredGatedBCWeir.) |
| _minimumHeadloss |
Minimum head loss across a structure.
Default value = 0.1
(Inherited from AbstractBroadCrestedCWeir.) |
| _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 SquaredGatedBCWeir.) |
| _offers |
List of quantities that are offered
(Inherited from Structure.) |
| _partOfCompositeFlow |
When the culvert is part of a composite structure Q1=Q2 will differ from Qs.
Qs=Q1*_partOfCompositeFlow;
(Inherited from AbstractBroadCrestedCWeir.) |
| _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.) |
| _runTimeDiagnostics |
Diagnostics are written into this Diagnostics during calculations.
Set during Initialize(IDiagnostics) (Inherited from Structure.) |
| _sillLevel |
The level of the sill just upstream of the gate.
(Inherited from SquareBroadCrestedWeir.) |
| _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 AbstractBroadCrestedCWeir.) |
| _topoID |
Identification used to find referenced cross sections
(Inherited from Structure.) |
| _upstreamCrossSection |
Upstream cross section data. The cross section data is the processed level, with, area.
(Inherited from AbstractBroadCrestedCWeir.) |
| _upstreamWaterLevel |
Upstream water level, as set by SetWaterLevels(Double, Double)
Unit: [m]
(Inherited from Structure.) |
| _useControlledMaxGateLevel |
Flag indicating if controllable maximum gate level is enforced
(Inherited from SquaredGatedBCWeir.) |
| _useControlledMinGateLevel |
Flag indicating if controllable minimum gate level is enforced
(Inherited from SquaredGatedBCWeir.) |
| _valveType |
Type of the valve
Default: None
(Inherited from ValvedStructure.) |
| _width |
Width of weir
(Inherited from SquareBroadCrestedWeir.) |
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