add docstrings to new MagnetCoil method

svalinn · Jan 29, 2025 · 289c4a7 · 289c4a7
1 parent 0fa2477
commit 289c4a7
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/parastell/magnet_coils.py b/parastell/magnet_coils.py
@@ -98,6 +98,9 @@ def export_mesh(self, mesh_filename="magnet_mesh", export_dir=""):
         )
 
     def add_solids_to_cad_to_dagmc(self, dagmc_model):
+        """Add the magnet solids to a cad_to_dagmc model with the magnet
+        material tag.
+        """
         for solid in self.coil_solids:
             dagmc_model.add_cadquery_object(
                 solid, material_tags=[self.mat_tag]
@@ -400,6 +403,7 @@ def __init__(
             self.__setattr__(name, kwargs[name])
 
     def get_cq_solids(self):
+        """Load the provided geometry into cadquery for use with cad_to_dagmc."""
         self.coil_solids = (
             cq.importers.importStep(str(self.geometry_file)).val().Solids()
         )