ENH: Air Brakes

data/calisto/airbrakes_cd.csv

@@ -0,0 +1,133 @@
+0.0, 0.0, 0.000
+0.0, 0.1, 0.000
+0.0, 0.2, 0.000
+0.0, 0.3, 0.000
+0.0, 0.4, 0.000
+0.0, 0.5, 0.000
+0.0, 0.6, 0.000
+0.0, 0.7, 0.000
+0.0, 0.8, 0.000
+0.0, 0.9, 0.000
+0.0, 1.0, 0.000
+0.0, 1.1, 0.000
+0.1, 0.0, 0.000
+0.2, 0.0, 0.000
+0.3, 0.0, 0.000
+0.4, 0.0, 0.000
+0.5, 0.0, 0.000
+0.6, 0.0, 0.000
+0.7, 0.0, 0.000
+0.8, 0.0, 0.000
+0.9, 0.0, 0.000
+1.0, 0.0, 0.000
+1.1, 0.0, 0.000
+0.1, 0.1, 0.000
+0.1, 0.2, 0.000
+0.1, 0.3, 0.045
+0.1, 0.4, 0.022
+0.1, 0.5, 0.026
+0.1, 0.6, 0.076
+0.1, 0.7, 0.051
+0.1, 0.8, 0.058
+0.1, 0.9, 0.022
+0.1, 1.0, 0.000
+0.1, 1.1, 0.000
+0.2, 0.1, 0.022
+0.2, 0.2, 0.062
+0.2, 0.3, 0.093
+0.2, 0.4, 0.076
+0.2, 0.5, 0.070
+0.2, 0.6, 0.129
+0.2, 0.7, 0.102
+0.2, 0.8, 0.115
+0.2, 0.9, 0.084
+0.2, 1.0, 0.018
+0.2, 1.1, 0.000
+0.3, 0.1, 0.056
+0.3, 0.2, 0.106
+0.3, 0.3, 0.147
+0.3, 0.4, 0.139
+0.3, 0.5, 0.139
+0.3, 0.6, 0.183
+0.3, 0.7, 0.169
+0.3, 0.8, 0.183
+0.3, 0.9, 0.149
+0.3, 1.0, 0.093
+0.3, 1.1, 0.070
+0.4, 0.1, 0.120
+0.4, 0.2, 0.169
+0.4, 0.3, 0.214
+0.4, 0.4, 0.195
+0.4, 0.5, 0.214
+0.4, 0.6, 0.262
+0.4, 0.7, 0.253
+0.4, 0.8, 0.271
+0.4, 0.9, 0.253
+0.4, 1.0, 0.192
+0.4, 1.1, 0.164
+0.5, 0.1, 0.217
+0.5, 0.2, 0.217
+0.5, 0.3, 0.275
+0.5, 0.4, 0.257
+0.5, 0.5, 0.284
+0.5, 0.6, 0.349
+0.5, 0.7, 0.340
+0.5, 0.8, 0.360
+0.5, 0.9, 0.340
+0.5, 1.0, 0.288
+0.5, 1.1, 0.253
+0.6, 0.1, 0.245
+0.6, 0.2, 0.288
+0.6, 0.3, 0.382
+0.6, 0.4, 0.360
+0.6, 0.5, 0.382
+0.6, 0.6, 0.457
+0.6, 0.7, 0.445
+0.6, 0.8, 0.447
+0.6, 0.9, 0.434
+0.6, 1.0, 0.403
+0.6, 1.1, 0.360
+0.7, 0.1, 0.320
+0.7, 0.2, 0.392
+0.7, 0.3, 0.487
+0.7, 0.4, 0.476
+0.7, 0.5, 0.476
+0.7, 0.6, 0.564
+0.7, 0.7, 0.527
+0.7, 0.8, 0.531
+0.7, 0.9, 0.527
+0.7, 1.0, 0.520
+0.7, 1.1, 0.487
+0.8, 0.1, 0.426
+0.8, 0.2, 0.507
+0.8, 0.3, 0.568
+0.8, 0.4, 0.538
+0.8, 0.5, 0.538
+0.8, 0.6, 0.617
+0.8, 0.7, 0.613
+0.8, 0.8, 0.624
+0.8, 0.9, 0.613
+0.8, 1.0, 0.520
+0.8, 1.1, 0.591
+0.9, 0.1, 0.507
+0.9, 0.2, 0.568
+0.9, 0.3, 0.613
+0.9, 0.4, 0.600
+0.9, 0.5, 0.609
+0.9, 0.6, 0.684
+0.9, 0.7, 0.684
+0.9, 0.8, 0.702
+0.9, 0.9, 0.708
+0.9, 1.0, 0.624
+0.9, 1.1, 0.674
+1.0, 0.1, 0.937
+1.0, 0.2, 0.937
+1.0, 0.3, 0.937
+1.0, 0.4, 0.887
+1.0, 0.5, 0.803
+1.0, 0.6, 0.930
+1.0, 0.7, 0.887
+1.0, 0.8, 0.921
+1.0, 0.9, 0.815
+1.0, 1.0, 0.844
+1.0, 1.1, 0.803

