refactor: simplify default material models (#1256)

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

Author: mhoeijm

doc/source/changelog/1256.miscellaneous.md

@@ -0,0 +1 @@
+Simplify default material models

src/ansys/health/heart/exceptions.py

@@ -85,3 +85,7 @@ class MissingMaterialError(ValueError):
 
     def __init__(self, part_name: str, material_type: Literal["EP", "Mechanical"]):
         super().__init__(f"Part {part_name} has no {material_type} material assigned.")
+
+
+class PartAlreadyExistsError(ValueError):
+    """Exception raised when a part already exists."""

src/ansys/health/heart/models.py

@@ -37,7 +37,7 @@
 import yaml
 
 from ansys.health.heart import LOG as LOGGER
-from ansys.health.heart.exceptions import InvalidHeartModelError
+from ansys.health.heart.exceptions import InvalidHeartModelError, PartAlreadyExistsError
 from ansys.health.heart.landmarks import LandMarks
 from ansys.health.heart.objects import (
     Cap,
@@ -409,7 +409,7 @@ def create_part_by_ids(
 
         if name in [p.name for p in self.parts]:
             LOGGER.error(f"Failed to create {name}. Name already exists.")
-            return None
+            raise PartAlreadyExistsError(f"Part {name} already exists.")
 
         new_part_id = self.mesh._unused_volume_id
 

src/ansys/health/heart/settings/defaults/electrophysiology.py

@@ -77,15 +77,15 @@
     "percent_mid": Quantity(0.41, "dimensionless"),
 }
 default_beam_material_eikonal = {
-    "sigma": Quantity(1, "mm/ms"),  # mm/ms in case of eikonal model
+    "sigma_fiber": Quantity(1, "mm/ms"),  # mm/ms in case of eikonal model
     "beta": Quantity(140, "1/mm"),
     "cm": Quantity(0.001, "uF/mm^2"),  # uF/mm^2
     "lambda": Quantity(0.2, "dimensionless"),
 }
 
 # Create monodomain defaults by copying eikonal and changing relevant fields
 default_beam_material_monodomain = default_beam_material_eikonal.copy()
-default_beam_material_monodomain["sigma"] = Quantity(1, "mS/mm")  # mS/mm
+default_beam_material_monodomain["sigma_fiber"] = Quantity(1, "mS/mm")  # mS/mm
 default_myocardium_material_monodomain = default_myocardium_material_eikonal.copy()
 default_myocardium_material_monodomain["sigma_fiber"] = Quantity(0.5, "mS/mm")  # mS/mm
 default_myocardium_material_monodomain["sigma_sheet"] = Quantity(0.1, "mS/mm")  # mS/mm

src/ansys/health/heart/settings/material/ep_material.py

@@ -38,7 +38,7 @@ class EPSolverType(Enum):
     REACTION_EIKONAL = "ReactionEikonal"
 
 
-class EPMaterialModel(BaseModel):  # EM MAT 003
+class EPMaterialModel(BaseModel):
     """Base class for all EP material models."""
 
     sigma_fiber: Optional[float] = None
@@ -59,38 +59,39 @@ def check_inputs(self):
         return self
 
 
-class Insulator(BaseModel):  # EM MAT 001
+class Insulator(EPMaterialModel):
     """Insulator material."""
 
     sigma_fiber: float = 0.0
+    sigma_sheet_normal: float = 0.0
+    sigma_sheet: float = 0.0
     cm: float = 0.0
     beta: float = 0.0
 
 
-# solver type should be managed from global settings and not in material settings.
+class Passive(EPMaterialModel):
+    """Hold data for a passive EP material."""
+
+
 class Active(EPMaterialModel):
-    """Hold data for EP material."""
+    """Hold data for an active EP material."""
 
-    sigma_fiber: Optional[float] = None
-    sigma_sheet: Optional[float] = None
-    sigma_sheet_normal: Optional[float] = None
+    # NOTE: an active EP material has a cell model associated with it.
 
     cell_model: Tentusscher = Field(default_factory=lambda: Tentusscher())
 
 
 class ActiveBeam(Active):
     """Hold data for beam active EP material."""
 
-    sigma_fiber: float = 1.0
     # TODO: replace by TentusscherEndo
     cell_model: Tentusscher = Tentusscher()
-    pmjres: float = 0.001
 
+    @model_validator(mode="after")
+    def check_inputs(self):
+        """Post init method."""
+        # ActiveBeam is by definition isotropic, so remove sheet conductivities if set
+        self.sigma_sheet is None
+        self.sigma_sheet_normal is None
 
-# A Passive material model is actually the same as the EPMaterialModel
-class Passive(EPMaterialModel):
-    """Hold data for EP passive material."""
-
-    # sigma_fiber: Optional[float] = None
-    # sigma_sheet: Optional[float] = None
-    # sigma_sheet_normal: Optional[float] = None
+        return self