capytaine 3.0.0a1__cp310-cp310-macosx_15_0_x86_64.whl

capytaine/bodies/multibodies.py

@@ -0,0 +1,216 @@
+from __future__ import annotations
+
+import logging
+from itertools import chain, accumulate
+from typing import Union, List, Optional
+from functools import cached_property, lru_cache
+
+import numpy as np
+import xarray as xr
+
+from capytaine.bodies.dofs import (
+    AbstractDof,
+    DofOnSubmesh,
+    add_dofs_labels_to_vector,
+    add_dofs_labels_to_matrix
+)
+
+LOG = logging.getLogger(__name__)
+
+
+class Multibody:
+    def __init__(
+        self,
+        bodies: List[Union[FloatingBody, Multibody]],
+        # own_dofs: Optional[Dict[str, np.array]] = None,
+        *,
+        name: Optional[str] = None
+    ):
+        self.bodies = bodies
+
+        if len(set(b.name for b in self.bodies)) < len(self.bodies):
+            raise ValueError(
+                "In Multibody, all component bodies must have a distinct name.\n"
+                f"Got: {[b.name for b in self.bodies]}"
+                )
+
+        # if own_dofs is None:
+        #     self.own_dofs = {}
+        # else:
+        #     self.own_dofs = own_dofs
+
+        if name is None:
+            self.name = '+'.join(b.name for b in self.bodies)
+        else:
+            self.name = name
+
+        # Keep legacy behavior of former mesh joining
+        for matrix_name in ["inertia_matrix", "hydrostatic_stiffness"]:
+            if all(hasattr(body, matrix_name) for body in bodies):
+                from scipy.linalg import block_diag
+                setattr(self, matrix_name, self.add_dofs_labels_to_matrix(
+                        block_diag(*[getattr(body, matrix_name) for body in bodies])
+                        ))
+
+        LOG.debug(f"New multibody: {self.__str__()}.")
+
+    @lru_cache
+    def as_FloatingBody(self):
+        from capytaine.bodies.bodies import FloatingBody
+        if all(body.mass is not None for body in self.bodies):
+            total_mass = sum(body.mass for body in self.bodies)
+        else:
+            total_mass = None
+
+        if (all(body.mass is not None for body in self.bodies)
+                and all(body.center_of_mass is not None for body in self.bodies)):
+            new_cog = sum(body.mass*np.asarray(body.center_of_mass) for body in self.bodies)/total_mass
+        else:
+            new_cog = None
+
+        return FloatingBody(
+                mesh=self.mesh,
+                dofs=self.dofs,
+                lid_mesh=self.lid_mesh,
+                mass=total_mass,
+                center_of_mass=new_cog,
+                name=self.name,
+                )
+
+    def __str__(self):
+        short_bodies = ', '.join(b.__short_str__() for b in self.bodies)
+        # short_dofs = '{' + ', '.join('"{}": ...'.format(d) for d in self.own_dofs) + '}'
+        return f"Multibody({short_bodies})" #, own_dofs={short_dofs})"
+
+    def __short_str__(self):
+        return str(self)
+
+    def __repr__(self):
+        return str(self)
+
+    def _check_dofs_shape_consistency(self):
+        # TODO
+        ...
+
+    @cached_property
+    def minimal_computable_wavelength(self):
+        return min(b.minimal_computable_wavelength for b in self.bodies)
+
+    def first_irregular_frequency_estimate(self, *args, **kwargs):
+        return min(b.first_irregular_frequency_estimate(*args, **kwargs) for b in self.bodies)
+
+    @cached_property
+    def mesh(self):
+        return self.bodies[0].mesh.join_meshes(*[b.mesh for b in self.bodies[1:]])
+
+    @cached_property
+    def lid_mesh(self):
+        if all(body.lid_mesh is None for body in self.bodies):
+            return None
+        else:
+            lid_meshes = [body.lid_mesh.copy() for body in self.bodies if body.lid_mesh is not None]
+            joined_lid = lid_meshes[0].join_meshes(*lid_meshes[1:], name=f"{self.name}_lid_mesh")
+            return joined_lid
+
+    @cached_property
+    def mesh_including_lid(self):
+        return self.bodies[0].mesh_including_lid.join_meshes(*[b.mesh_including_lid for b in self.bodies[1:]])
+
+    @cached_property
+    def hull_mask(self):
+        return np.concatenate([b.hull_mask for b in self.bodies])
+
+    @property
+    def nb_dofs(self):
+        return sum(b.nb_dofs for b in self.bodies) # + len(self.own_dofs)
+
+    @cached_property
+    def dofs(self):
+        for body in self.bodies:
+            body._check_dofs_shape_consistency()
+
+        componenents_dofs = {}
+        cum_nb_faces = accumulate(chain([0], (body.mesh.nb_faces for body in self.bodies)))
+        total_nb_faces = sum(body.mesh.nb_faces for body in self.bodies)
+        for body, nbf in zip(self.bodies, cum_nb_faces):
+            # nbf is the cumulative number of faces of the previous subbodies,
+            # that is the offset of the indices of the faces of the current body.
+            for name, dof in body.dofs.items():
+                if isinstance(dof, AbstractDof):
+                    new_dof = DofOnSubmesh(dof, range(nbf, nbf+body.mesh.nb_faces))
+                else:
+                    new_dof = np.zeros((total_nb_faces, 3))
+                    new_dof[nbf:nbf+len(dof), :] = dof
+
+                if '__' not in name:
+                    new_dof_name = '__'.join([body.name, name])
+                else:
+                    # The body is probably a combination of bodies already.
+                    # So for the associativity of the + operation,
+                    # it is better to keep the same name.
+                    new_dof_name = name
+                componenents_dofs[new_dof_name] = new_dof
+
+        return {**componenents_dofs} #, **self.own_dofs}
+
+    def add_dofs_labels_to_vector(self, vector):
+        """Helper function turning a bare vector into a vector labelled by the name of the dofs of the body,
+        to be used for instance for the computation of RAO."""
+        return add_dofs_labels_to_vector(self.dofs.keys(), vector)
+
+    def add_dofs_labels_to_matrix(self, matrix):
+        """Helper function turning a bare matrix into a matrix labelled by the name of the dofs of the body,
+        to be used for instance for the computation of RAO."""
+        return add_dofs_labels_to_matrix(self.dofs.keys(), matrix)
+
+    def immersed_part(self, *args, **kwargs):
+        return Multibody(
+                [b.immersed_part() for b in self.bodies],
+                # own_dofs=None,  # TODO
+                )
+
+    def __add__(self, body_to_add):
+        return self.join_bodies(body_to_add)
+
+    def join_bodies(*bodies, name=None):
+        from capytaine.bodies.multibodies import Multibody
+        return Multibody(bodies, name=name)
+
+    def integrate_pressure(self, pressure):
+        return self.as_FloatingBody().integrate_pressure(pressure)
+
+    @cached_property
+    def center_of_buoyancy(self):
+        return {b.name: b.center_of_buoyancy for b in self.bodies}
+
+    @cached_property
+    def center_of_mass(self):
+        return {b.name: b.center_of_mass for b in self.bodies}
+
+    @cached_property
+    def volume(self):
+        return {b.name: b.volume for b in self.bodies}
+
+    @cached_property
+    def mass(self):
+        return {b.name: b.mass for b in self.bodies}
+
+    def _combine_component_matrices(self, matrices):
+        for m, b in zip(matrices, self.bodies):
+            m.coords['radiating_dof'] = np.array([b.name + '__' + k for k in m.coords['radiating_dof'].values])
+            m.coords['influenced_dof'] = np.array([b.name + '__' + k for k in m.coords['influenced_dof'].values])
+
+        return xr.concat(
+            matrices,
+            dim="radiating_dof",
+            fill_value=0.0
+        ).sel(
+            radiating_dof=list(self.dofs.keys()),
+            influenced_dof=list(self.dofs.keys())
+        )
+
+    def compute_hydrostatic_stiffness(self, *, rho=1000.0, g=9.81):
+        return self._combine_component_matrices([b.compute_hydrostatic_stiffness(rho=rho, g=g) for b in self.bodies])
+
+    def compute_rigid_body_inertia(self, rho=1000.0):
+        return self._combine_component_matrices([b.compute_rigid_body_inertia(rho=rho) for b in self.bodies])

