Magnetic disturbances

paseos/actors/actor_builder.py

@@ -13,6 +13,7 @@
 from ..thermal.thermal_model import ThermalModel
 from ..power.power_device_type import PowerDeviceType
 from ..radiation.radiation_model import RadiationModel
+from ..attitude.attitude_model import AttitudeModel
 from paseos.geometric_model.geometric_model import GeometricModel
 
 
@@ -519,6 +520,64 @@ def set_thermal_model(
             power_consumption_to_heat_ratio=power_consumption_to_heat_ratio,
         )
 
+    @staticmethod
+    def set_disturbances(
+            actor: SpacecraftActor,
+            aerodynamic: bool = False,
+            gravitational: bool = False,
+            magnetic: bool = False,
+    ):
+        """Enables the attitude disturbances to be considered in the attitude modelling for an actor.
+
+        Args:
+            actor (SpacecraftActor): The actor to add to.
+            aerodynamic (bool): Whether to consider aerodynamic disturbances in the attitude model. Defaults to False
+            gravitational (bool): Whether to consider gravity disturbances in the attitude model. Defaults to False
+            magnetic (bool): Whether to consider magnetic disturbances in the attitude model. Defaults to False
+        """
+        # Create a list with user specified disturbances which are considered in the attitude modelling.
+        disturbance_list = []
+
+        if aerodynamic:
+            disturbance_list.append("aerodynamic")
+        if gravitational:
+            disturbance_list.append("gravitational")
+        if magnetic:
+            disturbance_list.append("magnetic")
+
+        # Assign disturbance list to actor.
+        actor._disturbances = disturbance_list
+
+    @staticmethod
+    def set_attitude_model(
+            actor: SpacecraftActor,
+            actor_initial_attitude_in_rad: list[float] = [0.0, 0.0, 0.0],
+            actor_initial_angular_velocity: list[float] = [0.0, 0.0, 0.0],
+            actor_pointing_vector_body: list[float] = [0.0, 0.0, 1.0],
+            actor_residual_magnetic_field: list[float] = [0.0, 0.0, 0.0],
+
+    ):
+        """Add an attitude model to the actor based on initial conditions: attitude (roll, pitch & yaw angles)
+        and angular velocity vector, modeling the evolution of the user specified pointing vector.
+
+        Args:
+            actor (SpacecraftActor): Actor to model.
+            actor_initial_attitude_in_rad (list of floats): Actor's initial attitude. Defaults to [0.0, 0.0, 0.0].
+            actor_initial_angular_velocity (list of floats): Actor's initial angular velocity. Defaults to [0.0, 0.0, 0.0].
+            actor_pointing_vector_body (list of floats): Actor's pointing vector. Defaults to [0.0, 0.0, 1.0].
+            actor_residual_magnetic_field (list of floats): Actor's residual magnetic dipole moment vector.
+            Defaults to [0.0, 0.0, 0.0].
+        """
+
+        actor._attitude_model = AttitudeModel(
+            local_actor=actor,
+            actor_initial_attitude_in_rad=actor_initial_attitude_in_rad,
+            actor_initial_angular_velocity=actor_initial_angular_velocity,
+            actor_pointing_vector_body=actor_pointing_vector_body,
+            actor_residual_magnetic_field=actor_residual_magnetic_field,
+
+        )
+
     @staticmethod
     def add_comm_device(actor: BaseActor, device_name: str, bandwidth_in_kbps: float):
         """Creates a communication device.

paseos/actors/base_actor.py

@@ -47,6 +47,9 @@ class BaseActor(ABC):
     # Tracks the current activity
     _current_activity = None
 
+    # Attitude disturbances experienced by the actor
+    _disturbances = None
+
     # The following variables are used to track last evaluated state vectors to avoid recomputation.
     _previous_position = None
     _time_of_previous_position = None
@@ -157,6 +160,24 @@ def has_thermal_model(self) -> bool:
         """
         return hasattr(self, "_thermal_model") and self._thermal_model is not None
 
+    @property
+    def has_attitude_model(self) -> bool:
+        """Returns true if actor's attitude is modeled, else false.
+
+        Returns:
+            bool: bool indicating presence.
+        """
+        return hasattr(self, "_attitude_model") and self._attitude_model is not None
+
+    @property
+    def has_attitude_disturbances(self) -> bool:
+        """Returns true if actor has attitude disturbances attributed, else false.
+
+        Returns:
+            bool: bool indicating presence.
+        """
+        return hasattr(self, "_disturbances") and self._disturbances is not None
+
     @property
     def mass(self) -> float:
         """Returns actor's mass in kg.
@@ -328,6 +349,17 @@ def get_position_velocity(self, epoch: pk.epoch):
         self._time_of_previous_position = epoch.mjd2000
         return pos, vel
 
+    def get_disturbances(self):
+        """Get the user-specified spacecraft attitude disturbances.
+
+        Returns:
+            list[string]: name of disturbances
+        """
+        if self.has_attitude_disturbances:
+            return self._disturbances
+        else:
+            return "No disturbances"
+
     def is_in_line_of_sight(
         self,
         other_actor: "BaseActor",

paseos/actors/spacecraft_actor.py

@@ -1,3 +1,4 @@
+import numpy as np
 from loguru import logger
 import pykep as pk
 
@@ -21,6 +22,7 @@ class SpacecraftActor(BaseActor):
 
     _thermal_model = None
     _radiation_model = None
+    _attitude_model = None
 
     # If radiation randomly restarted the device
     _was_interrupted = False
@@ -164,3 +166,43 @@ def charge(self, duration_in_s: float):
         self = charge_model.charge(self, duration_in_s)
 
         logger.debug(f"New battery level is {self.battery_level_in_Ws}")
+
+    def attitude_in_rad(self):
+        """Returns the current attitude of the actor in radians.
+
+        Returns:
+            list[floats]: actor attitude in radians.
+        """
+        if type(self._attitude_model._actor_attitude_in_rad) == np.ndarray:
+            return np.ndarray.tolist(self._attitude_model._actor_attitude_in_rad)
+        else:
+            return self._attitude_model._actor_attitude_in_rad
+
+    def attitude_in_deg(self):
+        """Returns the current attitude of the actor in degrees.
+
+        Returns:
+            list[floats]: actor attitude in degrees.
+        """
+        if type(self._attitude_model._actor_attitude_in_rad) == np.ndarray:
+            return np.ndarray.tolist(self._attitude_model._actor_attitude_in_rad * 180 / np.pi)
+        else:
+            return np.ndarray.tolist(np.array(self._attitude_model._actor_attitude_in_rad) * 180 / np.pi)
+
+
+    def pointing_vector(self):
+        """Returns the spacecraft pointing vector in the Earth-centered inertial frame.
+
+        Returns:
+            np.ndarray (x, y, z).
+        """
+        return self._attitude_model._actor_pointing_vector_eci
+
+
+    def angular_velocity(self):
+        """Returns the spacecraft angular velocity vector in the Earth-centered inertial frame.
+
+        Returns:
+            np.ndarray (owega_x, omega_y, omega_z).
+        """
+        return self._attitude_model._actor_angular_velocity_eci