Potential

class Potential(atom, name, options)

Bases: handle

Potential is an abstract base for particle potentials.

Encapsulates an Atom context and a short name for the potential, with optional manifold and state index information for internal state.

Example:

% See concrete subclasses like :class:`OpticalTrap` or :class:`OpticalLattice`.

Constructor Summary

Potential(atom, name, options)

Construct a Potential.

Parameters:

• atom (Atom) – Atom context for computing derived quantities

• name (string) – A short name/label for the potential

Property Summary

Atom Atom

Atom used to compute recoil, polarizability, etc.

AtomicState struct

Quantum state of the atom. Including quantum numbers like N,L,J…

Name string

Short human-readable label for the potential