MeshLib C# Docs
Loading...
Searching...
No Matches
Classes | Public Member Functions | Protected Member Functions | Protected Attributes | Properties | List of all members
MR.Const_WatershedGraph.Const_BasinInfo Class Reference

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

Inheritance diagram for MR.Const_WatershedGraph.Const_BasinInfo:

Classes

struct  _Underlying

Public Member Functions

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.

Protected Member Functions

virtual unsafe void Dispose (bool disposing)

Protected Attributes

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

Properties

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

Detailed Description

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

Constructor & Destructor Documentation

◆ Const_BasinInfo() [1/3]

unsafe MR.Const_WatershedGraph.Const_BasinInfo.Const_BasinInfo ( )
inline

Constructs an empty (default-constructed) instance.

◆ Const_BasinInfo() [2/3]

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

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

◆ Const_BasinInfo() [3/3]

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

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

Member Function Documentation

◆ amountTillOverflow()

unsafe float MR.Const_WatershedGraph.Const_BasinInfo.amountTillOverflow ( )
inline

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.

◆ approxLevel()

unsafe float MR.Const_WatershedGraph.Const_BasinInfo.approxLevel ( )
inline

approximate current level of water (z-coordinate) in the basin Generated from method MR::WatershedGraph::BasinInfo::approxLevel.

◆ Dispose() [1/2]

virtual void MR.Const_WatershedGraph.Const_BasinInfo.Dispose ( )
inlinevirtual

◆ Dispose() [2/2]

virtual unsafe void MR.Const_WatershedGraph.Const_BasinInfo.Dispose ( bool disposing)
inlineprotectedvirtual

Member Data Documentation

◆ __ref_storage_accVolume

unsafe float* MR.Const_WatershedGraph.Const_BasinInfo.__ref_storage_accVolume
protected

◆ __ref_storage_area

unsafe float* MR.Const_WatershedGraph.Const_BasinInfo.__ref_storage_area
protected

◆ __ref_storage_lastMergeLevel

unsafe float* MR.Const_WatershedGraph.Const_BasinInfo.__ref_storage_lastMergeLevel
protected

◆ __ref_storage_lastMergeVolume

unsafe float* MR.Const_WatershedGraph.Const_BasinInfo.__ref_storage_lastMergeVolume
protected

◆ __ref_storage_lastUpdateAmount

unsafe float* MR.Const_WatershedGraph.Const_BasinInfo.__ref_storage_lastUpdateAmount
protected

◆ __ref_storage_lowestBdLevel

unsafe float* MR.Const_WatershedGraph.Const_BasinInfo.__ref_storage_lowestBdLevel
protected

◆ __ref_storage_lowestLevel

unsafe float* MR.Const_WatershedGraph.Const_BasinInfo.__ref_storage_lowestLevel
protected

◆ __ref_storage_lowestVert

unsafe MR.VertId* MR.Const_WatershedGraph.Const_BasinInfo.__ref_storage_lowestVert
protected

◆ __ref_storage_maxVolume

unsafe float* MR.Const_WatershedGraph.Const_BasinInfo.__ref_storage_maxVolume
protected

◆ __ref_storage_overflowVia

unsafe MR.GraphEdgeId* MR.Const_WatershedGraph.Const_BasinInfo.__ref_storage_overflowVia
protected

Property Documentation

◆ accVolume

unsafe float MR.Const_WatershedGraph.Const_BasinInfo.accVolume
get

accumulated water volume in the basin so far

◆ area

unsafe float MR.Const_WatershedGraph.Const_BasinInfo.area
get

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

◆ lastMergeLevel

unsafe float MR.Const_WatershedGraph.Const_BasinInfo.lastMergeLevel
get

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

◆ lastMergeVolume

unsafe float MR.Const_WatershedGraph.Const_BasinInfo.lastMergeVolume
get

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

◆ lastUpdateAmount

unsafe float MR.Const_WatershedGraph.Const_BasinInfo.lastUpdateAmount
get

the amount when accVolume was last updated

◆ lowestBdLevel

unsafe float MR.Const_WatershedGraph.Const_BasinInfo.lowestBdLevel
get

lowest position on the boundary of the basin

◆ lowestLevel

unsafe float MR.Const_WatershedGraph.Const_BasinInfo.lowestLevel
get

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

◆ lowestVert

unsafe ref readonly MR.VertId MR.Const_WatershedGraph.Const_BasinInfo.lowestVert
get

in the whole basin

◆ maxVolume

unsafe float MR.Const_WatershedGraph.Const_BasinInfo.maxVolume
get

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

◆ overflowVia

unsafe ref readonly MR.GraphEdgeId MR.Const_WatershedGraph.Const_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: