cad-to-dagmc 0.9.1__py3-none-any.whl → 0.9.3__py3-none-any.whl

_version.py

@@ -1,7 +1,14 @@
 # file generated by setuptools-scm
 # don't change, don't track in version control
 
-__all__ = ["__version__", "__version_tuple__", "version", "version_tuple"]
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
 
 TYPE_CHECKING = False
 if TYPE_CHECKING:
@@ -9,13 +16,19 @@ if TYPE_CHECKING:
     from typing import Union
 
     VERSION_TUPLE = Tuple[Union[int, str], ...]
+    COMMIT_ID = Union[str, None]
 else:
     VERSION_TUPLE = object
+    COMMIT_ID = object
 
 version: str
 __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
+commit_id: COMMIT_ID
+__commit_id__: COMMIT_ID
 
-__version__ = version = '0.9.1'
-__version_tuple__ = version_tuple = (0, 9, 1)
+__version__ = version = '0.9.3'
+__version_tuple__ = version_tuple = (0, 9, 3)
+
+__commit_id__ = commit_id = None

cad_to_dagmc/core.py

@@ -7,6 +7,7 @@ from cadquery import importers
 from pymoab import core, types
 import tempfile
 import warnings
+from typing import Iterable
 from cad_to_dagmc import __version__
 
 
@@ -810,47 +811,112 @@ class CadToDagmc:
     def export_dagmc_h5m_file(
         self,
         filename: str = "dagmc.h5m",
-        min_mesh_size: float | None = None,
-        max_mesh_size: float | None = None,
-        mesh_algorithm: int = 1,
+        meshing_backend: str = "cadquery",
         implicit_complement_material_tag: str | None = None,
-        method: str = "file",
         scale_factor: float = 1.0,
         imprint: bool = True,
-        set_size: dict[int, float] | None = None,
+        **kwargs,
     ) -> str:
         """Saves a DAGMC h5m file of the geometry
 
         Args:
-            filename (str, optional): the filename to use for the saved DAGMC file. Defaults to "dagmc.h5m".
-            min_mesh_size (float, optional): the minimum size of mesh elements to use. Defaults to 1.
-            max_mesh_size (float, optional): the maximum size of mesh elements to use. Defaults to 5.
-            mesh_algorithm (int, optional): the GMSH mesh algorithm to use.. Defaults to 1.
-            implicit_complement_material_tag (str | None, optional):
-                the name of the material tag to use for the implicit complement
-                (void space). Defaults to None which is a vacuum. Defaults to None.
-           method: the method to use to import the geometry into gmsh. Options
-                are 'file' or 'in memory'. 'file' is the default and will write
-                the geometry to a temporary file before importing it into gmsh.
-                'in memory' will import the geometry directly into gmsh but
-                requires the version of OpenCASCADE used to build gmsh to be
-                the same as the version used by CadQuery. This is possible to
-                ensure when installing the package with Conda but harder when
-                installing from PyPI.
-            scale_factor: a scaling factor to apply to the geometry that can be
-                used to enlarge or shrink the geometry. Useful when converting
-                Useful when converting the geometry to cm for use in neutronics
-            imprint: whether to imprint the geometry or not. Defaults to True as this is
-                normally needed to ensure the geometry is meshed correctly. However if
-                you know your geometry does not need imprinting you can set this to False
-                and this can save time.
-            set_size: a dictionary of volume ids (int) and target mesh sizes
-                (floats) to set for each volume, passed to gmsh.model.mesh.setSize.
+            filename: the filename to use for the saved DAGMC file.
+            meshing_backend: determines whether gmsh or cadquery's direct mesh method
+                is used for meshing. Options are 'gmsh' or 'cadquery'.
+            implicit_complement_material_tag: the name of the material tag to use
+                for the implicit complement (void space).
+            scale_factor: a scaling factor to apply to the geometry.
+            imprint: whether to imprint the geometry or not.
+
+            **kwargs: Backend-specific parameters:
+
+                For GMSH backend:
+                - min_mesh_size (float): minimum mesh element size
+                - max_mesh_size (float): maximum mesh element size
+                - mesh_algorithm (int): GMSH mesh algorithm (default: 1)
+                - method (str): import method 'file' or 'in memory' (default: 'file')
+                - set_size (dict[int, float]): volume ids and target mesh sizes
+                - unstructured_volumes (Iterable[int]): volume ids for unstructured mesh
+                - umesh_filename (str): filename for unstructured mesh (default: 'umesh.vtk')
+
+                For CadQuery backend:
+                - tolerance (float): meshing tolerance (default: 0.1)
+                - angular_tolerance (float): angular tolerance (default: 0.1)
 
         Returns:
-            str: the DAGMC filename saved
+            str: the filename(s) for the files created.
+
+        Raises:
+            ValueError: If invalid parameter combinations are used.
         """
 
