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

T8codeMesh: Switching to t8_cmesh_new_brick_{2,3}d. #1939

Merged
merged 11 commits into from
Nov 5, 2024

Conversation

jmark
Copy link
Contributor

@jmark jmark commented May 10, 2024

Title says it all. This PR can only be merged after a new t8code release including PR DLR-AMR/t8code#1047.

@jmark jmark added the refactoring Refactoring code without functional changes label May 10, 2024
Copy link
Contributor

Review checklist

This checklist is meant to assist creators of PRs (to let them know what reviewers will typically look for) and reviewers (to guide them in a structured review process). Items do not need to be checked explicitly for a PR to be eligible for merging.

Purpose and scope

  • The PR has a single goal that is clear from the PR title and/or description.
  • All code changes represent a single set of modifications that logically belong together.
  • No more than 500 lines of code are changed or there is no obvious way to split the PR into multiple PRs.

Code quality

  • The code can be understood easily.
  • Newly introduced names for variables etc. are self-descriptive and consistent with existing naming conventions.
  • There are no redundancies that can be removed by simple modularization/refactoring.
  • There are no leftover debug statements or commented code sections.
  • The code adheres to our conventions and style guide, and to the Julia guidelines.

Documentation

  • New functions and types are documented with a docstring or top-level comment.
  • Relevant publications are referenced in docstrings (see example for formatting).
  • Inline comments are used to document longer or unusual code sections.
  • Comments describe intent ("why?") and not just functionality ("what?").
  • If the PR introduces a significant change or new feature, it is documented in NEWS.md with its PR number.

Testing

  • The PR passes all tests.
  • New or modified lines of code are covered by tests.
  • New or modified tests run in less then 10 seconds.

Performance

  • There are no type instabilities or memory allocations in performance-critical parts.
  • If the PR intent is to improve performance, before/after time measurements are posted in the PR.

Verification

  • The correctness of the code was verified using appropriate tests.
  • If new equations/methods are added, a convergence test has been run and the results
    are posted in the PR.

Created with ❤️ by the Trixi.jl community.

@jmark jmark marked this pull request as ready for review November 5, 2024 08:54
Copy link

codecov bot commented Nov 5, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.37%. Comparing base (2a4d266) to head (ca52cf6).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1939      +/-   ##
==========================================
- Coverage   96.38%   96.37%   -0.00%     
==========================================
  Files         480      480              
  Lines       37859    37855       -4     
==========================================
- Hits        36487    36482       -5     
- Misses       1372     1373       +1     
Flag Coverage Δ
unittests 96.37% <100.00%> (-<0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

benegee
benegee previously approved these changes Nov 5, 2024
Copy link
Contributor

@benegee benegee left a comment

Choose a reason for hiding this comment

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

Ignoring the invalidations test, everything seems alright!

@benegee benegee changed the title T8coeMesh: Switching to t8_cmesh_new_brick_{2,3}d. T8codeMesh: Switching to t8_cmesh_new_brick_{2,3}d. Nov 5, 2024
@benegee benegee enabled auto-merge (squash) November 5, 2024 13:31
@benegee benegee merged commit 16c6f17 into main Nov 5, 2024
37 of 38 checks passed
@benegee benegee deleted the t8code-switch-to-own-cmesh-brick-implementation branch November 5, 2024 14:27
Comment on lines +42 to +44
# test is currently broken as t8code applies a correction on the fly
# @test_throws "Discovered negative volumes" begin
@test begin
Copy link
Member

Choose a reason for hiding this comment

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

It looks like this is not broken anymore, correct? Could you please fix the comment?

Copy link
Member

Choose a reason for hiding this comment

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

@jmark @benegee You can do that in one of your new PRs working on T8code stuff in Trixi.jl

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The story behind this is a bit more involved. We will elaborate the comment a bit more.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
refactoring Refactoring code without functional changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants