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

Move Jacobian for para P4est to respective files, add muladd #1807

Conversation

DanielDoehring
Copy link
Contributor

@DanielDoehring DanielDoehring commented Jan 18, 2024

The wrong "place" of apply_jacobian_parabolic! happened in the bug-fixing PR https://github.com/trixi-framework/Trixi.jl/pull/1668/files .

The @muladd macro was missing actually all the time,w as this intended @jlchan ?

Edit: Most of the changes are actually due to the formatter


@jlchan There are actually multiple files within src/solvers/dgmulit which lack (?) the @muladd macro.

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.

@DanielDoehring DanielDoehring requested a review from jlchan January 18, 2024 14:00
@DanielDoehring DanielDoehring added the consistency Make Michael happy label Jan 18, 2024
Copy link

codecov bot commented Jan 18, 2024

Codecov Report

Attention: 2 lines in your changes are missing coverage. Please review.

Comparison is base (dfd632e) 94.98% compared to head (f006d33) 96.38%.

Files Patch % Lines
src/solvers/dgsem_p4est/dg_2d_parabolic.jl 97.56% 1 Missing ⚠️
src/solvers/dgsem_p4est/dg_3d_parabolic.jl 97.14% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1807      +/-   ##
==========================================
+ Coverage   94.98%   96.38%   +1.40%     
==========================================
  Files         455      455              
  Lines       36391    36391              
==========================================
+ Hits        34564    35074     +510     
+ Misses       1827     1317     -510     
Flag Coverage Δ
unittests 96.38% <97.37%> (+1.40%) ⬆️

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.

@jlchan
Copy link
Contributor

jlchan commented Jan 31, 2024

Sorry - I missed this. Will review later today

Copy link
Contributor

@jlchan jlchan left a comment

Choose a reason for hiding this comment

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

Thanks for reorganizing things and adding @muladd! I didn't intend to leave @muladd off, I just forgot.

I think @muladd is not included for several DGMulti files because it would interfered with Revise.jl and broke recompilation. This happened when @muladd was wrapping complex type aliases, if I remember correctly.

@DanielDoehring
Copy link
Contributor Author

Sorry - I missed this. Will review later today

No worries, this did not slow down any of my other plans!

@DanielDoehring DanielDoehring enabled auto-merge (squash) January 31, 2024 21:02
@DanielDoehring DanielDoehring merged commit e2c92f3 into trixi-framework:main Feb 1, 2024
35 checks passed
@DanielDoehring DanielDoehring deleted the MoveJacobianParaP4est_MulAdd_ParaP4est branch February 1, 2024 08:39
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.

2 participants