cad-to-dagmc 0.7.3__tar.gz → 0.7.5__tar.gz

{cad_to_dagmc-0.7.3 → cad_to_dagmc-0.7.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cad_to_dagmc
-Version: 0.7.3
+Version: 0.7.5
 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

{cad_to_dagmc-0.7.3 → cad_to_dagmc-0.7.5}/examples/unstrucutred_volume_mesh/curved_cadquery_object_to_dagmc_volume_mesh.py

@@ -59,4 +59,4 @@ my_model = CadToDagmc()
 my_model.add_cadquery_object(result, material_tags=["mat1"])
 my_model.add_cadquery_object(result2, material_tags=["mat2"])
 
-my_model.export_unstructured_mesh_file(filename="umesh.h5m", max_mesh_size=1, min_mesh_size=0.1)
+my_model.export_unstructured_mesh_file(filename="umesh.vtk", max_mesh_size=1, min_mesh_size=0.1)

{cad_to_dagmc-0.7.3 → cad_to_dagmc-0.7.5}/examples/unstrucutred_volume_mesh/simulate_unstrucutred_volume_mesh_with_openmc.py

@@ -1,4 +1,4 @@
-# script assumes that "umesh.h5m" has been created by
+# script assumes that "umesh.vtk" has been created by
 # curved_cadquery_object_to_dagmc_volume_mesh.py has been
 
 import openmc
@@ -14,7 +14,7 @@ with open("cross_sections.xml", "w") as file:
     )
 openmc.config["cross_sections"] = "cross_sections.xml"
 
-umesh = openmc.UnstructuredMesh("umesh.h5m", library="moab")
+umesh = openmc.UnstructuredMesh("umesh.vtk", library="moab")
 mesh_filter = openmc.MeshFilter(umesh)
 tally = openmc.Tally(name="unstrucutred_mesh_tally")
 tally.filters = [mesh_filter]

{cad_to_dagmc-0.7.3 → cad_to_dagmc-0.7.5}/src/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.7.3'
-__version_tuple__ = version_tuple = (0, 7, 3)
+__version__ = version = '0.7.5'
+__version_tuple__ = version_tuple = (0, 7, 5)

{cad_to_dagmc-0.7.3 → cad_to_dagmc-0.7.5}/src/cad_to_dagmc/core.py

@@ -1,7 +1,8 @@
+from pathlib import Path
 import cadquery as cq
 import gmsh
 import numpy as np
-from cadquery import importers, exporters
+from cadquery import importers
 from pymoab import core, types
 import tempfile
 
@@ -484,19 +485,62 @@ class CadToDagmc:
 
     def export_unstructured_mesh_file(
         self,
-        filename: str = "umesh.h5m",
+        filename: str = "umesh.vtk",
         min_mesh_size: float = 1,
         max_mesh_size: float = 5,
         mesh_algorithm: int = 1,
         method: str = "file",
         scale_factor: float = 1.0,
+        imprint: bool = True,
     ):
+        """
+        Exports an unstructured mesh file in VTK format for use with openmc.UnstructuredMesh.
+        Compatible with the MOAB unstructured mesh library. Example useage
+        openmc.UnstructuredMesh(filename="umesh.vtk", library="moab")
+
+        Parameters:
+        -----------
+            filename : str, optional
+                The name of the output file. Default is "umesh.vtk".
+            min_mesh_size: the minimum mesh element size to use in Gmsh. Passed
+                into gmsh.option.setNumber("Mesh.MeshSizeMin", min_mesh_size)
+            max_mesh_size: the maximum mesh element size to use in Gmsh. Passed
+                into gmsh.option.setNumber("Mesh.MeshSizeMax", max_mesh_size)
+            mesh_algorithm: The Gmsh mesh algorithm number to use. Passed into
+                gmsh.option.setNumber("Mesh.Algorithm", mesh_algorithm)
+            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.
+
+        Returns:
+        --------
+            gmsh : gmsh
+                The gmsh object after finalizing the mesh.
+        """
+
+        if Path(filename).suffix != ".vtk":
+            raise ValueError("Unstructured mesh filename must have a .vtk extension")
 
         assembly = cq.Assembly()
         for part in self.parts:
             assembly.add(part)
 
-        imprinted_assembly, _ = cq.occ_impl.assembly.imprint(assembly)
+        if imprint:
+            imprinted_assembly, _ = cq.occ_impl.assembly.imprint(assembly)
+        else:
+            imprinted_assembly = assembly
 
         gmsh = init_gmsh()
 
@@ -510,12 +554,9 @@ class CadToDagmc:
             dimensions=3,
         )
 
-        # gmesh writes out a vtk file that is converted by pymoab into a h5 file
-        gmsh.write(filename + ".vtk")
-
-        moab_core = core.Core()
-        moab_core.load_file(filename + ".vtk")
-        moab_core.write_file(filename)
+        # gmesh writes out a vtk file that is accepted by openmc.UnstructuredMesh
+        # The library argument must be set to "moab"
+        gmsh.write(filename)
 
         gmsh.finalize()
 
@@ -530,6 +571,7 @@ class CadToDagmc:
         dimensions: int = 2,
         method: str = "file",
         scale_factor: float = 1.0,
+        imprint: bool = True,
     ):
         """Saves a GMesh msh file of the geometry in either 2D surface mesh or
         3D volume mesh.
@@ -552,13 +594,20 @@ class CadToDagmc:
             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.
         """
 
         assembly = cq.Assembly()
         for part in self.parts:
             assembly.add(part)
 
-        imprinted_assembly, _ = cq.occ_impl.assembly.imprint(assembly)
+        if imprint:
+            imprinted_assembly, _ = cq.occ_impl.assembly.imprint(assembly)
+        else:
+            imprinted_assembly = assembly
 
         gmsh = init_gmsh()
 
@@ -587,11 +636,11 @@ class CadToDagmc:
         implicit_complement_material_tag: str | None = None,
         method: str = "file",
         scale_factor: float = 1.0,
+        imprint: bool = True,
     ) -> 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.
@@ -610,6 +659,10 @@ class CadToDagmc:
             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.
 
         Returns:
             str: the DAGMC filename saved
@@ -619,21 +672,27 @@ class CadToDagmc:
         for part in self.parts:
             assembly.add(part)
 
-        imprinted_assembly, imprinted_solids_with_org_id = cq.occ_impl.assembly.imprint(assembly)
-
         original_ids = _get_ids_from_assembly(assembly)
-        scrambled_ids = _get_ids_from_imprinted_assembly(imprinted_solids_with_org_id)
 
         # both id lists should be the same length as each other and the same
         # length as the self.material_tags
-
         if len(original_ids) != len(self.material_tags):
             msg = f"Number of volumes {len(original_ids)} is not equal to number of material tags {len(self.material_tags)}"
             raise ValueError(msg)
 
-        material_tags_in_brep_order = order_material_ids_by_brep_order(
-            original_ids, scrambled_ids, self.material_tags
-        )
+        if imprint:
+            imprinted_assembly, imprinted_solids_with_org_id = cq.occ_impl.assembly.imprint(
+                assembly
+            )
+
+            scrambled_ids = _get_ids_from_imprinted_assembly(imprinted_solids_with_org_id)
+
+            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
 
         _check_material_tags(material_tags_in_brep_order, self.parts)
 

{cad_to_dagmc-0.7.3 → cad_to_dagmc-0.7.5}/src/cad_to_dagmc.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cad_to_dagmc
-Version: 0.7.3
+Version: 0.7.5
 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