openfermion.utils.HubbardSquareLattice

A square lattice for a Hubbard model.

Inherits From: HubbardLattice

Valid edge types are:

  • 'onsite'
  • 'horizontal_neighbor'
  • 'vertical_neighbor'
  • 'neighbor': union of 'horizontal_neighbor' and 'vertical_neighbor'
  • 'diagonal_neighbor'

dof_indices

edge_types The types of edges that a term could correspond to.

Examples include 'onsite', 'neighbor', 'diagonal_neighbor', etc.

n_dofs The number of degrees of freedom per site (and spin if applicable).
n_sites The number of sites in the lattice.
n_spin_orbitals

n_spin_orbitals_per_site

n_spin_values

onsite_edge_types The edge types that connect sites to themselves.
shape

site_indices

spin_indices

spinless Whether or not the fermion has spin (False if so).

Methods

delta_mag

View source

The distance between sites X and Y in each dimension.

diagonal_neighbors_iter

View source

dof_index_offset

View source

dof_pairs_iter

View source

from_site_index

View source

from_spin_orbital_index

View source

horizontal_neighbors_iter

View source

manhattan_distance

View source

n_horizontal_neighbor_pairs

View source

Number of horizontally neighboring (unordered) pairs of sites.

n_neighbor_pairs

View source

Number of neighboring (unordered) pairs of sites.

n_vertical_neighbor_pairs

View source

Number of vertically neighboring (unordered) pairs of sites.

neighbors_iter

View source

site_index_offset

View source

site_pairs_iter

View source

Iterable over pairs of sites corresponding to the given edge type.

spin_pairs_iter

View source

to_site_index

View source

The index of a site.

to_spin_orbital_index

View source

The index of the spin orbital.

validate_dof

View source

validate_dofs

View source

validate_edge_type

View source

vertical_neighbors_iter

View source