Skip to article frontmatterSkip to article content
Site not loading correctly?

This may be due to an incorrect BASE_URL configuration. See the MyST Documentation for reference.

Models

The cell model

The shipped cell models, in examples/odefiles/, join two published models in one gotranx .ode file:

In the Land model, cytosolic calcium binds to troponin (CaTrpn), and the fraction of blocked tropomyosin (TmB) falls. Crossbridges then form, first weakly bound (XW) and then strongly bound (XS). Two distortion states, Zetas and Zetaw, track how far the attached crossbridges are strained by the stretch rate λ˙\dot\lambda of the fibre:

ζ˙s=As λ˙−cs ζs,ζ˙w=Aw λ˙−cw ζw.\dot\zeta_s = A_s\,\dot\lambda - c_s\,\zeta_s, \qquad \dot\zeta_w = A_w\,\dot\lambda - c_w\,\zeta_w .

The active tension is

Ta=h(λ) Trefrs[XS (ζs+1)+XW ζw],T_a = h(\lambda)\,\frac{T_{ref}}{r_s}\Big[X_S\,(\zeta_s + 1) + X_W\,\zeta_w\Big],

where h(λ)h(\lambda) is the length dependence and TrefT_{ref} (120 kPa by default) the reference tension. The tension therefore depends on the stretch rate, and this velocity dependence is what makes the coupling scheme matter (Coupling).

Splits

Every .ode file marks one component "mechanics". Its states are stepped by the activation backend at the quadrature points of the mechanics mesh, and everything else is stepped by EP. simcardemsx.ode_model.load_ode_modules(odefile, output_dir) cuts the file there and generates two modules, both with gotranx’s generalized Rush-Larsen scheme:

The generated code is cached in output_dir, with a stamp of the .ode file’s hash, gotranx’s version and the generator’s own source. It is regenerated only when one of them changes.

The three shipped splits of ToR-ORd + Land:

FileMechanics statesEP → mechanicsMechanics → EP
…_zetasplit.odeZetas, Zetaw, CdXS, XWZetas, Zetaw, λ\lambda
…_catrpnsplit.odethe Land model except troponinCaTrpnλ\lambda
…_caisplit.odethe whole Land modelcaiJ_TRPN

The further the cut moves towards EP, the more of the contraction model is evaluated at the true stretch of the mechanics mesh. On the Cai_i split, EP sees the contraction only through the troponin buffering flux J_TRPN. That split is also the one the NumPy crossbridge models of CrossbridgeSegregated plug into.

Tutorial 1 runs the whole cell, and then each split.

Writing your own split

Any gotranx .ode file works if:

Active stress

The tension acts along the fibre direction f0f_0. By default (formulation="stretch") simcardemsx uses the normalization of Regazzoni & Quarteroni (2021),

Pa=Ta Ff0⊗f0∣Ff0∣,∣Paf0∣=Ta,\mathbf{P}_a = T_a\,\frac{\mathbf{F} f_0 \otimes f_0}{|\mathbf{F} f_0|}, \qquad |\mathbf{P}_a f_0| = T_a ,

under which the tension is the force per reference area along the fibre whatever the stretch. The historical simcardems form, formulation="invariant" (Pa=Ta Ff0⊗f0\mathbf{P}_a = T_a\,\mathbf{F} f_0 \otimes f_0), is larger by a factor of λ\lambda. It is kept only to reproduce old results, which are not comparable with new ones.

tension_scale= multiplies TaT_a in the stress and nothing else. A DG0 mask of 0 and 1 takes the active stress out of part of the domain, for example the valve plugs of the rodero_05 example, while the contraction states there keep their own dynamics.

Passive mechanics

The passive material, compressibility and viscosity are pulse’s. The examples use the Holzapfel-Ogden model (Holzapfel & Ogden, 2009), either incompressible or with pulse’s compressibility penalties. See the pulse documentation for the full list.

References