PERK4 standalone

[DanielDoehring]

This concludes (as of now) the set of standalone PERK methods.

Xref: #21

[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.

[DanielDoehring]

@warisa-r Can you take a first look?

[codecov]

Codecov Report

Attention: Patch coverage is 92.50000% with 18 lines in your changes missing coverage. Please review.

Project coverage is 96.35%. Comparing base (f09a707) to head (b3611aa).

Files with missing lines	Patch %	Lines
...ation/paired_explicit_runge_kutta/methods_PERK4.jl	92.68%	9 Missing ⚠️
ext/TrixiConvexECOSExt.jl	89.71%	7 Missing ⚠️
...s/structured_2d_dgsem/elixir_euler_vortex_perk4.jl	95.45%	1 Missing ⚠️
...ation/paired_explicit_runge_kutta/methods_PERK3.jl	90.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2147      +/-   ##
==========================================
- Coverage   96.37%   96.35%   -0.02%     
==========================================
  Files         486      488       +2     
  Lines       39186    39386     +200     
==========================================
+ Hits        37764    37947     +183     
- Misses       1422     1439      +17     

Flag	Coverage Δ
unittests	96.35% <92.50%> (-0.02%)	⬇️

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.

[warisa-r]

@warisa-r Can you take a first look?

I'm on it!

[warisa-r]

Here is what I get from the brief look! I hope I could be of some help. Some might be totally non-sensical or out of ignorance. Apologies in advance!

[DanielDoehring]

This should wait for #2180

[DanielDoehring]

Two more refinement runs for the isentropic vortex example:

####################################################################################################
l2
rho                 rho_v1              rho_v2              rho_e               
error     EOC       error     EOC       error     EOC       error     EOC       
1.85e-04  -         4.25e-04  -         3.72e-04  -         2.67e-03  -         
1.55e-05  3.58      3.22e-05  3.73      2.80e-05  3.73      2.15e-04  3.64      
9.85e-07  3.97      1.80e-06  4.16      1.85e-06  3.92      1.34e-05  4.00      

mean      3.78      mean      3.94      mean      3.83      mean      3.82      
----------------------------------------------------------------------------------------------------
linf
rho                 rho_v1              rho_v2              rho_e               
error     EOC       error     EOC       error     EOC       error     EOC       
2.50e-03  -         9.27e-03  -         9.88e-03  -         3.07e-02  -         
3.85e-04  2.70      7.86e-04  3.56      7.82e-04  3.66      5.33e-03  2.53      
2.52e-05  3.93      6.55e-05  3.59      6.78e-05  3.53      3.63e-04  3.88      

mean      3.32      mean      3.57      mean      3.59      mean      3.20      
----------------------------------------------------------------------------------------------------

[DanielDoehring]

@warisa-r can you take a second look?

[DanielDoehring]

Thanks @warisa-r for your thorough review! I have now modularized stuff a lot - but things are now also quite busy :O

Once you are back from vacation I would be happy if you could take another look!

[JoshuaLampert]

I don't have the time right now to do a thorough review. Maybe add a NEWS entry?