carputils
Doxygen code documentation for the python framework controlling openCARP
Public Member Functions | Static Public Attributes | List of all members
carputils.model.conductivity.ConductivityRegionEMI Class Reference

Defines an electrical conductivity region for the EMI model. More...

Inheritance diagram for carputils.model.conductivity.ConductivityRegionEMI:

Public Member Functions

def __init__ (self, IDs=[], name=None, g_bath=2.0, g_mult=1.0)
 
def extra_default (cls, g_bath=2.0, g_mult=1.0)
 
def intra_default (cls, g_bath=0.4, g_mult=1.0)
 
def opts (self)
 

Static Public Attributes

string PRM_ARRAY = 'gregion'
 
string PRM_LENGTH = 'num_gregions'
 

Detailed Description

Defines an electrical conductivity region for the EMI model.

Args IDs list The material tags in this region name str, optional A short descriptive name for this region g_bath float, optional Defines the isotropic conductivity for myocardium domain g_mult float, optional Defines the factor by which all conductivities in the region should be multiplied

Constructor & Destructor Documentation

◆ __init__()

def carputils.model.conductivity.ConductivityRegionEMI.__init__ (   self,
  IDs = [],
  name = None,
  g_bath = 2.0,
  g_mult = 1.0 
)

Member Function Documentation

◆ extra_default()

def carputils.model.conductivity.ConductivityRegionEMI.extra_default (   cls,
  g_bath = 2.0,
  g_mult = 1.0 
)

◆ intra_default()

def carputils.model.conductivity.ConductivityRegionEMI.intra_default (   cls,
  g_bath = 0.4,
  g_mult = 1.0 
)

◆ opts()

def carputils.model.conductivity.ConductivityRegionEMI.opts (   self)

Member Data Documentation

◆ PRM_ARRAY

string carputils.model.conductivity.ConductivityRegionEMI.PRM_ARRAY = 'gregion'
static

◆ PRM_LENGTH

string carputils.model.conductivity.ConductivityRegionEMI.PRM_LENGTH = 'num_gregions'
static

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