Click or drag to resize

XSPolygon Class

Note: This API is now obsolete.

Closed polygon cross section. Polygon cross sections are defined by a list of points. Remember to call CalculateProcessedData() before use.
Inheritance Hierarchy

Namespace:  DHI.Mike1D.CrossSectionModule
Assembly:  DHI.Mike1D.CrossSectionModule (in DHI.Mike1D.CrossSectionModule.dll) Version: 19.0.0.0 (11.1.1.1111)
Syntax
[ObsoleteAttribute("Use XSBaseRaw, it handles now both XSOpen and XSPolygon")]
public class XSPolygon : XSBaseRaw

The XSPolygon type exposes the following members.

Constructors
  NameDescription
Public methodXSPolygon
Default constructor
Public methodXSPolygon(XSBaseRaw)
Construct a polygon cross section from XSBaseRaw
Top
Properties
  NameDescription
Public propertyAngle
Angle of correction between perpendicular (to river) and cross section orientation [radian].
(Inherited from XSBaseRaw.)
Public propertyApplyAngle
Flag specifying whether to apply Angle of correction.
(Inherited from XSBaseRaw.)
Public propertyAutoProcess
Automatically calculate processed data if 1) They are missing 2) They are not up-to-date (ProcessedDataStatus is NotUpdated)
(Inherited from XSBase.)
Public propertyBottomLevel
Lowest level/depth of the processed data. Note: ProcessedLevels must be defined
(Inherited from XSBase.)
Public propertyCrossSectionType
Type of cross section
(Inherited from XSBase.)
Public propertyEquidistantLevels
Flag to indicate whether equidistant levels are used.
(Inherited from XSBase.)
Public propertyFlowDir
Flow direction
(Inherited from XSBaseRaw.)
Public propertyFlowResistance
Flow resistance. Contains information on flow resistance type (ManningM or Chezy, Z dependence etc) and flow resistence values.
(Inherited from XSBase.)
Public propertyHasProcessedData (Inherited from XSBase.)
Public propertyHeight
Height of the cross section.
(Inherited from XSBase.)
Public propertyInterpolated
whether this cross section was generated from interpolation of neighboring cross sections
(Inherited from XSBaseRaw.)
Public propertyIsOpen
Return true if cross section is open
(Inherited from XSBaseRaw.)
Public propertyLeftCoordinateMarker
Point at left side of the cross section where the coordinate marker is located.
(Inherited from XSBaseRaw.)
Public propertyLeftLeveeBank
Point at left side of the cross section where the left levee is located.
(Inherited from XSBaseRaw.)
Public propertyLeftLowFlowBank
Point at left side of the cross section where the lowest flow bank is located.
(Inherited from XSBaseRaw.)
Public propertyLowestPoint
Point at lowest part of the cross section.
(Inherited from XSBaseRaw.)
Public propertyMaximumStorageWidth
Maximum storage width of the cross section
(Inherited from XSBaseRaw.)
Public propertyModifiedFormulation
Gets the Resistance Formulation that matches the GetResistanceFactor(Int32, Double) value.

This is not necessarily the same as in FlowResistance. but can be different for several reasons: a) The raw and processed data differ, as for DarcyWeisbach. b) The resistance factors have been modified, and values used are those in ModifiedResistanceFactors.

(Inherited from XSBase.)
Public propertyModifiedResistanceFactors
Modified resistance factors. These will be different than ProcessedResistanceFactors if one of the Multiply functions has been executed. This is matching the ModifiedFormulation
(Inherited from XSBase.)
Public propertyMorphologicalDivision
When MorphologicalDivisionType is Level, specifies the level of morphological division

For ST modeling only.

Level is relative to raw data, and must not include any datum offset

(Inherited from XSBase.)
Public propertyMorphologicalDivisionType
Specifies the type of morphological division that is applied.

For ST modeling only.

