🐛 Fix optimised design example (#4159)

* 🐛 Fix optimised design example

* ✨ Add design materials file

* 🐛 Fix path

Author: je-cook

bluemira/materials/cache.py

@@ -95,7 +95,9 @@ def _d(p, name, initial_p):
             mod = p
             for n in name:
                 mod = _d(mod, n, initial_p)
-                if isinstance(mod, Material):
+                if mod is not None and (
+                    isinstance(mod, Material) or issubclass(mod, Material)
+                ):
                     return mod
         raise AttributeError(f"No such material: {name}")
 

examples/design/design_materials.py

@@ -0,0 +1,72 @@
+# SPDX-FileCopyrightText: 2021-present M. Coleman, J. Cook, F. Franza
+# SPDX-FileCopyrightText: 2021-present I.A. Maione, S. McIntosh
+# SPDX-FileCopyrightText: 2021-present J. Morris, D. Short
+#
+# SPDX-License-Identifier: LGPL-2.1-or-later
+
+"""Materials for design examples"""
+
+from matproplib.conditions import OperationalConditions
+from matproplib.converters.neutronics import OpenMCNeutronicConfig
+from matproplib.library.beryllium import Be12Ti
+from matproplib.library.fluids import Helium
+from matproplib.library.tungsten import PlanseeTungsten
+from matproplib.material import material, mixture
+from matproplib.properties.group import props
+
+from bluemira.materials.neutronics import make_KALOS_ACB_mat
+
+EUROFER_MAT = material(
+    name="eurofer",
+    elements={
+        "Fe": 0.9006,
+        "Cr": 0.0886,
+        "W182": 0.0108 * 0.266,
+        "W183": 0.0108 * 0.143,
+        "W184": 0.0108 * 0.307,
+        "W186": 0.0108 * 0.284,
+        "fraction_type": "mass",
+    },
+    properties=props(density=(7.78, "g/cm^3")),
+    converters=OpenMCNeutronicConfig(),
+)()
+HELIUM_MAT = Helium()
+
+TUNGSTEN_MAT = PlanseeTungsten()
+
+BB_FW_MATERIAL = mixture(
+    name="FW material",
+    materials=[
+        (TUNGSTEN_MAT, 2.0 / 27.0),
+        (EUROFER_MAT, 25.0 * 0.573 / 27.0),
+        (HELIUM_MAT, 25.0 * 0.427 / 27.0),
+    ],
+    fraction_type="volume",
+    mix_condition=OperationalConditions(temperature=673.15, pressure=8e6),
+    converters=OpenMCNeutronicConfig(material_id=101),
+)
+
+structural_fraction_vo = 0.128
+multiplier_fraction_vo = 0.493
+breeder_fraction_vo = 0.103
+helium_fraction_vo = 0.276
+li6_enrich_atomic = 0.6
+KALOS_ACB_MATERIAL = make_KALOS_ACB_mat(li6_enrich_atomic)
+
+BB_BZ_MATERIAL = mixture(
+    name="BZ material",
+    materials=[
+        (EUROFER_MAT, structural_fraction_vo),
+        (Be12Ti(), multiplier_fraction_vo),
+        (KALOS_ACB_MATERIAL, breeder_fraction_vo),
+        (HELIUM_MAT, helium_fraction_vo),
+    ],
+    fraction_type="volume",
+    mix_condition=OperationalConditions(temperature=673.15, pressure=8e6),
+    converters=OpenMCNeutronicConfig(
+        material_id=102,
+        enrichment=li6_enrich_atomic * 100,
+        enrichment_target="Li6",
+        enrichment_type="atomic",
+    ),
+)

examples/design/optimised_reactor.ex.py

@@ -36,6 +36,7 @@
 from bluemira.base.builder import Builder
 from bluemira.base.components import Component, PhysicalComponent
 from bluemira.base.designer import Designer
+from bluemira.base.file import get_bluemira_root
 from bluemira.base.logs import set_log_level
 from bluemira.base.look_and_feel import bluemira_print
 from bluemira.base.parameter_frame import Parameter, ParameterFrame
@@ -399,7 +400,12 @@ def __init__(self, reactor_params: OptimisedReactorParams):
         """Initialise the optimised reactor."""
         self.params = reactor_params
         super().__init__("OptimisedReactor", n_sectors=reactor_params.n_TF.value)
-        establish_material_cache(["matproplib"])
+        establish_material_cache([
+            Path(get_bluemira_root(), "examples", "design", "design_materials.py")
+            .resolve()
+            .as_posix(),
+            "matproplib",
+        ])
 
     def build_plasma(self):
         """Build the plasma component."""
@@ -448,8 +454,8 @@ def build_tf_coils(self, mat_name: str):
 )
 
 r.build_plasma()
-r.build_bb("Homogenised_HCPB_2015_v3_BZ")
-r.build_tf_coils("Toroidal_Field_Coil_2015")
+r.build_bb("BB_BZ_MATERIAL")
+r.build_tf_coils("EUROFER_MAT")
 
 major_radius = r.params.R_0.value * 100
 aspect_ratio = r.params.A.value