IntegratorEntry#
- class braincell.quad.IntegratorEntry(name, func, aliases=(), category='general', order=None, description='', deprecated=False, module='')[source]#
A single registered integrator and its metadata.
- Parameters:
name (
str) – Canonical, user-facing name of the integrator (e.g."euler").func (
Callable) – The underlying*_stepfunction.aliases (
tuple[str,...]) – Alternative names that resolve to this entry.category (
str) – Loose grouping for introspection and documentation. Common values used in-tree are"explicit","implicit","exponential","staggered","voltage", and"general".order (
int|None) – Convergence order of the method, when applicable.description (
str) – One-line human-readable description shown in error messages and documentation.deprecated (
bool) – IfTrue, looking up this entry by name emits aDeprecationWarning.module (
str) – Fully-qualified module name wherefuncis defined. Populated automatically byIntegratorRegistry.register().