cad-to-dagmc 0.7.4__tar.gz → 0.7.6__tar.gz

{cad_to_dagmc-0.7.4 → cad_to_dagmc-0.7.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cad_to_dagmc
-Version: 0.7.4
+Version: 0.7.6
 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.4 → cad_to_dagmc-0.7.6}/src/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.7.4'
-__version_tuple__ = version_tuple = (0, 7, 4)
+__version__ = version = '0.7.6'
+__version_tuple__ = version_tuple = (0, 7, 6)

{cad_to_dagmc-0.7.4 → cad_to_dagmc-0.7.6}/src/cad_to_dagmc/core.py

@@ -5,6 +5,7 @@ import numpy as np
 from cadquery import importers
 from pymoab import core, types
 import tempfile
+import warnings
 
 
 def _define_moab_core_and_tags() -> tuple[core.Core, dict]:
@@ -76,6 +77,7 @@ def _vertices_to_h5m(
         triangles:
         material_tags:
         h5m_filename:
+        implicit_complement_material_tag:
     """
 
     if len(material_tags) != len(triangles_by_solid_by_face):
@@ -184,7 +186,15 @@ def _vertices_to_h5m(
 
     moab_core.add_entities(file_set, all_sets)
 
-    moab_core.write_file(h5m_filename)
+    # makes the folder if it does not exist
+    if Path(h5m_filename).parent:
+        Path(h5m_filename).parent.mkdir(parents=True, exist_ok=True)
+
+    # moab_core.write_file only accepts strings
+    if isinstance(h5m_filename, Path):
+        moab_core.write_file(str(h5m_filename))
+    else:
+        moab_core.write_file(h5m_filename)
 
     print(f"written DAGMC file {h5m_filename}")
 
@@ -230,8 +240,7 @@ def _mesh_brep(
     mesh_algorithm: int = 1,
     dimensions: int = 2,
 ):
-    """Creates a conformal surface meshes of the volumes in a Brep file using
-    Gmsh.
+    """Creates a conformal surface meshes of the volumes in a Brep file using Gmsh.
 
     Args:
         occ_shape: the occ_shape of the Brep file to convert
@@ -339,6 +348,12 @@ def _check_material_tags(material_tags, iterable_solids):
             if not isinstance(material_tag, str):
                 msg = f"material_tags should be an iterable of strings."
                 raise ValueError(msg)
+            if len(material_tag) > 28:
+                msg = (
+                    f"Material tag {material_tag} is too long. DAGMC will truncate this material tag "
+                    f"to 28 characters. The resulting tag in the h5m file will be {material_tag[:28]}"
+                )
+                warnings.warn(msg)
 
 
 def order_material_ids_by_brep_order(original_ids, scrambled_id, material_tags):
@@ -357,6 +372,7 @@ class MeshToDagmc:
 
     # TODO add export_unstructured_mesh_file
     # TODO add add_gmsh_msh_file
+    # TODO test for exports result in files
 
     def export_dagmc_h5m_file(
         self,
@@ -491,6 +507,7 @@ class CadToDagmc:
         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.
@@ -518,6 +535,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:
         --------
@@ -525,6 +546,8 @@ class CadToDagmc:
                 The gmsh object after finalizing the mesh.
         """
 
+        # gmesh writes out a vtk file that is accepted by openmc.UnstructuredMesh
+        # The library argument must be set to "moab"
         if Path(filename).suffix != ".vtk":
             raise ValueError("Unstructured mesh filename must have a .vtk extension")
 
@@ -532,7 +555,10 @@ class CadToDagmc:
         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()
 
@@ -546,9 +572,15 @@ class CadToDagmc:
             dimensions=3,
         )
 
-        # gmesh writes out a vtk file that is accepted by openmc.UnstructuredMesh
-        # The library argument must be set to "moab"
-        gmsh.write(filename)
+        # makes the folder if it does not exist
+        if Path(filename).parent:
+            Path(filename).parent.mkdir(parents=True, exist_ok=True)
+
+        # gmsh.write only accepts strings
+        if isinstance(filename, Path):
+            gmsh.write(str(filename))
+        else:
+            gmsh.write(filename)
 
         gmsh.finalize()
 
