Function t8_element_get_face_neighbor_inside

• Defined in File t8_scheme.h

Function Documentation

int t8_element_get_face_neighbor_inside(const t8_scheme_c *scheme, const t8_eclass_t tree_class, const t8_element_t *element, t8_element_t *neigh, const int face, int *neigh_face)

Construct the face neighbor of a given element if this face neighbor is inside the root tree.

Return 0 otherwise.

Parameters:

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

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

• element – [in] The element to be considered.

• neigh – [inout] If the face neighbor of element along face is inside the root tree, this element’s data is filled with the data of the face neighbor. Otherwise the data can be modified arbitrarily.

• face – [in] The number of the face along which the neighbor should be constructed.

• neigh_face – [out] The number of face as viewed from neigh. An arbitrary value, if the neighbor is not inside the root tree.

Returns:

True if neigh is inside the root tree. False if not. In this case neigh’s data can be arbitrary on output.