WIP: Add modal filter as a stage limiter

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 83.09859% with 12 lines in your changes are missing coverage. Please review.

Project coverage is 96.09%. Comparing base (3b52a30) to head (38b566d).

Files	Patch %	Lines
src/callbacks_stage/modal_filter_dg2d.jl	65.38%	9 Missing :warning:
src/callbacks_stage/modal_filter.jl	89.29%	3 Missing :warning:

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #1962 +/- ## ========================================== - Coverage 96.11% 96.09% -0.02% ========================================== Files 460 462 +2 Lines 36926 36997 +71 ========================================== + Hits 35490 35549 +59 - Misses 1436 1448 +12 ``` | [Flag](https://app.codecov.io/gh/trixi-framework/Trixi.jl/pull/1962/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/1962/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=trixi-framework) | `96.09% <83.10%> (-0.02%)` | :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.

sloede commented 1 month ago

Currently, running a convergence test does not work, in the sense that it gives exactly the same errors independent of the mesh resolution. It's probably just a denkfehler that requires a simple fix, most likely to the way we use the AnalysisCallback here.

Nevertheless, here are the current results (careful, the last run takes quite a long time (~8 mins)):

julia> convergence_test("examples/tree_2d_dgsem/elixir_euler_ec_modal_filter.jl", 2, initial_condition=initial_condition_convergence_test, n_cells_max=1_000_000, polydeg=7, tspan=(0.0, 0.3))

###################################################################################################
l2
rho                 rho_v1              rho_v2              rho_e
error     EOC       error     EOC       error     EOC       error     EOC
6.99e-02  -         1.31e-01  -         1.31e-01  -         3.67e-01  -
6.99e-02  -0.00     1.31e-01  -0.00     1.31e-01  -0.00     3.67e-01  -0.00
6.99e-02  -0.00     1.31e-01  -0.00     1.31e-01  -0.00     3.67e-01  -0.00
6.99e-02  -0.00     1.31e-01  -0.00     1.31e-01  -0.00     3.67e-01  -0.00

mean      -0.00     mean      -0.00     mean      -0.00     mean      -0.00
----------------------------------------------------------------------------------------------------
linf
rho                 rho_v1              rho_v2              rho_e
error     EOC       error     EOC       error     EOC       error     EOC
9.89e-02  -         1.87e-01  -         1.87e-01  -         5.24e-01  -
9.89e-02  -0.00     1.87e-01  0.00      1.87e-01  0.00      5.24e-01  -0.00
9.89e-02  0.00      1.87e-01  0.00      1.87e-01  0.00      5.24e-01  -0.00
9.89e-02  0.00      1.87e-01  -0.00     1.87e-01  -0.00     5.24e-01  -0.00

mean      -0.00     mean      0.00      mean      0.00      mean      -0.00
----------------------------------------------------------------------------------------------------

trixi-framework / Trixi.jl