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

fix type instability when iterating over callbacks in simple integrators #1684

Merged
merged 4 commits into from
Oct 23, 2023

Conversation

ranocha
Copy link
Member

@ranocha ranocha commented Oct 23, 2023

Fixes #1679

@github-actions
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.

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
Contributor

@DanielDoehring DanielDoehring left a comment

Choose a reason for hiding this comment

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

I guess for consistency one should also change

for cb in callback.continuous_callbacks
error("unsupported")
end
for cb in callback.discrete_callbacks
cb.initialize(cb, integrator.u, integrator.t, integrator)
end

and

for cb in callback.continuous_callbacks
error("unsupported")
end
for cb in callback.discrete_callbacks
cb.initialize(cb, integrator.u, integrator.t, integrator)
end

as well as

for cb in callback.continuous_callbacks
error("unsupported")
end
for cb in callback.discrete_callbacks
cb.initialize(cb, integrator.u, integrator.t, integrator)
end

and most importantly

for cb in callbacks.discrete_callbacks
if cb.condition(integrator.u, integrator.t, integrator)
cb.affect!(integrator)
end

@codecov
Copy link

codecov bot commented Oct 23, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (c2f0095) 82.63% compared to head (9e17d72) 86.35%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1684      +/-   ##
==========================================
+ Coverage   82.63%   86.35%   +3.71%     
==========================================
  Files         425      425              
  Lines       34376    34366      -10     
==========================================
+ Hits        28406    29674    +1268     
+ Misses       5970     4692    -1278     
Flag Coverage Δ
unittests 86.35% <100.00%> (+3.71%) ⬆️

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

Files Coverage Δ
src/time_integration/methods_2N.jl 90.36% <100.00%> (ø)
src/time_integration/methods_3Sstar.jl 93.27% <100.00%> (+1.92%) ⬆️

... and 214 files with indirect coverage changes

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

@ranocha
Copy link
Member Author

ranocha commented Oct 23, 2023

Good catch 👍 I adapted these parts as well.

src/time_integration/methods_3Sstar.jl Outdated Show resolved Hide resolved
src/time_integration/methods_3Sstar.jl Outdated Show resolved Hide resolved
src/time_integration/methods_SSP.jl Outdated Show resolved Hide resolved
src/time_integration/methods_SSP.jl Outdated Show resolved Hide resolved
src/time_integration/methods_2N.jl Outdated Show resolved Hide resolved
src/time_integration/methods_2N.jl Outdated Show resolved Hide resolved
@ranocha
Copy link
Member Author

ranocha commented Oct 23, 2023

Thanks! It's annoying that we sometimes use plural and sometimes singular...

@DanielDoehring DanielDoehring self-requested a review October 23, 2023 14:28
@ranocha ranocha merged commit a0cf926 into main Oct 23, 2023
27 of 28 checks passed
@ranocha ranocha deleted the hr/fix_iteration_callbacks branch October 23, 2023 14:59
@DanielDoehring DanielDoehring mentioned this pull request Oct 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
performance We are greedy
Projects
None yet
Development

Successfully merging this pull request may close these issues.

SimpleAlgorithm3Sstar solve! call is allocating
2 participants