Click or drag to resize

SquareBroadCrestedWeir Methods

The SquareBroadCrestedWeir 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
(Inherited from AbstractBroadCrestedCWeir.)
Protected methodCalculateCriticalConditions
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
Get the flow area
(Overrides AbstractBroadCrestedCWeirGetArea(Double).)
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.)
Protected methodGetDepth
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Protected methodGetInvertLevel
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 AbstractBroadCrestedCWeirInitialize(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 AbstractBroadCrestedCWeirPrepare(HDParameterData, IDiagnostics).)
Public methodPrepare(DateTime, HDParameterData, IDiagnostics)
Set up structure and set runtime diagnostics object
(Inherited from AbstractBroadCrestedCWeir.)
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.
(Overrides StructureSetWaterLevels(Double, Double).)
Public methodSetWaterLevels(Double, Double, Double, Double)
Sets up- and down-stream water level and forces the calculation of the discharge and its derivatives.
(Inherited from AbstractBroadCrestedCWeir.)
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
(Overrides StructureValueGetter(Int32).)
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
See Also