Function t8_forest_pfc_helper_index_in_tree_from_globalid

Function Documentation

void t8_forest_pfc_helper_index_in_tree_from_globalid(const t8_forest_t forest, const t8_gloidx_t gelement_id, t8_gloidx_t &gtree_id, t8_tree_t &tree, t8_locidx_t &index_in_tree, t8_element_t *&element)

Helper function for PFC that computes multiple indices for a given global element ID.

Parameters:
  • forest[in] the forest

  • gelement_id[in] the global element ID

  • gtree_id[out] the global ID of the tree holding the element

  • tree[out] the tree holding the element

  • index_in_tree[out] index of the element within the tree

  • element[out] pointer to the considered element