radtools.ExchangeHamiltonian.ferromagnetic_energy#
method
- ExchangeHamiltonian.ferromagnetic_energy(theta=0, phi=0)[source]#
Compute energy of the Hamiltonian assuming ferromagnetic state.
- Parameters:
- thetafloat or (N,) array-like, default 0
Angle between z axis and direction of the magnetization. \(0^{\circ} \le \theta \le 180^{\circ}\).
- phifloat or (N,) array-like, default 0
angle between x axis and projection of magnetization`s direction on xy plane. \(0^{\circ} \le \phi < 360^{\circ}\).
- Returns:
- energyfloat or (N,) numpy.ndarray
Energy of ferromagnetic Hamiltonian with magnetization direction defined by
thetaandphi. In the units of J values.
Notes
Notation of the Hamiltonian nas to be known. See
set_interpretation()andnotation.