Merge branch 'master' into develop

Author: Gui-FernandesBR

docs/conf.py

@@ -24,7 +24,7 @@
 author = "RocketPy Team"
 
 # The full version, including alpha/beta/rc tags
-release = "1.0.0"
+release = "1.0.1"
 
 
 # -- General configuration ---------------------------------------------------

docs/user/installation.rst

@@ -19,7 +19,7 @@ If you want to choose a specific version to guarantee compatibility, you may ins
 
 .. code-block:: shell
 
-    pip install rocketpy==1.0.0
+    pip install rocketpy==1.0.1
 
 
 Optional Installation Method: ``conda``

rocketpy/prints/rocket_prints.py

@@ -94,7 +94,8 @@ def rocket_geometrical_parameters(self):
             "Rocket Center of Dry Mass - Nozzle Exit: "
             + "{:.3f} m".format(
                 abs(
-                    self.rocket.center_of_dry_mass_position - self.rocket.motor_position
+                    self.rocket.center_of_dry_mass_position
+                    - self.rocket.nozzle_position
                 )
             )
         )

rocketpy/rocket/aero_surface.py

@@ -427,12 +427,13 @@ def final_shape(x):
 
         # Evaluate final geometry parameters
         self.shape_vec = [nosecone_x, nosecone_y]
-        self._length = nosecone_x[-1]
-        print(
-            "Due to the chosen bluffness ratio, the nose cone length was reduced to {:.3f} m.".format(
-                self.length
+        if abs(nosecone_x[-1] - self.length) >= 0.001:  # 1 milimiter
+            self._length = nosecone_x[-1]
+            print(
+                "Due to the chosen bluffness ratio, the nose cone length was reduced to m.".format(
+                    self.length
+                )
             )
-        )
         self.fineness_ratio = self.length / (2 * self.base_radius)
 
         return None

rocketpy/rocket/rocket.py

@@ -109,11 +109,16 @@ class Rocket:
     Rocket.motor : Motor
         Rocket's motor. See Motor class for more details.
     Rocket.motor_position : float
-        Position, in m, of the motor's nozzle exit area relative to the user
-        defined rocket coordinate system. See
-        :doc:`Positions and Coordinate Systems </user/positions>`
-        for more information
+        Position, in meters, of the motor's coordinate system origin
+        relative to the user defined rocket coordinate system.
+        See :doc:`Positions and Coordinate Systems </user/positions>`
+        for more information.
         regarding the rocket's coordinate system.
+    Rocket.nozzle_position : float
+        Position, in meters, of the motor's nozzle exit relative to the user
+        defined rocket coordinate system.
+        See :doc:`Positions and Coordinate Systems </user/positions>`
+        for more information.
     Rocket.center_of_propellant_position : Function
         Position of the propellant's center of mass relative to the user defined
         rocket reference system. See
@@ -697,14 +702,15 @@ def add_motor(self, motor, position):
         self.motor_position = position
         _ = self._csys * self.motor._csys
         self.center_of_propellant_position = (
-            self.motor.center_of_propellant_mass - self.motor.nozzle_position
-        ) * _ + self.motor_position
+            self.motor.center_of_propellant_mass * _ + self.motor_position
+        )
         self.motor_center_of_mass_position = (
-            self.motor.center_of_mass - self.motor.nozzle_position
-        ) * _ + self.motor_position
+            self.motor.center_of_mass * _ + self.motor_position
+        )
         self.motor_center_of_dry_mass_position = (
-            self.motor.center_of_dry_mass_position - self.motor.nozzle_position
-        ) * _ + self.motor_position
+            self.motor.center_of_dry_mass_position * _ + self.motor_position
+        )
+        self.nozzle_position = self.motor.nozzle_position * _ + self.motor_position
         self.evaluate_dry_mass()
         self.evaluate_total_mass()
         self.evaluate_center_of_dry_mass()

rocketpy/simulation/flight.py

@@ -1175,7 +1175,10 @@ def __init_equations_of_motion(self):
 
     @cached_property
     def effective_1rl(self):
-        nozzle = self.rocket.motor_position
+        """Original rail length minus the distance measured from nozzle exit
+        to the upper rail button. It assumes the nozzle to be aligned with
+        the beginning of the rail."""
+        nozzle = self.rocket.nozzle_position
         try:
             rail_buttons = self.rocket.rail_buttons[0]
             upper_r_button = (
@@ -1189,7 +1192,10 @@ def effective_1rl(self):
 
     @cached_property
     def effective_2rl(self):
-        nozzle = self.rocket.motor_position
+        """Original rail length minus the distance measured from nozzle exit
+        to the lower rail button. It assumes the nozzle to be aligned with
+        the beginning of the rail."""
+        nozzle = self.rocket.nozzle_position
         try:
             rail_buttons = self.rocket.rail_buttons[0]
             lower_r_button = rail_buttons.position
@@ -1379,7 +1385,7 @@ def u_dot(self, t, u, post_processing=False):
         )
         # c = -self.rocket.distance_rocket_nozzle
         c = (
-            -(self.rocket.motor_position - self.rocket.center_of_dry_mass_position)
+            -(self.rocket.nozzle_position - self.rocket.center_of_dry_mass_position)
             * self.rocket._csys
         )
         a = b * Mt / M
