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

Feature test cmesh set partition offset #869

Merged
merged 13 commits into from
Jan 11, 2024

Conversation

holke
Copy link
Collaborator

@holke holke commented Nov 29, 2023

Describe your changes here:

Note: Merge #868 first.

Add two test cases for the t8_cmesh_set_partition_offsets function with an underived cmesh.

We build a cmesh from scratch and call t8_cmesh_set_partition_offsets.
in the first test, we destroy the cmesh immediately, in the second we commit the cmesh and check whether it was partitioned correctly.

The tests iterate over the eclasses and a range of tree counts.

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)

According to a comment in the code, t8_cmesh_set_partition_offsets
does not work with underived cmeshes.
We started with test cases to check this comment.
- value ranges over classes and tree count
- check that the cmesh is committed
- check that the cmesh is partitioned according to the offset
@holke holke marked this pull request as draft November 29, 2023 13:52
@holke holke marked this pull request as ready for review November 29, 2023 13:57
Copy link
Collaborator

@Davknapp Davknapp left a comment

Choose a reason for hiding this comment

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

In both Tests you can also move the cmesh, the shmem_array and the initialization of the communicator in the SetUp-function of the class. The counterpart can be moved into the TearDown-function. That way the test shows exactly what is tested.

In the Test cmesh_set_partition_offsets_nocommit nothing is tested, but you say, that we need a "valid partition". Is this something we can test for?

test/t8_cmesh/t8_gtest_cmesh_set_partition_offsets.cxx Outdated Show resolved Hide resolved
test/t8_cmesh/t8_gtest_cmesh_set_partition_offsets.cxx Outdated Show resolved Hide resolved
test/t8_cmesh/t8_gtest_cmesh_set_partition_offsets.cxx Outdated Show resolved Hide resolved
test/t8_cmesh/t8_gtest_cmesh_set_partition_offsets.cxx Outdated Show resolved Hide resolved
test/t8_cmesh/t8_gtest_cmesh_set_partition_offsets.cxx Outdated Show resolved Hide resolved
test/t8_cmesh/t8_gtest_cmesh_set_partition_offsets.cxx Outdated Show resolved Hide resolved
@holke holke enabled auto-merge January 11, 2024 12:22
@holke holke assigned Davknapp and unassigned holke Jan 11, 2024
@holke holke merged commit 3802624 into main Jan 11, 2024
8 checks passed
@holke holke deleted the feature-test_cmesh_set_partition_offset branch January 11, 2024 13:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants