NonSpecificFixed

Contents

NonSpecificFixed#

class braincell.ion.NonSpecificFixed(size, E=Quantity(0., 'mV'), Ci=None, Co=None, valence=None, name=None, **channels)#

Fixed nonspecific current-owner placeholder.

Parameters:

  • size (int | Sequence[int] | integer | Sequence[integer]) – Runtime variable shape for this placeholder ion.

  • E (Array | ndarray | bool | number | bool | int | float | complex | Quantity | Callable | None) – Fixed reversal potential used only by channels that choose to read No.E. Defaults to 0 mV.

  • Ci (Array | ndarray | bool | number | bool | int | float | complex | Quantity | Callable | None) – Placeholder intracellular concentration. Defaults to None, which falls back to NonSpecific.default_Ci inside FixedIon._init_fixed_ion().

  • Co (Array | ndarray | bool | number | bool | int | float | complex | Quantity | Callable | None) – Placeholder extracellular concentration. Defaults to None, which falls back to NonSpecific.default_Co inside FixedIon._init_fixed_ion().

  • valence (Array | ndarray | bool | number | bool | int | float | complex | Quantity | Callable | None) – Placeholder valence. Defaults to None, which falls back to NonSpecific.default_valence inside FixedIon._init_fixed_ion().

  • name (str | None) – Runtime ion instance name.

  • **channels – Optional channels added directly to the placeholder ion.

Raises:

ValueError – If E is explicitly passed as None. FixedIon._init_fixed_ion() requires an explicit fixed reversal potential and does not fall back to a class default for E.

See also

NonSpecific

Base placeholder ion family this class fixes.

Notes

This class is intentionally minimal. It lets a channel expose a nonspecific current component through Ion.current(...) without changing the global membrane-current API. It should not be used as a substitute for sodium, potassium, calcium, or other explicit ion species when those concentrations carry model semantics.

Contents