Function t8_forest_element_neighbor_eclass

• Defined in File t8_forest_general.h

Function Documentation

t8_eclass_t t8_forest_element_neighbor_eclass(const t8_forest_t forest, const t8_locidx_t ltreeid, const t8_element_t *elem, const int face)

Return the eclass of the tree in which a face neighbor of a given element or ghost lies.

Parameters:

• forest – [in] A committed forest.

• ltreeid – [in] The local tree or ghost tree in which the element lies. 0 <= ltreeid < num_local_trees + num_ghost_trees

• elem – [in] An element or ghost in the tree ltreeid.

• face – [in] A face number of elem.

Returns:

The eclass of the local tree or ghost tree that is face neighbor of elem across face. T8_ECLASS_INVALID if no neighbor exists.