feat: allow unknown caps in model (#1261)

Co-authored-by: pyansys-ci-bot <[email protected]>

Author: mhoeijm

doc/source/changelog/1261.added.md

@@ -0,0 +1 @@
+Allow unknown caps in model

src/ansys/health/heart/models.py

@@ -1444,13 +1444,21 @@ def _update_cap_types(self):
                                 break
 
                         cap_name = split.replace("-plane", "").replace("-inlet", "")
-                        cap.type = CapType(cap_name)
 
-                        if "atrium" in part.name and (
-                            cap.type in [CapType.TRICUSPID_VALVE, CapType.MITRAL_VALVE]
-                        ):
-                            cap_name = cap_name + "-atrium"
-                            cap.type = CapType(cap.type.value + "-atrium")
+                        try:
+                            cap.type = CapType(cap_name)
+
+                            if "atrium" in part.name and (
+                                cap.type in [CapType.TRICUSPID_VALVE, CapType.MITRAL_VALVE]
+                            ):
+                                cap_name = cap_name + "-atrium"
+                                cap.type = CapType(cap.type.value + "-atrium")
+                        except ValueError:
+                            LOGGER.warning(
+                                f"Could not map cap name {cap_name} to CapType enum - default "
+                                "to unknown cap type."
+                            )
+                            cap.type = CapType.UNKNOWN
 
                         cap.name = cap_name
 

src/ansys/health/heart/parts.py

@@ -270,7 +270,15 @@ def _set_from_dict(
 
                 for cap_name, cap_id in part_data.get("caps", {}).items():
                     #! note that we assume cap name equals cap type here.
-                    cap = Cap(cap_name, cap_type=CapType(cap_name))
+                    try:
+                        cap_type = CapType(cap_name)
+                    except ValueError as e:
+                        LOGGER.warning(
+                            f"Invalid cap type: {cap_name}. {e}. Defaulting to UNKNOWN cap type."
+                        )
+                        cap_type = CapType.UNKNOWN
+
+                    cap = Cap(cap_name, cap_type=cap_type)
                     cap._mesh = mesh.get_surface(cap_id)
                     part.caps.append(cap)
 

src/ansys/health/heart/writer/laplace_writer.py

@@ -237,7 +237,10 @@ def _update_ra_tricuspid_nodeset(self, atrium: pv.UnstructuredGrid) -> None:
 
     def _update_atrial_caps_nodeset(self, atrium: pv.UnstructuredGrid) -> None:
         """Define nodesets for the caps."""
-        for cap in self.model.parts[0].caps:
+        # Only loop over caps that are mapped to nodeset IDs
+        caps = [cap for cap in self.model.parts[0].caps if cap.type in self._CAP_NODESET_MAP.keys()]
+
+        for cap in caps:
             # get node IDs for atrium mesh
             cap._mesh = self.model.mesh.get_surface(cap._mesh.id)
             ids_sub = np.where(np.isin(atrium["point_ids"], cap.global_node_ids_edge))[0]

tests/heart/test_parts.py

@@ -25,7 +25,7 @@
 import pyvista as pv
 
 from ansys.health.heart import __version__
-from ansys.health.heart.objects import Cap, Cavity, Mesh, SurfaceMesh
+from ansys.health.heart.objects import Cap, CapType, Cavity, Mesh, SurfaceMesh
 from ansys.health.heart.parts import (
     Artery,
     Atrium,
@@ -287,3 +287,51 @@ def test_get_element_ids_returns_empty_if_volume_id_missing(caplog):
     assert any(
         "Mesh does not contain '_volume-id' cell data." in m for m in caplog.text.splitlines()
     )
+
+
+def test_set_from_dict_caps_with_unknown_type():
+    """Test _set_from_dict can handle caps with unknown/invalid cap types."""
+    # Setup: create a test dictionary with an invalid cap type
+    part_name = "Left ventricle"
+    test_dict = {
+        part_name: {
+            "part-id": 42,
+            "part-type": "ventricle",
+            "surfaces": {
+                "Left ventricle endocardium": 1,
+                "Left ventricle epicardium": 2,
+            },
+            "_version": "0.15.dev0",
+            "caps": {
+                "unknown_cap_type": 100,  # This should trigger the unknown cap handling
+                "invalid-cap": 101,  # Another invalid cap type
+            },
+        }
+    }
+
+    # Create a mock mesh with the required surfaces and cap surfaces
+    mesh = _get_mock_mesh1()
+
+    # Add cap surfaces to the mesh for testing
+    from pyvista.examples import load_tetbeam
+
+    beam = load_tetbeam()
+    surface = beam.extract_surface()
+    mesh.add_surface(surface, name="unknown_cap_type", id=100)
+    mesh.add_surface(surface, name="invalid-cap", id=101)
+
+    # Act: reconstruct part from dictionary
+    part = Part._set_from_dict(test_dict, mesh=mesh)
+
+    # Assert: part should be created successfully
+    assert isinstance(part, Ventricle)
+    assert part.name == part_name
+    assert part.pid == 42
+
+    # Assert: caps should be created with UNKNOWN type
+    assert len(part.caps) == 2
+
+    for cap in part.caps:
+        assert cap.type == CapType.UNKNOWN
+        assert cap._mesh is not None
+        assert cap.name in ["unknown_cap_type", "invalid-cap"]