LORBIT: Difference between revisions

From VASP Wiki
No edit summary
(10 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{TAGDEF|LORBIT|0 {{!}} 1 {{!}} 2 {{!}} 5 {{!}} 10 {{!}} 11 {{!}} 12 | None }}
{{TAGDEF|LORBIT|0 {{!}} 1 {{!}} 2 {{!}} 5 {{!}} 10 {{!}} 11 {{!}} 12 | None }}


Description: {{TAG|LORBIT}}, together with an appropriate {{TAG|RWIGS}}, determines whether the {{FILE|PROCAR}} or {{FILE|PROOUT}} files are written.
Description: Selects a projection method onto local quantum numbers (<math>lm</math>) and writes {{FILE|PROCAR}}/{{FILE|PROOUT}} file.
----
----
When {{TAG|LORBIT}} is set, VASP performs a post-processing step of the Kohn-Sham (KS) orbitals to decompose the KS orbitals into local quantum numbers (<math>lm</math>) and obtain local properties, e.g., the on-site charge density or on-site magnetic moments due to the spin degrees of freedom. The decomposition is achieved by means of one of several projection methods selected by {{TAG|LORBIT}}. All these projections rely on the fact that most of the charge density is close to the ion center, and interstitial regions separate them well. This is merely a qualitative approach in contrast to performing a [[Wannier functions|wannierization]] in order to obtain a localized basis, but often it serves as a good estimate.
{{NB|tip| As this is a post-processing step, {{TAG|LORBIT}} can be added/changed when restarting a converged calculation. To this end, set {{TAG|ALGO}}{{=}}None and the desired {{TAG|LORBIT}}, and restart from {{FILE|WAVECAR}}.}}
For VASP version < 6 with {{TAG|LORBIT}} >= 11 and {{TAG|ISYM}} = 2, see [[Known issues|known issues]].
== Projection methods ==
See the table for an overview:
:{| border="1" cellspacing="0" cellpadding="5"
:{| border="1" cellspacing="0" cellpadding="5"
|{{TAG|LORBIT}} || {{TAG|RWIGS}} tag || files written
|{{TAG|LORBIT}} || {{TAG|RWIGS}} tag || files written
Line 18: Line 25:
| 11 || ignored || {{FILE|DOSCAR}} and ''lm''-decomposed {{FILE|PROCAR}}
| 11 || ignored || {{FILE|DOSCAR}} and ''lm''-decomposed {{FILE|PROCAR}}
|-
|-
| 12 || ignored || {{FILE|DOSCAR}} and ''lm''-decomposed {{FILE|PROCAR}} + phase factors
| 12 || ignored || {{FILE|DOSCAR}} and ''lm''-decomposed {{FILE|PROCAR}} + phase factors (not recommended)
|-
|-
| 13 || ignored || {{FILE|DOSCAR}} and ''lm''-decomposed {{FILE|PROCAR}} + phase factors, choose best projector for each band
| 13 || ignored || {{FILE|DOSCAR}} and ''lm''-decomposed {{FILE|PROCAR}} + phase factors, choose best projector for each band (not recommended)
|-
|-
| 14 || ignored || {{FILE|DOSCAR}} and ''lm''-decomposed {{FILE|PROCAR}} + phase factors, choose single projector for interval EMIN,EMAX
| 14 || ignored || {{FILE|DOSCAR}} and ''lm''-decomposed {{FILE|PROCAR}} + phase factors, choose single projector for interval {{TAG|EMIN}},{{TAG|EMAX}}
|}
|}


===Remarks:===
=== For {{TAG|LORBIT}} < 10 ===  
LORBIT=13 and LORBIT=14 are only supported by version >=5.4.4. For LORBIT >= 11 and ISYM = 2 the partial charge densities are not correctly symmetrized and can result in different charges for symmetrically equivalent partial charge densities. This issue if fixed as of version >=6. For older versions of vasp a two-step procedure is recommended:  
The projection is onto spherical harmonics at each ionic site within a sphere defined by {{TAG|RWIGS}}. The radius must be specified for each atomic species, and there is some uncertainty introduced depending on the size of the sphere.
*1. Self-consistent calculation with symmetry switched on (ISYM=2)
 
