Adding materials to DEMO

bluemira/builders/coil_supports.py

@@ -42,6 +42,7 @@
     sweep_shape,
 )
 from bluemira.geometry.wire import BluemiraWire
+from bluemira.materials.cache import get_cached_material
 from bluemira.optimisation import OptimisationProblem
 from bluemira.utilities.tools import floatify
 
@@ -283,7 +284,13 @@ def build_xyz(
         # Finally, make the floor block
         shape_list.append(self._make_floor_block(floatify(v1.x), floatify(v4.x)))
         shape = boolean_fuse(shape_list)
-        component = PhysicalComponent("ITER-like gravity support", shape)
+        component = PhysicalComponent(
+            "ITER-like gravity support",
+            shape,
+            material=get_cached_material(
+                self.build_config.get("material", {}).get("GS")
+            ),
+        )
         apply_component_display_options(component, color=BLUE_PALETTE["TF"][2])
         return component
 
@@ -341,7 +348,13 @@ def build_xz(self, xyz):
         result = slice_shape(xyz.shape, BluemiraPlane(axis=(0, 1, 0)))
         result.sort(key=lambda wire: -wire.length)
         face = BluemiraFace(result)
-        component = PhysicalComponent(self.name, face)
+        component = PhysicalComponent(
+            self.name,
+            face,
+            material=get_cached_material(
+                self.build_config.get("material", {}).get("PF ICS")
+            ),
+        )
         apply_component_display_options(component, color=BLUE_PALETTE["TF"][2])
         return component
 
@@ -866,7 +879,13 @@ def build_xz(self):
         components = []
         for i, ois_profile in enumerate(self.ois_xz_profiles):
             face = BluemiraFace(ois_profile)
-            component = PhysicalComponent(f"{self.OIS_XZ} {i}", face)
+            component = PhysicalComponent(
+                f"{self.OIS_XZ} {i}",
+                face,
+                material=get_cached_material(
+                    self.build_config.get("material", {}).get(self.OIS_XZ)
+                ),
+            )
             apply_component_display_options(component, color=BLUE_PALETTE["TF"][2])
             components.append(component)
         return components

bluemira/builders/cryostat.py

@@ -27,6 +27,7 @@
 from bluemira.display.palettes import BLUE_PALETTE
 from bluemira.geometry.face import BluemiraFace
 from bluemira.geometry.tools import make_polygon
+from bluemira.materials.cache import get_cached_material
 
 if TYPE_CHECKING:
     from bluemira.base.parameter_frame.typed import ParameterFrameLike
@@ -209,4 +210,7 @@ def build_xyz(
             self.params.n_TF.value,
             BLUE_PALETTE["CR"][0],
             degree,
+            material=get_cached_material(
+                self.build_config.get("material", {}).get("Body"),
+            ),
         )

bluemira/builders/divertor.py

@@ -23,6 +23,7 @@
     pattern_revolved_silhouette,
 )
 from bluemira.display.palettes import BLUE_PALETTE
+from bluemira.materials.cache import get_cached_material
 
 if TYPE_CHECKING:
     from bluemira.base.builder import BuildConfig
@@ -95,7 +96,11 @@ def build_xyz(self, degree: float = 360.0) -> list[PhysicalComponent]:
 
         segments = []
         for no, shape in enumerate(shapes):
-            segment = PhysicalComponent(f"{self.SEGMENT_PREFIX}_{no}", shape)
+            segment = PhysicalComponent(
+                f"{self.SEGMENT_PREFIX}_{no}",
+                shape,
+                material=get_cached_material(self.build_config.get("material", {})),
+            )
             apply_component_display_options(segment, BLUE_PALETTE[self.DIV][no])
             segments.append(segment)
 

bluemira/builders/pf_coil.py

@@ -23,6 +23,7 @@
 from bluemira.geometry.face import BluemiraFace
 from bluemira.geometry.parameterisations import PictureFrame
 from bluemira.geometry.tools import make_circle, offset_wire, revolve_shape
+from bluemira.materials.cache import get_cached_material
 
 if TYPE_CHECKING:
     from bluemira.base.builder import BuildConfig
@@ -120,16 +121,34 @@ def build_xz(self, shape: BluemiraWire) -> list[PhysicalComponent]:
         """
         Build the xz cross-section of the PF coil.
         """
-        wp = PhysicalComponent(self.WINDING_PACK, BluemiraFace(shape))
+        wp = PhysicalComponent(
+            self.WINDING_PACK,
+            BluemiraFace(shape),
+            material=get_cached_material(
+                self.build_config.get("material", {}).get(self.WINDING_PACK)
+            ),
+        )
         idx = CoilType(self.params.ctype.value).value - 1
         apply_component_display_options(wp, color=BLUE_PALETTE["PF"][idx])
 
         ins_shape = offset_wire(shape, self.params.tk_insulation.value)
-        ins = PhysicalComponent(self.GROUND_INSULATION, BluemiraFace([ins_shape, shape]))
+        ins = PhysicalComponent(
+            self.GROUND_INSULATION,
+            BluemiraFace([ins_shape, shape]),
+            material=get_cached_material(
+                self.build_config.get("material", {}).get(self.GROUND_INSULATION)
+            ),
+        )
         apply_component_display_options(ins, color=BLUE_PALETTE["PF"][3])
 
         cas_shape = offset_wire(ins_shape, self.params.tk_casing.value)
-        casing = PhysicalComponent(self.CASING, BluemiraFace([cas_shape, ins_shape]))
+        casing = PhysicalComponent(
+            self.CASING,
+            BluemiraFace([cas_shape, ins_shape]),
+            material=get_cached_material(
+                self.build_config.get("material", {}).get(self.CASING)
+            ),
+        )
         apply_component_display_options(casing, color=BLUE_PALETTE["PF"][2])
         return [wp, ins, casing]
 
