[Patch] PatchDataField : replace size() by get_val_cnt()

[tdavidcl]

This function was introduced to replace the legacy one size() which could be confused with
the of the buffer, which is not required to be the same.

This pr also add a few guards on function that are wrong for nvar!=1

[github-actions]

Workflow report

workflow report corresponding to commit e675b16
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 : 62
New warnings : 61
Warnings count : 5565 → 5564 (-0.0%)

Detailed changes :

- src/shammodels/sph/Model.hpp:420: warning: Member add_cube_disc_3d(Tvec center, u32 Npart, Tscal p, Tscal rho_0, Tscal m, Tscal r_in, Tscal r_out, Tscal q, Tscal cmass) (function) of class shammodels::sph::Model is not documented.
+ src/shammodels/sph/Model.hpp:424: warning: Member add_cube_disc_3d(Tvec center, u32 Npart, Tscal p, Tscal rho_0, Tscal m, Tscal r_in, Tscal r_out, Tscal q, Tscal cmass) (function) of class shammodels::sph::Model is not documented.
- src/shammodels/sph/Model.hpp:574: warning: Member remap_positions(std::function< Tvec(Tvec)> map) (function) of class shammodels::sph::Model is not documented.
- src/shammodels/sph/Model.hpp:576: warning: Member push_particle(std::vector< Tvec > &part_pos_insert, std::vector< Tscal > &part_hpart_insert, std::vector< Tscal > &part_u_insert) (function) of class shammodels::sph::Model is not documented.
+ src/shammodels/sph/Model.hpp:578: warning: Member remap_positions(std::function< Tvec(Tvec)> map) (function) of class shammodels::sph::Model is not documented.
+ src/shammodels/sph/Model.hpp:580: warning: Member push_particle(std::vector< Tvec > &part_pos_insert, std::vector< Tscal > &part_hpart_insert, std::vector< Tscal > &part_u_insert) (function) of class shammodels::sph::Model is not documented.
- src/shammodels/sph/Model.hpp:582: warning: Member set_value_in_a_box(std::string field_name, T val, std::pair< Tvec, Tvec > box) (function) of class shammodels::sph::Model is not documented.
+ src/shammodels/sph/Model.hpp:586: warning: Member set_value_in_a_box(std::string field_name, T val, std::pair< Tvec, Tvec > box) (function) of class shammodels::sph::Model is not documented.
- src/shammodels/sph/Model.hpp:609: warning: Member set_value_in_sphere(std::string field_name, T val, Tvec center, Tscal radius) (function) of class shammodels::sph::Model is not documented.
+ src/shammodels/sph/Model.hpp:617: warning: Member set_value_in_sphere(std::string field_name, T val, Tvec center, Tscal radius) (function) of class shammodels::sph::Model is not documented.
- src/shammodels/sph/Model.hpp:637: warning: Member add_kernel_value(std::string field_name, T val, Tvec center, Tscal h_ker) (function) of class shammodels::sph::Model is not documented.
+ src/shammodels/sph/Model.hpp:649: warning: Member add_kernel_value(std::string field_name, T val, Tvec center, Tscal h_ker) (function) of class shammodels::sph::Model is not documented.
- src/shammodels/sph/Model.hpp:664: warning: Member get_sum(std::string name) (function) of class shammodels::sph::Model is not documented.
- src/shammodels/sph/Model.hpp:680: warning: Member get_closest_part_to(Tvec pos) (function) of class shammodels::sph::Model is not documented.
+ src/shammodels/sph/Model.hpp:680: warning: Member get_sum(std::string name) (function) of class shammodels::sph::Model is not documented.
- src/shammodels/sph/Model.hpp:690: warning: Member set_solver_config(typename Solver::Config cfg) (function) of class shammodels::sph::Model is not documented.
- src/shammodels/sph/Model.hpp:692: warning: Member solver_logs_last_rate() (function) of class shammodels::sph::Model is not documented.
- src/shammodels/sph/Model.hpp:693: warning: Member solver_logs_last_obj_count() (function) of class shammodels::sph::Model is not documented.
- src/shammodels/sph/Model.hpp:694: warning: Member change_htolerance(Tscal in) (function) of class shammodels::sph::Model is not documented.
+ src/shammodels/sph/Model.hpp:696: warning: Member get_closest_part_to(Tvec pos) (function) of class shammodels::sph::Model is not documented.
+ src/shammodels/sph/Model.hpp:706: warning: Member set_solver_config(typename Solver::Config cfg) (function) of class shammodels::sph::Model is not documented.
+ 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:770: 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:772: warning: Member timestep() (function) of class shammodels::sph::Model is not documented.
- src/shammodels/sph/Model.hpp:774: warning: Member evolve_once() (function) of class shammodels::sph::Model is not documented.
- src/shammodels/sph/Model.hpp:779: warning: Member evolve_until(Tscal target_time, i32 niter_max) (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:790: 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/shamrock/include/shamrock/legacy/patch/comm/patch_object_mover.hpp:103: warning: Member reatribute_particles< f32_3 >(PatchScheduler &sched, SerialPatchTree< f32_3 > &sptree, bool periodic) (function) of file patch_object_mover.hpp is not documented.
- src/shamrock/include/shamrock/legacy/patch/comm/patch_object_mover.hpp:317: warning: Member reatribute_particles< f64_3 >(PatchScheduler &sched, SerialPatchTree< f64_3 > &sptree, bool periodic) (function) of file patch_object_mover.hpp is not documented.
+ src/shamrock/include/shamrock/legacy/patch/comm/patch_object_mover.hpp:341: warning: Member reatribute_particles< f64_3 >(PatchScheduler &sched, SerialPatchTree< f64_3 > &sptree, bool periodic) (function) of file patch_object_mover.hpp is not documented.
- src/shamrock/include/shamrock/legacy/patch/comm/patch_object_mover.hpp:87: warning: Member reatribute_particles(PatchScheduler &sched, SerialPatchTree< vecprec > &sptree, bool periodic) (function) of file patch_object_mover.hpp is not documented.
- src/shamrock/include/shamrock/legacy/patch/comm/patch_object_mover.hpp:91: warning: Member reatribute_particles< f32_3 >(PatchScheduler &sched, SerialPatchTree< f32_3 > &sptree, bool periodic) (function) of file patch_object_mover.hpp is not documented.
+ src/shamrock/include/shamrock/legacy/patch/comm/patch_object_mover.hpp:99: warning: Member reatribute_particles(PatchScheduler &sched, SerialPatchTree< vecprec > &sptree, bool periodic) (function) of file patch_object_mover.hpp is not documented.
- src/shamrock/include/shamrock/patch/PatchData.hpp:403: warning: argument 'pdat' of command @param is not found in the argument list of shamrock::patch::PatchData::fetch_data(std::string key)
+ src/shamrock/include/shamrock/patch/PatchData.hpp:404: warning: argument 'pdat' of command @param is not found in the argument list of shamrock::patch::PatchData::fetch_data(std::string key)
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:152: warning: Member is_empty() const (function) of class PatchDataField is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:152: warning: Member size() const (function) of class PatchDataField is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:154: warning: Member is_empty() const (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:154: warning: Member memsize() const (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:156: warning: Member get_nvar() const (function) of class PatchDataField is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:156: warning: Member memsize() const (function) of class PatchDataField is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:158: warning: Member get_nvar() const (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:158: warning: Member get_obj_cnt() const (function) of class PatchDataField is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:160: warning: Member get_obj_cnt() const (function) of class PatchDataField is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:162: warning: Member get_name() const (function) of class PatchDataField is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:165: warning: Member resize(u32 new_obj_cnt) (function) of class PatchDataField is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:167: warning: Member reserve(u32 new_obj_cnt) (function) of class PatchDataField is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:169: warning: Member expand(u32 obj_to_add) (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:171: warning: Member get_name() const (function) of class PatchDataField is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:171: warning: Member shrink(u32 obj_to_rem) (function) of class PatchDataField is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:173: warning: Member insert_element(T v) (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:174: warning: Member resize(u32 new_obj_cnt) (function) of class PatchDataField is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:175: warning: Member apply_offset(T off) (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:176: warning: Member reserve(u32 new_obj_cnt) (function) of class PatchDataField is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:177: warning: Member insert(PatchDataField< T > &f2) (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:178: warning: Member expand(u32 obj_to_add) (function) of class PatchDataField is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:179: warning: Member overwrite(PatchDataField< T > &f2, u32 obj_cnt) (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:180: warning: Member shrink(u32 obj_to_rem) (function) of class PatchDataField is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:181: warning: Member override(sycl::buffer< T > &data, u32 cnt) (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:182: warning: Member insert_element(T v) (function) of class PatchDataField is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:183: warning: Member override(std::vector< T > &data, u32 cnt) (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:184: warning: Member apply_offset(T off) (function) of class PatchDataField is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:185: warning: Member override(const T val) (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:186: warning: Member insert(PatchDataField< T > &f2) (function) of class PatchDataField is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:187: warning: Member synchronize_buf() (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:188: warning: Member overwrite(PatchDataField< T > &f2, u32 obj_cnt) (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:190: warning: Member override(sycl::buffer< T > &data, u32 cnt) (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:192: warning: Member override(std::vector< T > &data, u32 cnt) (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:194: warning: Member override(const T val) (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:196: warning: Member synchronize_buf() (function) of class PatchDataField is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:290: warning: Member get_elements_with_range(Lambdacd &&cd_true, T vmin, T vmax) (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:299: warning: Member get_elements_with_range(Lambdacd &&cd_true, T vmin, T vmax) (function) of class PatchDataField is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:307: warning: Member get_elements_with_range_buf(Lambdacd &&cd_true, T vmin, T vmax) (function) of class PatchDataField is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:314: warning: Member check_err_range(Lambdacd &&cd_true, T vmin, T vmax, std::string add_log="") (function) of class PatchDataField is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:316: warning: Member extract_element(u32 pidx, PatchDataField< T > &to) (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:316: warning: Member get_elements_with_range_buf(Lambdacd &&cd_true, T vmin, T vmax) (function) of class PatchDataField is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:318: warning: Member check_field_match(PatchDataField< T > &f2) (function) of class PatchDataField is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:320: warning: Member field_raz() (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:323: warning: Member check_err_range(Lambdacd &&cd_true, T vmin, T vmax, std::string add_log="") (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:325: warning: Member extract_element(u32 pidx, PatchDataField< T > &to) (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:327: warning: Member check_field_match(PatchDataField< T > &f2) (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:329: warning: Member field_raz() (function) of class PatchDataField is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:332: warning: Member append_subset_to(sycl::buffer< u32 > &idxs_buf, u32 sz, PatchDataField &pfield) (function) of class PatchDataField is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:334: warning: Member make_new_from_subset(sycl::buffer< u32 > &idxs_buf, u32 sz) (function) of class PatchDataField is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:340: warning: Member gen_mock_data(u32 obj_cnt, std::mt19937 &eng) (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:341: warning: Member append_subset_to(sycl::buffer< u32 > &idxs_buf, u32 sz, PatchDataField &pfield) (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:343: warning: Member make_new_from_subset(sycl::buffer< u32 > &idxs_buf, u32 sz) (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:349: warning: Member gen_mock_data(u32 obj_cnt, std::mt19937 &eng) (function) of class PatchDataField is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:415: warning: Member compute_max() (function) of class PatchDataField is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:416: warning: Member compute_min() (function) of class PatchDataField is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:417: warning: Member compute_sum() (function) of class PatchDataField is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:419: warning: Member compute_dot_sum() (function) of class PatchDataField is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:421: warning: Member has_nan() (function) of class PatchDataField is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:422: warning: Member has_inf() (function) of class PatchDataField is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:423: warning: Member has_nan_or_inf() (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:424: warning: Member compute_max() (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:425: warning: Member compute_min() (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:426: warning: Member compute_sum() (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:428: warning: Member compute_dot_sum() (function) of class PatchDataField is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:429: warning: Member mock_field(u64 seed, u32 obj_cnt, std::string name, u32 nvar) (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:430: warning: Member has_nan() (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:431: warning: Member has_inf() (function) of class PatchDataField is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:431: warning: Member mock_field(u64 seed, u32 obj_cnt, std::string name, u32 nvar, T vmin, T vmax) (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:432: warning: Member has_nan_or_inf() (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:438: warning: Member mock_field(u64 seed, u32 obj_cnt, std::string name, u32 nvar) (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:440: warning: Member mock_field(u64 seed, u32 obj_cnt, std::string name, u32 nvar, T vmin, T vmax) (function) of class PatchDataField is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:551: warning: Compound PatchDataRangeCheckError is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:553: warning: Member PatchDataRangeCheckError(const char *message) (function) of class PatchDataRangeCheckError is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:555: warning: Member PatchDataRangeCheckError(const std::string &message) (function) of class PatchDataRangeCheckError is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:559: warning: Member what() const noexcept override (function) of class PatchDataRangeCheckError is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:562: warning: Member msg_ (variable) of class PatchDataRangeCheckError is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:564: warning: Compound PatchDataRangeCheckError is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:566: warning: Member PatchDataRangeCheckError(const char *message) (function) of class PatchDataRangeCheckError is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:568: warning: Member PatchDataRangeCheckError(const std::string &message) (function) of class PatchDataRangeCheckError is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:572: warning: Member what() const noexcept override (function) of class PatchDataRangeCheckError is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:575: warning: Member msg_ (variable) of class PatchDataRangeCheckError is not documented.
- src/shamrock/src/patch/PatchDataField.cpp:484: warning: Member obj_mock_cnt (variable) of file PatchDataField.cpp is not documented.
+ src/shamrock/src/patch/PatchDataField.cpp:489: warning: Member obj_mock_cnt (variable) of file PatchDataField.cpp is not documented.