Function t8_element_face_get_child_face

Function Documentation

int t8_element_face_get_child_face(const t8_scheme_c *scheme, const t8_eclass_t tree_class, const t8_element_t *element, const int face, const int face_child)

Given a face of an element and a child number of a child of that face, return the face number of the child of the element that matches the child face. 

*  x ---- x   x      x           x ---- x
*  |      |   |      |           |   |  | <-- f
*  |      |   |      x           |   x--x
*  |      |   |                  |      |
*  x ---- x   x                  x ---- x
*   element    face  face_child    Returns the face number f
*
Parameters:

  • scheme – [in] The scheme of the forest.

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

  • element – [in] The element.

  • face – [in] Then number of the face.

  • face_child – [in] A number 0 <= face_child < num_face_children, specifying a child of element that shares a face with face. These children are counted in linear order. This coincides with the order of children from a call to t8_scheme::element_get_children_at_face.

Returns:

The face number of the face of a child of element that coincides with face_child.