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

Implement max_abs_speed for real maximum speed #2233

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

Conversation

DanielDoehring
Copy link
Contributor

The current implementation of the LLF flux uses max_abs_speed_naive

function FluxLaxFriedrichs(max_abs_speed = max_abs_speed_naive)
FluxPlusDissipation(flux_central, DissipationLocalLaxFriedrichs(max_abs_speed))
end
function Base.show(io::IO, f::FluxLaxFriedrichs)
print(io, "FluxLaxFriedrichs(", f.dissipation.max_abs_speed, ")")
end
"""
flux_lax_friedrichs
See [`FluxLaxFriedrichs`](@ref).
"""
const flux_lax_friedrichs = FluxLaxFriedrichs()

which is somewhat too conservative/over-diffusive:

λ_max = max(abs(v_ll), abs(v_rr)) + max(c_ll, c_rr)

In particular, this is actually different compared to the values used in the StepsizeCallback:

lambda1, lambda2 = max_abs_speeds(u_node, equations)

which uses the actual (sharp) true eigenvalues of the flux Jacobian:

@inline function max_abs_speeds(u, equations::CompressibleEulerEquations2D)
rho, v1, v2, p = cons2prim(u, equations)
c = sqrt(equations.gamma * p / rho)
return abs(v1) + c, abs(v2) + c
end

This PR adds the sharper functions + tests.

Whether we want to change the default used wave speed estimate remains for discussion for a separate PR.

@DanielDoehring DanielDoehring added enhancement New feature or request consistency Make Michael happy labels Jan 14, 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.

Copy link

codecov bot commented Jan 14, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.44%. Comparing base (fafa540) to head (db0569d).

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2233      +/-   ##
==========================================
+ Coverage   96.42%   96.44%   +0.03%     
==========================================
  Files         487      487              
  Lines       39352    39636     +284     
==========================================
+ Hits        37942    38226     +284     
  Misses       1410     1410              
Flag Coverage Δ
unittests 96.44% <100.00%> (+0.03%) ⬆️

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.

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 a lot! I think this is a good idea and we should likely update the default estimate as well. The only concern I have is as follows: In general, this is not a perfect estimate of the fastest wave speed in the solution of a Riemann problem but more a David-type estimate. Shall we rename it accordingly to max_abd_speed_davis?

@DanielDoehring
Copy link
Contributor Author

In general, this is not a perfect estimate of the fastest wave speed in the solution of a Riemann problem but more a David-type estimate. Shall we rename it accordingly to max_abd_speed_davis?

Hm true. The thing is, though, that this then somewhat indicates a different notion compared to max_abs_speeds which we use for the CFl condition, which might seem confusing.
I guess things boil down to some extent what we mean with "speed".

@ranocha
Copy link
Member

ranocha commented Jan 17, 2025

That's true. For max_abs_speeds, we just have single-point information. In this case, we have two points.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
consistency Make Michael happy enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants