KPOINTS: Difference between revisions

From VASP Wiki
No edit summary
Line 273: Line 273:


== Generalized regular meshes ==
== Generalized regular meshes ==
When more control about the generated mesh is desired, one can specify the generating vectors explicitly.
A typical use case would be to generate the mesh for the ''conventional'' unit cell and apply it to the ''primitive'' one.
Build a {{FILE|KPOINTS}} file for this mode starting from this template


  Automatic generation
  Automatic generation
Line 282: Line 286:
  0.00 0.00 0.00
  0.00 0.00 0.00


* If the first non-blank character on the third line of the {{FILE|KPOINTS}} file is not an ''A'', ''a'', ''M'', ''m'', ''G'' or ''g'' the third flavour of automatic mesh generation is selected: the mesh of k-points is defined by the specification of its generating basis vectors.
The mode is activated by specifying the [[#Coordinate system|coordinate system]] with the first nonblank character in line 3.
 
A ''C'', ''c'', ''K'' or ''k'' character determines that the generating basis vectors are in Cartesian coordinates.
:These generating vectors may be specified in Cartesian coordinates or in coordinates of the reciprocal lattice: if the first non-blank character is a ''C'', ''c'', ''K'' or ''k'' the generating vectors are assumed to be specified in Cartesian coordinates. Any other character (than ''a'', ''m'', ''g'', ''c'', or ''k'') implies the use of coordinates w.r.t. the reciprocal lattice vectors (reciprocal mode). We advise everyone to write ''reciprocal'', ''r'', or ''R'' to select reciprocal coordinates, since future versions of  VASP might require that the first letter agrees with ''r'' for the recipocal mode.
Use ''r'' or ''R'' to select the reciprocal coordinate system instead.
 
The latter is also the default used if VASP cannot interpret the provided character but we recommend not relying on this behavior.
* On lines 4-6 one should specify the generating vectors <math>g_1</math>, <math>g_2</math>, and <math>g_3</math>, respectively.
Otherwise, the introduction of further automatic modes in the future versions of VASP may change the interpretation of the {{FILE|KPOINTS}} file.  
:In the reciprocal mode the generating vectors are specified as:
:: <math>{\mathbf g} = x_1 {\mathbf b}_1 + x_2 {\mathbf b}_2 +  x_3 {\mathbf b}_3</math>
:where <math>{\mathbf b}_{1...3}</math> are the three reciprocal basis vectors, and <math>x_{1...3}</math> are the values you supply.
 
:In the Cartesian input format the generating vectors are given by:
::<math>{\mathbf g} =\frac{2 \pi}{a}  (x_1, x_2 , x_3).</math>
:where <math>a</math> is the scaling parameter you have specified on the second line of the {{FILE|POSCAR}} file.
 
:These generating vectors then define a mesh of k-points given by:
::<math>{\mathbf k} = {\mathbf g}_1 n_1 + {\mathbf g}_2 n_2  + {\mathbf g}_3 n_3 ,\qquad  n_1=0...,N_1-1 \quad  n_2=0...,N_2-1 \quad  n_3=0...,N_3-1 </math>
:where VASP will automatically choose <math>N_1</math>, <math>N_2</math>, and <math>N_3</math> such that all possible points of the generating mesh in the first Brillouin zone of the reciprocal lattice will be included.


:'''N.B.:''' The generating k-lattice defined by the vectors <math>g_1</math>, <math>g_2</math>, and <math>g_3</math> and the reciprocal lattice must be commensurate. This means it must be possible to express the reciprocal lattice vectors as sums of integer multiples of the generating lattice vectors. If this is not the case the code will exit in error.
VASP generates three vectors <math>\mathbf g_1</math>, <math>\mathbf g_2</math>, and <math>\mathbf g_3</math> from the coefficients <math>x_i</math> given in line 4–6.
Depending on the selected [[#Coordinate system|coordinate system]] these vectors are either multiples of the reciprocal lattice vectors
<math>\mathbf b_i</math> (reciprocal) or simply multiplying the coefficients by <math>2\pi/a</math> (Cartesian).
Here <math>a</math> is the scaling parameter you have specified on the second line of the {{FILE|POSCAR}} file.
{{NB|important|The generating vectors <math>\mathbf g_1</math>, <math>\mathbf g_2</math>, and <math>\mathbf g_3</math> must be commensurate with the reciprocal lattice. This means <math>\mathbf b_i = \textstyle \sum_{j} M_{ij} \mathbf g_j</math> where the matrix <math>M</math> contains only integer entries. If this is not the case the code will exit in error.}}


* On the seventh line one has to specify a shift of the k-point lattice w.r.t. the origin, in coordinates (<math>s_1</math>, <math>s_2</math>, <math>s_3</math>) w.r.t. the generating lattice vectors <math>g_1</math>, <math>g_2</math>, and <math>g_3</math>.
Combined with the shift (<math>s_1</math>, <math>s_2</math>, <math>s_3</math>) specified in the last line, VASP uses the generating vectors <math>\mathbf g_i</math> to construct the '''k'''-point mesh


The resulting shifted mesh of k-points is given by:
::<math>{\mathbf k} = \sum_i {\mathbf g}_i (n_i + s_i) \qquad n_i \in [0, N_i[</math>
::<math>{\mathbf k} = {\mathbf g}_1 (n_1 + s_1) + {\mathbf g}_2 (n_2 +s_2)  + {\mathbf g}_3 (n_3 + s_3) ,\qquad n_1=0...,N_1-1 \quad  n_2=0...,N_2-1 \quad  n_3=0...,N_3-1 </math>


where VASP chooses the <math>N_i</math> to include all possible points of the generating mesh in the first Brillouin zone.


From this definition and the definition of the Monkhorst-Pack meshes above it may be clear that Monkhorst-Pack meshes are a particular subset of generalized regular meshes, for which:
The [[#Regular k-point mesh|regular '''k'''-point meshes]] are a subset of the generalized regular meshes, for which
:<math>g_i=b_i/N_i, \qquad i=1,2,3</math>
::<math>\mathbf g_i = \mathbf b_i / N_i~.</math>
(i.e., the generating lattice vectors are integer subdivisions of the reciprocal lattice vectors).
Here, the generating lattice vectors are integer subdivisions of the reciprocal lattice vectors according to the <math>N_i</math> defined in the {{FILE|KPOINTS}} file.


For instance, the generalized regular mesh given by
For instance, the generalized regular mesh given by

Revision as of 07:30, 27 April 2022

The KPOINTS file specifies the Bloch vectors (k points) used to sample the Brillouin zone. Converging this sampling is one of the most important tasks in many calculations. A regular mesh is the most common choice to select k points. Choose the number of points along each direction approximately inversely proportional to the corresponding length of the unit cell. Build the KPOINTS file based on this template and read below for the exact specification.

Regular 4 x 4 x 4 mesh centered at Gamma 
0
Gamma
4 4 4

The band structure describes the eigenvalues of the orbitals throughout the Brillouin zone. It gives a detailed insight into the material determining many optical and transport properties. A band structure is often visualized along high symmetry paths. Some external tools[1][2] help to identify these points for materials of any symmetry. Use the template below to setup band-structure calculations. Alternatively, use a KPOINTS_OPT file to get the band structure as a postprocessing step after the regular calculation.

k points along high symmetry lines
 40              ! number of points per line
line mode
reciprocal
  0    0    0    gamma
  0.5  0.5  0    X

  0.5  0.5  0    X
  0.5  0.75 0.25 W

  0.5  0.75 0.25 W
  0    0    0    gamma
Tip: If the KPOINTS file is not present, the tag KSPACING determines the k-point sampling. Use that option for a quick first run but prefer generating a regular mesh for production calculations.


Coordinate system

When specifying coordinates in the KPOINTS file, use one of the following coordinate systems:

Reciprocal coordinate system
The k points are linear combinations of the reciprocal lattice vectors
Use the factors as the coordinates in KPOINTS.
Cartesian coordinate system
The coordinates directly correspond to the k point
up to the scaling factor . Here, is the scaling parameter specified on the second line of the POSCAR file.

Example: face-centered-cubic lattice

The following lattice vectors span the unit cell:

The corresponding reciprocal lattice vectors are

The following table shows several high-symmetry points of the fcc lattice expressed in Cartesian and reciprocal coordinates, respectively:

Point     Cartesian coordinates     Reciprocal coordinates
            (units of 2pi/a)         (units of b1,b2,b3)
----------------------------------------------------------
  G         (  0    0    0  )         (  0    0    0  )
  X         (  0    0    1  )         ( 1/2  1/2   0  )
  W         ( 1/2   0    1  )         ( 1/2  3/4  1/4 )
  K         ( 3/4  3/4   0  )         ( 3/8  3/8  3/4 )
  L         ( 1/2  1/2  1/2 )         ( 1/2  1/2  1/2 )

Explicit k-point mesh

When an explicit k-point mesh is provided, VASP uses exactly the provided points. The main use case of this mode is to look at particular features in the band structure for example for effective mass calculations. For regular meshes and band structures, prefer the automatic generation to avoid mistakes. Nevertheless, all other modes write the processed input in this format to IBZKPT so understanding this format helps analyze mistakes in setting up the KPOINTS file. A typical example has the following format:

Explicit k-point list
4
Cartesian
0.0  0.0  0.0   1
0.0  0.0  0.5   1
0.0  0.5  0.5   2
0.5  0.5  0.5   4
  • The first line is treated as a comment line.
  • Provide the number of k points on the second line.
  • The first character on the third line specifies the coordinate system. Use C, c, K, or k to indicate Cartesian coordinates. Any other character is interpreted as reciprocal coordinates but we advise writing reciprocal to make this clear.
  • Each following line contains the coordinates and weight of one k point. VASP takes care that weights are properly normalized so only relative weight is important. Typically the weights correspond to the symmetry degeneracy of a k point.

Use the explicit mode for

Tetrahedron method

When using the tetrahedron method (see ISMEAR), extend the list of k points by a list of all tetrahedra.

Explicit k-point list
4
Cartesian
0.0  0.0  0.0   1
0.0  0.0  0.5   1
0.0  0.5  0.5   2
0.5  0.5  0.5   4
Tetrahedra
1  0.183333333333333
6    1 2 3 4

The line following the list of k point coordinates and weights must start with 'T' or 't'. On the next line, enter the number of tetrahedra and the volume weight common to all the tetrahedra. The volume weight is simply the ratio between the volume of a tetrahedron and the volume of the first Brillouin zone.

Subsequently, list the symmetry degeneration weight and the four corner points of each tetrahedron. The four integers represent the indices of the corners of the tetrahedron in the k-point list given above. Here, the counter starts at 1 which corresponds to the k point specified in the fourth line.

Warning: VASP does not renormalize the weights of the tetrahedra. Make sure they are properly normalized.


Important: Explicitly listing all the k points is not very convenient, especially in the context of the tetrahedron method. Keep in mind that the automatic modes generate the IBZKPT file in this format. For any nontrivial case, preferably modify an automatically-generated IBZKPT instead of building an explicit list from scratch .

Regular k-point mesh

This mode will automatically generate a mesh where each lattice vector is subdivided into an explicitly defined number of subdivisions. It offers sufficient flexibility and stability and should be preferred for most production calculations. Choose the number of subdivisions , and in the KPOINTS file like this

Regular k-point mesh
0              ! 0 -> determine number of k points automatically
Gamma          ! generate a Gamma centered mesh
4  4  4        ! subdivisions N_1, N_2 and N_3 along the reciprocal lattice vectors
0  0  0        ! optional shift of the mesh (s_1, s_2, s_3)
  • The first line is a comment line.
  • In the second line, set the number of k points to 0 to indicate an automatic mesh generation.
  • The first nonblank character of the third line determines the center of the mesh. The possible choice are -centered (G, g) or the Monkhorst-Pack scheme (M, m).[7]
  • Specify the desired number of subdivisions , and in the fourth line.
  • Optionally add a fifth line to shift the mesh by with respect to the default.
-centered mesh
The following k points sample the Brillouin zone
Monkhorst-Pack mesh
The k point mesh results from this definition

The spacing between the points is the same for both meshes. The only difference is the shift in the numerator of the Monkhorst-Pack mesh. For an odd number of subdivisions, this term is an integer and because of periodic boundaries, the two meshes agree. When the number of subdivisions is even the -centered mesh is shifted by compared to the Monkhorst-Pack one.

Important: Monkhorst-Pack meshes may converge faster than -centered ones. However, carefully read the subsection on symmetry considerations to avoid breaking the symmetry with a Monkhorst-Pack mesh.

Guidelines for the choice of the subsections

As a rule of thumb, choose , , and such that

This guideline is also implemented for the automatic k-point generation using KSPACING. Nevertheless, specifying the , , and manually ensures that changes in the lattice vectors do not affect the k-point mesh. When the primitive cell has (nearly) perpendicular axes (cubic, tetragonal, orthorhombic), this is equivalent to:

Of course, this only provides a guide for the ratios between the subsections. The actual density of the k point mesh has to be increased until some relevant output quantity of the calculation is converged.

Symmetry reduction of the mesh

VASP determines the symmetry of the system. For ISYM 0, the automatically generated k-point meshes are reduced to the irreducible subset. Every k point acquires a weight following their symmetry multiplicity. This can reduce the total number of k points significantly.

Important: To enable an efficient symmetry reduction, the (shifted) regular mesh of k points should conserve the point group symmetry of the reciprocal lattice. Specifically, the generating lattice () should belong to the same class of Bravais lattice as the reciprocal lattice.

Consequently, a shifted regular mesh should not be used for some Bravais lattices. Importantly, this includes the default Monkhorst-Pack mesh for even numbers of subdivisions. Furthermore, the reciprocal lattice vectors do not in general align with lattice vectors. There is typically a difference in the subdivisions obtained from the inverse of the lattice vectors or the reciprocal lattice vectors.

In some special cases, the two options are equal, for example when the length of all vectors is the same or they are mutually perpendicular. Unfortunately, either choice yields incompatible k point meshes for some of the Bravais lattices. Consult the table below to make an informed choice depending on the symmetry of the system.

Bravais lattice variant mesh choices subsection choices
triclinic primitive -centered, Monkhorst Pack ,
monoclinic primitive -centered, Monkhorst Pack ,
base-centered -centered, Monkhorst Pack ,
orthorhombic primitive -centered, Monkhorst Pack ,
base-centered -centered, Monkhorst Pack ,
body-centered -centered, Monkhorst Pack
face-centered -centered
tetragonal primitive -centered, Monkhorst Pack ,
body-centered -centered, Monkhorst Pack
hexagonal rhombohedral -centered ,
hexagonal -centered ,
cubic primitive -centered, Monkhorst Pack ,
body-centered -centered, Monkhorst Pack ,
face-centered -centered ,
Tip: VASP issues an error when it detects an incompatible k point mesh. The specific error message depends on the particular setup but includes the name of the routine IBZKPT, some warning about the generating k-lattice, and some suggestions to overcome the problem.

Summarizing the information in the table above

  • Use only -centered meshes for face-centered cubic (fcc), hexagonal, and fcc-orthorhombic crystalline lattices.
  • Choose the ratios of the subdivisions for body-centered tetragonal and body-centered orthorhombic lattices. Keep in mind that the KSPACING uses the reciprocal lattice vectors so may not be suitable for these symmetries.
  • For face-centered orthorhombic crystal structures, choose subdivisions according to .
  • For any other symmetry, all combinations should work but changing to other subdivisions or meshes may overcome possible issues.

Solve problems with the primitive cells of the body-centered tetragonal and body/face-centered orthorhombic Bravais lattices with one of these options:

  1. Choose . For Monkhorst-Pack meshes the reciprocal lattice is always of the same Bravais lattice as the generating lattice. For body-centered tetragonal and face-centered orthorhombic primitive cells, the reciprocal lattices are body-centered tetragonal and body-centered orthorhombic, respectively. Therefore, choosing equal subdivisions is justified because the length of all reciprocal lattice vectors is the same .
  2. A simple but computationally-expensive option is to change to the conventional cell of the structure. For the body-centered tetragonal/orthorhombic structure, the conventional cell is two times bigger than the primitive cell.
  3. Alternatively, define the k-point mesh for the conventional cell. This approach requires a generalized regular mesh introduced in the next section and is demonstrated for the example of a body-centered orthorhombic lattice.

Generalized regular meshes

When more control about the generated mesh is desired, one can specify the generating vectors explicitly. A typical use case would be to generate the mesh for the conventional unit cell and apply it to the primitive one. Build a KPOINTS file for this mode starting from this template

Automatic generation
0
Cartesian
0.25 0.00 0.00
0.00 0.25 0.00
0.00 0.00 0.25
0.00 0.00 0.00

The mode is activated by specifying the coordinate system with the first nonblank character in line 3. A C, c, K or k character determines that the generating basis vectors are in Cartesian coordinates. Use r or R to select the reciprocal coordinate system instead. The latter is also the default used if VASP cannot interpret the provided character but we recommend not relying on this behavior. Otherwise, the introduction of further automatic modes in the future versions of VASP may change the interpretation of the KPOINTS file.

VASP generates three vectors , , and from the coefficients given in line 4–6. Depending on the selected coordinate system these vectors are either multiples of the reciprocal lattice vectors (reciprocal) or simply multiplying the coefficients by (Cartesian). Here is the scaling parameter you have specified on the second line of the POSCAR file.

Important: The generating vectors , , and must be commensurate with the reciprocal lattice. This means where the matrix contains only integer entries. If this is not the case the code will exit in error.

Combined with the shift (, , ) specified in the last line, VASP uses the generating vectors to construct the k-point mesh

where VASP chooses the to include all possible points of the generating mesh in the first Brillouin zone.

The regular k-point meshes are a subset of the generalized regular meshes, for which

Here, the generating lattice vectors are integer subdivisions of the reciprocal lattice vectors according to the defined in the KPOINTS file.

For instance, the generalized regular mesh given by

Automatic generation
0
Reciprocal
 0.25 0.00 0.00
 0.00 0.25 0.00
 0.00 0.00 0.25
 0.50 0.50 0.50

is equivalent to the Monkhorst-Pack mesh specified by

Automatic generation
0
Monkhorst-pack
 4 4 4
 0 0 0


A typical use-case for generalized regular meshes: to generate a mesh of k-points based on the conventional cell of a particular Bravais lattice, to be used with for instance the primitive cell of that lattice (see the subsection on symmetry considerations). As an example, consider the primitive cell of a body-centered orthorhombic lattice:

where the rows of represent the lattice vector of the primitive cell. The corresponding conventional cell is given by

and its reciprocal lattice by

Then the following generating lattice based on the reciprocal lattice of the conventional cell

yields a roughly uniform sampling of the Brillouin zone when , , and are chosen such that:

For instance, for a body-centered orthorhombic primitive cell with , here given in POSCAR file format:

body-centered orthorhombic primitive cell
5.0
-0.500000  0.600000  0.250000
 0.500000 -0.600000  0.250000
 0.500000  0.600000 -0.250000
1
direct
0.000000 0.000000 0.000000

this following KPOINTS file

Generalized regular mesh
0
Cartesian
 0.50000000  0.00000000  0.00000000
 0.00000000  0.41666667  0.00000000
 0.00000000  0.00000000  0.50000000
 0.00000000  0.00000000  0.00000000

corresponds to the aforementioned generating lattice for , , and .


Furthermore, the use of generalized regular meshes has been shown to be potentially superior to the use of Monkhorst-Pack meshes in terms of the convergence of total energy calculations with respect to the number of k-points in the irreducible part of the Brillouin zone (i.e., the resulting number of k-points after symmetry reduction).[3][4] For the moment, however, VASP is not able to automatically construct optimal generalized regular k-points meshes with a certain target sampling density (in the spirit of the aforementioned publications).

Band-structure calculations

When properties depend on the k vector, it is often convenient to visualize the property along high-symmetry lines. The line mode generates k points between user-defined points in the Brillouin zone. The most common use case is analyzing the electronic band structure.

Warning: The mesh generated by this mode is not suitable for self-consistent calculations. Please set ICHARG = 11 to avoid updating the density.

Build the KPOINTS based on this template

k points along high symmetry lines
 40              ! number of points per line
line mode
reciprocal
  0    0    0    gamma
  0.5  0.5  0    X

  0.5  0.5  0    X
  0.5  0.75 0.25 W

  0.5  0.75 0.25 W
  0    0    0    gamma
  • The first line is a comment line.
  • Specify the number of points per line segment on the second line.
  • The line mode activates when the first nonblank character on the third line is an L or l (for line mode)
  • The fourth line defines the coordinate system. Use Cartesian (C, c, K, or k) or reciprocal (any other character) coordinates.
  • Afterwards, any pair of lines define one path through the Brillouin zone. The empty lines and the label of the high-symmetry points are not required but simplify understanding the KPOINTS file. py4vasp uses the labels for the band structure plots.

The generated k-point mesh depends on the selected coordinate system. VASP produces equidistant k points for each segment such that the total of points including the endpoints equals the required number. Specifically for the template above, 40 points from to X, 40 points from X to W, and 40 points from W to . Because the endpoints are included every time, this generates two X and W points.

Transforming the same template to Cartesian coordinates produces

k points along high symmetry lines
 40              ! number of points per line
line mode
Cartesian
  0   0   0   gamma
  0   0   1   X

  0   0   1   X
  0.5 0   1   W

  0.5 0   1   W
  0   0   1   gamma

External tools[1][2] are useful to decide which paths in the Brillouin zone to include. The tools provide the coordinates and the labels for a given structure. Because these paths depend on the symmetry, take special care that the analysis is not tainted by finite precision or rounding. Also keep in mind that the primitive and the conventional unit cell have different reciprocal coordinate systems.


Here is another example for a hexagonal structure

k-points along high symmetry lines for hexagonal structure
 40
line
reciprocal
0.000    0.000    0.500  A
0.000    0.000    0.000  Gamma

0.000    0.000    0.000  Gamma 
0.500    0.000    0.000  M

0.500    0.000    0.000  M
0.333333 0.333333 0.000  K 

0.333333 0.333333 0.000  K
0.000    0.000    0.000  Gamma
Mind: The primary use of this particular mode of k-point generation is the calculation of DFT band structures. Because the mesh does not yield a good electronic density, it should only be used on a converged density. Therefore, run a calculation using a regular k-point mesh first. Freeze this density by setting ICHARG = 11 and run a non-self-consistent calculation with the line-mode k-point mesh afterward.

As of VASP.6.3, the KPOINTS_OPT file runs these two steps in a single calculation. It uses the same format and its presence triggers the postprocessing step. Use it for band structure calculations with hybrid functionals to avoid the more cumbersome previous approach.

Automatic k-point mesh

Deprecated: The KSPACING tag provides almost the same functionality. Preferably use that method instead.

The following KPOINTS file generates a regular -centered k-point. The subdivisions , , and are along the reciprocal lattice vectors , , and , respectively.

Fully automatic mesh
0              ! 0 -> automatic generation scheme 
Auto           ! fully automatic
  10           ! length (R_k)
  • The first line is a comment line.
  • Automatically determine the number of k points by setting '0' on the second line.
  • The first nonblank character in the third line is A or a activating the fully-automatic mode.
  • The fourth line defines a length () that determines the subdivisions , , and .

For every lattice vector the number of subdivisions is calculated as

Note that this similar to the KSPACING tag, when the length . The generated mesh is centered at

Useful values for the length vary between (large gap insulators) and (d metals). Please verify that changes to do not affect the quantity of interest. For production calculations, preferably specify the mesh dimensions explicitly to avoid discontinuities between different cell sizes.

Related tags and sections

KSPACING, KPOINTS_OPT

References


Contents