capytaine 3.0.0a1__cp38-cp38-macosx_15_0_x86_64.whl

capytaine/__about__.py

@@ -0,0 +1,21 @@
+#!/usr/bin/env python3
+
+__all__ = ["__title__", "__description__", "__version__", "__author__", "__uri__", "__license__"]
+
+__title__ = "capytaine"
+__description__ = """Python BEM solver for linear potential flow, based on Nemoh"""
+
+__author__ = "Matthieu Ancellin"
+__uri__ = "https://github.com/capytaine/capytaine"
+__license__ = "GPL-3.0"
+
+__version__ = "3.0.0a1"
+
+__build_info__ = {
+    "compiler": "gcc 13.4.0",
+    "build_time": "2026-02-02T13:05:10Z"
+}
+
+
+if __name__ == "__main__":
+    print(__version__)

capytaine/__init__.py

@@ -0,0 +1,32 @@
+# Copyright (C) 2017-2025 Matthieu Ancellin
+# See LICENSE file at <https://github.com/capytaine/capytaine>
+
+from .__about__ import (
+    __title__, __description__, __version__, __author__, __uri__, __license__, __build_info__
+)
+
+from capytaine.meshes.meshes import Mesh
+from capytaine.meshes.io import load_mesh
+from capytaine.meshes.symmetric_meshes import ReflectionSymmetricMesh, RotationSymmetricMesh
+
+from capytaine.meshes.predefined.cylinders import mesh_disk, mesh_horizontal_cylinder, mesh_vertical_cylinder
+from capytaine.meshes.predefined.spheres import mesh_sphere
+from capytaine.meshes.predefined.rectangles import mesh_rectangle, mesh_parallelepiped
+
+from capytaine.bodies.bodies import FloatingBody
+from capytaine.bodies.multibodies import Multibody
+from capytaine.bodies.dofs import rigid_body_dofs
+
+from capytaine.bem.problems_and_results import RadiationProblem, DiffractionProblem
+from capytaine.bem.solver import BEMSolver
+from capytaine.bem.engines import BasicMatrixEngine
+from capytaine.green_functions.delhommeau import Delhommeau, XieDelhommeau
+from capytaine.green_functions.hams import LiangWuNoblesseGF, FinGreen3D, HAMS_GF
+
+from capytaine.post_pro.free_surfaces import FreeSurface
+
+from capytaine.io.xarray import assemble_dataframe, assemble_dataset, assemble_matrices, export_dataset
+
+from capytaine.ui.rich import set_logging
+
+set_logging(level="WARNING")

capytaine/bem/airy_waves.py

