Skip to content

Commit

Permalink
add docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
pablosanjose committed Nov 6, 2024
1 parent 387bf19 commit 8701c31
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions src/docstrings.jl
Original file line number Diff line number Diff line change
Expand Up @@ -2617,6 +2617,7 @@ where `U` is the onsite interaction.
- `onsite`: charge-charge onsite potential. Overrides both Hartree and Fock potentials for onsite interactions. Default: `hartree(0)`
- `charge`: a number (in single-orbital systems) or a matrix (in multi-orbital systems) representing the charge operator on each site. Default: `I`
- `nambu::Bool`: specifies whether the model is defined in Nambu space. In such case, `charge` should also be in Nambu space, typically `SA[1 0; 0 -1]` or similar. Default: `false`
- `namburotation::Bool`: if `nambu == true` and spinful systems, specifies whether the spinor basis is `[c↑, c↓, c↓⁺, -c↑⁺]` (`namburotation = true`) or `[c↑, c↓, c↑⁺, c↓⁺]` (`namburotation = false`). Default: `false`
- `selector::NamedTuple`: a collection of `hopselector` directives that defines the pairs of sites (`pair_selection` above) that interact through the charge-charge potential. Default: `(; range = 0)` (i.e. onsite)
Any additional keywords `kw` are passed to the `densitymatrix` function used to compute the
Expand Down

0 comments on commit 8701c31

Please sign in to comment.