(Inherited from XSBase.)
Public propertyNumberOfProcessedLevels
returns the number of processed levels (same as dimension of all processed data arrays). Returns 0 if processed data have not been calculated, yet.
(Inherited from XSBase.)
Public propertyPoints
List of points defining polygon cross section.
(Inherited from XSBaseRaw.)
Public propertyProcessedAdditionalSurfaceAreas
Processed additional storage area
(Inherited from XSBase.)
Public propertyProcessedAreas
Processed geometric areas
(Inherited from XSBase.)
Public propertyProcessedDataProtected
false: data are not protected and will be recomputed. true: processed data are protected, data has been manually updated and will not be recomputed.
(Inherited from XSBase.)
Public propertyProcessedDataStatus
ProcessingStatus defines the status of the processed data of this cross section. Whenever the user updates raw data of the cross section, its state must be changed to NotUpdated.
(Inherited from XSBase.)
Public propertyProcessedDerivatives
Flag specifying whether processed derivatives are stored as processed data arrays, or calculated directly. If true, processed data arrays for the derivatives are created (most accurate, smooth interpolation)
(Inherited from XSBase.)
Public propertyProcessedFlowAreas
Processed flow areas
(Inherited from XSBase.)
Public propertyProcessedLevels
Processed levels
(Inherited from XSBase.)
Public propertyProcessedRadii
Processed radii
(Inherited from XSBase.)
Public propertyProcessedRadiiDerivatives
Processed radii
(Inherited from XSBase.)
Public propertyProcessedResistanceFactors
Processed resistance factors. Their type corresponds to the Resistance formulation specified in FlowResistance.
(Inherited from XSBase.)
Public propertyProcessedStorageWidths
Processed storage widths
(Inherited from XSBase.)
Public propertyProcessingLevelsSpecs
Access to all level-related specifications for pre-processing of cross section data
(Inherited from XSBase.)
Public propertyRadiusType
some kind of hydraulic or resistance radius
(Inherited from XSBaseRaw.)
Public propertyRelativeConveyanceCutoff
If processed data has been modified to assure that conveyance never decrease with increasing water levels, this value indicates at which level (relative to height) that the change started.

Only relevant for closed cross sections. Default value is 1.

(Inherited from XSBase.)
Public propertyRightCoordinateMarker
Point at right side of the cross section where the coordinate marker is located.
(Inherited from XSBaseRaw.)
Public propertyRightLeveeBank
Point at right side of the cross section where the right levee is located.
(Inherited from XSBaseRaw.)
Public propertyRightLowFlowBank
Point at right side of the cross section where the lowest flow bank is located.
(Inherited from XSBaseRaw.)
Public propertySelected
whether this cross section is selected for some operation, e.g. saving.
(Inherited from XSBaseRaw.)
Public propertySymmetric
Determines if the points in this cross sections makes up one side of a symmetric cross section Note: Not implemented yet Note: Not always possible.
(Inherited from XSBaseRaw.)
Public propertyTopLevel
Highest level/depth of the processed data.
(Inherited from XSBase.)
Public propertyTopoID
The TopoID set that this cross section belongs to. TODO: See where for details?
(Inherited from XSBase.)
Top
Methods
  NameDescription
