Add numerical support of other real types (shallow_water)

[huiyuxie]

Continue #1909.

Tasks:

• shallow_water 1d, 2d
• shallow_water_quasi 1d
• unit tests for above

[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.23%. Comparing base (91eac3c) to head (df0d34b).

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1995      +/-   ##
==========================================
- Coverage   96.23%   96.23%   -0.00%     
==========================================
  Files         462      462              
  Lines       37075    37074       -1     
==========================================
- Hits        35676    35675       -1     
  Misses       1399     1399              

Flag	Coverage Δ
unittests	96.23% <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.

[ranocha]

Thanks a lot! Please find below some comments/suggestions

[huiyuxie]

@ranocha I remember I asked you about why some functions look so complex. So I took the z as a variable that might appear in the original formula - basically, I would not modify the original function too much.

[huiyuxie]

Anyway, I fixed all of them based on your suggestions. Thanks!

[ranocha]

Thanks! Some unit tests are still missing but this looks good to me otherwise.

[huiyuxie]

Try to test both orientation and normal_direction but it showed

MethodError: no method matching min_max_speed_davis(::StaticArraysCore.SVector{3, Float32}, ::StaticArraysCore.SVector{3, Float32}, ::StaticArraysCore.SVector{1, Float32}, ::Trixi.ShallowWaterEquations1D{Float32})

[huiyuxie]

Is that okay to comment like this? @ranocha

[ranocha]

Yes, that's fine 👍

[huiyuxie]

@ranocha Ready for final review and merge ^o^

[ranocha]

Thanks!