3D support for subcell limiting

[bennibolm]

Add 3d support for subcell limiting on P4estMesh

Mergeable features

• Nonconservative terms: NonConservativeSymmetric (Add 3d subcell limiting example with nonconservative terms #2688)
• Nonconservative terms: NonConservativeJump
• BoundsCheck (Add 3d subcell bounds check #2722 for Positivity)
• Local limiting Cons vars (incl. bounds calculation) (Add 3d local limiting for conservative variables #2763)
• Local Limiting nonlinear vars (incl. bounds calculation) (Add 3d local subcell limiting for nonlinear variables #2733)
• Nonperiodic simulations (Add 3d support for nonperiodic simulations with subcell limiting #2844)

Treemesh features:

• Positivity limiting on periodic meshes (Add initial support for subcell limiting with 3D TreeMesh #2846)
• Relocate general functionalities to TreeMesh files (Relocate functions from P4estMesh folder to TreeMesh folder #2859)
• Local limiting (Add local subcell limiting for TreeMesh{3} #2848)
• Non-periodic local limiting (Add local limiting support for nonperiodic TreeMeshes #2878)
• Update NEWS.md (Relocate functions from P4estMesh folder to TreeMesh folder #2859)
• Nonconservative support (Symmetric & Jump)

[github-actions]

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.

[codecov]

Codecov Report

❌ Patch coverage is 9.35024% with 572 lines in your changes missing coverage. Please review.
✅ Project coverage is 95.89%. Comparing base (e6a0a8f) to head (186cc43).
⚠️ Report is 19 commits behind head on main.

Files with missing lines	Patch %	Lines
src/solvers/dgsem_tree/dg_3d_subcell_limiters.jl	0.00%	310 Missing ⚠️
src/solvers/dgsem_p4est/dg_3d_subcell_limiters.jl	0.00%	213 Missing ⚠️
src/equations/ideal_glm_mhd_3d.jl	0.00%	49 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2572      +/-   ##
==========================================
- Coverage   97.05%   95.89%   -1.15%     
==========================================
  Files         606      606              
  Lines       47371    48002     +631     
==========================================
+ Hits        45972    46031      +59     
- Misses       1399     1971     +572     

Flag	Coverage Δ
unittests	95.89% <9.35%> (-1.15%)	⬇️

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.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[DanielDoehring]

This is huge - could we maybe do euler only first to get a feeling for this?

[bennibolm]

This is huge - could we maybe do euler only first to get a feeling for this?

Yes, the plan is not to merge everything at once. First, Euler and probably only one limiting option.