1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
|
(calculator_interfaces)=
# Interfaces to calculators
The interfaces for VASP, WIEN2k, Quantum ESPRESSO (QE), ABINIT, Elk, SIESTA,
CRYSTAL, DFTB+, TURBOMOLE, FHI-AIMS, CASTEP, ABACUS, LAMMPS and Questaal(QLM)
are built in to the usual phonopy command. See the command options
and how to invoke each of them at {ref}`force_calculators`. {ref}`LAMMPS interface
<external_tools_phonolammps>` is provided as an external tool by Abel Carreras.
(interfaces_to_force_calculators)=
## List of force calculators
Short tutorials for the force calculators are found in the following pages.
```{toctree}
:maxdepth: 1
vasp
wien2k
qe
abinit
siesta
elk
crystal
dftb+
turbomole
cp2k
aims
castep
Fleur
abacus
lammps
qlm
```
The VASP DFPT interface reads `vasprun.xml` and creates `FORCE_CONSTANTS` file.
```{toctree}
:maxdepth: 1
vasp-dfpt
```
(interfaces-physical-units)=
## Physical unit system for calculator
Physical unit systems used for the calculators are as follows:
```
| Distance Atomic mass Force Force constants
-----------------------------------------------------------------
VASP | Angstrom AMU eV/Angstrom eV/Angstrom^2
WIEN2k | au (bohr) AMU mRy/au mRy/au^2
QE | au (bohr) AMU Ry/au Ry/au^2
ABINIT | au (bohr) AMU eV/Angstrom eV/Angstrom.au
SIESTA | au (bohr) AMU eV/Angstrom eV/Angstrom.au
Elk | au (bohr) AMU hartree/au hartree/au^2
CRYSTAL | Angstrom AMU eV/Angstrom eV/Angstrom^2
TURBOMOLE | au (bohr) AMU hartree/au hartree/au^2
CP2K | Angstrom AMU hartree/au hartree/Angstrom.au
FHI-AIMS | Angstrom AMU eV/Angstrom eV/Angstrom^2
Fleur | au (bohr) AMU hartree/au hartree/au^2
CASTEP | Angstrom AMU eV/angstrom eV/angstrom^2
ABACUS | au (bohr) AMU eV/angstrom eV/angstrom.au
LAMMPS | Angstrom AMU eV/Angstrom eV/Angstrom^2
QLM | au (bohr) AMU Ry/au Ry/au^2
```
For these sets of physical properties, phonon frequency is calculated in THz.
## Default file name, value, and conversion factor
### Default unit cell file name for calculator
Without specifying `-c` option, default file names of unit cell shown below is
searched in current directory. When generating supercells with `-c` option,
the default supercell file names based on those shown below are used.
```
VASP | POSCAR | SPOSCAR
WIEN2k | case.struct | case.structS
QE | unitcell.in | supercell.in
ABINIT | unitcell.in | supercell.in
SIESTA | input.fdf | supercell.fdf
Elk | elk.in | supercell.in
CRYSTAL | crystal.o | -
DFTB+ | geo.gen | geo.genS
TURBOMOLE | control | -
CP2K | unitcell.inp | -
FHI-AIMS | geometry.in | geometry.in.supercell
Fleur | fleur.in | supercell.in
CASTEP | unitcell.cell | supercell.cell
ABACUS | STRU | STRU.in
LAMMPS | unitcell | supercell
QLM | site.lm | supercell.lm
```
### Default displacement distances
Without specifying `DISPLACEMENT_DISTANCE` tag or `--amplitude` option, default
displacement distance is used when creating supercells with displacements
`CREATE_DISPLACEMENTS = .TRUE.` or `-d` option. The default value is dependent
on calculator, and the list is shown below:
```
VASP | 0.01 Angstrom
WIEN2k | 0.02 au (bohr)
QE | 0.02 au (bohr)
ABINIT | 0.02 au (bohr)
SIESTA | 0.02 au (bohr)
Elk | 0.02 au (bohr)
CRYSTAL | 0.01 Angstrom
DFTB+ | 0.01 au (bohr)
TURBOMOLE | 0.02 au (bohr)
CP2K | 0.01 Angstrom
FHI-AIMS | 0.01 Angstrom
Fleur | 0.02 au (bohr)
CASTEP | 0.01 Angstrom
ABACUS | 0.02 au (bohr)
LAMMPS | 0.01 Angstrom
QLM | 0.02 au (bohr)
```
(frequency_default_value_interfaces)=
### Default unit conversion factor of phonon frequency to THz
```
VASP | 15.633302
WIEN2k | 3.44595837
QE | 108.97077
ABINIT | 21.49068
SIESTA | 21.49068
Elk | 154.10794
CRYSTAL | 15.633302
DFTB+ | 154.10794
TURBOMOLE | 154.10794
CP2K | 112.10516
FHI-AIMS | 15.633302
Fleur | 154.10794
CASTEP | 15.633302
ABACUS | 21.49068
LAMMPS | 15.633302
QLM | 108.97077
```
(nac_default_value_interfaces)=
### Default unit conversion factor for non-analytical term correction
```
VASP | 14.399652
WIEN2k | 2000
QE | 2
ABINIT | 51.422090
SIESTA | 51.422090
Elk | 1
CRYSTAL | 14.399652
DFTB+ | 14.399652
TURBOMOLE | 1
CP2K | None (N/A)
FHI-AIMS | 14.399652
Fleur | 1 (but feature N/A)
CASTEP | 14.399652
ABACUS | 51.422090
LAMMPS | 14.399652
QLM | N/A
```
|
