ENH: Add the Coriolis Force to the Flight class

[kevin-alcaniz]

Pull request type

• Code changes (bugfix, features)

Checklist

• Tests for the changes have been added (if needed)
• Docs have been reviewed and added / updated
• Lint (black rocketpy/ tests/) has passed locally
• All tests (pytest tests -m slow --runslow) have passed locally
• CHANGELOG.md has been updated (if relevant)

Current behavior

Currently, RocketPy doesn't account for the Coriolis force, even though the Flight Coordinate System is not truly an inertial reference frame.

New behavior

• Environment class:
  A new attribute has been added: the Earth's angular velocity vector. Additionally, a new function has been implemented to compute it.

• Flight class:
  The Coriolis acceleration has been added to the vdot vector in the u_dot_generalized function. A theoretical explanation justifying this implementation is attached below.

Breaking change

• Yes
• No

Theory

[Gui-FernandesBR]

Looking good to me...

Please don't forget to update the CHANGELOG as well.
I hope one day we implement the autochangelog tool in this repo :)

[kevin-alcaniz]

@Gui-FernandesBR All good on my side!!

[Gui-FernandesBR]

Great work, @kevin-alcaniz !

From my point of view, this PR adds great value to RocketPy.
@MateusStano would like to review this PR before we proceed to merging it onto develop.

Tests are failing, this happens because some tests have values that were made by running flight and capturing the results. Since the flight simulation has changed with this PR, we have to update the values.
@kevin-alcaniz I know you've been busy, so don't worry, I believe we can work on this problem from our side.

[Copilot]

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

Comments suppressed due to low confidence (2)

rocketpy/simulation/flight.py:1696

• [nitpick] Consider explicitly indicating the discarded x component (perhaps with a named placeholder like '_x') for clarity. This would help ensure that the component order is immediately clear to readers and maintainers.

_, w_earth_y, w_earth_z = self.env.earth_rotation_vector

rocketpy/simulation/flight.py:1921

• [nitpick] Verify that the coordinate transformation via Kt applied here produces results consistent with the manual component handling in the u_dot method. Ensuring consistency in handling the Earth's rotation vector across methods is crucial for correct Coriolis force computation.

w_earth = Kt @ Vector(self.env.earth_rotation_vector)

[kevin-alcaniz]

Thank you, @Gui-FernandesBR , I appreciate it!

Sure. I'm looking forward to the third check. If you have any doubts or suggestions, please, let me know.

[Gui-FernandesBR]

Before we start working on updating the tests, does any of you have anything to say regarding this PR, @phmbressan @MateusStano ? another review would be appreciated here.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 80.11%. Comparing base (4df0b38) to head (5ca314d).
Report is 22 commits behind head on develop.

Additional details and impacted files

@@             Coverage Diff             @@
##           develop     #799      +/-   ##
===========================================
+ Coverage    79.11%   80.11%   +0.99%     
===========================================
  Files           96       98       +2     
  Lines        11575    12057     +482     
===========================================
+ Hits          9158     9659     +501     
+ Misses        2417     2398      -19     

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

[MateusStano]

Really awesome @kevin-alcaniz!

I took the liberty to add everything that was missing here since it had been so long.

From you implementation though, there was only one mistake: you were applying an extra unnecessary rotation to the earth_rotation_vector. Taking that out made the simulation behavior make more sense.

I also added the coriolis effect to the parachute udot.

For documentation purposes here is a few plots exemplifying the correct expected behavior with the Coriolis acceleration. The simulation here has no wind, no parachutes, and no aerodynamic forces (0 drag and no aero surfaces)

• Environment at Latitude 0, Inclination = 90, Heading = 0. There is no North-South drift, only westward drift:

• Same conditions, this time showing the effect of increasing latitude. As expected, drift decreases as it gets closer to the poles

Now some cases showing the effect of north vs south hemisphere. The expected behavior can be seen from analyzing the added acceleration from the Coriolis effect (written in the Flight Coord System):

$$ a_c = -2 \omega_E \times v = 2 \begin{bmatrix} - v_z \omega \cos{\phi} + v_y \omega \sin{\phi} \\ - v_x \omega \sin{\phi} \\ v_x \omega \cos{\phi} \end{bmatrix} $$

Wherever the $\sin$ terms appear, a difference due to hemisphere is expected. With $v_x$ positive, we expect the northern hemisphere launch to drift southwards, while the southern hemisphere drifts northwards. Opposite should happen for $v_x$ negative

For $v_y$ positive, the northern hemisphere launch should drift further eastwards than the southern hemisphere launch. Opposite for the negative case

• Free falling rocket beginning at 80000 m. Zero initial velocity.

• Free falling rocket beginning at 80000 m. Positive X (eastwards) velocity.

• Free falling rocket beginning at 80000 m. Negative X (westwards) velocity.

• Free falling rocket beginning at 80000 m. Positive Y (northwards) velocity.

• Free falling rocket beginning at 80000 m. Negative Y (southwards) velocity.

Now we just a need a final approve and we can merge this! @Gui-FernandesBR @phmbressan

[Gui-FernandesBR]

Please update changelog