-
Notifications
You must be signed in to change notification settings - Fork 52
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
Cleanup element interface #979
Merged
Merged
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
lukasdreyer
force-pushed
the
cleanup-element_interface
branch
from
March 8, 2024 08:46
2e9369a
to
2f05374
Compare
Davknapp
requested changes
Mar 12, 2024
src/t8_schemes/t8_default/t8_default_line/t8_default_line_cxx.cxx
Outdated
Show resolved
Hide resolved
src/t8_schemes/t8_default/t8_default_line/t8_default_line_cxx.cxx
Outdated
Show resolved
Hide resolved
src/t8_schemes/t8_default/t8_default_prism/t8_default_prism_cxx.cxx
Outdated
Show resolved
Hide resolved
src/t8_schemes/t8_default/t8_default_prism/t8_default_prism_cxx.cxx
Outdated
Show resolved
Hide resolved
Davknapp
approved these changes
Mar 13, 2024
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.
Describe your changes here:
Several small changes to cleanup the interface of the
eclass_scheme
, that I put together into one PR, but they are already split in meaningful commits, so I could also do a PR for each one:Remove
t8_element_
index_array
(Follow Todo from file)general_function
(If the user knows that he has a specific scheme, he can cast his eclass_scheme to that scheme and call additional functionality directly)child_eclass
(With the current approch, this is always the same as eclass)Make
fam**
parameter ofis_family
constRemove
level
fromt8_element_successor
interface. The interesting usecase is to compute the successor on the same level. If the successor of the ancestor or descendant is needed, this can be combined by other elementary functionality (sidenote: we should add a t8_element_ancestor interface function).called_new
fromt8_element_init
interface. t8_element_init is not allowed to be called on an element that was created by new.Introduce function
t8_element_deinit
. It deinitializes the memory allocated byt8_element_init
, but leaves the memory for the element container untouched.Remove no longer needed debug data from tet elements.
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
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):
Scripts and Wiki
script/find_all_source_files.scp
to check the indentation of these files.Licence
doc/
(or already has one)