ExchangeHamiltonian

Class

ExchangeHamiltonian([crystal, notation])

Exchange Hamiltonian.

Energy

ExchangeHamiltonian.ferromagnetic_energy([...])

Compute energy of the Hamiltonian assuming ferromagnetic state.

Structure

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. Unless they are defined directly for the ExchangeHamiltonian and listed here.

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

Manipulation with the model

Adding elements

ExchangeHamiltonian.add_atom(atom)	Add atom to the Hamiltonian.
ExchangeHamiltonian.add_bond(J, atom1, atom2, R)	Add one bond to the Hamiltonian.

Removing elements

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

Filtering the model

ExchangeHamiltonian.filter([max_distance, ...])	Filter the exchange entries based on the given conditions.
ExchangeHamiltonian.filtered([max_distance, ...])	Create filtered exchange Hamiltonian based on the given conditions.
ExchangeHamiltonian.force_symmetry(template)	Force the Hamiltonian to have the symmetries of the template.
ExchangeHamiltonian.forced_symmetry(template)	Force the Hamiltonian to have the symmetries of the template.

Notation

ExchangeHamiltonian.notation	Return a string with a simple comment about the Hamiltonian notation.
ExchangeHamiltonian.set_interpretation([...])	Set the interpretation of the Hamiltonian`s notation.

Individual properties

ExchangeHamiltonian.double_counting	Whether double counting is present in the Hamiltonian.
ExchangeHamiltonian.spin_normalized	Whether spin is normalized.
ExchangeHamiltonian.factor_one_half	Whether factor 1/2 is present in the Hamiltonian.
ExchangeHamiltonian.factor_two	Whether factor 2 is present in the Hamiltonian.
ExchangeHamiltonian.minus_sign	Whether the minus sign is present in the Hamiltonian.

Deprecated parameters

Usage of this parameters is deprecated. Usage of corresponding Crystal parameters is encouraged. Table of corresponding parameters:

Deprecated parameter	Corresponding parameter
get_distance	crystal.get_distance
get_bond_vector	crystal.get_vector
get_atom_coordinates	crystal.get_atom_coordinates

ExchangeHamiltonian.get_distance(atom1, atom2)	Getter for distance between the atom1 and atom2.
ExchangeHamiltonian.get_bond_vector(atom1, atom2)	Getter for distance between the atom1 and atom2.
ExchangeHamiltonian.get_atom_coordinates(atom)	Getter for the atom coordinates.