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

fix orientation #957

Merged
merged 1 commit into from
Feb 23, 2024
Merged

fix orientation #957

merged 1 commit into from
Feb 23, 2024

Conversation

Davknapp
Copy link
Collaborator

Discovered a bug in the hypercube_pad example, where the orientation between two quad-faces was set to 4 (which is impossible if, a quad has 4 corners, we start with corner 0). This PR fixes it.

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)

@Davknapp Davknapp added Bug For a bug in the Code shouldn't take long Can be resolved in under 30 mins labels Feb 23, 2024
@jmark jmark enabled auto-merge February 23, 2024 09:28
@jmark jmark merged commit 15a6aea into main Feb 23, 2024
8 checks passed
@jmark jmark deleted the bug-fix_hypercube_pad branch February 23, 2024 09:35
@holke
Copy link
Collaborator

holke commented Feb 23, 2024

This feels like something that should have been caught by an assertion.

Looks like we are missing some checks?

@Davknapp
Copy link
Collaborator Author

Davknapp commented Feb 23, 2024

This feels like something that should have been caught by an assertion.

Looks like we are missing some checks?

Yes, I found it while using this example in a test. Then an assertion was triggered. Checking if the orientation is correct is currently not possible during t8_cmesh_set_join, as we don't pass any information about the number of corners of the trees.
In my opinion the main cause of why this bug wasn't detected is that we didn't use the example in any tests.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug For a bug in the Code shouldn't take long Can be resolved in under 30 mins
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants