openfermion.hamiltonians.jellium_model

Return jellium Hamiltonian as FermionOperator class.

openfermion.hamiltonians.jellium_model(
    grid: openfermion.utils.Grid,
    spinless: bool = False,
    plane_wave: bool = True,
    include_constant: bool = False,
    e_cutoff: float = None,
    non_periodic: bool = False,
    period_cutoff: Optional[float] = None
) -> openfermion.ops.FermionOperator

Used in the notebooks

Used in the tutorials

grid openfermion.utils.Grid

The discretization to use.

spinless bool

Whether to use the spinless model or not.

plane_wave bool

Whether to return in momentum space (True) or position space (False).

include_constant bool

Whether to include the Madelung constant. Note constant is unsupported for non-uniform, non-cubic cells with ions.

e_cutoff float

Energy cutoff.

non_periodic bool

If the system is non-periodic, default to False.

period_cutoff float

Period cutoff, default to grid.volume_scale() ** (1. / grid.dimensions).

FermionOperator The Hamiltonian of the model.