Common

Realizations shared by several physics packages, by family.

The families are fields, mechanics, oscillators, particles, quantum species, and spins. The sandpile cell, which the criticality systems share, has no family.

SandpileCellElement(label, visual=None, *, height=0)

Bases: Element

Site of a sandpile, which holds a number of grains.

An AvalancheInteraction drops the grains and topples the sites that hold too many.

Parameters:

Name	Type	Description	Default
label	str	The label of the site or the lattice group.	required
visual	VisualSpec | None	How the site is drawn, or None for default_visual_.	None
height	Annotated[float, StateSpec(domain=NN)]	The initial number of grains.	0

Attributes:

Name	Type	Description
default_visual_		The visual of the site when it sets none.

Examples:

>>> from skcomplex.systems.physics.common import SandpileCellElement
>>> SandpileCellElement('site').height
0

Source code in src/skcomplex/systems/physics/common/_sandpile_cell.py

def __init__(
    self,
    label: str,
    visual: VisualSpec | None = None,
    *,
    height: Annotated[float, StateSpec(domain=NN)] = 0,
) -> None:
    super().__init__(label, visual=visual)
    self.height = height