Function t8_forest_element_is_leaf_or_ghost

Function Documentation

int t8_forest_element_is_leaf_or_ghost(const t8_forest_t forest, const t8_element_t *element, const t8_locidx_t local_tree, const int check_ghost)

Query whether a given element or a ghost is a leaf of a local or ghost tree in a forest.

Note

forest must be committed before calling this function. t8_forest_element_is_leaf t8_forest_element_is_ghost

Parameters:

  • forest – [in] The forest.

  • element – [in] An element of a local tree in forest.

  • local_tree – [in] A local tree id of forest or a ghost tree id

  • check_ghost – [in] If true element is interpreted as a ghost element and local_tree as the id of a ghost tree (0 <= local_tree < num_ghost_trees). If false element is interpreted as an element and local_tree as the id of a local tree (0 <= local_tree < num_local_trees).

Returns:

True (non-zero) if and only if element is a leaf (or ghost) in local_tree of forest.