MeshLib Rust Docs
Loading...
Searching...
No Matches
meshlib::FlowAggregator Struct Reference
Inheritance diagram for meshlib::FlowAggregator:

Public Member Functions

auto compute_flow_2_std_vector_mr_flow_origin (starts:&meshlib::std_vector_MR_FlowOrigin, out:Option<&meshlib::OutputFlows >) const -> meshlib::Owned< meshlib::VertScalars >
auto compute_flow_2_std_vector_mr_mesh_tri_point (starts:&meshlib::std_vector_MR_MeshTriPoint, out:Option<&meshlib::OutputFlows >) const -> meshlib::Owned< meshlib::VertScalars >
auto compute_flow_5 (numStarts:usize, startById:&meshlib::std_function_MR_MeshTriPoint_from_size_t, amountById:&meshlib::std_function_float_from_size_t, regionById:&meshlib::std_function_const_MR_FaceBitSet_ptr_from_size_t, out:Option<&meshlib::OutputFlows >) const -> meshlib::Owned< meshlib::VertScalars >
auto compute_flows_per_basin_1_std_vector_mr_flow_origin (starts:&meshlib::std_vector_MR_FlowOrigin) const -> meshlib::Owned< meshlib::phmap::phmap_flat_hash_map_MR_VertId_MR_FlowAggregator_Flows_phmap_Hash_MR_VertId_phmap_EqualTo_MR_VertId_MR_Allocator_std_pair_const_MR_VertId_MR_FlowAggregator_Flows >
auto compute_flows_per_basin_1_std_vector_mr_mesh_tri_point (starts:&meshlib::std_vector_MR_MeshTriPoint) const -> meshlib::Owned< meshlib::phmap::phmap_flat_hash_map_MR_VertId_MR_FlowAggregator_Flows_phmap_Hash_MR_VertId_phmap_EqualTo_MR_VertId_MR_Allocator_std_pair_const_MR_VertId_MR_FlowAggregator_Flows >
auto compute_flows_per_basin_3 (numStarts:usize, startById:&meshlib::std_function_MR_MeshTriPoint_from_size_t, amountById:&meshlib::std_function_float_from_size_t) const -> meshlib::Owned< meshlib::phmap::phmap_flat_hash_map_MR_VertId_MR_FlowAggregator_Flows_phmap_Hash_MR_VertId_phmap_EqualTo_MR_VertId_MR_Allocator_std_pair_const_MR_VertId_MR_FlowAggregator_Flows >
auto compute_catchment_delineation () const -> meshlib::Owned< meshlib::UndirectedEdgeBitSet >

Static Public Member Functions

static auto construct_from_another (_other:&meshlib::FlowAggregator) -> meshlib::Owned< meshlib::FlowAggregator >
static auto construct (mesh:&meshlib::Mesh, heights:&meshlib::VertScalars) -> meshlib::Owned< meshlib::FlowAggregator >
Static Public Member Functions inherited from meshlib::CppClass
static void destroy (ptr:*mut Self)
Static Public Member Functions inherited from meshlib::CppCopy
static auto copy (ptr:*const Self) -> *mut Self

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.

Generated from class MR::FlowAggregator. Heap-allocated instances are held in Owned<FlowAggregator>.

Member Function Documentation

◆ compute_catchment_delineation()

auto meshlib::FlowAggregator::compute_catchment_delineation ( ) const -> meshlib::Owned< meshlib::UndirectedEdgeBitSet >

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().

◆ compute_flow_2_std_vector_mr_flow_origin()

auto meshlib::FlowAggregator::compute_flow_2_std_vector_mr_flow_origin ( starts:&meshlib::std_vector_MR_FlowOrigin ,
out:Option<&meshlib::OutputFlows >  ) const -> meshlib::Owned< meshlib::VertScalars >

tracks multiple flows

Parameters
startsthe 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().

◆ compute_flow_2_std_vector_mr_mesh_tri_point()

auto meshlib::FlowAggregator::compute_flow_2_std_vector_mr_mesh_tri_point ( starts:&meshlib::std_vector_MR_MeshTriPoint ,
out:Option<&meshlib::OutputFlows >  ) const -> meshlib::Owned< meshlib::VertScalars >

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

Calls MR_FlowAggregator_computeFlow_2_std_vector_MR_MeshTriPoint().

◆ compute_flow_5()

auto meshlib::FlowAggregator::compute_flow_5 ( numStarts:usize ,
startById:&meshlib::std_function_MR_MeshTriPoint_from_size_t ,
amountById:&meshlib::std_function_float_from_size_t ,
regionById:&meshlib::std_function_const_MR_FaceBitSet_ptr_from_size_t ,
out:Option<&meshlib::OutputFlows >  ) const -> meshlib::Owned< meshlib::VertScalars >

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

Calls MR_FlowAggregator_computeFlow_5().

◆ compute_flows_per_basin_1_std_vector_mr_flow_origin()

tracks multiple flows

Parameters
startsthe 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().

◆ compute_flows_per_basin_1_std_vector_mr_mesh_tri_point()

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

Calls MR_FlowAggregator_computeFlowsPerBasin_1_std_vector_MR_MeshTriPoint().

◆ compute_flows_per_basin_3()

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

Calls MR_FlowAggregator_computeFlowsPerBasin_3().

◆ construct()

auto meshlib::FlowAggregator::construct ( mesh:&meshlib::Mesh ,
heights:&meshlib::VertScalars  ) -> meshlib::Owned< meshlib::FlowAggregator >
static

prepares the processing of given mesh with given height in each vertex Generated from constructor MR::FlowAggregator::FlowAggregator.

Calls MR_FlowAggregator_Construct(). 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.

◆ construct_from_another()

auto meshlib::FlowAggregator::construct_from_another ( _other:&meshlib::FlowAggregator ) -> meshlib::Owned< meshlib::FlowAggregator >
static

Generated from constructor MR::FlowAggregator::FlowAggregator.

Calls MR_FlowAggregator_ConstructFromAnother(). The reference to things referred to by the parameter _other (if any) might be preserved in the constructed object.


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