cad-to-dagmc 0.7.7__py3-none-any.whl → 0.8.1__py3-none-any.whl

_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.7.7'
-__version_tuple__ = version_tuple = (0, 7, 7)
+__version__ = version = '0.8.1'
+__version_tuple__ = version_tuple = (0, 8, 1)

cad_to_dagmc/core.py

@@ -235,10 +235,11 @@ def init_gmsh():
 
 def _mesh_brep(
     gmsh,
-    min_mesh_size: float = 1,
-    max_mesh_size: float = 10,
+    min_mesh_size: float | None = None,
+    max_mesh_size: float | None = None,
     mesh_algorithm: int = 1,
     dimensions: int = 2,
+    set_size: dict[int, float] | None = None,
 ):
     """Creates a conformal surface meshes of the volumes in a Brep file using Gmsh.
 
@@ -252,15 +253,49 @@ def _mesh_brep(
             gmsh.option.setNumber("Mesh.Algorithm", mesh_algorithm)
         dimensions: The number of dimensions, 2 for a surface mesh 3 for a
             volume mesh. Passed to gmsh.model.mesh.generate()
+        set_size: a dictionary of volume ids (int) and target mesh sizes
+            (floats) to set for each volume, passed to gmsh.model.mesh.setSize.
 
     Returns:
         The resulting gmsh object and volumes
     """
+    if min_mesh_size and max_mesh_size:
+        if min_mesh_size > max_mesh_size:
+            raise ValueError(
+                f"min_mesh_size must be less than or equal to max_mesh_size. Currently min_mesh_size is set to {min_mesh_size} and max_mesh_size is set to {max_mesh_size}"
+            )
+
+    if min_mesh_size:
+        gmsh.option.setNumber("Mesh.MeshSizeMin", min_mesh_size)
+
+    if max_mesh_size:
+        gmsh.option.setNumber("Mesh.MeshSizeMax", max_mesh_size)
 
     gmsh.option.setNumber("Mesh.Algorithm", mesh_algorithm)
-    gmsh.option.setNumber("Mesh.MeshSizeMin", min_mesh_size)
-    gmsh.option.setNumber("Mesh.MeshSizeMax", max_mesh_size)
     gmsh.option.setNumber("General.NumThreads", 0)  # Use all available cores
+
+    if set_size:
+        volumes = gmsh.model.getEntities(3)
+        available_volumes = [volume[1] for volume in volumes]
+        print("volumes", volumes)
+        for volume_id, size in set_size.items():
+            if volume_id in available_volumes:
+                size = set_size[volume_id]
+                if isinstance(size, dict):
+                    # TODO face specific mesh sizes
+                    pass
+                else:
+                    boundaries = gmsh.model.getBoundary(
+                        [(3, volume_id)], recursive=True
+                    )  # dim must be set to 3
+                    print("boundaries", boundaries)
+                    gmsh.model.mesh.setSize(boundaries, size)
+                    print(f"Set size of {size} for volume {volume_id}")
+            else:
+                raise ValueError(
+                    f"volume ID of {volume_id} set in set_sizes but not found in available volumes {volumes}"
+                )
+
     gmsh.model.mesh.generate(dimensions)
 
     return gmsh
@@ -468,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.
 
@@ -479,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.
@@ -492,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,
@@ -508,6 +553,7 @@ class CadToDagmc:
         method: str = "file",
         scale_factor: float = 1.0,
         imprint: bool = True,
+        set_size: dict[int, float] | None = None,
     ):
         """
         Exports an unstructured mesh file in VTK format for use with openmc.UnstructuredMesh.
@@ -539,6 +585,9 @@ class CadToDagmc:
                 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.
+
 
         Returns:
         --------
@@ -570,6 +619,7 @@ class CadToDagmc:
             max_mesh_size=max_mesh_size,
             mesh_algorithm=mesh_algorithm,
             dimensions=3,
+            set_size=set_size,
         )
 
         # makes the folder if it does not exist
@@ -589,13 +639,14 @@ class CadToDagmc:
     def export_gmsh_mesh_file(
         self,
         filename: str = "mesh.msh",
-        min_mesh_size: float = 1,
-        max_mesh_size: float = 5,
+        min_mesh_size: float | None = None,
+        max_mesh_size: float | None = None,
         mesh_algorithm: int = 1,
         dimensions: int = 2,
         method: str = "file",
         scale_factor: float = 1.0,
         imprint: bool = True,
+        set_size: dict[int, float] | None = None,
     ):
         """Saves a GMesh msh file of the geometry in either 2D surface mesh or
         3D volume mesh.