rocketpy/__init__.py

@@ -22,6 +22,7 @@
     TankGeometry,
     UllageBasedTank,
 )
+from .control import Controller
 from .rocket import (
     AeroSurface,
     Components,

rocketpy/control/__init__.py

@@ -0,0 +1 @@
+from .controller import Controller

rocketpy/control/controller.py

@@ -0,0 +1,87 @@
+from ..prints.control_prints import _ControllerPrints
+
+
+class Controller:
+    """A class for storing and running controllers on a rocket."""
+
+    def __init__(
+        self,
+        observed_objects,
+        controller_function,
+        sampling_rate,
+        name="Controller",
+    ):
+        """Initialize the class with the controller function and the objects to
+        be observed.
+
+        Parameters
+        ----------
+        observed_objects : list
+            A list of objects to be observed by the controller. It can be any
+            python object. This list will be passed to the controller function
+            as positional arguments, meaning that the order of the objects in
+            this list matters. These objects will then be able to be accessed
+            and modified by the controller function.
+        controller_function : function, callable
+            A function that takes the following arguments, in this order:
+
+            1. Time of the simulation at the current step in seconds.
+            2. The state vector of the simulation, which is defined as:
+
+               `[x, y, z, vx, vy, vz, e0, e1, e2, e3, wx, wy, wz]`.
+            3. A list containing the objects to be acted upon by the controller.
+               The objects in this list are the same as the objects in the
+               observed_objects list, but they can be modified by the controller.
+
+            This function will be called during the simulation at the specified
+            sampling rate. The function should evaluate and change the observed
+            objects as needed. The function should return None.
+
+            Note: The function will be called according to the sampling rate
+            specified.
+
+        sampling_rate : float
+            The sampling rate of the controller function in Hertz (Hz). This
+            means that the controller function will be called every
+            `1/sampling_rate` seconds.
+        name : str
+            The name of the controller. This will be used for printing and
+            plotting.
+
+        Returns
+        -------
+        None
+        """
+
+        self.observed_objects = observed_objects
+        self.controller_function = controller_function
+        self.sampling_rate = sampling_rate
+        self.name = name
+        self.print = _ControllerPrints
+
+    def __call__(self, time, state_vector):
+        """Call the controller function. This is used by the simulation class.
+
+        Parameters
+        ----------
+        time : float
+            The time of the simulation in seconds.
+        state_vector : list
+            The state vector of the simulation, which is defined as:
+
+            `[x, y, z, vx, vy, vz, e0, e1, e2, e3, wx, wy, wz]`.
+
+        Returns
+        -------
+        None
+        """
+        self.controller_function(time, state_vector, self.observed_objects)
+
+    def __str__(self):
+        return self.name
+
+    def info(self):
+        self.prints.all()
+
+    def all_info(self):
+        self.info()

rocketpy/plots/aero_surface_plots.py

@@ -448,3 +448,97 @@ def __init__(self, tail):
     def draw(self):
         # This will de done in the future
         return None
+
+
+class _AirbrakesPlots(_AeroSurfacePlots):
+    """Class that contains all airbrakes plots."""
+
+    def __init__(self, airbrakes):
+        """Initialize the class
+
+        Parameters
+        ----------
+        airbrakes : rocketpy.AeroSurface.airbrakes
+            Airbrakes object to be plotted
+
+        Returns
+        -------
+        None
+        """
+        super().__init__(airbrakes)
+        return None
+
+    def cd_curve(self):
+        return self.aero_surface.cd.plot(0, 1)
+
+    def deployed_level(self):
+        """Plots the deployed level of the airbrakes as a function of time.
+
+        Returns
+        -------
+        None
+        """
+
+        # Extract the first and second columns as x and y
+        x = [row[0] for row in self.aero_surface.state_history]
+        y = [row[1] for row in self.aero_surface.state_history]
+
+        # Create the plot
+        plt.figure(figsize=(10, 6))  # Adjust the figure size as needed
+        plt.scatter(
+            x, y, marker="o", linestyle="-", color="b", s=0.5
+        )  # You can customize the marker, linestyle, and color
+
+        # Add labels and a title
+        plt.xlabel("Time (s)")
+        plt.ylabel("Deployed Level")
+        plt.title("Deployed Level X Time (s)")
+
+        # Show the plot
+        plt.grid(True)  # Add grid lines if needed
+        plt.show()
+
+        return None
+
+    def cd(self):
+        """Plots the drag coefficient of the airbrakes as a function of time.
+
+        Returns
+        -------
+        None
+        """
+        # Extract the first and second columns as x and y
+        x = [row[0] for row in self.aero_surface.state_history]
+        y = [row[2] for row in self.aero_surface.state_history]
+
+        # Create the plot
+        plt.figure(figsize=(10, 6))  # Adjust the figure size as needed
+        plt.scatter(
+            x, y, marker="o", linestyle="-", color="b", s=0.5
+        )  # You can customize the marker, linestyle, and color
+
+        # Add labels and a title
+        plt.xlabel("Time (s)")
+        plt.ylabel("Drag Coefficient")
+        plt.title("Drag Coefficient X Time (s)")
+
+        # Show the plot
+        plt.grid(True)  # Add grid lines if needed
+        plt.show()
+
+        return None
+
+    def draw(self):
+        raise NotImplementedError
+
+    def all(self):
+        """Plots all available airbrakes plots.
+
+        Returns
+        -------
+        None
+        """
+        self.deployed_level()
+        self.cd()
+        self.cd_curve()
+        return None

rocketpy/prints/__init__.py

@@ -4,6 +4,7 @@
     _RailButtonsPrints,
     _TailPrints,
     _TrapezoidalFinsPrints,
+    _AirbrakesPrints,
 )
 from .compare_prints import _ComparePrints
 from .environment_analysis_prints import _EnvironmentAnalysisPrints

rocketpy/prints/aero_surface_prints.py

@@ -291,3 +291,41 @@ def geometry(self):
             f"Angular position of the buttons: {self.aero_surface.angular_position:.3f} deg\n"
         )
         return None
+
+
+class _AirbrakesPrints(_AeroSurfacePrints):
+    """Class that contains all tail prints."""
+
+    def __init__(self, Airbrakes):
+        """Initialize the class
+
+        Parameters
+        ----------
+        Airbrakes : rocketpy.AeroSurface.Airbrakes
+            Air break object to be printed.
+
+        Returns
+        -------
+        None
+        """
+        super().__init__(Airbrakes)
+        return None
+
+    def geometry(self):
+        """Prints the geometric information of the air break.
+
+        Returns
+        -------
+        None
+        """
+        print(f"Geometric information of the Air Break:")
+        print(f"----------------------------------")
+        print(
+            f"Current deployed level: {self.aero_surface.deployed_level:.2f} = {100*self.aero_surface.deployed_level:.0f} %"
+        )
+        print(
+            f"Current Cd: {self.aero_surface.cd_curve(self.aero_surface.deployed_level)} m²"
+        )
+        print(f"Maximum Cd: {self.aero_surface.cd.max:.3f} m²")
+        print(f"Minimum Cd: {self.aero_surface.cd.min:.3f} m²")
+        return None