`ConductionPath`#

class ansys.health.heart.pre.conduction_path.ConductionPath(name: ConductionPathType, mesh: ansys.health.heart.objects.Mesh, id: int, is_connected: numpy.ndarray, relying_surface: pyvista.PolyData, material: ansys.health.heart.settings.material.ep_material.EPMaterial = EPMaterial.DummyMaterial(), up_path: ConductionPath | None = None, down_path: ConductionPath | None = None)#: Conduction path class.

Overview#

Methods

plot

Plot the conduction path with underlying surface.

Properties

`up_path`	Get upstream conduction path.
`down_path`	Get downstream conduction path.
`length`	Length of the conduction path.

Attributes

`name`
`mesh`
`id`
`is_connected`
`relying_surface`
`ep_material`

Static methods

`create_from_keypoints`	Create a conduction path on a base mesh through a set of keypoints.
`create_from_k_file`	Build conduction path from LS-DYNA k-file.

Import detail#

from ansys.health.heart.pre.conduction_path import ConductionPath

Property detail#

property ConductionPath.up_path: ConductionPath | None#: Get upstream conduction path.

property ConductionPath.down_path: ConductionPath | None#: Get downstream conduction path.

property ConductionPath.length#: Length of the conduction path.

Attribute detail#

ConductionPath.name#

ConductionPath.mesh#

ConductionPath.id#

ConductionPath.is_connected#

ConductionPath.relying_surface#

ConductionPath.ep_material#

Method detail#

ConductionPath.plot()#: Plot the conduction path with underlying surface.

static ConductionPath.create_from_keypoints(name: ConductionPathType, keypoints: list[numpy.ndarray], id: int, base_mesh: pyvista.PolyData | pyvista.UnstructuredGrid, connection: Literal['none', 'first', 'last', 'all'] = 'none', line_length: float | None = 1.5) → ConductionPath#

Create a conduction path on a base mesh through a set of keypoints.

Parameters:

nameConductionPathType: Name of the conduction path.
keypointslist[np.ndarray]: Keypoints used to construct the path on the base mesh.
idint: ID of the conduction path.
base_meshpv.PolyData | pv.UnstructuredGrid: Base mesh where the conductionn path is created. If PolyData, then the result is a geodesic path on the surface. If pv.UnstructuredGrid, then the result the shortest path in the solid.
connectionLiteral["none", "first", "last", "all"]
, default: “none”: Describes how the path is connected to the solid mesh.
line_lengthfloat | None, default: 1.5: Length of line element in case of refinement.

Returns:

ConductionPath: Conduction path.

static ConductionPath.create_from_k_file(name: ConductionPathType, k_file: str, id: int, base_mesh: pyvista.PolyData, model, merge_apex: bool = True) → ConductionPath#

Build conduction path from LS-DYNA k-file.

Parameters:

nameConductionPathType: Conduction path name.
k_filestr: Path to LS-DYNA k-file.
idint: ID of the conduction path.
base_meshpv.PolyData: Surface mesh that the conduction path is relying on.
modelHeartModel: HeartModel object.
merge_apexbool, default: True: Whether to merge the apex node with the solid mesh.

Returns:

ConductionPath: Conduction path.