mrmeshpy.WatershedGraph.BasinInfo Class Reference

Public Member Functions
None	__init__ (self)
None	__init__ (self, WatershedGraph.BasinInfo arg0)
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 Protected Member Functions
	_pybind11_conduit_v1_ (*args, **kwargs)

Detailed Description

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

associated with each vertex in graph

Constructor & Destructor Documentation

__init__() [1/2]

None mrmeshpy.WatershedGraph.BasinInfo.__init__

(

self

)

__init__() [2/2]

None mrmeshpy.WatershedGraph.BasinInfo.__init__	(		self,
		WatershedGraph.BasinInfo	arg0 )

Implicit copy constructor.

Member Function Documentation

_pybind11_conduit_v1_()

mrmeshpy.WatershedGraph.BasinInfo._pybind11_conduit_v1_ ( * args, ** kwargs )

staticprotected

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 )

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

---

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

• mrmeshpy.pyi