pytetwild 0.1.dev0__cp310-cp310-win_amd64.whl → 0.1.dev1__cp310-cp310-win_amd64.whl

pytetwild/__init__.py

@@ -2,15 +2,15 @@
 
 
 # start delvewheel patch
-def _delvewheel_patch_1_5_2():
+def _delvewheel_patch_1_5_4():
     import os
     libs_dir = os.path.abspath(os.path.join(os.path.dirname(__file__), os.pardir, 'pytetwild.libs'))
     if os.path.isdir(libs_dir):
         os.add_dll_directory(libs_dir)
 
 
-_delvewheel_patch_1_5_2()
-del _delvewheel_patch_1_5_2
+_delvewheel_patch_1_5_4()
+del _delvewheel_patch_1_5_4
 # end delvewheel patch
 
 from ._version import __version__  # noqa: F401

pytetwild/py.typed

@@ -0,0 +1 @@
+partial

pytetwild/pytetwild.py

@@ -1,14 +1,32 @@
 """Wrapper for fTetWild."""
 import warnings
 import numpy as np
-from pytetwild import PyfTetWildWrapper
+from pytetwild import PyfTetWildWrapper  # type: ignore
 from typing import Tuple, TYPE_CHECKING
+import numpy.typing as npt
 
 if TYPE_CHECKING:
     import pyvista as pv
 
 
-def tetrahedralize_pv(mesh: "pv.PolyData") -> "pv.UnstructuredGrid":
+def _check_edge_length(edge_length_fac: float) -> None:
+    """Check edge length.
+
+    Parameters
+    ----------
+    edge_length_fac : float, default: 0.05
+        Tetrahedral edge length as a function of bounding box diagional. The
+        default ideal edge length is bb/20 (bounding box divided by 20).
+
+
+    """
+    if edge_length_fac > 1.0 or edge_length_fac < 0.0 + 1e-16:
+        raise ValueError("Edge length factor must be between 1e-16 and 1.0")
+
+
+def tetrahedralize_pv(
+    mesh: "pv.PolyData", edge_length_fac: float = 0.05, optimize: bool = True
+) -> "pv.UnstructuredGrid":
     """
     Convert a PyVista surface mesh to a PyVista unstructured grid.
 
@@ -16,11 +34,33 @@ def tetrahedralize_pv(mesh: "pv.PolyData") -> "pv.UnstructuredGrid":
     ----------
     mesh : pv.PolyData
         The input surface mesh.
+    edge_length_fac : float, default: 0.05
+        Tetrahedral edge length as a function of bounding box diagional. The
+        default ideal edge length is bb/20 (bounding box divided by 20).
+    optimize : bool
+        Improve the minimum scaled Jacobean for each cell. This leads to higher
+        cell quality at the expense of computation time.
 
     Returns
     -------
     pv.UnstructuredGrid
-        The converted unstructured grid.
+        The converted unstructured grid containing only tetrahedra.
+
+    Examples
+    --------
+    >>> import pyvista as pv
+    >>> import pytetwild
+    >>> surface_mesh = pv.Sphere()
+    >>> tetrahedral_mesh = pytetwild.tetrahedralize_pv(surface_mesh)
+    >>> tetrahedral_mesh
+    UnstructuredGrid (0x7ff568593d00)
+      N Cells:    7247
+      N Points:   1658
+      X Bounds:   -4.993e-01, 4.993e-01
+      Y Bounds:   -4.965e-01, 4.965e-01
+      Z Bounds:   -5.000e-01, 4.999e-01
+      N Arrays:   0
+
     """
     try:
         import pyvista as pv
@@ -29,6 +69,9 @@ def tetrahedralize_pv(mesh: "pv.PolyData") -> "pv.UnstructuredGrid":
             "Install PyVista to use this feature with:\n\n" "pip install pytetwild[all]"
         )
 
+    if not isinstance(mesh, pv.PolyData):
+        raise TypeError(f"`mesh` must be a pyvista.PolyData, got {type(mesh)}")
+
     if not mesh.is_all_triangles:
         warnings.warn(
             "Input mesh is not all triangles. Either call `.triangulate()`"
@@ -36,13 +79,14 @@ def tetrahedralize_pv(mesh: "pv.PolyData") -> "pv.UnstructuredGrid":
         )
         mesh = mesh.triangulate()
 
