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

Fix entropy for quasi-1D compressible Euler #1974

Merged
merged 7 commits into from
Jun 10, 2024
Merged

Fix entropy for quasi-1D compressible Euler #1974

merged 7 commits into from
Jun 10, 2024

Conversation

jlchan
Copy link
Contributor

@jlchan jlchan commented Jun 10, 2024

@jlchan jlchan requested a review from huiyuxie June 10, 2024 18:18
@jlchan jlchan marked this pull request as ready for review June 10, 2024 18:18
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.

@jlchan
Copy link
Contributor Author

jlchan commented Jun 10, 2024

There should be a test to catch this - there is not currently one, but I would propose making this a new issue instead of holding up #1947

Edit: ignore this comment, added a test in a098de3

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! I just have two minor suggestions.

src/equations/compressible_euler_quasi_1d.jl Outdated Show resolved Hide resolved
test/test_tree_1d_euler.jl Outdated Show resolved Hide resolved
test/test_tree_1d_euler.jl Outdated Show resolved Hide resolved
@ranocha ranocha added the bug Something isn't working label Jun 10, 2024
@jlchan jlchan requested a review from ranocha June 10, 2024 19:33
JoshuaLampert
JoshuaLampert previously approved these changes Jun 10, 2024
@JoshuaLampert
Copy link
Member

Formatting fails.

@jlchan
Copy link
Contributor Author

jlchan commented Jun 10, 2024

Ah, I made some edits online so I didn't have a chance to run the formatter. One second.

@jlchan
Copy link
Contributor Author

jlchan commented Jun 10, 2024

Hopefully that fixes things

@JoshuaLampert
Copy link
Member

Doesn't look like the formatter is happy. Note that we use JuliaFormatter v1.0.45.

Copy link

codecov bot commented Jun 10, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.14%. Comparing base (2043cfe) to head (95b176b).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1974      +/-   ##
==========================================
+ Coverage   96.13%   96.14%   +0.01%     
==========================================
  Files         460      460              
  Lines       36943    36942       -1     
==========================================
+ Hits        35512    35515       +3     
+ Misses       1431     1427       -4     
Flag Coverage Δ
unittests 96.14% <100.00%> (+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.

Copy link
Member

@JoshuaLampert JoshuaLampert left a comment

Choose a reason for hiding this comment

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

Thanks!

@jlchan
Copy link
Contributor Author

jlchan commented Jun 10, 2024

Thanks for the review!

@jlchan
Copy link
Contributor Author

jlchan commented Jun 10, 2024

Merging; all tests passed

@jlchan jlchan merged commit 23c70ba into main Jun 10, 2024
38 checks passed
@jlchan jlchan deleted the jlchan-patch-1 branch June 10, 2024 22:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants