EPMechanicsSimulator#

class ansys.health.heart.simulator.EPMechanicsSimulator(model: ansys.health.heart.models.FullHeart | ansys.health.heart.models.FourChamber | ansys.health.heart.models.BiVentricle | ansys.health.heart.models.LeftVentricle, dyna_settings: ansys.health.heart.settings.settings.DynaSettings, simulation_directory: pathlib = '')#

Bases: EPSimulator, MechanicsSimulator

Coupled EP-mechanics simulator with computed electrophysiology.

Overview#

simulate

Launch the main electro-mechanical simulation.

Import detail#

from ansys.health.heart.simulator import EPMechanicsSimulator

Method detail#

EPMechanicsSimulator.simulate(folder_name: str = 'ep_meca', zerop_folder: str | None = None, auto_post: bool = True, extra_k_files: list[str] | None = None)#

Launch the main electro-mechanical simulation.

Parameters:
folder_namestr, default: 'main-mechanics'

Simulation folder name.

zerop_folderstr | None, default: None

Folder containing stress-free simulation. If None, the zeropressure folder under the root directory is used.

auto_postbool, default: True

Whether to run postprocessing scripts.

extra_k_fileslist[str], default: None

User-defined k files.