Implement fluid simulation template classes

boat_simulator/nodes/physics_engine/fluid_generation.py

@@ -0,0 +1,37 @@
+"""Generator for fluid vectors used in the physics engine."""
+
+import numpy as np
+from numpy.typing import NDArray
+
+from boat_simulator.common.generators import VectorGenerator
+from boat_simulator.common.types import Scalar
+
+
+class FluidGenerator:
+    def __init__(self, generator: VectorGenerator):
+        self.__generator = generator
+        self.__velocity = np.array([0, 0])
+        self.__speed = 0
+        self.__direction = 0
+
+    def next(self) -> NDArray:
+        """Updates the fluid simulator by generating the next velocity vector.
+
+        Returns:
+            NDArray: An array representing the updated velocity vector for the fluid simulation.
+        """
+
+        # TODO: Implement this method
+        return np.array([0, 0])
+
+    @property
+    def velocity(self) -> NDArray:
+        return self.__velocity
+
+    @property
+    def speed(self) -> Scalar:
+        return self.__speed
+
+    @property
+    def direction(self) -> Scalar:
+        return self.__direction

boat_simulator/nodes/physics_engine/force_computation.py

@@ -0,0 +1,43 @@
+"""Class to compute lift and drag forces acting on a medium."""
+
+from typing import Tuple
+
+import numpy as np
+from numpy.typing import NDArray
+
+from boat_simulator.common.types import Scalar
+
+
+class ForceComputation:
+    def __init__(self, lift_coefficient: Scalar, area: Scalar, fluid_density: Scalar):
+        self.__lift_coefficient = lift_coefficient
+        self.__area = area
+        self.__fluid_density = fluid_density
+
+    def compute(self, apparent_velocity: NDArray) -> Tuple[NDArray, NDArray]:
+        """Computes the lift and drag forces acting on a medium.
+
+        Args:
+            apparent_velocity (NDArray): Apparent (relative) velocity between the fluid and the
+                medium, given in meters per second (m/s).
+
+        Returns:
+            Tuple[NDArray, NDArray]: A tuple where the first element represents lift force and the
+                second element represents the drag force, both of which are expressed in
+                newtons (N).
+        """
+
+        # TODO: Implement this method
+        return (np.array([0, 0]), np.array([0, 0]))
+
+    @property
+    def lift_coefficient(self) -> Scalar:
+        return self.__lift_coefficient
+
+    @property
+    def area(self) -> Scalar:
+        return self.__area
+
+    @property
+    def fluid_density(self) -> Scalar:
+        return self.__fluid_density