Improvement: Add test for (rather new) function t8_forest_leaf_neighbor_subface by spenke91 · Pull Request #2388 · DLR-AMR/t8code

spenke91 · 2026-08-04T11:23:10Z

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).

…or_subface

…_helper

codecov · 2026-08-04T11:44:41Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 82.36%. Comparing base (add658b) to head (896779d).
⚠️ Report is 6 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2388      +/-   ##
==========================================
+ Coverage   82.28%   82.36%   +0.08%     
==========================================
  Files         125      125              
  Lines       20701    20706       +5     
==========================================
+ Hits        17033    17054      +21     
+ 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

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

lenaploetzke · 2026-08-19T13:26:27Z

+              "t8_forest_leaf_neighbor_subface requires leaf neighbor to be one level coarser!\n");
+#endif
+
+  // Determine the virtual face neighbor of leaf along face.


I like the addition of comments! Can you also explain why we need a virtual neighbor here?

lenaploetzke · 2026-08-19T13:28:44Z

+  // Determine the neighbor_leaf's children at neighbor_face (i.e., at the dual face of face).
+  std::array<t8_element_t *, T8_ECLASS_MAX_FACE_CHILDREN>
+    neigh_children_at_face;  // assumes the forest is (locally) 2:1 balanced
+  scheme->element_new (neighbor_tree_class, neigh_children_at_face.size (), neigh_children_at_face.begin ());


Isnt it enough to use num_neighbor_face_children instead of the size?

lenaploetzke · 2026-08-19T13:32:00Z

-                                        num_children, nullptr);
+  // Find out which entry of neigh_children_at_face is equal to target_virtual_face_neighbor.
+  auto iter = std::find_if (
+    neigh_children_at_face.begin (), neigh_children_at_face.end (), [&] (t8_element *candidate) -> bool {


I think here also end() is not necessary but only neigh_children_at_face.begin()+num_neighbor_face_children right?

lenaploetzke · 2026-08-19T13:35:17Z


 INSTANTIATE_TEST_SUITE_P (t8_gtest_face_neighbors, forest_face_neighbors_two_quad_mesh, AllSchemeCollections);
+
+/**


We have a t8_gtest_adapt_callback file (where we define one test callback at the moment), i think this one could be a cool addition (such that we can reuse it in other tests). What do you think?

lenaploetzke · 2026-08-19T13:37:32Z

+/**
+ * \brief Class to test the functionality of \b t8_forest_leaf_neighbor_subface.
+ */
+class forest_face_neighbors_subface: public testing::TestWithParam<std::tuple<int, cmesh_example_base *> > {


lenaploetzke · 2026-08-19T13:44:45Z

+  void
+  TearDown () override
+  {
+    // Unref the


lenaploetzke · 2026-08-19T13:45:25Z

+  // ----------------------------------------------------------
+  // -------- LOOP 1: Iterate over all local trees.
+  // ----------------------------------------------------------
+  for (int itree = 0; itree < num_local_trees; itree++) {


Suggested change

for (int itree = 0; itree < num_local_trees; itree++) {

for (t8_locidx_t itree = 0; itree < num_local_trees; itree++) {

?

lenaploetzke · 2026-08-19T13:45:37Z

+    // ----------------------------------------------------------
+    // -------- LOOP 2: Iterate over all local elements in the tree.
+    // ----------------------------------------------------------
+    for (int ielem_tree = 0; ielem_tree < num_elems_tree; ielem_tree++) {


Same as above

lenaploetzke · 2026-08-19T13:46:31Z

+            int check_face = -1;
+            int neigh_child_to_check = -1;
+            int i_child_at_face = -1;
+            ;


Suggested change

;

?

lenaploetzke · 2026-08-19T13:53:51Z

+            // Make sure the face relation is also correct.
+            EXPECT_EQ (iface, dual_dual_face);
+
+            // (7.) Free memory of neigh_children and checkelem


Suggested change

// (7.) Free memory of neigh_children and checkelem

// (7.) Free memory of neigh_children and check_elem

spenke91 added 4 commits August 4, 2026 13:20

Improvement: Add test for (rather new) function t8_forest_leaf_neighb…

49b8ac3

…or_subface

Merge remote-tracking branch 'origin/main' into test_neighbor_surface…

aaea356

…_helper

Minor fix of hard-coded 4

68c93c7

Typos and indentation

896779d

lenaploetzke reviewed Aug 19, 2026

View reviewed changes

lenaploetzke assigned spenke91 Aug 19, 2026

Navigation Menu

Uh oh!

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

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

spenke91 commented Aug 4, 2026

Uh oh!

codecov Bot commented Aug 4, 2026

Uh oh!

lenaploetzke left a comment

Uh oh!

lenaploetzke Aug 19, 2026

Uh oh!

lenaploetzke Aug 19, 2026

Uh oh!

lenaploetzke Aug 19, 2026

Uh oh!

lenaploetzke Aug 19, 2026

Uh oh!

lenaploetzke Aug 19, 2026

Uh oh!

lenaploetzke Aug 19, 2026

Uh oh!

lenaploetzke Aug 19, 2026

Uh oh!

lenaploetzke Aug 19, 2026

Uh oh!

lenaploetzke Aug 19, 2026

Uh oh!

lenaploetzke Aug 19, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants


		INSTANTIATE_TEST_SUITE_P (t8_gtest_face_neighbors, forest_face_neighbors_two_quad_mesh, AllSchemeCollections);

		/**

	for (int itree = 0; itree < num_local_trees; itree++) {
	for (t8_locidx_t itree = 0; itree < num_local_trees; itree++) {

	// (7.) Free memory of neigh_children and checkelem
	// (7.) Free memory of neigh_children and check_elem

Uh oh!

Conversation

spenke91 commented Aug 4, 2026

General

Tests

Scripts and Wiki

License

Uh oh!

codecov Bot commented Aug 4, 2026

Codecov Report

Uh oh!

lenaploetzke left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants