Skip to content

Feature issue28 get element return const#833

Merged
Davknapp merged 4 commits intomainfrom
feature-issue28_get_element_return_const
Nov 16, 2023
Merged

Feature issue28 get element return const#833
Davknapp merged 4 commits intomainfrom
feature-issue28_get_element_return_const

Conversation

@holke
Copy link
Copy Markdown
Collaborator

@holke holke commented Nov 9, 2023

Describe your changes here:

This PR fixes #28.

  • t8_forest_get_element now returns a const t8_element_t*
  • t8_forest_get_element_in_tree now returns a const t8_element_t*

We do these changes since both getter functions are part of the public interface and users should not be able to modify elements of the forest.

Before merging please double check that this integrates easily into user codes. Especially Trixi @jmark

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 added 3 commits November 8, 2023 16:27
The element getter function now returns a const*.
Required touching the usages and examples of this function.
@holke holke added the enhancement Enhances already existing code label Nov 9, 2023
Copy link
Copy Markdown
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.

Looks good to me, but @jmark should have another look at it with a T8code.jl-lense

@jmark
Copy link
Copy Markdown
Collaborator

jmark commented Nov 16, 2023

@Davknapp @holke Should be fine. The const qualifiers are ignored by the wrappers anyway.

@Davknapp Davknapp merged commit bda02b1 into main Nov 16, 2023
@Davknapp Davknapp deleted the feature-issue28_get_element_return_const branch November 16, 2023 10:12
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.

Make t8_forest_get_element_in_tree return a const t8_element_t *

3 participants