Sodium

Contents

Sodium#

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

Base class for modeling the sodium ion species.

Sodium collects the physiological defaults shared by every concrete sodium ion model in BrainCell and provides the Ion/IonChannel container interface sodium 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

SodiumFixed

Fixed-parameter sodium ion built on this base.

SodiumInitNernst

Sodium ion with E initialized from the Nernst equation.

Notes

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

Variables:

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

  • default_Ci (brainunit.Quantity) – Default intracellular sodium concentration, 10.0 mM.

  • default_Co (brainunit.Quantity) – Default extracellular sodium concentration, 140.0 mM.

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

Contents