graphs representing rain basins on the mesh Generated from class MR.WatershedGraph. This is the const half of the class. More...

Inheritance diagram for MR.Const_WatershedGraph:

Classes
class	_InOptConst_BasinInfo
	This is used for optional parameters of class `BasinInfo` with default arguments. This is only used const parameters. For non-const ones we have `_InOptMut_BasinInfo`. Usage: More...

class	_InOptConst_BdInfo
	This is used for optional parameters of class `BdInfo` with default arguments. This is only used const parameters. For non-const ones we have `_InOptMut_BdInfo`. Usage: More...

class	_InOptConst_OverflowPoint
	This is used for optional parameters of class `OverflowPoint` with default arguments. This is only used const parameters. For non-const ones we have `_InOptMut_OverflowPoint`. Usage: More...

class	_InOptMut_BasinInfo
	This is used for optional parameters of class `BasinInfo` with default arguments. This is only used mutable parameters. For const ones we have `_InOptConst_BasinInfo`. Usage: More...

class	_InOptMut_BdInfo
	This is used for optional parameters of class `BdInfo` with default arguments. This is only used mutable parameters. For const ones we have `_InOptConst_BdInfo`. Usage: More...

class	_InOptMut_OverflowPoint
	This is used for optional parameters of class `OverflowPoint` with default arguments. This is only used mutable parameters. For const ones we have `_InOptConst_OverflowPoint`. Usage: More...

struct	_Underlying

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

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

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

class	Const_BdInfo
	associated with each edge in graph Generated from class `MR.WatershedGraph.BdInfo`. This is the const half of the class. More...

class	Const_OverflowPoint
	describes a point where a flow from one basin overflows into another basin Generated from class `MR.WatershedGraph.OverflowPoint`. This is the const half of the class. More...

class	OverflowPoint
	describes a point where a flow from one basin overflows into another basin Generated from class `MR.WatershedGraph.OverflowPoint`. This is the non-const half of the class. More...

Public Member Functions
virtual void	Dispose ()

unsafe	Const_WatershedGraph (MR._ByValue_WatershedGraph _other)
	Generated from constructor `MR.WatershedGraph.WatershedGraph`.

unsafe	Const_WatershedGraph (MR.Const_Mesh mesh, MR.Const_Vector_Int_MRFaceId face2basin, int numBasins)
	constructs the graph from given mesh, heights in z-coordinate, and initial subdivision on basins Generated from constructor `MR.WatershedGraph.WatershedGraph`.

unsafe float	getHeightAt (MR.VertId v)
	returns height at given vertex or FLT_MAX if the vertex is invalid Generated from method `MR.WatershedGraph.getHeightAt`.

unsafe MR.Const_Graph	graph ()
	returns underlying graph where each basin is a vertex Generated from method `MR.WatershedGraph.graph`.

unsafe float	totalArea ()
	returns total precipitation area Generated from method `MR.WatershedGraph.totalArea`.

unsafe int	numBasins ()
	returns the current number of basins (excluding special "outside" basin) Generated from method `MR.WatershedGraph.numBasins`.

unsafe MR.WatershedGraph.Const_BasinInfo	basinInfo (MR.GraphVertId v)
	returns data associated with given basin Generated from method `MR.WatershedGraph.basinInfo`.

unsafe MR.WatershedGraph.Const_BdInfo	bdInfo (MR.GraphEdgeId e)
	returns data associated with given boundary between basins Generated from method `MR.WatershedGraph.bdInfo`.

unsafe MR.GraphVertId	outsideId ()
	returns special "basin" representing outside areas of the mesh Generated from method `MR.WatershedGraph.outsideId`.

unsafe MR.GraphVertId	getRootBasin (MR.GraphVertId v)
	for valid basin returns self id; for invalid basin returns the id of basin it was merged in Generated from method `MR.WatershedGraph.getRootBasin`.

unsafe MR.GraphVertId	flowsTo (MR.GraphVertId v)
	returns the basin where the flow from this basin goes next (it can be self id if the basin is not full yet) Generated from method `MR.WatershedGraph.flowsTo`.

unsafe MR.GraphVertId	flowsFinallyTo (MR.GraphVertId v, bool? exceptOutside=null)
	returns the basin where the flow from this basin finally goes (it can be self id if the basin is not full yet);

