Todo

Improve autoapi module

`circadapt.components.cavity`

Cavity objects.

Module Contents

Classes

`Cavity`	Basic Cavity object.
`Bag`	Bag is designed to simulate the pericardium
`Capacitor`	Bag is designed to simulate the pericardium
`Tube0D`	Tube0D is designed to simulate pressure-volume relations of vessels.
`Chamber`	Chamber is a thick-walled sphere with a Wall describing the pressure
`Chamber2022`	Chamber2022 object.
`TriSeg2022`	TriSeg2022 is designed to represent ventricles including interaction.
`TriSeg`	TriSeg is designed to represent ventricles including interaction.

Objects

class circadapt.components.cavity.Cavity(component_type, model, objects=None)[source]

Bases: circadapt.components.Component

Basic Cavity object.

Signals

A [m ²]: array,: Cavity Area
p [Pa]: array,: Pressure in node
p_trans [Pa]: array,: Transmural pressure

q [m ³]: array

Flow in node

V [m ³]: array,: Volume in Cavity
dV_dt [m ³]: array,: Volume time derivative

parameters = []

signals = ['A', 'p', 'p_trans', 'q', 'V', 'dV_dt']

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).

add(name)

class circadapt.components.cavity.Bag(component_type, model, objects=None)[source]

Bases: circadapt.components.Component

Bag is designed to simulate the pericardium

Parameters

k [-]: float: Nonlinear exponent
p_ref [Pa]: float: Reference pressure for which hold p(V_ref) = p_ref
V_ref [m ³]: float: Reference volume for which hold p(V_ref) = p_ref

Signals

V [m ³]: array: Volume enclosed by the Bag
p [Pa]: array: Pressure inside the Bag

parameters = ['k', 'p_ref', 'V_ref']

signals = ['V', 'p']

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).

add(name)

class circadapt.components.cavity.Capacitor(component_type, model, objects=None)[source]

Bases: Cavity

Bag is designed to simulate the pericardium

Parameters

Vo: double: Reference volume for which hold p=0
C: double: Linear capacitance of cavity

Signals

V: array: Volume enclosed by the Bag
p: array: Pressure inside the Bag Cavity

parameters = ['V0', 'C']

signals = ['V']

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).

add(name)

class circadapt.components.cavity.Tube0D(component_type, model, objects=None)[source]

Bases: circadapt.components.Component

Tube0D is designed to simulate pressure-volume relations of vessels.

Parameters

l [m]: double: Length of the tube
A_wall [m ²]: double: Cross-sectional area of the wall
k [-]: double: Stiffness coefficient of the wall
p0 [Pa]: double: Pressure at A=A0
A0 [m ²]: double: Cross-sectional cavity area for p=p0
target_wall_stress: double: Adaptation target for wall stress
target_mean_flow: double: Adaptation target for mean flow

Signals

V [m ³]: array: Volume in the Cavity
p [Pa]: array: Pressure in the Node

parameters = ['l', 'A_wall', 'k', 'p0', 'A0', 'target_wall_stress', 'target_mean_flow']

signals = ['V', 'p']

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).

add(name)

class circadapt.components.cavity.Chamber(component_type, model, objects=None)[source]

Bases: circadapt.components.Component

Chamber is a thick-walled sphere with a Wall describing the pressure \(p=f(A_m, C_m)\).

Parameters

buckling: bool: Buckling function. If True, wall tension cannot be below zero.

Signals

V [m ³]: array: Volume of the Cavity
p [Pa]: array: Pressure in the Node

parameters = ['buckling']

signals = ['V', 'p', 'V', 'dV_dt', 'A', 'Y', 'q']

parameter_on_set

add_object(loc)[source]

build()

__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).

add(name)

class circadapt.components.cavity.Chamber2022(component_type, model, objects=None)[source]

Bases: circadapt.components.Component

Chamber2022 object.

Parameters

buckling: bool: Buckling function. If True, wall tension cannot be below zero.

Signals

V [m ³]: array: Volume of the Cavity
p [Pa]: array: Pressure in the Node

parameters = ['buckling']

signals = ['V', 'p', 'V', 'dV_dt', 'A', 'Y', 'q']

parameter_on_set

add_object(loc)[source]

build()

__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).

add(name)

class circadapt.components.cavity.TriSeg2022(component_type, model, objects=None)[source]

Bases: circadapt.components.Component

TriSeg2022 is designed to represent ventricles including interaction.

Parameters

tau: float [-]: Constant to limit change in estimation of dV and dY

Signals

V [m ³]: array: Volume of truncated septal wall
V0 [m ³]: array: Volume of truncated septal wall before finding mechanical equilibrium
dV_dt [m ³/s]: array: Time-derivative of V, used to find the estimation V0
Y [m]: array: Distance of wall-junction to center
Y0 [m]: array: Distance of wall-junction to center before finding mechanical equilibrium
YDot [m/s]: array: Time-derivative of Y, used to find the estimation Y0

parameters = ['tau', 'ratio_septal_LV_Am']

signals = ['V', 'Y', 'V0', 'Y0', 'dV_dt', 'YDot', 'n_loop', 'Fp', 'Fv']

parameter_on_set

add_object(loc)[source]: Link a c++ object to this object.

build()

__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).

add(name)

class circadapt.components.cavity.TriSeg(component_type, model, objects=None)[source]

Bases: circadapt.components.Component

TriSeg is designed to represent ventricles including interaction.

Parameters

tau: float [-]: Constant to limit change in estimation of dV and dY

Signals

V [m ³]: array: Volume of truncated septal wall
V0 [m ³]: array: Volume of truncated septal wall before finding mechanical equilibrium
dV_dt [m ³/s]: array: Time-derivative of V, used to find the estimation V0
Y [m]: array: Distance of wall-junction to center
Y0 [m]: array: Distance of wall-junction to center before finding mechanical equilibrium
YDot [m/s]: array: Time-derivative of Y, used to find the estimation Y0

parameters = ['tau', 'ratio_septal_LV_Am', 'max_number_of_iterations', 'thresh_F', 'thresh_dV', 'thresh_dY']

signals = ['V', 'Y', 'V0', 'Y0', 'dV_dt', 'YDot', 'n_loop', 'Fp', 'Fv']

parameter_on_set

add_object(loc)[source]: Link a c++ object to this object.

build()

__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).

add(name)

circadapt.components.cavity

Module Contents

Classes

Objects

Signals

Parameters

Parameters

Parameters

Signals

Parameters

Parameters

Parameters

Signals

Parameters

Parameters

Parameters

Signals

Parameters

Parameters

Parameters

Signals

Parameters

Parameters

Parameters

Signals

Parameters

Parameters

Parameters

Signals

Parameters

Parameters

Parameters

Signals

Parameters

Parameters

`circadapt.components.cavity`