CrossSectionSlotDecorator Class

Construct a new ICrossSection slot decorator with no bottom and top slot defined. Use one ore more of [!:SetBottomSlot(ISlot,double)], SetTopSlot(ITopSlot, Double), SetBottomSlot(BottomSlotType, Double), SetTopSlot(TopSlotType, Double) to add slot functionality.

Construct a new ICrossSection slot decorator with predefined bottom and top slot types.

Flag specifying whether the Coordinates is to be applied or not

Base cross section. The base cross section has no location and holds data in depth, not in water level.

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.

Start depth of the bottom slot

Gets or sets the cross section coordinates, i.e., the geographical coordinates of line that the cross section follows.

Get the underlying cross section

Height of the cross section

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)

Returns true if the CrossSection is interpolated from other cross sections

Return true if the cross section is open

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)).

Maximum width of the cross section

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.

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

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.

Xs area of stored sediment.

Sediment resistance factor

Width of sediment surface layer.

For a pipe/canal, this will vary with time. For a river this is constant.

The TopoID set that this cross section belongs to. TODO: See where for details?

Top slot

The maximum value of Z in the cross section.

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.

Creates a new object that is a copy of the current instance.

Compares the current instance with another object of the same type.

Create a slot decorator for the cross section.

Determines whether the specified object is equal to the current object.

Returns an extrapolated CrossSection, i.e., a copy of this cross section at the new location.

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.

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.

Return the cross sectional geometric area, at the given water level.

Get the conveyance at the specified water level

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.

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. MU version for Closed Irregular cross sections.

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.

Return the cross sectional flow area, at the given water level.

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

Return the cross sectional area, also called the flow area, at the given water level.

Values required to calculate friction factor for higher order friction term

Values required to calculate friction factor for higher order friction term

Serves as the default hash function.

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.

Get the derivate of the hydraulic radius at the given water level.

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)

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)

The natural depth will only be used when above the "outlet" water level. The minDNat can be set to the "outlet" water level, to save computations when natural depth is smaller than this "outlet" water level.

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)

Resistance factor for the given water level. This will always return absolute resistance values.

Get the derivative of the resistance factor at the given water level

Returns the width from left bank to right bank at the given water level.

Gets the Type of the current instance.

Return the integrated additional surface area from the bottom of the top slot to waterLevel

Returns true if the decorator has a bottom slot

Check if we are in bottom slot. Returns false when no bottom slot is active.

Initialize cross section. Calculates processed data if needed.

Creates a shallow copy of the current Object.

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.

Set bottom slot type and start depth (where bottom slot is to start).

Set bottom slot and start depth (where bottom slot is to start). if bottomSlot is null, bottom slot functionality is disabled.

Set top slot type and depth (where top slot is to start).

Set top slot type and depth (where top slot is to start).

Set top slot width. Only valid if top slot is of type TopSlotConstantARW. Throws an exception otherwise. Used to override the default width which is the width of the cross section where the top slot begins.

Returns a string that represents the current object.

Update datum for cross section

Update area of sediment and reset buffers

The sediments are placed in the bottom of the cross section/pipe, creating a new flat bottom of sediments.

The cross section is not changed, but outputs, as GetArea(Double), are modified to take into account the area taken by the sediments.

This is used by the "sewer" morphology updater.

Validates that this cross sections is set up correctly.

The minimum value of Z in the cross section (bottom level) at a distance dx from the center of the cross section.

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:

Get the capacity=conveyance*sqrt(slope) at the specified water level and slope.

Get the conveyance at the specified water level and slope.

The slope must be postive

Return delh for the cross section.