@@ -159,7 +178,7 @@ def build_xyz(
         components = []
         for c in xz_components:
             shape = revolve_shape(c.shape, degree=sector_degree * n_sectors)
-            c_xyz = PhysicalComponent(c.name, shape)
+            c_xyz = PhysicalComponent(c.name, shape, material=c.material)
             apply_component_display_options(
                 c_xyz, color=c.plot_options.face_options["color"]
             )

bluemira/builders/radiation_shield.py

@@ -26,6 +26,7 @@
 from bluemira.display.palettes import BLUE_PALETTE
 from bluemira.geometry.face import BluemiraFace
 from bluemira.geometry.tools import boolean_cut, boolean_fuse, make_polygon, offset_wire
+from bluemira.materials.cache import get_cached_material
 
 if TYPE_CHECKING:
     from bluemira.base.builder import BuildConfig
@@ -130,4 +131,5 @@ def build_xyz(
             self.params.n_TF.value,
             BLUE_PALETTE[self.RS][0],
             degree,
+            material=get_cached_material(self.build_config.get("material", {})),
         )

bluemira/builders/thermal_shield.py

@@ -38,7 +38,7 @@
     make_polygon,
     offset_wire,
 )
-from bluemira.materials.cache import Void
+from bluemira.materials.cache import Void, get_cached_material
 
 if TYPE_CHECKING:
     from bluemira.base.builder import BuildConfig
@@ -159,7 +159,12 @@ def build_xyz(
             self.params.n_TF.value,
             [BLUE_PALETTE["TS"][0], (0, 0, 0)],
             degree,
-            material=[None, Void("vacuum")],
+            material=[
+                get_cached_material(
+                    self.build_config.get("material", {}).get(self.VVTS)
+                ),
+                Void("vacuum"),
+            ],
         )
 
 
@@ -312,5 +317,10 @@ def build_xyz(
             [BLUE_PALETTE["TS"][0], (0, 0, 0)],
             degree,
             enable_sectioning=True,
-            material=[None, Void("vacuum")],
+            material=[
+                get_cached_material(
+                    self.build_config.get("material", {}).get(self.CRYO_TS)
+                ),
+                Void("vacuum"),
+            ],
         )

bluemira/builders/tools.py

@@ -172,6 +172,7 @@ def circular_pattern_component(
                         f"with search index: {search_index_i}"
                     )
                 phy_comp.shape = shape
+                phy_comp.material = comp.material
 
     return sectors
 

bluemira/materials/cache.py

@@ -12,12 +12,13 @@
 
 import copy
 import json
-from typing import Any, ClassVar
+from typing import TYPE_CHECKING, Any, ClassVar
 
 from bluemira.materials.material import (
     BePebbleBed,
     Liquid,
     MassFractionMaterial,
+    Material,
     MaterialsError,
     NbSnSuperconductor,
     NbTiSuperconductor,
@@ -27,6 +28,9 @@
 )
 from bluemira.materials.mixtures import HomogenisedMixture
 
+if TYPE_CHECKING:
+    from pathlib import Path
+
 
 class MaterialCache:
     """
@@ -56,6 +60,22 @@
             mat_class.__name__: mat_class for mat_class in self.default_classes
         }
 
+    _instance: MaterialCache | None = None
+
+    @classmethod
+    def get_instance(cls) -> MaterialCache:
+        """
+        Get the singleton instance of the MaterialCache.
+
+        Returns
+        -------
+        MaterialCache
+            The singleton instance of the MaterialCache.
+        """
+        if cls._instance is None:
+            cls._instance = MaterialCache()
+        return cls._instance
+
     def __getattr__(self, value: str):
         """Allow attribute access to cached materials
 
@@ -79,14 +99,11 @@
         ----------
         path:
             The path to the file from which to load the materials.
-
-        Returns
-        -------
-        The dictionary containing the loaded materials.
         """
         with open(path) as fh:
             mats_dict = json.load(fh)
-        return {name: self.load_from_dict(name, mats_dict) for name in mats_dict}
+        for name in mats_dict:
+            self.load_from_dict(name, mats_dict)
 
     def load_from_dict(
         self, mat_name: str, mats_dict: dict[str, Any], *, overwrite: bool = True
@@ -181,3 +198,55 @@
                 "exists in the cache."
             )
         self._material_dict[mat_name] = mat
+
+
+def establish_material_cache(materials_json_paths: list[Path | str]):
+    """
+    Load the material data from the provided json files into the global material cache
+    instance.
+
+    This instance can be accessed using the `MaterialCache.get_instance()`
+    function.
+
+    Parameters
+    ----------
+    materials_json_paths:
+        A list of paths to the data files to load into the material cache.
+
+    Returns
+    -------
+    The material cache.
+    """
+    cache = MaterialCache.get_instance()
+    for path in materials_json_paths:
+        cache.load_from_file(path)
+    return cache
+
+
+def get_cached_material(
+    material_name: str | None, cache: MaterialCache | None = None
+) -> Material | None:
+    """
+    Get the named material from the MaterialCache.
+
+    If cache is None, the global cache instance is used.
+
+    Parameters
+    ----------
+    material_name:
+        The name of the material to retrieve from the dictionary
+    cache:
+        The material cache to retrieve the material from. By default the global cache.
+
+    Returns
+    -------
+    The requested material.
+    """
+    # mateiral name can also be an empty dict
+    # sometimes because of the dict default value used
+    # when calling .get
+    if not (material_name and isinstance(material_name, str)):
+        return None
+    if cache is None:
+        cache = MaterialCache.get_instance()
+    return cache.get_material(material_name)