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

Add StructuredMeshView as proxy between solver and actual StructuredMesh #1624

Merged
merged 93 commits into from
May 10, 2024

Conversation

sloede
Copy link
Member

@sloede sloede commented Sep 6, 2023

Added a new mesh type called StructuredMeshView. Rather than defining a new mesh they provide a view on a given parent mesh. They provide an extended set of functionalities compared to ordinary meshes and can be used in the same way. Their main application is in coupled simulations.

@github-actions
Copy link
Contributor

github-actions bot commented Sep 6, 2023

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.

Copy link

codecov bot commented Nov 22, 2023

Codecov Report

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

Project coverage is 96.09%. Comparing base (ff3106c) to head (169dd1c).

Files Patch % Lines
src/meshes/structured_mesh_view.jl 91.30% 4 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1624      +/-   ##
==========================================
- Coverage   96.10%   96.09%   -0.01%     
==========================================
  Files         451      453       +2     
  Lines       36414    36461      +47     
==========================================
+ Hits        34993    35036      +43     
- Misses       1421     1425       +4     
Flag Coverage Δ
unittests 96.09% <92.86%> (-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.

@sloede sloede marked this pull request as ready for review April 23, 2024 13:39
@sloede sloede changed the title [WIP] Add StructuredMeshView as proxy between solver and actual StructuredMesh Add StructuredMeshView as proxy between solver and actual StructuredMesh Apr 23, 2024
Copy link
Member Author

@sloede sloede left a comment

Choose a reason for hiding this comment

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

A few final comments and suggestions, then this is good to merge imho. Thanks for pushing this forward!

examples/structured_2d_dgsem/elixir_advection_smview.jl Outdated Show resolved Hide resolved
examples/structured_2d_dgsem/elixir_advection_smview.jl Outdated Show resolved Hide resolved
src/meshes/mesh_io.jl Show resolved Hide resolved
src/meshes/mesh_io.jl Outdated Show resolved Hide resolved
src/meshes/mesh_io.jl Outdated Show resolved Hide resolved
src/meshes/mesh_io.jl Outdated Show resolved Hide resolved
test/test_structured_2d.jl Outdated Show resolved Hide resolved
src/meshes/structured_mesh_view.jl Outdated Show resolved Hide resolved
Copy link
Member Author

@sloede sloede left a comment

Choose a reason for hiding this comment

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

LGTM!

@sloede sloede enabled auto-merge (squash) May 8, 2024 17:12
@sloede
Copy link
Member Author

sloede commented May 8, 2024

@SimonCan LGTM! Can you do a review and approve this? It should then auto-merge once all tests have passed

@sloede
Copy link
Member Author

sloede commented May 9, 2024

Codecov hiccups 😢

@sloede sloede closed this May 9, 2024
auto-merge was automatically disabled May 9, 2024 04:56

Pull request was closed

@sloede sloede reopened this May 9, 2024
@sloede sloede closed this May 9, 2024
@sloede sloede reopened this May 9, 2024
@sloede sloede merged commit 8a9fc7b into main May 10, 2024
36 of 38 checks passed
@sloede sloede deleted the msl/structuredmesh-view branch May 10, 2024 04:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants