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

Add subcell positivity limiting of non-linear variables #1738

Merged

Conversation

bennibolm
Copy link
Contributor

@bennibolm bennibolm commented Nov 14, 2023

This PR expand the support of the subcell positivity limiting to non-linear variables. This allows for instance to reduce the initial pressure from 1.0 to 0.01 in the existing mhd elixir examples/tree_2d_dgsem/elixir_mhd_shockcapturing_subcell.jl.

The limiting is done as follows (same as in Fluxo):
Now, and as for the Zalesak-type limiting before, each node is looked at separately. Then, we look at the antidiffusive_flux (DG flux - FV flux) for all 4 (=2*dimension) directions separately again.
So, we want to calculate the maximum amount of flux, we can add to meet our given bounds.
For this, we start with the current (from local limiting and positivity limiting for conservative variables) coefficient and increase it until the resulting solution fulfills the bounds. For this iterative approach, we use a Newton-bisection method.

Copy link
Contributor

github-actions bot commented Nov 14, 2023

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 16, 2023

Codecov Report

Attention: 10 lines in your changes are missing coverage. Please review.

Comparison is base (c7cee98) 96.38% compared to head (b16d742) 96.38%.

Files Patch % Lines
src/solvers/dgsem_tree/subcell_limiters_2d.jl 95.18% 4 Missing ⚠️
src/callbacks_stage/subcell_bounds_check_2d.jl 80.00% 3 Missing ⚠️
src/callbacks_stage/subcell_bounds_check.jl 71.43% 2 Missing ⚠️
src/equations/compressible_euler_2d.jl 90.91% 1 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff            @@
##             main    #1738    +/-   ##
========================================
  Coverage   96.38%   96.38%            
========================================
  Files         454      455     +1     
  Lines       36249    36391   +142     
========================================
+ Hits        34937    35074   +137     
- Misses       1312     1317     +5     
Flag Coverage Δ
unittests 96.38% <93.42%> (+<0.01%) ⬆️

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.

@bennibolm bennibolm changed the title WIP: Add subcell positivity limiting of non-linear variables Add subcell positivity limiting of non-linear variables Nov 17, 2023
@bennibolm bennibolm marked this pull request as ready for review November 17, 2023 09:39
@bennibolm bennibolm requested review from efaulhaber and removed request for sloede and amrueda December 7, 2023 15:21
Copy link
Contributor

@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!!
Just a couple minor comments here.

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
Copy link
Contributor Author

Thanks @amrueda 🙌

@bennibolm bennibolm requested review from sloede and removed request for efaulhaber December 13, 2023 12:01
Copy link
Member

@sloede sloede left a comment

Choose a reason for hiding this comment

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

Not much left to do imho, ready to party by the end of the week 👯‍♂️

src/equations/equations.jl Outdated 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
src/solvers/dgsem_tree/subcell_limiters_2d.jl Outdated Show resolved Hide resolved
@bennibolm bennibolm requested a review from sloede January 30, 2024 14:34
src/equations/equations.jl Outdated Show resolved Hide resolved
sloede
sloede previously approved these changes Jan 30, 2024
Copy link
Member

@sloede sloede left a comment

Choose a reason for hiding this comment

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

LGTM, thanks! There are just two names that I'd like to get @ranocha's feedback on; if he agrees, this can be merged

src/equations/ideal_glm_mhd_2d.jl Outdated Show resolved Hide resolved
src/equations/ideal_glm_mhd_2d.jl Outdated Show resolved Hide resolved
@bennibolm bennibolm requested a review from sloede January 31, 2024 15:45
Copy link
Member

@sloede sloede left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

@sloede sloede enabled auto-merge (squash) January 31, 2024 15:55
@sloede sloede merged commit dfd632e into trixi-framework:main Jan 31, 2024
34 of 35 checks passed
@bennibolm bennibolm deleted the subcell-limiting-positivity-nonlinear branch January 31, 2024 20:52
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.

None yet

5 participants