carputils
Doxygen code documentation for the python framework controlling openCARP
Functions
carputils.model.protocols.RP_E_algorithm Namespace Reference

Functions

def RP_E (args, job, cmd_ref, meshname, stim_points, steady_state_dir)
 Rapid Pacing with reentry check at the End: More...
 
def stimulation (args, start, start_bcl, end_bcl, step, n_beats, stimulation_node)
 

Function Documentation

◆ RP_E()

def carputils.model.protocols.RP_E_algorithm.RP_E (   args,
  job,
  cmd_ref,
  meshname,
  stim_points,
  steady_state_dir 
)

Rapid Pacing with reentry check at the End:

It consists of a train of electrical stimulations with decreasing coupling interval (args.step) between args.start_bcl and args.end_bcl. It can give multiple beats with the same cycle length (args.max_n_beats_RP) and it checks for arrhythmia induction at the end of the protocol

Input parser arguments (args), output directory (job.ID), struct containing imp_regions and gregions (cmd_ref), meshname, stimulation point location (x,y,z) and prepacing directory (steady_state_dir)

'--M_lump',
type=int,
default='1',
help='set 1 for mass lumping, 0 otherwise. Mass lumping will speed up the simulation. Use with regular meshes.'
'--stim_size',
type=str,
default='2000.0',
help='stimulation edge square size in micrometers'
'--step',
type=float,
default=10,
help='Step to decrease bcl in ms'
'--max_n_beats_RP',
type=int,
default=1,
help='Max number of beats for th RP'
'--start',
type=float, default=2000.0,
help='initial basic cycle lenght in [ms]'
'--start_bcl',
type=float, default=200.0,
help='initial basic cycle lenght in [ms]'
'--end_bcl',
type=float, default=130.0,
help='last basic cycle lenght in [ms]'

◆ stimulation()

def carputils.model.protocols.RP_E_algorithm.stimulation (   args,
  start,
  start_bcl,
  end_bcl,
  step,
  n_beats,
  stimulation_node 
)