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

Feature: Checkpointing for T8codeMesh #1980

Merged
merged 78 commits into from
Nov 5, 2024
Merged

Conversation

jmark
Copy link
Contributor

@jmark jmark commented Jun 13, 2024

This PR adds checkpointing for T8codeMesh. By this, routines like save_mesh and load_mesh are supported.

Closes #2044

@jmark jmark added the enhancement New feature or request label Jun 13, 2024
Copy link
Contributor

Review checklist

This checklist is meant to assist creators of PRs (to let them know what reviewers will typically look for) and reviewers (to guide them in a structured review process). Items do not need to be checked explicitly for a PR to be eligible for merging.

Purpose and scope

  • The PR has a single goal that is clear from the PR title and/or description.
  • All code changes represent a single set of modifications that logically belong together.
  • No more than 500 lines of code are changed or there is no obvious way to split the PR into multiple PRs.

Code quality

  • The code can be understood easily.
  • Newly introduced names for variables etc. are self-descriptive and consistent with existing naming conventions.
  • There are no redundancies that can be removed by simple modularization/refactoring.
  • There are no leftover debug statements or commented code sections.
  • The code adheres to our conventions and style guide, and to the Julia guidelines.

Documentation

  • New functions and types are documented with a docstring or top-level comment.
  • Relevant publications are referenced in docstrings (see example for formatting).
  • Inline comments are used to document longer or unusual code sections.
  • Comments describe intent ("why?") and not just functionality ("what?").
  • If the PR introduces a significant change or new feature, it is documented in NEWS.md with its PR number.

Testing

  • The PR passes all tests.
  • New or modified lines of code are covered by tests.
  • New or modified tests run in less then 10 seconds.

Performance

  • There are no type instabilities or memory allocations in performance-critical parts.
  • If the PR intent is to improve performance, before/after time measurements are posted in the PR.

Verification

  • The correctness of the code was verified using appropriate tests.
  • If new equations/methods are added, a convergence test has been run and the results
    are posted in the PR.

Created with ❤️ by the Trixi.jl community.

Copy link

codecov bot commented Jun 13, 2024

Codecov Report

Attention: Patch coverage is 97.88136% with 5 lines in your changes missing coverage. Please review.

Project coverage is 95.44%. Comparing base (16c6f17) to head (aca9742).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
src/auxiliary/t8code.jl 75.00% 3 Missing ⚠️
src/callbacks_step/save_restart_dg.jl 66.67% 1 Missing ⚠️
src/meshes/t8code_mesh.jl 99.38% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1980      +/-   ##
==========================================
- Coverage   96.37%   95.44%   -0.93%     
==========================================
  Files         480      480              
  Lines       37855    38028     +173     
==========================================
- Hits        36482    36295     -187     
- Misses       1373     1733     +360     
Flag Coverage Δ
unittests 95.44% <97.88%> (-0.93%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@jmark jmark marked this pull request as ready for review June 24, 2024 12:40
@benegee benegee self-assigned this Jun 26, 2024
@benegee benegee self-requested a review June 26, 2024 06:54
src/meshes/mesh_io.jl Outdated Show resolved Hide resolved
@benegee
Copy link
Contributor

benegee commented Nov 5, 2024

Concerning the failing invalidations check, see timholy/SnoopCompile.jl#397

@benegee benegee self-requested a review November 5, 2024 08:40
benegee
benegee previously approved these changes Nov 5, 2024
@jmark
Copy link
Contributor Author

jmark commented Nov 5, 2024

@benegee As expected, several tests fail since some routines became obsolete with the breaking t8code 3.0.0 release. We have to iron out these issues first.

I suggest we fix these problems in this PR #1939 first since the changes are minimal on Trixi side. Then merge that PR into the checkpointing PR.

benegee
benegee previously approved these changes Nov 5, 2024
@benegee benegee enabled auto-merge (squash) November 5, 2024 16:26
@benegee benegee merged commit 91eaaf6 into main Nov 5, 2024
36 of 37 checks passed
@benegee benegee deleted the feature-t8codemesh-checkpointing branch November 5, 2024 17:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

saving solution while using T8code meshes
5 participants