@@ -622,6 +673,8 @@ class CadToDagmc:
                 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.
         """
 
         assembly = cq.Assembly()
@@ -643,6 +696,7 @@ class CadToDagmc:
             max_mesh_size=max_mesh_size,
             mesh_algorithm=mesh_algorithm,
             dimensions=dimensions,
+            set_size=set_size,
         )
 
         # makes the folder if it does not exist
@@ -662,13 +716,14 @@ class CadToDagmc:
     def export_dagmc_h5m_file(
         self,
         filename: str = "dagmc.h5m",
-        min_mesh_size: float = 1,
-        max_mesh_size: float = 5,
+        min_mesh_size: float | None = None,
+        max_mesh_size: float | None = None,
         mesh_algorithm: int = 1,
         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,
     ) -> str:
         """Saves a DAGMC h5m file of the geometry
 
@@ -695,6 +750,8 @@ class CadToDagmc:
                 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.
 
         Returns:
             str: the DAGMC filename saved
@@ -739,6 +796,7 @@ class CadToDagmc:
             min_mesh_size=min_mesh_size,
             max_mesh_size=max_mesh_size,
             mesh_algorithm=mesh_algorithm,
+            set_size=set_size,
         )
 
         dims_and_vol_ids = volumes

{cad_to_dagmc-0.7.7.dist-info → cad_to_dagmc-0.8.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: cad_to_dagmc
-Version: 0.7.7
+Version: 0.8.1
 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
@@ -35,7 +35,7 @@ Requires-Dist: vtk; extra == "tests"
 [![PyPI](https://img.shields.io/pypi/v/cad_to_dagmc?color=brightgreen&label=pypi&logo=grebrightgreenen&logoColor=green)](https://pypi.org/project/cad_to_dagmc/)
 
 
-A minimal package that converts CAD geometry to [DAGMC](https://github.com/svalinn/DAGMC/) compatible meshes
+A minimal package that converts CAD geometry to [DAGMC](https://github.com/svalinn/DAGMC/) (h5m) files, [unstructured mesh](https://docs.openmc.org/en/latest/pythonapi/generated/openmc.UnstructuredMesh.html) files (vtk) and Gmsh (msh) files ready for use in neutronics simulations.
 
 cad-to-dagmc can create DAGMC compatible:
 - surface meshes / faceted geometry / triangular meshes
@@ -43,23 +43,23 @@ cad-to-dagmc can create DAGMC compatible:
 
 cad-to-dagmc can convert the following in to DAGMC compatible meshes:
 - STEP files
-- CadQuery objects
+- CadQuery objects (in memory)
 - Gmsh meshes
 
-Options include
-- Ability to scale the output mesh (e.g from meters to cm)
-- Ability to skip imprinting stage
-- Specify meshing parameters for finer or coarser meshes or change the mesh algorithm
-- Ability to specify a material tag for the DAGMC implicit complement
-- Pass objects from CadQuery in memory (without writting to disk)
+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
+- 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)
+- Ability to tag the DAGMC implicit complement material using the ```implicit_complement_material_tag``` argument
+- Selected different Gmesh mesh algorithms (defaults to 1) using the ```mesh_algorithm``` argument
+- Pass CadQuery objects in memory for fast transfer of geometry using the ```method``` argument
+- Easy to install with [pip](https://pypi.org/project/cad-to-dagmc/) and [Conda/Mamba](https://anaconda.org/conda-forge/cad_to_dagmc)
+- Well tested both with [CI unit tests](https://github.com/fusion-energy/cad_to_dagmc/tree/main/tests), integration tests and the CSG [Model Benchmark Zoo](https://github.com/fusion-energy/model_benchmark_zoo).
+- Compatible with [Paramak](https://github.com/fusion-energy/paramak) geometry for fusion simulations.
 
-cad-to-dagmc aims to produce DAGMC compatible h5m and vtk files from CAD geometry is intended to convert [STEP](http://www.steptools.com/stds/step/) files, [CadQuery](https://cadquery.readthedocs.io) or [Gmsh]([https://cadquery.readthedocs.io](https://gmsh.info/)) meshes objects to a [DAGMC](https://github.com/svalinn/DAGMC/) compatible h5m file or a DAGMC compatible Unstruuctre vtk file.
-
-The resulting DAGMC geometry can then be used for simulations in [OpenMC](https://github.com/openmc-dev/openmc/) or [other supported codes](https://svalinn.github.io/DAGMC/).
-
-This package is tested with [pytest tests](https://github.com/fusion-energy/cad_to_dagmc/tree/main/tests) and also the DAGMC geometry made with this package is compared to simulation carried out with native constructive solid geometry, see [Model Benchmark Zoo](https://github.com/fusion-energy/model_benchmark_zoo) for more details.
-
-Also checkout these other software projects that also create DAGMC geometry [CAD-to-OpenMC](https://github.com/openmsr/CAD_to_OpenMC), [Stellarmesh](https://github.com/Thea-Energy/stellarmesh) and [Coreform Cubit](https://coreform.com/products/coreform-cubit/)
 
 # Installation options
 
@@ -176,3 +176,7 @@ Installing one of the package dependancies (Gmsh) with pip appears to result in
 For examples showing creation of DAGMC h5m files, vtk files and usage within OpenMC transport code see the [examples folder](https://github.com/fusion-energy/cad_to_dagmc/tree/main/examples)
 
 For more examples see the CAD tasks in the [neutronics-workshop](https://github.com/fusion-energy/neutronics-workshop) and [model benchmark zoo](https://github.com/fusion-energy/model_benchmark_zoo)
+
+# Related software
+
+Also checkout these other software projects that also create DAGMC geometry [CAD-to-OpenMC](https://github.com/openmsr/CAD_to_OpenMC), [Stellarmesh](https://github.com/Thea-Energy/stellarmesh) and [Coreform Cubit](https://coreform.com/products/coreform-cubit/).

cad_to_dagmc-0.8.1.dist-info/RECORD

@@ -0,0 +1,8 @@
+_version.py,sha256=Z8fNqmfsoA07nbVEewR90wZCgaN6eyDwPwgtgc2KIak,411
+cad_to_dagmc/__init__.py,sha256=fskHUTyCunSpnpJUvBfAYjx4uwDKXHTTiMP6GqnFRf0,494
+cad_to_dagmc/core.py,sha256=DbxXCaVEIiJxulRJlatoQg-yce37SS9Dx914Gt91qKY,31883
+cad_to_dagmc-0.8.1.dist-info/LICENSE,sha256=B8kznH_777JVNZ3HOKDc4Tj24F7wJ68ledaNYeL9sCw,1070
+cad_to_dagmc-0.8.1.dist-info/METADATA,sha256=AQ41vcWt_gHdZFL_rh7n28O5CheNftqa-FWdaVWvhjI,8700
+cad_to_dagmc-0.8.1.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+cad_to_dagmc-0.8.1.dist-info/top_level.txt,sha256=zTi8C64SEBsE5WOtPovnxhOzt-E6Oc5nC3RW6M_5aEA,22
+cad_to_dagmc-0.8.1.dist-info/RECORD,,

cad_to_dagmc-0.7.7.dist-info/RECORD

@@ -1,8 +0,0 @@
-_version.py,sha256=OFzKtYPiFCCvMWwWVN3UDiEwBAcWMPY3Atug8b0zLFk,411
-cad_to_dagmc/__init__.py,sha256=fskHUTyCunSpnpJUvBfAYjx4uwDKXHTTiMP6GqnFRf0,494
-cad_to_dagmc/core.py,sha256=5xWb8oGRs6318CcUI_PADsF1vJjqzYPVNAQ8vKGjZE4,29063
-cad_to_dagmc-0.7.7.dist-info/LICENSE,sha256=B8kznH_777JVNZ3HOKDc4Tj24F7wJ68ledaNYeL9sCw,1070
-cad_to_dagmc-0.7.7.dist-info/METADATA,sha256=rGXnqaOFnpf4mXTn-BN9uXi8d3dwBt7SzcP5Ornd18o,8362
-cad_to_dagmc-0.7.7.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-cad_to_dagmc-0.7.7.dist-info/top_level.txt,sha256=zTi8C64SEBsE5WOtPovnxhOzt-E6Oc5nC3RW6M_5aEA,22
-cad_to_dagmc-0.7.7.dist-info/RECORD,,