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.

Sign up for GitHub

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

Jump to bottom

Generalize one-sided limiting #125

Merged
merged 23 commits into from
Mar 1, 2024
Merged

Generalize one-sided limiting #125

merged 23 commits into from
Mar 1, 2024

Conversation

bennibolm
Copy link
Owner

@bennibolm bennibolm commented Feb 19, 2024 •
edited
Loading

  • Generalized entropy limiting to one-sided limiting for nonlinear variables:
    The idea is to not manually enable the one-sided limiting for specific or math. entropy, but to be able to pass general variables and limit them with an upper or lower bound. Therefore, we now pass a tuple containing the variable and wanted one-sided bound (min or max to get a lower or upper bound) as parameter to the limiter.
  • Renamed local_minmax to local_twosided

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

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.

@bennibolm bennibolm requested a review from amrueda February 20, 2024 09:26
@bennibolm bennibolm mentioned this pull request Feb 20, 2024
Merged
1 task
amrueda
amrueda reviewed Feb 26, 2024
View reviewed changes
Copy link
Collaborator

@amrueda amrueda left a comment

Choose a reason for hiding this comment

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

Looks great to me. Here a couple of comments:

src/solvers/dgsem_tree/subcell_limiters.jl Outdated Show resolved Hide resolved
src/solvers/dgsem_tree/subcell_limiters.jl Show resolved Hide resolved
src/solvers/dgsem_tree/subcell_limiters.jl Outdated Show resolved Hide resolved
src/solvers/dgsem_tree/subcell_limiters_2d.jl Outdated Show resolved Hide resolved
@bennibolm bennibolm merged commit 37b8117 into subcell-limiting-entropies Mar 1, 2024
6 of 32 checks passed
@bennibolm bennibolm deleted the subcell-limiting-entropies-new-version branch March 1, 2024 12:58
@bennibolm bennibolm mentioned this pull request Mar 1, 2024
Draft
23 tasks
bennibolm added a commit that referenced this pull request May 8, 2024
@bennibolm @sloede
Add one-sided local subcell IDP limiting for non-linear variables (tr…
80f3c36 
…ixi-framework#1792)

* Add positivity limiting of non-linear variables

* Revise derivative function call; Add default derivative version

* Adapt test to actually test pos limiter for nonlinear variables

* Add unit test to test default implementation of variable_derivative

* Clean up comments and code

* Rename Newton-bisection variables

* Implement suggestions

* Relocate functions

* Add entropy limiters

* Update test errors after adding entropy limiting

* Fix bug in entropy limiting

* Adapt estimated errors after bug fix

* Remove doubled code

* Rename function

* Generalize one-sided limiting (#125)

* Start to align both entropy limiters

* Adapt calc_bounds_onesided!

* Add wrapper function for entropy limiting

* Rename keys in Dict

* use variable and bound_function as parameter

* Use same function for both entropies

* First working version of general onesided limiting

* Rename minmax limiting to twosided limiting

* Update comment

* Clean up default vector

* Last stuff

* Fix unit test

* fmt

* Fix tests

* Correct order

* Rework docstring

* Rename operator to min_or_max

* Call initial check with min_or_max

* fmt

* Implement suggestions

* Remove type stuff

* Fix allocations due to non-specialized routine

* Add comment to NEWS.md

* Remove whitespaces

* Implement suggestions

* Replace `foreach` with `for`

* Fix tests

* Use new bounds check reduction for one sided limiter

* Adapt tests after last merge of main

* Rename `entropy_spec` to `entropy_guermond_etal`

* Remove not-needed `tuple`

* Adapt nameing changes to tutorial

---------

Co-authored-by: Michael Schlottke-Lakemper <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@amrueda amrueda amrueda left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@bennibolm @amrueda