Skip to content

Refactor SurfaceIntegral to make it 3D ready #2375

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

Merged
merged 29 commits into from
Apr 30, 2025

Conversation

DanielDoehring
Copy link
Contributor

@DanielDoehring DanielDoehring commented Apr 25, 2025

Similar to many other files this PR splits the analysis_surface_integral_2d.jl files into a dimension-general/independent one analysis_surface_integral.jl and a 2D specialized one analysis_surface_integral_2d.jl. Should make extension to 3D simpler.

@DanielDoehring DanielDoehring added breaking refactoring Refactoring code without functional changes labels Apr 25, 2025
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.

Copy link

codecov bot commented Apr 25, 2025

Codecov Report

Attention: Patch coverage is 80.95238% with 12 lines in your changes missing coverage. Please review.

Project coverage is 96.94%. Comparing base (6a1f16d) to head (57c3cfe).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
src/callbacks_step/analysis_surface_integral.jl 70.00% 12 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2375   +/-   ##
=======================================
  Coverage   96.94%   96.94%           
=======================================
  Files         503      504    +1     
  Lines       41717    41717           
=======================================
  Hits        40440    40440           
  Misses       1277     1277           
Flag Coverage Δ
unittests 96.94% <80.95%> (ø)

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.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@DanielDoehring DanielDoehring mentioned this pull request Apr 25, 2025
10 tasks
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 a lot!

@DanielDoehring DanielDoehring requested a review from ranocha April 30, 2025 12:00
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 enabled auto-merge (squash) April 30, 2025 14:23
@ranocha ranocha merged commit 9e1edee into trixi-framework:main Apr 30, 2025
38 of 39 checks passed
@DanielDoehring DanielDoehring deleted the Refactor_SurfaceIntegral branch May 1, 2025 02:35
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