Difference between revisions of "Hartree Fock"

From The Yambo Project
Jump to navigation Jump to search
 
(33 intermediate revisions by 7 users not shown)
Line 1: Line 1:
== Prerequisites ==
== Prerequisites ==
* Complete the [[Generating the Yambo databases|Generating the Yambo databases]] tutorial
[[File:Yambo-handbook-v4.1.2-p-9.png|thumb|Cheatsheet on HF|150px]]
* <code>SAVE</code> folder for bulk hBN.
<!-- * Complete the [[Generating the Yambo databases|Generating the Yambo databases]] tutorial -->
* <code>yambo</code> executable
* You must first complete the "How to use Yambo" modules (''[[Input_file_generation_and_command_line_options|input file generation and command_line_options]], [[Initialization]]'')
*  Run [[Initialization]]


'''You will need''':
* The <code>SAVE</code> databases for bulk hBN
* The <code>yambo</code> executable
* <code>gnuplot</code> for plotting spectra
== Background ==
The exchange part contribution of the self-energy for a generic state (nk) in reciprocal space reads:
The exchange part contribution of the self-energy for a generic state (nk) in reciprocal space reads:
[[File:Sx.png|none|x50px|caption]]
[[File:Sx.png|none|x50px|caption]]
Line 13: Line 18:
and hence they will differ from a standard self-consistent HF calculation.
and hence they will differ from a standard self-consistent HF calculation.


Let's start by building up the input file for an HF calculation by typing:
== Input file generation ==


  $ yambo -x -V all -F hf.in
Let's start by building up an input file for a HF calculation. From <code>yambo -h</code> you should understand that the correct option is <code>yambo -x</code>:
 
$ cd YAMBO_TUTORIALS/hBN/YAMBO
$ yambo        ''(Initialization)''
  $ yambo -x -F hf.in


