Click or drag to resize

BasinGeometry Class

Geometry of a basin
Inheritance Hierarchy
SystemObject
  DHI.Mike1D.NetworkDataAccessBasinGeometry

Namespace:  DHI.Mike1D.NetworkDataAccess
Assembly:  DHI.Mike1D.NetworkDataAccess (in DHI.Mike1D.NetworkDataAccess.dll) Version: 19.0.0.0 (11.1.1.1111)
Syntax
public class BasinGeometry

The BasinGeometry type exposes the following members.

Constructors
  NameDescription
Public methodBasinGeometry(IXYZTable)
Create geometry data structure with specified number of levels
Public methodBasinGeometry(Int32, Boolean)
Create geometry data structure with specified number of levels
Public methodBasinGeometry(IXYZTable, Double)
Create geometry data structure with specified number of levels
Top
Properties
  NameDescription
Public propertyAreaInterpolation
Type of interpolation between levels.

If true, areas are interpolated linearly between levels.

If false, the basin is assumed to be conical, interpolation in cone radii is performed, giving the cone area at the level of interpolation. This is not interpolating linearly in the areas, instead it gives a geometrical more correct interpolation routine.

Public propertyFlowAreas
Flow area, cross sectional area perpendicular to main flow direction

This is used for head loss calculations between basin and connected reaches.

If flow areas are unknown, use the EstimateFlowAreas method to give an estimate based on a circular basin.

Public propertyLevels
Levels
Public propertyPorosity
Porosity.

If not defined, this is null.

Valid values are in the range ]0;1], 1 being fully void (default value) and zero having no void.

The values are step values, meaning that the porosity at position [i] is valid from level [i] to [i+1], no interpolation takes place.

Public propertySurfaceAreas
Surface areas for each level
Public propertySurfaceRadii
Radius of a circle matching the area of the level.

Computational parameter, used by the engines at runtime

Top
Methods
  NameDescription
Public methodCalculateSurfaceRadii
Calculate SurfaceRadii array from SurfaceAreas.

must be called if geometry is updated.

Only necessary when AreaInterpolation is false.

Public methodCreatePorosity
Add porosity array to object.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodEstimateFlowAreas
Estimate flow areas from surface areas, assuming the basin is circular
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 methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodRemovePorosity
Remove porosity array from object.
Public methodRemoveSurfaceRadii
Remove the SurfaceRadii array
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Extension Methods
  NameDescription
Public Extension MethodGetPorosity
Get surface area of geometry at provided level, by interpolation
(Defined by EngineExtensions.)
Public Extension MethodGetSurfaceArea
Get surface area of geometry at provided level, by interpolation
(Defined by EngineExtensions.)
Public Extension MethodGetSurfaceAreaCone
Get surface area of geometry at provided level, by interpolation of cone/pyramid geometry
(Defined by EngineExtensions.)
Public Extension MethodGetVolume
Get volume of geometry at provided level
(Defined by EngineExtensions.)
Public Extension MethodGetVolumeCone
Get volume of geometry at provided level, by interpolation of cone/pyramid geometry
(Defined by EngineExtensions.)
Top
See Also