Skip to content
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

Pack/Unpack data for user-data #1224

Open
wants to merge 97 commits into
base: main
Choose a base branch
from
Open

Pack/Unpack data for user-data #1224

wants to merge 97 commits into from

Conversation

Davknapp
Copy link
Collaborator

@Davknapp Davknapp commented Aug 20, 2024

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

  • The code is covered in an existing or new test case using Google Test

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):

    • Should this use case be added to the github action?
    • If not, does the specific use case compile and all tests pass (check manually)

Scripts and Wiki

  • If a new directory with source-files is added, it must be covered by the script/find_all_source_files.scp to check the indentation of these files.
  • If this PR introduces a new feature, it must be covered in an example/tutorial and a Wiki article.

Licence

  • The author added a BSD statement to doc/ (or already has one)

@Davknapp Davknapp added New feature Adds a new feature to the code draft Enhance the visibility that this is a draft. C++ priority: low Should be solved eventually workload: medium Would take a week or less labels Aug 20, 2024
Copy link
Collaborator

@sandro-elsweijer sandro-elsweijer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe its just a pet peeve of mine, but none of your docstrings is indented

src/t8_data/t8_data_handler_base.hxx Show resolved Hide resolved
src/t8_data/t8_data_handler_base.hxx Outdated Show resolved Hide resolved
src/t8_data/t8_data_handler_base.hxx Outdated Show resolved Hide resolved
src/t8_data/t8_data_packs/t8_enlarged_stdtypes.hxx Outdated Show resolved Hide resolved
src/t8_data/t8_data_packs/t8_enlarged_stdtypes.hxx Outdated Show resolved Hide resolved
src/t8_data/t8_data_packs/t8_enlarged_stdtypes.hxx Outdated Show resolved Hide resolved
src/t8_data/t8_data_handler.hxx Outdated Show resolved Hide resolved
src/t8_data/t8_data_handler_base.hxx Show resolved Hide resolved
test/t8_data/t8_gtest_data_handler.cxx Outdated Show resolved Hide resolved
@Davknapp
Copy link
Collaborator Author

A C-interface will be implemented in #1357

Copy link
Collaborator

@sandro-elsweijer sandro-elsweijer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor comments about the docstring style

Comment on lines +43 to +44
* \class t8_single_data_handler
* \brief A template specialisation for handling single enlarged ints (int plus an additional int, this
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* \class t8_single_data_handler
* \brief A template specialisation for handling single enlarged ints (int plus an additional int, this
* A template specialisation for handling single enlarged ints (int plus an additional int, this

*/

/**
* \brief pseudo_types for testing
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* \brief pseudo_types for testing
* pseudo_types for testing

Comment on lines +45 to +46
* \class t8_single_data_handler
* \brief A template class for handling single data items.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* \class t8_single_data_handler
* \brief A template class for handling single data items.
* Template class for handling single data items.


private:
/**
* \brief A shared pointer to a vector of data.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* \brief A shared pointer to a vector of data.
* A shared pointer to a vector of data.

*/
std::shared_ptr<std::vector<TType>> m_data;
/**
* \brief A single data handler for the data type T.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* \brief A single data handler for the data type T.
* A single data handler for the data type T.

}

/**
* \brief Get the data.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* \brief Get the data.
* Get the data.

Comment on lines +133 to +134
* \class t8_data_handler
* \brief A template class for handling data in a distributed environment.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* \class t8_data_handler
* \brief A template class for handling data in a distributed environment.
* A template class for handling data in a distributed environment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C++ New feature Adds a new feature to the code priority: low Should be solved eventually workload: medium Would take a week or less
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants