cad-to-dagmc 0.8.0__tar.gz → 0.8.2__tar.gz

{cad_to_dagmc-0.8.0 → cad_to_dagmc-0.8.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: cad_to_dagmc
-Version: 0.8.0
+Version: 0.8.2
 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.8.0 → cad_to_dagmc-0.8.2}/src/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.8.0'
-__version_tuple__ = version_tuple = (0, 8, 0)
+__version__ = version = '0.8.2'
+__version_tuple__ = version_tuple = (0, 8, 2)

{cad_to_dagmc-0.8.0 → cad_to_dagmc-0.8.2}/src/cad_to_dagmc/core.py

@@ -8,7 +8,7 @@ import tempfile
 import warnings
 
 
-def _define_moab_core_and_tags() -> tuple[core.Core, dict]:
+def define_moab_core_and_tags() -> tuple[core.Core, dict]:
     """Creates a MOAB Core instance which can be built up by adding sets of
     triangles to the instance
 
@@ -62,7 +62,7 @@ def _define_moab_core_and_tags() -> tuple[core.Core, dict]:
     return moab_core, tags
 
 
-def _vertices_to_h5m(
+def vertices_to_h5m(
     vertices: list[tuple[float, float, float]] | list["cadquery.occ_impl.geom.Vector"],
     triangles_by_solid_by_face: list[list[tuple[int, int, int]]],
     material_tags: list[str],
@@ -100,7 +100,7 @@ def _vertices_to_h5m(
             else:
                 face_ids_with_solid_ids[face_id] = [solid_id]
 
-    moab_core, tags = _define_moab_core_and_tags()
+    moab_core, tags = define_moab_core_and_tags()
 
     volume_sets_by_solid_id = {}
     for material_tag, (solid_id, triangles_on_each_face) in zip(
@@ -233,7 +233,7 @@ def init_gmsh():
     return gmsh
 
 
-def _mesh_brep(
+def mesh_brep(
     gmsh,
     min_mesh_size: float | None = None,
     max_mesh_size: float | None = None,
@@ -355,21 +355,21 @@ def mesh_to_vertices_and_triangles(
     return vertices, triangles_by_solid_by_face
 
 
-def _get_ids_from_assembly(assembly: cq.assembly.Assembly):
+def get_ids_from_assembly(assembly: cq.assembly.Assembly):
     ids = []
     for obj, name, loc, _ in assembly:
         ids.append(name)
     return ids
 
 
-def _get_ids_from_imprinted_assembly(solid_id_dict):
+def get_ids_from_imprinted_assembly(solid_id_dict):
     ids = []
     for id in list(solid_id_dict.values()):
         ids.append(id[0])
     return ids
 
 
-def _check_material_tags(material_tags, iterable_solids):
+def check_material_tags(material_tags, iterable_solids):
     if material_tags:
         if len(material_tags) != len(iterable_solids):
             msg = (
@@ -448,7 +448,7 @@ class MeshToDagmc:
 
         gmsh.finalize()
 
-        h5m_filename = _vertices_to_h5m(
+        h5m_filename = vertices_to_h5m(
             vertices=vertices,
             triangles_by_solid_by_face=triangles_by_solid_by_face,
             material_tags=material_tags,
@@ -503,6 +503,7 @@ class CadToDagmc:
             cq.assembly.Assembly | cq.occ_impl.shapes.Compound | cq.occ_impl.shapes.Solid
         ),
         material_tags: list[str] | None,
+        scale_factor: float = 1.0,
     ) -> int:
         """Loads the parts from CadQuery object into the model.
 
@@ -514,6 +515,10 @@ class CadToDagmc:
                 same order as the volumes in the geometry added (STP file and
                 CadQuery objects) and match the material tags used in the
                 neutronics code (e.g. OpenMC).
+            scale_factor: a scaling factor to apply to the geometry that can be
+                used to increase the size or decrease the size of the geometry.
+                Useful when converting the geometry to cm for use in neutronics
+                simulations.
 
         Returns:
             int: number of volumes in the stp file.
@@ -527,12 +532,17 @@ class CadToDagmc:
         else:
             iterable_solids = cadquery_object.val().Solids()
 
-        _check_material_tags(material_tags, iterable_solids)
+        if scale_factor == 1.0:
+            scaled_iterable_solids = iterable_solids
+        else:
+            scaled_iterable_solids = [part.scale(scale_factor) for part in iterable_solids]
+
+        check_material_tags(material_tags, scaled_iterable_solids)
         if material_tags:
             self.material_tags = self.material_tags + material_tags
-        self.parts = self.parts + iterable_solids
+        self.parts = self.parts + scaled_iterable_solids
 
-        return len(iterable_solids)
+        return len(scaled_iterable_solids)
 
     def export_unstructured_mesh_file(
         self,
@@ -603,7 +613,7 @@ class CadToDagmc:
 
         gmsh, _ = get_volumes(gmsh, imprinted_assembly, method=method, scale_factor=scale_factor)
 
-        gmsh = _mesh_brep(
+        gmsh = mesh_brep(
             gmsh=gmsh,
             min_mesh_size=min_mesh_size,
             max_mesh_size=max_mesh_size,
@@ -680,7 +690,7 @@ class CadToDagmc:
 
         gmsh, _ = get_volumes(gmsh, imprinted_assembly, method=method, scale_factor=scale_factor)
 
-        gmsh = _mesh_brep(
+        gmsh = mesh_brep(
             gmsh=gmsh,
             min_mesh_size=min_mesh_size,
             max_mesh_size=max_mesh_size,
@@ -751,7 +761,7 @@ class CadToDagmc:
         for part in self.parts:
             assembly.add(part)
 
-        original_ids = _get_ids_from_assembly(assembly)
+        original_ids = get_ids_from_assembly(assembly)
 
         # both id lists should be the same length as each other and the same
         # length as the self.material_tags
@@ -764,7 +774,7 @@ class CadToDagmc:
                 assembly
             )
 
-            scrambled_ids = _get_ids_from_imprinted_assembly(imprinted_solids_with_org_id)
+            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
@@ -773,7 +783,7 @@ class CadToDagmc:
             material_tags_in_brep_order = self.material_tags
             imprinted_assembly = assembly
 
-        _check_material_tags(material_tags_in_brep_order, self.parts)
+        check_material_tags(material_tags_in_brep_order, self.parts)
 
         gmsh = init_gmsh()
 
@@ -781,7 +791,7 @@ class CadToDagmc:
             gmsh, imprinted_assembly, method=method, scale_factor=scale_factor
         )
 
-        gmsh = _mesh_brep(
+        gmsh = mesh_brep(
             gmsh=gmsh,
             min_mesh_size=min_mesh_size,
             max_mesh_size=max_mesh_size,
@@ -798,7 +808,7 @@ class CadToDagmc:
         gmsh.finalize()
 
         # checks and fixes triangle fix_normals within vertices_to_h5m
-        return _vertices_to_h5m(
+        return vertices_to_h5m(
             vertices=vertices,
             triangles_by_solid_by_face=triangles_by_solid_by_face,
             material_tags=material_tags_in_brep_order,

{cad_to_dagmc-0.8.0 → cad_to_dagmc-0.8.2}/src/cad_to_dagmc.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: cad_to_dagmc
-Version: 0.8.0
+Version: 0.8.2
 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.8.0 → cad_to_dagmc-0.8.2}/tests/test_python_api.py

@@ -1,16 +1,16 @@
 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
 
+import cadquery as cq
+import gmsh
 import pymoab as mb
+import pytest
 from pymoab import core, types
 
+from cad_to_dagmc import CadToDagmc
+from cad_to_dagmc.core import check_material_tags
+
 
 def get_volumes_and_materials_from_h5m(filename: str) -> dict:
     """Reads in a DAGMC h5m file and uses PyMoab to find the volume ids with
@@ -214,8 +214,122 @@ def test_export_gmsh_mesh_file_handel_paths_folders_strings(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])
+        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)
+
+
+@pytest.mark.parametrize(
+    "scale_factor, expected_width",
+    [
+        (1, 10.0),
+        (2, 20.0),
+        (10, 100.0),
+    ],
+)
+def test_scaling_factor_when_adding_stp(scale_factor, expected_width):
+
+    c2d = CadToDagmc()
+    c2d.add_stp_file("tests/single_cube.stp", scale_factor=scale_factor)
+    c2d.export_gmsh_mesh_file(f"st_test_scaling_factor_{scale_factor}.msh")
+
+    gmsh.initialize()
+    gmsh.open(f"st_test_scaling_factor_{scale_factor}.msh")
+    _, node_coords, _ = gmsh.model.mesh.getNodes()
+
+    # Reshape the node coordinates into a 2D array
+    node_coords = node_coords.reshape(-1, 3)
+
+    # Calculate the bounding box
+    min_coords = node_coords.min(axis=0)
+    max_coords = node_coords.max(axis=0)
+
+    width_x = max_coords[0] - min_coords[0]
+    width_y = max_coords[1] - min_coords[1]
+    width_z = max_coords[2] - min_coords[2]
+
+    gmsh.finalize()
+
+    assert width_x == expected_width
+    assert width_y == expected_width
+    assert width_z == expected_width
+
+
+@pytest.mark.parametrize(
+    "scale_factor, expected_width",
+    [
+        (1, 10.0),
+        (2, 20.0),
+        (10, 100.0),
+    ],
+)
+def test_scaling_factor_when_adding_cq_object(scale_factor, expected_width):
+
+    box = cq.Workplane("XY").box(10, 10, 10)
+    c2d = CadToDagmc()
+    c2d.add_cadquery_object(box, scale_factor=scale_factor, material_tags=["mat1"])
+    c2d.export_gmsh_mesh_file(f"cq_test_scaling_factor_{scale_factor}.msh")
+
+    gmsh.initialize()
+    gmsh.open(f"cq_test_scaling_factor_{scale_factor}.msh")
+    _, node_coords, _ = gmsh.model.mesh.getNodes()
+
+    # Reshape the node coordinates into a 2D array
+    node_coords = node_coords.reshape(-1, 3)
+
+    # Calculate the bounding box
+    min_coords = node_coords.min(axis=0)
+    max_coords = node_coords.max(axis=0)
+
+    width_x = max_coords[0] - min_coords[0]
+    width_y = max_coords[1] - min_coords[1]
+    width_z = max_coords[2] - min_coords[2]
+
+    gmsh.finalize()
+
+    assert width_x == expected_width
+    assert width_y == expected_width
+    assert width_z == expected_width
+
+
+@pytest.mark.parametrize(
+    "scale_factor, expected_x_width, expected_y_width, expected_z_width",
+    [
+        (1, 20.0, 10.0, 10.0),
+        (2, 40.0, 20.0, 20.0),
+        (10, 200.0, 100.0, 100.0),
+    ],
+)
+def test_two_box_scaling_factor_when_adding_cq_object(
+    scale_factor, expected_x_width, expected_y_width, expected_z_width
+):
+
+    box = cq.Workplane("XY").box(10, 10, 10)
+    box2 = cq.Workplane("XY").moveTo(10, 0).box(10, 10, 10)
+    c2d = CadToDagmc()
+    c2d.add_cadquery_object(box, scale_factor=scale_factor, material_tags=["mat1"])
+    c2d.add_cadquery_object(box2, scale_factor=scale_factor, material_tags=["mat1"])
+    c2d.export_gmsh_mesh_file(f"cq_test_2_box_scaling_factor_{scale_factor}.msh")
+
+    gmsh.initialize()
+    gmsh.open(f"cq_test_2_box_scaling_factor_{scale_factor}.msh")
+    _, node_coords, _ = gmsh.model.mesh.getNodes()
+
+    # Reshape the node coordinates into a numpy 2D array
+    node_coords = node_coords.reshape(-1, 3)
+
+    # Calculate the bounding box
+    min_coords = node_coords.min(axis=0)
+    max_coords = node_coords.max(axis=0)
+
+    width_x = max_coords[0] - min_coords[0]
+    width_y = max_coords[1] - min_coords[1]
+    width_z = max_coords[2] - min_coords[2]
+
+    gmsh.finalize()
+
+    assert width_x == expected_x_width
+    assert width_y == expected_y_width
+    assert width_z == expected_z_width