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 a bug in Equilibrium3D EoS #5882

Merged
merged 1 commit into from
Apr 1, 2024

Conversation

isaaclegred
Copy link
Contributor

@isaaclegred isaaclegred commented Mar 22, 2024

Proposed changes

There was a "bug" (a mistake) in the previous version of the sound speed calculation involved in the promotion of 2-d to 3-d EoSs. The previous version may have been right but if it was I have no idea why. Essentially the wrong variable was being held constant in a partial derivative. I have:

  1. Added docs the EoS class to explicitly clarify what needs to be computed in terms of variables that we use elsewhere
  2. Fixed the thing that was being computed incorrectly, it is now computed correctly
  3. Changed the test to use an IdealFluid EoS where the sound speed can be computed "by hand"

Upgrade instructions

Code review checklist

  • The code is documented and the documentation renders correctly. Run
    make doc to generate the documentation locally into BUILD_DIR/docs/html.
    Then open index.html.
  • The code follows the stylistic and code quality guidelines listed in the
    code review guide.
  • The PR lists upgrade instructions and is labeled bugfix or
    new feature if appropriate.

Further comments

Someone should probably check the math in the docs, (thermodynamics is hard :( )

Copy link
Member

@nilsdeppe nilsdeppe 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 doing this! A few comments on the documentation that you can squash directly :)

@isaaclegred
Copy link
Contributor Author

@nilsdeppe this is updated when you get the chance!

Copy link
Member

@nilsdeppe nilsdeppe left a comment

Choose a reason for hiding this comment

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

Awesome! Thank you very much for doing this :D

@nilsdeppe nilsdeppe merged commit eabf7be into sxs-collaboration:develop Apr 1, 2024
22 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants