Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add documentation for t8_forest_leaf_face_neighbors_ext #1269

Merged
merged 11 commits into from
Oct 16, 2024
5 changes: 5 additions & 0 deletions src/t8_forest/t8_forest_general.h
Original file line number Diff line number Diff line change
Expand Up @@ -571,6 +571,11 @@ t8_forest_leaf_face_neighbors (t8_forest_t forest, t8_locidx_t ltreeid, const t8
t8_locidx_t **pelement_indices, t8_eclass_scheme_c **pneigh_scheme,
int forest_is_balanced);

/** Like \ref t8_forest_leaf_face_neighbors but also provides information about the global neighbors and the orientation.
* \param [out] gneigh_tree The global tree IDs of the neighbor trees.
ole-alb marked this conversation as resolved.
Show resolved Hide resolved
* \param [out] orientation The face orientation is computed and stored there.
ole-alb marked this conversation as resolved.
Show resolved Hide resolved
* All other parameters and behavior are identical to \ref `t8_forest_leaf_face_neighbors`.
*/
ole-alb marked this conversation as resolved.
Show resolved Hide resolved
void
t8_forest_leaf_face_neighbors_ext (t8_forest_t forest, t8_locidx_t ltreeid, const t8_element_t *leaf,
t8_element_t **pneighbor_leaves[], int face, int *dual_faces[], int *num_neighbors,
Expand Down