Skip to content

Commit 5ff03cd

Browse files
aZira371Gui-FernandesBR
authored andcommitted
MNT: docstring corrections to flight.py around new weathercocking implementation
1 parent 7cd0050 commit 5ff03cd

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

rocketpy/simulation/flight.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -578,7 +578,7 @@ def __init__( # pylint: disable=too-many-arguments,too-many-statements
578578
documentation [1]_.
579579
weathercock_coeff : float, optional
580580
Coefficient that controls the rate at which the rocket's body axis
581-
aligns with the relative wind direction in 3-DOF simulations.
581+
aligns with the relative wind direction in 3-DOF simulations, in rad/s.
582582
A higher value means faster alignment (quasi-static weathercocking).
583583
This parameter is only used when simulation_mode is '3 DOF'.
584584
Default is 1.0, which provides moderate alignment. Set to 0 to
@@ -1802,7 +1802,7 @@ def u_dot(self, t, u, post_processing=False): # pylint: disable=too-many-locals
18021802
def u_dot_generalized_3dof(self, t, u, post_processing=False):
18031803
"""Calculates derivative of u state vector with respect to time when the
18041804
rocket is flying in 3 DOF motion in space and significant mass variation
1805-
effects exist.Includes a weathercocking model that evolves the body axis
1805+
effects exist. Includes a weathercocking model that evolves the body axis
18061806
direction toward the relative wind direction.
18071807
18081808
Parameters
@@ -1942,7 +1942,7 @@ def u_dot_generalized_3dof(self, t, u, post_processing=False):
19421942
sin_angle = min(1.0, max(-1.0, sin_angle))
19431943

19441944
# Angular velocity magnitude proportional to misalignment angle
1945-
# Using sin(angle) as approximation for small angles: sin(theta) ≈ theta
1945+
# Angular velocity magnitude proportional to sin(angle)
19461946
omega_mag = self.weathercock_coeff * sin_angle
19471947

19481948
# Angular velocity in inertial frame

0 commit comments

Comments
 (0)