carputils.model.conductivity.ConductivityRegion Class Reference

Defines an electrical conductivity region. More...

Inheritance diagram for carputils.model.conductivity.ConductivityRegion:

Public Member Functions
def	__init__ (self, IDs=[], name=None, g_il=0.174, g_it=0.019, g_in=0.019, g_el=0.625, g_et=0.236, g_en=0.236, g_bath=None)
def	isotropic (cls, IDs=[], name=None, cond=0.1)
	Define an isotropic conductivity region. More...
def	passive (cls, IDs=[], name=None, cond=0.0002)
	Define an electrically passive (very low conducivity) region. More...
def	bath (cls, IDs=[], name=None, g_bath=1.0)
	Define an isotropic conductivity for a non-myocardium domain. More...
def	eikonal (self, vel=None, vel_l=None, vel_t=None, vel_n=None)
	Set eikonal conduction velocities for this region in mm/s. More...
def	opts (self)

Static Public Attributes
string	PRM_ARRAY = 'gregion'
string	PRM_LENGTH = 'num_gregions'

Detailed Description

Defines an electrical conductivity region.

Args IDs list The material tags in this region name str, optional A short descriptive name for this region g_il float, optional Intracellular longitudinal conductivity g_it float, optional Intracellular transverse conductivity g_in float, optional Intracellular sheet-normal conductivity g_el float, optional Extracellular longitudinal conductivity g_et float, optional Extracellular transverse conductivity g_en float, optional Extracellular sheet-normal conductivity g_bath float, optional Isotropic conductivity for non-myocardium domain (if set, g_* are ignored)

Constructor & Destructor Documentation

__init__()

def carputils.model.conductivity.ConductivityRegion.__init__	(		self,
			IDs = [],
			name = None,
			g_il = 0.174,
			g_it = 0.019,
			g_in = 0.019,
			g_el = 0.625,
			g_et = 0.236,
			g_en = 0.236,
			g_bath = None
	)

Member Function Documentation

bath()

def carputils.model.conductivity.ConductivityRegion.bath	(		cls,
			IDs = [],
			name = None,
			g_bath = 1.0
	)

Define an isotropic conductivity for a non-myocardium domain.

Parameters

IDs	list The material tags in this region
name	str, optional A short descriptive name for this region
g_bath	float, optional Isotropic conductivity in non-myocardium domain

eikonal()

def carputils.model.conductivity.ConductivityRegion.eikonal	(		self,
			vel = None,
			vel_l = None,
			vel_t = None,
			vel_n = None
	)

Set eikonal conduction velocities for this region in mm/s.

The function returns self to enable chaining with the other classmethods.

Parameters

vel	float, optional Isotropic conduction velocity (sets all directions equally, bypassing the other values)
vel_l	float, optional Longitudinal conduction velocity
vel_t	float, optional Transverse conduction velocity
vel_n	float, optional Sheet-normal conduction velocity

isotropic()

def carputils.model.conductivity.ConductivityRegion.isotropic	(		cls,
			IDs = [],
			name = None,
			cond = 0.1
	)

Define an isotropic conductivity region.

Parameters

IDs	list The material tags in this region
name	str, optional A short descriptive name for this region
cond	float, optional The conductivity to use

opts()

def carputils.model.conductivity.ConductivityRegion.opts

(

self

)

passive()

def carputils.model.conductivity.ConductivityRegion.passive	(		cls,
			IDs = [],
			name = None,
			cond = 0.0002
	)

Define an electrically passive (very low conducivity) region.

Parameters

IDs	list The material tags in this region
name	str, optional A short descriptive name for this region

Member Data Documentation

PRM_ARRAY

string carputils.model.conductivity.ConductivityRegion.PRM_ARRAY = 'gregion'

static

PRM_LENGTH

string carputils.model.conductivity.ConductivityRegion.PRM_LENGTH = 'num_gregions'

static

---

The documentation for this class was generated from the following file:

• carputils/model/conductivity.py