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

Make min_max_speed_davis default wave speed estimate for FluxHLL() #1743

Merged

Conversation

DanielDoehring
Copy link
Contributor

@DanielDoehring DanielDoehring commented Nov 17, 2023

See #1721 and #1726

In this version, we keep min_max_speed_naive.

Closes #1721

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

codecov bot commented Nov 17, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (4369c1c) 96.38% compared to head (1ecce03) 95.96%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1743      +/-   ##
==========================================
- Coverage   96.38%   95.96%   -0.42%     
==========================================
  Files         455      455              
  Lines       36391    36391              
==========================================
- Hits        35074    34921     -153     
- Misses       1317     1470     +153     
Flag Coverage Δ
unittests 95.96% <100.00%> (-0.42%) ⬇️

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.

@DanielDoehring DanielDoehring marked this pull request as ready for review November 20, 2023 14:40
@DanielDoehring
Copy link
Contributor Author

The changes in the test directory stem from those elixirs for which the speed estimates have been exchanged.

NEWS.md Outdated Show resolved Hide resolved
examples/dgmulti_2d/elixir_euler_bilinear.jl Outdated Show resolved Hide resolved
examples/dgmulti_3d/elixir_euler_curved.jl Outdated Show resolved Hide resolved
test/test_tree_2d_mhd.jl Outdated Show resolved Hide resolved
test/test_tree_2d_shallowwater.jl Outdated Show resolved Hide resolved
test/test_tree_3d_mhd.jl Outdated Show resolved Hide resolved
test/test_unstructured_2d.jl Outdated Show resolved Hide resolved
test/test_unstructured_2d.jl Outdated Show resolved Hide resolved
@ranocha
Copy link
Member

ranocha commented Dec 4, 2023

Is it necessary to merge main into this PR so often? If not, please refrain from doing so since it notifies people on GitHub and creates unnecessary friction since there isn't anything new.

@DanielDoehring DanielDoehring mentioned this pull request Jan 31, 2024
8 tasks
ranocha
ranocha previously approved these changes Feb 23, 2024
ranocha
ranocha previously approved these changes Feb 23, 2024
@ranocha ranocha merged commit 5418274 into trixi-framework:main Feb 23, 2024
2 checks passed
@DanielDoehring DanielDoehring deleted the HLL_WavespeedDefault_Davis branch February 23, 2024 08:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Using min_max_speed_davis instead of min_max_speed_naive as default
2 participants