Name

kpoint — A description of k-points for quantum Hamiltonians.

Description

The kpoint element contains parameters defining control parameters for a kpoint.

Processing expectations

Create a set of k-points for total energy or band struture calculations.

Parents

potential

Children

The following elements occur in simulation: parameter, attrib

Attributes

datatype

Optional, the type of kpoint. The valid values of the datatype attribute are

auto

Default MP mesh is generated.

list

Use a set of the k-points and weights as listed.

band

The k-point set is determined by the start and end special k-points.

condition

Optional, the valid values of the condition attribute are

half

Default. Use all the k-points excluding the duplicates related by the time-reversal symmetry, i.e., k=-k

reduced

The number of k-point is reduced by the symmetry of the crystalline system.

band

The k-point set is a simple list for band structure calculations.

role

Optional, (none | distributed). If "distributed", the k-points can be distributed over mpi processors.

size

Optional, the number of k-points. The value of size should be provided if condition="list".

src

Optional, an external source for k-point data.

srctype

Optional, the type of an external source, if the extension is not sufficient to instruct an application what the source is.

Implementation details

The datatype attribute is an input instruction to the applications to generate a k-point set. Its value limits the valid state described by the condition.

The condition refines the property of the k-point set and reflects the state of the set in an application. It is not necessary as an input but the output document will contain the state of the k-point set appropriate for the simulation as used in the applications.

Examples

Example 5. A list of k-points and weights

This example shows how to use a list to set the k-points. This is a part of an output, root.es.kpt.xml generated by ohmms with the example to generate MP mesh.

 <kpoint datatype="list" condition="reduced" size="2">
    <attrib name="k">
      2.5000000000e-01        0.0000000000e+00        0.0000000000e+00
      2.5000000000e-01        5.0000000000e-01        0.0000000000e+00
    </attrib>
    <attrib name="weight">
      2.5000000000e-01 7.5000000000e-01
    </attrib>
 </kpoint>