Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision |
| documentation:language_reference:functions:createclusterhamiltonian [2024/09/16 11:44] – Sina Shokri | documentation:language_reference:functions:createclusterhamiltonian [2024/09/18 14:23] (current) – old revision restored (2024/09/16 12:17) Sina Shokri |
|---|
| ### | ### |
| The function //CreateClusterHamiltonian(TB, cluster, ...)// generates a Hamiltonian operator using the input tight-binding Object (//TB//) and the information regarding the cluster (//cluster//). The cluster can be an open cluster or a periodic one. | The function //CreateClusterHamiltonian(TB, cluster, ...)// generates a Hamiltonian operator using the input tight-binding Object (//TB//) and the information regarding the cluster (//cluster//). The cluster can be an open cluster or a periodic one. |
| | See also //[[documentation:language_reference:objects:tightbinding:start|Tight Binding]]// object. |
| ### | ### |
| |
| The last element of CreateClusterHamiltonian can be a table of options. Possible options are: | The last element of CreateClusterHamiltonian can be a table of options. Possible options are: |
| * "AddSpin": Boolean for including spin in the output Hamiltonian operator. (standard value false) | * "AddSpin": Boolean for including spin in the output Hamiltonian operator. (standard value false) |
| * "ReturnTBSuperCell": Boolean for returning the output tight-binding object | * "ReturnTBSuperCell": Boolean for returning the output tight-binding object. (standard value false) |
| | * "ReturnTBCellPositions": Boolean for returning the lattice vectors of the output periodic cluster. (standard value false) |
| | * "ReturnTBKVectors": Boolean for returning the reciprocal lattice vectors of the output periodic cluster. (standard value false) |
| | * "ReturnTBIndicesDict": Boolean for returning the dict for the indices defined for the output Hamiltonian operator (see //[[documentation:language_reference:functions:CreateAtomicIndicesDict|CreateAtomicIndicesDict()]]//). |
| | * "k": possible phase-shift in the hopping matrix elements of the output Hamiltonian operator. (standard value {0,0,0}) |
| |
| ===== Table of contents ===== | ===== Table of contents ===== |
| {{indexmenu>.#1}} | {{indexmenu>.#1}} |
| |
