OverFlowGate Methods |
The OverFlowGate type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | Accepts |
List of data types that is accepted, i.e., that you can get a ValueSetter for.
(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
|
| 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 |
Calculates the flow area at the structure for a given water level
Do we actually know the water level 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).) |
| GetCurrentValue |
Get the current value of the control for the specified id.
(Inherited from SquaredGatedBCWeir.) |
| GetDepth |
Calculates the depth for a given water level as water level minus the gate level.
(Overrides SquareBroadCrestedWeirGetDepth(Double).) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetInvertLevel |
Return invert level (ground level)
(Overrides SquareBroadCrestedWeirGetInvertLevel.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| Initialize(IStructureCollection, CrossSectionData, Boolean, IDiagnostics) |
Prepare the weir: Set the cross sections on each side of the weir.
(Overrides SquaredGatedBCWeirInitialize(IStructureCollection, CrossSectionData, Boolean, IDiagnostics).) |
| Initialize(IStructureCollection, IBoundaryData, CrossSectionData, Boolean, IDiagnostics) |
Set up structure and set runtime diagnostics object
(Inherited from Structure.) |
| 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.) |
| 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.) |
| SetControlStrategyId |
Set control strategy ID manually.
(Inherited from Structure.) |
| 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, DateTime) | (Inherited from Structure.) |
| 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 |
Writes errors, warnings and hints into their respective member classes. The member objects are initially cleared.
(Inherited from SquaredGatedBCWeir.) |
| ValueFractionGetter |
Get value setter for the specified data quantity
(Overrides SquaredGatedBCWeirValueFractionGetter(Int32).) |
| ValueGetter |
Get value setter for the specified data quantity
(Overrides SquaredGatedBCWeirValueGetter(Int32).) |
| ValueGetterBoxed |
Get value setter for the specified data quantity
(Inherited from Structure.) |
| ValueSetter |
Get value setter for the specified data type
(Inherited from Structure.) |
| ValueSetterBoxed |
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.) |
| ZeroFlowDueToValve |
Decides wheather the valve will prevent flow given the flow direction.
(Inherited from ValvedStructure.) |
Extension Methods| Name | Description | |
|---|---|---|
 | Description |
Returns the description of the structure, if it is an Structure,
otherwise id + type
(Defined by StructureExtensions.) |
| Getter | From the proxy, return an IDoubleGetter 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 IDoubleGetter 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 IDoubleGetter 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 IDoubleGetter 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