IonInfo

class braincell.IonInfo(Ci: Array | ndarray | bool | number | bool | int | float | complex | Quantity, Co: Array | ndarray | bool | number | bool | int | float | complex | Quantity, E: Array | ndarray | bool | number | bool | int | float | complex | Quantity, valence: Array | ndarray | bool | number | bool | int | float | complex | Quantity)

A named tuple representing the information of an ion in a neuron model.

This class encapsulates the intracellular/extracellular concentrations of an ion, its reversal potential, and its valence. It is used to store and pass ion-related information in various neuronal simulation contexts.

Variables:

• Ci (brainstate.typing.ArrayLike) – The intracellular ion concentration. This represents the concentration of the ion inside the cell, typically in units of millimoles per liter (mM).

• Co (brainstate.typing.ArrayLike) – The extracellular ion concentration. This represents the concentration of the ion outside the cell, typically in units of millimoles per liter (mM).

• E (brainstate.typing.ArrayLike) – The reversal potential. This represents the electrical potential at which there is no net flow of the ion across the membrane, typically in millivolts (mV).

• valence (brainstate.typing.ArrayLike) – The ionic valence. This represents the charge number used in Nernst/GHK relations.

Note

Ci, Co, E, and valence are expected to be array-like objects or scalars, allowing representation of these properties across multiple neurons or compartments simultaneously.

Ci: Array | ndarray | bool | number | bool | int | float | complex | Quantity

Alias for field number 0

Co: Array | ndarray | bool | number | bool | int | float | complex | Quantity

Alias for field number 1

E: Array | ndarray | bool | number | bool | int | float | complex | Quantity

Alias for field number 2

valence: Array | ndarray | bool | number | bool | int | float | complex | Quantity

Alias for field number 3