Click or drag to resize

AbstractBroadCrestedCWeir Methods

The AbstractBroadCrestedCWeir type exposes the following members.

Methods
  NameDescription
Public methodAccepts
List of data types that is accepted, i.e., that you can get a ValueSetter for.
(Inherited from Structure.)
Protected methodApplyFlowFactor
Applies flow factor to discharge and it's derivatives
(Inherited from Structure.)
Protected methodBroadCrestedWeirFlow
Calculates the flow over a broadcrested weir. The method handels the zero variation issues and passes the real calculation parts to BroadCrestedWeirFlowInner
Protected methodCalculateCriticalConditions
Critical -discharge, -discharge derivative and -water level is calculated from the upstream water level and the data of the specific weir.
Public methodStatic memberCalculateZetaInflow
Calculation of the absolute head loss coefficient at contractions
Public methodStatic memberCalculateZetaOutflow
Calculation of the absolute head loss coefficient at expansions
Public methodControlSetFlowFactor
Set flow factor to specified value
(Inherited from Structure.)
Public methodDescription
Return a string that describes this structure. Includes structure type and ID
(Inherited from Structure.)
Public methodDispose
Frees the licenses held.
(Inherited from Structure.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodExplicitStructureSupport
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.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Protected methodGetArea
Flow area
Public methodGetControlAction
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.)
Public methodGetCurrentValue
Get the current value of the control for the specified id.

Base implementation for IControllable

(Inherited from Structure.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodInitialize(IDiagnostics)
Set up structure and set runtime diagnostics object
(Inherited from Structure.)
Public methodInitialize(ICrossSection, ICrossSection, Boolean, IDiagnostics)
Prepare the weir: Set the cross sections on each side of the weir.
(Overrides StructureInitialize(ICrossSection, ICrossSection, Boolean, IDiagnostics).)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodOffers
A list of quantities available from this structure
(Inherited from Structure.)
Public methodPrepare(HDParameterData, IDiagnostics)
Set up structure and set runtime diagnostics object
(Overrides StructurePrepare(HDParameterData, IDiagnostics).)
Public methodPrepare(DateTime, HDParameterData, IDiagnostics)
Set up structure and set runtime diagnostics object
(Overrides StructurePrepare(DateTime, HDParameterData, IDiagnostics).)
Public methodResetControlledState
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.)
Public methodSetControlStrategyId
Set control strategy ID manually.

Base implementation for IControllable

(Inherited from Structure.)
Protected methodSetInputWaterLevels (Inherited from Structure.)
Public methodSetWaterLevels(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 Structure.)
Public methodSetWaterLevels(Double, Double, Double, Double)
Sets up- and down-stream water level and forces the calculation of the discharge and its derivatives.
Protected methodSetZeroFlow
Sets the conditions for zero flow
(Inherited from Structure.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodUpdatedWaterLevels
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.)
Public methodValidate
Writes errors, warnings and hints into their respective member classes. The member objects are initially cleared.
(Inherited from Structure.)
Public methodValueGetter
Get value setter for the specified data quantity
(Inherited from Structure.)
Public methodValueSetter
Get value setter for the specified data type
(Inherited from Structure.)
Protected methodValveDecidesFlow
Decides whether the valve will decide the flow and sets the flow to zero in case the valve forbids flow.
(Inherited from ValvedStructure.)
Protected methodZeroFlowDueToValve
Decides wheather the valve will prevent flow given the flow direction.
(Inherited from ValvedStructure.)
Top
Extension Methods
  NameDescription
Public Extension MethodGetter

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.)
Public Extension MethodGetters
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.)
Public Extension MethodGettersFraction
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.)
Public Extension MethodGetterUnboxed

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.)
Public Extension MethodInitialize(CrossSectionData, Boolean, IDiagnostics)Overloaded.
Helper function for some unit tests. Do not use.
(Defined by StructureExtensions.)
Public Extension MethodInitialize(BoundaryData, CrossSectionData, Boolean, IDiagnostics)Overloaded.
Helper function for some unit tests. Do not use.
(Defined by StructureExtensions.)
Public Extension MethodIsSideStructure
Returns true if the structure is a side structure
(Defined by StructureExtensions.)
Public Extension MethodSetter

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.)
Top
See Also