unsafe MR.Std.Pair_MRGraphEdgeId_Float	findLowestBd ()
	finds the lowest boundary between basins and its height, which is defined as the minimal different between lowest boundary point and lowest point in a basin Generated from method `MR.WatershedGraph.findLowestBd`.

unsafe MR.FaceBitSet	getBasinFaces (MR.GraphVertId basin)
	returns the mesh faces of given basin Generated from method `MR.WatershedGraph.getBasinFaces`.

unsafe MR.Vector_MRFaceBitSet_MRGraphVertId	getAllBasinFaces (bool? joinOverflowBasins=null)
	returns the mesh faces of each valid basin;

unsafe MR.FaceBitSet	getBasinFacesBelowLevel (MR.GraphVertId basin, float waterLevel)
	returns the mesh faces of given basin with at least one vertex below given level Generated from method `MR.WatershedGraph.getBasinFacesBelowLevel`.

unsafe double	computeBasinVolume (MR.GraphVertId basin, float waterLevel)
	returns water volume in basin when its surface reaches given level, which must be in between the lowest basin level and the lowest level on basin's boundary Generated from method `MR.WatershedGraph.computeBasinVolume`.

unsafe MR.UndirectedEdgeBitSet	getInterBasinEdges (bool? joinOverflowBasins=null)
	returns the mesh edges between current basins

unsafe MR.Std.Vector_MRWatershedGraphOverflowPoint	getOverflowPoints ()
	returns all overflow points in the graph Generated from method `MR.WatershedGraph.getOverflowPoints`.

unsafe MR.Vector_MRGraphVertId_MRGraphVertId	iniBasin2Tgt (bool? joinOverflowBasins=null)
	computes a map from initial basin id to a valid basin in which it was merged

Protected Member Functions
virtual unsafe void	Dispose (bool disposing)

Additional Inherited Members
Protected Attributes inherited from MR.Misc.Object< Const_WatershedGraph >
bool	_IsOwningVal

Properties inherited from MR.Misc.Object< Const_WatershedGraph >
virtual bool	_IsOwning `[get]`
	Returns true if this is an owning instance, and when disposed, will destroy the underlying C++ instance. If false, we assume that the underlying C++ instance will live long enough.

Detailed Description

graphs representing rain basins on the mesh Generated from class MR.WatershedGraph. This is the const half of the class.

Member Function Documentation

◆ flowsFinallyTo()

unsafe MR.GraphVertId MR.Const_WatershedGraph.flowsFinallyTo	(	MR.GraphVertId	v,
		bool?	exceptOutside = null )

inline

returns the basin where the flow from this basin finally goes (it can be self id if the basin is not full yet);

Parameters

exceptOutside if true then the method returns the basin that receives water flow from (v) just before outside Generated from method MR.WatershedGraph.flowsFinallyTo. Parameter exceptOutside defaults to false.

◆ getAllBasinFaces()

unsafe MR.Vector_MRFaceBitSet_MRGraphVertId MR.Const_WatershedGraph.getAllBasinFaces ( bool? joinOverflowBasins = null )

inline

returns the mesh faces of each valid basin;

Parameters

joinOverflowBasins if true then overflowing basins will be merged in the target basins (except for overflow in outside) Generated from method MR.WatershedGraph.getAllBasinFaces. Parameter joinOverflowBasins defaults to false.

◆ getInterBasinEdges()

unsafe MR.UndirectedEdgeBitSet MR.Const_WatershedGraph.getInterBasinEdges ( bool? joinOverflowBasins = null )

inline

returns the mesh edges between current basins

Parameters

joinOverflowBasins if true then overflowing basins will be merged in the target basins (except for overflow in outside) Generated from method MR.WatershedGraph.getInterBasinEdges. Parameter joinOverflowBasins defaults to false.

◆ iniBasin2Tgt()

unsafe MR.Vector_MRGraphVertId_MRGraphVertId MR.Const_WatershedGraph.iniBasin2Tgt ( bool? joinOverflowBasins = null )

inline

computes a map from initial basin id to a valid basin in which it was merged

Parameters

joinOverflowBasins if true then overflowing basins will be merged in the target basins (except for overflow in outside) Generated from method MR.WatershedGraph.iniBasin2Tgt. Parameter joinOverflowBasins defaults to false.

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

MRWatershedGraph.cs

Classes

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ flowsFinallyTo()

◆ getAllBasinFaces()

◆ getInterBasinEdges()

◆ iniBasin2Tgt()