Skip to content

Bugfix: public header includes private header in cmesh implementation#2224

Open
saustinp wants to merge 2 commits intoDLR-AMR:mainfrom
saustinp:fix/2221
Open

Bugfix: public header includes private header in cmesh implementation#2224
saustinp wants to merge 2 commits intoDLR-AMR:mainfrom
saustinp:fix/2221

Conversation

@saustinp
Copy link
Contributor

@saustinp saustinp commented Mar 11, 2026

Describe your changes here:
Previously, src/t8_geometry/t8_geometry_implementations/t8_geometry_cad.hxx included a private header to the cmesh implementation which was not available after building and installing the library. This broke compilation of programs using this feature, for example t8_features_curved_meshes.cxx.

The include statement was removed. Fixes #2221.

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

Copy link
Collaborator

@holke holke 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 for this fix!

@holke holke enabled auto-merge March 12, 2026 08:20
Copy link
Collaborator

@holke holke left a comment

Choose a reason for hiding this comment

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

The types header needs to be included in the cxx file now.

@holke holke disabled auto-merge March 12, 2026 08:33
@holke
Copy link
Collaborator

holke commented Mar 12, 2026

@saustinp would be easiest if you could add the include in the cxx file yourself since this lives at a fork of yours. If not, we can do it.

@codecov
Copy link

codecov bot commented Mar 12, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 78.27%. Comparing base (4a737b6) to head (2cb39df).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2224   +/-   ##
=======================================
  Coverage   78.27%   78.27%           
=======================================
  Files         114      114           
  Lines       19101    19101           
=======================================
  Hits        14952    14952           
  Misses       4149     4149           

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

@saustinp
Copy link
Contributor Author

@holke, as I judged these to have related, but slightly different impacts on the functionality of the code, I created a separate PR to include the types header into the .cxx file:

9c3a140

@holke
Copy link
Collaborator

holke commented Mar 12, 2026

@holke, as I judged these to have related, but slightly different impacts on the functionality of the code, I created a separate PR to include the types header into the .cxx file:

9c3a140

Ahh, did not see that :)

Thank you.

Since the CI fails without the types header here, we will have to merge #2223 first before we can merge this PR.

Copy link
Collaborator

@holke holke left a comment

Choose a reason for hiding this comment

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

Approved but needs to

@holke holke enabled auto-merge March 12, 2026 10:36
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.

Public installed header t8_geometry_cad.hxx includes non-installed internal header

2 participants