MeshLib Python Docs
Loading...
Searching...
No Matches
mrmeshpy.WatershedGraph.BasinInfo Class Reference

Public Member Functions

None __init__ (self)
 
float amountTillOverflow (self)
 
float approxLevel (self)
 
None updateAccVolume (self, float amount)
 
float accVolume (self)
 
None accVolume (self, float arg1)
 
float area (self)
 
None area (self, float arg1)
 
float lastMergeLevel (self)
 
None lastMergeLevel (self, float arg1)
 
float lastMergeVolume (self)
 
None lastMergeVolume (self, float arg1)
 
float lastUpdateAmount (self)
 
None lastUpdateAmount (self, float arg1)
 
float lowestBdLevel (self)
 
None lowestBdLevel (self, float arg1)
 
float lowestLevel (self)
 
None lowestLevel (self, float arg1)
 
VertId lowestVert (self)
 
None lowestVert (self, VertId arg1)
 
float maxVolume (self)
 
None maxVolume (self, float arg1)
 
GraphEdgeId overflowVia (self)
 
None overflowVia (self, GraphEdgeId arg1)
 

Static Public Member Functions

None __init__ (*args, **kwargs)
 
WatershedGraph.BasinInfo operator (*args, **kwargs)
 
WatershedGraph.BasinInfo operator (*args, **kwargs)
 

Static Protected Attributes

typing _offsetof_accVolume = 20
 
typing _offsetof_area = 8
 
typing _offsetof_lastMergeLevel = 28
 
typing _offsetof_lastMergeVolume = 32
 
typing _offsetof_lastUpdateAmount = 24
 
typing _offsetof_lowestBdLevel = 12
 
typing _offsetof_lowestLevel = 4
 
typing _offsetof_lowestVert = 0
 
typing _offsetof_maxVolume = 16
 
typing _offsetof_overflowVia = 36
 

Detailed Description

Generated from:  MR::WatershedGraph::BasinInfo
Aliases:  std_vector_WatershedGraph_BasinInfo_value_type, std_vector_WatershedGraph_BasinInfo_const_reference, Vector_WatershedGraph_BasinInfo_GraphVertId.reference, std_vector_WatershedGraph_BasinInfo_reference, Vector_WatershedGraph_BasinInfo_GraphVertId.const_reference, Vector_WatershedGraph_BasinInfo_GraphVertId.value_type

associated with each vertex in graph

Constructor & Destructor Documentation

◆ __init__() [1/2]

None mrmeshpy.WatershedGraph.BasinInfo.__init__ ( * args,
** kwargs )
static

◆ __init__() [2/2]

None mrmeshpy.WatershedGraph.BasinInfo.__init__ ( self)

Member Function Documentation

◆ accVolume() [1/2]

float mrmeshpy.WatershedGraph.BasinInfo.accVolume ( self)
accumulated water volume in the basin so far

◆ accVolume() [2/2]

None mrmeshpy.WatershedGraph.BasinInfo.accVolume ( self,
float arg1 )

◆ amountTillOverflow()

float mrmeshpy.WatershedGraph.BasinInfo.amountTillOverflow ( self)
amount of precipitation (in same units as mesh coordinates and water level),
which can be added before overflowing the basin

◆ approxLevel()

float mrmeshpy.WatershedGraph.BasinInfo.approxLevel ( self)
approximate current level of water (z-coordinate) in the basin

◆ area() [1/2]

float mrmeshpy.WatershedGraph.BasinInfo.area ( self)
precipitation area that flows in this basin (and if it is full, continue flowing next)

◆ area() [2/2]

None mrmeshpy.WatershedGraph.BasinInfo.area ( self,
float arg1 )

◆ lastMergeLevel() [1/2]

float mrmeshpy.WatershedGraph.BasinInfo.lastMergeLevel ( self)
water level in the basin when it was formed (by merge or creation)

◆ lastMergeLevel() [2/2]

None mrmeshpy.WatershedGraph.BasinInfo.lastMergeLevel ( self,
float arg1 )

◆ lastMergeVolume() [1/2]

float mrmeshpy.WatershedGraph.BasinInfo.lastMergeVolume ( self)
water volume in the basin when it was formed (by merge or creation)

◆ lastMergeVolume() [2/2]

None mrmeshpy.WatershedGraph.BasinInfo.lastMergeVolume ( self,
float arg1 )

◆ lastUpdateAmount() [1/2]

float mrmeshpy.WatershedGraph.BasinInfo.lastUpdateAmount ( self)
the amount when accVolume was last updated

◆ lastUpdateAmount() [2/2]

None mrmeshpy.WatershedGraph.BasinInfo.lastUpdateAmount ( self,
float arg1 )

◆ lowestBdLevel() [1/2]

float mrmeshpy.WatershedGraph.BasinInfo.lowestBdLevel ( self)
lowest position on the boundary of the basin

◆ lowestBdLevel() [2/2]

None mrmeshpy.WatershedGraph.BasinInfo.lowestBdLevel ( self,
float arg1 )

◆ lowestLevel() [1/2]

float mrmeshpy.WatershedGraph.BasinInfo.lowestLevel ( self)
lowest level (z-coordinate of lowestVert) in the basin

◆ lowestLevel() [2/2]

None mrmeshpy.WatershedGraph.BasinInfo.lowestLevel ( self,
float arg1 )

◆ lowestVert() [1/2]

VertId mrmeshpy.WatershedGraph.BasinInfo.lowestVert ( self)
in the whole basin

◆ lowestVert() [2/2]

None mrmeshpy.WatershedGraph.BasinInfo.lowestVert ( self,
VertId arg1 )

◆ maxVolume() [1/2]

float mrmeshpy.WatershedGraph.BasinInfo.maxVolume ( self)
full water volume to be accumulated in the basin till water reaches the lowest height on the boundary

◆ maxVolume() [2/2]

None mrmeshpy.WatershedGraph.BasinInfo.maxVolume ( self,
float arg1 )

◆ operator() [1/2]

WatershedGraph.BasinInfo mrmeshpy.WatershedGraph.BasinInfo.operator ( * args,
** kwargs )
static

◆ operator() [2/2]

WatershedGraph.BasinInfo mrmeshpy.WatershedGraph.BasinInfo.operator ( * args,
** kwargs )
static

◆ overflowVia() [1/2]

GraphEdgeId mrmeshpy.WatershedGraph.BasinInfo.overflowVia ( self)
when level=lowestBdLevel, volume=0, all water from this basin overflows via this boundary

◆ overflowVia() [2/2]

None mrmeshpy.WatershedGraph.BasinInfo.overflowVia ( self,
GraphEdgeId arg1 )

◆ updateAccVolume()

None mrmeshpy.WatershedGraph.BasinInfo.updateAccVolume ( self,
float amount )
updates accumulated volume in the basin to the moment of given precipitation amount

Member Data Documentation

◆ _offsetof_accVolume

typing mrmeshpy.WatershedGraph.BasinInfo._offsetof_accVolume = 20
staticprotected

◆ _offsetof_area

typing mrmeshpy.WatershedGraph.BasinInfo._offsetof_area = 8
staticprotected

◆ _offsetof_lastMergeLevel

typing mrmeshpy.WatershedGraph.BasinInfo._offsetof_lastMergeLevel = 28
staticprotected

◆ _offsetof_lastMergeVolume

typing mrmeshpy.WatershedGraph.BasinInfo._offsetof_lastMergeVolume = 32
staticprotected

◆ _offsetof_lastUpdateAmount

typing mrmeshpy.WatershedGraph.BasinInfo._offsetof_lastUpdateAmount = 24
staticprotected

◆ _offsetof_lowestBdLevel

typing mrmeshpy.WatershedGraph.BasinInfo._offsetof_lowestBdLevel = 12
staticprotected

◆ _offsetof_lowestLevel

typing mrmeshpy.WatershedGraph.BasinInfo._offsetof_lowestLevel = 4
staticprotected

◆ _offsetof_lowestVert

typing mrmeshpy.WatershedGraph.BasinInfo._offsetof_lowestVert = 0
staticprotected

◆ _offsetof_maxVolume

typing mrmeshpy.WatershedGraph.BasinInfo._offsetof_maxVolume = 16
staticprotected

◆ _offsetof_overflowVia

typing mrmeshpy.WatershedGraph.BasinInfo._offsetof_overflowVia = 36
staticprotected

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