Hyperbolic-Parabolic elixir using SparseConnectivityTracer

[sbairos]

In the footsteps of #2532, here's a hyperbolic-parabolic elixir that is sped up using SparseConnectivityTracer

[sbairos]

cc @DanielDoehring

[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

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 96.81%. Comparing base (1d75f8f) to head (75af937).

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #2604   +/-   ##
=======================================
  Coverage   96.81%   96.81%           
=======================================
  Files         535      536    +1     
  Lines       42813    42832   +19     
=======================================
+ Hits        41446    41465   +19     
  Misses       1367     1367           

Flag	Coverage Δ
unittests	96.81% <100.00%> (+<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.

🚀 New features to boost your workflow:

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

[ranocha]

@DanielDoehring Could you please review this initially and ping me for a final review?

[DanielDoehring]

And we also need a test where we restart

[JoshuaLampert]

Regarding the formatting, you can follow https://trixi-framework.github.io/TrixiDocumentation/stable/styleguide/#automated-source-code-formatting.

[sbairos]

Not sure what's going on with the formatting check. The only failure is:

examples/tree_1d_dgsem/elixir_advection_diffusion_implicit_sparse_jacobian_restart.jl:27:-            dt = dt_restart, save_everystep = false, callback = callbacks);
examples/tree_1d_dgsem/elixir_advection_diffusion_implicit_sparse_jacobian_restart.jl:27:+            dt = dt_restart, save_everystep = false, callback = callbacks);

which as far as I can tell is identical. When I replace this line in my IDE, git doesn't detect any difference

[JoshuaLampert]

You don't need to worry about the suggestion made in CI job. You can follow the instructions in the link above and the formatting will be applied automatically.

[sbairos]

Ah thanks @JoshuaLampert! I had been thinking there must be a better way to apply the formatting changes but didn't think to ask