Example 1D Visualization Callback

[DanielDoehring]

The possibility to have the in-situ visualization for 1D is somewhat overshadowed/unclear, this PR aims at improving this.

Although this stuff is marked as experimental it is probably still nicer to include this in a breaking change.

[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

Attention: Patch coverage is 88.88889% with 1 line in your changes missing coverage. Please review.

Project coverage is 96.67%. Comparing base (159b9e3) to head (5c6db49).
Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
src/callbacks_step/visualization.jl	88.89%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2468      +/-   ##
==========================================
- Coverage   96.68%   96.67%   -0.00%     
==========================================
  Files         506      506              
  Lines       42005    42009       +4     
==========================================
+ Hits        40609    40612       +3     
- Misses       1396     1397       +1     

Flag	Coverage Δ
unittests	96.67% <88.89%> (-<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]

Thanks, this is a good idea 👍

[ranocha]

@DanielDoehring Is this ready from your point of view?

[DanielDoehring]

@DanielDoehring Is this ready from your point of view?

Yes, good to go 👍

[ranocha]

Could you please add a NEWS.md entry (since this is technically breaking)?

[DanielDoehring]

Could you please add a NEWS.md entry (since this is technically breaking)?

Sorry I am still in Canada 6 hours behind, just saw this this morning, thanks for adding the entry!