Click or drag to resize

CrossSectionLocated Methods

The CrossSectionLocated type exposes the following members.

Methods
  NameDescription
Public methodClone
Creates a new object that is a copy of the current instance.
Public methodStatic memberCompareBy(String, String)
Predicate to find ICrossSection by ID/BranchName and Topo_ID
Public methodStatic memberCompareBy(ILocation, String)
Predicate to find ICrossSection by Location and topo_id.
Public methodStatic memberCompareBy(ILocationSpan, String)
Predicate to find ICrossSection by LocationSpan and Topo_ID. Uses StrictlyContains
Public methodCompareTo
IComparable implementation. Calls IComparable on the members, if that returns 0, if that returns 0 calls CompareTo on the Topo_ID, calls CompareTo on the DHI_ID members,.
Public methodDeepClone
Creates a new object that is a copy of the current instance.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodExtrapolate
Returns an extrapolated CrossSection, i.e., a copy of this cross section at the new location.
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.)
Public methodGetAdditionalSurfaceArea
Additional storage area is a surface area 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
Public methodGetChild
Returns a Clone of the CrossSection, where the parent keeps a reference to the child. If a property is changed on the parent it will reflect in the child.
Public methodGetConveyance
Get the conveyance at the specified water level
Public methodGetCriticalDepthOld
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.
Public methodGetCriticalDischarge
Gets the Critical discharge for a given water level The critical discharge is the discharge where the flow changes from supercritical to subcritical flow.
Public methodGetFlowArea
Return the cross sectional flow area, which may differ from the geometrical area due to water not being part of the flow
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 methodGetFrictionValues(Double)
Values required to calculate friction factor for higher order friction term
Public methodGetFrictionValues(Double, Double, Double, Double, Double)
Values required to calculate friction factor for higher order friction term
Public methodGetGeoReferencedCoords
If cross section coordinates are valid, returns the geographic (in the landscape's plane) coordinates of all points, otherwise null. Raw data must be present.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetHydraulicRadius
Returns the hydraulic radius for the given water level. The radius is calculated as one of: Resistance radius, effective area hydraulic radius, or total area hydraulic radius
Public methodGetHydraulicRadiusDerivative
Get the derivate of the hydraulic radius at the given water level.
Public methodGetNaturalDepthOld Obsolete.
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)
Public methodGetResistanceFactor
Resistance factor for the given water level. This will always return absolute resitance 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 methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
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.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodPrepare
Ensures that the resistance formulation is not relative. If the resistance formulation 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 methodToString
Returns a string that represents the current object.
(Inherited from Object.)
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)
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