Function t8_forest_is_incomplete_family

Function Documentation

int t8_forest_is_incomplete_family(const t8_forest_t forest, const t8_locidx_t ltree_id, const t8_locidx_t el_considered, t8_element_t **elements, const int elements_size)

Check whether or not elements contains a (in)complete family and return the size of it or zero if no family is considered.

See also

t8_elements_are_family is recommended.

Note

The check works for complete and incomplete forests. In the case of complete forests, the scheme based element function

Note

If the element with id el_considered is not the first family member, return 0. Therefore, if return is x > 0, the first x elements in elements form a family.

Parameters:

  • forest – [in] The forest.

  • ltree_id – [in] The index of considered local tree.

  • el_considered – [in] The local id of the first element in elements in the local tree of the forest.

  • elements – [in] Array of elements to consider.

  • elements_size – [in] Number of elements in elements.

Returns:

Size of family or zero, if elements does not contain a family.