Public methodAdjustProcessedLevels(Double)
Adjust the processed levels. Used to ensure that _processedLevels[0] has a certain value
(Inherited from XSBase.)
Public methodAdjustProcessedLevelSpecs
Adjust the processed level specification.
(Inherited from XSBase.)
Public methodBottomLevelFromCenter
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.
(Inherited from XSBaseRaw.)
Public methodCalculateProcessedData
Calculate processed data
(Inherited from XSBaseRaw.)
Public methodCalculateProcessedDataIfNeeded
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.
(Inherited from XSBase.)
Public methodCheckProcessedData
Validates that this cross sections is set up correctly.
(Inherited from XSBase.)
Public methodClearOriginalProcessedData
Clear any stored processed data arrays
(Inherited from XSBase.)
Public methodClearZones
clear section from vegetation and dead water, setting all zone info to Normal
(Inherited from XSBaseRaw.)
Public methodClone
ICloneable implementation. deep clone, including owner
(Overrides XSBaseRawClone.)
Protected methodConvertModifiedResistanceFactorsIfNecessary
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;
(Inherited from XSBase.)
Public methodConvertRelativeResistanceMultiZones
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.
(Inherited from XSBase.)
Public methodCopyValuesToOther
Copy the values of this cross section to another cross section
(Inherited from XSBaseRaw.)
Public methodCreateAllProcessedArrays
Creates all processed data arrays with the given number of levels.
(Inherited from XSBase.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
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 methodGetActualMorphologicalDivision
Get actual morphological division or top of cross section if not defined.
(Inherited from XSBase.)
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.
(Inherited from XSBase.)
Public methodGetArea
Return the cross sectional geometric area, for index and fraction into the processed data.
(Inherited from XSBase.)
Public methodGetAreaByIntegratingWidths
Return the cross sectional geometric area, integrating the storage widths
(Inherited from XSBase.)
Public methodGetCriticalDepth
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.
(Inherited from XSBase.)
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.
(Inherited from XSBase.)
Public methodGetFlowArea(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)
(Inherited from XSBase.)
Public methodGetFlowArea(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)
(Inherited from XSBase.)
Public methodGetFlowAreaDerivative
Get storagewidth as dA/dh from neighboring values in processed XS areas at waterLevel.
(Inherited from XSBase.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetHydraulicRadius(Int32)
Returns the hydraulic radius for index and fraction into the processed data
(Inherited from XSBase.)
Public methodGetHydraulicRadius(Int32, Double)
Returns the hydraulic radius for index and fraction into the processed data
(Inherited from XSBase.)
Public methodGetHydraulicRadiusDerivative
Get the derivate of the hydraulic radius for index and fraction into the processed data.
(Inherited from XSBase.)
Public methodGetLevelFromArea
For a given area, find the level.
(Inherited from XSBase.)
Public methodGetLocalVelocity
Calculates a local velocity for a given x along the cross sectional profile. The result must be divided by GetLocalVelocityFactor().

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

(Inherited from XSBaseRaw.)
Public methodGetLocalVelocityFactor
Calculate a local velocity factor for the provided water depth. This factor is used when calculating a transversally distributed flow velocity.
(Inherited from XSBaseRaw.)
Public methodGetLocalVelocityFactorFromIntegral
Calculates the local velocity factor for use in GetLocalVelocity(Double, Double, Double).

The method is seperated from the GetLocalVelocity(Double, Double, Double) method, since this can be an expensive method (integrating over the entire cross section), to be called once, and the result used many times by the GetLocalVelocity(Double, Double, Double) method.

(Inherited from XSBaseRaw.)
Public methodGetMarkerIndex
Return index of a marker
(Inherited from XSBaseRaw.)
Public methodGetMarkerSequence
Returns a sequence of markers and their indices.
(Inherited from XSBaseRaw.)
Public methodGetMarkersOfPoint
For a given cross section point (at some index), return all markers on that point.
(Inherited from XSBaseRaw.)
Public methodGetMaximumValues
Set maximum area, maximum hydraulic radius and maximum storage width.
(Inherited from XSBase.)
Public methodGetNaturalDepthOld Obsolete.
Get the natural depth at a given discharge and slope
(Inherited from XSBase.)
Public methodGetResistanceFactor
Returns the resistance factor.
(Inherited from XSBase.)
Public methodGetResistanceFactorsDerivative
Get the derivative of the resistance factor at the given water level
(Inherited from XSBase.)
Public methodGetStorageWidth(Int32)
Returns the width from left bank to right bank for index and fraction into the processed data
(Inherited from XSBase.)
Public methodGetStorageWidth(Int32, Double)
Returns the width from left bank to right bank for index and fraction into the processed data
(Inherited from XSBase.)
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
(Inherited from XSBase.)
Public methodInheritProcessedDataFrom
Makes all processed data arrays point to the same arrays as in the other. (reference copy, not value copy)
(Inherited from XSBase.)
Public methodInitialize
Calculate processed data if needed
(Inherited from XSBaseRaw.)
Public methodLevel
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
(Inherited from XSBase.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
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.
(Inherited from XSBase.)
Public methodProcessedLevel
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
(Inherited from XSBase.)
Public methodRestoreModifiedResistanceFactors
if Multiply... or Convert... or similar was called earlier, reset the modified resistance factors to the original processed resistance factors
(Inherited from XSBase.)
Public methodRestoreOriginalProcessedData
Restores any stored processed data arrays previously stored.
(Inherited from XSBase.)
Public methodSaveOriginalProcessedData
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)

(Inherited from XSBase.)
Public methodSetAllProcessedValues
set all the processed data (references to the member array). All values are in SI.
(Inherited from XSBase.)
Public methodSetMarkerAt
Set a particular marker to a given 0-BASED index (within the list of points), or remove it (call with -1). If any other point had this marker before, it gets removed from that point. Throws IndexOutOfRangeException if list of points is empty or index is invalid.
(Inherited from XSBaseRaw.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodUpdateMarkersToDefaults
clears the indicated existing markers and sets them to their default x location. (LeftLeveeBank: smallest x, RightLeveeBank: largest x, LowestPoint: x with the smallest z). Doesn't do anything for Circular, Rectangular.
(Inherited from XSBaseRaw.)
Public methodUpdatePointMarkerString
Update the MarkerString for all cross section points with a marker. Used by the GUI.
(Inherited from XSBaseRaw.)
Public methodUpdatePointResistance
Update the resistance values in the Points in case the ResistanceDistribution is Uniform or Zones
(Inherited from XSBaseRaw.)
Public methodValidate
Validates the data. The constraints are that the levels and the areas after sorting must be monotonically increasing.
(Inherited from XSBaseRaw.)
Top
Fields
  NameDescription
Protected field_bAutoProcess
Allow CalculateProcessedDataIfNeeded. Set to false to disable
(Inherited from XSBase.)
Protected field_bProcessedDataProtected
false: data are not protected and will be recomputed. true: processed data are protected, data has been manually updated and will not be recomputed.
(Inherited from XSBase.)
Protected field_crossSectionType
Type of cross section.
(Inherited from XSBase.)
Protected field_distanceBetweenLevels
The distance between levels if equidistant levels are ued. If equidistant levels are used, then getIndex and getFraction are faster.
(Inherited from XSBase.)
Protected field_equidistantLevels
Flag to indicate whether equidistant levels are used. If equidistant levels are used, then getIndex and getFraction are faster. Each derived cross section must set this flag to true (during construction), if it does not store levels in the _processedLevels array.
(Inherited from XSBase.)
Protected field_flowResistance
Flow resistance
(Inherited from XSBase.)
Protected field_height (Inherited from XSBase.)
Protected field_isInitialized (Inherited from XSBase.)
Protected field_isPrepared
Flag defining whether Prepare(Diagnostics, HDParameterData, ILocation) has been called.
(Inherited from XSBase.)
Protected field_modifiedFormulation
Flow resistance formulation
(Inherited from XSBase.)
Protected field_modifiedResistanceFactors
Modified resistance factors. As default points to _processedResistanceFactors, but during simulation contains resistance factors that are supported by the engine, which may differ from the original values.
(Inherited from XSBase.)
Protected field_modifiedResistanceFactorsDerivatives
Processed resistance factor derivatives for the modified resistance factors.
(Inherited from XSBase.)
Protected field_numberOfProcessedLevels
The number of processed levels
(Inherited from XSBase.)
Protected field_originalProcessedData
A copy of original processed data, in case they have been modified by the engine during the simulation.
(Inherited from XSBase.)
Protected field_processedAdditionalSurfaceAreas
Processed additional storage areas
(Inherited from XSBase.)
Protected field_processedAreas
Processed geometric areas
(Inherited from XSBase.)
Protected field_processedCriticalDischarges
Table with processed critical discharges, created automatically when required.
(Inherited from XSBase.)
Protected field_processedDataStatus
ProcessingStatus defines the status of the processed data of this cross section. Whenever the user updates raw data of the cross section, its state must be changed to NotUpdated.
(Inherited from XSBase.)
Protected field_processedDerivatives
Flag specifying whether processed derivatives are stored as processed data arrays, or calculated directly. If true, processed data arrays for the derivatives are created (most accurate, smooth interpolation)
(Inherited from XSBase.)
Protected field_processedFlowAreas
Processed flow ares
(Inherited from XSBase.)
Protected field_processedLevels
Processed depths
(Inherited from XSBase.)
Protected field_processedRadii
Processed radii
(Inherited from XSBase.)
Protected field_processedRadiiDerivatives
Processed radius derivatives
(Inherited from XSBase.)
Protected field_processedResistanceFactors
Processed resistance factors
(Inherited from XSBase.)
Protected field_processedStorageWidths
Processed storage widths
(Inherited from XSBase.)
Protected field_resistenceDistri
Resistance distribution
(Inherited from XSBase.)
Top
Extension Methods
  NameDescription
Public Extension MethodGetConveyance
Get the conveyance at the specified processed level
(Defined by CrossSectionExtensions.)
Top
See Also