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

Move t8_cmesh_set_tree_vertices #635

Merged
merged 3 commits into from
Jul 21, 2023
Merged

Conversation

sandro-elsweijer
Copy link
Collaborator

@sandro-elsweijer sandro-elsweijer commented Jul 19, 2023

Describe your changes here:
The t8_cmesh_set_tree_vertices function was in the t8_cmesh_vtk_writer.h header and it made no sense. Based on a Mattermost discussion the according changes were made. There is no new code in this PR, I only moved things around.

Since the vertices of a tree are only needed, if a t8_geometry_w_vertices geometry is used, the function is now part of this header. Therefore, it is automatically loaded when a t8_geometry_w_vertices or derived geometry is used. This should also enshure, that all external applications which link against t8code do not have to be adapted (apart from that in some cases the t8_cmesh_vtk_writer.h header does not have to be included anymore).

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.
  • New Datatypes are added to t8indent_custom_datatypes.txt
  • 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 self-assigned this Jul 19, 2023
@sandro-elsweijer sandro-elsweijer marked this pull request as ready for review July 19, 2023 12:40
@sandro-elsweijer sandro-elsweijer removed their assignment Jul 19, 2023
@sandro-elsweijer sandro-elsweijer added the enhancement Enhances already existing code label Jul 19, 2023
Copy link
Collaborator

@jmark jmark left a comment

Choose a reason for hiding this comment

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

@sandro-elsweijer What is the meaning of _w_ in all these names? Is it an abreviation for _with_ or anything else? I think it wouldn't hurt to spell it out. This makes the intent of the code much clearer.

@sandro-elsweijer
Copy link
Collaborator Author

@sandro-elsweijer What is the meaning of _w_ in all these names? Is it an abreviation for _with_ or anything else? I think it wouldn't hurt to spell it out. This makes the intent of the code much clearer.

Yes you are right, this can be confusing. Changed that

@jmark jmark merged commit f5a15f2 into main Jul 21, 2023
@jmark jmark deleted the fix-move_t8_cmesh_set_tree_vertices branch July 21, 2023 11:55
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.

2 participants