Show percentage of simulation progress

[JoshuaLampert]

Only a minor thing, but as a user you are probably interested in how much percent of the simulation is already done, especially in a simulation that runs for a longer time. With this PR, this information is printed in the AnalysisCallback and in the AliveCallback in parenthesis behind the simulation time.

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

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.

[sloede]

Very interesting idea!

Without having looked at the code yet: How do you know whether the simulation time or the max. number of iterations will determine when the simulation is finished?

[JoshuaLampert]

Ok, justified objection. I just assumed the simulation time will determine when the simulation is finished.

[JoshuaLampert]

But IMHO a finish due to max. number of iterations is something like an "early finish" for me. So I would be fine if it does not say 100% at the end when the simulation is finished due to the max. number of iterations are reached. It would actually be an interesting number at which percent of the final simulation time the simulation ended in this case, I think. What do you think?

[sloede]

Not really an objection, more of an honest question. I wouldn't mind having such an feature if it is made clear to the user that what this percentage refers to.

[codecov]

Codecov Report

Attention: 2 lines in your changes are missing coverage. Please review.

Comparison is base (8bc5469) 93.24% compared to head (0a279e1) 86.32%.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1659      +/-   ##
==========================================
- Coverage   93.24%   86.32%   -6.92%     
==========================================
  Files         419      419              
  Lines       34134    34146      +12     
==========================================
- Hits        31826    29474    -2352     
- Misses       2308     4672    +2364     

Flag	Coverage Δ
unittests	86.32% <83.33%> (-6.92%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files	Coverage Δ
src/callbacks_step/alive.jl	94.74% <83.33%> (-2.23%)	⬇️
src/callbacks_step/analysis.jl	92.55% <83.33%> (-0.20%)	⬇️

... and 92 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[DanielDoehring]

In principle one could also print final time alongside current simulation time. Then, if the user forgot the simulation endtime it is conveniently displayed.
Providing a percentage bears in my opinion the danger of people expecting to be able to extrapolate from this, which can go e.g. for AMR horribly wrong.

On the other side, we always write out errors which are also meaningless in actual simulations - in some sense this is also misleading.

[JoshuaLampert]

We could document this, e.g., here.

[ranocha]

It looks like the P4est_jll update breaks some tests here, too...

[ranocha]

Moreover, some *neuralnetwork_perssonperaire.jl test fail due to changes of the results...

[ranocha]

Other than the failing tests, I do like the approach. It's of course not perfect (since one could want to have a percentage of the total run time), but it's the best information we can provide.

[ranocha]

Thanks!