The ``simulator.py`` module
===========================

.. py:module:: ansys.health.heart.simulator


Summary
-------
















.. py:currentmodule:: simulator
.. tab-set::




    .. tab-item:: Classes

        .. list-table::
          :header-rows: 0
          :widths: auto


          * - :py:obj:`~ansys.health.heart.simulator.BaseSimulator`
            - Base class for the simulator.


          * - :py:obj:`~ansys.health.heart.simulator.EPSimulator`
            - EP (electrophysiology) simulator.


          * - :py:obj:`~ansys.health.heart.simulator.MechanicsSimulator`
            - Mechanics simulator with imposed active stress.


          * - :py:obj:`~ansys.health.heart.simulator.EPMechanicsSimulator`
            - Coupled EP-mechanics simulator with computed electrophysiology.





    .. tab-item:: Functions

        .. list-table::
          :header-rows: 0
          :widths: auto


          * - :py:obj:`~run_lsdyna`
            - Standalone function for running LS-DYNA.









.. toctree::
   :titlesonly:
   :maxdepth: 1
   :hidden:

    <span class="nf nf-cod-symbol_class"></span> BaseSimulator</api/ansys/health/heart/simulator/BaseSimulator>
    <span class="nf nf-cod-symbol_class"></span> EPSimulator</api/ansys/health/heart/simulator/EPSimulator>
    <span class="nf nf-cod-symbol_class"></span> MechanicsSimulator</api/ansys/health/heart/simulator/MechanicsSimulator>
    <span class="nf nf-cod-symbol_class"></span> EPMechanicsSimulator</api/ansys/health/heart/simulator/EPMechanicsSimulator>









Description
-----------

Simulator module.

Options for simulation:

- EP-only

  - With/without fibers
  - With/without Purkinje

- Electro-mechanics

  - Simplified EP (imposed activation)
  - Coupled electro-mechanics

..
    !! processed by numpydoc !!






Module detail
-------------

.. py:function:: run_lsdyna(path_to_input: pathlib, settings: ansys.health.heart.settings.settings.DynaSettings = None, simulation_directory: pathlib = None)

   
   Standalone function for running LS-DYNA.


   :Parameters:

       **path_to_input** : :obj:`Path`
           Input file for LS-DYNA.

       **settings** : :obj:`DynaSettings`, default: :data:`python:None`
           LS-DYNA settings, such as path to the executable file, executable type,
           and platform.

       **simulation_directory** : :obj:`Path`, default: :data:`python:None`
           Directory for the simulation.














   ..
       !! processed by numpydoc !!