@@ -0,0 +1,111 @@
+"""Computing the potential and velocity of Airy wave."""
+# Copyright (C) 2017-2019 Matthieu Ancellin
+# See LICENSE file at <https://github.com/mancellin/capytaine>
+
+import numpy as np
+from capytaine.tools.lists_of_points import _normalize_points, _normalize_free_surface_points
+
+def airy_waves_potential(points, pb):
+    """Compute the potential for Airy waves at a given point (or array of points).
+
+    Parameters
+    ----------
+    points: array of shape (3) or (N x 3)
+        coordinates of the points in which to evaluate the potential.
+    pb: DiffractionProblem
+        problem with the environmental conditions (g, rho, ...) of interest
+
+    Returns
+    -------
+    array of shape (1) or (N x 1)
+        The potential
+    """
+    points, output_shape = _normalize_points(points)
+
+    if float(pb.wavenumber) == 0.0 or float(pb.wavenumber) == np.inf:
+        return np.nan * np.ones(output_shape)
+
+    x, y, z = points.T
+    k = pb.wavenumber
+    h = pb.water_depth
+    beta = pb.encounter_wave_direction
+    wbar = x * np.cos(beta) + y * np.sin(beta)
+
+    if 0 <= k*h < 20:
+        cih = np.cosh(k*(z+h))/np.cosh(k*h)
+        # sih = np.sinh(k*(z+h))/np.cosh(k*h)
+    else:
+        cih = np.exp(k*z)
+        # sih = np.exp(k*z)
+
+    phi = -1j*pb.g/pb.omega * cih * np.exp(1j * k * wbar)
+    return phi.reshape(output_shape)
+
+
+def airy_waves_velocity(points, pb):
+    """Compute the fluid velocity for Airy waves at a given point (or array of points).
+
+    Parameters
+    ----------
+    points: array of shape (3) or (N x 3)
+        coordinates of the points in which to evaluate the potential.
+    pb: DiffractionProblem
+        problem with the environmental conditions (g, rho, ...) of interest
+
+    Returns
+    -------
+    array of shape (3) or (N x 3)
+        the velocity vectors
+    """
+    points, output_shape = _normalize_points(points)
+
+    if float(pb.wavenumber) == 0.0 or float(pb.wavenumber) == np.inf:
+        return np.nan * np.ones((*output_shape, 3))
+
+    x, y, z = points.T
+    k = pb.wavenumber
+    h = pb.water_depth
+    beta = pb.encounter_wave_direction
+
+    wbar = x * np.cos(beta) + y * np.sin(beta)
+
+    if 0 <= k*h < 20:
+        cih = np.cosh(k*(z+h))/np.cosh(k*h)
+        sih = np.sinh(k*(z+h))/np.cosh(k*h)
+    else:
+        cih = np.exp(k*z)
+        sih = np.exp(k*z)
+
+    v = pb.g*k/pb.omega * \
+        np.exp(1j * k * wbar) * \
+        np.array([np.cos(pb.wave_direction) * cih, np.sin(pb.wave_direction) * cih, -1j * sih])
+
+    return v.T.reshape((*output_shape, 3))
+
+
+def airy_waves_pressure(points, pb):
+    return 1j * float(pb.omega) * pb.rho * airy_waves_potential(points, pb)
+
+
+def froude_krylov_force(pb):
+    return pb.body.integrate_pressure(airy_waves_pressure(pb.body.mesh.faces_centers, pb))
+
+
+def airy_waves_free_surface_elevation(points, pb):
+    """Compute the free surface elevation at points of the undisturbed Airy waves
+
+    Parameters
+    ----------
+    points: array of shape (3) or (N × 3) or (2) or (N × 2)
+        coordinates of the points in which to evaluate the potential.
+        If only two coordinates are passed, the last one is filled with zeros.
+    pb: DiffractionProblem
+        problem with the environmental conditions (g, rho, ...) of interest
+
+    Returns
+    -------
+    complex-valued array of shape (1,) or (N,)
+        the free surface elevations
+    """
+    points, output_shape = _normalize_free_surface_points(points)
+    return 1j * pb.omega / pb.g * airy_waves_potential(points, pb).reshape(output_shape)

capytaine/bem/engines.py

