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

Check BCs for periodicity for periodic Tree & Structured meshes #1860

Merged

Conversation

DanielDoehring
Copy link
Contributor

Motivated by #752

This puts out warnings if a mesh with periodic boundaries is used, but still BCs are supplied.
The converse case, where a non-periodic mesh and periodic BCs are paired returns an error, so no additional treatment is added here.

@DanielDoehring DanielDoehring added enhancement New feature or request low-priority refactoring Refactoring code without functional changes labels Mar 6, 2024
Copy link
Contributor

github-actions bot commented Mar 6, 2024

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.

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.

@DanielDoehring DanielDoehring added the bug Something isn't working label Mar 6, 2024
Copy link

codecov bot commented Mar 6, 2024

Codecov Report

Attention: Patch coverage is 96.15385% with 1 lines in your changes are missing coverage. Please review.

Project coverage is 96.30%. Comparing base (4bf61a0) to head (2b47577).

Files Patch % Lines
src/meshes/tree_mesh.jl 50.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1860      +/-   ##
==========================================
- Coverage   96.30%   96.30%   -0.00%     
==========================================
  Files         438      438              
  Lines       35577    35603      +26     
==========================================
+ Hits        34259    34284      +25     
- Misses       1318     1319       +1     
Flag Coverage Δ
unittests 96.30% <96.15%> (-<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.

Copy link
Member

@ranocha ranocha left a comment

Choose a reason for hiding this comment

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

Thanks

@DanielDoehring DanielDoehring enabled auto-merge (squash) March 7, 2024 08:47
@ranocha ranocha disabled auto-merge March 7, 2024 09:41
@ranocha ranocha merged commit 3bed828 into trixi-framework:main Mar 7, 2024
34 of 39 checks passed
@DanielDoehring DanielDoehring deleted the PeriodicityCheck_MeshBC_TreeStruct branch March 7, 2024 10:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working enhancement New feature or request low-priority refactoring Refactoring code without functional changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants