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

More const parameter for our element array class [1/3]. #1079

Merged
merged 7 commits into from
Jun 19, 2024

Conversation

holke
Copy link
Collaborator

@holke holke commented Jun 4, 2024

Describe your changes here:

  • Added const parameters to all functions where possible of the element array class.
  • Added additional "_mutable" versions of function if it was necessary to have a non-const version besides a const version.
  • Applied the changes throughout t8code

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

@holke holke changed the title More const parameter for our element array class. More const parameter for our element array class [1/3]. Jun 5, 2024
@holke holke requested a review from lukasdreyer June 10, 2024 13:21
src/t8_data/t8_containers.cxx Show resolved Hide resolved
src/t8_data/t8_containers.h Outdated Show resolved Hide resolved
src/t8_forest/t8_forest_adapt.cxx Show resolved Hide resolved
src/t8_forest/t8_forest_partition.cxx Outdated Show resolved Hide resolved
@lukasdreyer lukasdreyer assigned holke and unassigned lukasdreyer Jun 10, 2024
@holke holke added the enhancement Enhances already existing code label Jun 19, 2024
@holke holke assigned lukasdreyer and unassigned holke Jun 19, 2024
@lukasdreyer lukasdreyer merged commit 8fb8478 into main Jun 19, 2024
10 checks passed
@lukasdreyer lukasdreyer deleted the feature-const_params branch June 19, 2024 08:49
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