Function t8_forest_pfc_extreme_local_sibling

• Defined in File t8_forest_pfc_helper.hxx

Function Documentation

t8_locidx_t t8_forest_pfc_extreme_local_sibling(const t8_scheme_c *scheme, t8_tree_t tree, const t8_locidx_t start_element_id_in_tree, const int signed_increment)

Determine the sibling with the biggest difference in IDs (in the given direction).

Parameters:

• scheme – [in] the refinement scheme

• tree – [in] the considered tree

• start_element_id_in_tree – [in] the tree-internal ID of the considered element

• signed_increment – [in] increment determining the search direction. Has to be either -1 (decreasing IDs) or +1 (increasing IDs).

Returns:

The extreme sibling ID within tree, i.e., the tree-internal ID of the sibling with the biggest difference to start_element_id_in_tree.