MeshLib C# Docs
Loading...
Searching...
No Matches
MR.Const_WatershedGraph.BasinInfo Class Reference

associated with each vertex in graph Generated from class MR.WatershedGraph.BasinInfo. This is the non-const half of the class. More...

Inheritance diagram for MR.Const_WatershedGraph.BasinInfo:

Public Member Functions

unsafe BasinInfo ()
 Constructs an empty (default-constructed) instance.
unsafe BasinInfo (MR.WatershedGraph.Const_BasinInfo _other)
 Generated from constructor MR::WatershedGraph::BasinInfo::BasinInfo.
 BasinInfo (BasinInfo _other)
 Generated from constructor MR::WatershedGraph::BasinInfo::BasinInfo.
unsafe MR.WatershedGraph.BasinInfo assign (MR.WatershedGraph.Const_BasinInfo _other)
 Generated from method MR::WatershedGraph::BasinInfo::operator=.
unsafe void updateAccVolume (float amount)
 updates accumulated volume in the basin to the moment of given precipitation amount Generated from method MR::WatershedGraph::BasinInfo::updateAccVolume.
Public Member Functions inherited from MR.Const_WatershedGraph.Const_BasinInfo
virtual void Dispose ()
unsafe Const_BasinInfo ()
 Constructs an empty (default-constructed) instance.
unsafe Const_BasinInfo (MR.WatershedGraph.Const_BasinInfo _other)
 Generated from constructor MR::WatershedGraph::BasinInfo::BasinInfo.
 Const_BasinInfo (BasinInfo _other)
 Generated from constructor MR::WatershedGraph::BasinInfo::BasinInfo.
unsafe float amountTillOverflow ()
 amount of precipitation (in same units as mesh coordinates and water level), which can be added before overflowing the basin Generated from method MR::WatershedGraph::BasinInfo::amountTillOverflow.
unsafe float approxLevel ()
 approximate current level of water (z-coordinate) in the basin Generated from method MR::WatershedGraph::BasinInfo::approxLevel.

Properties

new unsafe ref MR.VertId lowestVert [get]
 in the whole basin
new unsafe ref float lowestLevel [get]
 lowest level (z-coordinate of lowestVert) in the basin
new unsafe ref float area [get]
 precipitation area that flows in this basin (and if it is full, continue flowing next)
new unsafe ref float lowestBdLevel [get]
 lowest position on the boundary of the basin
new unsafe ref float maxVolume [get]
 full water volume to be accumulated in the basin till water reaches the lowest height on the boundary
new unsafe ref float accVolume [get]
 accumulated water volume in the basin so far
new unsafe ref float lastUpdateAmount [get]
 the amount when accVolume was last updated
new unsafe ref float lastMergeLevel [get]
 water level in the basin when it was formed (by merge or creation)
new unsafe ref float lastMergeVolume [get]
 water volume in the basin when it was formed (by merge or creation)
new unsafe ref MR.GraphEdgeId overflowVia [get]
 when level=lowestBdLevel, volume=0, all water from this basin overflows via this boundary
Properties inherited from MR.Const_WatershedGraph.Const_BasinInfo
unsafe ref readonly MR.VertId lowestVert [get]
 in the whole basin
unsafe float lowestLevel [get]
 lowest level (z-coordinate of lowestVert) in the basin
unsafe float area [get]
 precipitation area that flows in this basin (and if it is full, continue flowing next)
unsafe float lowestBdLevel [get]
 lowest position on the boundary of the basin
unsafe float maxVolume [get]
 full water volume to be accumulated in the basin till water reaches the lowest height on the boundary
unsafe float accVolume [get]
 accumulated water volume in the basin so far
unsafe float lastUpdateAmount [get]
 the amount when accVolume was last updated
unsafe float lastMergeLevel [get]
 water level in the basin when it was formed (by merge or creation)
unsafe float lastMergeVolume [get]
 water volume in the basin when it was formed (by merge or creation)
unsafe ref readonly MR.GraphEdgeId overflowVia [get]
 when level=lowestBdLevel, volume=0, all water from this basin overflows via this boundary