@@ -563,6 +595,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.
@@ -585,13 +618,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()
 
@@ -605,7 +645,15 @@ class CadToDagmc:
             dimensions=dimensions,
         )
 
-        gmsh.write(filename)
+        # makes the folder if it does not exist
+        if Path(filename).parent:
+            Path(filename).parent.mkdir(parents=True, exist_ok=True)
+
+        # gmsh.write only accepts strings
+        if isinstance(filename, Path):
+            gmsh.write(str(filename))
+        else:
+            gmsh.write(filename)
 
         print(f"written GMSH mesh file {filename}")
 
@@ -620,11 +668,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.
@@ -643,6 +691,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
@@ -652,21 +704,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.4 → cad_to_dagmc-0.7.6}/src/cad_to_dagmc.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cad_to_dagmc
-Version: 0.7.4
+Version: 0.7.6
 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.4 → cad_to_dagmc-0.7.6}/tests/test_python_api.py

@@ -1,8 +1,10 @@
 import os
 from pathlib import Path
+import pytest
 import cadquery as cq
 from cad_to_dagmc import CadToDagmc
-
+import warnings
+from cad_to_dagmc.core import _check_material_tags
 
 from pathlib import Path
 
@@ -138,3 +140,82 @@ def test_add_stp_file_returned_volumes():
     c2d = CadToDagmc()
     vols = c2d.add_stp_file("tests/two_disconnected_cubes.stp")
     assert vols == 2
+
+
+@pytest.mark.parametrize(
+    "filename",
+    [
+        "test_dagmc1.h5m",
+        "out_folder1/test_dagmc2.h5m",
+        Path("test_dagmc3.h5m"),
+        Path("out_folder2/test_dagmc4.h5m"),
+    ],
+)
+def test_export_dagmc_h5m_file_handel_paths_folders_strings(filename):
+    """Checks that a h5m file is created"""
+
+    box = cq.Workplane().box(1, 1, 1)
+    c2d = CadToDagmc()
+    c2d.add_cadquery_object(box, material_tags=["mat1"])
+
+    c2d.export_dagmc_h5m_file(filename=filename)
+
+    assert Path(filename).is_file()
+
+    os.system(f"rm -rf {filename}")
+
+
+@pytest.mark.parametrize(
+    "filename",
+    [
+        "test_dagmc1.vtk",
+        "out_folder3/test_dagmc2.vtk",
+        Path("test_dagmc3.vtk"),
+        Path("out_folder4/test_dagmc4.vtk"),
+    ],
+)
+def test_export_unstructured_mesh_file_handel_paths_folders_strings(filename):
+    """Checks that a vtk file is created"""
+
+    box = cq.Workplane().box(1, 1, 1)
+    c2d = CadToDagmc()
+    c2d.add_cadquery_object(box, material_tags=["mat1"])
+
+    c2d.export_unstructured_mesh_file(filename=filename)
+
+    assert Path(filename).is_file()
+
+    os.system(f"rm -rf {filename}")
+
+
+@pytest.mark.parametrize(
+    "filename",
+    [
+        "test_dagmc1.msh",
+        "out_folder5/test_dagmc2.msh",
+        Path("test_dagmc3.msh"),
+        Path("out_folder6/test_dagmc4.msh"),
+    ],
+)
+def test_export_gmsh_mesh_file_handel_paths_folders_strings(filename):
+    """Checks that a vtk file is created"""
+
+    box = cq.Workplane().box(1, 1, 1)
+    c2d = CadToDagmc()
+    c2d.add_cadquery_object(box, material_tags=["mat1"])
+
+    c2d.export_gmsh_mesh_file(filename=filename)
+
+    assert Path(filename).is_file()
+
+    os.system(f"rm -rf {filename}")
+
+
+def test_check_material_tags_too_long():
+    with warnings.catch_warnings(record=True) as w:
+        warnings.simplefilter("always")
+        _check_material_tags(["a" * 29], [1])
+        assert len(w) == 1
+        assert issubclass(w[-1].category, UserWarning)
+        assert "Material tag" in str(w[-1].message)
+        assert "a" * 29 in str(w[-1].message)