SimulationSettings

class ansys.health.heart.settings.settings.SimulationSettings(mechanics: bool = True, electrophysiology: bool = True, fiber: bool = True, purkinje: bool = True, stress_free: bool = True)

Class for keeping track of settings.

Overview

Methods

save	Save simulation settings to disk.
load	Load simulation settings.
load_defaults	Load default simulation settings.
to_consistent_unit_system	Convert all settings to consistent unit-system [“MPa”, “mm”, “N”, “ms”, “g”].
get_mechanical_material	Load mechanical materials from settings.
get_ventricle_fiber_rotation	Get rotation angles from settings.

Special methods

__repr__

Represent object as list of relevant attribute names.

Import detail

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

Method detail

SimulationSettings.__repr__()

Represent object as list of relevant attribute names.

SimulationSettings.save(filename: pathlib.Path, remove_units: bool = False)

Save simulation settings to disk.

Parameters:

filenamepathlib.Path

Path to target .json or .yml file

remove_unitsbool, optional

Flag indicating whether to remove units before writing, by default False

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")
>>> assert settings.mechanics.analysis == settings1.mechanics.analysis
True

SimulationSettings.load_defaults()

Load default simulation settings.

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: 3000.0 millisecond
  dtmin: 10.0 millisecond
  dtmax: 10.0 millisecond
  dt_d3plot: 50.0 millisecond
  dt_icvout: 1.0 millisecond
  global_damping: 0.5 / 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

SimulationSettings.get_mechanical_material(required_type: Literal['isotropic', 'anisotropic'], ep_coupled=False) → ansys.health.heart.settings.material.material.Mat295

Load mechanical materials from settings.

Parameters:

required_typeLiteral['isotropic','anisotropic']

Type of required maerial

ep_coupledbool, optional

If MAT295 is coupled with EP simulation, by default False

Returns:

MAT295

material with parameters in settings

SimulationSettings.get_ventricle_fiber_rotation(method: Literal['LSDYNA', 'D-RBM']) → dict

Get rotation angles from settings.

Parameters:

methodLiteral["LSDYNA", "D

Fiber rule based methods

Returns:

dict

rotation angles alpha and beta