Function t8_forest_get_leaf_element

Function Documentation

t8_element_t *t8_forest_get_leaf_element(t8_forest_t forest, t8_locidx_t lelement_id, t8_locidx_t *ltreeid)

Return a leaf element of the forest.

See also

t8_forest_ghost_get_leaf_element to access ghost leaf elements.

Note

This function performs a binary search. For constant access, use t8_forest_get_leaf_element_in_tree forest must be committed before calling this function.

Parameters:

  • forest – [in] The forest.

  • lelement_id – [in] The local id of a leaf element in forest.

  • ltreeid – [out] If not NULL, on output the local tree id of the tree in which the leaf element lies in.

Returns:

A pointer to the leaf element. NULL if this element does not exist. Ghost elements are not considered as local.