Skip to content

Improvement: redesigns vtk compilation#1481

Merged
Davknapp merged 23 commits intomainfrom
redesign-vtk-compilation
May 5, 2025
Merged

Improvement: redesigns vtk compilation#1481
Davknapp merged 23 commits intomainfrom
redesign-vtk-compilation

Conversation

@faouziH21
Copy link
Collaborator

@faouziH21 faouziH21 commented Mar 14, 2025

Closes #1537

Describe your changes here:

This PR changes the way vtk compilation is done. Before we used macros to check whether VTK is linked or not and depending on that, some fuctions were defined and some were not. This PR aims to seperate these complications ultimately improving readabilty.

NOTE: not all files have been converted yet. t8_vtk_writer.cxx, t8_vtk_writer.hxx and t8_vtk_writer.h have been omitted to avoid this PR being too large

All these boxes must be checked by the AUTHOR before requesting review:

  • The PR is small enough to be reviewed easily. If not, consider splitting up the changes in multiple PRs.
  • The title starts with one of the following prefixes: Documentation:, Bugfix:, Feature:, Improvement: or Other:.
  • If the PR is related to an issue, make sure to link it.
  • The author made sure that, as a reviewer, he/she would check all boxes below.

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 CMake files.
  • The code is well documented. In particular, 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.

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 or tutorial and a Wiki article.

Tag Label

  • The author added the patch/minor/major label in accordance to semantic versioning.

License

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

@faouziH21 faouziH21 changed the title chore: redesing compilation for polydata and parallel chore: redesings vtk compilation Mar 24, 2025
@faouziH21 faouziH21 changed the title chore: redesings vtk compilation Improvement: redesings vtk compilation Mar 24, 2025
@faouziH21 faouziH21 marked this pull request as ready for review March 24, 2025 07:02
@faouziH21 faouziH21 requested a review from Davknapp March 24, 2025 07:13
@Davknapp
Copy link
Collaborator

Davknapp commented Mar 27, 2025

Can you indent

  • ../src/t8_cmesh_vtk_reader.hxx
  • ../src/t8_vtk/t8_with_vtk/t8_vtk_reader.cxx
    ?

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.

This will be your first contribution to t8code! Congratulations for that. To successfully contribute, can you please add your author file to doc/ . Please name it similar to the others and add a BSD License-statement there. Thank you.

@Davknapp Davknapp changed the title Improvement: redesings vtk compilation Improvement: redesigns vtk compilation Mar 28, 2025
@faouziH21 faouziH21 requested a review from Davknapp April 2, 2025 13:07
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.

Can you address my comment about the documentation? Then we are probably ready to merge.

@Davknapp Davknapp added this pull request to the merge queue May 5, 2025
Merged via the queue into main with commit 05b3ed8 May 5, 2025
22 checks passed
@Davknapp Davknapp deleted the redesign-vtk-compilation branch May 5, 2025 09:04
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.

Improvement: redesigns vtk compilation

2 participants