Skip to content

Feature: Adapt class#2045

Open
Davknapp wants to merge 35 commits intomainfrom
adapt_class
Open

Feature: Adapt class#2045
Davknapp wants to merge 35 commits intomainfrom
adapt_class

Conversation

@Davknapp
Copy link
Collaborator

@Davknapp Davknapp commented Dec 15, 2025

Closes #2046

This is a draft PR for an outline (and hopefully later on meant seriously) adapt class.

It provides a class that manages the adaptation of a forest. The adaption is split into several parts:

  • the gathering of the adaptation action via element-callbacks
  • the family check
  • the execution of the action matching the results of the element-callbacks and the are_family checks.

The goal is to provide a general functionality of adaptivy whilst also providing the flexibilty to speciallize for other adaptions, like forests with wholes, or subelements. The steps can be overwritten to provide such functionality and also to create new adaptions workflows more easily.

Please feel free to discuss it in this draft PR.

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

a templated function to describe how the new forest is based on the old forest depending on the return value of the adaptation cb
TODO: execute element_manipulation on every leaf of the tree
- iterate over all elements in tree
- fix is_family check
- fix wrong indices used for element manipulation
Family can not be larger that T8_ECLASS_MAX_CHILDREN
@Davknapp Davknapp marked this pull request as ready for review February 6, 2026 12:05
@codecov
Copy link

codecov bot commented Feb 6, 2026

Codecov Report

❌ Patch coverage is 0% with 19 lines in your changes missing coverage. Please review.
✅ Project coverage is 77.87%. Comparing base (411b90b) to head (4574fc7).
⚠️ Report is 96 commits behind head on main.

Files with missing lines Patch % Lines
...orest/t8_forest_adapt/t8_forest_standard_adapt.hxx 0.00% 19 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2045      +/-   ##
==========================================
- Coverage   77.95%   77.87%   -0.09%     
==========================================
  Files         113      114       +1     
  Lines       19087    19108      +21     
==========================================
+ Hits        14880    14881       +1     
- Misses       4207     4227      +20     

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

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.

Feature: Adapt class

1 participant