Skip to content

Add StiffenedGas EOS implementation#2979

Draft
Raymond0622 wants to merge 8 commits into
trixi-framework:mainfrom
Raymond0622:SGEntropyImpl
Draft

Add StiffenedGas EOS implementation#2979
Raymond0622 wants to merge 8 commits into
trixi-framework:mainfrom
Raymond0622:SGEntropyImpl

Conversation

@Raymond0622

Copy link
Copy Markdown

Using equation_of_state framework introduced by Jesse Chan, I added a Stiffened Gas EOS implementation using state functions defined in the following reference: https://www.sciencedirect.com/science/article/pii/S0029549310005157

@github-actions

Copy link
Copy Markdown
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.

@Raymond0622

Copy link
Copy Markdown
Author

Note. I forgot to remove tester.jl file that I copied accidentally.

@jlchan jlchan left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks @Raymond0622! Here are some comments. Once these are addressed, you can mark it ready for review

Comment thread examples/structured_1d_dgsem/tester.jl Outdated
Comment thread examples/structured_1d_dgsem/elixir_euler_stiffened_gas.jl
# run the simulation
solver = CarpenterKennedy2N54(williamson_condition = false)
sol = solve(ode, solver;
dt = stepsize_callback(ode), saveat = LinRange(tspan..., 100),# solve needs some value here but it will be overwritten by the stepsize_callback

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Lets remove saveat for CI-run elixirs

Comment on lines +42 to +43
boundary_conditions = (x_neg = boundary_condition_periodic,
x_pos = boundary_condition_periodic);

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

These are defined but not used

Comment thread src/equations/equation_of_state_stiffened_gas.jl
Comment on lines +54 to +58
pInf = 1e9
q = -1167 * 1e3
R = 0.08314 / 0.01802
gamma = 2.35
cv0 = 1816.0

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Could we convert all constants via convert(RealT, ...) so StiffenedGas(RealT=Float32) is type-stable and consistent with Trixi conventions? Adding a unit test would b great too

"""
function calc_pressure_derivatives(V, T, eos::StiffenedGas)
(; cv0, gamma) = eos
dpdT_V = (gamma - 1) * cv0 * T / V

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Should there be a factor of T here?

Comment thread examples/structured_1d_dgsem/tester.jl Outdated
end

#struct to match
# https://www.sciencedirect.com/science/article/pii/S0045793015001887

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

It might be good in this comment (possibly bulk it out to a docstring) to point to the equation of state in the reference. I think it is equation (38) but I am not 100% sure because the notation used below is slightly different.

@codecov

codecov Bot commented May 7, 2026

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 0% with 40 lines in your changes missing coverage. Please review.
✅ Project coverage is 97.05%. Comparing base (1afb053) to head (100353b).
⚠️ Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
src/equations/equation_of_state_stiffened_gas.jl 0.00% 31 Missing ⚠️
.../structured_1d_dgsem/elixir_euler_stiffened_gas.jl 0.00% 9 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2979      +/-   ##
==========================================
- Coverage   97.11%   97.05%   -0.06%     
==========================================
  Files         625      627       +2     
  Lines       48544    48584      +40     
==========================================
+ Hits        47139    47150      +11     
- Misses       1405     1434      +29     
Flag Coverage Δ
unittests 97.05% <0.00%> (-0.06%) ⬇️

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.

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.

3 participants