Change default wave speed for Local Lax-Friedrichs
See #2273
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.mdwith 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 :heart: by the Trixi.jl community.
Codecov Report
All modified and coverable lines are covered by tests :white_check_mark:
Project coverage is 96.66%. Comparing base (
c3cee00) to head (abc9078). Report is 1 commits behind head on main.
Additional details and impacted files
@@ Coverage Diff @@
## main #2458 +/- ##
=======================================
Coverage 96.66% 96.66%
=======================================
Files 507 507
Lines 42011 42011
=======================================
Hits 40609 40609
Misses 1402 1402
| Flag | Coverage Δ | |
|---|---|---|
| unittests | 96.66% <100.00%> (ø) |
Flags with carried forward coverage won't be shown. Click here to find out more.
:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.
:rocket: New features to boost your workflow:
- :snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
@ranocha This is good from my side - but it would be good to get a second pair of eyes looking at test_unit and test_type.
I'm not arguing against making the change, and this has perhaps been pointed out before, but it's interesting to see that the "conservative" wave speed estimate is not just something from the beginning of Trixi.jl, but actually comes from how the wave speed is computed in FLEXI:
https://github.com/flexi-framework/flexi/blob/9a6bd75fde2f410df93bb996e86cd79d84e2ffdc/src/equations/navierstokes/riemann.f90#L580
I'm not arguing against making the change, and this has perhaps been pointed out before, but it's interesting to see that the "conservative" wave speed estimate is not just something from the beginning of Trixi.jl, but actually comes from how the wave speed is computed in FLEXI:
https://github.com/flexi-framework/flexi/blob/9a6bd75fde2f410df93bb996e86cd79d84e2ffdc/src/equations/navierstokes/riemann.f90#L580
True - in itself, this estimate is probably a decent approximation for non-convex flux functions. The main reason for this change is that we estimate the wave speeds in the CFL callback differently and thus, by default, different wave speeds are employed in different parts of the code which I would consider bad practice.
@DanielDoehring Is this ready from your point of view?
@DanielDoehring Is this ready from your point of view?
Yes, I think I got every place where LLF is used