Skip to content

[Patch] In place ghost zones in PatchDataField #895

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

tdavidcl
Copy link
Member

No description provided.

@tdavidcl tdavidcl added the Draft label Mar 31, 2025
Copy link

Workflow report

workflow report corresponding to commit beeef71
Commiter email is [email protected]

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

Test pipeline can run.

Clang-tidy diff report

/__w/Shamrock/Shamrock/src/shamrock/include/shamrock/patch/PatchDataField.hpp:166:16: warning: returning reference to local temporary object [clang-diagnostic-return-stack-address]
  166 |         return ghost_obj_cnt + obj_cnt;
      |                ^~~~~~~~~~~~~~~~~~~~~~~

1 warning generated.

Doxygen diff with main

Removed warnings : 52
New warnings : 61
Warnings count : 5694 → 5703 (0.2%)

Detailed changes :
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:104: warning: Member Field_type (typedef) of class PatchDataField is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:106: warning: Member PatchDataField(std::string name, u32 nvar) (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:107: warning: Member Field_type (typedef) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:109: warning: Member PatchDataField(std::string name, u32 nvar) (function) of class PatchDataField is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:110: warning: Member PatchDataField(std::string name, u32 nvar, u32 obj_cnt) (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:113: warning: Member PatchDataField(std::string name, u32 nvar, u32 obj_cnt) (function) of class PatchDataField is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:114: warning: Member PatchDataField(const PatchDataField &other) (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:117: warning: Member PatchDataField(sham::DeviceBuffer< T > &&moved_buf, u32 obj_cnt, std::string name, u32 nvar) (function) of class PatchDataField is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:118: warning: Member PatchDataField(sham::DeviceBuffer< T > &&moved_buf, u32 obj_cnt, std::string name, u32 nvar) (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:122: warning: Member PatchDataField(sycl::buffer< T > &&moved_buf, u32 obj_cnt, std::string name, u32 nvar) (function) of class PatchDataField is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:123: warning: Member PatchDataField(sycl::buffer< T > &&moved_buf, u32 obj_cnt, std::string name, u32 nvar) (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:128: warning: Member PatchDataField(const PatchDataField &other) (function) of class PatchDataField is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:135: warning: Member duplicate() const (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:138: warning: Member duplicate() const (function) of class PatchDataField is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:140: warning: Member duplicate(std::string new_name) const (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:143: warning: Member duplicate(std::string new_name) const (function) of class PatchDataField is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:147: warning: Member duplicate_to_ptr() const (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:150: warning: Member duplicate_to_ptr() const (function) of class PatchDataField is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:152: warning: Member get_buf() (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:155: warning: Member get_buf() (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 is_empty() const (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:159: warning: Member has_ghost_zone() 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:161: warning: Member get_nvar() const (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:163: warning: Member get_obj_cnt() const (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:164: warning: Member get_obj_cnt_ghost() const (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:165: warning: Member get_obj_cnt_with_ghost() const (function) of class PatchDataField is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:173: warning: Member get_name() const (function) of class PatchDataField is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:176: warning: Member resize(u32 new_obj_cnt) (function) of class PatchDataField is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:178: warning: Member reserve(u32 new_obj_cnt) (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:179: warning: Member get_val_cnt_ghost() const (function) of class PatchDataField is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:180: warning: Member expand(u32 obj_to_add) (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:180: warning: Member get_val_cnt_with_ghost() const (function) of class PatchDataField is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:182: warning: Member shrink(u32 obj_to_rem) (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:184: warning: Member get_name() const (function) of class PatchDataField is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:184: warning: Member insert_element(T v) (function) of class PatchDataField is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:186: warning: Member apply_offset(T off) (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:186: warning: Member resize(u32 new_obj_cnt, u32 new_ghost_obj_cnt) (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:187: warning: Member reserve(u32 new_obj_cnt, u32 new_ghost_obj_cnt) (function) of class PatchDataField is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:188: warning: Member insert(PatchDataField< T > &f2) (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:189: warning: Member set_ghost_zone_count(u32 new_ghost_obj_cnt) (function) of class PatchDataField is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:190: warning: Member overwrite(PatchDataField< T > &f2, u32 obj_cnt) (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:191: warning: Member erase_ghost_zone() (function) of class PatchDataField is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:192: warning: Member override(sycl::buffer< T > &data, u32 cnt) (function) of class PatchDataField is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:194: 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 resize(u32 new_obj_cnt) (function) of class PatchDataField is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:196: warning: Member override(const T val) (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:196: warning: Member reserve(u32 new_obj_cnt) (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:198: warning: Member expand(u32 obj_to_add) (function) of class PatchDataField is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:198: warning: Member synchronize_buf() (function) of class PatchDataField is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:200: warning: Member copy_to_stdvec() (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:200: warning: Member shrink(u32 obj_to_rem) (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:202: warning: Member insert_element(T v) (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:204: warning: Member apply_offset(T off) (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:206: warning: Member insert(PatchDataField< T > &f2) (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:208: warning: Member overwrite(PatchDataField< T > &f2, u32 obj_cnt) (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:210: warning: Member override(sycl::buffer< T > &data, u32 cnt) (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:212: warning: Member override(std::vector< T > &data, u32 cnt) (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:214: warning: Member override(const T val) (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:216: warning: Member synchronize_buf() (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:218: warning: Member copy_to_stdvec() (function) of class PatchDataField is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:334: 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:351: 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:352: 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:358: 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:360: warning: Member extract_element(u32 pidx, PatchDataField< T > &to) (function) of class PatchDataField is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:362: warning: Member check_field_match(PatchDataField< T > &f2) (function) of class PatchDataField is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:364: warning: Member field_raz() (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:369: 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:376: 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:376: 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:378: warning: Member extract_element(u32 pidx, PatchDataField< T > &to) (function) of class PatchDataField is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:378: 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:380: warning: Member check_field_match(PatchDataField< T > &f2) (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:382: warning: Member field_raz() (function) of class PatchDataField is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:384: 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:394: 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:396: 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:402: 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:459: warning: Member compute_max() (function) of class PatchDataField is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:460: warning: Member compute_min() (function) of class PatchDataField is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:461: warning: Member compute_sum() (function) of class PatchDataField is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:463: warning: Member compute_dot_sum() (function) of class PatchDataField is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:465: warning: Member has_nan() (function) of class PatchDataField is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:466: warning: Member has_inf() (function) of class PatchDataField is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:467: warning: Member has_nan_or_inf() (function) of class PatchDataField is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:473: 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:475: 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:477: warning: Member compute_max() (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:478: warning: Member compute_min() (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:479: warning: Member compute_sum() (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:481: warning: Member compute_dot_sum() (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:483: warning: Member has_nan() (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:484: warning: Member has_inf() (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:485: warning: Member has_nan_or_inf() (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:491: 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:493: 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:599: warning: Compound PatchDataRangeCheckError is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:601: warning: Member PatchDataRangeCheckError(const char *message) (function) of class PatchDataRangeCheckError is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:603: warning: Member PatchDataRangeCheckError(const std::string &message) (function) of class PatchDataRangeCheckError is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:607: warning: Member what() const noexcept override (function) of class PatchDataRangeCheckError is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:610: warning: Member msg_ (variable) of class PatchDataRangeCheckError is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:626: warning: Compound PatchDataRangeCheckError is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:628: warning: Member PatchDataRangeCheckError(const char *message) (function) of class PatchDataRangeCheckError is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:630: warning: Member PatchDataRangeCheckError(const std::string &message) (function) of class PatchDataRangeCheckError is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:634: warning: Member what() const noexcept override (function) of class PatchDataRangeCheckError is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:637: warning: Member msg_ (variable) of class PatchDataRangeCheckError is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:89: warning: Member PatchDataField(PatchDataField &&other) noexcept (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:90: warning: Member PatchDataField(PatchDataField &&other) noexcept (function) of class PatchDataField is not documented.
- src/shamrock/include/shamrock/patch/PatchDataField.hpp:93: warning: Member operator=(PatchDataField &&other) noexcept (function) of class PatchDataField is not documented.
+ src/shamrock/include/shamrock/patch/PatchDataField.hpp:95: warning: Member operator=(PatchDataField &&other) noexcept (function) of class PatchDataField is not documented.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant