Skip to content

return nothing & helper functions for custom time integrators #2517

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

Open
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

DanielDoehring
Copy link
Member

@DanielDoehring DanielDoehring commented Aug 10, 2025

Follows upon #2516 .

Also, I am bundling some helper functions to avoid duplicated code.

@DanielDoehring DanielDoehring added low-priority refactoring Refactoring code without functional changes labels Aug 10, 2025
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.

@DanielDoehring DanielDoehring changed the title return nothing for the curstom time integrators return nothing for the custom time integrators Aug 11, 2025
@DanielDoehring DanielDoehring changed the title return nothing for the custom time integrators return nothing for the custom time integrators, unify callback functions Aug 11, 2025
Copy link

codecov bot commented Aug 11, 2025

Codecov Report

❌ Patch coverage is 98.86364% with 1 line in your changes missing coverage. Please review.
⚠️ Please upload report for BASE (main@531ee91). Learn more about missing BASE report.

Files with missing lines Patch % Lines
src/time_integration/time_integration.jl 96.43% 1 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2517   +/-   ##
=======================================
  Coverage        ?   96.75%           
=======================================
  Files           ?      512           
  Lines           ?    42387           
  Branches        ?        0           
=======================================
  Hits            ?    41010           
  Misses          ?     1377           
  Partials        ?        0           
Flag Coverage Δ
unittests 96.75% <98.86%> (?)

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.

@DanielDoehring DanielDoehring changed the title return nothing for the custom time integrators, unify callback functions return nothing & helper functions for custom time integrators Aug 11, 2025
Copy link
Contributor

@bennibolm bennibolm left a comment

Choose a reason for hiding this comment

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

Looks good to me, thanks.

@DanielDoehring DanielDoehring enabled auto-merge (squash) August 18, 2025 07:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
low-priority refactoring Refactoring code without functional changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants