Click or drag to resize

EngineNodeBasin Methods

The EngineNodeBasin type exposes the following members.

Methods
  NameDescription
Public methodAssignBoundary
Assign a water level boundary to this node. Only one open boundary type can be assigned to each node
(Inherited from EngineNode.)
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 methodGetFlowArea
Calculate the flow area (area perpendicular to flow direction) for a given water level
(Overrides EngineNodeVolumeGetFlowArea(Double).)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetStorageArea
Return the surface area for a given water level
(Overrides EngineNodeGetStorageArea(Double).)
Public methodGetStorageWidth
Calculate the storage width for a given water level.

Calculated as the diameter of a circle with the same surface area as the basin at the give water level.

(Overrides EngineNodeVolumeGetStorageWidth(Double).)
Public methodGetSurfaceArea
Return the surface area for a given water level
(Overrides EngineNodeGetSurfaceArea(Double).)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetVolume(Double)
Calculate volume in node for given water level
(Overrides EngineNodeVolumeGetVolume(Double).)
Public methodGetVolume(Double, Boolean)
Calculate volume in node for given water level
Public methodIDEquals
Checks whether the otherId matches this nodes ID.
(Inherited from EngineNode.)
Public methodInitialize (Overrides EngineNodeInitialize(IDiagnostics).)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodPrepare
Called in prepare step
(Inherited from EngineNode.)
Public methodSetHeadloss Obsolete.
Set head loss calculator, for user defined head loss calculations
(Inherited from EngineNode.)
Public methodToString
Returns a String that represents the current Object.
(Inherited from EngineNode.)
Public methodUpdateBottomLevelOfStructureReaches
Update bottom level of all structure reaches connected to the node to the same bottom level as the node.
(Inherited from EngineNode.)
Top
Extension Methods
  NameDescription
Public Extension MethodIsAutoCreated
If node is automatically created. This happens when reach start/end connections are based on locations.
(Defined by EngineExtensions.)
Public Extension MethodIsPressureNode
Returns true if the engine node is in a pressurized section
(Defined by EngineExtensions.)
Public Extension MethodIsSpillingNode
If node is spilling node, i.e. is a volume node, and has a cover that supports spilling
(Defined by EngineExtensions.)
Public Extension MethodIsStructureOutlet
Returns true if the engine node is a structure outlet
(Defined by EngineExtensions.)
Top
See Also