| Accepts |
List of data types that is accepted, i.e., that you can get a ValueSetter for.
(Inherited from Structure) |
| AddToOffers |
Add additional offers to structure
(Inherited from Structure) |
| ApplyFlowFactor |
Applies flow factor to discharge and it's derivatives
(Inherited from Structure) |
| BroadCrestedWeirFlow | Calculates the flow over a broad crested weir. The method handles the zero variation issues and passes the real calculation parts to BroadCrestedWeirFlowInner |
| CalculateCriticalConditions | Critical -discharge, -discharge derivative and -water level is calculated from the upstream water level and the data of the specific weir. |
| 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) |
| DetermineCriticalPartOfCompositeFlow |
Determines part of composite flow for structure, which was marked as having critical flow
with initial estimate of part of composite flow.
(Inherited from AbstractHeadLossStructure) |
| Dispose |
Frees the licenses held.
(Inherited from Structure) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| Evaluate(StructureParametersFromHD) |
Sets up- and down-stream water level and discharge and calculates the headloss and its derivatives.
(Inherited from AbstractHeadLossStructure) |
| Evaluate(Double, Double, Double) |
Sets up- and down-stream water level and discharge and calculates the headloss and its derivatives.
(Inherited from AbstractHeadLossStructure) |
| 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) |
| GetActionInfos |
List of control action infos
(Inherited from Structure) |
| GetArea | Flow area |
| 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.
Base implementation for IControllable (Inherited from Structure) |
| GetCurrentValue |
Get the current value of the control for the specified id.
Base implementation for IControllable (Inherited from Structure) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetPartOfCompositeFlowEstimateFactor |
Provides an estimate factor for part of composite flow.
Presently it is upstream structure cross-section to upstream cross-section flow area ratio.
(Overrides AbstractHeadLossStructureGetPartOfCompositeFlowEstimateFactor(Double, Double, Double)) |
| 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 StructureInitialize(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
(Overrides StructurePrepare(HDParameterData, IDiagnostics)) |
| Prepare(DateTime, HDParameterData, IDiagnostics) |
Set up structure and set runtime diagnostics object
(Overrides StructurePrepare(DateTime, HDParameterData, IDiagnostics)) |
| ResetControlledState |
Reset internal state (if any) used by controlling class.
Called after a controlling class has performed a control sequence,
and simulation is restarted.
Base implementation for IControllable (Inherited from Structure) |
| SetControlStrategyId |
Set control strategy ID manually.
Base implementation for IControllable (Inherited from Structure) |
| SetInputWaterLevels |
Set the _upstreamWaterLevel, _downstreamWaterLevel and _flowDir (Inherited from Structure) |
| SetWaterLevels(StructureParametersFromHD) |
Sets up- and down-stream water level and forces the calculation of the discharge and its derivatives.
(Inherited from AbstractHeadLossStructure) |
| SetWaterLevels(Double, Double) |
Sets up- and down- stream water level and forces the calculation of the discharge and its derivatives.
Override in extending classes to do something useful. (Inherited from AbstractHeadLossStructure) |
| SetWaterLevels(Double, Double, Double, Double) |
Sets up- and down-stream water level and forces the calculation of the discharge and its derivatives.
(Inherited from AbstractHeadLossStructure) |
| SetZeroFlow |
Sets the conditions for zero flow
(Overrides AbstractHeadLossStructureSetZeroFlow) |
| 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 Structure) |
| ValueGetter |
Get value setter for the specified data quantity
(Inherited from Structure) |
| 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 AbstractHeadLossStructureValved) |
| ZeroFlowDueToValve |
Decides whether the valve will prevent flow given the flow direction.
(Inherited from AbstractHeadLossStructureValved) |
| 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. (Defined by ProxyExtensions) |
| 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. (Defined by ProxyExtensions) |
| Initialize |
Helper function for some unit tests. Do not use.
(Defined by StructureExtensions) |
| Initialize |
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. (Defined by ProxyExtensions) |