meshlib.FlowAggregator Class Reference

Inheritance diagram for meshlib.FlowAggregator:

Public Member Functions
	FlowAggregator (java.lang.foreign.MemorySegment ptr, boolean owned, java.lang.Object owner)
	FlowAggregator (meshlib.FlowAggregator _other)
	FlowAggregator (meshlib.Mesh mesh, meshlib.VertScalars heights)
meshlib.VertScalars	computeFlow (meshlib.std_vector_MR_FlowOrigin starts, meshlib.OutputFlows out)
meshlib.VertScalars	computeFlow (meshlib.std_vector_MR_MeshTriPoint starts, meshlib.OutputFlows out)
meshlib.VertScalars	computeFlow (long numStarts, meshlib.std_function_MR_MeshTriPoint_from_size_t startById, meshlib.std_function_float_from_size_t amountById, meshlib.std_function_const_MR_FaceBitSet_ptr_from_size_t regionById, meshlib.OutputFlows out)
meshlib.phmap.phmap_flat_hash_map_MR_VertId_MR_FlowAggregator_Flows_phmap_Hash_MR_VertId_phmap_EqualTo_MR_VertId_M__e593e025	computeFlowsPerBasin (meshlib.std_vector_MR_FlowOrigin starts)
meshlib.phmap.phmap_flat_hash_map_MR_VertId_MR_FlowAggregator_Flows_phmap_Hash_MR_VertId_phmap_EqualTo_MR_VertId_M__e593e025	computeFlowsPerBasin (meshlib.std_vector_MR_MeshTriPoint starts)
meshlib.phmap.phmap_flat_hash_map_MR_VertId_MR_FlowAggregator_Flows_phmap_Hash_MR_VertId_phmap_EqualTo_MR_VertId_M__e593e025	computeFlowsPerBasin (long numStarts, meshlib.std_function_MR_MeshTriPoint_from_size_t startById, meshlib.std_function_float_from_size_t amountById)
meshlib.UndirectedEdgeBitSet	computeCatchmentDelineation ()
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

this class can track multiple flows and find in each mesh vertex the amount of water reached it Generated from class MR::FlowAggregator.

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

Constructor & Destructor Documentation

FlowAggregator() [1/3]

meshlib.FlowAggregator.FlowAggregator	(	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.

FlowAggregator() [2/3]

meshlib.FlowAggregator.FlowAggregator

(

meshlib.FlowAggregator

_other

)

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

Calls MR_FlowAggregator_ConstructFromAnother().

FlowAggregator() [3/3]

meshlib.FlowAggregator.FlowAggregator	(	meshlib.Mesh	mesh,
		meshlib.VertScalars	heights )

prepares the processing of given mesh with given height in each vertex Generated from constructor MR::FlowAggregator::FlowAggregator. The reference to the parameter mesh might be preserved in the constructed object. The reference to the parameter heights might be preserved in the constructed object.

Calls MR_FlowAggregator_Construct().

Member Function Documentation

computeCatchmentDelineation()

meshlib.UndirectedEdgeBitSet meshlib.FlowAggregator.computeCatchmentDelineation

(

)

finds the edges on the mesh that divides catchment basin (every triangle is attributed to the final destination point based on the path originated from its centroid) Generated from method MR::FlowAggregator::computeCatchmentDelineation.

Calls MR_FlowAggregator_computeCatchmentDelineation().

computeFlow() [1/3]

meshlib.VertScalars meshlib.FlowAggregator.computeFlow	(	long	numStarts,
		meshlib.std_function_MR_MeshTriPoint_from_size_t	startById,
		meshlib.std_function_float_from_size_t	amountById,
		meshlib.std_function_const_MR_FaceBitSet_ptr_from_size_t	regionById,
		meshlib.OutputFlows	out )

general version that supplies starts in a functional way Generated from method MR::FlowAggregator::computeFlow.

Calls MR_FlowAggregator_computeFlow_5().

computeFlow() [2/3]

meshlib.VertScalars meshlib.FlowAggregator.computeFlow	(	meshlib.std_vector_MR_FlowOrigin	starts,
		meshlib.OutputFlows	out )

tracks multiple flows

Parameters

starts

the origin of each flow (should be uniformly sampled over the terrain)

Returns

the flow reached each mesh vertex Generated from method MR::FlowAggregator::computeFlow.

Calls MR_FlowAggregator_computeFlow_2_std_vector_MR_FlowOrigin().

computeFlow() [3/3]

meshlib.VertScalars meshlib.FlowAggregator.computeFlow	(	meshlib.std_vector_MR_MeshTriPoint	starts,
		meshlib.OutputFlows	out )

same with all amounts equal to 1 Generated from method MR::FlowAggregator::computeFlow.

Calls MR_FlowAggregator_computeFlow_2_std_vector_MR_MeshTriPoint().

computeFlowsPerBasin() [1/3]

meshlib.phmap.phmap_flat_hash_map_MR_VertId_MR_FlowAggregator_Flows_phmap_Hash_MR_VertId_phmap_EqualTo_MR_VertId_M__e593e025 meshlib.FlowAggregator.computeFlowsPerBasin	(	long	numStarts,
		meshlib.std_function_MR_MeshTriPoint_from_size_t	startById,
		meshlib.std_function_float_from_size_t	amountById )

general version that supplies starts in a functional way Generated from method MR::FlowAggregator::computeFlowsPerBasin.

Calls MR_FlowAggregator_computeFlowsPerBasin_3().

computeFlowsPerBasin() [2/3]

meshlib.phmap.phmap_flat_hash_map_MR_VertId_MR_FlowAggregator_Flows_phmap_Hash_MR_VertId_phmap_EqualTo_MR_VertId_M__e593e025 meshlib.FlowAggregator.computeFlowsPerBasin

(

meshlib.std_vector_MR_FlowOrigin

starts

)

tracks multiple flows

Parameters

starts

the origin of each flow (should be uniformly sampled over the terrain)

Returns

the flows grouped by the final destination vertex Generated from method MR::FlowAggregator::computeFlowsPerBasin.

Calls MR_FlowAggregator_computeFlowsPerBasin_1_std_vector_MR_FlowOrigin().

computeFlowsPerBasin() [3/3]

meshlib.phmap.phmap_flat_hash_map_MR_VertId_MR_FlowAggregator_Flows_phmap_Hash_MR_VertId_phmap_EqualTo_MR_VertId_M__e593e025 meshlib.FlowAggregator.computeFlowsPerBasin

(

meshlib.std_vector_MR_MeshTriPoint

starts

)

same with all amounts equal to 1 Generated from method MR::FlowAggregator::computeFlowsPerBasin.

Calls MR_FlowAggregator_computeFlowsPerBasin_1_std_vector_MR_MeshTriPoint().

---

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

• FlowAggregator.java