[Doc] add sod tube example to sphinx

[tdavidcl]

No description provided.

[github-actions]

Thanks @tdavidcl for opening this PR!

You can do multiple things directly here:
1 - Comment pre-commit.ci run to run pre-commit checks.
2 - Comment pre-commit.ci autofix to apply fixes.
3 - Add label autofix.ci to fix authorship & pre-commit for every commit made.
4 - Add label light-ci to only trigger a reduced & faster version of the CI (need the full one before merge).
5 - Add label trigger-ci to create an empty commit to trigger the CI.

Once the workflow completes a message will appear displaying informations related to the run.

Also the PR gets automatically reviewed by gemini, you can:
1 - Comment /gemini review to trigger a review
2 - Comment /gemini summary for a summary
3 - Tag it using @gemini-code-assist either in the PR or in review comments on files

[gemini-code-assist]

Summary of Changes

Hello @tdavidcl, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request introduces a new documentation example for the Sod tube test, designed to showcase and compare the behavior of different numerical methods (slope limiters and Riemann solvers) within the RAMSES simulation framework. The example provides visual comparisons against analytical solutions and includes an animation, enhancing the understanding of solver performance. Additionally, a minor but necessary update was made to the underlying SodTube C++ class to ensure proper initialization and logging capabilities.

Highlights

• New Sphinx Example: A new Sphinx example, run_sod.py, has been added to demonstrate the Sod tube test within the RAMSES solver. This example allows for comparison of various slope limiters and Riemann solvers.
• Solver Configuration Comparison: The example script runs simulations with different combinations of 'none' and 'minmod' slope limiters, and 'rusanov', 'hll', and 'hllc' Riemann solvers, then plots the absolute differences against an analytical solution.
• Animation Feature: An animation feature is included to visualize the evolution of density, velocity, and pressure over time for a specific solver configuration (minmod_hllc).
• SodTube Class Update: The SodTube C++ class was updated to include the shamcomm/logs.hpp header and to explicitly initialize vx_1 and vx_5 to zero in its constructor.

Changelog

• doc/sphinx/examples/ramses/run_sod.py
  • Added a new Python script implementing the Sod tube test for the RAMSES solver.
  • Included functionality to compare various slope limiters and Riemann solvers.
  • Implemented plotting for results comparison against analytical solutions.
  • Added an animation of the simulation's time evolution.
• src/shamphys/src/SodTube.cpp
  • Included the shamcomm/logs.hpp header.
  • Initialized vx_1 and vx_5 member variables to zero in the constructor.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request adds a new example for the Sod tube test to the Sphinx documentation. The example script is well-structured and demonstrates the comparison of different slope limiters and Riemann solvers.

My review includes a few suggestions to improve the Python script's maintainability and readability, such as refactoring if/elif blocks and avoiding variable name shadowing. I also found a minor issue in the C++ code regarding an unused header, and a suggestion to adhere to PEP 8 for import statements.

Overall, this is a great addition to the documentation.

[gemini-code-assist]

The header shamcomm/logs.hpp is included but does not appear to be used in this file. To improve code clarity and reduce compilation dependencies, it's best to remove unused includes.

[github-actions]

Workflow report

workflow report corresponding to commit 401d4c5
Commiter email is timothee.davidcleris@proton.me
GitHub page artifact URL GitHub page artifact link (can expire)

Pre-commit check report

Pre-commit check: ✅

trim trailing whitespace.................................................Passed
fix end of files.........................................................Passed
check for merge conflicts................................................Passed
check that executables have shebangs.....................................Passed
check that scripts with shebangs are executable..........................Passed
check for added large files..............................................Passed
check for case conflicts.................................................Passed
check for broken symlinks................................................Passed
check yaml...............................................................Passed
detect private key.......................................................Passed
No-tabs checker..........................................................Passed
Tabs remover.............................................................Passed
Validate GitHub Workflows................................................Passed
clang-format.............................................................Passed
ruff check...............................................................Passed
ruff format..............................................................Passed
Check doxygen headers....................................................Passed
Check license headers....................................................Passed
Check #pragma once.......................................................Passed
Check SYCL #include......................................................Passed
No ssh in git submodules remote..........................................Passed
No UTF-8 in files (except for authors)...................................Passed

Test pipeline can run.

Clang-tidy diff report

No relevant changes found.
Well done!

You should now go back to your normal life and enjoy a hopefully sunny day while waiting for the review.

Doxygen diff with main

Removed warnings : 0
New warnings : 0
Warnings count : 8183 → 8183 (0.0%)

Detailed changes :