ToyCaBindingSourceKinetic_SU2015_DCN#
- class braincell.ion.ToyCaBindingSourceKinetic_SU2015_DCN(size, temp=Quantity(309.15, 'K'), kf=Quantity(2., '1 / (mM * ms)'), kb=Quantity(0.5, 'kHz'), Btot=Quantity(1., 'mM'), ci_source=Quantity(0.002, 'mM / ms'), Co=None, Ci_initializer=Quantity(0.1, 'mM'), BC_initializer=Quantity(0., 'mM'), solver='rk4', substeps=5, name=None, **channels)#
Minimal reversible calcium-binding toy with a constant
Cisource.This is a BrainCell import-path validation fixture, not a model of a published mechanism – the
SU2015_DCNsuffix follows BrainCell’s naming convention only. The mechanism keeps the same reversible binding network asToyCaBindingKinetic_SU2015_DCN:\[Ca_i + B \rightleftharpoons BC\]and adds one constant source term on
Ci:\[\frac{d Ca_i}{dt}\Big|_{\text{source}} = s_{Ca}\]- Parameters:
size (
int|Sequence[int] |integer|Sequence[integer]) – The size of the simulation target, typically the number of neurons or compartments. Forwarded unchanged toCalcium.temp (
Array|ndarray|bool|number|bool|int|float|complex|Quantity|Callable) – Absolute temperature used by the Nernst equation inE. Defaults to 36 degrees Celsius, converted to kelvin viau.celsius2kelvinbefore being stored.kf (
Array|ndarray|bool|number|bool|int|float|complex|Quantity|Callable) – Forward rate constant of theCi + B -> BCreaction. Defaults to2.0 / (mM * ms).kb (
Array|ndarray|bool|number|bool|int|float|complex|Quantity|Callable) – Backward rate constant of theBC -> Ci + Breaction. Defaults to0.5 / ms.Btot (
Array|ndarray|bool|number|bool|int|float|complex|Quantity|Callable) – Total conserved concentration ofB + BC. Defaults to1.0 mM.ci_source (
Array|ndarray|bool|number|bool|int|float|complex|Quantity|Callable) – Constant source rate \(s_{Ca}\) added todCi/dt. Defaults to0.002 mM / ms.Co (
Array|ndarray|bool|number|bool|int|float|complex|Quantity|Callable|None) – Extracellular calcium concentration. Defaults toNone, which falls back toCalcium.default_CoinsideKineticIon._init_kinetic_ion().Ci_initializer (
Array|ndarray|bool|number|bool|int|float|complex|Quantity|Callable) – Initializer for theCispecies. Defaults to0.10 mM.BC_initializer (
Array|ndarray|bool|number|bool|int|float|complex|Quantity|Callable) – Initializer for theBCspecies. Defaults to0.00 mM.solver (
str) – Integrator name used for the reaction network. Defaults to"rk4".substeps (
int) – Number of solver substeps run inside one parent update. Defaults to5.name (
str|None) – Runtime ion instance name. Defaults toNone.**channels – Channel instances to attach to this ion, forwarded unchanged to
Calcium.
- Raises:
ValueError – If
tempis explicitly passed asNone, or ifsubstepsis less than1. Both come fromKineticIon._init_kinetic_ion().
See also
CalciumBase calcium ion family this class attaches the reaction network to.
ToyCaBindingKinetic_SU2015_DCNSame reaction network without the constant source.
ToyCaBindingIcaSourceKinetic_SU2015_DCNSibling fixture whose source is driven by current instead of a constant rate.
braincell.ion._base.KineticIonTemplate this class instantiates; documents the NMODL-style semantics shared by all five toy fixtures.
Notes
Bis not a differential species:conservesmarks it as thealgebraicmember of theB + BC = Btotconservation relation, so its value is recovered fromBCrather than integrated, exactly as inToyCaBindingKinetic_SU2015_DCN.