capytaine 2.3.1__cp39-cp39-macosx_14_0_arm64.whl → 3.0.0a1__cp39-cp39-macosx_14_0_arm64.whl

capytaine/tools/memory_monitor.py

@@ -0,0 +1,45 @@
+import logging
+import time
+from threading import Thread
+
+from capytaine.tools.optional_imports import silently_import_optional_dependency
+
+LOG = logging.getLogger(__name__)
+
+class MemoryMonitor(Thread):
+    """Monitor the memory usage in a separate thread.
+    from : https://joblib.readthedocs.io/en/stable/auto_examples/parallel_generator.html#sphx-glr-auto-examples-parallel-generator-py
+    """
+
+    def __init__(self):
+        super().__init__()
+        self.stop = False
+        self.memory_buffer = [0]
+        self.psutil = silently_import_optional_dependency("psutil")
+        self.start()
+
+    def get_memory(self):
+        "Get memory of a process and its children."
+        p = self.psutil.Process()
+        memory = p.memory_info().rss
+        for c in p.children():
+            try:
+                memory += c.memory_info().rss
+            except self.psutil.NoSuchProcess:
+                pass
+        return memory
+
+    def run(self):
+        if self.psutil is not None:
+            memory_start = self.get_memory()
+            while not self.stop:
+                self.memory_buffer.append(self.get_memory() - memory_start)
+                time.sleep(0.2)
+
+    def get_memory_peak(self):
+        self.stop = True 
+        super().join()
+        if self.psutil is None:
+            return None
+        else:
+            return round(max(self.memory_buffer) / 1e9, 2)

capytaine/tools/symbolic_multiplication.py

@@ -24,11 +24,23 @@ class SymbolicMultiplication:
     __array_priority__ = 1.0
 
     def __array_function__(self, func, types, *args, **kwargs):
-        if func in {np.real, np.imag, np.sum}:
+        actual_args = args[0]  # args = (actual_args, kwargs) for some reason
+        if func in {np.real, np.imag, np.sum} and len(actual_args) == 1 and len(kwargs) == 0:
             return SymbolicMultiplication(self.symbol, func(self.value))
+        elif (
+                func in {np.einsum} and
+                len([a for a in actual_args if isinstance(a, SymbolicMultiplication)]) == 1 and
+                "out" not in kwargs
+                ):
+            # Einsum with one of the array being wrapped in SymbolicMultiplication
+            unwrapped = [a.value if isinstance(a, SymbolicMultiplication) else a for a in actual_args]
+            return SymbolicMultiplication(self.symbol, func(*unwrapped, **kwargs))
         else:
             return NotImplemented
 
+    def astype(self, proper_type):
+        return SymbolicMultiplication(self.symbol, proper_type(self.value))
+
     def __str__(self):
         return f"{self.symbol}×{self.value}"
 

capytaine/tools/timer.py

@@ -2,21 +2,37 @@
 
 from functools import wraps
 import time
+import contextlib
+
+import pandas as pd
 
 class Timer:
-    """A simple timer class that can be used as context manager or as decorator using `wraps_function` method
+    """A timer class that can be used as context manager or as decorator using `wraps_function` method.
+    Several timing measurement can be nested.
+
+    Attributes
+    ----------
+    timings: List[Dict]]
+        List of records of each timing measurement.
+        The record is a dict with a 'timing' key and any number of other metadata keys.
+    default_tags: Optional[Dict]
+        Tags added to all the timing measurements.
+    _start_times: List[float]
+        Start times of the ongoing timing measurements.
 
     Example
     -------
     ::
+        from time import sleep  # For testing
 
         timer = Timer()
-        with timer:
+
+        with timer(tag="run 1"):
             sleep(1.0)
 
         print(timer.total)  # 1.0...
 
-        @timer.wraps_function
+        @timer.wraps_function(tag="run function")
         def my_function():
             sleep(0.5)
 
@@ -25,42 +41,50 @@ class Timer:
         my_function()
         print(timer.total)  # 2.0...
 
