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

Functions

def PEERP (args, job, cmd_ref, mesh_name, sinus, stim_point, steady_state_dir, tag_str="")
 Pacing at the End of the Effective Refractory Period: More...
 
def save_S2_time (index_node, job, new_time_points)
 

Function Documentation

◆ PEERP()

def carputils.model.protocols.PEERP_algorithm.PEERP (   args,
  job,
  cmd_ref,
  mesh_name,
  sinus,
  stim_point,
  steady_state_dir,
  tag_str = "" 
)

Pacing at the End of the Effective Refractory Period:

It triggers ectopic beats at the end of the effective refractory period, computed as the minimum coupling interval at which the action potential could propagate in the tissue.

Input parser arguments (args), output directory (job.ID), struct containing imp_regions and gregions (cmd_ref), meshname, sinus node location (sinus), 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'
'--max_n_beats_PEERP',
type=int,
default=2,
help='Max number of beats for the PEERP'
'--APD_percent',
type=float, default=94.0,
help='action potential duration percentage to set as first guess to find the end of the effective refractory period'
'--tol',
type=float, default=1.0,

help='tolerance to compute the end of the effective refractory period'

Parameters
args
job
cmd_ref
mesh_name
sinus
stim_point3D position of the stimulation point
steady_state_dir
tag_strTags which belong to the surface of the corresponding atrium size (all LA or all RA tags) :return:

◆ save_S2_time()

def carputils.model.protocols.PEERP_algorithm.save_S2_time (   index_node,
  job,
  new_time_points 
)