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

WIP: Sc/p4est view #1761

Open
wants to merge 77 commits into
base: main
Choose a base branch
from
Open

WIP: Sc/p4est view #1761

wants to merge 77 commits into from

Conversation

SimonCan
Copy link
Contributor

@SimonCan SimonCan commented Nov 28, 2023

Structures that create a view on a p4est mesh, similar to the structured mesh views implemented earlier. This is intended to be used on coupled simulations, but can be used for un-coupled as well.

This is a 0th iteration and provides some basic framework for some of the more exciting features to come in the next PRs.

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.

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.

@SimonCan SimonCan marked this pull request as draft November 28, 2023 16:42
Copy link

codecov bot commented Nov 30, 2023

Codecov Report

Attention: Patch coverage is 96.73913% with 3 lines in your changes missing coverage. Please review.

Project coverage is 96.34%. Comparing base (480aea9) to head (820cf13).

Files with missing lines Patch % Lines
src/meshes/p4est_mesh_view.jl 95.95% 3 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1761      +/-   ##
==========================================
- Coverage   96.34%   96.34%   -0.00%     
==========================================
  Files         470      471       +1     
  Lines       37497    37577      +80     
==========================================
+ Hits        36125    36201      +76     
- Misses       1372     1376       +4     
Flag Coverage Δ
unittests 96.34% <96.74%> (-<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.

@SimonCan SimonCan marked this pull request as ready for review July 30, 2024 14:25
src/meshes/p4est_mesh_view.jl Show resolved Hide resolved
src/meshes/p4est_mesh_view.jl Show resolved Hide resolved
src/meshes/p4est_mesh_view.jl Show resolved Hide resolved
src/meshes/p4est_mesh_view.jl Show resolved Hide resolved
@SimonCan SimonCan requested a review from jmark August 20, 2024 11:42
@SimonCan SimonCan added the enhancement New feature or request label Sep 2, 2024
src/meshes/p4est_mesh_view.jl Show resolved Hide resolved
src/meshes/p4est_mesh_view.jl Show resolved Hide resolved
jmark
jmark previously approved these changes Sep 12, 2024
Copy link
Contributor

@jmark jmark left a comment

Choose a reason for hiding this comment

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

LGTM!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants