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

LinearizedEuler3D #1903

Merged
merged 12 commits into from
Apr 16, 2024
Merged

Conversation

DanielDoehring
Copy link
Contributor

No description provided.

@DanielDoehring DanielDoehring added the enhancement New feature or request label Apr 11, 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.

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
Member

@lchristm lchristm 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 adding this! I just found a few minor things like typos. I did not visually check the solution obtained from the new Gauss wall example elixir. The rest looks good to me!

src/equations/linearized_euler_3d.jl Outdated Show resolved Hide resolved
src/equations/linearized_euler_3d.jl Outdated Show resolved Hide resolved
test/test_tree_3d_linearizedeuler.jl Outdated Show resolved Hide resolved
DanielDoehring and others added 4 commits April 12, 2024 13:59
Co-authored-by: Lars Christmann <account-github@l12n.eu>
@DanielDoehring
Copy link
Contributor Author

Thanks @lchristm ! I slightly adjusted the wall example, the rest I left untouched.

Copy link

codecov bot commented Apr 12, 2024

Codecov Report

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

Project coverage is 96.30%. Comparing base (b1a84a6) to head (fc7e86b).

Files Patch % Lines
src/equations/linearized_euler_3d.jl 94.74% 5 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1903      +/-   ##
==========================================
+ Coverage   96.12%   96.30%   +0.18%     
==========================================
  Files         448      450       +2     
  Lines       36081    36182     +101     
==========================================
+ Hits        34682    34843     +161     
+ Misses       1399     1339      -60     
Flag Coverage Δ
unittests 96.30% <95.05%> (+0.18%) ⬆️

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

@lchristm lchristm left a comment

Choose a reason for hiding this comment

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

The changes look good to me now, but test coverage seems to be lower than required by the CI checks. You still need approval from one of the devs with write access to get this merged. Thanks again!

@DanielDoehring DanielDoehring enabled auto-merge (squash) April 14, 2024 11:08
@DanielDoehring
Copy link
Contributor Author

IMO, this is ready to go - any mergers @andrewwinters5000 @jlchan @ranocha @sloede ?

@sloede
Copy link
Member

sloede commented Apr 15, 2024

Note: EOC numbers to confirm expected convergence can be found here:
#1903 (comment)

sloede
sloede previously approved these changes Apr 15, 2024
Copy link
Member

@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!

Copy link
Member

@andrewwinters5000 andrewwinters5000 left a comment

Choose a reason for hiding this comment

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

LGTM! Just one small remark about one of the comments.

src/equations/linearized_euler_3d.jl Outdated Show resolved Hide resolved
Co-authored-by: Andrew Winters <andrew.ross.winters@liu.se>
@DanielDoehring DanielDoehring merged commit 3cd1266 into trixi-framework:main Apr 16, 2024
36 of 37 checks passed
@DanielDoehring DanielDoehring deleted the LinearizedEuler3D branch April 16, 2024 07:06
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.

None yet

4 participants