Skip to content

Conversation

holke
Copy link
Collaborator

@holke holke commented Jul 30, 2025

Closes #1805

Describe your changes here:

Implements t8_cmesh_get_tree_face_neighbor_eclass

Given a local tree or ghost tree and a face this function returns the eclass of the neighbor tree.
If no neighbor is found it returns T8_ECLASS_INVALID

Added the function to test cases that already compute the face neighbor in order to double check the eclass and the new function.

All these boxes must be checked by the AUTHOR before requesting review:

  • The PR is small enough to be reviewed easily. If not, consider splitting up the changes in multiple PRs.
  • The title starts with one of the following prefixes: Documentation:, Bugfix:, Feature:, Improvement: or Other:.
  • If the PR is related to an issue, make sure to link it.
  • The author made sure that, as a reviewer, he/she would check all boxes below.

All these boxes must be checked by the REVIEWERS before merging the pull request:

As a reviewer please read through all the code lines and make sure that the code is fully understood, bug free, well-documented and well-structured.

General

  • The reviewer executed the new code features at least once and checked the results manually.
  • The code follows the t8code coding guidelines.
  • New source/header files are properly added to the CMake files.
  • The code is well documented. In particular, all function declarations, structs/classes and their members have a proper doxygen documentation.
  • All new algorithms and data structures are sufficiently optimal in terms of memory and runtime (If this should be merged, but there is still potential for optimization, create a new issue).

Tests

  • The code is covered in an existing or new test case using Google Test.
  • The code coverage of the project (reported in the CI) should not decrease. If coverage is decreased, make sure that this is reasonable and acceptable.
  • Valgrind doesn't find any bugs in the new code. This script can be used to check for errors; see also this wiki article.

If the Pull request introduces code that is not covered by the github action (for example coupling with a new library):

  • Should this use case be added to the github action?
  • If not, does the specific use case compile and all tests pass (check manually).

Scripts and Wiki

  • If a new directory with source files is added, it must be covered by the script/find_all_source_files.scp to check the indentation of these files.
  • If this PR introduces a new feature, it must be covered in an example or tutorial and a Wiki article.

License

  • The author added a BSD statement to doc/ (or already has one).

…lass of a cmesh neighbor tree

Given a local tree or ghost tree and a face this function returns the
eclass of the neighbor tree.
If no neighbor is found it returns T8_ECLASS_INVALID
@holke holke added priority:medium Should be solved within half a year workload:low Would take half a day or less labels Jul 30, 2025
Copy link

codecov bot commented Jul 30, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 74.43%. Comparing base (c9f6591) to head (73e18e4).
⚠️ Report is 62 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1806      +/-   ##
==========================================
- Coverage   74.51%   74.43%   -0.09%     
==========================================
  Files         100      101       +1     
  Lines       19104    19203      +99     
==========================================
+ Hits        14236    14293      +57     
- Misses       4868     4910      +42     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@holke holke marked this pull request as draft July 30, 2025 13:28
@holke holke marked this pull request as ready for review July 31, 2025 07:31
Copy link
Collaborator

@Davknapp Davknapp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Only a small change required in my opinion! Thanks for the addition.

}

t8_eclass_t
t8_cmesh_get_tree_face_neighbor_eclass (const t8_cmesh_t cmesh, const t8_locidx_t ltreeid, const int face)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please assert that face is a positive number, or make it an uint.

Copy link
Collaborator Author

@holke holke Aug 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.
Note that t8_cmesh_get_face_neighbor will also performs this check and also check whether face is smaller than the number of faces.
The latter is difficult to check at this place, since we do not have access to the eclass of the tree immediately.
And i figure it is ok to just check against 0 here since t8_cmesh_get_face_neighbor will do the other check.

@holke holke requested a review from Davknapp August 20, 2025 12:01
@holke holke assigned Davknapp and unassigned holke Aug 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority:medium Should be solved within half a year workload:low Would take half a day or less
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Compute the eclass of a neighbor tree in the cmesh
2 participants