Todo
Improve autoapi module
circadapt.components.cavity
Cavity objects.
Module Contents
Classes
Basic Cavity object. |
|
Bag is designed to simulate the pericardium |
|
Tube0D is designed to simulate pressure-volume relations of vessels. |
|
Chamber2022 object. |
|
TriSeg2022 is designed to represent ventricles including interaction. |
Objects
-
class
circadapt.components.cavity.Cavity(model, objects=None) -
Bases:
circadapt.components.ComponentBasic Cavity object.
-
parameters= []
-
signals= ['A', 'p', 'p_trans', 'q', 'V', 'VDot']
-
parameter_on_set
-
build()
-
add_object(o)
-
-
class
circadapt.components.cavity.Bag(model, objects=None) -
Bases:
circadapt.components.ComponentBag is designed to simulate the pericardium
Parameters
- k: double
Nonlinear exponent
- p_ref: double
Reference pressure for which hold p(V_ref) = p_ref
- V_ref: double
Reference volume for which hold p(V_ref) = p_ref
Signals
- V: array
Volume enclosed by the Bag
- p: array
Pressure inside the Bag
-
parameters= ['k', 'p_ref', 'V_ref']
-
signals= ['V', 'p']
-
parameter_on_set
-
build()
-
add_object(o)
-
class
circadapt.components.cavity.Tube0D(model, objects=None) -
Bases:
circadapt.components.ComponentTube0D is designed to simulate pressure-volume relations of vessels.
Parameters
- Len: double
Length of the tube
- AWall: double
Cross-sectional area of the wall
- k: double
Stiffness coefficient of the wall
- p0: double
Pressure at A=A0
- A0: double
Cross-sectional cavity area for p=p0
Signals
- V: array
Volume
- p: array
Pressure
-
parameters= ['Len', 'AWall', 'k', 'p0', 'A0']
-
signals= ['V', 'p']
-
parameter_on_set
-
build()
-
add_object(o)
-
class
circadapt.components.cavity.Chamber2022(model, objects=None) -
Bases:
circadapt.components.ComponentChamber2022 object.
Parameters
- buckling: bool
Buckling function. If True, wall tension cannot be below zero.
Signals
- V: array
Volume
- p: array
Pressure
-
parameters= ['buckling']
-
signals= ['V', 'p', 'V', 'VDot', 'A', 'Y', 'q']
-
parameter_on_set
-
build()
-
add_object(o)
-
class
circadapt.components.cavity.TriSeg2022(model, objects=None) -
Bases:
circadapt.components.ComponentTriSeg2022 is designed to represent ventricles including interaction.
Parameters
- tau: float [-]
Constant to limit change in estimation of dV and dY
Signals
- V: array
Volume of truncated septal wall
- V0: array
Volume of truncated septal wall before finding mechanical equilibrium
- VDot: array
Time-derivative of V, used to find the estimation V0
- Y: array
Distance of wall-junction to center
- Y0: array
Distance of wall-junction to center before finding mechanical equilibrium
- YDot: array
Time-derivative of Y, used to find the estimation Y0
-
parameters= ['tau']
-
signals= ['V', 'Y', 'V0', 'Y0', 'VDot', 'YDot', 'nLoop', 'Fp', 'Fv']
-
parameter_on_set
-
build()
-
add_object(o)