Skip to content

Feature: add neighbor subface helper#2216

Open
dutkalex wants to merge 16 commits into
DLR-AMR:mainfrom
dutkalex:add-neighbor-subface-helper
Open

Feature: add neighbor subface helper#2216
dutkalex wants to merge 16 commits into
DLR-AMR:mainfrom
dutkalex:add-neighbor-subface-helper

Conversation

@dutkalex
Copy link
Copy Markdown
Contributor

@dutkalex dutkalex commented Mar 6, 2026

Describe your changes here:
Implements #2215

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!
  • 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
Copy link
Copy Markdown

codecov Bot commented Mar 6, 2026

Codecov Report

❌ Patch coverage is 0% with 15 lines in your changes missing coverage. Please review.
✅ Project coverage is 82.50%. Comparing base (5c1e9cb) to head (ad7767f).

Files with missing lines Patch % Lines
src/t8_forest/t8_forest.cxx 0.00% 15 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2216      +/-   ##
==========================================
- Coverage   82.57%   82.50%   -0.07%     
==========================================
  Files         116      116              
  Lines       18553    18568      +15     
==========================================
  Hits        15320    15320              
- Misses       3233     3248      +15     

☔ 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 self-assigned this Mar 12, 2026
@holke holke added enhancement Enhances already existing code priority:medium Should be solved within half a year workload:low Would take half a day or less labels Mar 12, 2026
@holke holke assigned spenke91 and benegee and unassigned holke Apr 17, 2026
@spenke91 spenke91 self-requested a review April 29, 2026 07:06
Copy link
Copy Markdown
Collaborator

@spenke91 spenke91 left a comment

Choose a reason for hiding this comment

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

Thank you very much @dutkalex for another great contribution! :-) I am sorry it took us so long to reply...
I mostly have suggestions regarding variable names and code comments (which, I know, not everybody loves as much as I do 🤓 ). Aside from that, I only have a question regarding the hard-coded 4.

Comment thread src/t8_forest/t8_forest_general.h
Comment thread src/t8_forest/t8_forest.cxx Outdated
Comment thread src/t8_forest/t8_forest.cxx
Comment thread src/t8_forest/t8_forest.cxx
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 src/t8_forest/t8_forest.cxx
dutkalex and others added 2 commits May 9, 2026 23:04
Co-authored-by: spenke91 <thomas.spenke@dlr.de>
Add assertion to ensure the face was found before destruction.
@dutkalex
Copy link
Copy Markdown
Contributor Author

dutkalex commented May 9, 2026

Thank you very much @dutkalex for another great contribution! :-) I am sorry it took us so long to reply...

No worries @spenke91. Thank you for taking the time, I know you guys have a lot on your plate.

I mostly have suggestions regarding variable names and code comments (which, I know, not everybody loves as much as I do 🤓 ). Aside from that, I only have a question regarding the hard-coded 4.

I get it, I often say that getting the compiler to understand the code is the easy part and that the real challenge it to write code that humans can comprehend 😉. I have either committed your suggestions directly, or answered your comments/questions to get your opinion. Let me know what you think and I'll revise the code accordingly.

@dutkalex dutkalex removed their assignment May 14, 2026
@dutkalex dutkalex requested a review from spenke91 May 14, 2026 16:53
Copy link
Copy Markdown
Collaborator

@spenke91 spenke91 left a comment

Choose a reason for hiding this comment

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

Thanks a lot for your comments and replies!

Comment thread src/t8_forest/t8_forest.cxx Outdated
Comment thread src/t8_forest/t8_forest.cxx
Comment thread src/t8_forest/t8_forest.cxx
Comment thread src/t8_forest/t8_forest.cxx
Comment thread src/t8_forest/t8_forest.cxx
Comment thread src/t8_forest/t8_forest.cxx Outdated
@spenke91 spenke91 assigned dutkalex and unassigned benegee May 19, 2026
@dutkalex dutkalex removed their assignment May 26, 2026
@dutkalex dutkalex requested a review from spenke91 May 26, 2026 21:41
spenke91
spenke91 previously approved these changes May 27, 2026
Copy link
Copy Markdown
Collaborator

@spenke91 spenke91 left a comment

Choose a reason for hiding this comment

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

Thanks a lot @dutkalex for this contribution! 👍

Comment thread src/t8_forest/t8_forest.cxx
@spenke91 spenke91 enabled auto-merge May 27, 2026 05:52
Copy link
Copy Markdown
Collaborator

@spenke91 spenke91 left a comment

Choose a reason for hiding this comment

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

The doxygen workflow is failing due to a minor typo...

Comment thread src/t8_forest/t8_forest_general.h Outdated
Co-authored-by: spenke91 <thomas.spenke@dlr.de>
auto-merge was automatically disabled May 27, 2026 12:01

Head branch was pushed to by a user without write access

spenke91
spenke91 previously approved these changes May 27, 2026
@spenke91
Copy link
Copy Markdown
Collaborator

@dutkalex The failing doxygen workflow has nothing to do with your PR specifically. We have a rather unstable setup there which I will fix in the next days (#2331). Until then, I tried restarting the workflows.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement Enhances already existing code 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.

4 participants