Function t8_forest_element_is_ghost

Function Documentation

int t8_forest_element_is_ghost(const t8_forest_t forest, const t8_element_t *element, const t8_locidx_t lghost_tree)

Query whether a given element is a ghost of a certrain tree in a forest.

Note

forest must be committed before calling this function.

Parameters:
  • forest[in] The forest.

  • element[in] An element of a ghost tree in forest.

  • lghost_tree[in] A local ghost tree id of forest. (0 <= lghost_tree < num_ghost_trees)

Returns:

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