Click or drag to resize

ICrossSection Methods

The ICrossSection type exposes the following members.

Methods
  NameDescription
Public methodClone
Creates a new object that is a copy of the current instance.
(Inherited from ICloneable.)
Public methodCompareTo
Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.
(Inherited from IComparable.)
Public methodExtrapolate
Returns an extrapolated CrossSection, i.e., a copy of this cross section at the new location.
Public methodGetAdditionalSurfaceArea
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.
Public methodGetArea
Return the cross sectional geometric area at the given water level.
Public methodGetConveyance
Get the conveyance at the specified water level
Public methodGetFlowArea
Return the cross sectional flow area at the given water level.
Public methodGetFlowAreaDerivative
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
Public methodGetHydraulicRadius
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.
Public methodGetHydraulicRadiusDerivative
Get the derivate of the hydraulic radius at the given water level.
Public methodGetResistanceFactor
Resistance factor for the given water level. This will always return absolute resistance values.
Public methodGetResistanceFactorDerivative
Get the derivative of the resistance factor at the given water level
Public methodGetStorageWidth
Returns the width from left bank to right bank at the given water level.
Public methodGetVolumeFromAdditionalSurfaceArea
Return the integrated additional surface area from the bottom of the top slot to waterLevel
Public methodInitialize
Initialize cross section. Calculates processed data if needed.
Public methodPrepare
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.
Public methodUpdateDatum
Update datum for cross section
Public methodValidate
Validates that this cross sections is set up correctly.
Public methodZMinFromCenter
The minimum value of Z in the cross section (bottom level) at a distance dx from the center of the cross section.
Top
Extension Methods
  NameDescription
Public Extension MethodCalculateNaturalDepth
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., for Manning resistance formulation when Manning formula is fullfilled:
Q = M*A*R^(2/3)*sqrt(I)
(Defined by CrossSectionExtensions.)
Public Extension MethodGetCapacity
Get the capacity=conveyance*sqrt(slope) at the specified water level and slope.
(Defined by CrossSectionExtensions.)
Public Extension MethodGetConveyance
Get the conveyance at the specified water level and slope.

The slope must be postive

(Defined by CrossSectionExtensions.)
Public Extension MethodGetDelh
Return delh for the cross section.
(Defined by CrossSectionExtensions.)
Top
See Also