m3h3 package

Submodules

m3h3.setup_parameters module

This module handles parameters for cardiac simulations.

class m3h3.setup_parameters.Parameters(label, **kwargs)

Bases: sphinx.ext.autodoc.importer._MockObject

This class handles parameters for cardiac simulations. It inherits from dolfin’s Parameters class.

set_default_parameters()

Sets default simulation parameters.

set_electro_parameters(parameters=None)

Sets parameters for electrophysiology problems and solver. If argument is None, default parameters are applied.

set_fluid_parameters(parameters=None)

Sets parameters for fluid mechanics problems and solver. If argument is None, default parameters are applied.

set_porous_parameters(parameters=None)

Sets parameters for porous mechanics problems and solver. If argument is None, default parameters are applied.

set_solid_parameters(parameters=None)

Sets parameters for solid mechanics problems and solver. If argument is None, default parameters are applied.

class m3h3.setup_parameters.Physics

Bases: enum.Enum

This Enum contains physics descriptors for cardiac simulations.

ELECTRO = 'Electro'

FLUID = 'Fluid'

POROUS = 'Porous'

SOLID = 'Solid'

has_value = <bound method Physics.has_value of <enum 'Physics'>>

m3h3.setup_parameters.set_dolfin_compiler_parameters()

Sets dolfin parameters to speed up the compiler.

Module contents