XSBase Methods

Methods

AdjustProcessedLevels(Double) Adjust the processed levels. Used to ensure that _processedLevels[0] has a certain value
AdjustProcessedLevels(Double, Double) Adjust the processed levels, subtract delta. Used to ensure that _processedLevels[0] has a certain value
AdjustProcessedLevelSpecs Adjust the processed level specification.
BottomLevelFromCenter Return the bottom level of the cross section at a distance dx from the center of the cross section. Throws an exception if dx is larger than half the cross section width.
CalculateProcessedData Calculate processed data
CalculateProcessedDataIfNeeded Calculate the processed levels, storage areas, radii, etc, ie, fill in all ProcessedXXX properties if they are not up to date. Also called by getters for these properties if needed, so usually, this method doesn't have to be called explicitly.
CheckProcessedData Validates that this cross sections is set up correctly.
ClearOriginalProcessedData Clear any stored processed data arrays
Clone Creates a new object that is a copy of the current instance.
ConvertModifiedResistanceFactorsIfNecessary Converts the modified resistance data to another formulation. Returns false if the conversion could be performed. Note: so far only few conversions are supported: - from Manningsn to ManningsM;
ConvertRelativeResistanceMultiZones Converts the ProcessedResistanceFactors according to a multizone set of absolute resistance values. Each input factor is applied between each level seperator, the first factor from -infinity to the first level, the second factor from the first level to the second level, and the last factor from the last level to infinity, i.e., the levelSeperators defines where one factor takes over from the previous. The factors array must be one longer than the levelSeperators array. The relative resistance factor is taken into account also. Results are stored in the ModifiedResistanceFactors and those are used in the calculation.
CreateAllProcessedArrays Creates all processed data arrays with the given number of levels.
EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GetActualMorphologicalDivision Get actual morphological division or top of cross section if not defined.
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, for index and fraction into the processed data.
GetAreaByIntegratingWidths Return the cross sectional geometric area, integrating the storage widths
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(Int32) Return the cross sectional flow area, for index and fraction into the processed data. This can be the total areas or the effective flow area hence the area does not necessarily correspond to the amount of water in the system (volume)
GetFlowArea(Int32, Double) Return the cross sectional flow area, for index and fraction into the processed data. This can be the total areas or the effective flow area hence the area does not necessarily correspond to the amount of water in the system (volume)
GetFlowAreaDerivative Get storagewidth as dA/dh from neighboring values in processed XS areas at waterLevel.
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetHydraulicRadius(Int32) Returns the hydraulic radius for index and fraction into the processed data
GetHydraulicRadius(Int32, Double) Returns the hydraulic radius for index and fraction into the processed data
GetHydraulicRadiusDerivative Get the derivate of the hydraulic radius for index and fraction into the processed data.
GetLevelFromArea For a given area, find the level.
GetLocalFlowDistributionDepthFactor Calculates a local flow distribution factor for a given x along the cross sectional profile. The result must be divided by GetFlowDistributionConveyance(Double).

The calculation is based on a parallel canal analysis, and if integrated up, matches the total discharge through the cross section.

GetMaximumValues Set maximum area, maximum hydraulic radius and maximum storage width.
GetNaturalDepthOld Get the natural depth at a given discharge and slope
Obsolete
GetResistanceFactor Returns the resistance factor.
GetResistanceFactorsDerivative Get the derivative of the resistance factor at the given water level
GetStorageWidth(Int32) Returns the width from left bank to right bank for index and fraction into the processed data
GetStorageWidth(Int32, Double) Returns the width from left bank to right bank for index and fraction into the processed data
GetTypeGets 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
InheritProcessedDataFrom Makes all processed data arrays point to the same arrays as in the other. (reference copy, not value copy)
Initialize Calculate processed data if needed
Level Get the actual processed level at the given index. Works regardless of the _equidistantLevels flag, i.e., also when ProcessedLevels are not present. Index must be between 0 and NumberOfProcessedLevels-1 otherwise it will fail or give incorrect results
MemberwiseCloneCreates 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.
ProcessedLevel Get the raw processed level at the given index. Works regardless of the _equidistantLevels flag, i.e., also when ProcessedLevels are not present. Index must be between 0 and NumberOfProcessedLevels-1 otherwise it will fail or give incorrect results
RemoveAllProcessedData Removes all processed data arrays.
RestoreModifiedResistanceFactors if Multiply... or Convert... or similar was called earlier, reset the modified resistance factors to the original processed resistance factors
RestoreOriginalProcessedData Restores any stored processed data arrays previously stored.
SaveOriginalProcessedData Store the current processed data arrays (shallow copy). If a set of original processed data already exists, the original set is kept and not overwritten.

Updating the ProcessedLevels will still update the original processed data, unless new processed data has been provided, i.e. by using CreateAllProcessedArrays(Int32) or SetAllProcessedValues(Double, Double, Double, Double, Double, Double), due to the shallow copy.

The original processed data arrays are kept when setting new processed data, using e.g. SetAllProcessedValues(Double, Double, Double, Double, Double, Double)

SetAllProcessedValues set all the processed data (references to the member array). All values are in SI.
ToStringReturns a string that represents the current object.
(Inherited from Object)
Validate Validates that this cross sections is set up correctly.

Extension Methods

GetConveyance Get the conveyance at the specified processed level
(Defined by CrossSectionExtensions)

See Also