Skip to content

Feature: Ghost interface with t8code module structure - #1711

Open
sandro-elsweijer wants to merge 173 commits into
mainfrom
feature-ghost_interface_restructuring
Open

sandro-elsweijer wants to merge 173 commits into
mainfrom
feature-ghost_interface_restructuring

Conversation

@sandro-elsweijer

@sandro-elsweijer sandro-elsweijer commented Jun 17, 2025 •

Copy link
Copy Markdown
Member

Closes #1784

Describe your changes here:
Separates ghost algorithm into its own abstract class. The structure is similar to the geometry module, but there is no ghost handler yet. But it should be easily implementable if needed in the future.
original work from @antjeHP.

There now is a ghost base class, which can be derived from to create a new ghost definition.
There is also a class which implements a base for search-based ghost algorithms and a class which implements our normal face ghost algorithms.
I tried to separate the functions needed by the actual ghost class into t8_ghost_definition_helpers and the rest (ghost element access and information, remote information etc.) stayed in t8_forest_ghost.

I am sorry, but I was not able to break the PR down into smaller bits. Most of the code just switched files, only the actual interface and ghost classes are new.

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

antjeHP and others added 30 commits June 24, 2024 15:16
Co-authored-by: Sandro Elsweijer <49643115+sandro-elsweijer@users.noreply.github.com>

This branch has not been deployed

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

Labels

priority:medium Should be solved within half a year workload:medium Would take a week or less

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Feature: Ghost interface with t8code module structure

4 participants