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)

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	opts (self)

Public Member Functions inherited from carputils.model.general.RegionMixin
def	__init__ (self, IDs=[], name=None, args, kwargs)

def	opts (self)
	Generator that yields field name - value pairs for the command line. More...

Public Member Functions inherited from carputils.model.general.AbstractModelComponent
def	__init__ (self, fields)

def	opts (self)
	Generator that yields field name - value pairs for the command line. More...

def	opts_formatted (self, index)
	Return the command line options for this model component. More...

Static Public Attributes
string	PRM_ARRAY = 'gregion'

string	PRM_LENGTH = 'num_gregions'

Static Public Attributes inherited from carputils.model.general.AbstractModelComponent
	PRM_ARRAY = None

	PRM_LENGTH = None

list	FIELDS = []

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

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`
	)

Member Function Documentation

◆ 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'