Skip to content

Improvement: Add test for (rather new) function t8_forest_leaf_neighbor_subface - #2388

Open
spenke91 wants to merge 6 commits into
mainfrom
test_neighbor_surface_helper
Open

Improvement: Add test for (rather new) function t8_forest_leaf_neighbor_subface#2388
spenke91 wants to merge 6 commits into
mainfrom
test_neighbor_surface_helper

Conversation

@spenke91

@spenke91 spenke91 commented Aug 4, 2026

Copy link
Copy Markdown
Collaborator

Closes #2295

Describe your changes here:

Adds a test to the function t8_forest_leaf_neighbor_subface added in #2216 .

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. Make sure to add a file documentation for each file!
  • README.md files are updated if necessary.
  • 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 scripts/internal/find_all_source_files.sh 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).

@codecov

codecov Bot commented Aug 4, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 82.36%. Comparing base (a75bc50) to head (c90e7cf).

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2388      +/-   ##
==========================================
+ Coverage   82.28%   82.36%   +0.08%     
==========================================
  Files         125      125              
  Lines       20703    20709       +6     
==========================================
+ Hits        17035    17057      +22     
+ Misses       3668     3652      -16     

☔ View full report in Codecov by Harness.
📢 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.

@lenaploetzke lenaploetzke left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Thanks for adding the test, i have some first comments for you :)

Comment thread src/t8_forest/t8_forest.cxx
Comment thread src/t8_forest/t8_forest.cxx Outdated
Comment thread src/t8_forest/t8_forest.cxx Outdated
Comment thread test/t8_forest/t8_gtest_leaf_face_neighbors.cxx Outdated
Comment thread test/t8_forest/t8_gtest_leaf_face_neighbors.cxx Outdated
Comment thread test/t8_forest/t8_gtest_leaf_face_neighbors.cxx Outdated
Comment thread test/t8_forest/t8_gtest_leaf_face_neighbors.cxx Outdated
Comment thread test/t8_forest/t8_gtest_leaf_face_neighbors.cxx Outdated
Comment thread test/t8_forest/t8_gtest_leaf_face_neighbors.cxx Outdated
Comment thread test/t8_forest/t8_gtest_leaf_face_neighbors.cxx Outdated
@spenke91 spenke91 assigned lenaploetzke and unassigned spenke91 Aug 20, 2026
@spenke91

Copy link
Copy Markdown
Collaborator Author

Thanks for your review, @lenaploetzke! I incorporated your suggestions 👍

@lenaploetzke lenaploetzke left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Very nice, nearly ready to merge.

Comment thread src/t8_forest/t8_forest.cxx
[&] (t8_element *candidate) -> bool {
return scheme->element_compare (neighbor_tree_class, target_virtual_face_neighbor, candidate) == 0;
});
T8_ASSERT (iter != neigh_children_at_face.end ()); // make sure target_virtual_face_neighbor was found

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Maybe also better in relation to num_neighbor_face_children?

const int is_family, const int num_elements, t8_element_t *elements[]);

/**
* Adapt callback that refines every n-th local element, where \a n is given as template parameter.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Oh nice idea! Also used a similar callback in a subelement PR with n=2, we can reuse it then ;)

{
protected:
/**
* \brief Set the Up test suite.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

haha

Suggested change
* \brief Set the Up test suite.
* \brief Set up the test suite.

Comment thread test/t8_forest/t8_gtest_leaf_face_neighbors.cxx
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Improvement: Cover t8_forest_leaf_neighbor_subface in a test case

2 participants