-    vertices = np.array(mesh.points, dtype=np.float64)
-    faces = np.array(mesh.faces.reshape((-1, 4))[:, 1:4], dtype=np.int32)
+    _check_edge_length(edge_length_fac)
+    vertices = mesh.points.astype(np.float64, copy=False)
+    faces = mesh.faces.reshape((-1, 4))[:, 1:4].astype(np.float32, copy=False)
 
     (
         tetrahedral_mesh_vertices,
         tetrahedral_mesh_tetrahedra,
-    ) = PyfTetWildWrapper.tetrahedralize_mesh(vertices, faces)
+    ) = PyfTetWildWrapper.tetrahedralize_mesh(vertices, faces, optimize, edge_length_fac)
 
     cells = np.hstack(
         [
@@ -55,7 +99,12 @@ def tetrahedralize_pv(mesh: "pv.PolyData") -> "pv.UnstructuredGrid":
     return pv.UnstructuredGrid(cells, cell_types, tetrahedral_mesh_vertices)
 
 
-def tetrahedralize(vertices: np.ndarray, faces: np.ndarray) -> Tuple[np.ndarray, np.ndarray]:
+def tetrahedralize(
+    vertices: npt.NDArray[np.float64],
+    faces: npt.NDArray[np.int32],
+    optimize: bool = True,
+    edge_length_fac: float = 0.05,
+) -> Tuple[npt.NDArray[np.float64], npt.NDArray[np.int32]]:
     """
     Convert mesh vertices and faces to a tetrahedral mesh.
 
@@ -65,10 +114,23 @@ def tetrahedralize(vertices: np.ndarray, faces: np.ndarray) -> Tuple[np.ndarray,
         The vertices of the mesh.
     faces : np.ndarray
         The faces of the mesh.
+    optimize : bool
+        Improve the minimum scaled Jacobean for each cell. This leads to higher
+        cell quality at the expense of computation time.
+    edge_length_fac : float, default: 0.05
+        Tetrahedral edge length as a function of bounding box diagional. The
+        default ideal edge length is bb/20 (bounding box divided by 20).
 
     Returns
     -------
     Tuple[np.ndarray, np.ndarray]
         A tuple containing the vertices and tetrahedra of the tetrahedral mesh.
     """
-    return PyfTetWildWrapper.tetrahedralize_mesh(vertices, faces)
+    _check_edge_length(edge_length_fac)
+    if not isinstance(vertices, np.ndarray):
+        raise TypeError("`vertices` must be a numpy array")
+    if not isinstance(faces, np.ndarray):
+        raise TypeError("`faces` must be a numpy array")
+    vertices = vertices.astype(np.float64, copy=False)
+    faces = faces.astype(np.int32, copy=False)
+    return PyfTetWildWrapper.tetrahedralize_mesh(vertices, faces, optimize, edge_length_fac)

pytetwild-0.1.dev1.dist-info/DELVEWHEEL

@@ -0,0 +1,2 @@
+Version: 1.5.4
+Arguments: ['C:\\Users\\runneradmin\\AppData\\Local\\Temp\\cibw-run-rdukv1yg\\cp310-win_amd64\\build\\venv\\Scripts\\delvewheel', 'repair', '-w', 'C:\\Users\\runneradmin\\AppData\\Local\\Temp\\cibw-run-rdukv1yg\\cp310-win_amd64\\repaired_wheel', 'C:\\Users\\runneradmin\\AppData\\Local\\Temp\\cibw-run-rdukv1yg\\cp310-win_amd64\\built_wheel\\pytetwild-0.1.dev1-cp310-cp310-win_amd64.whl', '--add-path', '.']

{pytetwild-0.1.dev0.dist-info → pytetwild-0.1.dev1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pytetwild
-Version: 0.1.dev0
+Version: 0.1.dev1
 Summary: Python wrapper of fTetWild
 Author-Email: Alex Kaszynski <akascap@gmail.com>
 Classifier: Development Status :: 3 - Alpha
@@ -62,28 +62,72 @@ more details.
 Usage
 *****
 
-To tetrahedralize a surface mesh:
+To tetrahedralize a surface mesh from `PyVista <https://docs.pyvista.org>`_:
 
-.. code:: pycon
+.. code:: py
 
-   >>> import pytetwild
-   >>> mesh = pytetwild.tetrahedralize("input_mesh.ply")
-   >>> mesh.vertices
-   array([[x1, y1, z1],
-          [x2, y2, z2],
-          ...], dtype=float32)
-   >>> mesh.tetrahedra
-   array([[i1, j1, k1, l1],
-          [i2, j2, k2, l2],
-          ...], dtype=int32)
+   import pyvista as pv
+   import pytetwild
 
-You can also load a mesh, perform tetrahedralization, and export the tetrahedral mesh:
+   # Load or create a PyVista PolyData surface mesh
+   # Here, we'll create a simple sphere mesh as an example
+   surface_mesh = pv.Icosphere(nsub=2)
 
-.. code:: pycon
+   # Convert the surface mesh to a tetrahedral mesh. For this example let's
+   # use a coarse mesh
+   tetrahedral_mesh = pytetwild.tetrahedralize_pv(surface_mesh, edge_length_fac=1))
+
+   # Visualize the tetrahedral mesh in an "exploded" view
+   tetrahedral_mesh.explode(1).plot(show_edges=True)
 
-    >>> import pytetwild
-    >>> pytetwild.tetrahedralize("input_mesh.ply", "output_mesh.ply")
+.. image:: https://github.com/pyvista/pytetwild/raw/main/exploded-sphere.png
+
+You can also work with raw arrays. Here's a simple cube that we turn into tetrahedra.
+
+.. code:: pycon
 
+   import numpy as np
+
+   # Define vertices of the cube
+   vertices = np.array([
+       [0, 0, 0],  # Vertex 0
+       [1, 0, 0],  # Vertex 1
+       [1, 1, 0],  # Vertex 2
+       [0, 1, 0],  # Vertex 3
+       [0, 0, 1],  # Vertex 4
+       [1, 0, 1],  # Vertex 5
+       [1, 1, 1],  # Vertex 6
+       [0, 1, 1]   # Vertex 7
+   ])
+
+   # Define faces using vertex indices
+   # Each face is a rectangle (also accepts triangles)
+   faces = np.array([
+       [0, 1, 2, 3],  # Front face
+       [1, 5, 6, 2],  # Right face
+       [5, 4, 7, 6],  # Back face
+       [4, 0, 3, 7],  # Left face
+       [4, 5, 1, 0],  # Bottom face
+       [3, 2, 6, 7]   # Top face
+   ])
+   v_out, tetra = pytetwild.tetrahedralize(vertices, faces, optimize=False)
+
+
+Usage - Options
+---------------
+We've surfaced a handful of parameters to each of our interfaces
+``tetrahedralize`` and ``tetrahedralize_pv``. Here are the optional parameters.
+
+.. code::
+
+    Additional Parameters
+    ---------------------
+    edge_length_fac : float, default: 0.05
+        Tetrahedral edge length as a function of bounding box diagional. The
+        default ideal edge length is bb/20 (bounding box divided by 20).
+    optimize : bool
+        Improve the minimum scaled Jacobean for each cell. This leads to higher
+        cell quality at the expense of computation time.
 
 
 License and Acknowledgments

pytetwild-0.1.dev1.dist-info/RECORD

@@ -0,0 +1,14 @@
+pytetwild/py.typed,sha256=mDShSrm8qg9qjacQc2F-rI8ATllqP6EdgHuEYxuCXZ0,7
+pytetwild/PyfTetWildWrapper.pyd,sha256=drheVC_9LDlGgYPyjAdcxmEKW0Rcsu2wNx2xOBrZFVs,4988416
+pytetwild/pytetwild.py,sha256=PSLlG5czLo2Z2aZtcgxmZAy97E9eAtbo7EdvY0WONIs,4646
+pytetwild/_version.py,sha256=hbg9UkagWDGV6Zg23kEpex_otuUYHUzMCHXYTnFnHmE,118
+pytetwild/__init__.py,sha256=QdK3GINbrnK1cwEauX0cPgzkVCa1VPait8aGT2AJN4Q,486
+pytetwild-0.1.dev1.dist-info/DELVEWHEEL,sha256=9gdhJR4vb_YdBPE6ej5YzI4lvi6480X3Wh0PPcfM5TM,423
+pytetwild-0.1.dev1.dist-info/entry_points.txt,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pytetwild-0.1.dev1.dist-info/METADATA,sha256=6I1FzXoY9ezDC8EWamtUR2MVxWtBvgjD5frhxz4gw6Y,4587
+pytetwild-0.1.dev1.dist-info/RECORD,,
+pytetwild-0.1.dev1.dist-info/WHEEL,sha256=8XuJkyxPIT13OzegTGarRVhmDP5NkOix_zaC7jtZJJE,105
+pytetwild-0.1.dev1.dist-info/licenses/LICENSE,sha256=k0P1sbYupRWlxoESvbYq2UzoMW6MXA84LltqR-4mEo4,17096
+pytetwild.libs/concrt140-ddbfd8b75976783430ced289c6b989c3.dll,sha256=BZPGv1uz0YBgBOgTWBBL0elt7C3clmR348_2Zlqh47Q,302080
+pytetwild.libs/mpir-0f58ffaa159ebf7efb9359a55c2d7f23.dll,sha256=qd6vEIL0JPtRZ39EzelGE9rApfJ6duoMgV8jT8UHGns,612352
+pytetwild.libs/msvcp140-3499a3a8427eec4915749ee9a8991ddd.dll,sha256=oDDcLf0uyiipN1ySmJrfTa8WH5iNteFrnhBnjrDf9Mc,573008

pytetwild-0.1.dev0.dist-info/DELVEWHEEL

@@ -1,2 +0,0 @@
-Version: 1.5.2
-Arguments: ['C:\\Users\\runneradmin\\AppData\\Local\\Temp\\cibw-run-a87uf2fd\\cp310-win_amd64\\build\\venv\\Scripts\\delvewheel', 'repair', '-w', 'C:\\Users\\runneradmin\\AppData\\Local\\Temp\\cibw-run-a87uf2fd\\cp310-win_amd64\\repaired_wheel', 'C:\\Users\\runneradmin\\AppData\\Local\\Temp\\cibw-run-a87uf2fd\\cp310-win_amd64\\built_wheel\\pytetwild-0.1.dev0-cp310-cp310-win_amd64.whl', '--add-path', '.']

pytetwild-0.1.dev0.dist-info/RECORD

@@ -1,13 +0,0 @@
-pytetwild/PyfTetWildWrapper.pyd,sha256=UuNiz6sAfdNOMcAi9EPWcmMs4OvCTiHLA6tQar9U6Cs,4988416
-pytetwild/pytetwild.py,sha256=fA0lXIqIf97TONhpX2vME7_3vS_9kVh8ianOVIC44EU,2169
-pytetwild/_version.py,sha256=hbg9UkagWDGV6Zg23kEpex_otuUYHUzMCHXYTnFnHmE,118
-pytetwild/__init__.py,sha256=01OqAVF8WQmKyJjKPOTwgJCDAqYmP-KwbCF9VhN--xo,486
-pytetwild-0.1.dev0.dist-info/DELVEWHEEL,sha256=SHYn2-hpJw46uLwvXBovphCM_cH6y5DadxgiGIXrv_A,423
-pytetwild-0.1.dev0.dist-info/entry_points.txt,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-pytetwild-0.1.dev0.dist-info/METADATA,sha256=tAozjdbNnB40sjP1A_7R-maND-a9aNqKpNibMwI0k3c,3038
-pytetwild-0.1.dev0.dist-info/RECORD,,
-pytetwild-0.1.dev0.dist-info/WHEEL,sha256=8XuJkyxPIT13OzegTGarRVhmDP5NkOix_zaC7jtZJJE,105
-pytetwild-0.1.dev0.dist-info/licenses/LICENSE,sha256=k0P1sbYupRWlxoESvbYq2UzoMW6MXA84LltqR-4mEo4,17096
-pytetwild.libs/concrt140-ddbfd8b75976783430ced289c6b989c3.dll,sha256=BZPGv1uz0YBgBOgTWBBL0elt7C3clmR348_2Zlqh47Q,302080
-pytetwild.libs/mpir-0f58ffaa159ebf7efb9359a55c2d7f23.dll,sha256=qd6vEIL0JPtRZ39EzelGE9rApfJ6duoMgV8jT8UHGns,612352
-pytetwild.libs/msvcp140-3499a3a8427eec4915749ee9a8991ddd.dll,sha256=oDDcLf0uyiipN1ySmJrfTa8WH5iNteFrnhBnjrDf9Mc,573008