OverFlowFormula Class |
Calculation of the flow at energy loss structures.
Inheritance HierarchySystemObject
DHI.Mike1D.StructureModuleStructure
DHI.Mike1D.StructureModuleValvedStructure
DHI.Mike1D.StructureModuleOverFlowFormula
DHI.Mike1D.StructureModuleStructure
DHI.Mike1D.StructureModuleValvedStructure
DHI.Mike1D.StructureModuleOverFlowFormula
Namespace: DHI.Mike1D.StructureModule
Assembly: DHI.Mike1D.StructureModule (in DHI.Mike1D.StructureModule.dll) Version: 19.0.0.0 (11.1.1.1111)
SyntaxThe OverFlowFormula type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | OverFlowFormula |
Constructor method for the valve structure
|
Properties| Name | Description | |
|---|---|---|
 | CrestLevel |
The level of the weir crest. For structures with control, this is
the initial creste level only.
Type: River Structure Geometry
Unit: [m]
Default: 0
|
| CrestType |
Integere indicating which weir type it is:
1: Rectangular
2: V-Notch
3: Trapezoidal
4: Irregular
5: Long weir
|
| CrestWidth |
The width of the weir.
Type: River Structure Geometry
Unit: [m]
Default: 0
|
| CurrentCrestLevel |
For structure with control, the crest level may change. Use this property to
get/set the current crest level.
|
| DataSetID |
ID of the table where the Q-h relation is located.
|
| 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
|
| Discharge |
Calculated Discharge. The value is calculated by SetWaterLevels.
Unit: [m^3/s]
(Inherited from Structure.) |
| 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 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.) |
| 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.) |
| InvertLevelDownstream |
Invert level down stream
(Overrides StructureInvertLevelDownstream.) |
| InvertLevelUpstream |
Invert level up stream
(Overrides StructureInvertLevelUpstream.) |
| Kc |
Coeffcient used to determine overall flow coefficient when weir coefficient is not used.
Type: Undefined
Unit: []
Default: Undefined
|
| Length |
Length of the structure.
Unit: [m]
Default value: 0m
(Inherited from Structure.) |
| Location |
Location property.
(Inherited from Structure.) |
| MaxCrestLevel |
Maximum crest level
Used when crest level is being controlled |
| MaxCrestLevelDecreaseSpeed |
Maximum crest level decrease speed
Used when crest level is being controlled |
| MaxCrestLevelIncreaseSpeed |
Maximum crest level increase speed
Used when crest level is being controlled |
| MethodNumber |
Calculation method: 1 for a Q-h table and 2 for weir formula
Default: 2
|
| MinCrestLevel |
Minimum crest level
Used when crest level is being 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.
(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.) |
| StructureType |
Type of structure
(Inherited from Structure.) |
| TopoID |
String used to identified cross sections
(Inherited from Structure.) |
| TransitionCoefficient |
Coefficient used to make a continuos transistion between
submerged and not submerged flow at the weir
Unit: []
Default: 0.00.
|
| Type |
Structure type, unique for each structure.
(Overrides StructureType.) |
| 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.) |
| 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 the valve
Default: None
(Inherited from ValvedStructure.) |
| 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 Structure.) |
 | ApplyFlowFactor |
Applies flow factor to discharge and it's derivatives
(Inherited from Structure.) |
 | CalcCritWeirYc |
Calculation of the characteristic height for critical flow: a*D
|
| CalcFreeWeirFlow |
Calculation of the free flow across the weir according to: Q=Width*sqrt(g*Y*Y*Y)where Y = a*D.
|
| CalcSubmergedWeirFlow |
Calculation of the subcritical flow across the weir according to: Q=Width*sqrt(g*Y*Y*Y)
where Y = a*upsD*(1 - dwsD/upsD)^^b
|
| CalcSubmergedWeirFlowAlt |
Calculation of the subcritical flow across the weir. This version is from the MU weir.
|
| CalcSubWeirYc |
Calculation of characteristic height for a submerged weir: a*upsDepth*(1 - dwsDepth/upsDepth)^^b
|
| ControlSetCrestLevel |
Control the structure, set crest level to specified value
|
| 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.) |
| 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 Prepare() if _implitcit == false to check if
the structure supports being Explicit.
Once all structures support explicit operation this method can be deleted.
(Overrides StructureExplicitStructureSupport.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| 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 StructureGetControlAction(String).)Base implementation for IControllable |
| GetCurrentValue |
Get the current value of the control for the specified id.
(Overrides StructureGetCurrentValue(String).)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) |
Set up structure and set runtime diagnostics object
(Overrides StructureInitialize(ICrossSection, ICrossSection, Boolean, IDiagnostics).) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| Offers |
List of data types that is offered and can be used in GetValue
(Overrides StructureOffers.) |
| Prepare(HDParameterData, IDiagnostics) |
Set up structure and set runtime diagnostics object
(Inherited from Structure.) |
| Prepare(DateTime, HDParameterData, IDiagnostics) |
Set up structure and set runtime diagnostics object
(Inherited from Structure.) |
| PrepareTimeStep |
Prepare structure for time step
|
| QSluiceGate |
Calculation of the discharge as Q=Width*sqrt(g*Yc*Yc*Yc)
|
| ReadState | |
| ResetControlledState |
Reset internal state (if any) used by controlling class.
Called after a controlling class has performed a control sequence,
and simulation is restarted.
(Overrides StructureResetControlledState.)Base implementation for IControllable |
| SetControlStrategyId |
Set control strategy ID manually.
(Inherited from Structure.)Base implementation for IControllable |
| SetInputWaterLevels | (Inherited from Structure.) |
| SetWaterLevels |
Sets up- and down- stream water level and forces the calculation of the discharge and its derivatives.
(Overrides StructureSetWaterLevels(Double, Double).) |
| 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 tabulated 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.) |
| 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 | |
| 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.) |
| _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.) |
| _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.) |
| _runTimeDiagnostics |
Diagnostics are written into this Diagnostics during calculations.
Set during Initialize(IDiagnostics) (Inherited from Structure.) |
| _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.) |
| _valveType |
Type of the valve
Default: None
(Inherited from ValvedStructure.) |
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