Function t8_forest_iterate_faces

Function Documentation

void t8_forest_iterate_faces(const t8_forest_t forest, const t8_locidx_t ltreeid, const t8_element_t *element, const int face, const t8_element_array_t *leaf_elements, void *user_data, const t8_locidx_t tree_lindex_of_first_leaf, const t8_forest_iterate_face_fn callback)

Iterate over all leaves of an element that touch a given face of the element.

Callback is called in each recursive step with element as input. leaf_index is only not negative if element is a leaf, in which case it indicates the index of the leaf in the leaves of the tree. If it is negative, it is

  • (index + 1) Top-down iteration and callback is called on each intermediate level. If it returns false, the current element is not traversed further

Parameters:

  • forest – [in] A committed forest.

  • ltreeid – [in] Local index of the tree containing the element.

  • element – [in] The considered element.

  • face – [in] The integer index of the considered face of element.

  • leaf_elements – [in] The array of leaf elements that are descendants of element. Sorted by linear index.

  • user_data – [in] The user data passed to the callback function.

  • tree_lindex_of_first_leaf – [in] Tree-local index of the first leaf.

  • callback – [in] The callback function.