CrossSectionSlotDecorator Methods |
The CrossSectionSlotDecorator type exposes the following members.
Name | Description | |
---|---|---|
Clone |
Creates a new object that is a copy of the current instance.
| |
CompareTo |
Compares the current instance with another object of the same type.
| |
CreateSlotDecorator |
Create a slot decorator for the cross section.
| |
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
Extrapolate |
Returns an extrapolated CrossSection, i.e., a copy of this cross
section at the new location.
| |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | |
GetAdditionalSurfaceArea |
Additional storage area is a volume that the mass equation takes
into account, but it does not influence the momentum equation. It
could be a small pond next to the river that is filled/emptied as
the water level in the river raises/falss.
| |
GetArea |
Return the cross sectional geometric area,
at the given water level.
| |
GetConveyance |
Get the conveyance at the specified water level
| |
GetCriticalDepth |
Gets the Critical depth for a given discharge - [m3/s]
The critical depth is the depth where the flow changes
from supercritical to subcritical flow.
| |
GetCriticalDischarge |
Gets the Critical discharge for a given water level
The critical discharge is the discharge where the flow changes
from supercritical to subcritical flow.
| |
GetFlowArea |
Return the cross sectional flow area,
at the given water level.
| |
GetFlowAreaDerivative |
Get storagewidth as dA/dh from neighboring values in processed XS areas at waterLevel
This is how M11 does it - ONLY USED IN M11 SCHEME WHEN COMPARING DIRECTLY WITH M11 RESULTS
Only implemented in XSOpen for now
| |
GetFlowAreaWithoutBottomSlot |
Return the cross sectional area, also called the flow area,
at the given water level.
| |
GetFrictionValuesNoBottomSlot |
Values required to calculate friction factor for higher order friction term
| |
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) | |
GetHydraulicRadius |
Returns the hydraulic radius for the given water level.
The radius are calculated as one of : todo: check:
Resistance Radius.
Effective area, hydraulic radius
Total area, hydraulic radius.
| |
GetHydraulicRadiusDerivative |
Get the derivate of the hydraulic radius at the given water level.
| |
GetNaturalDepth |
Gets the Natural depth for a given discharge [m3/s] and slope [dimensionless]
The natural depth is the depth where the flow resistance and velocity
balances, i.e., the Manning formula is fullfilled: Q = M*A*R^(2/3)*sqrt(I)
| |
GetResistanceFactor |
Resistance factor for the given water level.
This will always return absolute resistance values.
| |
GetResistanceFactorDerivative |
Get the derivative of the resistance factor at the given water level
| |
GetStorageWidth |
Returns the width from left bank to right bank at the given water level.
| |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
GetVolumeFromAdditionalSurfaceArea |
Return the integrated additional surface area from the bottom of the top slot to waterLevel
| |
HasBottomSlot |
Returns true if the decorator has a bottom slot
| |
InBottomSlot |
Check if we are in bottom slot.
Returns false when no bottom slot is active.
| |
Initialize |
Initialize cross section. Calculates processed data if needed.
| |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
Prepare |
Ensures that the resistance fomulation is not relative. If the resistance fomulation is
Mannings n it is changed to Mannings M and the data are changed accordingly if the resistance
formulation is Darcy Weisbach formulation and data are changed to Chezy.
| |
SetBottomSlot(BottomSlotType, Double) |
Set bottom slot type and start depth (where bottom slot is to start).
| |
SetBottomSlot(ISlot, Double) |
Set bottom slot and start depth (where bottom slot is to start).
if bottomSlot is null, bottom slot functionality is disabled.
| |
SetTopSlot(ITopSlot, Double) |
Set top slot type and depth (where top slot is to start).
| |
SetTopSlot(TopSlotType, Double) |
Set top slot type and depth (where top slot is to start).
| |
SetTopSlotWidth |
Set top slot width. Only valid if top slot is of type TopSlotConstantARW. Throws an exception otherwise.
Used to override the default width which is the width of the cross section where the top slot begins.
| |
ToString | Returns a string that represents the current object. (Inherited from Object.) | |
Validate |
Validates that this cross sections is set up correctly.
| |
ZMinFromCenter |
The minimum value of Z in the cross section (bottom level) at a distance dx from the center of the cross section.
|
Name | Description | |
---|---|---|
GetDelh |
Return delh for the cross section.
(Defined by CrossSectionExtensions.) |