+        # Validate meshing backend
+        if meshing_backend not in ["gmsh", "cadquery"]:
+            raise ValueError(
+                f'meshing_backend "{meshing_backend}" not supported. '
+                'Available options are "gmsh" or "cadquery"'
+            )
+
+        # Initialize variables to avoid unbound errors
+        tolerance = 0.1
+        angular_tolerance = 0.1
+        min_mesh_size = None
+        max_mesh_size = None
+        mesh_algorithm = 1
+        method = "file"
+        set_size = None
+        unstructured_volumes = None
+        umesh_filename = "umesh.vtk"
+
+        # Extract backend-specific parameters with defaults
+        if meshing_backend == "cadquery":
+            # CadQuery parameters
+            tolerance = kwargs.get("tolerance", 0.1)
+            angular_tolerance = kwargs.get("angular_tolerance", 0.1)
+
+            # Check for invalid parameters
+            unstructured_volumes = kwargs.get("unstructured_volumes")
+            if unstructured_volumes is not None:
+                raise ValueError(
+                    "CadQuery backend cannot be used for volume meshing. "
+                    "unstructured_volumes must be None when using 'cadquery' backend."
+                )
+
+            # Warn about unused GMSH parameters
+            gmsh_params = [
+                "min_mesh_size",
+                "max_mesh_size",
+                "mesh_algorithm",
+                "set_size",
+                "umesh_filename",
+                "method",
+            ]
+            unused_params = [param for param in gmsh_params if param in kwargs]
+            if unused_params:
+                warnings.warn(
+                    f"The following parameters are ignored when using CadQuery backend: "
+                    f"{', '.join(unused_params)}"
+                )
+
+        elif meshing_backend == "gmsh":
+            # GMSH parameters
+            min_mesh_size = kwargs.get("min_mesh_size")
+            max_mesh_size = kwargs.get("max_mesh_size")
+            mesh_algorithm = kwargs.get("mesh_algorithm", 1)
+            method = kwargs.get("method", "file")
+            set_size = kwargs.get("set_size")
+            unstructured_volumes = kwargs.get("unstructured_volumes")
+            umesh_filename = kwargs.get("umesh_filename", "umesh.vtk")
+
+            # Warn about unused CadQuery parameters
+            cq_params = ["tolerance", "angular_tolerance"]
+            unused_params = [param for param in cq_params if param in kwargs]
+            if unused_params:
+                warnings.warn(
+                    f"The following parameters are ignored when using GMSH backend: "
+                    f"{', '.join(unused_params)}"
+                )
+
         assembly = cq.Assembly()
         for part in self.parts:
             assembly.add(part)
@@ -863,51 +929,108 @@ class CadToDagmc:
             msg = f"Number of volumes {len(original_ids)} is not equal to number of material tags {len(self.material_tags)}"
             raise ValueError(msg)
 
