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 vtk_writer function [1/2] - update vtk_writer #508

Merged
merged 5 commits into from
May 23, 2023
Merged

Conversation

Davknapp
Copy link
Collaborator

@Davknapp Davknapp commented Apr 5, 2023

Update the API-Writer function to our current coding guidelines.
Mostly const-ing arguments and variable-scoping.

I updated the profile of the legacy-writer, too, such that we can change it easily. Unfortunatly write_ghost can not be made const without further changes in the legacy-writer, because it can be set in the beginning of the write-function.

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.

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

  • The code compiles without warning in debugging and release mode, with and without MPI (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)
  • All tests pass (in various configurations, this should be executed automatically in a github action)

  • New source/header files are properly added to the Makefiles

  • New Datatypes are added to t8indent_custom_datatypes.txt

  • The reviewer executed the new code features at least once and checked the results manually

  • The code is covered in an existing or new test case

  • New tests use the Google Test framework

  • The code follows the t8code coding guidelines

  • 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)

  • 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.

@Davknapp Davknapp added the enhancement Enhances already existing code label Apr 5, 2023
@Davknapp Davknapp added the draft Enhance the visibility that this is a draft. label Apr 5, 2023
@jmark jmark self-assigned this May 8, 2023
@jmark jmark marked this pull request as ready for review May 9, 2023 08:45
Base automatically changed from cmesh_vtk_DataSet_translator to main May 12, 2023 11:48
@jmark
Copy link
Collaborator

jmark commented May 12, 2023

@Davknapp Please resolve merge conflicts.

@jmark jmark assigned Davknapp and unassigned jmark May 12, 2023
@jmark jmark removed the draft Enhance the visibility that this is a draft. label May 12, 2023
@Davknapp Davknapp assigned jmark and unassigned Davknapp May 15, 2023
@jmark jmark merged commit a68e2ad into main May 23, 2023
@jmark jmark deleted the update-vtk_writer branch May 23, 2023 12:55
jfussbro pushed a commit to jfussbro/t8code that referenced this pull request Jun 27, 2023
Split vtk_writer function [1/2] - update vtk_writer
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