Skip to content

Feature: Optionally compute face orientation when calling leaf_face_neighbor routine.#1021

Merged
jfussbro merged 2 commits intomainfrom
feature-compute-leaf-face-orientation
Apr 23, 2024
Merged

Feature: Optionally compute face orientation when calling leaf_face_neighbor routine.#1021
jfussbro merged 2 commits intomainfrom
feature-compute-leaf-face-orientation

Conversation

@jmark
Copy link
Copy Markdown
Collaborator

@jmark jmark commented Apr 10, 2024

Describe your changes here:

Title says it all. This is a convenience argument for the user base of 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)

@jmark jmark added enhancement Enhances already existing code shouldn't take long Can be resolved in under 30 mins good first issue Can be handled if you are new to t8code labels Apr 10, 2024
@jfussbro jfussbro self-assigned this Apr 22, 2024
Copy link
Copy Markdown
Contributor

@jfussbro jfussbro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lgtm! I especially like the reference to t8_cmesh_get_face_neighbor in the documentation of the new function :)

@jfussbro jfussbro merged commit f3425bf into main Apr 23, 2024
@jfussbro jfussbro deleted the feature-compute-leaf-face-orientation branch April 23, 2024 06:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement Enhances already existing code good first issue Can be handled if you are new to t8code shouldn't take long Can be resolved in under 30 mins

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants