Add functionality for TimeSeries callback on UnstructuredMesh2D

[andrewwinters5000]

For now this callback is only reliable on straight-sided unstructured elements. If a curved element contains a time series point then a warning is thrown to inform the user. The callback itself still works and creates data, but it may have errors.

I updated my element identification strategy such that this callback now works as expected on curvilinear elements as well. It uses the same Newton approach and reuses the existing mapping and metric functions used in the mesh creation. It took me a bit to realize that we already had all the tools necessary to invert the transfinite interpolation as well. My new strategy to identify if a point lies in a curved element is a bit brute force (it involves computing all the barycenters), so I am open to suggestions to optimize it if it allocates too much or so.

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

[codecov]

Codecov Report

Attention: Patch coverage is 98.60140% with 2 lines in your changes are missing coverage. Please review.

Project coverage is 87.23%. Comparing base (1ca37cf) to head (d81b79e).
Report is 1 commits behind head on main.

Files	Patch %	Lines
src/callbacks_step/time_series_dg2d.jl	98.20%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1855      +/-   ##
==========================================
- Coverage   89.44%   87.23%   -2.22%     
==========================================
  Files         438      439       +1     
  Lines       35593    35734     +141     
==========================================
- Hits        31836    31170     -666     
- Misses       3757     4564     +807     

Flag	Coverage Δ
unittests	87.23% <98.60%> (-2.22%)	⬇️

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.

[DanielDoehring]

Hey Andrew, I just took a look at this during yesterdays meeting and added some quality of life remarks :)

[ranocha]

Thanks a lot! I didn't check the implementation in detail but I assume you have already done so.

[DanielDoehring]

LGTM, just added couple comments.

[sloede]

This is a great feature, thanks for tackling it!

[sloede]

I forgot to mention in my review: It would be great to update the docs as well, indicating which mesh types are supported (both in the docstring of the callback and the docs in docs/)

[andrewwinters5000]

There are still normal use cases that fail, I need to work more and make this more robust.

[andrewwinters5000]

forgot to mention in my review: It would be great to update the docs as well, indicating which mesh types are supported (both in the docstring of the callback and the docs in docs/)

I updated the docstring but could not find this callback mentioned anywhere else in the docs.

[sloede]

forgot to mention in my review: It would be great to update the docs as well, indicating which mesh types are supported (both in the docstring of the callback and the docs in docs/)

I updated the docstring but could not find this callback mentioned anywhere else in the docs.

You're right, sorry. I thought we had mentioned it there, but apparently we didn't.

[JoshuaLampert]

I updated the docstring but could not find this callback mentioned anywhere else in the docs.

We have this: https://github.com/trixi-framework/Trixi.jl/blob/main/docs/src/callbacks.md#time-series.

[patrickersing]

Thanks for adding this functionality!
Everything looks good already. I just added a few comment suggestions and a question regarding the new strategy.

[andrewwinters5000]

I updated the docstring but could not find this callback mentioned anywhere else in the docs.

We have this: https://github.com/trixi-framework/Trixi.jl/blob/main/docs/src/callbacks.md#time-series.

Since this general discussion links to the TimeSeriesCallback docstring where we indicate the mesh support I do not think we need to update the general callback overview.

[andrewwinters5000]

@sloede @ranocha Should this feature extension get mentioned in the NEWS.md?

[sloede]

@sloede @ranocha Should this feature extension get mentioned in the NEWS.md?

I think this is so cool that, yes, I'd mention it!

[patrickersing]

I just have one question about where the additional tests should live.

[patrickersing]

LGTM!

[ranocha]

Thanks a lot!