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

WIP: Fix bug in the semi-discrete entropy limiter #133

Open
wants to merge 4 commits into
base: subcell-limiting
Choose a base branch
from

Conversation

amrueda
Copy link
Collaborator

@amrueda amrueda commented Nov 11, 2024

In this PR, I propose a fix for the semi-discrete entropy limiter.

Thanks @weil4 for noticing the problem!

Copy link

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.

Comment on lines +41 to +42
surface_flux = flux_ranocha
volume_flux = flux_ranocha
Copy link
Owner

Choose a reason for hiding this comment

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

Is there another difference between the two new elixirs than just the volume flux?

Copy link
Owner

Choose a reason for hiding this comment

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

If no, we could just adapt the volume flux in the tests and remove one of the elixirs.

Copy link
Owner

Choose a reason for hiding this comment

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

Ah, I see that it is not even tested. Could you maybe add some test?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

The examples here are not meant to be tests (yet), but a proof of concept for debugging. They show that there is an error in the current implementation in the branch subcell-limiting: We get entropy production in these two tests with entropy_limiter_semidiscrete = true. That is wrong.

My "fix" causes entropy_limiter_semidiscrete = true to dissipate entropy in these two tests, but that is not enough to show that this is the only/correct fix that needs to be done. However, I don't know how to design a more definitive test.

@bennibolm
Copy link
Owner

I saw that two tests in tree_part2 are failing in this PR. Are those tests/e elixirs, where the entropy fix is used?

@amrueda
Copy link
Collaborator Author

amrueda commented Nov 18, 2024

I saw that two tests in tree_part2 are failing in this PR. Are those tests/e elixirs, where the entropy fix is used?

Yes, I'll update the reference values.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants