Potassium

Contents

Potassium#

class braincell.ion.Potassium(size, name=None, **channels)#

Base class for modeling the potassium ion species.

Potassium collects the physiological defaults shared by every concrete potassium ion model in BrainCell and provides the Ion/IonChannel container interface potassium channels attach to. It carries no dynamics of its own.

Parameters:

  • size (int | Sequence[int] | integer | Sequence[integer]) – The size of the simulation target, typically the number of neurons or compartments. Forwarded unchanged to Ion.

  • name (str | None) – Runtime instance name. Defaults to None, in which case the instance is unnamed. Forwarded unchanged to Ion.

  • **channels – Channel instances to attach to this ion, forwarded unchanged to Ion.

See also

PotassiumFixed

Fixed-parameter potassium ion built on this base.

PotassiumInitNernst

Potassium ion with E initialized from the Nernst equation.

Notes

This is an abstract base class and must be subclassed (for example by PotassiumFixed or PotassiumInitNernst) to obtain a concrete potassium ion model with defined reversal- potential dynamics.

Variables:

  • ion_symbol (str) – Symbol used for runtime family lookup. Set to 'K'.

  • default_Ci (brainunit.Quantity) – Default intracellular potassium concentration, 54.4 mM.

  • default_Co (brainunit.Quantity) – Default extracellular potassium concentration, 2.5 mM.

  • default_valence (int) – Default ionic valence, 1.

Contents