*2. Recalculation of the partial charge density with symmetry switched off (ISYM=0)
=== For {{TAG|LORBIT}} >= 10 ===  
To avoid unnecessary large {{TAG|WAVECAR}} files it recommended to set {{TAG|LWAVE}}=.FALSE. in step 2
The projection uses the projector functions that are provided by the [[PAW formalism|PAW method]]. This is, of course, still a qualitative approach because also, for the PAW projectors, the radius was somehow defined, and it is not guaranteed to be the best choice for that particular system as it depends on the chemical composition and crystal or molecular structure.
 
=== Phase factors ===
 
For {{TAG|LORBIT}}>=12:
The '''phase factors''' written by VASP can usually only be used as a qualitative measure of the projection of the orbitals into the atomic sphere. The main issue is that most VASP {{FILE|POTCAR}} files have two or three projectors per <math>l</math>-quantum number, and projecting an orbital onto two projectors will yield two complex numbers. VASP combines these two numbers into a single number. The precise algorithms differ in different versions of VASP, and we recommend that you inspect the source code for more details. From vasp.6 onward, an improved scheme has been implemented and can be selected using {{TAG|LORBIT}}=14. In this case, VASP first selects a single projector for each <math>l</math>-quantum number by linearly combining all projectors with the same <math>l</math>-quantum number. This is done in such a way that the new projector is optimally chosen to represent the calculated orbitals in the energy interval specified by {{TAG|EMAX}} and {{TAG|EMIN}}. In the second step, VASP projects onto these optimized projectors, yielding a single complex number for each orbital, site and <math>l</math>-quantum number, which is written to the {{FILE|PROCAR}} file. For details we also refer to {{cite|Schuler:JPCM:2018}}.
{{TAG|LORBIT}}=12 should no longer be used except for qualitative calculations. LORBIT=13 chooses the projectors also automatically, but allows for different optimal linear combinations for each orbital.
Note that this is generally not desirable, since the resultant projection is not compatible with the required properties of a projection operator (a projection operator needs to use energy and orbital independent projectors).
Hence, do not use {{TAG|LORBIT}}=13 for anything but a qualitative analysis.
 
{{TAG|LORBIT}}=13 and {{TAG|LORBIT}}=14 are only supported by version >=5.4.4.  


The phase factors written by VASP can usually only be used as a qualitative measure of the projection of the orbitals into the atomic sphere. The main issue is
== On-site partial charge densities and magnetization ==  
that most VASP POTCAR files have two or three projectors per l-quantum number, and projecting an orbital onto two projectors will obviously yield two complex numbers. VASP
combines these two numbers into a single number. The precise algorithms differ in different versions of VASP, and we recommend that you inspect the source
code for more details. From vasp.6 onward, a new improved scheme has been implemented and can be selected using LORBIT=14. In this case, VASP first
selects a single projector for each l-quantum number by linearly combining all projectors with the same l-quantum number. This is done in such a way that the new projector is optimally chosen
to represent the calculated orbitals in the energy interval specified by {{TAG|ENMAX}} and {{TAG|ENMIN}}. In the second step, VASP projects onto these optimized
projectors yielding a single complex number for each orbital, site and l-quantum number, which is written to the PROCAR file. For details we also refer to {{cite|Schuler:JPCM:2018}}.
LORBIT=12 should no longer be used except for qualitative calculations. LORBIT=13 chooses the projectors also automatically, but allows for different optimal linear combinations for each orbital.
Note that this is generally not desirable, since the  resultant projection is not compatible with the required properties of a projection operator (a projection operator needs
to use energy and orbital independent projectors).
Hence do not use LORBIT=13 for anything but a qualitative analysis.


*If LORBIT is set the partial charge densities can be found in the {{TAGBL|OUTCAR}}
The partial charge densities can be found in the {{FILE|OUTCAR}}
  total charge     
  total charge     
   
   
Line 50: Line 57:
     1        1.514  0.000  0.000  1.514
     1        1.514  0.000  0.000  1.514
     2        0.123  0.345  0.000  0.468
     2        0.123  0.345  0.000  0.468
Here the first column corresponds to the ion index <math>\alpha</math>, the s, p, d,... columns correspond to the partial charges for <math>l=0,1,2,\cdots</math> defined as
Here, the first column corresponds to the ion index <math>\alpha</math>, the s, p, d,... columns correspond to the partial charges for <math>l=0,1,2,\cdots</math> defined as


