radtools.dipole_dipole_energy#

radtools.dipole_dipole_energy(magnetic_centres, progress_bar=True, normalize=True)[source]#

Computes magnetic dipole-dipole energy.

This function computes the magnetic dipole-dipole energy of the set of magnetic centres:

\[E = -\frac{\mu_0}{4\pi}\sum_{i > j}\frac{1}{\vert r_{ij}\vert^3}\left(3(\vec{m_i} \cdot \vec{r_{ij}})(\vec{m_j} \cdot \vec{r_{ij}}) - (\vec{m_i}\cdot\vec{m_j})\right)\]
Parameters:
magnetic_centres: (N, 2, 3) |array_like|_

List of N magnetic centres. First element along second axis is magnetic moment (in Bohr magnetons). Second element along second axis if position (in Angstrom).

progress_barbool, default True

Whether to show progressbar.

normalizebool, default True

Whether to normalize energy to the number of magnetic centres.

Returns:
energyfloat

Dipole-dipole energy of the system of magnetic_centres. Normalized to the number of magnetic centres N.

See also

dipole_dipole_interaction

between two sets of magnetic centres.