capytaine/green_functions/__init__.py

@@ -0,0 +1,2 @@
+# Copyright (C) 2017-2019 Matthieu Ancellin
+# See LICENSE file at <https://github.com/mancellin/capytaine>

capytaine/green_functions/abstract_green_function.py

@@ -0,0 +1,64 @@
+"""Abstract structure of a class used to compute the Green function"""
+# Copyright (C) 2017-2024 Matthieu Ancellin
+# See LICENSE file at <https://github.com/capytaine/capytaine>
+
+from abc import ABC, abstractmethod
+
+import numpy as np
+
+from capytaine.meshes.abstract_meshes import AbstractMesh
+
+
+class GreenFunctionEvaluationError(Exception):
+    pass
+
+
+class AbstractGreenFunction(ABC):
+    """Abstract method to evaluate the Green function."""
+
+    floating_point_precision: str
+
+    def _get_colocation_points_and_normals(self, mesh1, mesh2, adjoint_double_layer):
+        if isinstance(mesh1, AbstractMesh):
+            collocation_points = mesh1.faces_centers
+            nb_collocation_points = mesh1.nb_faces
+            if not adjoint_double_layer: # Computing the D matrix
+                early_dot_product_normals = mesh2.faces_normals
+            else: # Computing the K matrix
+                early_dot_product_normals = mesh1.faces_normals
+
+        elif isinstance(mesh1, np.ndarray) and mesh1.ndim == 2 and mesh1.shape[1] == 3:
+            # This is used when computing potential or velocity at given points in postprocessing
+            collocation_points = mesh1
+            nb_collocation_points = mesh1.shape[0]
+            if not adjoint_double_layer: # Computing the D matrix
+                early_dot_product_normals = mesh2.faces_normals
+            else: # Computing the K matrix
+                early_dot_product_normals = np.zeros((nb_collocation_points, 3))
+                # Dummy argument since this method is meant to be used either
+                # - to compute potential, then only S is needed and early_dot_product_normals is irrelevant,
+                # - to compute velocity, then the adjoint full gradient is needed and early_dot_product is False and this value is unused.
+                # TODO: add an only_S argument and return an error here if (early_dot_product and not only_S)
+
+        else:
+            raise ValueError(f"Unrecognized first input for {self.__class__.__name__}.evaluate:\n{mesh1}")
+
+        return collocation_points, early_dot_product_normals
+
+    def _init_matrices(self, shape, early_dot_product):
+        if self.floating_point_precision == "float32":
+            dtype = "complex64"
+        elif self.floating_point_precision == "float64":
+            dtype = "complex128"
+        else:
+            raise NotImplementedError(
+                    f"Unsupported floating point precision: {self.floating_point_precision}"
+                    )
+
+        S = np.zeros(shape, order="F", dtype=dtype)
+        K = np.zeros((shape[0], shape[1], 1 if early_dot_product else 3), order="F", dtype=dtype)
+        return S, K
+
+    @abstractmethod
+    def evaluate(self, mesh1, mesh2, free_surface, water_depth, wavenumber, adjoint_double_layer=True, early_dot_product=True):
+        pass