Feature t8 io #368
Draft
Feature t8 io #368
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 10 commits
November 21, 2022 16:59
Currently they are not filled with anything meaningfull.
Davknapp
added
enhancement
jmark
requested changes
Nov 25, 2022
src/t8_IO/t8_IO.h
Outdated
|
|
||
| /** | ||
| * \file t8_IO.h | ||
| * Defines a class that combines input and outputroutines. |
src/t8_IO/t8_IO.h
Outdated
|
|
||
| /** | ||
| * A general routine for writing files in serial. | ||
| * TODO: provide implementation |
There was a problem hiding this comment.
I don't like TODOs in PRs. You can remove this TODO since this PR is aimed at the API anyway. Specific implementations will follow in later PRs.
src/t8_IO/t8_IO.h
Outdated
|
|
||
| /** | ||
| * A general routine for writing files in parallel. | ||
| * TODO: provide implementation |
There was a problem hiding this comment.
I don't like TODOs in PRs. You can remove this TODO since this PR is aimed at the API anyway. Specific implementations will follow in later PRs.
| /* Write the output */ | ||
| virtual t8_read_status_t read (); | ||
|
|
||
| virtual t8_read_status_t set_source (const t8_extern_t * source); |
There was a problem hiding this comment.
I don't think this is a good idea and exactly what we wanted to avoid, right? We should talk about this. :)
| * \param[in] source an object to be filled. | ||
| * \return t8_write_status_t T8_WRITE_FAIL if it wasn't able to set the source, T8_WRITE_SUCCESS otherwise | ||
| */ | ||
| virtual t8_read_status_t set_source (const t8_extern_t * source) = 0; |
There was a problem hiding this comment.
This routine does not have be part of the base class. We should talk about this.
|
|
||
| /* *INDENT-OFF* */ | ||
| t8_write_status | ||
| t8_vtk_writer::set_dest (const t8_extern_t * dest) |
There was a problem hiding this comment.
The same problem as with set_source.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Implementation of a general IO Interface to centralize all IO-routines in t8code.
Goal of this Interface is to:
This PR provides only the structure to meet these ideas. I will move the current implementations of supported IO-routines as soon as possible.
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):
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
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)
Testing of this template: If you feel something is missing from this list, contact the developers