Feat/exposure of material names

src/ansys/dpf/composites/_composite_model_impl.py

@@ -144,6 +144,25 @@ def material_operators(self) -> MaterialOperators:
         """Material operators."""
         return self._material_operators
 
+    @property
+    def material_names(self) -> Dict[str, int]:
+        """
+        Material name to DPF material ID map.
+
+        Can be used to filter analysis plies or element layers.
+        """
+        helper_op = dpf.Operator("composite::materials_container_helper")
+        helper_op.inputs.materials_container(self._material_operators.material_provider.outputs)
+        string_field = helper_op.outputs.material_names()
+        material_ids = string_field.scoping.ids
+
+        names = {}
+        for mat_id in material_ids:
+            names[string_field.data[string_field.scoping.index(mat_id)]] = mat_id
+
+        return names
+
+
     @_deprecated_composite_definition_label
     def get_mesh(self, composite_definition_label: Optional[str] = None) -> MeshedRegion:
         """Get the underlying DPF meshed region.

src/ansys/dpf/composites/_composite_model_impl_2023r2.py

@@ -193,6 +193,15 @@ def material_operators(self) -> MaterialOperators:
         """Material operators."""
         return self._material_operators
 
+    @property
+    def material_names(self) -> Dict[str, int]:
+        """Material ID to name map"""
+        raise NotImplementedError(
+            "material_names is not implemented"
+            " for this version of DPF. Please upgrade to 7.0 (2024 R1)"
+            " or later."
+        )
+
     def get_layup_operator(self, composite_definition_label: Optional[str] = None) -> Operator:
         """Get the lay-up operator.
 

src/ansys/dpf/composites/composite_model.py

@@ -106,6 +106,11 @@ def material_operators(self) -> MaterialOperators:
         """Material operators."""
         return self._implementation.material_operators
 
+    @property
+    def material_names(self) -> Dict[str, int]:
+        """Material ID to name map"""
+        return self._implementation.material_names
+
     def get_mesh(self, composite_definition_label: Optional[str] = None) -> MeshedRegion:
         """Get the underlying DPF meshed region.
 

tests/composite_model_test.py

@@ -83,6 +83,17 @@ def test_basic_functionality_of_composite_model(dpf_server, data_files, distribu
 
     assert [ply["id"] for ply in sampling_point.analysis_plies] == analysis_ply_ids
 
+    ref_material_names = {
+       'Epoxy Carbon UD (230 GPa) Prepreg': 3,
+       'Epoxy Carbon Woven (230 GPa) Wet': 2,
+       'Honeycomb': 4,
+       'Structural Steel': 1
+    }
+    mat_names = composite_model.material_names
+    assert len(mat_names) == len(ref_material_names)
+    for mat_name, dpf_mat_id in ref_material_names.items():
+        assert mat_names[mat_name] == dpf_mat_id
+
     timer.add("After getting properties")
 
     timer.summary()