refactor: use pydantic-based modules for EP materials (#1242)

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

Author: mhoeijm

doc/source/changelog/1242.miscellaneous.md

@@ -0,0 +1 @@
+Use pydantic-based modules for materials

examples/preprocessor/demo-material_pr.py

@@ -35,9 +35,9 @@
 
 import matplotlib.pyplot as plt
 
-from ansys.health.heart.settings.material.cell_models import Tentusscher
+import ansys.health.heart.settings.material.cell_models as cell_models
 from ansys.health.heart.settings.material.curve import kumaraswamy_active
-from ansys.health.heart.settings.material.ep_material import EPMaterial
+import ansys.health.heart.settings.material.ep_material as ep_materials
 from ansys.health.heart.settings.material.material_pyd import (
     ACTIVE,
     ANISO,
@@ -133,10 +133,10 @@
 ###############################################################################
 # Create EP materials
 # ~~~~~~~~~~~~~~~~~~~
-ep_mat_active = EPMaterial.Active(
-    sigma_fiber=1, sigma_sheet=0.5, beta=140, cm=0.01, cell_model=Tentusscher()
+ep_mat_active = ep_materials.Active(
+    sigma_fiber=1, sigma_sheet=0.5, beta=140, cm=0.01, cell_model=cell_models.Tentusscher()
 )
-epinsulator = EPMaterial.Insulator()
+epinsulator = ep_materials.Insulator()
 
 # import pyvista as pv
 

examples/simulator/ep-mechanics-simulator-fullheart.py

@@ -50,7 +50,7 @@
 
 from ansys.health.heart.examples import get_preprocessed_fullheart
 import ansys.health.heart.models as models
-from ansys.health.heart.settings.material.ep_material import EPMaterial
+import ansys.health.heart.settings.material.ep_material as ep_materials
 from ansys.health.heart.settings.material.material import ISO, Mat295
 from ansys.health.heart.simulator import DynaSettings, EPMechanicsSimulator
 
@@ -133,7 +133,7 @@
 ring.meca_material = stiff_iso
 
 # Assign the default EP material
-ring.ep_material = EPMaterial.Active()
+ring.ep_material = ep_materials.Active()
 
 # plot the mesh
 simulator.model.plot_mesh()

src/ansys/health/heart/models.py

@@ -54,7 +54,7 @@
 )
 from ansys.health.heart.pre.input import _InputModel
 import ansys.health.heart.pre.mesher as mesher
-from ansys.health.heart.settings.material.ep_material import EPMaterial
+import ansys.health.heart.settings.material.ep_material as ep_materials
 from ansys.health.heart.settings.material.material import (
     ISO,
     Mat295,
@@ -1689,7 +1689,7 @@ def create_stiff_ventricle_base(
         part.active = False
         part.meca_material = stiff_material
         # assign default EP material as for ventricles
-        part.ep_material = EPMaterial.Active()
+        part.ep_material = ep_materials.Active()
 
         return part
 
@@ -1830,7 +1830,7 @@ def _create_atrioventricular_isolation(self) -> None | anatomy.Part:
         # Assign a new part ID to the isolation part
         isolation.fiber = True
         isolation.active = False
-        isolation.ep_material = EPMaterial.Insulator()
+        isolation.ep_material = ep_materials.Insulator()
 
         return isolation
 
@@ -1891,7 +1891,7 @@ def create_atrial_stiff_ring(self, radius: float = 2) -> None | anatomy.Part:
         ring.fiber = False
         ring.active = False
         # assign default EP material
-        ring.ep_material = EPMaterial.Active()
+        ring.ep_material = ep_materials.Active()
 
         return ring
 
@@ -1932,7 +1932,7 @@ def __init__(self, working_directory: pathlib.Path | str = None) -> None:
         self.pulmonary_artery.fiber = False
         self.pulmonary_artery.active = False
 
-        self.aorta.ep_material = EPMaterial.Insulator()
-        self.pulmonary_artery.ep_material = EPMaterial.Insulator()
+        self.aorta.ep_material = ep_materials.Insulator()
+        self.pulmonary_artery.ep_material = ep_materials.Insulator()
 
         super().__init__(working_directory=working_directory)

src/ansys/health/heart/parts.py

@@ -36,7 +36,7 @@
 
 from ansys.health.heart import LOG as LOGGER, __version__
 from ansys.health.heart.objects import Cap, CapType, Cavity, Mesh, Point, SurfaceMesh
-from ansys.health.heart.settings.material.ep_material import EPMaterial
+import ansys.health.heart.settings.material.ep_material as ep_materials
 from ansys.health.heart.settings.material.material import MechanicalMaterialModel
 
 
@@ -140,7 +140,7 @@ def __init__(self, name: str = None, part_type: _PartType = _PartType.UNDEFINED)
         self.meca_material: MechanicalMaterialModel = MechanicalMaterialModel.DummyMaterial()
         """Material model to assign in the simulator."""
 
-        self.ep_material: EPMaterial = EPMaterial.DummyMaterial()
+        self.ep_material: ep_materials.EPMaterialModel = None
         """EP material model to assign in the simulator."""
 
     def __str__(self) -> str:
@@ -336,7 +336,7 @@ def __init__(self, name: str = None) -> None:
 
         self.wall: SurfaceMesh = SurfaceMesh(name="{0} wall".format(self.name))
 
-        self.ep_material = EPMaterial.Insulator()
+        self.ep_material = ep_materials.Insulator()
         """EP material model for the artery part."""
 
 

src/ansys/health/heart/pre/conduction_path.py

@@ -33,7 +33,7 @@
 
 from ansys.health.heart import LOG as LOGGER
 from ansys.health.heart.objects import Mesh, SurfaceMesh
-from ansys.health.heart.settings.material.ep_material import EPMaterial
+from ansys.health.heart.settings.material.ep_material import EPMaterialModel, Insulator
 
 
 class ConductionPathType(Enum):
@@ -84,7 +84,7 @@ def __init__(
         id: int,
         is_connected: np.ndarray,
         relying_surface: pv.PolyData,
-        material: EPMaterial = EPMaterial.DummyMaterial(),
+        material: EPMaterialModel | Insulator | None = None,
         up_path: ConductionPath | None = None,
         down_path: ConductionPath | None = None,
     ):
@@ -103,7 +103,7 @@ def __init__(
             Mask array of points connected to the solid mesh.
         relying_surface : pv.PolyData
             Surface mesh that the conduction path relies on.
-        material : EPMaterial, default: EPMaterial.DummyMaterial()
+        material : EPMaterial, default: None
             EP Material property.
         up_path : ConductionPath | None, default: None
             Upstream conduction path. Its closest point connects to the first point of this path.