Skip to content

Add entropy2cons for CompressibleEulerQuasi1D#2385

Merged
jlchan merged 10 commits intotrixi-framework:mainfrom
jlchan:jc/update_euler_quasi_1d
May 6, 2025
Merged

Add entropy2cons for CompressibleEulerQuasi1D#2385
jlchan merged 10 commits intotrixi-framework:mainfrom
jlchan:jc/update_euler_quasi_1d

Conversation

@jlchan
Copy link
Copy Markdown
Contributor

@jlchan jlchan commented May 6, 2025

This enables modal flux differencing DGMulti solvers, and adds a new test.

This should also retain coverage which decreases after moving SWE to TrixiSWE.jl in #2379.

@jlchan jlchan requested a review from patrickersing May 6, 2025 16:50
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented May 6, 2025

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.

@codecov
Copy link
Copy Markdown

codecov bot commented May 6, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.95%. Comparing base (0ae1541) to head (6babc55).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2385      +/-   ##
==========================================
+ Coverage   96.94%   96.95%   +0.01%     
==========================================
  Files         504      504              
  Lines       41717    41721       +4     
==========================================
+ Hits        40440    40448       +8     
+ Misses       1277     1273       -4     
Flag Coverage Δ
unittests 96.95% <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.

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

Copy link
Copy Markdown
Member

@patrickersing patrickersing 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!
This looks almost ready to merge, I would just add an additional unit test for the conversion between conservative and entropy variables.

jlchan and others added 2 commits May 6, 2025 13:17
Co-authored-by: Patrick Ersing <114223904+patrickersing@users.noreply.github.com>
@jlchan jlchan requested a review from patrickersing May 6, 2025 18:18
Copy link
Copy Markdown
Member

@patrickersing patrickersing left a comment

Choose a reason for hiding this comment

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

LGTM!

@jlchan jlchan merged commit bdc17ff into trixi-framework:main May 6, 2025
39 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants