Click or drag to resize

CrossSectionMiddling Class

A Cross Section middling is a cross sections that is placed between two other cross sections and uses those to calculate its own values using interpolation.
Inheritance Hierarchy
SystemObject
  DHI.Mike1D.CrossSectionModuleCrossSectionMiddling

Namespace:  DHI.Mike1D.CrossSectionModule
Assembly:  DHI.Mike1D.CrossSectionModule (in DHI.Mike1D.CrossSectionModule.dll) Version: 19.0.0.0 (11.1.1.1111)
Syntax
public class CrossSectionMiddling : ICrossSection, 
	IComparable, ICloneable

The CrossSectionMiddling type exposes the following members.

Constructors
  NameDescription
Public methodCrossSectionMiddling
Create a new CrossSectionMiddling based on a location and two neighbours.
Top
Properties
  NameDescription
Public propertyApplyCoordinates
Not implemented
Public propertyBaseCrossSection
Base cross section. The base cross section has no location and holds data in depth, not in water level.
Public propertyBottomLevel
The minimum value of Z in the cross section (bottom level)
Public propertyCoordinates
Not implemented
Public propertyDHI_ID
An ID that may be used by ArcGIS, for unikely identifying this cross section. No cross sections must share the same DHI_ID. A value of -1 means that the value is not set.
Public propertyHeight
Height of the cross section
Public propertyInfo
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)
Public propertyInterpolated
Not implemented
Public propertyIsOpen
Not implemented
Public propertyLocation
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)).
Public propertyMaximumWidth
Maximum width of the cross section
Public propertyMinWaterDepth
Minimum water depth of the cross section This can be negative
Public propertyOwner
The cross section collection that this cross section belongs to. Used for sending events whenever this cross section updates its state.
Public propertyResistanceFactorProportionality
A proportionality factor that is multiplied with the resistance factor. ResistanceFactorProportionality is used by the resistance factor boundaries to adjust the resistance factor. Default value: 1.0
Public propertyResistanceFormulation
The ResistanceFormulation that is used for this crossSection.
Public propertyTopoID
The TopoID set that this cross section belongs to. TODO: See where for details?
Public propertyZMax
The maximum value of Z in the cross section.
Public propertyZMin
The minimum value of Z in the cross section (bottom level)
Top
Methods
  NameDescription
Public methodClone
Creates a new object that is a copy of the current instance.
Public methodCompareTo
Compares the current instance with another object of the same type.
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 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 area, also called the flow area, at the given water level.
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 area, also called the 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 methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
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 methodGetNaturalDepthOld
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 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 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) 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