66 allow custom classes to utilise the geometrymakerparse json method

examples/3custom_component.json

@@ -0,0 +1,8 @@
+{
+    "class": "CustomComponent",
+    "material": "material_name",
+    "geometry": {
+        "length": 5,
+        "height": 7.931
+    }
+}

examples/3custom_component.py

@@ -0,0 +1,26 @@
+from hypnos.components import SimpleComponent
+from hypnos.geometry import create_brick
+from hypnos.geometry_maker import GeometryMaker
+
+
+class CustomComponent(SimpleComponent):
+    def __init__(self, params):
+        super().__init__("custom", params)
+
+    def check_sanity(self):
+        length = self.geometry["length"]
+        height = self.geometry["height"]
+        if length < 0 or height < 0:
+            raise ValueError("parameters must be positive")
+
+    def make_geometry(self):
+        length = self.geometry["length"]
+        height = self.geometry["height"]
+        brick = create_brick({"dimensions": [length, length, height]})
+        return brick
+
+
+maker = GeometryMaker([CustomComponent])
+maker.file_to_tracked_geometry("3custom_component.json")
+maker.tetmesh()
+maker.export(rootname="custom_geometry")

examples/sample_blanket.json

@@ -1,5 +1,5 @@
 {
-    "class": "HCPB_blanket",
+    "class": "HCPBBlanket",
     "geometry": {
         "pin spacing": 135,
         "pin vertical offset": 0,
@@ -23,7 +23,7 @@
     },
     "components": {
         "pin": {
-            "class": "pin",
+            "class": "PinAssembly",
             "material": {
                 "cladding": "EUROFER",
                 "pressure tube": "EUROFER",
@@ -57,7 +57,7 @@
             }
         },
         "first_wall": {
-            "class": "first_wall",
+            "class": "FirstWallComponent",
             "material": "Tungsten",
             "geometry": {
                 "inner width": 1480,
@@ -78,7 +78,7 @@
             }
         },
         "front_rib": {
-            "class": "front_rib",
+            "class": "FrontRib",
             "geometry": {
                 "thickness": 30,
                 "side channel width": 10,
@@ -87,7 +87,7 @@
             }
         },
         "back_rib": {
-            "class": "back_rib",
+            "class": "BackRib",
             "geometry": {
                 "thickness": 60,
                 "side channel width": 10,
@@ -96,7 +96,7 @@
             }
         },
         "coolant_outlet_plenum": {
-            "class": "coolant_outlet_plenum",
+            "class": "CoolantOutletPlenum",
             "geometry": {
                 "length": 120,
                 "width": 1000,

examples/sample_blanket_ring.json

@@ -1,5 +1,5 @@
 {
-    "class": "blanket_ring",
+    "class": "BlanketRingAssembly",
     "geometry": {
         "minimum radius": 580
     },

examples/sample_blanket_shell.json

@@ -1,5 +1,5 @@
 {
-    "class": "blanket_shell",
+    "class": "BlanketShellAssembly",
     "geometry": {
         "pin spacing": 135,
         "vertical offset": 0,

examples/sample_first_wall.json

@@ -1,5 +1,5 @@
 {
-    "class": "first_wall",
+    "class": "FirstWallComponent",
     "material": "Tungsten",
     "geometry": {
         "inner width": 1480,

examples/sample_mini_blanket.json

@@ -1,13 +1,13 @@
 {
-    "class": "blanket_shell",
+    "class": "BlanketShellAssembly",
     "geometry": {
         "pin spacing": 135,
         "vertical offset": 0,
         "horizontal offset": 0
     },
     "components": {
         "first_wall": {
-            "class": "first_wall",
+            "class": "FirstWallComponent",
             "material": "Tungsten",
             "geometry": {
                 "inner width": 480,
@@ -19,7 +19,7 @@
             }
         },
         "pin": {
-            "class": "pin",
+            "class": "PinAssembly",
             "material": {
                 "cladding": "Steel",
                 "pressure tube": "Steel",

examples/sample_morphology.json

@@ -1,10 +1,10 @@
 [
     {
-        "class": "neutron_test_facility",
+        "class": "NeutronTestFacility",
         "morphology": "overlap",
         "components": [
             {
-                "class" : "source",
+                "class" : "SourceAssembly",
                 "filepath": "./dummy_source.stp",
                 "group": "neutron_source",
                 "manufacturer": "blobcorp",
@@ -15,10 +15,10 @@
             },    
 
             {
-                "class": "room",
+                "class": "RoomAssembly",
                 "components": [
                     {
-                        "class": "surrounding_walls",
+                        "class": "SurroundingWallsComponent",
                         "material": "SS",
                         "air": "some_gas",
                         "geometry": {
@@ -28,7 +28,7 @@
 
                     },
                     {
-                        "class": "wall",
+                        "class": "WallComponent",
                         "material": "SS",
                         "geometry": {
                             "thickness": 5,

examples/sample_pin.json

@@ -1,5 +1,5 @@
 {
-    "class": "pin",
+    "class": "PinAssembly",
     "material": {
         "cladding": "EUROFER",
         "pressure tube": "EUROFER",

src/hypnos/assemblies.py

@@ -40,7 +40,6 @@
 from hypnos.geometry import Vertex, arctan
 from hypnos.cubit_functions import to_bodies
 from hypnos.constants import (
-    CLASS_MAPPING,
     NEUTRON_TEST_FACILITY_REQUIREMENTS,
     ROOM_REQUIREMENTS,
     BLANKET_REQUIREMENTS,
@@ -412,7 +411,7 @@ def __init__(self, json_object):
         # Take out any walls from component list
         json_walls = []
         for json_component in component_list:
-            if json_component["class"] == "wall":
+            if json_component["class"] == "WallComponent":
                 json_walls.append(json_component)
                 component_list.remove(json_component)
         json_object["components"] = component_list
@@ -869,17 +868,17 @@ def setup_assembly(self):
 
     def __add_component_attributes(self):
         for component in self.component_list:
-            if component["class"] == "first_wall":
+            if component["class"] == "FirstWallComponent":
                 self.first_wall_geometry = component["geometry"]
                 self.first_wall_material = component["material"]
-            elif component["class"] == "pin":
+            elif component["class"] == "PinAssembly":
                 self.breeder_materials = component["material"]
                 self.breeder_geometry = component["geometry"]
-            elif component["class"] == "front_rib":
+            elif component["class"] == "FrontRib":
                 self.front_ribs_geometry = component["geometry"]
-            elif component["class"] == "back_rib":
+            elif component["class"] == "BackRib":
                 self.back_ribs_geometry = component["geometry"]
-            elif component["class"] == "coolant_outlet_plenum":
+            elif component["class"] == "CoolantOutletPlenum":
                 self.cop_geometry = component["geometry"]
 
     def __dict_with_height(self):
@@ -1129,10 +1128,8 @@ def get_all_geometries_from_components(component_list) -> list[CubitInstance]:
     for component in component_list:
         if isinstance(component, CubitInstance):
             instances.append(component)
-        elif isinstance(component, SimpleComponent):
-            instances += component.subcomponents
-        elif isinstance(component, GenericComponentAssembly):
-            instances += component.get_all_geometries()
+        elif isinstance(component, ComponentBase):
+            instances += component.get_geometries()
     return instances
 
 
@@ -1187,8 +1184,24 @@ def construct(json_object: dict, *args):
 
     Returns
     -------
-    SimpleComponent | GenericComponentAssembly
+    ComponentBase
         Instantiated python class
     '''
-    constructor = globals()[CLASS_MAPPING[json_object["class"]]]
+    constructor = classdict(ComponentBase)[json_object["class"]]
     return constructor(json_object, *args)
+
+
+# it take so long to run :(
+def classdict(cls):
+    '''Find all subclasses recursively.
+
+    Returns
+    -------
+    dict
+        {"Class": Class}
+    '''
+    return_dict = {}
+    for subcls in cls.__subclasses__():
+        return_dict[subcls.__name__] = subcls
+        return_dict.update(classdict(subcls))
+    return return_dict

src/hypnos/components.py

@@ -68,13 +68,6 @@ def classname(self, new_classname):
     def classname(self):
         del self._classname
 
-    @classmethod
-    def from_classname(cls, classname, params):
-        for toplvl in cls.__subclasses__():
-            for construct_lvl in toplvl.__subclasses__():
-                if construct_lvl.classname == classname:
-                    return construct_lvl(params)
-
     def check_sanity(self):
         '''Check whether the parameters supplied to this instance are physical
         '''

src/hypnos/constants.py

@@ -8,43 +8,17 @@
 '''
 
 # required components for assemblies to be generated
-NEUTRON_TEST_FACILITY_REQUIREMENTS = ["room", "source"]
-BLANKET_REQUIREMENTS = ["breeder", "structure"]
-ROOM_REQUIREMENTS = ["blanket", "surrounding_walls"]
-BLANKET_SHELL_REQUIREMENTS = ["first_wall", "pin"]
+NEUTRON_TEST_FACILITY_REQUIREMENTS = ["RoomAssembly", "SourceAssembly"]
+BLANKET_REQUIREMENTS = ["BreederComponent", "StructureComponent"]
+ROOM_REQUIREMENTS = ["BlanketComponent", "SurroundingWallsComponent"]
+BLANKET_SHELL_REQUIREMENTS = ["FirstWallComponent", "PinAssembly"]
 HCPB_BLANKET_REQUIREMENTS = [
-    "first_wall",
-    "pin",
-    "front_rib",
-    "back_rib",
-    "coolant_outlet_plenum"
+    "FirstWallComponent",
+    "PinAssembly",
+    "FrontRib",
+    "BackRib",
+    "CoolantOutletPlenum"
     ]
 
-# LEGACY - classes according to what make_geometry subfunction(?) needs to be called
-BLOB_CLASSES = ["complex", "breeder", "structure", "air"]
-ROOM_CLASSES = ["surrounding_walls"]
-WALL_CLASSES = ["wall"]
-
 # LEGACY - currently only supports exclusive, inclusive, and overlap
 FACILITY_MORPHOLOGIES = ["exclusive", "inclusive", "overlap", "wall"]
-
-# mapping from json class names to python class names
-CLASS_MAPPING = {
-    "complex": "ComplexComponent",
-    "external": "ExternalComponentAssembly",
-    "source": "SourceAssembly",
-    "neutron_test_facility": "NeutronTestFacility",
-    "blanket": "BlanketAssembly",
-    "room": "RoomAssembly",
-    "surrounding_walls": "SurroundingWallsComponent",
-    "breeder": "BreederComponent",
-    "structure": "StructureComponent",
-    "pin": "PinAssembly",
-    "cladding": "CladdingComponent",
-    "pressure_tube": "PressureTubeComponent",
-    "multiplier": "MultiplierComponent",
-    "first_wall": "FirstWallComponent",
-    "blanket_shell": "BlanketShellAssembly",
-    "blanket_ring": "BlanketRingAssembly",
-    "HCPB_blanket": "HCPBBlanket"
-}