Additional Inherited Members

Protected Member Functions inherited from MR.Const_WatershedGraph.Const_BasinInfo
virtual unsafe void Dispose (bool disposing)
Protected Attributes inherited from MR.Const_WatershedGraph.Const_BasinInfo
unsafe MR.VertId__ref_storage_lowestVert
unsafe float * __ref_storage_lowestLevel
unsafe float * __ref_storage_area
unsafe float * __ref_storage_lowestBdLevel
unsafe float * __ref_storage_maxVolume
unsafe float * __ref_storage_accVolume
unsafe float * __ref_storage_lastUpdateAmount
unsafe float * __ref_storage_lastMergeLevel
unsafe float * __ref_storage_lastMergeVolume
unsafe MR.GraphEdgeId__ref_storage_overflowVia

Detailed Description

associated with each vertex in graph Generated from class MR.WatershedGraph.BasinInfo. This is the non-const half of the class.

Constructor & Destructor Documentation

◆ BasinInfo() [1/3]

unsafe MR.Const_WatershedGraph.BasinInfo.BasinInfo ( )
inline

Constructs an empty (default-constructed) instance.

◆ BasinInfo() [2/3]

unsafe MR.Const_WatershedGraph.BasinInfo.BasinInfo ( MR.WatershedGraph.Const_BasinInfo _other)
inline

Generated from constructor MR::WatershedGraph::BasinInfo::BasinInfo.

◆ BasinInfo() [3/3]

MR.Const_WatershedGraph.BasinInfo.BasinInfo ( BasinInfo _other)
inline

Generated from constructor MR::WatershedGraph::BasinInfo::BasinInfo.

Member Function Documentation

◆ assign()

unsafe MR.WatershedGraph.BasinInfo MR.Const_WatershedGraph.BasinInfo.assign ( MR.WatershedGraph.Const_BasinInfo _other)
inline

Generated from method MR::WatershedGraph::BasinInfo::operator=.

◆ updateAccVolume()

unsafe void MR.Const_WatershedGraph.BasinInfo.updateAccVolume ( float amount)
inline

updates accumulated volume in the basin to the moment of given precipitation amount Generated from method MR::WatershedGraph::BasinInfo::updateAccVolume.

Property Documentation

◆ accVolume

new unsafe ref float MR.Const_WatershedGraph.BasinInfo.accVolume
get

accumulated water volume in the basin so far

◆ area

new unsafe ref float MR.Const_WatershedGraph.BasinInfo.area
get

precipitation area that flows in this basin (and if it is full, continue flowing next)

◆ lastMergeLevel

new unsafe ref float MR.Const_WatershedGraph.BasinInfo.lastMergeLevel
get

water level in the basin when it was formed (by merge or creation)

◆ lastMergeVolume

new unsafe ref float MR.Const_WatershedGraph.BasinInfo.lastMergeVolume
get

water volume in the basin when it was formed (by merge or creation)

◆ lastUpdateAmount

new unsafe ref float MR.Const_WatershedGraph.BasinInfo.lastUpdateAmount
get

the amount when accVolume was last updated

◆ lowestBdLevel

new unsafe ref float MR.Const_WatershedGraph.BasinInfo.lowestBdLevel
get

lowest position on the boundary of the basin

◆ lowestLevel

new unsafe ref float MR.Const_WatershedGraph.BasinInfo.lowestLevel
get

lowest level (z-coordinate of lowestVert) in the basin

◆ lowestVert

new unsafe ref MR.VertId MR.Const_WatershedGraph.BasinInfo.lowestVert
get

in the whole basin

◆ maxVolume

new unsafe ref float MR.Const_WatershedGraph.BasinInfo.maxVolume
get

full water volume to be accumulated in the basin till water reaches the lowest height on the boundary

◆ overflowVia

new unsafe ref MR.GraphEdgeId MR.Const_WatershedGraph.BasinInfo.overflowVia
get

when level=lowestBdLevel, volume=0, all water from this basin overflows via this boundary


The documentation for this class was generated from the following file: