Pack/Unpack data for user-data #1224
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Davknapp
added
New feature
and pack and unpack without prefix for the size
Co-authored-by: David Knapp <[email protected]>
Co-authored-by: David Knapp <[email protected]>
add placeholder for internal data handling
sandro-elsweijer
requested changes
Jan 3, 2025
| along with t8code; if not, write to the Free Software Foundation, Inc., | ||
| 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. | ||
| */ | ||
|
|
There was a problem hiding this comment.
Please adapt the file description to the format we use in other files: https://github.com/DLR-AMR/t8code/blob/main/src/t8_eclass.h#L23-L29
| * | ||
| * This function unpacks data from a given buffer into the provided data structure. | ||
| * | ||
| * \tparam T The type of the data to be unpacked. |
| /** | ||
| * Packs the given data into a buffer for communication. | ||
| * | ||
| * \tparam T The type of the data to be packed. |
There was a problem hiding this comment.
Since the class is templated and not the member function I would remove this. And if we leave it T->TType
| return size; | ||
| } | ||
|
|
||
| void |
| SC_CHECK_MPI (mpiret); | ||
| } | ||
|
|
||
| void |
| template <> | ||
| class t8_single_data_handler<enlarged_data<double>> { | ||
| public: | ||
| int |
There was a problem hiding this comment.
inline? You get the drill ^^
| t8code is a C library to manage a collection (a forest) of multiple | ||
| connected adaptive space-trees of general element classes in parallel. | ||
|
|
||
| Copyright (C) 2024 the developers |
There was a problem hiding this comment.
Suggested change
| Copyright (C) 2024 the developers | |
| Copyright (C) 2025 the developers |
Happy New Year 🥳
| along with t8code; if not, write to the Free Software Foundation, Inc., | ||
| 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. | ||
| */ | ||
|
|
There was a problem hiding this comment.
For all files, the other formats are also off
| * | ||
| * @tparam T the type of data | ||
| */ | ||
| template <typename T> |
There was a problem hiding this comment.
Please rename the parameter
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
An interface for arbitrary data.
For new user-data it suffies to implement how a single element should be packed/unpacked.
The routines for vectors of user-data make use of this routine and pack/unpack the data accordingly.
Furthermore it provides a wrapper around the send/recv routine from MPI for to avoid code duplication and easy usage. This part of the interface should be extended in the future to other MPI send/recv routines.
All these boxes must be checked by the reviewers before merging the pull request:
As a reviewer please read through all the code lines and make sure that the code is fully understood, bug free, well-documented and well-structured.
General
The reviewer executed the new code features at least once and checked the results manually
The code follows the t8code coding guidelines
New source/header files are properly added to the Makefiles
The code is well documented
All function declarations, structs/classes and their members have a proper doxygen documentation
All new algorithms and data structures are sufficiently optimal in terms of memory and runtime (If this should be merged, but there is still potential for optimization, create a new issue)
Tests
Github action
The code compiles without warning in debugging and release mode, with and without MPI (this should be executed automatically in a github action)
All tests pass (in various configurations, this should be executed automatically in a github action)
If the Pull request introduces code that is not covered by the github action (for example coupling with a new library):
Scripts and Wiki
script/find_all_source_files.scpto check the indentation of these files.Licence
doc/(or already has one)