<math>\rho_{\alpha l}=\frac{1}{N_{\bf k}} \sum_{n{\bf k}}f_{n{\bf k}} \sum_{m=-l}^{l}|\langle Y_{lm}^{\alpha}|\phi_{n\mathbf{k}}\rangle|^2
<math>\rho_{\alpha l}=\frac{1}{N_{\bf k}} \sum_{n{\bf k}}f_{n{\bf k}} \sum_{m=-l}^{l}|\langle Y_{lm}^{\alpha}|\phi_{n\mathbf{k}}\rangle|^2
</math>
</math>


The <math>\langle Y_{lm}^{\alpha}|\phi_{n\mathbf{k}}\rangle</math> are obtained from the projection of the (occupied) wavefunctions <math>|\phi_{n{\bf k}}\rangle</math> onto spherical harmonics that are non zero within spheres of a radius {{TAG|RWIGS}} centered at ion <math>\alpha</math> and
The <math>\langle Y_{lm}^{\alpha}|\phi_{n\mathbf{k}}\rangle</math> are obtained from the projection of the (occupied) KS orbitals <math>|\phi_{n{\bf k}}\rangle</math> onto spherical harmonics that are non zero within spheres of a radius {{TAG|RWIGS}} centered at ion <math>\alpha</math> and the last column is the sum <math>\sum_{l}\rho_{\alpha l}</math>.  
the last column is the sum <math>\sum_{l}\rho_{\alpha l}</math>.  


Note that depending on the system an "f" column can be found as well.  
Note that depending on the system, an "f" column is written as well.  


*In case of collinear calculations ({{TAGBL|ISPIN}}=2) the magnetization densities are written to the {{TAGBL|OUTCAR}}
*In case of spin-polarized magnetic calculations ({{TAG|ISPIN}}=2), the partial magnetization densities are written to the {{FILE|OUTCAR}}
  magnetization (x)
  magnetization (x)
    
    
Line 68: Line 74:
     2        0.000  0.245  0.000  0.245
     2        0.000  0.245  0.000  0.245


Here the magnetization density (projection axis is the z-axis) is calculated from the difference in the up and down spin channel <math>m^{\alpha l}_z = \rho_{\alpha l}^{\uparrow}-\rho_{\alpha l}^{\downarrow}
Here, the magnetization density is calculated from the difference in the up and down spin channel <math>m^{\alpha l}_z = \rho_{\alpha l}^{\uparrow}-\rho_{\alpha l}^{\downarrow}
</math>
</math>
Although the direction of the magnetization densities is meaningless in a spin-polarized calculation (no spin-orbit coupling, see {{TAG|LSORBIT}}), here the projection axis is the z-axis. This is consistent withe the behavior upon restarting a noncollinear calculation from a spin-polarized one with default {{TAG|SAXIS}}.


*In case of non-collinear calculations ({{TAGBL|LNONCOLLINEAR}}=.TRUE.) the lines after "total charge" correspond to the diagonal average  
*In case of noncollinear calculations ({{TAG|LNONCOLLINEAR}}=.TRUE.), the lines after "total charge" correspond to the diagonal average  
<math> \frac{\rho_{\alpha l}^{\uparrow\uparrow} - \rho_{\alpha l}^{\downarrow \downarrow}}{2} </math>
<math> \frac{\rho_{\alpha l}^{\uparrow\uparrow} - \rho_{\alpha l}^{\downarrow \downarrow}}{2} </math>
of the density tensor
of the density tensor


<math>
::<math>
\rho_{\alpha l} = \left(\begin{matrix}
\rho_{\alpha l} = \left(\begin{matrix}
   \rho_{\alpha l}^{\uparrow \uparrow }  &  \rho_{\alpha l}^{\uparrow \downarrow}    \\
   \rho_{\alpha l}^{\uparrow \uparrow }  &  \rho_{\alpha l}^{\uparrow \downarrow}    \\
Line 84: Line 91:
which is determined from the projected components  
which is determined from the projected components  


<math>
::<math>
\rho^{\mu\nu}_{\alpha l} = \frac{1}{N_{\bf k}} \sum_{n{\bf k}}f_{n{\bf k}} \sum_{m=-l}^{l}  
\rho^{\mu\nu}_{\alpha l} = \frac{1}{N_{\bf k}} \sum_{n{\bf k}}f_{n{\bf k}} \sum_{m=-l}^{l}  
\langle \chi_{n {\bf k}}^\mu | Y_{lm}^\alpha \rangle
\langle \chi_{n {\bf k}}^\mu | Y_{lm}^\alpha \rangle
Line 92: Line 99:
of the spinor <math>|\Psi_{n{\bf k}}\rangle=\left(\begin{matrix}\chi_{n{\bf k}}^\uparrow \\\chi_{n{\bf k}}^\downarrow \end{matrix}\right)</math>  
of the spinor <math>|\Psi_{n{\bf k}}\rangle=\left(\begin{matrix}\chi_{n{\bf k}}^\uparrow \\\chi_{n{\bf k}}^\downarrow \end{matrix}\right)</math>  


Similarly, the lines after "magnetization (x)" correspond to the partial magnetization density projected onto the x direction and two additional entries "magnetization (y)", "magnetization (z)" are written for the y and z direction and are calculated from the three Pauli matrices
Similarly, the lines after "magnetization (x)", "magnetization (y)", and "magnetization (z)"correspond to the partial magnetization density


<math>  
::<math>
\sigma^x = \left(\begin{matrix}
m_{\alpha l}^j = \frac{1}{2}\sum_{\mu,\nu=1}^2 \sigma^j_{\mu \nu} \rho_{\alpha l}^{\mu \nu}.
  0  &  1 \\
  1  &  0 \\
\end{matrix}\right), \quad
\sigma^y = \left(\begin{matrix}
  0  &  -i \\
  i  &  0 \\
\end{matrix}\right), \quad
\sigma^z = \left(\begin{matrix}
  1  &  0 \\
  0  &  -1 \\
\end{matrix}\right)
</math>
</math>


via
projected onto Pauli matrices <math>\{\sigma_1</math>, <math>\sigma_2</math>, <math>\mathbf{\sigma}_3\}</math>. By default, this corresponds to Cartesian directions <math>\sigma_1=\hat x</math>, <math>\sigma_2 =\hat y</math>, <math>\sigma_3 = \hat z</math>, but the orientation can be changed using {{TAG|SAXIS}}.
 
<math>
m_{\alpha l}^j = \frac{1}{2}\sum_{\mu,\nu=1}^2 \sigma^j_{\mu \nu} \rho_{\alpha l}^{\mu \nu}.
</math>


== References ==
== References ==
<references/>
<references/>


== Related Tags and Sections ==
== Related tags and articles ==
{{TAG|RWIGS}},
{{TAG|RWIGS}},
{{FILE|PROCAR}},
{{FILE|PROCAR}},
Line 126: Line 118:
{{sc|LORBIT|Examples|Examples that use this tag}}
{{sc|LORBIT|Examples|Examples that use this tag}}
----
----
[[The_VASP_Manual|Contents]]


[[Category:INCAR]][[Category:Electronic Minimization]][[Category:Density of States]]
[[Category:INCAR tag]][[Category:Electronic minimization]][[Category:Electronic ground-state properties]][[Category:Density of states]][[Category:Band structure]]

Revision as of 15:35, 10 June 2024

LORBIT = 0 | 1 | 2 | 5 | 10 | 11 | 12
Default: LORBIT = None 

Description: Selects a projection method onto local quantum numbers () and writes PROCAR/PROOUT file.


When LORBIT is set, VASP performs a post-processing step of the Kohn-Sham (KS) orbitals to decompose the KS orbitals into local quantum numbers () and obtain local properties, e.g., the on-site charge density or on-site magnetic moments due to the spin degrees of freedom. The decomposition is achieved by means of one of several projection methods selected by LORBIT. All these projections rely on the fact that most of the charge density is close to the ion center, and interstitial regions separate them well. This is merely a qualitative approach in contrast to performing a wannierization in order to obtain a localized basis, but often it serves as a good estimate.

Tip: As this is a post-processing step, LORBIT can be added/changed when restarting a converged calculation. To this end, set ALGO=None and the desired LORBIT, and restart from WAVECAR.

For VASP version < 6 with LORBIT >= 11 and ISYM = 2, see known issues.

Projection methods

See the table for an overview:

LORBIT RWIGS tag files written
0 required DOSCAR and PROCAR
1 required DOSCAR and lm-decomposed PROCAR
2 required DOSCAR and lm-decomposed PROCAR + phase factors
5 required DOSCAR and PROOUT
10 ignored DOSCAR and PROCAR
11 ignored DOSCAR and lm-decomposed PROCAR
12 ignored DOSCAR and lm-decomposed PROCAR + phase factors (not recommended)
13 ignored DOSCAR and lm-decomposed PROCAR + phase factors, choose best projector for each band (not recommended)
14 ignored DOSCAR and lm-decomposed PROCAR + phase factors, choose single projector for interval EMIN,EMAX

For LORBIT < 10

The projection is onto spherical harmonics at each ionic site within a sphere defined by RWIGS. The radius must be specified for each atomic species, and there is some uncertainty introduced depending on the size of the sphere.

For LORBIT >= 10

The projection uses the projector functions that are provided by the PAW method. This is, of course, still a qualitative approach because also, for the PAW projectors, the radius was somehow defined, and it is not guaranteed to be the best choice for that particular system as it depends on the chemical composition and crystal or molecular structure.

Phase factors

For LORBIT>=12: The phase factors written by VASP can usually only be used as a qualitative measure of the projection of the orbitals into the atomic sphere. The main issue is that most VASP POTCAR files have two or three projectors per -quantum number, and projecting an orbital onto two projectors will yield two complex numbers. VASP combines these two numbers into a single number. The precise algorithms differ in different versions of VASP, and we recommend that you inspect the source code for more details. From vasp.6 onward, an improved scheme has been implemented and can be selected using LORBIT=14. In this case, VASP first selects a single projector for each -quantum number by linearly combining all projectors with the same -quantum number. This is done in such a way that the new projector is optimally chosen to represent the calculated orbitals in the energy interval specified by EMAX and EMIN. In the second step, VASP projects onto these optimized projectors, yielding a single complex number for each orbital, site and -quantum number, which is written to the PROCAR file. For details we also refer to [1]. LORBIT=12 should no longer be used except for qualitative calculations. LORBIT=13 chooses the projectors also automatically, but allows for different optimal linear combinations for each orbital. Note that this is generally not desirable, since the resultant projection is not compatible with the required properties of a projection operator (a projection operator needs to use energy and orbital independent projectors). Hence, do not use LORBIT=13 for anything but a qualitative analysis.

LORBIT=13 and LORBIT=14 are only supported by version >=5.4.4.

On-site partial charge densities and magnetization

The partial charge densities can be found in the OUTCAR

total charge     

# of ion       s       p       d       tot
------------------------------------------
    1        1.514   0.000   0.000   1.514
    2        0.123   0.345   0.000   0.468

Here, the first column corresponds to the ion index , the s, p, d,... columns correspond to the partial charges for defined as

The are obtained from the projection of the (occupied) KS orbitals onto spherical harmonics that are non zero within spheres of a radius RWIGS centered at ion and the last column is the sum .

Note that depending on the system, an "f" column is written as well.

  • In case of spin-polarized magnetic calculations (ISPIN=2), the partial magnetization densities are written to the OUTCAR
magnetization (x)
 
# of ion       s       p       d       tot
------------------------------------------
    1        0.000   0.000   0.000   0.000
    2        0.000   0.245   0.000   0.245

Here, the magnetization density is calculated from the difference in the up and down spin channel Although the direction of the magnetization densities is meaningless in a spin-polarized calculation (no spin-orbit coupling, see LSORBIT), here the projection axis is the z-axis. This is consistent withe the behavior upon restarting a noncollinear calculation from a spin-polarized one with default SAXIS.

  • In case of noncollinear calculations (LNONCOLLINEAR=.TRUE.), the lines after "total charge" correspond to the diagonal average

of the density tensor

which is determined from the projected components

of the spinor

Similarly, the lines after "magnetization (x)", "magnetization (y)", and "magnetization (z)"correspond to the partial magnetization density

projected onto Pauli matrices , , . By default, this corresponds to Cartesian directions , , , but the orientation can be changed using SAXIS.

References

Related tags and articles

RWIGS, PROCAR, PROOUT, DOSCAR

Examples that use this tag