Looking inside the input file you will find:
Looking inside the input file you will find:


  [[Variables#EXXRLvcs|EXXRLvcs]] = 1491       RL    # [XX] Exchange RL components
  [[Variables#EXXRLvcs|EXXRLvcs]] = 3187       RL    # [XX] Exchange RL components
[[Variables#VXCRLvcs|VXCRLvcs]] = 3187        RL    # [XC] XCpotential RL components
  %[[Variables#QPkrange|QPkrange]]                    # [GW] QP generalized Kpoint/Band indices
  %[[Variables#QPkrange|QPkrange]]                    # [GW] QP generalized Kpoint/Band indices
   1| 14|  1|100|
   1| 14|  1|100|
  %
  %


The variable  [[Variables#EXXRLvcs|EXXRLvcs]]  governs the number of G vector to be summed in the expression of the exchange self-energy reported above.
The variable  [[Variables#EXXRLvcs|EXXRLvcs]]  governs the number of G vectors to be summed in the expression of the exchange self-energy reported above.
The variable [[Variables#VXCRLvcs|VXCRLvcs]]  set the number of G vectors used in the evaluation of the density for the <Vxc> matrix element. A large number is needed in order to have a precise cancellation with the ground state calculation, in particular when GGA potentials are used. A good practice is to leave it at the maximum number (default). In case it would be needed to reduce (e.g. for memory reason), the accuracy can be checked by comparing the E_xc value printed in Yambo report and QE output file.
The [[Variables#QPkrange|QPkrange]]  name list it is a generalized index needed to select the first and last kpoints and bands we want to calculate the QP correction.  
The [[Variables#QPkrange|QPkrange]]  name list it is a generalized index needed to select the first and last kpoints and bands we want to calculate the QP correction.  
In general, we are interested in the gap of the system or in the band structure across the Fermi Energy. Let's start by editing the ''hf.in'' file by selecting the last occupied and first unoccupied bands These are the bands 8 and 9 as reported in the r_setup file.   
In general, we are interested in the gap of the system or in the band structure across the Fermi Energy. Let's start by editing the ''hf.in'' file by selecting the last occupied and first unoccupied bands These are the bands 8 and 9 as reported in the r_setup file.   
Line 37: Line 48:
  [[Variables#EXXRLvcs|EXXRLvcs]]= 10 Ry
  [[Variables#EXXRLvcs|EXXRLvcs]]= 10 Ry


and run yambo:
== Calculation and analysis of output ==
Let's now run yambo:


  $ yambo -F hf.in -J 3D
  $ yambo -F hf.in -J 3D
Line 43: Line 55:
The result can be found int the output ''o-3D.hf'' file and in the ''r-3D_HF_and_locXC'' file. Looking inside the output file we have:
The result can be found int the output ''o-3D.hf'' file and in the ''r-3D_HF_and_locXC'' file. Looking inside the output file we have:


  #  K-point   Band      Eo         Ehf        DFT       HF
 
  #  K-point         Band      Eo           Ehf        Vxc (DFT)  Vnlxc (HF)
  #
  #
  1.00000   8.00000   -1.29642   -4.78877  -18.03791  -21.53026
    1.00000     8.00000     -1.29642     -4.79324    -18.03344    -21.53026
  1.000000  9.000000  4.832399  9.755138  -9.592175  -4.669436
    1.00000      9.00000      4.83239    9.755507    -9.592554    -4.669446
  2.00000   8.00000   -1.33551   -4.80180  -18.08289  -21.54919
    2.00000     8.00000     -1.33551     -4.80994    -18.07476    -21.54919
  2.00000   9.00000   7.56742   13.44057  -11.55955  -5.68641
    2.00000     9.00000     7.56742     13.43122    -11.55012    -5.68633
  ........
  ........
   
   
Looking at the definition of the HF energy, the third column is the DFT energy (KS eigenvalue), Ehf is the HF energy, and column 4 and 5 report the different contribution to be subtracted Vx (DFT) and added Σx (HF) to the unperturbed DFT eigenvalue.  From this data we can calculate the obtained HF gap: you can recognize that the direct gap is found at k-point number 7 passing from the DFT value 4.29 eV to the HF one 11.95 eV. This information can be easily found in the  
Looking at the definition of the HF energy, the third column is the DFT energy (KS eigenvalue), Ehf is the HF energy, and column 4 and 5 report the different contribution to be subtracted Vx (DFT) and added Vnlxc (HF that is Σx) to the unperturbed DFT eigenvalue.  From these data we can calculate the HF gap: you can recognize that the direct gap is found at k-point number 7,  being 4.29 eV at  DFT level and 11.95 eV in  HF approximation. This information can be also easily found in the  
report file ''r-D3_HF_and_locXC'' searching for Direct Gaps:  
report file ''r-3D_HF_and_locXC'' searching for Direct Gaps:  


Before the HF computation:   
Before the HF computation:   


  States summary        : Full        Metallic    Empty
  [X] Direct Gap                                    : 4.289853 [eV]
                          0001-0008               0009-0100
  [X] Direct Gap localized at k-point               :  7
   Indirect Gaps      [ev]: 3.877976 7.279063
   [X] Indirect Gap                                  : 3.877976 [eV]
   Direct Gaps        [ev]:  4.28985  11.35417
   [X] Indirect Gap between k-points                14  7
 


... after the HF computation:
... after the HF computation:
Line 66: Line 80:
   =============================
   =============================


   States summary        : Full        Metallic    Empty
   [Hartree-Fock] Direct Gap                        : 11.94549 [eV]
                          0001-0008              0009-0100
  [Hartree-Fock] Direct Gap localized at k-point    :  7
   Indirect Gaps      [ev]: 11.31653  16.10704
   [Hartree-Fock] Indirect Gap                      : 11.28767 [eV]
   Direct Gaps        [ev]: 11.94662 21.62986
   [Hartree-Fock] Indirect Gap between k-points      14  7
 


or simply by typing:
or simply by typing:


  $ grep "Direct Gaps" r-D3_HF_and_locXC
  $ grep "irect Gap" r-3D_HF_and_locXC


and the gap value before and after the HF correction is shown:
and the gap value before and after the HF correction is shown:
Direct Gaps        [ev]:  4.28985 11.35417
  [X] Direct Gap                                    :  4.289853 [eV]
Direct Gaps        [ev]: 11.94662 21.62986
  [X] Direct Gap localized at k-point              :  7
  [Hartree-Fock] Direct Gap                        : 11.94549 [eV]
  [Hartree-Fock] Direct Gap localized at k-point    :  7
  [Hartree-Fock] Indirect Gap                      : 11.28767 [eV]
  [Hartree-Fock] Indirect Gap between kpts          : 14  7


In the report file, the first value indicates the minimum gap while the second one is the maximum energy gap between the same bands.
 
In the report file, the first value indicates the maximum (direct) gap while the second one is the minimum (indirect) energy gap between the same bands.


In the following, in order to converge the direct gap, we will focus the K point where the direct band is found. Inspecting the ''r_setup'' file, or any other report file it can be recognized that the direct minimum gap is found at the K-point number 7  (M point): this can be seen by searching the DFT "Direct Gap" and looking at the eigenvalues reported for each k point. Note that the zero energy is fixed at the top of the valence band, K point number 14 (H point).  
In the following, in order to converge the direct gap, we will focus the K point where the direct band is found. Inspecting the ''r_setup'' file, or any other report file it can be recognized that the direct minimum gap is found at the K-point number 7  (M point): this can be seen by searching the DFT "Direct Gap" and looking at the eigenvalues reported for each k point. Note that the zero energy is fixed at the top of the valence band, K point number 14 (H point).  
So we can restrict the convergence calculations to the occupied and empty bands at point M, by modifying the input file as:
So we can restrict the convergence calculations to the occupied and empty bands at point M, by modifying the input file as follows:


  %[[Variables#QPkrange|QPkrange]]                    # [GW] QP generalized Kpoint/Band indices
  %[[Variables#QPkrange|QPkrange]]                    # [GW] QP generalized Kpoint/Band indices
Line 90: Line 108:


Even if for this case the calculations are not at all expensive, reducing the calculations to few bands when performing convergence test allows to save memory and time.  
Even if for this case the calculations are not at all expensive, reducing the calculations to few bands when performing convergence test allows to save memory and time.  
Now we can run different calculations changing the value of [[Variables#EXXRLvcs|EXXRLvcs]], let's say 10,20,30 and 40 Ry. A possible way is to build four different input files differing for the [[Variables#EXXRLvcs|EXXRLvcs]] values naming them hf_10Ry.in, hf_20Ry.in, etc..


Now we can run different calculations changing the value of [[Variables#EXXRLvcs|EXXRLvcs]], let's say to 10,20,30 and 40 Ry.
Build four different input files differing only for the [[Variables#EXXRLvcs|EXXRLvcs]] values and naming them hf_10Ry.in, hf_20Ry.in, etc.
$ cp hf.in hf_10Ry.in
  $ yambo -F hf_10Ry.in -J 3D
  $ yambo -F hf_10Ry.in -J 3D
next,
$ cp hf.in hf_20Ry.in      ''and edit file, changing EXXRLvcs to 20 Ry''
  $ yambo -F hf_20Ry.in -J 3D
  $ yambo -F hf_20Ry.in -J 3D
  .....
  .....
Line 101: Line 122:
You can use the ''grep'' command to extract these data from the output e.g by typing.
You can use the ''grep'' command to extract these data from the output e.g by typing.


  grep 8.000 o-3D.hf_*
  grep "^ *7 *8" o-3D.hf_*
and
and
  grep 9.000 o-3D.hf_*
  grep "^ *7 *9" o-3D.hf_*


and looking at the column corresponding to Ehf value (column 4).
and looking at the column corresponding to Ehf value (column 4).
For the number of G vectors corresponding to the cutoff energy cutoff in input search  ''Exchange RL vectors'' in the report files. Note that it is not possible anymore to extract directly the HF gap from the report file as we did above, as in this case, we did not include all the BZ in the calculation.
For the number of G vectors corresponding to the cutoff energy cutoff in input search  ''Exchange RL vectors'' in the report files. Note that it is not possible anymore to extract directly the HF gap from the report file as we did above, as in this case, we did not include all the BZ in the calculation.
Now it possible to plot the energy gap in function of the energy cutoff or number of Gvectors:
Now it possible to plot the energy gap in function of the energy cutoff or number of Gvectors:
you can copy in a separate file naming e.g. hf.gnu the following line:


  set key c
  $ gnuplot
set grid y
  gnuplot> plot "hf.dat" u 1:($4-$3)  w lp t "HF gap vs Energy cutoff"
set grid x
gnuplot> plot "hf.dat" u 2:($4-$3) w lp t "HF gap vs Number of G vector"
set xtics nomirror
set x2tics
set xlabel 'Cutoff Energy Ry"
set x2label 'Number of RL Vectors in Exchange'
  p "hf.dat" u 1:($4-$3)  w lp lw 2 lt -1 t "HF gap", '' using 1:($4-$3):x2tic(2) lt 7 t ''


and next
or you can plot the gap in function of both quantities using the [[gnuplot_scripts|hf.gnu]] gnuplot script:
 
$gnuplot
lo "hf.gnu"


[[File:Hf_plot1.png|none|600px|caption]]
[[File:Hf_plot1.png|none|600px|caption]]
Line 128: Line 140:
and you can see that at 40Ry the energy gap is very close to convergence. Plotting the occupied and unoccupied bands separately you can recognize that for this system the unoccupied band does converge much faster.  
and you can see that at 40Ry the energy gap is very close to convergence. Plotting the occupied and unoccupied bands separately you can recognize that for this system the unoccupied band does converge much faster.  


The last important convergence test deals with the accuracy of the integral over the Brillouin zone in the expression of the Exchange Self-Energy, which translates into K point convergence. In order to test the K point sampling, it is needed to  perform a new nscf calculation with a bigger k point grid, convert wave functions and electronic structure to Yambo databases in a different directory as explained in [[Bulk material: h-BN|DFT and p2y module on bulk hBN]], [[initialization | initialize]] the Yambo databases and redo the steps explained in this section. Now you can skip this convergence test and come back to  [[How to obtain the quasi-particle band structure of a bulk material: h-BN]] or move to the next step: the calculation of the correlation part of the Self Energy.
The last important convergence test deals with the accuracy of the integral over the Brillouin zone in the expression of the Exchange Self-Energy, which translates into K point convergence.  
In order to test the K point sampling, you should:
# perform a new non-scf calculation with a bigger k point grid,  
# convert wave functions and electronic structure to Yambo databases in a different directory as explained in the [[Bulk material: h-BN|DFT and p2y module]],  
# [[initialization |Initialize]] the Yambo databases,
# Redo the steps explained in this section.  
 
For now, however, you can skip this convergence test and continue the main tutorial (click back on your browser).
 
 


== Links ==
[[Category:Modules]]
* [[Tutorials|Back to tutorials menu]]
* [[How to obtain the quasi-particle band structure of a bulk material: h-BN | Back to How to obtain the quasi-particle band structure of a bulk material: h-BN  ]]
* Next : The Correlation Self Energy and Quasi particle Energies

Latest revision as of 10:41, 17 May 2023

Prerequisites

Cheatsheet on HF

You will need:

  • The SAVE databases for bulk hBN
  • The yambo executable
  • gnuplot for plotting spectra

Background

The exchange part contribution of the self-energy for a generic state (nk) in reciprocal space reads:

caption

It is important to note that in this way we are adding the HF contribution in a perturbative way to previously calculated DFT energies:

caption

and hence they will differ from a standard self-consistent HF calculation.

Input file generation

Let's start by building up an input file for a HF calculation. From yambo -h you should understand that the correct option is yambo -x:

$ cd YAMBO_TUTORIALS/hBN/YAMBO
$ yambo        (Initialization)
$ yambo -x -F hf.in

Looking inside the input file you will find:

EXXRLvcs = 3187        RL    # [XX] Exchange RL components
VXCRLvcs = 3187        RL    # [XC] XCpotential RL components
%QPkrange                    # [GW] QP generalized Kpoint/Band indices
  1| 14|  1|100|
%

The variable EXXRLvcs governs the number of G vectors to be summed in the expression of the exchange self-energy reported above. The variable VXCRLvcs set the number of G vectors used in the evaluation of the density for the <Vxc> matrix element. A large number is needed in order to have a precise cancellation with the ground state calculation, in particular when GGA potentials are used. A good practice is to leave it at the maximum number (default). In case it would be needed to reduce (e.g. for memory reason), the accuracy can be checked by comparing the E_xc value printed in Yambo report and QE output file. The QPkrange name list it is a generalized index needed to select the first and last kpoints and bands we want to calculate the QP correction. In general, we are interested in the gap of the system or in the band structure across the Fermi Energy. Let's start by editing the hf.in file by selecting the last occupied and first unoccupied bands These are the bands 8 and 9 as reported in the r_setup file. So we change the QPkrange variable in:

%QPkrange                    # [GW] QP generalized Kpoint/Band indices
   1| 14|  8| 9|
%

and run calculations to converge the expression above. In the expression of the Exchange Self Energy, we have a summation over bands, an integral over the Brillouin Zone and a Sum over the G vectors. Looking at the occupation factor we realize that occupied states only enters in the expression, so we do not need to worry about the bands as Yambo will include all the occupied bands by default. In order to check convergence of the G vectors in the summation in the Σx expression, we will perform different calculation varying the kinetic energy cutoff governing the number of G vectors entering in the sum. Let's start by setting in hf.in:

EXXRLvcs= 10 Ry

Calculation and analysis of output

Let's now run yambo:

$ yambo -F hf.in -J 3D

The result can be found int the output o-3D.hf file and in the r-3D_HF_and_locXC file. Looking inside the output file we have:


#  K-point          Band       Eo           Ehf        Vxc (DFT)   Vnlxc (HF)
#
    1.00000      8.00000     -1.29642     -4.79324    -18.03344    -21.53026
    1.00000      9.00000      4.83239     9.755507    -9.592554    -4.669446
    2.00000      8.00000     -1.33551     -4.80994    -18.07476    -21.54919
    2.00000      9.00000      7.56742     13.43122    -11.55012    -5.68633
........

Looking at the definition of the HF energy, the third column is the DFT energy (KS eigenvalue), Ehf is the HF energy, and column 4 and 5 report the different contribution to be subtracted Vx (DFT) and added Vnlxc (HF that is Σx) to the unperturbed DFT eigenvalue. From these data we can calculate the HF gap: you can recognize that the direct gap is found at k-point number 7, being 4.29 eV at DFT level and 11.95 eV in HF approximation. This information can be also easily found in the report file r-3D_HF_and_locXC searching for Direct Gaps:

Before the HF computation:

 [X] Direct Gap                                    :  4.289853 [eV]
 [X] Direct Gap localized at k-point               :   7
 [X] Indirect Gap                                  :  3.877976 [eV]
 [X] Indirect Gap between k-points                 :  14   7


... after the HF computation:

[05.01] HF occupations report
 =============================
 [Hartree-Fock] Direct Gap                         :  11.94549 [eV]
 [Hartree-Fock] Direct Gap localized at k-point    :   7
 [Hartree-Fock] Indirect Gap                       :  11.28767 [eV]
 [Hartree-Fock] Indirect Gap between k-points      :  14   7

or simply by typing:

$ grep "irect Gap" r-3D_HF_and_locXC

and the gap value before and after the HF correction is shown:

 [X] Direct Gap                                    :  4.289853 [eV]
 [X] Direct Gap localized at k-point               :   7
 [Hartree-Fock] Direct Gap                         :  11.94549 [eV]
 [Hartree-Fock] Direct Gap localized at k-point    :   7
 [Hartree-Fock] Indirect Gap                       :  11.28767 [eV]
 [Hartree-Fock] Indirect Gap between kpts          :  14   7


In the report file, the first value indicates the maximum (direct) gap while the second one is the minimum (indirect) energy gap between the same bands.

In the following, in order to converge the direct gap, we will focus the K point where the direct band is found. Inspecting the r_setup file, or any other report file it can be recognized that the direct minimum gap is found at the K-point number 7 (M point): this can be seen by searching the DFT "Direct Gap" and looking at the eigenvalues reported for each k point. Note that the zero energy is fixed at the top of the valence band, K point number 14 (H point). So we can restrict the convergence calculations to the occupied and empty bands at point M, by modifying the input file as follows:

%QPkrange                    # [GW] QP generalized Kpoint/Band indices
   7| 7|  8| 9|
%

Even if for this case the calculations are not at all expensive, reducing the calculations to few bands when performing convergence test allows to save memory and time.

Now we can run different calculations changing the value of EXXRLvcs, let's say to 10,20,30 and 40 Ry. Build four different input files differing only for the EXXRLvcs values and naming them hf_10Ry.in, hf_20Ry.in, etc.

$ cp hf.in hf_10Ry.in
$ yambo -F hf_10Ry.in -J 3D
$ cp hf.in hf_20Ry.in       and edit file, changing EXXRLvcs to 20 Ry
$ yambo -F hf_20Ry.in -J 3D
.....

Once the calculations are terminated, collect the results found in the output, for instance, putting in a file named hf.dat the following data: Cutoff Energy, Number of G vector in the Sum, HF energy for the occupied state (Ehf for the state 8), HF energy for the unoccupied state (Ehf for the state 9). You can use the grep command to extract these data from the output e.g by typing.

grep "^ *7 *8" o-3D.hf_*

and

grep "^ *7 *9" o-3D.hf_*

and looking at the column corresponding to Ehf value (column 4). For the number of G vectors corresponding to the cutoff energy cutoff in input search Exchange RL vectors in the report files. Note that it is not possible anymore to extract directly the HF gap from the report file as we did above, as in this case, we did not include all the BZ in the calculation. Now it possible to plot the energy gap in function of the energy cutoff or number of Gvectors:

$ gnuplot
gnuplot> plot "hf.dat" u 1:($4-$3)  w lp t "HF gap vs Energy cutoff"
gnuplot> plot "hf.dat" u 2:($4-$3)  w lp t "HF gap vs Number of G vector"

or you can plot the gap in function of both quantities using the hf.gnu gnuplot script:

caption

and you can see that at 40Ry the energy gap is very close to convergence. Plotting the occupied and unoccupied bands separately you can recognize that for this system the unoccupied band does converge much faster.

The last important convergence test deals with the accuracy of the integral over the Brillouin zone in the expression of the Exchange Self-Energy, which translates into K point convergence. In order to test the K point sampling, you should:

  1. perform a new non-scf calculation with a bigger k point grid,
  2. convert wave functions and electronic structure to Yambo databases in a different directory as explained in the DFT and p2y module,
  3. Initialize the Yambo databases,
  4. Redo the steps explained in this section.

For now, however, you can skip this convergence test and continue the main tutorial (click back on your browser).