-        print(timer.timings)  # [1.0, 0.5, 0.5]
+        with timer(tag="outer"):
+            sleep(0.3)
+            with timer(tag="inner"):
+                sleep(0.3)
+            sleep(0.3)
     """
-
-    def __init__(self, timings=None):
-        if timings is None:
-            self.timings = []
-        else:
-            self.timings = timings
+    def __init__(self, *, default_tags=None):
+        self.timings = []
+        if default_tags is None:
+            default_tags = {}
+        self.default_tags = default_tags
+        self._start_times = []  # Starting time of ongoing sub-timers
 
     def __repr__(self):
         return f"Timer({self.timings})"
 
-    @property
-    def nb_timings(self):
-        return len(self.timings)
+    def add_data_from_other_timer(self, other, **supplementary_tags):
+        self.timings.extend([{**t, **supplementary_tags} for t in other.timings])
+
+    @contextlib.contextmanager
+    def __call__(self, **tags):
+        self._start_times.append(time.perf_counter())
+        try:
+            yield
+        finally:
+            timing = time.perf_counter() - self._start_times.pop()
+            self.timings.append({'timing': timing, **tags, **self.default_tags})
+
+    def wraps_function(self, **tags):
+        def wrapper(f):
+            @wraps(f)
+            def wrapped_f(*args, **kwargs):
+                with self(**tags):
+                    out = f(*args, **kwargs)
+                return out
+            return wrapped_f
+        return wrapper
+
+    def as_dataframe(self):
+        if len(self.timings) == 0:
+            return pd.DataFrame([{'timing': 0.0}])
+        else:
+            return pd.DataFrame(self.timings)
 
     @property
     def total(self):
-        return sum(self.timings)
-
-    @property
-    def mean(self):
-        if self.nb_timings == 0:
-            return float('nan')
-        else:
-            return self.total/self.nb_timings
-
-    def __enter__(self):
-        self.start_time = time.perf_counter()
-
-    def __exit__(self, *exc):
-        self.timings.append(time.perf_counter() - self.start_time)
-
-    def wraps_function(self, f):
-        @wraps(f)
-        def wrapped_f(*args, **kwargs):
-            with self:
-                return f(*args, **kwargs)
-        return wrapped_f
+        return self.as_dataframe()['timing'].sum()

{capytaine-2.3.1.dist-info → capytaine-3.0.0a1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: capytaine
-Version: 2.3.1
+Version: 3.0.0a1
 Summary: Python BEM solver for linear potential flow, based on Nemoh
 Author-Email: Matthieu Ancellin <matthieu.ancellin@mews-labs.com>
 License:                     GNU GENERAL PUBLIC LICENSE
@@ -694,10 +694,15 @@ Requires-Dist: xarray
 Requires-Dist: rich
 Provides-Extra: optional
 Requires-Dist: matplotlib; extra == "optional"
+Requires-Dist: vtk; extra == "optional"
+Requires-Dist: pyvista; extra == "optional"
+Requires-Dist: psutil; extra == "optional"
 Requires-Dist: joblib>=1.3; extra == "optional"
+Requires-Dist: threadpoolctl; extra == "optional"
 Requires-Dist: meshio; extra == "optional"
+Requires-Dist: trimesh; extra == "optional"
+Requires-Dist: h5py; extra == "optional"
 Requires-Dist: netcdf4; extra == "optional"
-Requires-Dist: vtk; extra == "optional"
 Description-Content-Type: text/markdown
 
 # Capytaine: a linear potential flow BEM solver with Python.

capytaine-3.0.0a1.dist-info/RECORD

@@ -0,0 +1,65 @@
+capytaine/__init__.py,sha256=fdEfZXF2pwTyT-VFiscWbiF_6fGpzyr5_o4P7tYasaY,1388
+capytaine/__about__.py,sha256=bgxawhvlGsp8EpxmhlJ_ywUs9FSVl623qCo2GQAgj58,510
+capytaine/ui/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+capytaine/ui/rich.py,sha256=ZfMHUpCSVztNseIGpN2I69ts_Aw_HJ5RnZc0f73av5Q,233
+capytaine/ui/cli.py,sha256=o3MH2OCHXFww1kb2zM9R3qs4jjfkCeeZFRAgnFnb2NE,797
+capytaine/green_functions/Delhommeau_float64.cpython-39-darwin.so,sha256=8lkMXn3N8RZc5-QRy_Ho9QNpKYbZ0QrSzOa3igCoBms,399344
+capytaine/green_functions/Delhommeau_float32.cpython-39-darwin.so,sha256=3tzBQy8zseRE6bT4IqKgMDB_7udLDrvqFU8SXCaXLg8,346288
+capytaine/green_functions/__init__.py,sha256=527Pd0SIqwR64-d4sT-_jyE89XU-PLgFL0et96ChAIo,107
+capytaine/green_functions/delhommeau.py,sha256=tAwJSFIlUh4Lxb3x2xRCJb496KTlTeOe00p3HY8q-kQ,24284
+capytaine/green_functions/hams.py,sha256=HApi_OGay2cVt1nJxtZ849eEEsz4tK9ktxNNj2hrWo8,8267
+capytaine/green_functions/abstract_green_function.py,sha256=gHwhzVB2KyDpjy5LTb80Hb2FOBmoKtpmPHCcMBlsEk4,2839
+capytaine/bodies/dofs.py,sha256=WFT4snSkUFxxrdHsfxGAj5wc6aLWbqz8gLblhIlRWX8,5227
+capytaine/bodies/bodies.py,sha256=aH3PDEN-ywFo2P8r4oh2zx7mOPRJcIUm8HihdQh1dV0,26102
+capytaine/bodies/__init__.py,sha256=wIYFs14NAWqaHLQWvDGUEZTBWp_kdthKkbOlXHup6LA,157
+capytaine/bodies/hydrostatics.py,sha256=9SUz-xqsizAMAciJhUn7ZT_tg78VZ-4PMNqXTKydgTk,26419
+capytaine/bodies/multibodies.py,sha256=y6np-DpueJLu78ViOBApDWV5NTu86v8koTgI2OA9bb8,7880
+capytaine/tools/cache_on_disk.py,sha256=Cj2J5pNKw9PbIvxUn53swSmuGJoMibZzIvB5Skt52ig,912
+capytaine/tools/timer.py,sha256=2157o0Wm02GW5xHlTJR15gVgtGaGSIzOwR0FcMxmX5M,2602
+capytaine/tools/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+capytaine/tools/deprecation_handling.py,sha256=_QFNrkreLerm3-LzRZ3l6B_O249PM-fCCAXMsHA7kIU,809
+capytaine/tools/block_circulant_matrices.py,sha256=2fRGtrWNTPtod02xt532p-VKZPJ5vsNa4R0cx0DQvc8,10977
+capytaine/tools/optional_imports.py,sha256=HNjtvNZGxsw-eYmr4ejq001KhLevrvqq7ASAqTOw8W8,860
+capytaine/tools/symbolic_multiplication.py,sha256=d0Ll0HOo8q_cPMt--ZBXQ5TZ4-Tw_VHmjoWz6Wy7r2E,5554
+capytaine/tools/memory_monitor.py,sha256=UNG-yOCXqvCKK2fXbUj9rvVPHQnZk62R1b2EaHMC4YA,1427
+capytaine/tools/lists_of_points.py,sha256=_yaQbBxWw5n61DoqndV21Q35kJhJK7sstc6Hcs_fXeA,1833
+capytaine/tools/prony_decomposition.py,sha256=Eg8CcedPuLKVUA-wpjwXBJsnXjBGZruHVy4jMU2cCSM,5147
+capytaine/bem/solver.py,sha256=z2P7asqt4UruV0LWe61a98f64btqXf1JyhY3xN9Efs4,35121
+capytaine/bem/engines.py,sha256=G_CgTXe4fjrLiS0SiOdg6Ek0MkMUlMR6p1jy8mZW6RM,13125
+capytaine/bem/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+capytaine/bem/problems_and_results.py,sha256=ryv4TDfGna1svW1QiYLnxSD281Ispto4IYIPtCJmIoY,27260
+capytaine/bem/airy_waves.py,sha256=GAhX5xNEgjoOo2uEHXfKCxb2TnmbPBCqW6VWfvzJTM8,3498
+capytaine/io/wamit.py,sha256=dvmthwIZnzOM8L1kq814pilCpQPLeTHvjjgg21hV2po,16028
+capytaine/io/legacy.py,sha256=xWPznKSooZof9FOLLoogDu1ouvGgisx1TixdYazCEWY,10339
+capytaine/io/bemio.py,sha256=WXT7QPJK0t2kgUdI0DOOQG8u5zh_zk9q_PmTXqW1dJE,7334
+capytaine/io/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+capytaine/io/xarray.py,sha256=tbWUoqub56uddHfo0Nv1T6YcymipCo9m74PKgMsM3pY,27343
+capytaine/.dylibs/libgfortran.5.dylib,sha256=6uNZS_KEqHsXxVzZp8qANpYBaOKVUp4PapKX4P8wvhE,1901520
+capytaine/.dylibs/libquadmath.0.dylib,sha256=AtjHD7yn1DtR6T2PA-Ry7z9iJFiYF9eZ4dfkBVTFa6k,363936
+capytaine/.dylibs/libgcc_s.1.1.dylib,sha256=a2klIEBZo0Ns9hxZzfO7_Aur4CtbIedHBYCDc5gRMbg,183040
+capytaine/meshes/clean.py,sha256=xpbCiyEBxziCjEBaUN_izIkLinVGywGnwPT5rrggvF4,9824
+capytaine/meshes/surface_integrals.py,sha256=JqQEIOz9fkMHEOHLva02zwvbS_Ed0q7qzDaVYUCG9wQ,3123
+capytaine/meshes/io.py,sha256=xUU2WV00gcLduoP5db3eOGKgigh0OKdZY5-NGZfjxZg,17093
+capytaine/meshes/abstract_meshes.py,sha256=kQE8phEGs92_HRPOEQiYcBkv8c2ECG06CVLPS_5gyd8,13050
+capytaine/meshes/__init__.py,sha256=5K_nx-RnEGG2NO6o0HEO1YZ-eTFHQl0EL0sqF5UUSCM,102
+capytaine/meshes/export.py,sha256=d3UFsMq0cvM2SIu537aii2kZkQn8GGxIRGO4pVvi2pg,2711
+capytaine/meshes/visualization.py,sha256=HgTxmmar6owCp56eSMTC81pJmS8IwwN_sQE9S7haZbc,12384
+capytaine/meshes/meshes.py,sha256=OPFa8d7QmQBmnn17nxjI7eoHfqhH2sgotv9aul-nleY,29805
+capytaine/meshes/geometry.py,sha256=7rnVK87TFL8KrQ7fYfwaYQb6t2ME1beFG-Mb-HQjJjs,8833
+capytaine/meshes/clip.py,sha256=QM3qWCBDAMacOywx5WugHM9aRYRXr7kNdtVxaw_FDw8,10729
+capytaine/meshes/quality.py,sha256=D5EtbtBFiLccEeO89tfjBl17uipOeffOPoubQ4ZH5_4,4870
+capytaine/meshes/symmetric_meshes.py,sha256=APRMDAZOHg-mNGLVSxpy7kyaeZJt1h2zfqwTOys2E_Y,24732
+capytaine/meshes/predefined/rectangles.py,sha256=cjq_lOP43udVxxtvYGmMNuyHZChQlh_gZi9_Y6RMWh0,9471
+capytaine/meshes/predefined/spheres.py,sha256=HgZpWV__gA5P5yCjCPpF7OdtW_FE7v5hjRwQHdhD_-g,1939
+capytaine/meshes/predefined/__init__.py,sha256=uc2b-3UJi_4NnTkk6wRlbq5UTKOyRU7JTpMDdlUrjiY,365
+capytaine/meshes/predefined/cylinders.py,sha256=ETG3P_44YFQucrsKGmLoSScvi3FQ3OXBF16QUYg39Og,13412
+capytaine/post_pro/rao.py,sha256=kLePr2sbh38f-ydjQTIyeRuoDDqEootqwLSt575aGik,2293
+capytaine/post_pro/free_surfaces.py,sha256=pNf3uBMJ7snD9I0dWRqZmLSVoPcH0vEc3jbwwL2kCOA,3016
+capytaine/post_pro/__init__.py,sha256=fi9BE68OzphGjf08HYGcCPmZLJYnD-wHjz86QEXkBn8,274
+capytaine/post_pro/kochin.py,sha256=8Dmc7Xt0qTPRzXjzZYfMywVdPa_eSRQxfrKEmDZhSpI,2067
+capytaine/post_pro/impedance.py,sha256=gNMKkSyD4qN55_PrTZhrtsh2XsAbC3ciFCWtvpJLKLM,3492
+capytaine-3.0.0a1.dist-info/RECORD,,
+capytaine-3.0.0a1.dist-info/LICENSE,sha256=jOtLnuWt7d5Hsx6XXB2QxzrSe2sWWh3NgMfFRetluQM,35147
+capytaine-3.0.0a1.dist-info/WHEEL,sha256=QNpUOVkwcjwY22mJ1yDEo3_scKAYwaSfG2-jzE22pPE,120
+capytaine-3.0.0a1.dist-info/entry_points.txt,sha256=R72-je8lc6ELm8ftt7lJ7f1aalnQs5BWYrGDBMexHII,53
+capytaine-3.0.0a1.dist-info/METADATA,sha256=4YdZOR22xCmwIHWLYxDSR21K5JLNhiUGdOCEsDYI-NI,45296

capytaine/bodies/predefined/__init__.py

@@ -1,6 +0,0 @@
-# Copyright (C) 2017-2019 Matthieu Ancellin
-# See LICENSE file at <https://github.com/mancellin/capytaine>
-
-from capytaine.bodies.predefined.spheres import Sphere
-from capytaine.bodies.predefined.cylinders import HorizontalCylinder, VerticalCylinder
-from capytaine.bodies.predefined.rectangles import Rectangle, RectangularParallelepiped

capytaine/bodies/predefined/cylinders.py

@@ -1,151 +0,0 @@
-"""Legacy interfaces to predefined meshes"""
-# Copyright (C) 2017-2022 Matthieu Ancellin
-# See LICENSE file at <https://github.com/capytaine/capytaine>
-
-import logging
-import numpy as np
-
-from capytaine.meshes.predefined import mesh_disk, mesh_vertical_cylinder, mesh_horizontal_cylinder
-from capytaine.meshes.meshes import Mesh
-from capytaine.bodies.bodies import FloatingBody
-
-LOG = logging.getLogger(__name__)
-
-
-##########
-#  Disk  #
-##########
-
-class Disk(FloatingBody):
-    """(One-sided) disk.
-    Deprecated: please prefer capytaine.meshes.predefined.mesh_disk()
-
-    Parameters
-    ----------
-    radius : float, optional
-        radius of the disk
-    resolution : 2-ple of int, optional
-        number of panels along a radius and around the disk
-    center : 3-ple or array of shape (3,), optional
-        position of the geometric center of the disk
-    normal: 3-ple of floats, optional
-        normal vector, default: along x axis
-    axial_symmetry : bool, optional
-        if True, use the axial symmetry to speed up the computations
-    reflection_symmetry : bool, optional
-        if True, use the reflection symmetry to speed up the computations
-    name : str, optional
-        a string naming the floating body
-    """
-
-    def __init__(self, radius=1.0, resolution=(3, 5),
-                 center=(0, 0, 0), normal=(1, 0, 0),
-                 reflection_symmetry=False, axial_symmetry=False,
-                 name=None):
-        LOG.warning("Deprecation warning: The class Disk() is deprecated. "
-                "Please prefer the function capytaine.meshes.predefined.mesh_disk()")
-
-        if name is None:
-            name = f"disk_{next(Mesh._ids)}"
-
-        self.radius = float(radius)
-        self.geometric_center = np.asarray(center, dtype=float)
-        mesh = mesh_disk(radius=radius, center=center, normal=normal, resolution=resolution,
-                reflection_symmetry=reflection_symmetry, axial_symmetry=axial_symmetry, name=f"{name}_mesh")
-        FloatingBody.__init__(self, mesh=mesh, name=name)
-
-
-##############
-#  Cylinder  #
-##############
-
-class HorizontalCylinder(FloatingBody):
-    """Horizontal cylinder
-    Deprecated: please prefer capytaine.meshes.predefined.mesh_horizontal_cylinder()
-
-    Parameters
-    ----------
-    length : float, optional
-        length of the cylinder
-    radius : float, optional
-        radius of the cylinder
-    center : 3-ple or array of shape (3,), optional
-        position of the geometric center of the cylinder
-    nx : int, optional
-        number of circular slices
-    ntheta : int, optional
-        number of panels along a circular slice of the cylinder
-    nr : int, optional
-        number of panels along a radius on the extremities of the cylinder
-    reflection_symmetry : bool, optional
-        if True, returns a ReflectionSymmetricMesh
-    translation_symmetry : bool, optional
-        if True, uses a TranslationalSymmetricMesh internally for the main part of the cylinder
-    name : str, optional
-        a string naming the floating body
-    """
-
-    def __init__(self, length=10.0, radius=1.0, center=(0, 0, 0),
-                 nx=10, ntheta=10, nr=2,
-                 reflection_symmetry=True, translation_symmetry=False,
-                 clever=None,
-                 name=None):
-
-        LOG.warning("Deprecation warning: The class HorizontalCylinder() is deprecated. "
-                "Please prefer the function capytaine.meshes.predefined.mesh_horizontal_cylinder()")
-
-        self.length = length
-        self.radius = radius
-        self.geometric_center = np.asarray(center, dtype=float)
-
-        if name is None:
-            name = f"cylinder_{next(Mesh._ids)}"
-
-        mesh = mesh_horizontal_cylinder(length=length, radius=radius, center=center,
-                resolution=(nr, ntheta, nx), reflection_symmetry=reflection_symmetry,
-                translation_symmetry=translation_symmetry, name=f"{name}_mesh")
-        FloatingBody.__init__(self, mesh=mesh, name=name)
-
-
-class VerticalCylinder(FloatingBody):
-    """Vertical cylinder.
-    Deprecated: please prefer capytaine.meshes.predefined.mesh_vertical_cylinder()
-
-    Parameters
-    ----------
-    length : float, optional
-        length of the cylinder
-    radius : float, optional
-        radius of the cylinder
-    center : 3-ple or array of shape (3,), optional
-        position of the geometric center of the cylinder
-    nx : int, optional
-        number of circular slices
-    ntheta : int, optional
-        number of panels along a circular slice of the cylinder
-    nr : int, optional
-        number of panels along a radius on the extremities of the cylinder
-    clever : bool, optional
-        if True, uses the mesh symmetries
-    name : str, optional
-        a string naming the floating body
-    """
-
-    def __init__(self, length=10.0, radius=1.0, center=(0, 0, 0),
-                 nx=10, ntheta=10, nr=2,
-                 clever=True, name=None):
-        LOG.warning("Deprecation warning: The class VerticalCylinder() is deprecated. "
-                "Please prefer the function capytaine.meshes.predefined.mesh_vertical_cylinder()")
-
-        self.length = length
-        self.radius = radius
-        self.geometric_center = np.asarray(center, dtype=float)
-
-        if name is None:
-            name = f"cylinder_{next(Mesh._ids)}"
-
-        mesh = mesh_vertical_cylinder(length=length, radius=radius, center=center,
-                resolution=(nr, ntheta, nx), reflection_symmetry=False,
-                axial_symmetry=clever, name=f"{name}_mesh")
-
-        FloatingBody.__init__(self, mesh=mesh, name=name)

capytaine/bodies/predefined/rectangles.py

@@ -1,111 +0,0 @@
-"""Legacy interfaces to predefined meshes"""
-# Copyright (C) 2017-2022 Matthieu Ancellin
-# See LICENSE file at <https://github.com/capytaine/capytaine>
-
-import logging
-import numpy as np
-
-from capytaine.meshes.predefined import mesh_rectangle, mesh_parallelepiped
-from capytaine.meshes.meshes import Mesh
-from capytaine.bodies.bodies import FloatingBody
-
-LOG = logging.getLogger(__name__)
-
-
-class Rectangle(FloatingBody):
-    """One-sided vertical rectangle (along y and z).
-
-    By default, the normals are oriented in the positive y direction.
-
-    Parameters
-    ----------
-    size : couple of floats, optional
-        dimensions of the rectangle (width and height)
-    resolution : couple of ints, optional
-        number of faces along each of the two directions
-    center : 3-ple of floats, optional
-        position of the geometric center of the rectangle, default: (0, 0, 0)
-    normal: 3-ple of floats, optional
-        normal vector, default: along x axis
-    translational_symmetry : bool, optional
-        if True, use the translation symmetry to speed up the computations
-    reflection_symmetry : bool, optional
-        if True, use the reflection symmetry to speed up the computations
-    name : string, optional
-        a name for the body
-    """
-
-    def __init__(self, size=(5.0, 5.0), resolution=(5, 5),
-                 center=(0, 0, 0), normal=(1, 0, 0),
-                 translational_symmetry=False, reflection_symmetry=False, name=None):
-
-        LOG.warning("Deprecation warning: The class Rectangle() is deprecated. "
-                    "Please prefer the function capytaine.meshes.predefined.mesh_rectangle()")
-
-        self.size = np.asarray(size, dtype=float)
-        self.geometric_center = np.asarray(center, dtype=float)
-
-        if name is None:
-            name = f"rectangle_{next(Mesh._ids)}"
-
-        mesh = mesh_rectangle(size=size, resolution=resolution, center=center, normal=normal,
-                translation_symmetry=translational_symmetry, reflection_symmetry=reflection_symmetry,
-                name=f"{name}_mesh")
-        FloatingBody.__init__(self, mesh=mesh, name=name)
-
-
-class RectangularParallelepiped(FloatingBody):
-    """Six rectangles forming a parallelepiped.
-
-    Parameters
-    ----------
-    size : 3-ple of floats, optional
-        dimensions of the parallelepiped (width, thickness, height) for coordinates (x, y, z).
-    resolution : 3-ple of ints, optional
-        number of faces along the three directions
-    center : 3-ple of floats, optional
-        coordinates of the geometric center of the parallelepiped
-    top: bool, optional
-        whether or not to close the parallelepiped on the top
-    bottom: bool, optional
-        whether or not to close the parallelepiped on the bottom
-    reflection_symmetry : bool, optional
-        use xOz and yOz symmetry plane to generate the mesh
-    translational_symmetry : bool, optional
-        if True, use the translation symmetry in the x direction to speed up the computations.
-        To use the translation symmetry in the y direction, create a x-symmetric body and then rotate it by pi/2.
-    name : string, optional
-        a name for the body
-    """
-
-    def __init__(self,
-                 size=(1.0, 1.0, 1.0), resolution=(4, 4, 4),
-                 center=(0, 0, 0),
-                 top=True, bottom=True,
-                 reflection_symmetry=False,
-                 translational_symmetry=False,
-                 name=None):
-
-        LOG.warning("Deprecation warning: The class RectangularParallelepiped() is deprecated. "
-                    "Please prefer the function capytaine.meshes.predefined.mesh_parallelepiped()")
-
-        if name is None:
-            name = f"rectangular_parallelepiped_{next(Mesh._ids)}"
-
-        missing_sides = set()
-        if not top: missing_sides.add("top")
-        if not bottom: missing_sides.add("bottom")
-
-        mesh = mesh_parallelepiped(size=size, resolution=resolution, center=center,
-                missing_sides=missing_sides,
-                translation_symmetry=translational_symmetry, reflection_symmetry=reflection_symmetry,
-                name=f"{name}_mesh")
-
-        self.geometric_center = np.asarray(center, dtype=float)
-
-        FloatingBody.__init__(self, mesh=mesh, name=name)
-
-class OpenRectangularParallelepiped(RectangularParallelepiped):
-    def __init__(self, *args, **kwargs):
-        RectangularParallelepiped.__init__(self, top=False, bottom=False, *args, **kwargs)
-        # Kept mostly for legacy

capytaine/bodies/predefined/spheres.py

@@ -1,70 +0,0 @@
-"""Generate spherical bodies."""
-# Copyright (C) 2017-2022 Matthieu Ancellin
-# See LICENSE file at <https://github.com/capytaine/capytaine>
-
-import logging
-
-import numpy as np
-
-from capytaine.meshes import Mesh
-from capytaine.meshes.predefined import mesh_sphere
-from capytaine.bodies.bodies import FloatingBody
-
-LOG = logging.getLogger(__name__)
-
-
-class Sphere(FloatingBody):
-    """Sphere
-    Deprecated: please prefer capytaine.meshes.predefined.mesh_sphere()
-
-    Parameters
-    ----------
-    radius : float
-        radius of the sphere
-    center : 3-ple or array of shape (3,)
-        position of the geometric center of the sphere
-    ntheta : int
-        number of panels along a meridian (or number of parallels-1)
-    nphi : int
-        number of panels along a parallel (or number of meridians-1)
-    axial_symmetry : bool
-        if True, use the axial symmetry to build the mesh (default: True)
-    clip_free_surface : bool
-        if True, only mesh the part of the sphere where z < 0 (default: False),
-        can be used with center to obtain any clipped sphere,
-        if True, then ntheta is the number of parallel below the free surface.
-    name : string
-        a name identifying the sphere (default: "sphere_id" where id is an unique integer).
-    """
-
-    def __init__(self, *, radius=1.0, center=(0, 0, 0),
-                 ntheta=10, nphi=10, clip_free_surface=False,
-                 axial_symmetry=True, clever=None,
-                 name=None):
-
-        LOG.warning("Deprecation warning: The class Sphere() is deprecated. "
-                "Please prefer the function capytaine.meshes.predefined.mesh_sphere()")
-
-        if clever is not None:
-            LOG.warning("Deprecation warning: `clever` argument for Sphere is deprecated. "
-                        "Use `axial_symmetry` instead.")
-
-        if name is None:
-            name = f"sphere_{next(Mesh._ids)}"
-
-        if clip_free_surface:
-            if center[2] < -radius:  # fully immersed
-                pass
-            elif center[2] < radius:
-                ntheta = int(ntheta*np.pi/np.arccos(center[2]/radius))
-            else:
-                raise ValueError("Impossible to mesh the immersed hull of a sphere completely out of the water")
-
-        mesh = mesh_sphere(radius=radius, center=center, resolution=(ntheta, nphi), axial_symmetry=axial_symmetry, name=f"{name}_mesh")
-
-        if clip_free_surface:
-            mesh.keep_immersed_part()
-
-        self.radius = radius
-        self.geometric_center = np.array(center, dtype=float)
-        FloatingBody.__init__(self, mesh=mesh, name=name)

capytaine/green_functions/FinGreen3D/.gitignore

@@ -1 +0,0 @@
-build/