Skip to content

Conversation

@y-lapeyre
Copy link
Collaborator

@y-lapeyre y-lapeyre commented Mar 12, 2025

  • Rearranged the Godunov model's Solver header (split into actual solver + solver config as in the SPH model).
  • Added JSON serialization/deserialization: you can now dump in sham format, and start a simulation from a sham dump. Tested of a Sedov script that I added to the exemples.

@y-lapeyre y-lapeyre requested review from Akos299 and tdavidcl March 12, 2025 14:29
@tdavidcl tdavidcl changed the title [I/O] Sham native format for the Godunov solver. [Ramses][io] add shamrock native dump. Mar 12, 2025
@tdavidcl tdavidcl marked this pull request as draft March 12, 2025 14:31
@y-lapeyre y-lapeyre requested a review from tdavidcl May 5, 2025 09:59
@y-lapeyre y-lapeyre marked this pull request as ready for review May 5, 2025 15:03
Copy link
Member

@tdavidcl tdavidcl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small nitpicks

Copy link
Member

@tdavidcl tdavidcl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also could you fix this Doxygen error ?

+ src/shamrock/include/shamrock/io/units_json.hpp:26: warning: found documented return type for to_json_optional that does not return anything
+ src/shamrock/include/shamrock/io/units_json.hpp:45: warning: found documented return type for from_json_optional that does not return anything

Co-authored-by: David--Cléris Timothée <timothee.davidcleris@proton.me>
y-lapeyre and others added 2 commits May 6, 2025 10:17
Co-authored-by: David--Cléris Timothée <timothee.davidcleris@proton.me>
@github-actions
Copy link

github-actions bot commented May 6, 2025

Workflow report

workflow report corresponding to commit a86d621
Commiter email is yona.lapeyre@ens-lyon.fr

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............................(no files to check)Skipped
check yaml...............................................................Passed
detect private key.......................................................Passed
No-tabs checker..........................................................Passed
Tabs remover.............................................................Passed
Validate GitHub Workflows................................................Passed
clang-format.............................................................Passed
black....................................................................Passed
isort....................................................................Passed
Check doxygen headers....................................................Passed
Check license headers....................................................Passed
Check #pragma once.......................................................Passed
Check SYCL #include......................................................Passed
No ssh in git submodules remote..........................................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 : 103
New warnings : 108
Warnings count : 5734 → 5739 (0.1%)

