MagneticPotential

MagneticPotential#

class MagneticPotential(atom, magneticField, name, options)#

Bases: Potential, matlab.mixin.Heterogeneous

MagneticPotential models Zeeman energy shifts from a magnetic field.

Couples an Atom state to a MagneticField and provides low- and high-field limits for the Zeeman energy factor. Exposes space-dependent potential functions in both limits.

Example:

mp = MagneticPotential(atom, magneticField, "Trap", manifold="DGround");
Vlow = mp.spaceFuncLowField();
Constructor Summary
MagneticPotential(atom, magneticField, name, options)#

Construct a MagneticPotential.

Parameters:

  • atom (Atom) – Atomic species

  • magneticField (MagneticField) – Magnetic field instance

  • name (string, optional) – Potential name

  • manifold (string, optional) – Atomic manifold label (e.g., “DGround”)

  • stateIndex (double, optional) – Specific state index within manifold

Property Summary
EnergyFactor#

Effective Zeeman factor \(\alpha\) [Hz/T]

EnergyFactorHighField#

High-field \(\alpha = (m_J g_J + m_I g_I) \mu_B / h\) [Hz/T]

EnergyFactorLowField#

Low-field \(\alpha = m_F g_F \mu_B / h\) [Hz/T]

MagneticField MagneticField#

Background magnetic field \(\mathbf{B}(\mathbf{r})\)

Method Summary
spaceFunc()#

Build low-field potential \(V(\mathbf{r}) = \alpha \|\mathbf{B}(\mathbf{r})\|\).

Returns:

function handle mapping \(\mathbf{r}\) to \(V(\mathbf{r})\) [Hz]

Return type:

function_handle