Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Split forest h #516

Merged
merged 22 commits into from
Apr 25, 2023
Merged

Split forest h #516

merged 22 commits into from
Apr 25, 2023

Conversation

chiaraMaHe
Copy link
Collaborator

-Splitted t8_forest.h into the following header files:
t8_forest_general.h,
t8_forest_io.h,
t8_forest_geometrical.h, and
t8_forest_profiling.h.
-Reduced the includes in the 4 new header files
-Changed the includes for all files that included t8_forest.h to these of the new ones that are used
-No new code

With merging this we should open a new issue, about comparing t8_forest_io.h and t8_forest/t8_forest_vtk.h and merging them in one file
Closes #215

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.

  • The author added a BSD statement to doc/ (or already has one)

  • The code compiles without warning in debugging and release mode, with and without MPI (this should be executed automatically in a github action)

    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)
  • All tests pass (in various configurations, this should be executed automatically in a github action)

  • New source/header files are properly added to the Makefiles

  • New Datatypes are added to t8indent_custom_datatypes.txt

  • The reviewer executed the new code features at least once and checked the results manually

  • The code is covered in an existing or new test case

  • New tests use the Google Test framework

  • The code follows the t8code coding guidelines

  • The code is well documented

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

  • 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/tutorial and a Wiki article.

@chiaraMaHe chiaraMaHe added the cleanup Cleans the code label Apr 13, 2023
@chiaraMaHe chiaraMaHe self-assigned this Apr 13, 2023
src/t8_forest_geometrical.h Outdated Show resolved Hide resolved
src/t8_forest_geometrical.h Outdated Show resolved Hide resolved
@chiaraMaHe chiaraMaHe removed their assignment Apr 15, 2023
@jmark jmark merged commit e237632 into main Apr 25, 2023
3 checks passed
@jmark jmark deleted the split_forestH branch April 25, 2023 09:44
jfussbro pushed a commit to jfussbro/t8code that referenced this pull request Jun 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cleanup Cleans the code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Clean up forest.h
4 participants