Detailed changes :
- src/shammodels/ramses/include/shammodels/ramses/Model.hpp:104: warning: Member evolve_once_time_expl(f64 t_curr, f64 dt_input) (function) of class shammodels::basegodunov::Model is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/Model.hpp:106: warning: Member evolve_once_time_expl(f64 t_curr, f64 dt_input) (function) of class shammodels::basegodunov::Model is not documented.
- src/shammodels/ramses/include/shammodels/ramses/Model.hpp:108: warning: Member timestep() (function) of class shammodels::basegodunov::Model is not documented.
- src/shammodels/ramses/include/shammodels/ramses/Model.hpp:110: warning: Member evolve_once() (function) of class shammodels::basegodunov::Model is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/Model.hpp:110: warning: Member timestep() (function) of class shammodels::basegodunov::Model is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/Model.hpp:112: warning: Member evolve_once() (function) of class shammodels::basegodunov::Model is not documented.
- src/shammodels/ramses/include/shammodels/ramses/Model.hpp:115: warning: Member evolve_until(Tscal target_time, i32 niter_max) (function) of class shammodels::basegodunov::Model is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/Model.hpp:117: warning: Member evolve_until(Tscal target_time, i32 niter_max) (function) of class shammodels::basegodunov::Model is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/Model.hpp:125: warning: Member dump(std::string fname) (function) of class shammodels::basegodunov::Model is not documented.
- src/shammodels/ramses/include/shammodels/ramses/Model.hpp:31: warning: Compound shammodels::basegodunov::Model is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/Model.hpp:33: warning: Compound shammodels::basegodunov::Model is not documented.
- src/shammodels/ramses/include/shammodels/ramses/Model.hpp:33: warning: Member Tscal (typedef) of class shammodels::basegodunov::Model is not documented.
- src/shammodels/ramses/include/shammodels/ramses/Model.hpp:34: warning: Member dim (variable) of class shammodels::basegodunov::Model is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/Model.hpp:35: warning: Member Tscal (typedef) of class shammodels::basegodunov::Model is not documented.
- src/shammodels/ramses/include/shammodels/ramses/Model.hpp:35: warning: Member ctx (variable) of class shammodels::basegodunov::Model is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/Model.hpp:36: warning: Member dim (variable) of class shammodels::basegodunov::Model is not documented.
- src/shammodels/ramses/include/shammodels/ramses/Model.hpp:37: warning: Member Solver (typedef) of class shammodels::basegodunov::Model is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/Model.hpp:37: warning: Member ctx (variable) of class shammodels::basegodunov::Model is not documented.
- src/shammodels/ramses/include/shammodels/ramses/Model.hpp:38: warning: Member solver (variable) of class shammodels::basegodunov::Model is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/Model.hpp:39: warning: Member Solver (typedef) of class shammodels::basegodunov::Model is not documented.
- src/shammodels/ramses/include/shammodels/ramses/Model.hpp:40: warning: Member Model(ShamrockCtx &ctx) (function) of class shammodels::basegodunov::Model is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/Model.hpp:40: warning: Member solver (variable) of class shammodels::basegodunov::Model is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/Model.hpp:42: warning: Member Model(ShamrockCtx &ctx) (function) of class shammodels::basegodunov::Model is not documented.
- src/shammodels/ramses/include/shammodels/ramses/Model.hpp:46: warning: Member init_scheduler(u32 crit_split, u32 crit_merge) (function) of class shammodels::basegodunov::Model is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/Model.hpp:48: warning: Member init_scheduler(u32 crit_split, u32 crit_merge) (function) of class shammodels::basegodunov::Model is not documented.
- src/shammodels/ramses/include/shammodels/ramses/Model.hpp:48: warning: Member make_base_grid(TgridVec bmin, TgridVec cell_size, u32_3 cell_count) (function) of class shammodels::basegodunov::Model is not documented.
- src/shammodels/ramses/include/shammodels/ramses/Model.hpp:50: warning: Member dump_vtk(std::string filename) (function) of class shammodels::basegodunov::Model is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/Model.hpp:50: warning: Member make_base_grid(TgridVec bmin, TgridVec cell_size, u32_3 cell_count) (function) of class shammodels::basegodunov::Model is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/Model.hpp:52: warning: Member dump_vtk(std::string filename) (function) of class shammodels::basegodunov::Model is not documented.
- src/shammodels/ramses/include/shammodels/ramses/Model.hpp:53: warning: Member set_field_value_lambda(std::string field_name, const std::function< T(Tvec, Tvec)> pos_to_val, const i32 offset) (function) of class shammodels::basegodunov::Model is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/Model.hpp:55: warning: Member set_field_value_lambda(std::string field_name, const std::function< T(Tvec, Tvec)> pos_to_val, const i32 offset) (function) of class shammodels::basegodunov::Model is not documented.
- src/shammodels/ramses/include/shammodels/ramses/Model.hpp:96: warning: Member get_cell_coords(std::pair< TgridVec, TgridVec > block_coords, u32 lid) (function) of class shammodels::basegodunov::Model is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/Model.hpp:98: warning: Member get_cell_coords(std::pair< TgridVec, TgridVec > block_coords, u32 lid) (function) of class shammodels::basegodunov::Model is not documented.
- src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:101: warning: Member set_refine_none() (function) of struct shammodels::basegodunov::AMRMode is not documented.
- src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:102: warning: Member set_refine_density_based(Tscal crit_mass) (function) of struct shammodels::basegodunov::AMRMode is not documented.
- src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:106: warning: Compound shammodels::basegodunov::SolverConfig is not documented.
- src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:108: warning: Member Tscal (typedef) of struct shammodels::basegodunov::SolverConfig is not documented.
- src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:110: warning: Member eos_gamma (variable) of struct shammodels::basegodunov::SolverConfig is not documented.
- src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:112: warning: Member grid_coord_to_pos_fact (variable) of struct shammodels::basegodunov::SolverConfig is not documented.
- src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:114: warning: Member NsideBlockPow (variable) of struct shammodels::basegodunov::SolverConfig is not documented.
- src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:115: warning: Member AMRBlock (typedef) of struct shammodels::basegodunov::SolverConfig is not documented.
- src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:117: warning: Member set_eos_gamma(Tscal gamma) (function) of struct shammodels::basegodunov::SolverConfig is not documented.
- src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:119: warning: Member riemman_config (variable) of struct shammodels::basegodunov::SolverConfig is not documented.
- src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:120: warning: Member slope_config (variable) of struct shammodels::basegodunov::SolverConfig is not documented.
- src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:121: warning: Member face_half_time_interpolation (variable) of struct shammodels::basegodunov::SolverConfig is not documented.
- src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:122: warning: Member dust_config (variable) of struct shammodels::basegodunov::SolverConfig is not documented.
- src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:123: warning: Member drag_config (variable) of struct shammodels::basegodunov::SolverConfig is not documented.
- src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:125: warning: Member is_dust_on() (function) of struct shammodels::basegodunov::SolverConfig is not documented.
- src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:128: warning: Member set_alphas_static(f32 alpha_values) (function) of struct shammodels::basegodunov::SolverConfig is not documented.
- src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:133: warning: Member Csafe (variable) of struct shammodels::basegodunov::SolverConfig is not documented.
- src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:153: warning: Compound shammodels::basegodunov::Solver is not documented.
- src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:155: warning: Member Tscal (typedef) of class shammodels::basegodunov::Solver is not documented.
- src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:156: warning: Member Tgridscal (typedef) of class shammodels::basegodunov::Solver is not documented.
- src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:157: warning: Member dim (variable) of class shammodels::basegodunov::Solver is not documented.
- src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:159: warning: Member u_morton (typedef) of class shammodels::basegodunov::Solver is not documented.
- src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:160: warning: Member Config (typedef) of class shammodels::basegodunov::Solver is not documented.
- src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:162: warning: Member AMRBlock (typedef) of class shammodels::basegodunov::Solver is not documented.
- src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:164: warning: Member context (variable) of class shammodels::basegodunov::Solver is not documented.
- src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:165: warning: Member scheduler() (function) of class shammodels::basegodunov::Solver is not documented.
- src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:167: warning: Member solver_config (variable) of class shammodels::basegodunov::Solver is not documented.
- src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:169: warning: Member storage (variable) of class shammodels::basegodunov::Solver is not documented.
- src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:171: warning: Member init_required_fields() (function) of class shammodels::basegodunov::Solver is not documented.
- src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:186: warning: Member Solver(ShamrockCtx &context) (function) of class shammodels::basegodunov::Solver is not documented.
- src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:188: warning: Member do_debug_vtk_dump(std::string filename) (function) of class shammodels::basegodunov::Solver is not documented.
- src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:190: warning: Member print_timestep_logs() (function) of class shammodels::basegodunov::Solver is not documented.
- src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:199: warning: Member evolve_once() (function) of class shammodels::basegodunov::Solver is not documented.
- src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:201: warning: Member evolve_once_time_expl(Tscal t_current, Tscal dt_input) (function) of class shammodels::basegodunov::Solver is not documented.
- src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:208: warning: Member evolve_until(Tscal target_time, i32 niter_max) (function) of class shammodels::basegodunov::Solver is not documented.
- src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:27: warning: Member RiemmanSolverMode (enumeration) of namespace shammodels::basegodunov is not documented.
- src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:27: warning: Member RiemmanSolverMode (enumeration) of namespace shammodels::basegodunov is not documented.
- src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:29: warning: Member SlopeMode (enumeration) of namespace shammodels::basegodunov is not documented.
- src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:29: warning: Member SlopeMode (enumeration) of namespace shammodels::basegodunov is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:31: warning: Compound shammodels::basegodunov::Solver is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:33: warning: Member Tscal (typedef) of class shammodels::basegodunov::Solver is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:34: warning: Member Tgridscal (typedef) of class shammodels::basegodunov::Solver is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:35: warning: Member dim (variable) of class shammodels::basegodunov::Solver is not documented.
- src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:37: warning: Member DustRiemannSolverMode (enumeration) of namespace shammodels::basegodunov is not documented.
- src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:37: warning: Member DustRiemannSolverMode (enumeration) of namespace shammodels::basegodunov is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:37: warning: Member u_morton (typedef) of class shammodels::basegodunov::Solver is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:38: warning: Member Config (typedef) of class shammodels::basegodunov::Solver is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:40: warning: Member AMRBlock (typedef) of class shammodels::basegodunov::Solver is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:42: warning: Member context (variable) of class shammodels::basegodunov::Solver is not documented.
- src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:43: warning: Member DragSolverMode (enumeration) of namespace shammodels::basegodunov is not documented.
- src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:43: warning: Member DragSolverMode (enumeration) of namespace shammodels::basegodunov is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:43: warning: Member scheduler() (function) of class shammodels::basegodunov::Solver is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:45: warning: Member solver_config (variable) of class shammodels::basegodunov::Solver is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:47: warning: Member storage (variable) of class shammodels::basegodunov::Solver is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:49: warning: Member init_required_fields() (function) of class shammodels::basegodunov::Solver is not documented.
- src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:54: warning: Member drag_solver_config (variable) of struct shammodels::basegodunov::DragConfig is not documented.
- src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:55: warning: Member alphas (variable) of struct shammodels::basegodunov::DragConfig is not documented.
- src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:56: warning: Member enable_frictional_heating (variable) of struct shammodels::basegodunov::DragConfig is not documented.
- src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:60: warning: Compound shammodels::basegodunov::DustConfig is not documented.
- src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:61: warning: Member dust_riemann_config (variable) of struct shammodels::basegodunov::DustConfig is not documented.
- src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:62: warning: Member ndust (variable) of struct shammodels::basegodunov::DustConfig is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:64: warning: Member Solver(ShamrockCtx &context) (function) of class shammodels::basegodunov::Solver is not documented.
- src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:64: warning: Member is_dust_on() (function) of struct shammodels::basegodunov::DustConfig is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:66: warning: Member do_debug_vtk_dump(std::string filename) (function) of class shammodels::basegodunov::Solver is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:68: warning: Member print_timestep_logs() (function) of class shammodels::basegodunov::Solver is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:77: warning: Member evolve_once() (function) of class shammodels::basegodunov::Solver is not documented.
- src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:78: warning: Compound shammodels::basegodunov::SolverStatusVar is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:79: warning: Member evolve_once_time_expl(Tscal t_current, Tscal dt_input) (function) of class shammodels::basegodunov::Solver is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:86: warning: Member evolve_until(Tscal target_time, i32 niter_max) (function) of class shammodels::basegodunov::Solver is not documented.
- src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:88: warning: Compound shammodels::basegodunov::AMRMode is not documented.
- src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:90: warning: Member Tscal (typedef) of struct shammodels::basegodunov::AMRMode is not documented.
- src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:93: warning: Compound shammodels::basegodunov::AMRMode::DensityBased is not documented.
- src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:94: warning: Member crit_mass (variable) of struct shammodels::basegodunov::AMRMode::DensityBased is not documented.
- src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:97: warning: Member mode (typedef) of struct shammodels::basegodunov::AMRMode is not documented.
- src/shammodels/ramses/include/shammodels/ramses/Solver.hpp:99: warning: Member config (variable) of struct shammodels::basegodunov::AMRMode is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/SolverConfig.hpp:100: warning: Compound shammodels::basegodunov::SolverConfig is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/SolverConfig.hpp:105: warning: Compound shammodels::basegodunov::SolverStatusVar is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/SolverConfig.hpp:115: warning: Compound shammodels::basegodunov::SolverConfig is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/SolverConfig.hpp:117: warning: Member Tscal (typedef) of struct shammodels::basegodunov::SolverConfig is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/SolverConfig.hpp:119: warning: Member eos_gamma (variable) of struct shammodels::basegodunov::SolverConfig is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/SolverConfig.hpp:121: warning: Member grid_coord_to_pos_fact (variable) of struct shammodels::basegodunov::SolverConfig is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/SolverConfig.hpp:123: warning: Member NsideBlockPow (variable) of struct shammodels::basegodunov::SolverConfig is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/SolverConfig.hpp:124: warning: Member AMRBlock (typedef) of struct shammodels::basegodunov::SolverConfig is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/SolverConfig.hpp:126: warning: Member set_eos_gamma(Tscal gamma) (function) of struct shammodels::basegodunov::SolverConfig is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/SolverConfig.hpp:128: warning: Member riemman_config (variable) of struct shammodels::basegodunov::SolverConfig is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/SolverConfig.hpp:129: warning: Member slope_config (variable) of struct shammodels::basegodunov::SolverConfig is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/SolverConfig.hpp:130: warning: Member face_half_time_interpolation (variable) of struct shammodels::basegodunov::SolverConfig is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/SolverConfig.hpp:136: warning: Member dust_config (variable) of struct shammodels::basegodunov::SolverConfig is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/SolverConfig.hpp:137: warning: Member drag_config (variable) of struct shammodels::basegodunov::SolverConfig is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/SolverConfig.hpp:139: warning: Member is_dust_on() (function) of struct shammodels::basegodunov::SolverConfig is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/SolverConfig.hpp:142: warning: Member set_alphas_static(f32 alpha_values) (function) of struct shammodels::basegodunov::SolverConfig is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/SolverConfig.hpp:184: warning: Member Csafe (variable) of struct shammodels::basegodunov::SolverConfig is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/SolverConfig.hpp:193: warning: Member to_json(nlohmann::json &j, const SolverStatusVar< Tvec > &p) (function) of namespace shammodels::basegodunov is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/SolverConfig.hpp:193: warning: Member to_json(nlohmann::json &j, const SolverStatusVar< Tvec > &p) (function) of namespace shammodels::basegodunov is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/SolverConfig.hpp:198: warning: Member from_json(const nlohmann::json &j, SolverStatusVar< Tvec > &p) (function) of namespace shammodels::basegodunov is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/SolverConfig.hpp:198: warning: Member from_json(const nlohmann::json &j, SolverStatusVar< Tvec > &p) (function) of namespace shammodels::basegodunov is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/SolverConfig.hpp:28: warning: Member RiemmanSolverMode (enumeration) of namespace shammodels::basegodunov is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/SolverConfig.hpp:28: warning: Member RiemmanSolverMode (enumeration) of namespace shammodels::basegodunov is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/SolverConfig.hpp:30: warning: Member SlopeMode (enumeration) of namespace shammodels::basegodunov is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/SolverConfig.hpp:30: warning: Member SlopeMode (enumeration) of namespace shammodels::basegodunov is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/SolverConfig.hpp:38: warning: Member DustRiemannSolverMode (enumeration) of namespace shammodels::basegodunov is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/SolverConfig.hpp:38: warning: Member DustRiemannSolverMode (enumeration) of namespace shammodels::basegodunov is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/SolverConfig.hpp:44: warning: Member DragSolverMode (enumeration) of namespace shammodels::basegodunov is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/SolverConfig.hpp:44: warning: Member DragSolverMode (enumeration) of namespace shammodels::basegodunov is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/SolverConfig.hpp:55: warning: Member drag_solver_config (variable) of struct shammodels::basegodunov::DragConfig is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/SolverConfig.hpp:56: warning: Member alphas (variable) of struct shammodels::basegodunov::DragConfig is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/SolverConfig.hpp:57: warning: Member enable_frictional_heating (variable) of struct shammodels::basegodunov::DragConfig is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/SolverConfig.hpp:61: warning: Compound shammodels::basegodunov::DustConfig is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/SolverConfig.hpp:62: warning: Member dust_riemann_config (variable) of struct shammodels::basegodunov::DustConfig is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/SolverConfig.hpp:63: warning: Member ndust (variable) of struct shammodels::basegodunov::DustConfig is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/SolverConfig.hpp:65: warning: Member is_dust_on() (function) of struct shammodels::basegodunov::DustConfig is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/SolverConfig.hpp:79: warning: Compound shammodels::basegodunov::SolverStatusVar is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/SolverConfig.hpp:82: warning: Compound shammodels::basegodunov::AMRMode is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/SolverConfig.hpp:84: warning: Member Tscal (typedef) of struct shammodels::basegodunov::AMRMode is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/SolverConfig.hpp:87: warning: Compound shammodels::basegodunov::AMRMode::DensityBased is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/SolverConfig.hpp:88: warning: Member crit_mass (variable) of struct shammodels::basegodunov::AMRMode::DensityBased is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/SolverConfig.hpp:91: warning: Member mode (typedef) of struct shammodels::basegodunov::AMRMode is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/SolverConfig.hpp:93: warning: Member config (variable) of struct shammodels::basegodunov::AMRMode is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/SolverConfig.hpp:95: warning: Member set_refine_none() (function) of struct shammodels::basegodunov::AMRMode is not documented.
+ src/shammodels/ramses/include/shammodels/ramses/SolverConfig.hpp:96: warning: Member set_refine_density_based(Tscal crit_mass) (function) of struct shammodels::basegodunov::AMRMode is not documented.
- src/shammodels/ramses/src/pyRamsesModel.cpp:244: warning: Member Register_pymod(pybasegodunovmodel) (function) of file pyRamsesModel.cpp is not documented.
+ src/shammodels/ramses/src/pyRamsesModel.cpp:246: warning: Member Register_pymod(pybasegodunovmodel) (function) of file pyRamsesModel.cpp is not documented.
- src/shammodels/sph/include/shammodels/sph/SolverConfig.hpp:100: warning: Member set_none() (function) of struct shammodels::sph::DustConfig is not documented.
- src/shammodels/sph/include/shammodels/sph/SolverConfig.hpp:101: warning: Member set_monofluid_tvi(u32 nvar) (function) of struct shammodels::sph::DustConfig is not documented.
+ src/shammodels/sph/include/shammodels/sph/SolverConfig.hpp:101: warning: Member set_none() (function) of struct shammodels::sph::DustConfig is not documented.
- src/shammodels/sph/include/shammodels/sph/SolverConfig.hpp:102: warning: Member set_monofluid_complete(u32 nvar) (function) of struct shammodels::sph::DustConfig is not documented.
+ src/shammodels/sph/include/shammodels/sph/SolverConfig.hpp:102: warning: Member set_monofluid_tvi(u32 nvar) (function) of struct shammodels::sph::DustConfig is not documented.
+ src/shammodels/sph/include/shammodels/sph/SolverConfig.hpp:103: warning: Member set_monofluid_complete(u32 nvar) (function) of struct shammodels::sph::DustConfig is not documented.
- src/shammodels/sph/include/shammodels/sph/SolverConfig.hpp:104: warning: Member has_epsilon_field() (function) of struct shammodels::sph::DustConfig is not documented.
+ src/shammodels/sph/include/shammodels/sph/SolverConfig.hpp:105: warning: Member has_epsilon_field() (function) of struct shammodels::sph::DustConfig is not documented.
- src/shammodels/sph/include/shammodels/sph/SolverConfig.hpp:109: warning: Member has_deltav_field() (function) of struct shammodels::sph::DustConfig is not documented.
+ src/shammodels/sph/include/shammodels/sph/SolverConfig.hpp:110: warning: Member has_deltav_field() (function) of struct shammodels::sph::DustConfig is not documented.
- src/shammodels/sph/include/shammodels/sph/SolverConfig.hpp:113: warning: Member get_dust_nvar() (function) of struct shammodels::sph::DustConfig is not documented.
+ src/shammodels/sph/include/shammodels/sph/SolverConfig.hpp:114: warning: Member get_dust_nvar() (function) of struct shammodels::sph::DustConfig is not documented.
- src/shammodels/sph/include/shammodels/sph/SolverConfig.hpp:128: warning: Member check_config() (function) of struct shammodels::sph::DustConfig is not documented.
+ src/shammodels/sph/include/shammodels/sph/SolverConfig.hpp:129: warning: Member check_config() (function) of struct shammodels::sph::DustConfig is not documented.
- src/shammodels/sph/include/shammodels/sph/SolverConfig.hpp:165: warning: Member RTree (typedef) of struct shammodels::sph::SolverConfig is not documented.
+ src/shammodels/sph/include/shammodels/sph/SolverConfig.hpp:166: warning: Member RTree (typedef) of struct shammodels::sph::SolverConfig is not documented.
- src/shammodels/sph/include/shammodels/sph/SolverConfig.hpp:264: warning: Member MHDConfig (typedef) of struct shammodels::sph::SolverConfig is not documented.
+ src/shammodels/sph/include/shammodels/sph/SolverConfig.hpp:265: warning: Member MHDConfig (typedef) of struct shammodels::sph::SolverConfig is not documented.
- src/shammodels/sph/include/shammodels/sph/SolverConfig.hpp:265: warning: Member mhd_config (variable) of struct shammodels::sph::SolverConfig is not documented.
+ src/shammodels/sph/include/shammodels/sph/SolverConfig.hpp:266: warning: Member mhd_config (variable) of struct shammodels::sph::SolverConfig is not documented.
- src/shammodels/sph/include/shammodels/sph/SolverConfig.hpp:278: warning: Member set_NonIdealMHD(typename MHDConfig::NonIdealMHD v) (function) of struct shammodels::sph::SolverConfig is not documented.
+ src/shammodels/sph/include/shammodels/sph/SolverConfig.hpp:279: warning: Member set_NonIdealMHD(typename MHDConfig::NonIdealMHD v) (function) of struct shammodels::sph::SolverConfig is not documented.
- src/shammodels/sph/include/shammodels/sph/SolverConfig.hpp:288: warning: Member DustConfig (typedef) of struct shammodels::sph::SolverConfig is not documented.
+ src/shammodels/sph/include/shammodels/sph/SolverConfig.hpp:289: warning: Member DustConfig (typedef) of struct shammodels::sph::SolverConfig is not documented.
- src/shammodels/sph/include/shammodels/sph/SolverConfig.hpp:289: warning: Member dust_config (variable) of struct shammodels::sph::SolverConfig is not documented.
+ src/shammodels/sph/include/shammodels/sph/SolverConfig.hpp:290: warning: Member dust_config (variable) of struct shammodels::sph::SolverConfig is not documented.
- src/shammodels/sph/include/shammodels/sph/SolverConfig.hpp:394: warning: The following parameter of shammodels::sph::SolverConfig::set_eos_locally_isothermalFA2014(Tscal h_over_r) is not documented:
- src/shammodels/sph/include/shammodels/sph/SolverConfig.hpp:394: warning: argument 'cs0' of command @param is not found in the argument list of shammodels::sph::SolverConfig< Tvec, SPHKernel >::set_eos_locally_isothermalFA2014(Tscal h_over_r)
- src/shammodels/sph/include/shammodels/sph/SolverConfig.hpp:394: warning: argument 'q' of command @param is not found in the argument list of shammodels::sph::SolverConfig< Tvec, SPHKernel >::set_eos_locally_isothermalFA2014(Tscal h_over_r)
- src/shammodels/sph/include/shammodels/sph/SolverConfig.hpp:394: warning: argument 'r0' of command @param is not found in the argument list of shammodels::sph::SolverConfig< Tvec, SPHKernel >::set_eos_locally_isothermalFA2014(Tscal h_over_r)
+ src/shammodels/sph/include/shammodels/sph/SolverConfig.hpp:395: warning: The following parameter of shammodels::sph::SolverConfig::set_eos_locally_isothermalFA2014(Tscal h_over_r) is not documented:
+ src/shammodels/sph/include/shammodels/sph/SolverConfig.hpp:395: warning: argument 'cs0' of command @param is not found in the argument list of shammodels::sph::SolverConfig< Tvec, SPHKernel >::set_eos_locally_isothermalFA2014(Tscal h_over_r)
+ src/shammodels/sph/include/shammodels/sph/SolverConfig.hpp:395: warning: argument 'q' of command @param is not found in the argument list of shammodels::sph::SolverConfig< Tvec, SPHKernel >::set_eos_locally_isothermalFA2014(Tscal h_over_r)
+ src/shammodels/sph/include/shammodels/sph/SolverConfig.hpp:395: warning: argument 'r0' of command @param is not found in the argument list of shammodels::sph::SolverConfig< Tvec, SPHKernel >::set_eos_locally_isothermalFA2014(Tscal h_over_r)
- src/shammodels/sph/include/shammodels/sph/SolverConfig.hpp:683: warning: Member check_config() (function) of struct shammodels::sph::SolverConfig is not documented.
+ src/shammodels/sph/include/shammodels/sph/SolverConfig.hpp:684: warning: Member check_config() (function) of struct shammodels::sph::SolverConfig is not documented.
- src/shammodels/sph/include/shammodels/sph/SolverConfig.hpp:685: warning: Member set_layout(shamrock::patch::PatchDataLayout &pdl) (function) of struct shammodels::sph::SolverConfig is not documented.
- src/shammodels/sph/include/shammodels/sph/SolverConfig.hpp:686: warning: Member set_ghost_layout(shamrock::patch::PatchDataLayout &ghost_layout) (function) of struct shammodels::sph::SolverConfig is not documented.
+ src/shammodels/sph/include/shammodels/sph/SolverConfig.hpp:686: warning: Member set_layout(shamrock::patch::PatchDataLayout &pdl) (function) of struct shammodels::sph::SolverConfig is not documented.
+ src/shammodels/sph/include/shammodels/sph/SolverConfig.hpp:687: warning: Member set_ghost_layout(shamrock::patch::PatchDataLayout &ghost_layout) (function) of struct shammodels::sph::SolverConfig is not documented.
- src/shammodels/sph/include/shammodels/sph/SolverConfig.hpp:761: warning: found documented return type for shammodels::sph::to_json_optional that does not return anything
- src/shammodels/sph/include/shammodels/sph/SolverConfig.hpp:780: warning: found documented return type for shammodels::sph::from_json_optional that does not return anything
- src/shammodels/sph/include/shammodels/sph/SolverConfig.hpp:83: warning: Compound shammodels::sph::DustConfig is not documented.
+ src/shammodels/sph/include/shammodels/sph/SolverConfig.hpp:84: warning: Compound shammodels::sph::DustConfig is not documented.
- src/shammodels/sph/include/shammodels/sph/SolverConfig.hpp:87: warning: Compound shammodels::sph::DustConfig::MonofluidTVI is not documented.
+ src/shammodels/sph/include/shammodels/sph/SolverConfig.hpp:88: warning: Compound shammodels::sph::DustConfig::MonofluidTVI is not documented.
- src/shammodels/sph/include/shammodels/sph/SolverConfig.hpp:88: warning: Member ndust (variable) of struct shammodels::sph::DustConfig::MonofluidTVI is not documented.
+ src/shammodels/sph/include/shammodels/sph/SolverConfig.hpp:89: warning: Member ndust (variable) of struct shammodels::sph::DustConfig::MonofluidTVI is not documented.
- src/shammodels/sph/include/shammodels/sph/SolverConfig.hpp:91: warning: Compound shammodels::sph::DustConfig::MonofluidComplete is not documented.
+ src/shammodels/sph/include/shammodels/sph/SolverConfig.hpp:92: warning: Compound shammodels::sph::DustConfig::MonofluidComplete is not documented.
- src/shammodels/sph/include/shammodels/sph/SolverConfig.hpp:92: warning: Member ndust (variable) of struct shammodels::sph::DustConfig::MonofluidComplete is not documented.
+ src/shammodels/sph/include/shammodels/sph/SolverConfig.hpp:93: warning: Member ndust (variable) of struct shammodels::sph::DustConfig::MonofluidComplete is not documented.
- src/shammodels/sph/include/shammodels/sph/SolverConfig.hpp:98: warning: Member current_mode (variable) of struct shammodels::sph::DustConfig is not documented.
+ src/shammodels/sph/include/shammodels/sph/SolverConfig.hpp:99: warning: Member current_mode (variable) of struct shammodels::sph::DustConfig is not documented.

Copy link
Member

@tdavidcl tdavidcl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks !

@tdavidcl tdavidcl merged commit 33a5fa4 into Shamrock-code:main May 6, 2025
34 checks passed
@y-lapeyre y-lapeyre deleted the grid_sedov branch May 6, 2025 11:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants