Function t8_elements_are_family

Function Documentation

int t8_elements_are_family(const t8_scheme_c *scheme, const t8_eclass_t tree_class, t8_element_t *const *fam)

Query whether a given set of elements is a family or not.

Parameters:
  • scheme[in] The scheme of the forest.

  • tree_class[in] The eclass of tree the elements are part of.

  • fam[in] An array of as many elements as an element of class scheme has children.

Returns:

Zero if fam is not a family, nonzero if it is.