[SPH][Setup] fix and add control over initial h factor for disc setup

[tdavidcl]

@y-lapeyre, This should fix the issue. I moved the factor to a global factor on h for clarity and added a new parameter h_init_factor (default = 0.8) which would be the factor applied to the smoothing lenght deduced from the density generated by the disc setup.

This should not require any change as it has a default value but will add the possibility to control it if needed.

[y-lapeyre]

Perfect, thank you!

[github-actions]

Workflow report

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

Pre-commit check report

Pre-commit check: ✅

[WARNING] The 'rev' field of repo 'https://github.com/psf/black' appears to be a mutable reference (moving tag / branch).  Mutable references are never updated after first install and are not supported.  See https://pre-commit.com/#using-the-latest-version-for-a-repository for more details.  Hint: `pre-commit autoupdate` often fixes this.
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
black....................................................................Passed
isort....................................................................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 : 11
New warnings : 11
Warnings count : 5696 → 5696 (0.0%)

Detailed changes :

- src/shammodels/sph/include/shammodels/sph/modules/SPHSetup.hpp:53: warning: Member make_generator_disc_mc(Tscal part_mass, Tscal disc_mass, Tscal r_in, Tscal r_out, std::function< Tscal(Tscal)> sigma_profile, std::function< Tscal(Tscal)> H_profile, std::function< Tscal(Tscal)> rot_profile, std::function< Tscal(Tscal)> cs_profile, std::mt19937 eng) (function) of class shammodels::sph::modules::SPHSetup is not documented.
+ src/shammodels/sph/include/shammodels/sph/modules/SPHSetup.hpp:53: warning: Member make_generator_disc_mc(Tscal part_mass, Tscal disc_mass, Tscal r_in, Tscal r_out, std::function< Tscal(Tscal)> sigma_profile, std::function< Tscal(Tscal)> H_profile, std::function< Tscal(Tscal)> rot_profile, std::function< Tscal(Tscal)> cs_profile, std::mt19937 eng, Tscal init_h_factor) (function) of class shammodels::sph::modules::SPHSetup is not documented.
- src/shammodels/sph/include/shammodels/sph/modules/SPHSetup.hpp:65: warning: Member make_combiner_add(SetupNodePtr parent1, SetupNodePtr parent2) (function) of class shammodels::sph::modules::SPHSetup is not documented.
+ src/shammodels/sph/include/shammodels/sph/modules/SPHSetup.hpp:66: warning: Member make_combiner_add(SetupNodePtr parent1, SetupNodePtr parent2) (function) of class shammodels::sph::modules::SPHSetup is not documented.
- src/shammodels/sph/include/shammodels/sph/modules/SPHSetup.hpp:67: warning: Member make_modifier_warp_disc(SetupNodePtr parent, Tscal Rwarp, Tscal Hwarp, Tscal inclination, Tscal posangle) (function) of class shammodels::sph::modules::SPHSetup is not documented.
+ src/shammodels/sph/include/shammodels/sph/modules/SPHSetup.hpp:68: warning: Member make_modifier_warp_disc(SetupNodePtr parent, Tscal Rwarp, Tscal Hwarp, Tscal inclination, Tscal posangle) (function) of class shammodels::sph::modules::SPHSetup is not documented.
- src/shammodels/sph/include/shammodels/sph/modules/setup/GeneratorMCDisc.hpp:107: warning: Compound shammodels::sph::modules::GeneratorMCDisc< Tvec, SPHKernel >::DiscIterator is not documented.
+ src/shammodels/sph/include/shammodels/sph/modules/setup/GeneratorMCDisc.hpp:109: warning: Compound shammodels::sph::modules::GeneratorMCDisc< Tvec, SPHKernel >::DiscIterator is not documented.
- src/shammodels/sph/include/shammodels/sph/modules/setup/GeneratorMCDisc.hpp:130: warning: Member DiscIterator(Tscal part_mass, Tscal disc_mass, Tscal r_in, Tscal r_out, std::function< Tscal(Tscal)> sigma_profile, std::function< Tscal(Tscal)> H_profile, std::function< Tscal(Tscal)> rot_profile, std::function< Tscal(Tscal)> cs_profile, std::mt19937 eng) (function) of class shammodels::sph::modules::GeneratorMCDisc::DiscIterator is not documented.
+ src/shammodels/sph/include/shammodels/sph/modules/setup/GeneratorMCDisc.hpp:132: warning: Member DiscIterator(Tscal part_mass, Tscal disc_mass, Tscal r_in, Tscal r_out, std::function< Tscal(Tscal)> sigma_profile, std::function< Tscal(Tscal)> H_profile, std::function< Tscal(Tscal)> rot_profile, std::function< Tscal(Tscal)> cs_profile, std::mt19937 eng) (function) of class shammodels::sph::modules::GeneratorMCDisc::DiscIterator is not documented.
- src/shammodels/sph/include/shammodels/sph/modules/setup/GeneratorMCDisc.hpp:162: warning: Member is_done() (function) of class shammodels::sph::modules::GeneratorMCDisc::DiscIterator is not documented.
+ src/shammodels/sph/include/shammodels/sph/modules/setup/GeneratorMCDisc.hpp:164: warning: Member is_done() (function) of class shammodels::sph::modules::GeneratorMCDisc::DiscIterator is not documented.
- src/shammodels/sph/include/shammodels/sph/modules/setup/GeneratorMCDisc.hpp:164: warning: Member next() (function) of class shammodels::sph::modules::GeneratorMCDisc::DiscIterator is not documented.
+ src/shammodels/sph/include/shammodels/sph/modules/setup/GeneratorMCDisc.hpp:166: warning: Member next() (function) of class shammodels::sph::modules::GeneratorMCDisc::DiscIterator is not documented.
- src/shammodels/sph/include/shammodels/sph/modules/setup/GeneratorMCDisc.hpp:166: warning: Member next_n(u32 nmax) (function) of class shammodels::sph::modules::GeneratorMCDisc::DiscIterator is not documented.
+ src/shammodels/sph/include/shammodels/sph/modules/setup/GeneratorMCDisc.hpp:168: warning: Member next_n(u32 nmax) (function) of class shammodels::sph::modules::GeneratorMCDisc::DiscIterator is not documented.
- src/shammodels/sph/include/shammodels/sph/modules/setup/GeneratorMCDisc.hpp:178: warning: Member skip(u32 n) (function) of class shammodels::sph::modules::GeneratorMCDisc::DiscIterator is not documented.
+ src/shammodels/sph/include/shammodels/sph/modules/setup/GeneratorMCDisc.hpp:180: warning: Member skip(u32 n) (function) of class shammodels::sph::modules::GeneratorMCDisc::DiscIterator is not documented.
- src/shammodels/sph/include/shammodels/sph/modules/setup/GeneratorMCDisc.hpp:72: warning: Member GeneratorMCDisc(ShamrockCtx &context, Config &solver_config, Tscal part_mass, Tscal disc_mass, Tscal r_in, Tscal r_out, std::function< Tscal(Tscal)> sigma_profile, std::function< Tscal(Tscal)> H_profile, std::function< Tscal(Tscal)> rot_profile, std::function< Tscal(Tscal)> cs_profile, std::mt19937 eng) (function) of class shammodels::sph::modules::GeneratorMCDisc is not documented.
+ src/shammodels/sph/include/shammodels/sph/modules/setup/GeneratorMCDisc.hpp:73: warning: Member GeneratorMCDisc(ShamrockCtx &context, Config &solver_config, Tscal part_mass, Tscal disc_mass, Tscal r_in, Tscal r_out, std::function< Tscal(Tscal)> sigma_profile, std::function< Tscal(Tscal)> H_profile, std::function< Tscal(Tscal)> rot_profile, std::function< Tscal(Tscal)> cs_profile, std::mt19937 eng, Tscal init_h_factor) (function) of class shammodels::sph::modules::GeneratorMCDisc is not documented.
- src/shammodels/sph/src/pySPHModel.cpp:716: warning: Member Register_pymod(pysphmodel) (function) of file pySPHModel.cpp is not documented.
+ src/shammodels/sph/src/pySPHModel.cpp:719: warning: Member Register_pymod(pysphmodel) (function) of file pySPHModel.cpp is not documented.