@@ -1634,7 +1640,7 @@ def u_dot_generalized(self, t, u, post_processing=False):
         r_CM_ddot = Vector([0, 0, r_CM_z.differentiate(t, order=2)])
         ## Nozzle gyration tensor
         r_NOZ = (
-            -(self.rocket.motor_position - self.rocket.center_of_dry_mass_position)
+            -(self.rocket.nozzle_position - self.rocket.center_of_dry_mass_position)
             * self.rocket._csys
         )
         S_noz_33 = 0.5 * self.rocket.motor.nozzle_radius**2
@@ -2436,23 +2442,10 @@ def aerodynamic_spin_moment(self):
     # Kinetic Energy
     @funcify_method("Time (s)", "Rotational Kinetic Energy (J)")
     def rotational_energy(self):
-        # b = -self.rocket.distanceRocketPropellant
-        b = (
-            -(self.rocket.motor_position - self.rocket.center_of_dry_mass_position)
-            * self.rocket._csys
-        )
-        mu = self.rocket.reduced_mass
-        Rz = self.rocket.dry_I_33
-        Ri = self.rocket.dry_I_11
-        Tz = self.rocket.motor.I_33
-        Ti = self.rocket.motor.I_11
-        I1, I2, I3 = (Ri + Ti + mu * b**2), (Ri + Ti + mu * b**2), (Rz + Tz)
-        # Redefine I1, I2 and I3 time grid to allow for efficient Function algebra
-        I1.set_discrete_based_on_model(self.w1)
-        I2.set_discrete_based_on_model(self.w1)
-        I3.set_discrete_based_on_model(self.w1)
         rotational_energy = 0.5 * (
-            I1 * self.w1**2 + I2 * self.w2**2 + I3 * self.w3**2
+            self.rocket.I_11 * self.w1**2
+            + self.rocket.I_22 * self.w2**2
+            + self.rocket.I_33 * self.w3**2
         )
         rotational_energy.set_discrete_based_on_model(self.w1)
         return rotational_energy
@@ -2610,40 +2603,6 @@ def stability_margin(self):
         return [(t, self.rocket.stability_margin(m, t)) for t, m in self.mach_number]
 
     # Rail Button Forces
-    @cached_property
-    def effective_1rl(self):
-        """Original rail length minus the distance measured from nozzle exit
-        to the upper rail button. It assumes the nozzle to be aligned with
-        the beginning of the rail."""
-        nozzle = (
-            self.rocket.motor_position - self.rocket.center_of_dry_mass_position
-        ) * self.rocket._csys  # Kinda works for single nozzle
-        try:
-            rail_buttons = self.rocket.rail_buttons[0]
-            upper_r_button = (
-                rail_buttons.component.buttons_distance + rail_buttons.position
-            )
-        except IndexError:  # No rail buttons defined
-            upper_r_button = nozzle
-        effective_1rl = self.rail_length - abs(nozzle - upper_r_button)
-        return effective_1rl
-
-    @cached_property
-    def effective_2rl(self):
-        """Original rail length minus the distance measured from nozzle exit
-        to the lower rail button. It assumes the nozzle to be aligned with
-        the beginning of the rail."""
-        nozzle = (
-            self.rocket.motor_position - self.rocket.center_of_dry_mass_position
-        ) * self.rocket._csys
-        try:
-            rail_buttons = self.rocket.rail_buttons[0]
-            lower_r_button = rail_buttons.position
-        except IndexError:  # No rail buttons defined
-            lower_r_button = nozzle
-        effective_2rl = self.rail_length - abs(nozzle - lower_r_button)
-        return effective_2rl
-
     @cached_property
     def frontal_surface_wind(self):
         """Surface wind speed in m/s aligned with the launch rail."""

rocketpy/utilities.py

@@ -573,7 +573,7 @@ def apogee(mass):
     source = np.array(list(zip(x, y)), dtype=np.float64)
 
     retfunc = Function(
-        source, inputs="Rocket Dry Mass (kg)", outputs="Estimated Apogee AGL (m)"
+        source, inputs="Rocket Mass without motor (kg)", outputs="Apogee AGL (m)"
     )
     if plot:
         retfunc.plot(min_mass, max_mass, points)
@@ -638,7 +638,9 @@ def liftoff_speed(mass):
     source = np.array(list(zip(x, y)), dtype=np.float64)
 
     retfunc = Function(
-        source, inputs="Rocket Dry Mass (kg)", outputs="Liftoff Speed (m/s)"
+        source,
+        inputs="Rocket Mass without motor (kg)",
+        outputs="Out of Rail Speed (m/s)",
     )
     if plot:
         retfunc.plot(min_mass, max_mass, points)

setup.py

@@ -23,7 +23,7 @@
 
 setuptools.setup(
     name="rocketpy",
-    version="1.0.0",
+    version="1.0.1",
     install_requires=necessary_require,
     extras_require={
         "env_analysis": env_analysis_require,

tests/conftest.py

@@ -111,16 +111,10 @@ def cesaroni_m1670():  # old name: solid_motor
 
 
 @pytest.fixture
-def calisto(cesaroni_m1670):  # old name: rocket
+def calisto_motorless():
     """Create a simple object of the Rocket class to be used in the tests. This
-    is the same rocket that has been used in the getting started guide for
-    years. The Calisto rocket is the Projeto Jupiter's project launched at the
-    2019 Spaceport America Cup.
-
-    Parameters
-    ----------
-    cesaroni_m1670 : rocketpy.SolidMotor
-        An object of the SolidMotor class. This is a pytest fixture too.
+    is the same rocket that has been used in the getting started guide for years
+    but without a motor.
 
     Returns
     -------
@@ -136,60 +130,71 @@ def calisto(cesaroni_m1670):  # old name: rocket
         center_of_mass_without_motor=0,
         coordinate_system_orientation="tail_to_nose",
     )
+    return calisto
+
+
+@pytest.fixture
+def calisto(calisto_motorless, cesaroni_m1670):  # old name: rocket
+    """Create a simple object of the Rocket class to be used in the tests. This
+    is the same rocket that has been used in the getting started guide for
+    years. The Calisto rocket is the Projeto Jupiter's project launched at the
+    2019 Spaceport America Cup.
+
+    Parameters
+    ----------
+    calisto_motorless : rocketpy.Rocket
+        An object of the Rocket class. This is a pytest fixture too.
+    cesaroni_m1670 : rocketpy.SolidMotor
+        An object of the SolidMotor class. This is a pytest fixture too.
+
+    Returns
+    -------
+    rocketpy.Rocket
+        A simple object of the Rocket class
+    """
+    calisto = calisto_motorless
     calisto.add_motor(cesaroni_m1670, position=-1.373)
     return calisto
 
 
 @pytest.fixture
-def calisto_liquid_modded(liquid_motor):
+def calisto_liquid_modded(calisto_motorless, liquid_motor):
     """Create a simple object of the Rocket class to be used in the tests. This
     is an example of the Calisto rocket with a liquid motor.
 
     Parameters
     ----------
+    calisto_motorless : rocketpy.Rocket
+        An object of the Rocket class. This is a pytest fixture too.
     liquid_motor : rocketpy.LiquidMotor
 
     Returns
     -------
     rocketpy.Rocket
         A simple object of the Rocket class
     """
-    calisto = Rocket(
-        radius=0.0635,
-        mass=14.426,
-        inertia=(6.321, 6.321, 0.034),
-        power_off_drag="data/calisto/powerOffDragCurve.csv",
-        power_on_drag="data/calisto/powerOnDragCurve.csv",
-        center_of_mass_without_motor=0,
-        coordinate_system_orientation="tail_to_nose",
-    )
+    calisto = calisto_motorless
     calisto.add_motor(liquid_motor, position=-1.373)
     return calisto
 
 
 @pytest.fixture
-def calisto_hybrid_modded(hybrid_motor):
+def calisto_hybrid_modded(calisto_motorless, hybrid_motor):
     """Create a simple object of the Rocket class to be used in the tests. This
     is an example of the Calisto rocket with a hybrid motor.
 
     Parameters
     ----------
+    calisto_motorless : rocketpy.Rocket
+        An object of the Rocket class. This is a pytest fixture too.
     hybrid_motor : rocketpy.HybridMotor
 
     Returns
     -------
     rocketpy.Rocket
         A simple object of the Rocket class
     """
-    calisto = Rocket(
-        radius=0.0635,
-        mass=14.426,
-        inertia=(6.321, 6.321, 0.034),
-        power_off_drag="data/calisto/powerOffDragCurve.csv",
-        power_on_drag="data/calisto/powerOnDragCurve.csv",
-        center_of_mass_without_motor=0,
-        coordinate_system_orientation="tail_to_nose",
-    )
+    calisto = calisto_motorless
     calisto.add_motor(hybrid_motor, position=-1.373)
     return calisto