SpinHamiltonian

Class

SpinHamiltonian([crystal, notation])

Spin Hamiltonian.

Hint

All properties and methods of Crystal are accessible directly from the hamiltonian instance. As a consequence all properties and methods of Lattice are accessible directly from the hamiltonian instance.

Energy

SpinHamiltonian.ferromagnetic_energy([...])

Compute energy of the Hamiltonian assuming ferromagnetic state.

Structure

SpinHamiltonian.cell_list	List of cells from the Hamiltonian.
SpinHamiltonian.number_spins_in_unit_cell	Number of spins (or magnetic atoms) in the unit cell.
SpinHamiltonian.space_dimensions	Model minimum and maximum coordinates in real space.

Manipulation with the model

Adding elements

SpinHamiltonian.add_atom([new_atom, relative])	Add atom to the crystal.
SpinHamiltonian.add_bond(atom1, atom2, R[, J])	Add one bond to the Hamiltonian.

Removing elements

SpinHamiltonian.remove_atom(atom)	Remove magnetic atom from the Hamiltonian.
SpinHamiltonian.remove_bond(atom1, atom2, R)	Remove one bond from the Hamiltonian.

Filtering the model

SpinHamiltonian.filter([max_distance, ...])	Filter the exchange entries based on the given conditions.
SpinHamiltonian.filtered([max_distance, ...])	Create filtered spin Hamiltonian based on the given conditions.
SpinHamiltonian.form_model(template)	Force the Hamiltonian to have the symmetries of the template.
SpinHamiltonian.formed_model(template)	Form the model from the Hamiltoian based on the template.

Notation

SpinHamiltonian.notation	Tuple of the notation.
SpinHamiltonian.set_interpretation([...])	Set the interpretation of the Hamiltonian`s notation.

Individual properties

SpinHamiltonian.double_counting	Whether double counting is present in the Hamiltonian.
SpinHamiltonian.spin_normalized	Whether spin is normalized.
SpinHamiltonian.factor	Whether any factor is present in the Hamiltonian.

Human readable representation

SpinHamiltonian.notation_string

Human-readable representation of the notation.

Crystal getter

SpinHamiltonian.crystal

Crystal of the Hamiltonian.