fix: modify beam mesh doc strings (#1030)

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

Author: 3 people

doc/source/changelog/1030.fixed.md

@@ -0,0 +1 @@
+modify beam mesh doc strings

src/ansys/health/heart/objects.py

@@ -1066,16 +1066,14 @@ class _ConductionType(Enum):
 
 
 class _BeamsMesh(Mesh):
-    """Mesh class: inherits from pyvista UnstructuredGrid.
+    """Mesh class: inherits from Mesh.
 
     Notes
     -----
-    This class inherits from pyvista.UnstructuredGrid and adds additional
-    attributes and convenience methods for enhanced functionality. E.g. we use _volume_id,
-    _surface_id and _line_id cell arrays to keep track of "labeled" selections of
-    cells. _volume_id is used to group 3D volume cells together.
-    Any non 3D volume cell is labeled as numpy.nan. Similarly 2D and 1D cells are tracked
-    through _surface_id and _line_id respectively.
+    This class inherits from Mesh and adds additional
+    attributes and convenience methods for enhanced functionality. Lines of the same component are
+    tracked as _line_id, connections to the volume mesh are tracked using the pointdata field
+    _is-connected.
     """
 
     def __init__(self, *args):
@@ -1168,6 +1166,8 @@ def add_lines(self, lines: pv.PolyData, id: int = None, name: str = None):
             PolyData representation of the lines to add
         id : int
             ID of the surface to be added. This id will be tracked as "_line-id"
+        name: str
+            Name of the lines to add
         """
         if not id:
             return None

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

@@ -227,7 +227,9 @@ def compute_his_conduction(self, beam_length: float = 1.5) -> tuple[_BeamsMesh,
         )
         new_nodes = self.m.mesh.points[nodes]
         new_nodes = _refine_line(new_nodes, beam_length=beam_length)
-        new_nodes[0] = self.m.conduction_system.get_lines_by_name("SAN_to_AVN").points[-1]
+        new_nodes[0] = self.m.conduction_system.get_lines_by_name(
+            _ConductionType.SAN_AVN.value
+        ).points[-1]
         beamnet = pv.lines_from_points(new_nodes)
         id = self.m.conduction_system.get_unique_lines_id()
         self.m.conduction_system.add_lines(lines=beamnet, id=id, name=_ConductionType.HIS.value)