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

Add doc and check for t8_cmesh_set_partition_uniform #1096

Merged
merged 1 commit into from
Jul 4, 2024

Conversation

lukasdreyer
Copy link
Collaborator

@lukasdreyer lukasdreyer commented Jun 20, 2024

Describe your changes here:
t8_cmesh_set_partition_uniform is only allowed to be called when deriving a cmesh, since when commiting from stash we do not know which proc is responsible for which part of the tree information.

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)

@lukasdreyer lukasdreyer force-pushed the enhancement-cmesh_uniform_doc branch from 5d3f1e5 to 3371d37 Compare June 20, 2024 09:08
@lukasdreyer lukasdreyer changed the title Add documentation and check that t8_cmesh_set_partition_uniform is on… Add doc and check for t8_cmesh_set_partition_uniform Jun 20, 2024
@lukasdreyer lukasdreyer marked this pull request as ready for review June 21, 2024 07:17
@Niklas997 Niklas997 merged commit f81357e into main Jul 4, 2024
10 checks passed
@Niklas997 Niklas997 deleted the enhancement-cmesh_uniform_doc branch July 4, 2024 10:30
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