Skip to content

Commit 94e2958

Browse files
committed
MNT: small doc changes
1 parent 1f76b41 commit 94e2958

File tree

6 files changed

+13
-22
lines changed

6 files changed

+13
-22
lines changed

rocketpy/rocket/aero_surface/fins/elliptical_fins.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ def __init__(
106106
Parameters
107107
----------
108108
n : int
109-
Number of fins, from 2 to infinity.
109+
Number of fins, must be larger than 2.
110110
root_chord : int, float
111111
Fin root chord in meters.
112112
span : int, float

rocketpy/rocket/aero_surface/fins/fins.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ def __init__(
106106
Parameters
107107
----------
108108
n : int
109-
Number of fins, from 2 to infinity.
109+
Number of fins, must be larger than 2.
110110
root_chord : int, float
111111
Fin root chord in meters.
112112
span : int, float

rocketpy/rocket/aero_surface/fins/free_form_fins.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ def __init__(
101101
Parameters
102102
----------
103103
n : int
104-
Number of fins, from 2 to infinity.
104+
Number of fins, must be larger than 2.
105105
shape_points : list
106106
List of tuples (x, y) containing the coordinates of the fin's
107107
geometry defining points. The point (0, 0) is the root leading edge.

rocketpy/rocket/aero_surface/fins/trapezoidal_fins.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ def __init__(
111111
Parameters
112112
----------
113113
n : int
114-
Number of fins, from 2 to infinity.
114+
Number of fins, must be larger than 2.
115115
root_chord : int, float
116116
Fin root chord in meters.
117117
tip_chord : int, float

rocketpy/rocket/rocket.py

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -563,10 +563,10 @@ def evaluate_surfaces_cp_to_cdm(self):
563563
surface center of pressure to the rocket's center of mass.
564564
"""
565565
for surface, position in self.aerodynamic_surfaces:
566-
self.evaluate_single_surface_cp_to_cdm(surface, position)
566+
self.__evaluate_single_surface_cp_to_cdm(surface, position)
567567
return self.surfaces_cp_to_cdm
568568

569-
def evaluate_single_surface_cp_to_cdm(self, surface, position):
569+
def __evaluate_single_surface_cp_to_cdm(self, surface, position):
570570
"""Calculates the relative position of each aerodynamic surface
571571
center of pressure to the rocket's center of dry mass in Body Axes
572572
Coordinate System."""
@@ -996,21 +996,22 @@ def add_surfaces(self, surfaces, positions):
996996
-------
997997
None
998998
"""
999+
# TODO: separate this method into smaller methods: https://github.com/RocketPy-Team/RocketPy/pull/696#discussion_r1771978422
9991000
try:
10001001
for surface, position in zip(surfaces, positions):
10011002
if not isinstance(position, (Vector, tuple, list)):
10021003
position = Vector([0, 0, position])
10031004
else:
10041005
position = Vector(position)
10051006
self.aerodynamic_surfaces.add(surface, position)
1006-
self.evaluate_single_surface_cp_to_cdm(surface, position)
1007+
self.__evaluate_single_surface_cp_to_cdm(surface, position)
10071008
except TypeError:
10081009
if not isinstance(positions, (Vector, tuple, list)):
10091010
positions = Vector([0, 0, positions])
10101011
else:
10111012
positions = Vector(positions)
10121013
self.aerodynamic_surfaces.add(surfaces, positions)
1013-
self.evaluate_single_surface_cp_to_cdm(surfaces, positions)
1014+
self.__evaluate_single_surface_cp_to_cdm(surfaces, positions)
10141015

10151016
self.evaluate_center_of_pressure()
10161017
self.evaluate_stability_margin()
@@ -1175,7 +1176,7 @@ def add_trapezoidal_fins(
11751176
Parameters
11761177
----------
11771178
n : int
1178-
Number of fins, from 2 to infinity.
1179+
Number of fins, must be greater than 2.
11791180
span : int, float
11801181
Fin span in meters.
11811182
root_chord : int, float
@@ -1273,7 +1274,7 @@ def add_elliptical_fins(
12731274
Parameters
12741275
----------
12751276
n : int
1276-
Number of fins, from 2 to infinity.
1277+
Number of fins, must be greater than 2.
12771278
root_chord : int, float
12781279
Fin root chord in meters.
12791280
span : int, float
@@ -1341,8 +1342,8 @@ def add_free_form_fins(
13411342
Parameters
13421343
----------
13431344
n : int
1344-
Number of fins, from 2 to infinity.
1345-
shape_points : list[tuple[float, float]]
1345+
Number of fins, must be greater than 2.
1346+
shape_points : list
13461347
List of tuples (x, y) containing the coordinates of the fin's
13471348
geometry defining points. The point (0, 0) is the root leading edge.
13481349
Positive x is rearwards, positive y is upwards (span direction).

rocketpy/simulation/flight.py

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2704,16 +2704,6 @@ def angle_of_sideslip(self):
27042704
) # x-z plane
27052705
return np.column_stack([self.time, np.rad2deg(beta)])
27062706

2707-
@funcify_method("Time (s)", "Angle of Attack (°)", "spline", "constant")
2708-
def angle_of_attack2(self):
2709-
alpha = np.arctan(
2710-
np.sqrt(
2711-
np.tan(np.deg2rad(self.partial_angle_of_attack.y_array)) ** 2
2712-
+ np.tan(np.deg2rad(self.angle_of_sideslip.y_array)) ** 2
2713-
)
2714-
)
2715-
return np.column_stack([self.time, np.rad2deg(alpha)])
2716-
27172707
# Frequency response and stability variables
27182708
@funcify_method("Frequency (Hz)", "ω1 Fourier Amplitude", "spline", "zero")
27192709
def omega1_frequency_response(self):

0 commit comments

Comments
 (0)