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

Add t8_element_destroy statements to improve memory management #678

Merged
merged 8 commits into from
Aug 17, 2023

Conversation

lukasdreyer
Copy link
Collaborator

@lukasdreyer lukasdreyer commented Aug 17, 2023

Describe your changes here:
Clean version of #676, closes #672
Memory that is allocated by t8_element_new, but not destroyed by t8_element_destroy, stays in the memory pool until the scheme is destroyed. This leads to an increasing memory footprint that doesn't show up as an error with the sc library or with valgrind.
Therefore, an assertion is introduced in the destructor of the scheme, that all elements were explicitely given back to the memory pool.
Additionally, many occurences of missing t8_element_destroy statements were found and fixed.

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 Makefiles

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

Tests

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

Github action

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

  • All tests pass (in various configurations, 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)

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.
  • New Datatypes are added to t8indent_custom_datatypes.txt
  • If this PR introduces a new feature, it must be covered in an example/tutorial and a Wiki article.

Licence

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

Copy link
Collaborator

@Davknapp Davknapp left a comment

Choose a reason for hiding this comment

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

Thanks @ackirby88 for finding this bug and your support in fixing it together with @lukasdreyer

It only needs some small adaptations and we are ready to merge!

src/t8_forest/t8_forest.c Outdated Show resolved Hide resolved
src/t8_forest/t8_forest.c Outdated Show resolved Hide resolved
@Davknapp Davknapp assigned lukasdreyer and unassigned Davknapp Aug 17, 2023
@Davknapp Davknapp added the enhancement Enhances already existing code label Aug 17, 2023
Co-authored-by: David Knapp <david.knapp@dlr.de>
@lukasdreyer lukasdreyer assigned Davknapp and unassigned lukasdreyer Aug 17, 2023
@Davknapp Davknapp merged commit e1de331 into main Aug 17, 2023
8 checks passed
@Davknapp Davknapp deleted the fix_element_destroy_clean branch August 17, 2023 11:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Enhances already existing code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Getting Face Neighbor IDs; Memory Leak in t8_forest_leaf_face_neighbors function.
2 participants