Add subcell limiting support for StructuredMesh

bennibolm commented 1 month ago

This PR adds subcell limiting support for Structuredmesh.

Getting the inverse Jacobian makes this PR a bit longer. That's because for TreeMesh, inverse_jacobian is fixed within one element, while it is different for each node for StructuredMesh. To avoid something like

if mesh isa TreeMesh
    inverse_jacobian = cache.elements.inverse_jacobian[element]
end
for j in eachnode(dg), i in eachnode(dg)
    if mesh isa StructuredMesh
        inverse_jacobian = cache.elements.inverse_jacobian[i, j, element]
    end
    [...]
end

and also avoid unnecessary calls of inverse jacobian in TreeMesh simulations, I dispatched for the mesh type and extracted the code [...] to an inner function (This is also done for e.g. the routine apply_jacobian!).

After this PR, it will be straight forward to add support for P4estMesh.

For now, there is no support for non-conservative systems.

TODO:

[ ] Add or adapt test with non-periodic boundaries

github-actions[bot] commented 1 month ago

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 :heart: by the Trixi.jl community.

codecov[bot] commented 1 month ago

Codecov Report

Attention: Patch coverage is 73.75000% with 84 lines in your changes are missing coverage. Please review.

Project coverage is 75.26%. Comparing base (9b64eab) to head (98c2144). Report is 1 commits behind head on main.

Files	Patch %	Lines
...rc/solvers/dgsem_structured/subcell_limiters_2d.jl	40.62%	76 Missing :warning:
src/solvers/dgsem_tree/subcell_limiters_2d.jl	93.69%	7 Missing :warning:
...llbacks_stage/subcell_limiter_idp_correction_2d.jl	95.24%	1 Missing :warning:

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #1942 +/- ## =========================================== - Coverage 89.49% 75.26% -14.23% =========================================== Files 453 457 +4 Lines 36474 36681 +207 =========================================== - Hits 32640 27606 -5034 - Misses 3834 9075 +5241 ``` | [Flag](https://app.codecov.io/gh/trixi-framework/Trixi.jl/pull/1942/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=trixi-framework) | Coverage Δ | | |---|---|---| | [unittests](https://app.codecov.io/gh/trixi-framework/Trixi.jl/pull/1942/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=trixi-framework) | `75.26% <73.75%> (-14.23%)` | :arrow_down: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=trixi-framework#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

bennibolm commented 1 month ago

Due to issues with the code coverage test, continue this PR with a branch on upstream Trixi and not on my fork. https://github.com/trixi-framework/Trixi.jl/pull/1946

trixi-framework / Trixi.jl