[SPH] add dust config for SPH and move layout init to SolverConfig by tdavidcl · Pull Request #747 · Shamrock-code/Shamrock

tdavidcl · 2025-01-20T13:17:53Z

This pr add the dust config to the SPH solver config, add the fields in the layout, and move the layout definition to the new SolverConfig.cpp file.

github-actions · 2025-01-20T15:04:47Z

Workflow report

workflow report corresponding to commit 52a22d4
Commiter email is timothee.davidcleris@proton.me

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 yaml...............................................................Passed
detect private key.......................................................Passed
Validate GitHub Workflows................................................Passed
clang-format.............................................................Passed
Check doxygen headers....................................................Passed
Check license headers....................................................Passed
Check #pragma once.......................................................Passed
Check SYCL #include......................................................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 : 60
New warnings : 76
Warnings count : 5564 → 5580 (0.3%)

Detailed changes :

- src/shammodels/sph/Model.hpp:708: warning: Member solver_logs_last_rate() (function) of class shammodels::sph::Model is not documented.
- src/shammodels/sph/Model.hpp:709: warning: Member solver_logs_last_obj_count() (function) of class shammodels::sph::Model is not documented.
- src/shammodels/sph/Model.hpp:710: warning: Member change_htolerance(Tscal in) (function) of class shammodels::sph::Model is not documented.
+ src/shammodels/sph/Model.hpp:711: warning: Member solver_logs_last_rate() (function) of class shammodels::sph::Model is not documented.
+ src/shammodels/sph/Model.hpp:712: warning: Member solver_logs_last_obj_count() (function) of class shammodels::sph::Model is not documented.
+ src/shammodels/sph/Model.hpp:713: warning: Member change_htolerance(Tscal in) (function) of class shammodels::sph::Model is not documented.
- src/shammodels/sph/Model.hpp:786: warning: Member evolve_once_time_expl(f64 t_curr, f64 dt_input) (function) of class shammodels::sph::Model is not documented.
- src/shammodels/sph/Model.hpp:788: warning: Member timestep() (function) of class shammodels::sph::Model is not documented.
+ src/shammodels/sph/Model.hpp:789: warning: Member evolve_once_time_expl(f64 t_curr, f64 dt_input) (function) of class shammodels::sph::Model is not documented.
- src/shammodels/sph/Model.hpp:790: warning: Member evolve_once() (function) of class shammodels::sph::Model is not documented.
+ src/shammodels/sph/Model.hpp:791: warning: Member timestep() (function) of class shammodels::sph::Model is not documented.
+ src/shammodels/sph/Model.hpp:793: warning: Member evolve_once() (function) of class shammodels::sph::Model is not documented.
- src/shammodels/sph/Model.hpp:795: warning: Member evolve_until(Tscal target_time, i32 niter_max) (function) of class shammodels::sph::Model is not documented.
+ src/shammodels/sph/Model.hpp:798: warning: Member evolve_until(Tscal target_time, i32 niter_max) (function) of class shammodels::sph::Model is not documented.
+ src/shammodels/sph/Solver.hpp:119: warning: Member reset_ghost_handler() (function) of class shammodels::sph::Solver is not documented.
+ src/shammodels/sph/Solver.hpp:121: warning: Member build_ghost_cache() (function) of class shammodels::sph::Solver is not documented.
+ src/shammodels/sph/Solver.hpp:122: warning: Member clear_ghost_cache() (function) of class shammodels::sph::Solver is not documented.
+ src/shammodels/sph/Solver.hpp:124: warning: Member merge_position_ghost() (function) of class shammodels::sph::Solver is not documented.
+ src/shammodels/sph/Solver.hpp:127: warning: Member RTree (typedef) of class shammodels::sph::Solver is not documented.
+ src/shammodels/sph/Solver.hpp:128: warning: Member build_merged_pos_trees() (function) of class shammodels::sph::Solver is not documented.
+ src/shammodels/sph/Solver.hpp:129: warning: Member clear_merged_pos_trees() (function) of class shammodels::sph::Solver is not documented.
+ src/shammodels/sph/Solver.hpp:131: warning: Member compute_presteps_rint() (function) of class shammodels::sph::Solver is not documented.
+ src/shammodels/sph/Solver.hpp:132: warning: Member reset_presteps_rint() (function) of class shammodels::sph::Solver is not documented.
- src/shammodels/sph/Solver.hpp:133: warning: Member gen_serial_patch_tree() (function) of class shammodels::sph::Solver is not documented.
- src/shammodels/sph/Solver.hpp:134: warning: Member reset_serial_patch_tree() (function) of class shammodels::sph::Solver is not documented.
+ src/shammodels/sph/Solver.hpp:134: warning: Member start_neighbors_cache() (function) of class shammodels::sph::Solver is not documented.
+ src/shammodels/sph/Solver.hpp:135: warning: Member reset_neighbors_cache() (function) of class shammodels::sph::Solver is not documented.
- src/shammodels/sph/Solver.hpp:137: warning: Member GhostHandle (typedef) of class shammodels::sph::Solver is not documented.
+ src/shammodels/sph/Solver.hpp:137: warning: Member sph_prestep(Tscal time_val, Tscal dt) (function) of class shammodels::sph::Solver is not documented.
- src/shammodels/sph/Solver.hpp:138: warning: Member GhostHandleCache (typedef) of class shammodels::sph::Solver is not documented.
- src/shammodels/sph/Solver.hpp:139: warning: Member PreStepMergedField (typedef) of class shammodels::sph::Solver is not documented.
+ src/shammodels/sph/Solver.hpp:141: warning: Member do_predictor_leapfrog(Tscal dt) (function) of class shammodels::sph::Solver is not documented.
- src/shammodels/sph/Solver.hpp:141: warning: Member gen_ghost_handler(Tscal time_val) (function) of class shammodels::sph::Solver is not documented.
+ src/shammodels/sph/Solver.hpp:143: warning: Member update_artificial_viscosity(Tscal dt) (function) of class shammodels::sph::Solver is not documented.
+ src/shammodels/sph/Solver.hpp:145: warning: Member init_ghost_layout() (function) of class shammodels::sph::Solver is not documented.
+ src/shammodels/sph/Solver.hpp:147: warning: Member communicate_merge_ghosts_fields() (function) of class shammodels::sph::Solver is not documented.
+ src/shammodels/sph/Solver.hpp:148: warning: Member reset_merge_ghosts_fields() (function) of class shammodels::sph::Solver is not documented.
+ src/shammodels/sph/Solver.hpp:150: warning: Member compute_eos_fields() (function) of class shammodels::sph::Solver is not documented.
+ src/shammodels/sph/Solver.hpp:151: warning: Member reset_eos_fields() (function) of class shammodels::sph::Solver is not documented.
+ src/shammodels/sph/Solver.hpp:153: warning: Member prepare_corrector() (function) of class shammodels::sph::Solver is not documented.
+ src/shammodels/sph/Solver.hpp:154: warning: Member update_derivs() (function) of class shammodels::sph::Solver is not documented.
+ src/shammodels/sph/Solver.hpp:163: warning: Member Solver(ShamrockCtx &context) (function) of class shammodels::sph::Solver is not documented.
+ src/shammodels/sph/Solver.hpp:165: warning: Member vtk_do_dump(std::string filename, bool add_patch_world_id) (function) of class shammodels::sph::Solver is not documented.
+ src/shammodels/sph/Solver.hpp:167: warning: Member set_debug_dump(bool _do_debug_dump, std::string _debug_dump_filename) (function) of class shammodels::sph::Solver is not documented.
+ src/shammodels/sph/Solver.hpp:171: warning: Member print_timestep_logs() (function) of class shammodels::sph::Solver is not documented.
- src/shammodels/sph/Solver.hpp:172: warning: Member reset_ghost_handler() (function) of class shammodels::sph::Solver is not documented.
- src/shammodels/sph/Solver.hpp:174: warning: Member build_ghost_cache() (function) of class shammodels::sph::Solver is not documented.
- src/shammodels/sph/Solver.hpp:175: warning: Member clear_ghost_cache() (function) of class shammodels::sph::Solver is not documented.
- src/shammodels/sph/Solver.hpp:177: warning: Member merge_position_ghost() (function) of class shammodels::sph::Solver is not documented.
+ src/shammodels/sph/Solver.hpp:178: warning: Member evolve_once() (function) of class shammodels::sph::Solver is not documented.
- src/shammodels/sph/Solver.hpp:180: warning: Member RTree (typedef) of class shammodels::sph::Solver is not documented.
+ src/shammodels/sph/Solver.hpp:180: warning: Member evolve_once_time_expl(Tscal t_current, Tscal dt_input) (function) of class shammodels::sph::Solver is not documented.
- src/shammodels/sph/Solver.hpp:181: warning: Member build_merged_pos_trees() (function) of class shammodels::sph::Solver is not documented.
- src/shammodels/sph/Solver.hpp:182: warning: Member clear_merged_pos_trees() (function) of class shammodels::sph::Solver is not documented.
- src/shammodels/sph/Solver.hpp:184: warning: Member compute_presteps_rint() (function) of class shammodels::sph::Solver is not documented.
- src/shammodels/sph/Solver.hpp:185: warning: Member reset_presteps_rint() (function) of class shammodels::sph::Solver is not documented.
+ src/shammodels/sph/Solver.hpp:187: warning: Member evolve_until(Tscal target_time, i32 niter_max) (function) of class shammodels::sph::Solver is not documented.
- src/shammodels/sph/Solver.hpp:187: warning: Member start_neighbors_cache() (function) of class shammodels::sph::Solver is not documented.
- src/shammodels/sph/Solver.hpp:188: warning: Member reset_neighbors_cache() (function) of class shammodels::sph::Solver is not documented.
- src/shammodels/sph/Solver.hpp:190: warning: Member sph_prestep(Tscal time_val, Tscal dt) (function) of class shammodels::sph::Solver is not documented.
- src/shammodels/sph/Solver.hpp:194: warning: Member do_predictor_leapfrog(Tscal dt) (function) of class shammodels::sph::Solver is not documented.
- src/shammodels/sph/Solver.hpp:196: warning: Member update_artificial_viscosity(Tscal dt) (function) of class shammodels::sph::Solver is not documented.
- src/shammodels/sph/Solver.hpp:198: warning: Member init_ghost_layout() (function) of class shammodels::sph::Solver is not documented.
- src/shammodels/sph/Solver.hpp:200: warning: Member communicate_merge_ghosts_fields() (function) of class shammodels::sph::Solver is not documented.
- src/shammodels/sph/Solver.hpp:201: warning: Member reset_merge_ghosts_fields() (function) of class shammodels::sph::Solver is not documented.
- src/shammodels/sph/Solver.hpp:203: warning: Member compute_eos_fields() (function) of class shammodels::sph::Solver is not documented.
- src/shammodels/sph/Solver.hpp:204: warning: Member reset_eos_fields() (function) of class shammodels::sph::Solver is not documented.
- src/shammodels/sph/Solver.hpp:206: warning: Member prepare_corrector() (function) of class shammodels::sph::Solver is not documented.
- src/shammodels/sph/Solver.hpp:207: warning: Member update_derivs() (function) of class shammodels::sph::Solver is not documented.
- src/shammodels/sph/Solver.hpp:216: warning: Member Solver(ShamrockCtx &context) (function) of class shammodels::sph::Solver is not documented.
- src/shammodels/sph/Solver.hpp:218: warning: Member vtk_do_dump(std::string filename, bool add_patch_world_id) (function) of class shammodels::sph::Solver is not documented.
- src/shammodels/sph/Solver.hpp:220: warning: Member set_debug_dump(bool _do_debug_dump, std::string _debug_dump_filename) (function) of class shammodels::sph::Solver is not documented.
- src/shammodels/sph/Solver.hpp:224: warning: Member print_timestep_logs() (function) of class shammodels::sph::Solver is not documented.
- src/shammodels/sph/Solver.hpp:231: warning: Member evolve_once() (function) of class shammodels::sph::Solver is not documented.
- src/shammodels/sph/Solver.hpp:233: warning: Member evolve_once_time_expl(Tscal t_current, Tscal dt_input) (function) of class shammodels::sph::Solver is not documented.
- src/shammodels/sph/Solver.hpp:240: warning: Member evolve_until(Tscal target_time, i32 niter_max) (function) of class shammodels::sph::Solver is not documented.
+ src/shammodels/sph/Solver.hpp:80: warning: Member gen_serial_patch_tree() (function) of class shammodels::sph::Solver is not documented.
+ src/shammodels/sph/Solver.hpp:81: warning: Member reset_serial_patch_tree() (function) of class shammodels::sph::Solver is not documented.
+ src/shammodels/sph/Solver.hpp:84: warning: Member GhostHandle (typedef) of class shammodels::sph::Solver is not documented.
+ src/shammodels/sph/Solver.hpp:85: warning: Member GhostHandleCache (typedef) of class shammodels::sph::Solver is not documented.
+ src/shammodels/sph/Solver.hpp:86: warning: Member PreStepMergedField (typedef) of class shammodels::sph::Solver is not documented.
+ src/shammodels/sph/Solver.hpp:88: warning: Member gen_ghost_handler(Tscal time_val) (function) of class shammodels::sph::Solver is not documented.
+ src/shammodels/sph/SolverConfig.hpp:104: warning: Member has_deltav_field() (function) of struct shammodels::sph::DustConfig is not documented.
+ src/shammodels/sph/SolverConfig.hpp:108: warning: Member get_dust_nvar() (function) of struct shammodels::sph::DustConfig is not documented.
+ src/shammodels/sph/SolverConfig.hpp:123: warning: Member check_config() (function) of struct shammodels::sph::DustConfig is not documented.
- src/shammodels/sph/SolverConfig.hpp:203: warning: Member MHDConfig (typedef) of struct shammodels::sph::SolverConfig is not documented.
- src/shammodels/sph/SolverConfig.hpp:204: warning: Member mhd_config (variable) of struct shammodels::sph::SolverConfig is not documented.
- src/shammodels/sph/SolverConfig.hpp:217: warning: Member set_NonIdealMHD(typename MHDConfig::NonIdealMHD v) (function) of struct shammodels::sph::SolverConfig is not documented.
+ src/shammodels/sph/SolverConfig.hpp:257: warning: Member MHDConfig (typedef) of struct shammodels::sph::SolverConfig is not documented.
+ src/shammodels/sph/SolverConfig.hpp:258: warning: Member mhd_config (variable) of struct shammodels::sph::SolverConfig is not documented.
+ src/shammodels/sph/SolverConfig.hpp:271: warning: Member set_NonIdealMHD(typename MHDConfig::NonIdealMHD v) (function) of struct shammodels::sph::SolverConfig is not documented.
+ src/shammodels/sph/SolverConfig.hpp:281: warning: Member DustConfig (typedef) of struct shammodels::sph::SolverConfig is not documented.
+ src/shammodels/sph/SolverConfig.hpp:282: warning: Member dust_config (variable) of struct shammodels::sph::SolverConfig is not documented.
- src/shammodels/sph/SolverConfig.hpp:322: warning: The following parameter of shammodels::sph::SolverConfig::set_eos_locally_isothermalFA2014(Tscal h_over_r) is not documented:
- src/shammodels/sph/SolverConfig.hpp:322: 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/SolverConfig.hpp:322: 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/SolverConfig.hpp:322: 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/SolverConfig.hpp:387: warning: The following parameter of shammodels::sph::SolverConfig::set_eos_locally_isothermalFA2014(Tscal h_over_r) is not documented:
+ src/shammodels/sph/SolverConfig.hpp:387: 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/SolverConfig.hpp:387: 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/SolverConfig.hpp:387: 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/SolverConfig.hpp:676: warning: Member check_config() (function) of struct shammodels::sph::SolverConfig is not documented.
+ src/shammodels/sph/SolverConfig.hpp:678: warning: Member set_layout(shamrock::patch::PatchDataLayout &pdl) (function) of struct shammodels::sph::SolverConfig is not documented.
+ src/shammodels/sph/SolverConfig.hpp:679: warning: Member set_ghost_layout(shamrock::patch::PatchDataLayout &ghost_layout) (function) of struct shammodels::sph::SolverConfig is not documented.
- src/shammodels/sph/SolverConfig.hpp:684: warning: found documented return type for shammodels::sph::to_json_optional that does not return anything
- src/shammodels/sph/SolverConfig.hpp:703: warning: found documented return type for shammodels::sph::from_json_optional that does not return anything
+ src/shammodels/sph/SolverConfig.hpp:754: warning: found documented return type for shammodels::sph::to_json_optional that does not return anything
+ src/shammodels/sph/SolverConfig.hpp:773: warning: found documented return type for shammodels::sph::from_json_optional that does not return anything
+ src/shammodels/sph/SolverConfig.hpp:82: warning: Compound shammodels::sph::DustConfig is not documented.
+ src/shammodels/sph/SolverConfig.hpp:86: warning: Compound shammodels::sph::DustConfig::MonofluidTVI is not documented.
+ src/shammodels/sph/SolverConfig.hpp:87: warning: Member ndust (variable) of struct shammodels::sph::DustConfig::MonofluidTVI is not documented.
+ src/shammodels/sph/SolverConfig.hpp:90: warning: Compound shammodels::sph::DustConfig::MonofluidComplete is not documented.
+ src/shammodels/sph/SolverConfig.hpp:91: warning: Member ndust (variable) of struct shammodels::sph::DustConfig::MonofluidComplete is not documented.
+ src/shammodels/sph/SolverConfig.hpp:97: warning: Member current_mode (variable) of struct shammodels::sph::DustConfig is not documented.
+ src/shammodels/sph/SolverConfig.hpp:99: warning: Member has_epsilon_field() (function) of struct shammodels::sph::DustConfig is not documented.
+ src/shamrock/include/shamrock/scheduler/ShamrockCtx.hpp:104: warning: Member init_sched(u64 crit_split, u64 crit_merge) (function) of class ShamrockCtx is not documented.
- src/shamrock/include/shamrock/scheduler/ShamrockCtx.hpp:107: warning: Member close_sched() (function) of class ShamrockCtx is not documented.
+ src/shamrock/include/shamrock/scheduler/ShamrockCtx.hpp:114: warning: Member close_sched() (function) of class ShamrockCtx is not documented.
- src/shamrock/include/shamrock/scheduler/ShamrockCtx.hpp:117: warning: Member gather_data(u32 rank) (function) of class ShamrockCtx is not documented.
- src/shamrock/include/shamrock/scheduler/ShamrockCtx.hpp:121: warning: Member allgather_data() (function) of class ShamrockCtx is not documented.
+ src/shamrock/include/shamrock/scheduler/ShamrockCtx.hpp:124: warning: Member gather_data(u32 rank) (function) of class ShamrockCtx is not documented.
+ src/shamrock/include/shamrock/scheduler/ShamrockCtx.hpp:128: warning: Member allgather_data() (function) of class ShamrockCtx is not documented.
- src/shamrock/include/shamrock/scheduler/ShamrockCtx.hpp:139: warning: Member set_coord_domain_bound(std::tuple< f64_3, f64_3 > box) (function) of class ShamrockCtx is not documented.
+ src/shamrock/include/shamrock/scheduler/ShamrockCtx.hpp:146: warning: Member set_coord_domain_bound(std::tuple< f64_3, f64_3 > box) (function) of class ShamrockCtx is not documented.
- src/shamrock/include/shamrock/scheduler/ShamrockCtx.hpp:169: warning: Member scheduler_step(bool do_split_merge, bool do_load_balancing) (function) of class ShamrockCtx is not documented.
+ src/shamrock/include/shamrock/scheduler/ShamrockCtx.hpp:176: warning: Member scheduler_step(bool do_split_merge, bool do_load_balancing) (function) of class ShamrockCtx is not documented.
+ src/shamrock/include/shamrock/scheduler/ShamrockCtx.hpp:67: warning: Member get_pdl_write() (function) of class ShamrockCtx is not documented.
- src/shamrock/include/shamrock/scheduler/ShamrockCtx.hpp:68: warning: Member pdata_layout_add_field(std::string fname, u32 nvar) (function) of class ShamrockCtx is not documented.
+ src/shamrock/include/shamrock/scheduler/ShamrockCtx.hpp:75: warning: Member pdata_layout_add_field(std::string fname, u32 nvar) (function) of class ShamrockCtx is not documented.
- src/shamrock/include/shamrock/scheduler/ShamrockCtx.hpp:75: warning: Member pdata_layout_add_field_t(std::string fname, u32 nvar, std::string type) (function) of class ShamrockCtx is not documented.
+ src/shamrock/include/shamrock/scheduler/ShamrockCtx.hpp:82: warning: Member pdata_layout_add_field_t(std::string fname, u32 nvar, std::string type) (function) of class ShamrockCtx is not documented.
- src/shamrock/include/shamrock/scheduler/ShamrockCtx.hpp:82: warning: Member pdata_layout_print() (function) of class ShamrockCtx is not documented.
- src/shamrock/include/shamrock/scheduler/ShamrockCtx.hpp:89: warning: Member dump_status() (function) of class ShamrockCtx is not documented.
+ src/shamrock/include/shamrock/scheduler/ShamrockCtx.hpp:89: warning: Member pdata_layout_print() (function) of class ShamrockCtx is not documented.
+ src/shamrock/include/shamrock/scheduler/ShamrockCtx.hpp:96: warning: Member dump_status() (function) of class ShamrockCtx is not documented.
- src/shamrock/include/shamrock/scheduler/ShamrockCtx.hpp:97: warning: Member init_sched(u64 crit_split, u64 crit_merge) (function) of class ShamrockCtx is not documented.

tdavidcl added 2 commits January 20, 2025 14:15

[SPH] add dust config for SPH and move layout init to SolverConfig

b4b80fc

[SPH] add dust fields to layout

762efc1

tdavidcl added the in-review label Jan 20, 2025

tdavidcl requested a review from y-lapeyre January 20, 2025 13:17

fix

52a22d4

tdavidcl merged commit d025833 into main Jan 21, 2025

tdavidcl deleted the feat/sph/monofluid-fields branch January 21, 2025 14:35

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[SPH] add dust config for SPH and move layout init to SolverConfig#747

[SPH] add dust config for SPH and move layout init to SolverConfig#747
tdavidcl merged 3 commits intomainfrom
feat/sph/monofluid-fields

tdavidcl commented Jan 20, 2025

Uh oh!

github-actions Bot commented Jan 20, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Conversation

tdavidcl commented Jan 20, 2025

Uh oh!

github-actions Bot commented Jan 20, 2025

Workflow report

Pre-commit check report

Clang-tidy diff report

Doxygen diff with main

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Doxygen diff with `main`