ICrossSection Interface |
This is the interface that all cross sections should implement.
The methods are mainly defined by what is needed by the engine.
Namespace: DHI.Mike1D.CrossSectionModule
Assembly: DHI.Mike1D.CrossSectionModule (in DHI.Mike1D.CrossSectionModule.dll) Version: 19.0.0.0 (11.1.1.1111)
SyntaxThe ICrossSection type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | ApplyCoordinates |
Flag specifying whether the Coordinates is to be applied or ´not
|
| BaseCrossSection |
Base cross section. The base cross section has no location and holds
data in depth, not in water level.
|
| BottomLevel |
The Bottom level of the cross section.
It can differ from the BottomLevel when sediments are present and added in the bottom of the cross section. |
| Coordinates |
Gets or sets the cross section coordinates, i.e., the geographical coordinates
of line that the cross section follows.
|
| Height |
Height of the cross section
|
| Info |
Generel info on this cross section, user specified, can be empty. In
Mike11 XNS editor called cross section ID (though it does not identify
the cross section)
|
| Interpolated |
Returns true if the CrossSection is interpolated from other cross sections
|
| IsOpen |
Return true if the cross section is open
|
| Location |
Defines the location of the current cross section. The Z-coordinate
is the bottom level of the cross section (unless defined by the
raw data (the open cross sections)).
|
| MaximumWidth |
Maximum width of the cross section
|
| MinWaterDepth |
Minimum water depth of the cross section.
If the water depth goes below this depth, it will be corrected to match this depth. This can be negative, in case the cross section has a slot attached. |
| ResistanceFactorProportionality |
A proportionality factor that is multiplied with the resistance factor.
ResistanceFactorProportionality is used by the resistance factor
boundaries to adjust the resistance factor during the simulation.
If not set here, its value is default: 1.0
|
| ResistanceFormulation |
The ResistanceFormulation that is used for this crossSection and stored in the processed data.
This may differ from the ones specified in the Formulation, which is the formulation for the raw data. |
| TopoID |
The TopoID set that this cross section belongs to. TODO: See where for details?
|
| ZMax |
The maximum value of Z in the cross section.
|
| ZMin |
The minimum value of Z in the cross section.
It can differ from the BottomLevel when sediments are present and added in the bottom of the cross section. |
Methods| Name | Description | |
|---|---|---|
 | Clone | Creates a new object that is a copy of the current instance. (Inherited from ICloneable.) |
| CompareTo | 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.) |
| Extrapolate |
Returns an extrapolated CrossSection, i.e., a copy of this cross
section at the new location.
|
| 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
|
| 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
|
| 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.
|
| 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.
|
| GetVolumeFromAdditionalSurfaceArea |
Return the integrated additional surface area from the bottom of the top slot to waterLevel
|
| Initialize |
Initialize cross section. Calculates processed data if needed.
|
| 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.
|
| UpdateDatum |
Update datum for cross section
|
| 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.
|
Extension Methods| Name | Description | |
|---|---|---|
 | CalculateNaturalDepth |
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:
(Defined by CrossSectionExtensions.)Q = M*A*R^(2/3)*sqrt(I) |
| GetCapacity |
Get the capacity=conveyance*sqrt(slope) at the specified water level and slope.
(Defined by CrossSectionExtensions.) |
| GetConveyance |
Get the conveyance at the specified water level and slope.
(Defined by CrossSectionExtensions.)The slope must be postive |
| GetDelh |
Return delh for the cross section.
(Defined by CrossSectionExtensions.) |
See Also