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

calc_volume_integral! for all meshes supported by fv_kernel! #2014

Merged
merged 6 commits into from
Jul 24, 2024

Conversation

DanielDoehring
Copy link
Contributor

@DanielDoehring DanielDoehring commented Jul 18, 2024

Although fv_kernel! is implemented for most (all) available meshes, the calling calc_volume_integral was not allowing this.

The only untested case is the UnstructuredMesh2D - I could

  1. exclude this from the allowed meshes
  2. write a new elixir for this
  3. just hope for the best

Xref: #425

@DanielDoehring DanielDoehring added the consistency Make Michael happy label Jul 18, 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.

@andrewwinters5000
Copy link
Member

This vol_int should work directly for the UnstructuedMesh2D as its data structures have the same structure as P4estMesh and StructuredMesh. Also, isn't a P4estMesh test also missing?

Copy link

codecov bot commented Jul 18, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.23%. Comparing base (75b7ca4) to head (0613f66).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2014   +/-   ##
=======================================
  Coverage   96.23%   96.23%           
=======================================
  Files         462      462           
  Lines       37074    37074           
=======================================
  Hits        35675    35675           
  Misses       1399     1399           
Flag Coverage Δ
unittests 96.23% <ø> (ø)

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!

test/test_p4est_2d.jl Outdated Show resolved Hide resolved
test/test_p4est_2d.jl Outdated Show resolved Hide resolved
test/test_p4est_2d.jl Outdated Show resolved Hide resolved
@DanielDoehring
Copy link
Contributor Author

DanielDoehring commented Jul 19, 2024

This vol_int should work directly for the UnstructuedMesh2D as its data structures have the same structure as P4estMesh and StructuredMesh.

This is also what I recall. 👍

Also, isn't a P4estMesh test also missing?

I have added a test where I recycle the existing TreeMesh implementation but exchange the mesh for a P4estMesh{2}. So in some sense P4estMesh{3} is untested.

@DanielDoehring DanielDoehring changed the title calc_volume_integral! for all meshes supported by fv_kernel! calc_volume_integral! for all meshes supported by fv_kernel! Jul 23, 2024
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

@ranocha ranocha merged commit e5f4cbe into trixi-framework:main Jul 24, 2024
37 checks passed
@DanielDoehring DanielDoehring deleted the PureFV_otherMeshes branch July 24, 2024 16:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
consistency Make Michael happy
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants