Function t8_forest_search_partition

Function Documentation

void t8_forest_search_partition(const t8_forest_t forest, t8_forest_partition_search_fn search_fn, t8_forest_partition_query_fn query_fn, sc_array_t *queries)

Perform a top-down search of the global partition, executing a callback on each intermediate element.

The search will enter each tree at least once. The recursion will only go down branches that are split between multiple processors. This is not a collective function. It does not communicate. The function expects the coarse mesh to be replicated. If the callback returns false for an element, its descendants are not further searched. To pass user data to search_fn function use t8_forest_set_user_data

Parameters:

  • forest – [in] the forest to be searched

  • search_fn – [in] a search callback function called on elements

  • query_fn – [in] a query callback function called for all active queries of an element

  • queries – [inout] an array of queries that are checked by the function