SimulationSettings

class ansys.health.heart.settings.settings.SimulationSettings(mechanics: bool = True, electrophysiology: bool = True, fiber: bool = True, fiber_method: Literal['LSDYNA', 'D-RBM'] = 'LSDYNA', purkinje: bool = True, stress_free: bool = True)

Class for keeping track of settings.

Attributes are conditionally created based on initialization parameters. All parameters default to True, so all attributes exist by default.

Overview

Methods

save	Save simulation settings to disk.
load	Load simulation settings.
load_defaults	Load default simulation settings using Pydantic model initialization.
to_consistent_unit_system	Convert all settings to consistent unit-system [“MPa”, “mm”, “N”, “ms”, “g”].

Attributes

mechanics
electrophysiology
fibers
atrial_fibers
purkinje
stress_free

Special methods

__repr__

Represent object as list of relevant attribute names.

Import detail

from ansys.health.heart.settings.settings import SimulationSettings

Attribute detail

SimulationSettings.mechanics: Mechanics

SimulationSettings.electrophysiology: Electrophysiology

SimulationSettings.fibers: FibersBRBM | FibersDRBM

SimulationSettings.atrial_fibers: AtrialFiber

SimulationSettings.purkinje: Purkinje

SimulationSettings.stress_free: ZeroPressure

Method detail

SimulationSettings.__repr__()

Represent object as list of relevant attribute names.

Returns:

str

String representation showing the class name and active settings attribute names.

Examples

>>> settings = SimulationSettings()
>>> print(repr(settings))
SimulationSettings
  mechanics
  electrophysiology
  fibers
  atrial_fibers
  purkinje
  stress_free

SimulationSettings.save(filename: pathlib.Path)

Save simulation settings to disk.

Parameters:

filenamepathlib.Path

Path to target .json or .yml file

Examples

Create examples settings with default values.

>>> from ansys.health.heart.settings.settings import SimulationSettings
>>> settings = SimulationSettings()
>>> settings.load_defaults()
>>> settings.save("my_settings.yml")

SimulationSettings.load(filename: pathlib.Path)

Load simulation settings.

Parameters:

filenamepathlib.Path

Path to yaml or json file.

Examples

Create examples settings with default values.

>>> from ansys.health.heart.settings.settings import SimulationSettings
>>> settings = SimulationSettings()
>>> settings.load_defaults()
>>> settings.save("my_settings.yml")

Load settings in second SimulationSettings object.

>>> settings1 = SimulationSettings()
>>> settings1.load("my_settings.yml")
>>> print(
...     "True" if settings.mechanics.analysis == settings1.mechanics.analysis else "False"
... )
True

SimulationSettings.load_defaults()

Load default simulation settings using Pydantic model initialization.

This method properly initializes all settings with default values using Pydantic’s built-in validation and type conversion capabilities.

Examples

Create examples settings with default values.

Load module >>> from ansys.health.heart.settings.settings import SimulationSettings

Instantiate settings object.

>>> settings = SimulationSettings()
>>> settings.load_defaults()
>>> settings.mechanics.analysis
Analysis:
  end_time: 800.0 millisecond
  dtmin: 5.0 millisecond
  dtmax: 5.0 millisecond
  dt_d3plot: 20.0 millisecond
  dt_icvout: 5.0 millisecond
  global_damping: 0.1 / millisecond

SimulationSettings.to_consistent_unit_system()

Convert all settings to consistent unit-system [“MPa”, “mm”, “N”, “ms”, “g”].

Examples

Convert to the consistent unit system [“MPa”, “mm”, “N”, “ms”, “g”].

Import necessary modules >>> from ansys.health.heart.settings.settings import SimulationSettings >>> from pint import Quantity

Instantiate settings >>> settings = SimulationSettings() >>> settings.mechanics.analysis.end_time = Quantity(1, “s”) >>> settings.to_consistent_unit_system() >>> settings.mechanics.analysis.end_time