Components¶
- class components.SimpleComponent(classname, json_object)¶
Base class for simple components. These are intended to be the smallest functional unit of a single material. They may comprise multiple volumes/ may not be ‘simple’ geometrically.
- add_to_subcomponents(subcomponents: list[hypnos.generic_classes.CubitInstance])¶
Add geometries to self.subcomponents
- Parameters
subcomponents (CubitInstance | list[CubitInstance]) – geometry/ies to add
- as_bodies()¶
Convert geometries to references to their owning bodies
- as_volumes()¶
Convert any references to bodies in the subcomponents to references to their composing volumes
- extract_parameters(parameters) dict¶
Get values of geometrical parameters.
- Parameters
parameters (list | dict) – list - get corresponding values of parameters, i.e. returned dict will look like {key : value} dict - {search_key : output_key}, i.e. returned dict will look like {output_key : value}
- Returns
key-value pairs as described above
- Return type
dict
- get_geometries() list[hypnos.generic_classes.CubitInstance]¶
Get contained geometries
- Returns
list of geometries
- Return type
list[CubitInstance]
- abstract make_geometry() list[hypnos.generic_classes.CubitInstance]¶
Make this instance in cubit
- Returns
list of created geometries
- Return type
list[CubitInstance]
- volume_id_string()¶
Space-separated string of volume IDs.
- Returns
volume ID string
- Return type
str
- class components.ExternalComponent(*args: Any, **kwargs: Any)¶
Track components imported externally