Skip to content

Rename the keyword gravity_constant to gravity for the ShallowWaterEquations3D #81

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

Merged

Conversation

patrickersing
Copy link
Contributor

This PR renames the gravity_constant keyword in the equations constructor to gravity and fixes the docstrings/comments to describe this quantity as the gravitational acceleration instead of the gravitational constant. This will make it consistent with the actual field equations.gravity and avoid any confusion between gravitational acceleration and the gravitational constant. See trixi-framework/TrixiShallowWater.jl#82, trixi-framework/TrixiShallowWater.jl#84, trixi-framework/Trixi.jl#2357

Copy link
Member

@tristanmontoya tristanmontoya left a comment

Choose a reason for hiding this comment

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

LGTM!

@tristanmontoya tristanmontoya enabled auto-merge (squash) April 14, 2025 16:28
Copy link

codecov bot commented Apr 14, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.39%. Comparing base (f250b56) to head (7bb5be1).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #81   +/-   ##
=======================================
  Coverage   90.39%   90.39%           
=======================================
  Files          22       22           
  Lines        2104     2104           
=======================================
  Hits         1902     1902           
  Misses        202      202           

☔ 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.

@tristanmontoya tristanmontoya merged commit c89ab29 into trixi-framework:main Apr 14, 2025
9 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