Inheritance diagram for meshlib.WatershedGraph_BasinInfo:

Public Member Functions
	WatershedGraph_BasinInfo (java.lang.foreign.MemorySegment ptr, boolean owned, java.lang.Object owner)
	WatershedGraph_BasinInfo ()
	WatershedGraph_BasinInfo (meshlib.WatershedGraph_BasinInfo _other)
meshlib.WatershedGraph_BasinInfo	assignFromAnother (meshlib.WatershedGraph_BasinInfo _other)
float	amountTillOverflow ()
float	approxLevel ()
void	updateAccVolume (float amount)
meshlib.VertId	lowestVert ()
void	setLowestVert (meshlib.VertId value)
float	lowestLevel ()
void	setLowestLevel (float value)
float	area ()
void	setArea (float value)
float	lowestBdLevel ()
void	setLowestBdLevel (float value)
float	maxVolume ()
void	setMaxVolume (float value)
float	accVolume ()
void	setAccVolume (float value)
float	lastUpdateAmount ()
void	setLastUpdateAmount (float value)
float	lastMergeLevel ()
void	setLastMergeLevel (float value)
float	lastMergeVolume ()
void	setLastMergeVolume (float value)
meshlib.GraphEdgeId	overflowVia ()
void	setOverflowVia (meshlib.GraphEdgeId value)
Public Member Functions inherited from meshlib.CppObject
final java.lang.foreign.MemorySegment	rawPointer ()
final boolean	isOwned ()
final void	close ()
final java.lang.foreign.MemorySegment	release ()

Additional Inherited Members
Protected Member Functions inherited from meshlib.CppObject
	CppObject (java.lang.foreign.MemorySegment ptr, java.util.function.Consumer< java.lang.foreign.MemorySegment > destroy, java.lang.Object owner)

Detailed Description

associated with each vertex in graph Generated from class MR::WatershedGraph::BasinInfo.

Instances created here own their C++ objects, see CppObject.

Constructor & Destructor Documentation

◆ WatershedGraph_BasinInfo() [1/3]

meshlib.WatershedGraph_BasinInfo.WatershedGraph_BasinInfo	(	java.lang.foreign.MemorySegment	ptr,
		boolean	owned,
		java.lang.Object	owner )

Wraps a pointer from the C bindings. If owned, the object is destroyed when the wrapper dies. owner is kept alive as long as this wrapper is. Not for normal use.

◆ WatershedGraph_BasinInfo() [2/3]

meshlib.WatershedGraph_BasinInfo.WatershedGraph_BasinInfo ( )

Constructs an empty (default-constructed) instance.

Calls MR_WatershedGraph_BasinInfo_DefaultConstruct().

◆ WatershedGraph_BasinInfo() [3/3]

meshlib.WatershedGraph_BasinInfo.WatershedGraph_BasinInfo ( meshlib.WatershedGraph_BasinInfo _other )

Generated from constructor MR::WatershedGraph::BasinInfo::BasinInfo. The reference to things referred to by the parameter _other (if any) might be preserved in the constructed object.

Calls MR_WatershedGraph_BasinInfo_ConstructFromAnother().

Member Function Documentation

◆ accVolume()

float meshlib.WatershedGraph_BasinInfo.accVolume ( )

< accumulated water volume in the basin so far Returns a pointer to a member variable of class MR::WatershedGraph::BasinInfo named accVolume. The reference to this object might be preserved as the return value.

Calls MR_WatershedGraph_BasinInfo_Get_accVolume().

◆ amountTillOverflow()

float meshlib.WatershedGraph_BasinInfo.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.

Calls MR_WatershedGraph_BasinInfo_amountTillOverflow().

◆ approxLevel()

float meshlib.WatershedGraph_BasinInfo.approxLevel ( )

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

Calls MR_WatershedGraph_BasinInfo_approxLevel().

◆ area()

float meshlib.WatershedGraph_BasinInfo.area ( )

< precipitation area that flows in this basin (and if it is full, continue flowing next) Returns a pointer to a member variable of class MR::WatershedGraph::BasinInfo named area. The reference to this object might be preserved as the return value.

Calls MR_WatershedGraph_BasinInfo_Get_area().

◆ assignFromAnother()

meshlib.WatershedGraph_BasinInfo meshlib.WatershedGraph_BasinInfo.assignFromAnother ( meshlib.WatershedGraph_BasinInfo _other )

Generated from method MR::WatershedGraph::BasinInfo::operator=. The reference to things referred to by the parameter _other (if any) might be preserved in this object.

Calls MR_WatershedGraph_BasinInfo_AssignFromAnother().

◆ lastMergeLevel()

float meshlib.WatershedGraph_BasinInfo.lastMergeLevel ( )

< water level in the basin when it was formed (by merge or creation) Returns a pointer to a member variable of class MR::WatershedGraph::BasinInfo named lastMergeLevel. The reference to this object might be preserved as the return value.

Calls MR_WatershedGraph_BasinInfo_Get_lastMergeLevel().

◆ lastMergeVolume()

float meshlib.WatershedGraph_BasinInfo.lastMergeVolume ( )

< water volume in the basin when it was formed (by merge or creation) Returns a pointer to a member variable of class MR::WatershedGraph::BasinInfo named lastMergeVolume. The reference to this object might be preserved as the return value.

Calls MR_WatershedGraph_BasinInfo_Get_lastMergeVolume().

◆ lastUpdateAmount()

float meshlib.WatershedGraph_BasinInfo.lastUpdateAmount ( )

< the amount when accVolume was last updated Returns a pointer to a member variable of class MR::WatershedGraph::BasinInfo named lastUpdateAmount. The reference to this object might be preserved as the return value.

Calls MR_WatershedGraph_BasinInfo_Get_lastUpdateAmount().

◆ lowestBdLevel()

float meshlib.WatershedGraph_BasinInfo.lowestBdLevel ( )

< lowest position on the boundary of the basin Returns a pointer to a member variable of class MR::WatershedGraph::BasinInfo named lowestBdLevel. The reference to this object might be preserved as the return value.

Calls MR_WatershedGraph_BasinInfo_Get_lowestBdLevel().

◆ lowestLevel()

float meshlib.WatershedGraph_BasinInfo.lowestLevel ( )

< lowest level (z-coordinate of lowestVert) in the basin Returns a pointer to a member variable of class MR::WatershedGraph::BasinInfo named lowestLevel. The reference to this object might be preserved as the return value.

Calls MR_WatershedGraph_BasinInfo_Get_lowestLevel().

◆ lowestVert()

meshlib.VertId meshlib.WatershedGraph_BasinInfo.lowestVert ( )

< in the whole basin Returns a pointer to a member variable of class MR::WatershedGraph::BasinInfo named lowestVert. The reference to this object might be preserved as the return value.

Calls MR_WatershedGraph_BasinInfo_Get_lowestVert().

◆ maxVolume()

float meshlib.WatershedGraph_BasinInfo.maxVolume ( )

< full water volume to be accumulated in the basin till water reaches the lowest height on the boundary Returns a pointer to a member variable of class MR::WatershedGraph::BasinInfo named maxVolume. The reference to this object might be preserved as the return value.

Calls MR_WatershedGraph_BasinInfo_Get_maxVolume().

◆ overflowVia()

meshlib.GraphEdgeId meshlib.WatershedGraph_BasinInfo.overflowVia ( )

< when level=lowestBdLevel, volume=0, all water from this basin overflows via this boundary Returns a pointer to a member variable of class MR::WatershedGraph::BasinInfo named overflowVia. The reference to this object might be preserved as the return value.

Calls MR_WatershedGraph_BasinInfo_Get_overflowVia().

◆ setAccVolume()

void meshlib.WatershedGraph_BasinInfo.setAccVolume ( float value )

< accumulated water volume in the basin so far Modifies a member variable of class MR::WatershedGraph::BasinInfo named accVolume.

Calls MR_WatershedGraph_BasinInfo_Set_accVolume().

◆ setArea()

void meshlib.WatershedGraph_BasinInfo.setArea ( float value )

< precipitation area that flows in this basin (and if it is full, continue flowing next) Modifies a member variable of class MR::WatershedGraph::BasinInfo named area.

Calls MR_WatershedGraph_BasinInfo_Set_area().

◆ setLastMergeLevel()

void meshlib.WatershedGraph_BasinInfo.setLastMergeLevel ( float value )

< water level in the basin when it was formed (by merge or creation) Modifies a member variable of class MR::WatershedGraph::BasinInfo named lastMergeLevel.

Calls MR_WatershedGraph_BasinInfo_Set_lastMergeLevel().

◆ setLastMergeVolume()

void meshlib.WatershedGraph_BasinInfo.setLastMergeVolume ( float value )

< water volume in the basin when it was formed (by merge or creation) Modifies a member variable of class MR::WatershedGraph::BasinInfo named lastMergeVolume.

Calls MR_WatershedGraph_BasinInfo_Set_lastMergeVolume().

◆ setLastUpdateAmount()

void meshlib.WatershedGraph_BasinInfo.setLastUpdateAmount ( float value )

< the amount when accVolume was last updated Modifies a member variable of class MR::WatershedGraph::BasinInfo named lastUpdateAmount.

Calls MR_WatershedGraph_BasinInfo_Set_lastUpdateAmount().

◆ setLowestBdLevel()

void meshlib.WatershedGraph_BasinInfo.setLowestBdLevel ( float value )

< lowest position on the boundary of the basin Modifies a member variable of class MR::WatershedGraph::BasinInfo named lowestBdLevel.

Calls MR_WatershedGraph_BasinInfo_Set_lowestBdLevel().

◆ setLowestLevel()

void meshlib.WatershedGraph_BasinInfo.setLowestLevel ( float value )

< lowest level (z-coordinate of lowestVert) in the basin Modifies a member variable of class MR::WatershedGraph::BasinInfo named lowestLevel.

Calls MR_WatershedGraph_BasinInfo_Set_lowestLevel().

◆ setLowestVert()

void meshlib.WatershedGraph_BasinInfo.setLowestVert ( meshlib.VertId value )

< in the whole basin Modifies a member variable of class MR::WatershedGraph::BasinInfo named lowestVert. The reference to the parameter value might be preserved in this object in element lowestVert.

Calls MR_WatershedGraph_BasinInfo_Set_lowestVert().

◆ setMaxVolume()

void meshlib.WatershedGraph_BasinInfo.setMaxVolume ( float value )

< full water volume to be accumulated in the basin till water reaches the lowest height on the boundary Modifies a member variable of class MR::WatershedGraph::BasinInfo named maxVolume.

Calls MR_WatershedGraph_BasinInfo_Set_maxVolume().

◆ setOverflowVia()

void meshlib.WatershedGraph_BasinInfo.setOverflowVia ( meshlib.GraphEdgeId value )

< when level=lowestBdLevel, volume=0, all water from this basin overflows via this boundary Modifies a member variable of class MR::WatershedGraph::BasinInfo named overflowVia. The reference to the parameter value might be preserved in this object in element overflowVia.

Calls MR_WatershedGraph_BasinInfo_Set_overflowVia().

◆ updateAccVolume()

void meshlib.WatershedGraph_BasinInfo.updateAccVolume ( float amount )

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

Calls MR_WatershedGraph_BasinInfo_updateAccVolume().

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

WatershedGraph_BasinInfo.java

Public Member Functions

Additional Inherited Members