-        if imprint:
-            imprinted_assembly, imprinted_solids_with_org_id = cq.occ_impl.assembly.imprint(
-                assembly
+        # Use the CadQuery direct mesh plugin
+        if meshing_backend == "cadquery":
+            import cadquery_direct_mesh_plugin
+
+            # Mesh the assembly using CadQuery's direct-mesh plugin
+            cq_mesh = assembly.toMesh(
+                imprint,
+                tolerance=tolerance,
+                angular_tolerance=angular_tolerance,
+                scale_factor=scale_factor,
             )
 
-            scrambled_ids = get_ids_from_imprinted_assembly(imprinted_solids_with_org_id)
+            # Fix the material tag order for imprinted assemblies
+            if cq_mesh["imprinted_assembly"] is not None:
+                imprinted_solids_with_org_id = cq_mesh["imprinted_solids_with_orginal_ids"]
 
-            material_tags_in_brep_order = order_material_ids_by_brep_order(
-                original_ids, scrambled_ids, self.material_tags
-            )
-        else:
-            material_tags_in_brep_order = self.material_tags
-            imprinted_assembly = assembly
+                scrambled_ids = get_ids_from_imprinted_assembly(imprinted_solids_with_org_id)
 
-        check_material_tags(material_tags_in_brep_order, self.parts)
+                material_tags_in_brep_order = order_material_ids_by_brep_order(
+                    original_ids, scrambled_ids, self.material_tags
+                )
+            else:
+                material_tags_in_brep_order = self.material_tags
+
+            check_material_tags(material_tags_in_brep_order, self.parts)
+
+            # Extract the mesh information to allow export to h5m from the direct-mesh result
+            vertices = cq_mesh["vertices"]
+            triangles_by_solid_by_face = cq_mesh["solid_face_triangle_vertex_map"]
+        # Use gmsh
+        elif meshing_backend == "gmsh":
+            # If assembly is not to be imprinted, pass through the assembly as-is
+            if imprint:
+                imprinted_assembly, imprinted_solids_with_org_id = cq.occ_impl.assembly.imprint(
+                    assembly
+                )
 
-        gmsh = init_gmsh()
+                scrambled_ids = get_ids_from_imprinted_assembly(imprinted_solids_with_org_id)
 
-        gmsh, volumes = get_volumes(
-            gmsh, imprinted_assembly, method=method, scale_factor=scale_factor
-        )
+                material_tags_in_brep_order = order_material_ids_by_brep_order(
+                    original_ids, scrambled_ids, self.material_tags
+                )
 
-        gmsh = set_sizes_for_mesh(
-            gmsh=gmsh,
-            min_mesh_size=min_mesh_size,
-            max_mesh_size=max_mesh_size,
-            mesh_algorithm=mesh_algorithm,
-            set_size=set_size,
-        )
+            else:
+                material_tags_in_brep_order = self.material_tags
+                imprinted_assembly = assembly
 
-        gmsh.model.mesh.generate(2)
+            check_material_tags(material_tags_in_brep_order, self.parts)
 
-        dims_and_vol_ids = volumes
+            # Start generating the mesh
+            gmsh = init_gmsh()
 
-        vertices, triangles_by_solid_by_face = mesh_to_vertices_and_triangles(
-            dims_and_vol_ids=dims_and_vol_ids
-        )
+            gmsh, volumes = get_volumes(
+                gmsh, imprinted_assembly, method=method, scale_factor=scale_factor
+            )
 
-        gmsh.finalize()
+            gmsh = set_sizes_for_mesh(
+                gmsh=gmsh,
+                min_mesh_size=min_mesh_size,
+                max_mesh_size=max_mesh_size,
+                mesh_algorithm=mesh_algorithm,
+                set_size=set_size,
+            )
+
+            gmsh.model.mesh.generate(2)
+
+            vertices, triangles_by_solid_by_face = mesh_to_vertices_and_triangles(
+                dims_and_vol_ids=volumes
+            )
+
+        else:
+            raise ValueError(
+                f'meshing_backend {meshing_backend} not supported. Available options are "cadquery" or "gmsh"'
+            )
 
-        # checks and fixes triangle fix_normals within vertices_to_h5m
-        return vertices_to_h5m(
+        dagmc_filename = vertices_to_h5m(
             vertices=vertices,
             triangles_by_solid_by_face=triangles_by_solid_by_face,
             material_tags=material_tags_in_brep_order,
             h5m_filename=filename,
             implicit_complement_material_tag=implicit_complement_material_tag,
         )
+
+        if unstructured_volumes:
+            # remove all the unused occ volumes, this prevents them being meshed
+            for volume_dim, volume_id in volumes:
+                if volume_id not in unstructured_volumes:
+                    gmsh.model.occ.remove([(volume_dim, volume_id)], recursive=True)
+            gmsh.option.setNumber("Mesh.SaveAll", 1)
+            gmsh.model.occ.synchronize()
+
+            # removes all the 2D groups so that 2D faces are not included in the vtk file
+            all_2d_groups = gmsh.model.getPhysicalGroups(2)
+            for entry in all_2d_groups:
+                gmsh.model.removePhysicalGroups([entry])
+
+            gmsh.model.mesh.generate(3)
+            gmsh.option.setNumber("Mesh.SaveElementTagType", 3)  # Save only volume elements
+            gmsh.write(umesh_filename)
+
+            gmsh.finalize()
+
+            return dagmc_filename, umesh_filename
+        else:
+            return dagmc_filename

{cad_to_dagmc-0.9.1.dist-info → cad_to_dagmc-0.9.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cad_to_dagmc
-Version: 0.9.1
+Version: 0.9.3
 Summary: Converts CAD files to a DAGMC h5m file
 Author-email: Jonathan Shimwell <mail@jshimwell.com>
 Project-URL: Homepage, https://github.com/fusion-energy/cad_to_dagmc
@@ -55,7 +55,8 @@ Cad-to-dagmc offers a wide range of features including.
 - Geometry scaling with ```scale_factor``` argument
 - Model wide mesh size parameters with ```min_mesh_size``` and ```max_mesh_size``` arguments
 - Volume specific mesh sizing parameters with the ```set_size``` argument
-- Volume mesh selected volumes in the geometry (helps ensure conformal volume and surface mesh).
+- Unstructured mesh that share the same coordinates as the surface mesh.
+- Volume mesh allows selecting individual volumes in the geometry.
 - Parallel meshing to quickly mesh the geometry using multiple CPU cores
 - Imprint and merging of CAD geometry, or disable with the ```imprint``` argument
 - Add geometry from multiple sources ([STEP](http://www.steptools.com/stds/step/) files, [CadQuery](https://cadquery.readthedocs.io) objects and [Gmsh](https://gmsh.info/) meshes)

cad_to_dagmc-0.9.3.dist-info/RECORD

@@ -0,0 +1,8 @@
+_version.py,sha256=IVkGBvcxJApDB_GrSj1qL5BDxEvWBYmqcR3emEmrC0I,704
+cad_to_dagmc/__init__.py,sha256=fskHUTyCunSpnpJUvBfAYjx4uwDKXHTTiMP6GqnFRf0,494
+cad_to_dagmc/core.py,sha256=2OzaYEMcWr508PuyciESTJPvOKRAbEwfOOL6d4VKEzM,40333
+cad_to_dagmc-0.9.3.dist-info/licenses/LICENSE,sha256=B8kznH_777JVNZ3HOKDc4Tj24F7wJ68ledaNYeL9sCw,1070
+cad_to_dagmc-0.9.3.dist-info/METADATA,sha256=OmHxTGWZTity6KYaUwMwB9wppyBxxcry_ikCWOvSfPU,8990
+cad_to_dagmc-0.9.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+cad_to_dagmc-0.9.3.dist-info/top_level.txt,sha256=zTi8C64SEBsE5WOtPovnxhOzt-E6Oc5nC3RW6M_5aEA,22
+cad_to_dagmc-0.9.3.dist-info/RECORD,,

{cad_to_dagmc-0.9.1.dist-info → cad_to_dagmc-0.9.3.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.3.1)
+Generator: setuptools (80.9.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

cad_to_dagmc-0.9.1.dist-info/RECORD

@@ -1,8 +0,0 @@
-_version.py,sha256=QG_t-w_CzDn2UjPaW-Svt-wTU1NXK2QkudawUihJfHA,511
-cad_to_dagmc/__init__.py,sha256=fskHUTyCunSpnpJUvBfAYjx4uwDKXHTTiMP6GqnFRf0,494
-cad_to_dagmc/core.py,sha256=ej1wk_-q-eXJ5F7jfjBwPII4qWHnMQWeMT_XZG_A0xI,35713
-cad_to_dagmc-0.9.1.dist-info/licenses/LICENSE,sha256=B8kznH_777JVNZ3HOKDc4Tj24F7wJ68ledaNYeL9sCw,1070
-cad_to_dagmc-0.9.1.dist-info/METADATA,sha256=S15I2B5N_eEUC7XqFB6sNyiuFwSLrHj8--1CraXkaMo,8947
-cad_to_dagmc-0.9.1.dist-info/WHEEL,sha256=0CuiUZ_p9E4cD6NyLD6UG80LBXYyiSYZOKDm5lp32xk,91
-cad_to_dagmc-0.9.1.dist-info/top_level.txt,sha256=zTi8C64SEBsE5WOtPovnxhOzt-E6Oc5nC3RW6M_5aEA,22
-cad_to_dagmc-0.9.1.dist-info/RECORD,,