Function t8_forest_get_leaf_element_in_tree
Defined in File t8_forest_general.h
Function Documentation
-
const t8_element_t *t8_forest_get_leaf_element_in_tree(t8_forest_t forest, t8_locidx_t ltreeid, t8_locidx_t leid_in_tree)
Return a leaf element of a local tree in a forest.
See also
t8_forest_ghost_get_leaf_element_in_tree to access ghost leaf elements.
Note
If the tree id is know, this function should be preferred over t8_forest_get_leaf_element. forest must be committed before calling this function.
- Parameters:
forest – [in] The forest.
ltreeid – [in] An id of a local tree in the forest. Ghost trees are not considered local.
leid_in_tree – [in] The index of a leaf element in the tree.
- Returns:
A pointer to the leaf element.