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

Split t8_cmesh_is_committed into two funtions #968

Closed
wants to merge 1 commit into from

Conversation

sandro-elsweijer
Copy link
Collaborator

Describe your changes here:
Splits the t8_cmesh_is_commited function into two.
The new t8_cmesh_is_commited now behaves exactly as its counterpart t8_forest_is_commited.
The additional validation checks are moved into the new function t8_cmesh_validate, which is called in a t8_cmesh_commit. Therefore, a cmesh has to be valid when committed and remains that way.

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)

@sandro-elsweijer sandro-elsweijer added the enhancement Enhances already existing code label Mar 3, 2024
@sandro-elsweijer sandro-elsweijer force-pushed the enhancement-cmesh_is_commited branch from 7817eeb to 9aba998 Compare March 3, 2024 14:42
@sandro-elsweijer sandro-elsweijer changed the title Split t8_cmesh_is_commited into two funtions Split t8_cmesh_is_committed into two funtions Mar 3, 2024
@sandro-elsweijer
Copy link
Collaborator Author

Merged #974 instead

@sandro-elsweijer sandro-elsweijer deleted the enhancement-cmesh_is_commited branch March 5, 2024 10:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Enhances already existing code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant