DLR-AMR
Unify names of get_leaves and get_elements functions
Feature request
We have multiple functions for the tree and forest to get the leaf elements. In some cases they are called get_elementsand in other cases get_leaves.
Describe the solution or feature you'd like Unify the function names so a user can find the correct functionality for the current problem.
"Priority: low" Should be solved eventually
@ole-alb @lukasdreyer Are there preferences on what a unified name should be? elements, leaves, or leaf_elements? 🤔
@ole-alb @lukasdreyer Are there preferences on what a unified name should be?
elements,leaves, orleaf_elements? 🤔
Usually "element" should refer to everything that can exist while "leave" should refer to existing (leaf) elements in a forest. I.e. only the leaf elements of the refinement tree that form the actual computational mesh.
This can guide us in properly naming the functions.
In addition to that, in this case leaf is suitable as the functions I was referring to, are for example used to get the number of leaves of a tree or forest.
We decided:
- functions that explicitly need leaf elements should have leaf_elements in the name
- functions that work on any element should have only element in their name.
Please also document this decision in the wiki.
