carputils
Doxygen code documentation for the python framework controlling openCARP
Functions | Variables
carputils.forcepss.prepace Namespace Reference

Functions

def mesh_base_format (meshname)
 
def setup_lats_prepacing (pp_bcl, pp_cycs, lat_file)
 
def stim_mode (prop)
 
def setup_prepace (meshname, cnf, fncs, elecs, pp_prtcl, rmode, *use_split=True, split_file=None, tags_file=None, job=None, ucc_file=None)
 
def sim_ID (prefix, pp_prtcl, caseID)
 
def generate_lat (meshname, configs, funcs, elecs, solver, pp_prtcl, gen_lat, lats_file, visual, use_split=True, split_file=None, tags_file=None, job=None, ucc_file=None)
 
def setup_tsavs (tsav, tsav_basename)
 
def prepace (meshname, cnf, fncs, elecs, pp_prtcl, mode, lats_file, rmode, visual, use_split=True, split_file=None, tags_file=None, job=None, ucc_file=None)
 
def restart (meshname, cnf, fncs, elecs, pp_prtcl, mode, rmode, restart_chkpt, visual, job=None, ucc_file=None)
 
def print_prepace_summary (pprtcl, plan, prepace, lat, rstrt_file)
 

Variables

string EXAMPLE_DESCRIPTIVE_NAME = 'Prepacing and validation of tissue/organ models'
 
string EXAMPLE_AUTHOR = 'Gernot Plank <gernot.plank@medunigraz.at>, ' \
 
 EXAMPLE_DIR = os.path.dirname(__file__)
 

Function Documentation

◆ generate_lat()

def carputils.forcepss.prepace.generate_lat (   meshname,
  configs,
  funcs,
  elecs,
  solver,
  pp_prtcl,
  gen_lat,
  lats_file,
  visual,
  use_split = True,
  split_file = None,
  tags_file = None,
  job = None,
  ucc_file = None 
)

◆ mesh_base_format()

def carputils.forcepss.prepace.mesh_base_format (   meshname)

◆ prepace()

def carputils.forcepss.prepace.prepace (   meshname,
  cnf,
  fncs,
  elecs,
  pp_prtcl,
  mode,
  lats_file,
  rmode,
  visual,
  use_split = True,
  split_file = None,
  tags_file = None,
  job = None,
  ucc_file = None 
)

◆ print_prepace_summary()

def carputils.forcepss.prepace.print_prepace_summary (   pprtcl,
  plan,
  prepace,
  lat,
  rstrt_file 
)

◆ restart()

def carputils.forcepss.prepace.restart (   meshname,
  cnf,
  fncs,
  elecs,
  pp_prtcl,
  mode,
  rmode,
  restart_chkpt,
  visual,
  job = None,
  ucc_file = None 
)

◆ setup_lats_prepacing()

def carputils.forcepss.prepace.setup_lats_prepacing (   pp_bcl,
  pp_cycs,
  lat_file 
)

◆ setup_prepace()

def carputils.forcepss.prepace.setup_prepace (   meshname,
  cnf,
  fncs,
  elecs,
  pp_prtcl,
  rmode,
use_split = True,
  split_file = None,
  tags_file = None,
  job = None,
  ucc_file = None 
)

◆ setup_tsavs()

def carputils.forcepss.prepace.setup_tsavs (   tsav,
  tsav_basename 
)

◆ sim_ID()

def carputils.forcepss.prepace.sim_ID (   prefix,
  pp_prtcl,
  caseID 
)

◆ stim_mode()

def carputils.forcepss.prepace.stim_mode (   prop)

Variable Documentation

◆ EXAMPLE_AUTHOR

string carputils.forcepss.prepace.EXAMPLE_AUTHOR = 'Gernot Plank <gernot.plank@medunigraz.at>, ' \

◆ EXAMPLE_DESCRIPTIVE_NAME

string carputils.forcepss.prepace.EXAMPLE_DESCRIPTIVE_NAME = 'Prepacing and validation of tissue/organ models'

◆ EXAMPLE_DIR

carputils.forcepss.prepace.EXAMPLE_DIR = os.path.dirname(__file__)