@@ -0,0 +1,321 @@
+"""Definition of the methods to build influence matrices, using possibly some sparse structures."""
+# Copyright (C) 2017-2019 Matthieu Ancellin
+# See LICENSE file at <https://github.com/capytaine/capytaine>
+
+import logging
+from abc import ABC, abstractmethod
+from typing import Tuple, Union, Optional, Callable
+
+import numpy as np
+import scipy.sparse.linalg as ssl
+
+from capytaine.meshes.symmetric_meshes import ReflectionSymmetricMesh, RotationSymmetricMesh
+
+from capytaine.green_functions.abstract_green_function import AbstractGreenFunction
+from capytaine.green_functions.delhommeau import Delhommeau
+
+from capytaine.tools.block_circulant_matrices import (
+        BlockCirculantMatrix, lu_decompose, has_been_lu_decomposed,
+        MatrixLike, LUDecomposedMatrixLike
+        )
+
+LOG = logging.getLogger(__name__)
+
+
+####################
+#  ABSTRACT CLASS  #
+####################
+
+class MatrixEngine(ABC):
+    """Abstract method to build a matrix."""
+
+    @abstractmethod
+    def build_matrices(self, mesh1, mesh2, free_surface, water_depth, wavenumber, adjoint_double_layer):
+        pass
+
+    @abstractmethod
+    def build_S_matrix(self, mesh1, mesh2, free_surface, water_depth, wavenumber):
+        pass
+
+    @abstractmethod
+    def build_fullK_matrix(self, mesh1, mesh2, free_surface, water_depth, wavenumber):
+        pass
+
+
+##################
+#  BASIC ENGINE  #
+##################
+
+class Counter:
+    def __init__(self):
+        self.nb_iter = 0
+
+    def __call__(self, *args, **kwargs):
+        self.nb_iter += 1
+
+
+def solve_gmres(A, b):
+    LOG.debug(f"Solve with GMRES for {A}.")
+
+    if LOG.isEnabledFor(logging.INFO):
+        counter = Counter()
+        x, info = ssl.gmres(A, b, atol=1e-6, callback=counter)
+        LOG.info(f"End of GMRES after {counter.nb_iter} iterations.")
+
+    else:
+        x, info = ssl.gmres(A, b, atol=1e-6)
+
+    if info > 0:
+        raise RuntimeError(f"No convergence of the GMRES after {info} iterations.\n"
+                            "This can be due to overlapping panels or irregular frequencies.")
+
+    return x
+
+
+LUDecomposedMatrixOrNot = Union[MatrixLike, LUDecomposedMatrixLike]
+
+
+class BasicMatrixEngine(MatrixEngine):
+    """
+    Default matrix engine.
+
+    Features:
+        - Caching of the last computed matrices.
+        - Supports plane symmetries and nested plane symmetries.
+        - Linear solver can be customized. Default is `lu_decomposition` with caching of the LU decomposition.
+
+    Parameters
+    ----------
+    green_function: AbstractGreenFunction
+        the low level implementation used to compute the coefficients of the matrices.
+    linear_solver: str or function, optional
+        Setting of the numerical solver for linear problems Ax = b.
+        It can be set with the name of a preexisting solver
+        (available: "lu_decomposition", "lu_decompositon_with_overwrite" and "gmres", the former is the default choice)
+        or by passing directly a solver function.
+    """
+
+    green_function: AbstractGreenFunction
+    _linear_solver: Union[str, Callable]
+    last_computed_matrices: Optional[Tuple[MatrixLike, LUDecomposedMatrixOrNot]]
+
+    def __init__(self, *, green_function=None, linear_solver='lu_decomposition'):
+
+        self.green_function = Delhommeau() if green_function is None else green_function
+
+        self._linear_solver = linear_solver
+
+        self.last_computed_inputs = None
+        self.last_computed_matrices = None
+
+        self.exportable_settings = {
+            'engine': 'BasicMatrixEngine',
+            'linear_solver': str(linear_solver),
+            **self.green_function.exportable_settings,
+        }
+
+    def __str__(self):
+        params= [f"green_function={self.green_function}", f"linear_solver={repr(self._linear_solver)}"]
+        return f"BasicMatrixEngine({', '.join(params)})"
+
+    def __repr__(self):
+        return self.__str__()
+
+    def _repr_pretty_(self, p, cycle):
+        p.text(self.__str__())
+
+    def build_S_matrix(self, mesh1, mesh2, **gf_params) -> np.ndarray:
+        """Similar to :code:`build_matrices`, but returning only :math:`S`"""
+        # Calls directly evaluate instead of build_matrices because the caching
+        # mechanism of build_matrices is not compatible with giving mesh1 as a
+        # list of points, but we need that for post-processing
+        S, _ = self.green_function.evaluate(mesh1, mesh2, **gf_params)
+        return S
+
+    def build_fullK_matrix(self, mesh1, mesh2, **gf_params) -> np.ndarray:
+        """Similar to :code:`build_matrices`, but returning only full :math:`K`
+        (that is the three components of the gradient, not just the normal one)"""
+        # TODO: could use symmetries. In particular for forward, we compute the
+        # full velocity on the same mesh so symmetries could be used.
+        gf_params.setdefault("diagonal_term_in_double_layer", True)
+        gf_params.setdefault("adjoint_double_layer", True)
+        gf_params.setdefault("early_dot_product", False)
+        _, fullK = self.green_function.evaluate(mesh1, mesh2, **gf_params)
+        return fullK
+
+    def _build_matrices_with_symmetries(self, mesh1, mesh2, *, diagonal_term_in_double_layer=True, **gf_params) -> Tuple[MatrixLike, MatrixLike]:
+        if (isinstance(mesh1, ReflectionSymmetricMesh)
+                and isinstance(mesh2, ReflectionSymmetricMesh)
+                and mesh1.plane == mesh2.plane):
+
+            S_a, K_a = self._build_matrices_with_symmetries(mesh1.half, mesh2.half,
+                                                            diagonal_term_in_double_layer=diagonal_term_in_double_layer, **gf_params)
+            S_b, K_b = self._build_matrices_with_symmetries(mesh1.other_half, mesh2.half,
+                                                            diagonal_term_in_double_layer=False, **gf_params)
+
+            return BlockCirculantMatrix([S_a, S_b]), BlockCirculantMatrix([K_a, K_b])
+
+        elif (isinstance(mesh1, RotationSymmetricMesh)
+                and isinstance(mesh2, RotationSymmetricMesh)
+                and mesh1.n == mesh2.n):
+
+            S_cols, K_cols = self.green_function.evaluate(
+                    mesh1.merged(), mesh2.wedge,
+                    diagonal_term_in_double_layer=diagonal_term_in_double_layer,
+                    **gf_params,
+                    )
+            # Building the first column of blocks, that is the interactions of all of mesh1 with the reference wedge of mesh2.
+
+            n_blocks = mesh1.n # == mesh2.n
+            block_shape = (mesh2.wedge.nb_faces, mesh2.wedge.nb_faces)
+
+            return (
+                    BlockCirculantMatrix(S_cols.reshape((n_blocks, *block_shape))),
+                    BlockCirculantMatrix(K_cols.reshape((n_blocks, *block_shape))),
+                    )
+
+        else:
+            gf_params.setdefault("early_dot_product", True)
+            return self.green_function.evaluate(mesh1, mesh2, diagonal_term_in_double_layer=diagonal_term_in_double_layer, **gf_params)
+
+    def _build_and_cache_matrices_with_symmetries(
+            self, mesh1, mesh2, **gf_params
+            ) -> Tuple[MatrixLike, LUDecomposedMatrixOrNot]:
+        if (mesh1, mesh2, gf_params) == self.last_computed_inputs:
+            LOG.debug("%s: reading cache.", self.__class__.__name__)
+            return self.last_computed_matrices
+        else:
+            LOG.debug("%s: computing new matrices.", self.__class__.__name__)
+            self.last_computed_matrices = None  # Unlink former cached values, so the memory can be freed to compute new matrices.
+            S, K = self._build_matrices_with_symmetries(mesh1, mesh2, **gf_params)
+            self.last_computed_inputs = (mesh1, mesh2, gf_params)
+            self.last_computed_matrices = (S, K)
+            return self.last_computed_matrices
+
+    # Main interface for compliance with AbstractGreenFunction interface
+    def build_matrices(self, mesh1, mesh2, **gf_params):
+        r"""Build the influence matrices between mesh1 and mesh2.
+
+        Parameters
+        ----------
+        mesh1: MeshLike or list of points
+            mesh of the receiving body (where the potential is measured)
+        mesh2: MeshLike
+            mesh of the source body (over which the source distribution is integrated)
+        free_surface: float
+            position of the free surface (default: :math:`z = 0`)
+        water_depth: float
+            position of the sea bottom (default: :math:`z = -\infty`)
+        wavenumber: float
+            wavenumber (default: 1.0)
+        adjoint_double_layer: bool, optional
+            compute double layer for direct method (F) or adjoint double layer for indirect method (T) matrices (default: True)
+
+        Returns
+        -------
+        tuple of matrix-like (Numpy arrays or BlockCirculantMatrix)
+            the matrices :math:`S` and :math:`K`
+        """
+        return self._build_and_cache_matrices_with_symmetries(
+            mesh1, mesh2, **gf_params
+        )
+
+    def linear_solver(self, A: LUDecomposedMatrixOrNot, b: np.ndarray) -> np.ndarray:
+        """Solve a linear system with left-hand side A and right-hand-side b
+
+        Parameters
+        ----------
+        A: matrix-like
+            Expected to be the second output of `build_matrices`
+        b: np.ndarray
+            Vector of the correct length
+
+        Returns
+        -------
+        x: np.ndarray
+            Vector such that A@x = b
+        """
+        if not isinstance(self._linear_solver, str):
+            # If not a string, it is expected to be a custom function that can
+            # be called to solve the system
+            x = self._linear_solver(A, b)
+
+            if not x.shape == b.shape:
+                raise ValueError(f"Error in linear solver of {self}: the shape of the output ({x.shape}) "
+                                 f"does not match the expected shape ({b.shape})")
+
+            return x
+
+        elif self._linear_solver in ("lu_decomposition", "lu_decomposition_with_overwrite") :
+            overwrite_a = (self._linear_solver == "lu_decomposition_with_overwrite")
+            if not has_been_lu_decomposed(A):
+                luA = lu_decompose(A, overwrite_a=overwrite_a)
+                if A is self.last_computed_matrices[1]:
+                    # In normal operation of Capytaine, `A` is always the $D$
+                    # or $K$ matrix stored in the cache of the solver.
+                    # Here we replace the matrix by its LU decomposition in the
+                    # cache to avoid doing the decomposition again.
+                    self.last_computed_matrices = (self.last_computed_matrices[0], luA)
+            else:
+                luA: LUDecomposedMatrixLike = A
+            return luA.solve(b)
+
+        elif self._linear_solver == "gmres":
+            return solve_gmres(A, b)
+
+        else:
+            raise NotImplementedError(
+                f"Unknown `linear_solver` in BasicMatrixEngine: {self._linear_solver}"
+            )
+
+    def compute_ram_estimation(self, problem):
+        nb_faces = problem.body.mesh.nb_faces
+        nb_matrices = 2
+        nb_bytes = 16
+
+        if self._linear_solver == "lu_decomposition":
+            nb_matrices += 1
+
+        if self.green_function.floating_point_precision == "float32":
+            nb_bytes = 8
+
+        # In theory a simple symmetry is a gain of factor 1/2
+        # and a nested symmetry is a gain of factor 1/4.
+        # For the solvers that use LU decomposition the gain is a bit less.
+        solver_factors = {
+            # Formula to compute the factor of gain:
+            # (2 matrices * theoretical symmetry factor + LU decomposition + intermediate_step) / nb matrices without symmetry
+            "lu_decomposition": {
+                "simple": 2 / 3, # (2 * 1/2 + 1/2 + 1/2) / 3
+                "nested": 5 / 12,  # (2 * 1/4 + 1/4 + 1/2) / 3
+                "rotation": 4 / 3,
+            },
+            # Formula to compute the factor of gain:
+            # (2 matrices * theoretical symmetry factor + intermediate step) / nb matrices without symmetry
+            "lu_decomposition_with_overwrite": {
+                "simple": 3 / 4, # (2 * 1/2 + 1/2) / 2
+                "nested": 1 / 2, # (2 * 1/4 + 1/2) / 2
+                "rotation": 3 / 2,
+            },
+            "gmres": {
+                "simple": 1 / 2,
+                "nested": 1 / 4,
+                "rotation": 1,
+            },
+        }
+
+        if isinstance(problem.body.mesh, ReflectionSymmetricMesh):
+            if isinstance(problem.body.mesh.half, ReflectionSymmetricMesh):
+                # Should not go deeper than that, there is currently only two
+                # symmetries available
+                symmetry_type = "nested"
+            else:
+                symmetry_type = "simple"
+            symmetry_factor = solver_factors[self._linear_solver][symmetry_type]
+        elif isinstance(problem.body.mesh, RotationSymmetricMesh):
+            symmetry_factor = solver_factors[self._linear_solver]["rotation"] / problem.body.mesh.n
+        else:
+            symmetry_factor = 1.0
+
+        memory_peak = symmetry_factor * nb_faces**2 * nb_matrices * nb_bytes/1e9
+        return memory_peak