Todo

Improve autoapi module

circadapt.components.global_functions

Module Contents

Classes

Timings

Timings for whole heart simulations.

PressureFlowControl

Pressure Flow Control by fitting ArtVen resistance and total volume.

Objects

class circadapt.components.global_functions.Timings(model, objects=None)

Bases: circadapt.components.Component

Timings for whole heart simulations.

This module sets timings for whole heart simulations. It is designed for hearts with 2 artia (Chambers) and 2 ventricles (TriSeg) which results in five walls: Left and Rigth atrial wall and Left, septal, and right ventricular wall.

Parameters

time_fac: float

Relative contraction duration

tau_av: float

AV delay

dtau_av: float

Extra AV delay

law_tau_av: int

Tells which law is used to set tau_av at the start of each beat. If law_tau_av == 0, no law is used and tau_av can be set manually.

law_Ra2La: int

Tells which atrial delay law is used. If law_Ra2La == 0, no law is used.

law_ta: int

Tells which atrial activation duration law is used. If law_ta == 0, no law is used.

law_tv: int

Tells which ventricular activation duration law is used. If law_Ra2La == 0, no law is used.

c_tau_av0: float

Constant used to calculate tau_av depending on the used law.

c_tau_av1

Constant used to calculate tau_av depending on the used law.

parameters = ['time_fac', 'tau_av', 'dtau_av', 'law_tau_av', 'law_Ra2La', 'law_ta', 'law_tv', 'c_tau_av0',...
signals = []
parameter_on_set
build()
add_object(o)
__repr__()

Object representation in string format.

__getitem__(arg: any) → any

Get data.

This function is called when self[arg].

Parameters
arg: slice or string

If slice, return a components object with locs obtained from slice. If str, return the parameter or signal for all locs

__setitem__(arg: str, val: any) → any

Set data.

Set data of the parameter given in arg. Only parameter names can be used.

Parameters
arg: str

Parameter name

val: float/int/bool

Value will automatically be translated to type to

__iter__()

Iterate over object, used for dict(self).

class circadapt.components.global_functions.PressureFlowControl(model, objects=None)

Bases: circadapt.components.Component

Pressure Flow Control by fitting ArtVen resistance and total volume.

Parameters

p0 [Pa]: float

Target pressure.

q0 [m3/s]: float

Target mean flow

stable_threshold [-]: float

Threshhold to determine hemodynamic stability

is_active [-]: bool

activates or disactivates pressure flow control

fac [-]: float

Exponent to control speed.

fac_pfc [-]: float

Deviation from p0, driving factor for changing blood volume.

epsilon [-]: float

Minimal hemodynamic stability needed to allow pressure flow control.

parameters = ['p0', 'q0', 'stable_threshold', 'is_active', 'fac', 'fac_pfc', 'epsilon']
signals = []
parameter_on_set
build()
add_object(o)
__repr__()

Object representation in string format.

__getitem__(arg: any) → any

Get data.

This function is called when self[arg].

Parameters
arg: slice or string

If slice, return a components object with locs obtained from slice. If str, return the parameter or signal for all locs

__setitem__(arg: str, val: any) → any

Set data.

Set data of the parameter given in arg. Only parameter names can be used.

Parameters
arg: str

Parameter name

val: float/int/bool

Value will automatically be translated to type to

__iter__()

Iterate over object, used for dict(self).