Browse files

Added particle hole symmetry to general Hubbard model (#476)

* added magnetic field to general hubbard model

* added particle hole symmetry to general hubbard model

* added self to author lists

* renamed field_operator to magnetic_field_operator

* made magnetic field operator indexing-independent

added test for equivalence of magnetic field parameter in special and
general cases

* fixed bug in test

* renamed difference_operator to number_difference_operator

* renamed expanded name of particle_hole_symmetry parameter

* removed duplication from bad merge

* made default value of magnetic_field float-valued rather than int

* switched Number to float in arguments section of FermiHubbardModel docstring
  • Loading branch information...
bryano authored and kevinsung committed Oct 31, 2018
1 parent ffa9c50 commit 4c0df2e1e9cf641683259eba4d2736eea34da1f7
Showing with 25 additions and 13 deletions.
  1. +25 −13 src/openfermion/hamiltonians/
@@ -27,21 +27,27 @@
('dof', 'coefficient'))
def number_operator(i, coefficient=1.):
return FermionOperator(((i, 1), (i, 0)), coefficient)
def number_operator(i, coefficient=1., particle_hole_symmetry=False):
op = FermionOperator(((i, 1), (i, 0)), coefficient)
if particle_hole_symmetry:
op -= FermionOperator((), 0.5)
return op
def interaction_operator(i, j, coefficient=1.):
return number_operator(i, coefficient) * number_operator(j)
def interaction_operator(i, j, coefficient=1., particle_hole_symmetry=False):
return (number_operator(i, coefficient,
particle_hole_symmetry=particle_hole_symmetry) *
number_operator(j, particle_hole_symmetry=particle_hole_symmetry))
def tunneling_operator(i, j, coefficient):
def tunneling_operator(i, j, coefficient=1.):
return (FermionOperator(((i, 1), (j, 0)), coefficient) +
FermionOperator(((j, 1), (i, 0)), coefficient.conjugate()))
def number_difference_operator(i, j, coefficient=1.):
return number_operator(i, coefficient) - number_operator(j, coefficient)
class FermiHubbardModel:
r"""A general, parameterized Fermi-Hubbard model.
@@ -164,19 +170,22 @@ def __init__(self, lattice,
r"""A Hubbard model defined on a lattice.
lattice (HubbardLattice): The lattice on which the model is defined.
tunneling_parameters (Iterable[Tuple[Hashable, Tuple[int, int],
Number]], optional): The tunneling parameters.
float]], optional): The tunneling parameters.
interaction_parameters (Iterable[Tuple[Hashable, Tuple[int, int],
Number, int?]], optional): The interaction parameters.
potential_parameters (Iterable[Tuple[int, Number]], optional): The
float, int?]], optional): The interaction parameters.
potential_parameters (Iterable[Tuple[int, float]], optional): The
potential parameters.
magnetic_field (Number, optional): The magnetic field. Default is 0.
magnetic_field (float, optional): The magnetic field. Default is 0.
particle_hole_symmetry: If true, each number operator :math:`n` is
replaced with :math:`n - 1/2`.
Each group of parameters is specified as an iterable of tuples.
@@ -253,7 +262,7 @@ def __init__(self, lattice,
self.potential_parameters = self.parse_potential_parameters(
self.magnetic_field = magnetic_field
self.particle_hole_symmetry = particle_hole_symmetry
def parse_tunneling_parameters(self, parameters):
@@ -330,7 +339,8 @@ def interaction_terms(self):
not same_spatial_orbital):
i = self.lattice.to_spin_orbital_index(r, a, s)
j = self.lattice.to_spin_orbital_index(rr, aa, ss)
terms += interaction_operator(i, j, param.coefficient)
terms += interaction_operator(i, j, param.coefficient,
return terms
@@ -341,9 +351,11 @@ def potential_terms(self):
for spin_index in self.lattice.spin_indices:
i = self.lattice.to_spin_orbital_index(
site_index, param.dof, spin_index)
terms += number_operator(i, -param.coefficient)
terms += number_operator(i, -param.coefficient,
return terms
def field_terms(self):
terms = FermionOperator()
if self.lattice.spinless or not self.magnetic_field:

0 comments on commit 4c0df2e

Please sign in to comment.