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

Finalize callbacks for custom time integrators #2304

Merged
merged 6 commits into from
Mar 7, 2025

Conversation

JoshuaLampert
Copy link
Member

As noted by @knstmrd, after having merged #2275, the summary callback is not printed anymore for our custom integrators after the simulation finished. This is because we do not call the callback finalizers in our custom solve function. This PR fixes this.

@JoshuaLampert JoshuaLampert added the bug Something isn't working label Mar 7, 2025
Copy link
Contributor

github-actions bot commented Mar 7, 2025

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.

@JoshuaLampert JoshuaLampert marked this pull request as draft March 7, 2025 14:27
Copy link

codecov bot commented Mar 7, 2025

Codecov Report

Attention: Patch coverage is 90.90909% with 1 line in your changes missing coverage. Please review.

Project coverage is 96.90%. Comparing base (95ba917) to head (57a8f0c).
Report is 2 commits behind head on main.

Files with missing lines Patch % Lines
src/time_integration/time_integration.jl 85.71% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2304      +/-   ##
==========================================
- Coverage   96.90%   96.90%   -0.00%     
==========================================
  Files         493      493              
  Lines       40331    40342      +11     
==========================================
+ Hits        39082    39092      +10     
- Misses       1249     1250       +1     
Flag Coverage Δ
unittests 96.90% <90.91%> (-<0.01%) ⬇️

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.

🚀 New features to boost your workflow:
  • Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@JoshuaLampert JoshuaLampert marked this pull request as ready for review March 7, 2025 15:07
@bennibolm
Copy link
Contributor

Thanks for fixing this.

JoshuaLampert and others added 2 commits March 7, 2025 16:32
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Copy link
Member

@ranocha ranocha left a comment

Choose a reason for hiding this comment

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

Thanks!

@ranocha ranocha enabled auto-merge (squash) March 7, 2025 18:49
@ranocha ranocha merged commit cdc083f into main Mar 7, 2025
38 of 39 checks passed
@ranocha ranocha deleted the finalize-callbacks-custom-time-integrators branch March 7, 2025 19:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants