Todo

Improve autoapi module

circadapt.components.wall

Wall objects.

Module Contents

Classes

Wall	Wall object.
Wall2022	Wall2022 object.
LoadExperiment	PreAfterloadExperiment object.

Functions

rebuild_patch2022(model)	Rebuilds patches of the model, e.g. for when n_patch changed.
rebuild_patch(model)	Rebuilds patches of the model, e.g. for when n_patch changed.

Objects

circadapt.components.wall.rebuild_patch2022(model)

Rebuilds patches of the model, e.g. for when n_patch changed.

circadapt.components.wall.rebuild_patch(model)

Rebuilds patches of the model, e.g. for when n_patch changed.

class circadapt.components.wall.Wall(component_type, model, objects=None)

Bases: circadapt.components.Component

Wall object.

Parameters

Am_dead: float

Non-conctractile wall area.

n_patch: int

Number of patches in the wall. On increase, the last patch will be copied. Wall volume and area are distributed equally over the patches. On decrease, the last patches in the list will be removed.

Signals

Signals are arrays. Each point in the array represents a point in time with step-size controlled by the solver.

Am [m ²]: array

Wall area

Am0 [m ²]: array

Linearized stress-free wall area

Cm [1/m]: array

Wall curvature

dA_dT [m/N]: array

Stress-tension derivative

p_trans [Pa]: array

Transmural pressure

T [Nm]: array

Tension

Vm [m ³]: array

Mid-wall volume

V_wall [m ³]: double

Wall volume

parameters = ['Am_dead', 'n_patch']

parameter_on_set

signals = ['A', 'Am', 'Am0', 'Cm', 'dA_dT', 'p_trans', 'T', 'Vm', 'V_wall']

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.wall.Wall2022(component_type, model, objects=None)

Bases: circadapt.components.Component

Wall2022 object.

Parameters

Am_dead: float

Non-conctractile wall area.

n_patch: int

Number of patches in the wall. On increase, the last patch will be copied. Wall volume and area are distributed equally over the patches. On decrease, the last patches in the list will be removed.

Signals

Signals are arrays. Each point in the array represents a point in time with step-size controlled by the solver.

Am [m ²]: array

Wall area

Am0 [m ²]: array

Linearized stress-free wall area

Cm [1/m]: array

Wall curvature

dA_dT [m/N]: array

Stress-tension derivative

p_trans [Pa]: array

Transmural pressure

T [Nm]: array

Tension

Vm [m ³]: array

Mid-wall volume

V_wall [m ³]: double

Wall volume

parameters = ['Am_dead', 'n_patch']

parameter_on_set

signals = ['A', 'Am', 'Am0', 'Cm', 'dA_dT', 'p_trans', 'T', 'Vm', 'V_wall']

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.wall.LoadExperiment(component_type, model, objects=None)

Bases: Wall

PreAfterloadExperiment object.

Parameters

Am_dead: float

Non-conctractile wall area.

Am_ref_afterload: float

Wall area at \(T_{m} = Tafterload\).

n_patch: int

Number of patches. On change, the last patch is splitted or last patches are removed.

n_iter: int

Number of iterations to calculate mechanical stability.

T_afterload: float

Maximum wall tension. When tension is reached, wall area shortens.

Signals

Signals are arrays. Each point in the array represents a point in time with step-size controlled by the solver.

Am: array

Wall area

Am0: array

Linearized stress-free wall area

Cm: array

Wall curvature

dA_dT: array

Stress-tension derivative

T: array

Tension

p_trans: array

Transmural pressure

parameters = ['Am_dead', 'Am_ref_afterload', 'n_patch', 'n_iter', 'T_afterload']

parameter_on_set

signals = ['A', 'Am', 'Am0', 'Cm', 'dA_dT', 'p_trans', 'T', 'Vm', 'V_wall']

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)