nomad-parser-plugins-electronic 1.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (272) hide show
  1. electronicparsers/__init__.py +1162 -0
  2. electronicparsers/abacus/__init__.py +20 -0
  3. electronicparsers/abacus/__main__.py +32 -0
  4. electronicparsers/abacus/metainfo/__init__.py +19 -0
  5. electronicparsers/abacus/metainfo/abacus.py +836 -0
  6. electronicparsers/abacus/nomad_plugin.yaml +44 -0
  7. electronicparsers/abacus/parser.py +1975 -0
  8. electronicparsers/abinit/__init__.py +19 -0
  9. electronicparsers/abinit/__main__.py +31 -0
  10. electronicparsers/abinit/metainfo/__init__.py +20 -0
  11. electronicparsers/abinit/metainfo/abinit.py +871 -0
  12. electronicparsers/abinit/metainfo/abinit_autogenerated.py +6794 -0
  13. electronicparsers/abinit/nomad_plugin.yaml +43 -0
  14. electronicparsers/abinit/parser.py +1922 -0
  15. electronicparsers/ams/__init__.py +19 -0
  16. electronicparsers/ams/__main__.py +31 -0
  17. electronicparsers/ams/metainfo/__init__.py +19 -0
  18. electronicparsers/ams/metainfo/ams.py +769 -0
  19. electronicparsers/ams/nomad_plugin.yaml +19 -0
  20. electronicparsers/ams/parser.py +1849 -0
  21. electronicparsers/ams/rkf.py +620 -0
  22. electronicparsers/atk/__init__.py +19 -0
  23. electronicparsers/atk/__main__.py +31 -0
  24. electronicparsers/atk/metainfo/__init__.py +19 -0
  25. electronicparsers/atk/metainfo/atk.py +71 -0
  26. electronicparsers/atk/nomad_plugin.yaml +34 -0
  27. electronicparsers/atk/parser.py +388 -0
  28. electronicparsers/bigdft/__init__.py +19 -0
  29. electronicparsers/bigdft/__main__.py +31 -0
  30. electronicparsers/bigdft/metainfo/__init__.py +18 -0
  31. electronicparsers/bigdft/nomad_plugin.yaml +19 -0
  32. electronicparsers/bigdft/parser.py +372 -0
  33. electronicparsers/castep/__init__.py +19 -0
  34. electronicparsers/castep/__main__.py +31 -0
  35. electronicparsers/castep/metainfo/__init__.py +19 -0
  36. electronicparsers/castep/metainfo/castep.py +2481 -0
  37. electronicparsers/castep/nomad_plugin.yaml +28 -0
  38. electronicparsers/castep/parser.py +1680 -0
  39. electronicparsers/charmm/__init__.py +19 -0
  40. electronicparsers/charmm/__main__.py +31 -0
  41. electronicparsers/charmm/metainfo/__init__.py +19 -0
  42. electronicparsers/charmm/metainfo/charmm.py +1931 -0
  43. electronicparsers/charmm/nomad_plugin.yaml +18 -0
  44. electronicparsers/charmm/parser.py +61 -0
  45. electronicparsers/cp2k/__init__.py +19 -0
  46. electronicparsers/cp2k/__main__.py +31 -0
  47. electronicparsers/cp2k/metainfo/__init__.py +19 -0
  48. electronicparsers/cp2k/metainfo/cp2k.py +59185 -0
  49. electronicparsers/cp2k/metainfo/cp2k_general.py +1014 -0
  50. electronicparsers/cp2k/nomad_plugin.yaml +49 -0
  51. electronicparsers/cp2k/parser.py +2324 -0
  52. electronicparsers/cpmd/__init__.py +19 -0
  53. electronicparsers/cpmd/__main__.py +31 -0
  54. electronicparsers/cpmd/metainfo/__init__.py +19 -0
  55. electronicparsers/cpmd/metainfo/cpmd.py +10733 -0
  56. electronicparsers/cpmd/metainfo/cpmd_general.py +988 -0
  57. electronicparsers/cpmd/nomad_plugin.yaml +19 -0
  58. electronicparsers/cpmd/parser.py +680 -0
  59. electronicparsers/crystal/__init__.py +19 -0
  60. electronicparsers/crystal/__main__.py +31 -0
  61. electronicparsers/crystal/metainfo/__init__.py +19 -0
  62. electronicparsers/crystal/metainfo/crystal.py +619 -0
  63. electronicparsers/crystal/nomad_plugin.yaml +36 -0
  64. electronicparsers/crystal/parser.py +1745 -0
  65. electronicparsers/dmol3/__init__.py +19 -0
  66. electronicparsers/dmol3/__main__.py +31 -0
  67. electronicparsers/dmol3/metainfo/__init__.py +19 -0
  68. electronicparsers/dmol3/metainfo/dmol3.py +664 -0
  69. electronicparsers/dmol3/nomad_plugin.yaml +19 -0
  70. electronicparsers/dmol3/parser.py +750 -0
  71. electronicparsers/edmft/__init__.py +19 -0
  72. electronicparsers/edmft/__main__.py +31 -0
  73. electronicparsers/edmft/metainfo/__init__.py +19 -0
  74. electronicparsers/edmft/metainfo/edmft.py +96 -0
  75. electronicparsers/edmft/nomad_plugin.yaml +53 -0
  76. electronicparsers/edmft/parser.py +912 -0
  77. electronicparsers/elk/__init__.py +19 -0
  78. electronicparsers/elk/__main__.py +31 -0
  79. electronicparsers/elk/metainfo/__init__.py +19 -0
  80. electronicparsers/elk/metainfo/elk.py +775 -0
  81. electronicparsers/elk/nomad_plugin.yaml +19 -0
  82. electronicparsers/elk/parser.py +493 -0
  83. electronicparsers/exciting/__init__.py +19 -0
  84. electronicparsers/exciting/__main__.py +31 -0
  85. electronicparsers/exciting/metainfo/__init__.py +19 -0
  86. electronicparsers/exciting/metainfo/exciting.py +2942 -0
  87. electronicparsers/exciting/nomad_plugin.yaml +83 -0
  88. electronicparsers/exciting/parser.py +3398 -0
  89. electronicparsers/fhiaims/__init__.py +19 -0
  90. electronicparsers/fhiaims/__main__.py +31 -0
  91. electronicparsers/fhiaims/metainfo/__init__.py +19 -0
  92. electronicparsers/fhiaims/metainfo/fhi_aims.py +1565 -0
  93. electronicparsers/fhiaims/nomad_plugin.yaml +52 -0
  94. electronicparsers/fhiaims/parser.py +2582 -0
  95. electronicparsers/fleur/__init__.py +19 -0
  96. electronicparsers/fleur/__main__.py +31 -0
  97. electronicparsers/fleur/metainfo/__init__.py +19 -0
  98. electronicparsers/fleur/metainfo/fleur.py +623 -0
  99. electronicparsers/fleur/nomad_plugin.yaml +19 -0
  100. electronicparsers/fleur/parser.py +952 -0
  101. electronicparsers/fplo/__init__.py +19 -0
  102. electronicparsers/fplo/__main__.py +31 -0
  103. electronicparsers/fplo/metainfo/__init__.py +19 -0
  104. electronicparsers/fplo/metainfo/fplo.py +188 -0
  105. electronicparsers/fplo/metainfo/fplo_input_autogenerated.py +2744 -0
  106. electronicparsers/fplo/metainfo/fplo_temporaries.py +319 -0
  107. electronicparsers/fplo/nomad_plugin.yaml +19 -0
  108. electronicparsers/fplo/parser.py +42 -0
  109. electronicparsers/gamess/__init__.py +19 -0
  110. electronicparsers/gamess/__main__.py +31 -0
  111. electronicparsers/gamess/metainfo/__init__.py +19 -0
  112. electronicparsers/gamess/metainfo/gamess.py +837 -0
  113. electronicparsers/gamess/nomad_plugin.yaml +19 -0
  114. electronicparsers/gamess/parser.py +941 -0
  115. electronicparsers/gaussian/__init__.py +19 -0
  116. electronicparsers/gaussian/__main__.py +31 -0
  117. electronicparsers/gaussian/metainfo/__init__.py +19 -0
  118. electronicparsers/gaussian/metainfo/gaussian.py +1707 -0
  119. electronicparsers/gaussian/nomad_plugin.yaml +18 -0
  120. electronicparsers/gaussian/parser.py +1556 -0
  121. electronicparsers/gpaw/__init__.py +19 -0
  122. electronicparsers/gpaw/__main__.py +31 -0
  123. electronicparsers/gpaw/metainfo/__init__.py +19 -0
  124. electronicparsers/gpaw/metainfo/gpaw.py +214 -0
  125. electronicparsers/gpaw/nomad_plugin.yaml +19 -0
  126. electronicparsers/gpaw/parser.py +671 -0
  127. electronicparsers/magres/__init__.py +19 -0
  128. electronicparsers/magres/__main__.py +31 -0
  129. electronicparsers/magres/metainfo/__init__.py +19 -0
  130. electronicparsers/magres/metainfo/magres.py +110 -0
  131. electronicparsers/magres/nomad_plugin.yaml +18 -0
  132. electronicparsers/magres/parser.py +505 -0
  133. electronicparsers/molcas/__init__.py +19 -0
  134. electronicparsers/molcas/__main__.py +31 -0
  135. electronicparsers/molcas/metainfo/__init__.py +19 -0
  136. electronicparsers/molcas/metainfo/molcas.py +151 -0
  137. electronicparsers/molcas/nomad_plugin.yaml +19 -0
  138. electronicparsers/molcas/parser.py +59 -0
  139. electronicparsers/mopac/__init__.py +19 -0
  140. electronicparsers/mopac/__main__.py +31 -0
  141. electronicparsers/mopac/metainfo/__init__.py +19 -0
  142. electronicparsers/mopac/metainfo/mopac.py +79 -0
  143. electronicparsers/mopac/nomad_plugin.yaml +19 -0
  144. electronicparsers/mopac/parser.py +304 -0
  145. electronicparsers/nwchem/__init__.py +19 -0
  146. electronicparsers/nwchem/__main__.py +31 -0
  147. electronicparsers/nwchem/metainfo/__init__.py +19 -0
  148. electronicparsers/nwchem/metainfo/nwchem.py +487 -0
  149. electronicparsers/nwchem/nomad_plugin.yaml +19 -0
  150. electronicparsers/nwchem/parser.py +757 -0
  151. electronicparsers/ocean/__init__.py +19 -0
  152. electronicparsers/ocean/__main__.py +31 -0
  153. electronicparsers/ocean/metainfo/__init__.py +19 -0
  154. electronicparsers/ocean/metainfo/ocean.py +410 -0
  155. electronicparsers/ocean/nomad_plugin.yaml +37 -0
  156. electronicparsers/ocean/parser.py +344 -0
  157. electronicparsers/octopus/__init__.py +19 -0
  158. electronicparsers/octopus/__main__.py +31 -0
  159. electronicparsers/octopus/metainfo/__init__.py +19 -0
  160. electronicparsers/octopus/metainfo/octopus.py +71 -0
  161. electronicparsers/octopus/metainfo/octopus_autogenerated.py +11647 -0
  162. electronicparsers/octopus/nomad_plugin.yaml +41 -0
  163. electronicparsers/octopus/parser.py +1214 -0
  164. electronicparsers/onetep/__init__.py +19 -0
  165. electronicparsers/onetep/__main__.py +31 -0
  166. electronicparsers/onetep/metainfo/__init__.py +19 -0
  167. electronicparsers/onetep/metainfo/onetep.py +3443 -0
  168. electronicparsers/onetep/nomad_plugin.yaml +19 -0
  169. electronicparsers/onetep/parser.py +577 -0
  170. electronicparsers/openmx/__init__.py +19 -0
  171. electronicparsers/openmx/__main__.py +31 -0
  172. electronicparsers/openmx/metainfo/__init__.py +19 -0
  173. electronicparsers/openmx/metainfo/openmx.py +24 -0
  174. electronicparsers/openmx/nomad_plugin.yaml +25 -0
  175. electronicparsers/openmx/parser.py +918 -0
  176. electronicparsers/orca/__init__.py +19 -0
  177. electronicparsers/orca/__main__.py +31 -0
  178. electronicparsers/orca/metainfo/__init__.py +19 -0
  179. electronicparsers/orca/metainfo/orca.py +1448 -0
  180. electronicparsers/orca/nomad_plugin.yaml +19 -0
  181. electronicparsers/orca/parser.py +1371 -0
  182. electronicparsers/psi4/__init__.py +19 -0
  183. electronicparsers/psi4/__main__.py +31 -0
  184. electronicparsers/psi4/metainfo/__init__.py +19 -0
  185. electronicparsers/psi4/metainfo/psi4.py +372 -0
  186. electronicparsers/psi4/nomad_plugin.yaml +27 -0
  187. electronicparsers/psi4/parser.py +1362 -0
  188. electronicparsers/qball/__init__.py +19 -0
  189. electronicparsers/qball/__main__.py +31 -0
  190. electronicparsers/qball/metainfo/__init__.py +19 -0
  191. electronicparsers/qball/metainfo/qball.py +27 -0
  192. electronicparsers/qball/nomad_plugin.yaml +25 -0
  193. electronicparsers/qball/parser.py +152 -0
  194. electronicparsers/qbox/__init__.py +19 -0
  195. electronicparsers/qbox/__main__.py +31 -0
  196. electronicparsers/qbox/metainfo/__init__.py +19 -0
  197. electronicparsers/qbox/metainfo/qbox.py +490 -0
  198. electronicparsers/qbox/nomad_plugin.yaml +19 -0
  199. electronicparsers/qbox/parser.py +508 -0
  200. electronicparsers/quantumespresso/__init__.py +19 -0
  201. electronicparsers/quantumespresso/__main__.py +31 -0
  202. electronicparsers/quantumespresso/metainfo/__init__.py +19 -0
  203. electronicparsers/quantumespresso/metainfo/quantum_espresso.py +3296 -0
  204. electronicparsers/quantumespresso/nomad_plugin.yaml +31 -0
  205. electronicparsers/quantumespresso/parser.py +3594 -0
  206. electronicparsers/siesta/__init__.py +19 -0
  207. electronicparsers/siesta/__main__.py +31 -0
  208. electronicparsers/siesta/metainfo/__init__.py +19 -0
  209. electronicparsers/siesta/metainfo/siesta.py +141 -0
  210. electronicparsers/siesta/metainfo/siesta_autogenerated.py +3365 -0
  211. electronicparsers/siesta/nomad_plugin.yaml +19 -0
  212. electronicparsers/siesta/parser.py +607 -0
  213. electronicparsers/soliddmft/__init__.py +19 -0
  214. electronicparsers/soliddmft/__main__.py +31 -0
  215. electronicparsers/soliddmft/metainfo/__init__.py +19 -0
  216. electronicparsers/soliddmft/metainfo/soliddmft.py +274 -0
  217. electronicparsers/soliddmft/nomad_plugin.yaml +26 -0
  218. electronicparsers/soliddmft/parser.py +727 -0
  219. electronicparsers/tbstudio/__init__.py +19 -0
  220. electronicparsers/tbstudio/__main__.py +31 -0
  221. electronicparsers/tbstudio/metainfo/__init__.py +19 -0
  222. electronicparsers/tbstudio/metainfo/tbstudio.py +34 -0
  223. electronicparsers/tbstudio/nomad_plugin.yaml +24 -0
  224. electronicparsers/tbstudio/parser.py +412 -0
  225. electronicparsers/turbomole/__init__.py +19 -0
  226. electronicparsers/turbomole/__main__.py +31 -0
  227. electronicparsers/turbomole/metainfo/__init__.py +19 -0
  228. electronicparsers/turbomole/metainfo/turbomole.py +727 -0
  229. electronicparsers/turbomole/nomad_plugin.yaml +18 -0
  230. electronicparsers/turbomole/parser.py +1585 -0
  231. electronicparsers/utils/__init__.py +20 -0
  232. electronicparsers/utils/magres_workflow.py +61 -0
  233. electronicparsers/utils/utils.py +636 -0
  234. electronicparsers/vasp/__init__.py +19 -0
  235. electronicparsers/vasp/__main__.py +31 -0
  236. electronicparsers/vasp/metainfo/__init__.py +19 -0
  237. electronicparsers/vasp/metainfo/vasp.py +169 -0
  238. electronicparsers/vasp/metainfo/vasp_incars.py +3428 -0
  239. electronicparsers/vasp/metainfo/vasp_incarsOut.py +3428 -0
  240. electronicparsers/vasp/metainfo/vasp_incarsUnknown.py +86 -0
  241. electronicparsers/vasp/nomad_plugin.yaml +28 -0
  242. electronicparsers/vasp/parser.py +2340 -0
  243. electronicparsers/w2dynamics/__init__.py +19 -0
  244. electronicparsers/w2dynamics/__main__.py +31 -0
  245. electronicparsers/w2dynamics/metainfo/__init__.py +19 -0
  246. electronicparsers/w2dynamics/metainfo/w2dynamics.py +1270 -0
  247. electronicparsers/w2dynamics/nomad_plugin.yaml +36 -0
  248. electronicparsers/w2dynamics/parser.py +674 -0
  249. electronicparsers/wannier90/__init__.py +19 -0
  250. electronicparsers/wannier90/__main__.py +31 -0
  251. electronicparsers/wannier90/metainfo/__init__.py +19 -0
  252. electronicparsers/wannier90/metainfo/wannier90.py +56 -0
  253. electronicparsers/wannier90/nomad_plugin.yaml +34 -0
  254. electronicparsers/wannier90/parser.py +671 -0
  255. electronicparsers/wien2k/__init__.py +19 -0
  256. electronicparsers/wien2k/__main__.py +31 -0
  257. electronicparsers/wien2k/metainfo/__init__.py +19 -0
  258. electronicparsers/wien2k/metainfo/wien2k.py +783 -0
  259. electronicparsers/wien2k/nomad_plugin.yaml +18 -0
  260. electronicparsers/wien2k/parser.py +1133 -0
  261. electronicparsers/yambo/__init__.py +19 -0
  262. electronicparsers/yambo/__main__.py +31 -0
  263. electronicparsers/yambo/metainfo/__init__.py +19 -0
  264. electronicparsers/yambo/metainfo/yambo.py +577 -0
  265. electronicparsers/yambo/nomad_plugin.yaml +31 -0
  266. electronicparsers/yambo/parser.py +896 -0
  267. nomad_parser_plugins_electronic-1.0.dist-info/LICENSE +202 -0
  268. nomad_parser_plugins_electronic-1.0.dist-info/METADATA +360 -0
  269. nomad_parser_plugins_electronic-1.0.dist-info/RECORD +272 -0
  270. nomad_parser_plugins_electronic-1.0.dist-info/WHEEL +5 -0
  271. nomad_parser_plugins_electronic-1.0.dist-info/entry_points.txt +43 -0
  272. nomad_parser_plugins_electronic-1.0.dist-info/top_level.txt +1 -0
@@ -0,0 +1,3428 @@
1
+ #
2
+ # Copyright The NOMAD Authors.
3
+ #
4
+ # This file is part of NOMAD.
5
+ # See https://nomad-lab.eu for further info.
6
+ #
7
+ # Licensed under the Apache License, Version 2.0 (the "License");
8
+ # you may not use this file except in compliance with the License.
9
+ # You may obtain a copy of the License at
10
+ #
11
+ # http://www.apache.org/licenses/LICENSE-2.0
12
+ #
13
+ # Unless required by applicable law or agreed to in writing, software
14
+ # distributed under the License is distributed on an "AS IS" BASIS,
15
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16
+ # See the License for the specific language governing permissions and
17
+ # limitations under the License.
18
+ #
19
+ import numpy as np # pylint: disable=unused-import
20
+ import typing # pylint: disable=unused-import
21
+ from nomad.metainfo import ( # pylint: disable=unused-import
22
+ MSection,
23
+ MCategory,
24
+ Category,
25
+ Package,
26
+ Quantity,
27
+ Section,
28
+ SubSection,
29
+ SectionProxy,
30
+ Reference,
31
+ )
32
+ import runschema.run # pylint: disable=unused-import
33
+ import runschema.calculation # pylint: disable=unused-import
34
+ import runschema.method # pylint: disable=unused-import
35
+ import runschema.system # pylint: disable=unused-import
36
+
37
+
38
+ m_package = Package()
39
+
40
+
41
+ class x_vasp_incar_param(MCategory):
42
+ """
43
+ Incar parameters. Value stored in incar.
44
+ """
45
+
46
+ m_def = Category()
47
+
48
+
49
+ class Method(runschema.method.Method):
50
+ m_def = Section(validate=False, extends_base_section=True)
51
+
52
+ x_vasp_incar_ADDGRID = Quantity(
53
+ type=bool,
54
+ shape=[],
55
+ description="""
56
+ ADDGRID determines whether an additional support grid is used for the evaluation
57
+ of the augmentation charges.
58
+ """,
59
+ categories=[x_vasp_incar_param],
60
+ )
61
+
62
+ x_vasp_incar_AEXX = Quantity(
63
+ type=np.float64,
64
+ shape=[],
65
+ description="""
66
+ AEXX specifies the fraction of exact exchange in a Hartree-Fock/DFT hybrid
67
+ functional type calculation.
68
+ """,
69
+ categories=[x_vasp_incar_param],
70
+ )
71
+
72
+ x_vasp_incar_AGGAC = Quantity(
73
+ type=np.float64,
74
+ shape=[],
75
+ description="""
76
+ AGGAC specifies the fraction of gradient corrections to the correlation in a
77
+ Hartree-Fock/DFT hybrid functional type calculation.
78
+ """,
79
+ categories=[x_vasp_incar_param],
80
+ )
81
+
82
+ x_vasp_incar_AGGAX = Quantity(
83
+ type=np.float64,
84
+ shape=[],
85
+ description="""
86
+ AGGAX specifies the fraction of gradient corrections to the exchange in a Hartree-
87
+ Fock/DFT hybrid functional type calculation.
88
+ """,
89
+ categories=[x_vasp_incar_param],
90
+ )
91
+
92
+ x_vasp_incar_ALDAC = Quantity(
93
+ type=np.float64,
94
+ shape=[],
95
+ description="""
96
+ ALDAC specifies the fraction of LDA correlation in a Hartree-Fock/DFT hybrid
97
+ functional type calculation.
98
+ """,
99
+ categories=[x_vasp_incar_param],
100
+ )
101
+
102
+ x_vasp_incar_ALGO = Quantity(
103
+ type=str,
104
+ shape=[],
105
+ description="""
106
+ Option to specify the electronic minimisation algorithm (as of VASP.4.5) and/or to
107
+ select the type of GW calculations.
108
+ """,
109
+ categories=[x_vasp_incar_param],
110
+ )
111
+
112
+ x_vasp_incar_AMIN = Quantity(
113
+ type=np.float64,
114
+ shape=[],
115
+ description="""
116
+ AMIN specifies the minimal mixing parameter in Kerker's initial approximation to
117
+ the charge dielectric function used in the Broyden / Pulay mixing scheme (IMIX=4,
118
+ INIMIX=1).
119
+ """,
120
+ categories=[x_vasp_incar_param],
121
+ )
122
+
123
+ x_vasp_incar_AMIX = Quantity(
124
+ type=np.float64,
125
+ shape=[],
126
+ description="""
127
+ AMIX specifies the linear mixing parameter.
128
+ """,
129
+ categories=[x_vasp_incar_param],
130
+ )
131
+
132
+ x_vasp_incar_AMIX_MAG = Quantity(
133
+ type=np.float64,
134
+ shape=[],
135
+ description="""
136
+ AMIX_MAG linear mixing parameter for the magnetization density.
137
+ """,
138
+ categories=[x_vasp_incar_param],
139
+ )
140
+
141
+ x_vasp_incar_ANDERSEN_PROB = Quantity(
142
+ type=np.float64,
143
+ shape=[],
144
+ description="""
145
+ ANDERSEN_PROB sets the collision probability for the Anderson thermostat (in case
146
+ VASP was compiled with the flag -Dtbdyn).
147
+ """,
148
+ categories=[x_vasp_incar_param],
149
+ )
150
+
151
+ x_vasp_incar_ANTIRES = Quantity(
152
+ type=np.int32,
153
+ shape=[],
154
+ description="""
155
+ The flag ANTIRES determines whether the Tamm-Dancoff approximation is used or not.
156
+ """,
157
+ categories=[x_vasp_incar_param],
158
+ )
159
+
160
+ x_vasp_incar_APACO = Quantity(
161
+ type=np.float64,
162
+ shape=[],
163
+ description="""
164
+ APACO sets the maximum distance in the evaluation of the pair-correlation function
165
+ (in Angstroms).
166
+ """,
167
+ categories=[x_vasp_incar_param],
168
+ )
169
+
170
+ x_vasp_incar_BMIX = Quantity(
171
+ type=np.float64,
172
+ shape=[],
173
+ description="""
174
+ BMIX sets the cutoff wave vector for Kerker mixing scheme (IMIX = 1 and / or
175
+ INIMIX = 1).
176
+ """,
177
+ categories=[x_vasp_incar_param],
178
+ )
179
+
180
+ x_vasp_incar_BMIX_MAG = Quantity(
181
+ type=np.float64,
182
+ shape=[],
183
+ description="""
184
+ BMIX_MAG sets the cutoff wave vector for Kerker mixing scheme (IMIX=1 and/or
185
+ INIMIX=1) for the magnetization density.
186
+ """,
187
+ categories=[x_vasp_incar_param],
188
+ )
189
+
190
+ x_vasp_incar_CH_LSPEC = Quantity(
191
+ type=bool,
192
+ shape=[],
193
+ description="""
194
+ This flag controls whether the imaginary part of the dielectric function for a
195
+ selected core electron is calculated and written to the OUTCAR file or not.
196
+ """,
197
+ categories=[x_vasp_incar_param],
198
+ )
199
+
200
+ x_vasp_incar_CH_NEDOS = Quantity(
201
+ type=np.int32,
202
+ shape=[],
203
+ description="""
204
+ This tag specifies the number of frequency (energy) grid points on the x-axis in
205
+ the calculation of the dielectric function for XAS spectra.
206
+ """,
207
+ categories=[x_vasp_incar_param],
208
+ )
209
+
210
+ x_vasp_incar_CH_SIGMA = Quantity(
211
+ type=np.float64,
212
+ shape=[],
213
+ description="""
214
+ This tag specifies the broadening in eV of the imaginary dielectric function for a
215
+ core electron.
216
+ """,
217
+ categories=[x_vasp_incar_param],
218
+ )
219
+
220
+ x_vasp_incar_CLL = Quantity(
221
+ type=np.int32,
222
+ shape=[],
223
+ description="""
224
+ CLL selects the angular (l) quantum number of the excited electron when using
225
+ ICORELEVEL=2.
226
+ """,
227
+ categories=[x_vasp_incar_param],
228
+ )
229
+
230
+ x_vasp_incar_CLN = Quantity(
231
+ type=np.int32,
232
+ shape=[],
233
+ description="""
234
+ CLN selects the main quantum number of the excited electron when using
235
+ ICORELEVEL=2.
236
+ """,
237
+ categories=[x_vasp_incar_param],
238
+ )
239
+
240
+ x_vasp_incar_CLNT = Quantity(
241
+ type=np.int32,
242
+ shape=[],
243
+ description="""
244
+ CLNT selects for which species the core levels are calculated using the tag
245
+ ICORELEVEL.
246
+ """,
247
+ categories=[x_vasp_incar_param],
248
+ )
249
+
250
+ x_vasp_incar_CLZ = Quantity(
251
+ type=np.float64,
252
+ shape=[],
253
+ description="""
254
+ CLZ selects the electron count of the excited electron when using ICORELEVEL=2.
255
+ """,
256
+ categories=[x_vasp_incar_param],
257
+ )
258
+
259
+ x_vasp_incar_CMBJ = Quantity(
260
+ type=np.float64,
261
+ shape=[],
262
+ description="""
263
+ defines the _c_ parameter in the modified Becke-Johnson meta-GGA potential. NOTE:
264
+ Either specify a single value, or one value per atomic type (FIXME)
265
+ """,
266
+ categories=[x_vasp_incar_param],
267
+ )
268
+
269
+ x_vasp_incar_CMBJA = Quantity(
270
+ type=np.float64,
271
+ shape=[],
272
+ description="""
273
+ sets the $\\alpha$ parameter in the modified Becke-Johnson meta-GGA potential.
274
+ """,
275
+ categories=[x_vasp_incar_param],
276
+ )
277
+
278
+ x_vasp_incar_CMBJB = Quantity(
279
+ type=np.float64,
280
+ shape=[],
281
+ description="""
282
+ sets the $\\eta$ parameter in the modified Becke-Johnson meta-GGA potential.
283
+ """,
284
+ categories=[x_vasp_incar_param],
285
+ )
286
+
287
+ x_vasp_incar_CSHIFT = Quantity(
288
+ type=np.float64,
289
+ shape=[],
290
+ description="""
291
+ CSHIFT sets the (small) complex shift $\\eta$ in the Kramers-Kronig transformation.
292
+ """,
293
+ categories=[x_vasp_incar_param],
294
+ )
295
+
296
+ x_vasp_incar_DEPER = Quantity(
297
+ type=np.float64,
298
+ shape=[],
299
+ description="""
300
+ DEPER specifies a relative stopping criterion for the optimization of an
301
+ eigenvalue.
302
+ """,
303
+ categories=[x_vasp_incar_param],
304
+ )
305
+
306
+ x_vasp_incar_DIMER_DIST = Quantity(
307
+ type=np.float64,
308
+ shape=[],
309
+ description="""
310
+ The flag DIMER_DIST defines the step size for the numerical differentiation (in
311
+ Angstrongs) for the Improved Dimer Method.
312
+ """,
313
+ categories=[x_vasp_incar_param],
314
+ )
315
+
316
+ x_vasp_incar_DIPOL = Quantity(
317
+ type=np.float64,
318
+ shape=[3],
319
+ description="""
320
+ Specifies the center of the cell in direct lattice coordinates with respect to
321
+ which the total dipole-moment in the cell is calculated.
322
+ """,
323
+ categories=[x_vasp_incar_param],
324
+ )
325
+
326
+ x_vasp_incar_DQ = Quantity(
327
+ type=np.float64,
328
+ shape=[],
329
+ description="""
330
+ Step size for the finite difference _k_-space derivative in the linear response
331
+ calculation of chemical shifts. Typical values for DQ are in the range [0.001 -
332
+ 0.003]. The default is often sufficient
333
+ """,
334
+ categories=[x_vasp_incar_param],
335
+ )
336
+
337
+ x_vasp_incar_EBREAK = Quantity(
338
+ type=np.float64,
339
+ shape=[],
340
+ description="""
341
+ EBREAK specifies an absolute stopping criterion for the optimization of an
342
+ eigenvalue.
343
+ """,
344
+ categories=[x_vasp_incar_param],
345
+ )
346
+
347
+ x_vasp_incar_EDIFF = Quantity(
348
+ type=np.float64,
349
+ shape=[],
350
+ description="""
351
+ EDIFF specifies the global break condition for the electronic SC-loop.
352
+ """,
353
+ categories=[x_vasp_incar_param],
354
+ )
355
+
356
+ x_vasp_incar_EDIFFG = Quantity(
357
+ type=np.float64,
358
+ shape=[],
359
+ description="""
360
+ EDIFFG defines the break condition for the ionic relaxation loop.
361
+ """,
362
+ categories=[x_vasp_incar_param],
363
+ )
364
+
365
+ x_vasp_incar_EFIELD = Quantity(
366
+ type=np.float64,
367
+ shape=[],
368
+ description="""
369
+ EFIELD controls the magnitude of the applied electric force field.
370
+ """,
371
+ categories=[x_vasp_incar_param],
372
+ )
373
+
374
+ x_vasp_incar_EFIELD_PEAD = Quantity(
375
+ type=np.float64,
376
+ shape=[3],
377
+ description="""
378
+ EFIELD_PEAD specifies the homogeneous electric field in the electric enthalpy
379
+ functional used to compute the self-consistent response to finite electric
380
+ fields.
381
+ """,
382
+ categories=[x_vasp_incar_param],
383
+ )
384
+
385
+ x_vasp_incar_EINT = Quantity(
386
+ type=np.float64,
387
+ shape=[2],
388
+ description="""
389
+ Specifies the energy range of the bands that are used for the evaluation of the
390
+ partial charge density needed in Band decomposed charge densities. Check also
391
+ NBMOD and IBAND.
392
+ """,
393
+ categories=[x_vasp_incar_param],
394
+ )
395
+
396
+ x_vasp_incar_EMAX = Quantity(
397
+ type=np.float64,
398
+ shape=[],
399
+ description="""
400
+ EMAX specifies the upper boundary of the energy range for the evaluation of the
401
+ DOS.
402
+ """,
403
+ categories=[x_vasp_incar_param],
404
+ )
405
+
406
+ x_vasp_incar_EMIN = Quantity(
407
+ type=np.float64,
408
+ shape=[],
409
+ description="""
410
+ specifies the lower boundary of the energy range for the evaluation of the DOS.
411
+ """,
412
+ categories=[x_vasp_incar_param],
413
+ )
414
+
415
+ x_vasp_incar_ENAUG = Quantity(
416
+ type=np.float64,
417
+ shape=[],
418
+ description="""
419
+ ENAUG specifies the cut-off energy of the plane wave representation of the
420
+ augmentation charges in eV.
421
+ """,
422
+ categories=[x_vasp_incar_param],
423
+ )
424
+
425
+ x_vasp_incar_ENCUT = Quantity(
426
+ type=np.float64,
427
+ shape=[],
428
+ description="""
429
+ ENCUT specifies the cutoff energy for the planewave basis set in eV.
430
+ """,
431
+ categories=[x_vasp_incar_param],
432
+ )
433
+
434
+ x_vasp_incar_ENCUTFOCK = Quantity(
435
+ type=np.float64,
436
+ shape=[],
437
+ description="""
438
+ The ENCUTFOCK tag sets the energy cutoff that determines the FFT grids used by the
439
+ Hartree-Fock routines. WARNING: The flag ENCUTFOCK is no longer supported in
440
+ VASP.5.2.4 and newer versions. Please use PRECFOCK instead.
441
+ """,
442
+ categories=[x_vasp_incar_param],
443
+ )
444
+
445
+ x_vasp_incar_ENCUTGW = Quantity(
446
+ type=np.float64,
447
+ shape=[],
448
+ description="""
449
+ The tag ENCUTGW sets the energy cutoff for response function. It controls the
450
+ basis set for the response functions in exactly the same manner as ENCUT does for
451
+ the orbitals.
452
+ """,
453
+ categories=[x_vasp_incar_param],
454
+ )
455
+
456
+ x_vasp_incar_ENCUTGWSOFT = Quantity(
457
+ type=np.float64,
458
+ shape=[],
459
+ description="""
460
+ The flag ENCUTGWSOFT sets the energy cutoff for response function, such that it
461
+ allows to truncate the Coulomb kernel slowly between the energy specified by
462
+ ENCUTGWSOFT and ENCUTGW.
463
+ """,
464
+ categories=[x_vasp_incar_param],
465
+ )
466
+
467
+ x_vasp_incar_ENINI = Quantity(
468
+ type=np.float64,
469
+ shape=[],
470
+ description="""
471
+ ENINI controls the cutoff during the initial (steepest descent) phase for
472
+ IALGO=48.
473
+ """,
474
+ categories=[x_vasp_incar_param],
475
+ )
476
+
477
+ x_vasp_incar_EPSILON = Quantity(
478
+ type=np.float64,
479
+ shape=[],
480
+ description="""
481
+ EPSILON sets the dielectric constant of the medium.
482
+ """,
483
+ categories=[x_vasp_incar_param],
484
+ )
485
+
486
+ x_vasp_incar_EVENONLY = Quantity(
487
+ type=bool,
488
+ shape=[],
489
+ description="""
490
+ EVENONLY=.TRUE. selects a subset of k-points for the representation of the Fock
491
+ exchange potential, with $C_1=C_2=C_3=1$, and $n_1+n_2+n_3$ even.
492
+ """,
493
+ categories=[x_vasp_incar_param],
494
+ )
495
+
496
+ x_vasp_incar_EVENONLYGW = Quantity(
497
+ type=bool,
498
+ shape=[],
499
+ description="""
500
+ EVENONLYGW allows to restrict the k-points in the evaluation of response functions
501
+ (in GW calculations) to even values.
502
+ """,
503
+ categories=[x_vasp_incar_param],
504
+ )
505
+
506
+ x_vasp_incar_FERDO = Quantity(
507
+ type=np.float64,
508
+ shape=['x_vasp_incar_NBANDS * x_vasp_number_of_k_points'],
509
+ description="""
510
+ FERDO sets the occupancies of the states in the down-spin channel for ISMEAR=-2
511
+ and ISPIN=2.
512
+ """,
513
+ categories=[x_vasp_incar_param],
514
+ )
515
+
516
+ x_vasp_incar_FERWE = Quantity(
517
+ type=np.float64,
518
+ shape=['x_vasp_incar_NBANDS * x_vasp_number_of_k_points'],
519
+ description="""
520
+ FERWE sets the occupancies of the states for ISMEAR=-2.
521
+ """,
522
+ categories=[x_vasp_incar_param],
523
+ )
524
+
525
+ x_vasp_incar_FINDIFF = Quantity(
526
+ type=np.int32,
527
+ shape=[],
528
+ description="""
529
+ The flag DIMER_DIST defines whether a forward (FINDIFF=1) or a central (FINDIFF=2)
530
+ difference formula for the numerical differentiation to compute the curvature
531
+ along the dimer direction is used in the Improved Dimer Method.
532
+ """,
533
+ categories=[x_vasp_incar_param],
534
+ )
535
+
536
+ x_vasp_incar_GGA = Quantity(
537
+ type=str,
538
+ shape=[],
539
+ description="""
540
+ GGA specifies the type of generalized-gradient-approximation one wishes to use.
541
+ """,
542
+ categories=[x_vasp_incar_param],
543
+ )
544
+
545
+ x_vasp_incar_GGA_COMPAT = Quantity(
546
+ type=bool,
547
+ shape=[],
548
+ description="""
549
+ This flag restores the full lattice symmetry for gradient corrected functionals.
550
+ """,
551
+ categories=[x_vasp_incar_param],
552
+ )
553
+
554
+ x_vasp_incar_HFLMAX = Quantity(
555
+ type=np.int32,
556
+ shape=[],
557
+ description="""
558
+ To be compatible w.r.t. old releases, VASP also reads the flag HFLMAX to the same
559
+ effect as LMAXFOCK.
560
+ """,
561
+ categories=[x_vasp_incar_param],
562
+ )
563
+
564
+ x_vasp_incar_HFRCUT = Quantity(
565
+ type=np.float64,
566
+ shape=[],
567
+ description="""
568
+ HFRCUT specifies the spherical cutoff radius for the potential kernel in hybrid
569
+ functionals.
570
+ """,
571
+ categories=[x_vasp_incar_param],
572
+ )
573
+
574
+ x_vasp_incar_HFSCREEN = Quantity(
575
+ type=np.float64,
576
+ shape=[],
577
+ description="""
578
+ HFSCREEN specifies the range-separation parameter in range separated hybrid
579
+ functionals.
580
+ """,
581
+ categories=[x_vasp_incar_param],
582
+ )
583
+
584
+ x_vasp_incar_HILLS_BIN = Quantity(
585
+ type=np.int32,
586
+ shape=[],
587
+ description="""
588
+ HILLS_BIN sets the number of steps after which the bias potential is updated in a
589
+ metadynamics run (in case VASP was compiled with -Dtbdyn).
590
+ """,
591
+ categories=[x_vasp_incar_param],
592
+ )
593
+
594
+ x_vasp_incar_HILLS_H = Quantity(
595
+ type=np.float64,
596
+ shape=[],
597
+ description="""
598
+ HILLS_H specifies the height of the Gaussian hill (in eV) used in metadynamics (in
599
+ case VASP was compiled with -Dtbdyn).
600
+ """,
601
+ categories=[x_vasp_incar_param],
602
+ )
603
+
604
+ x_vasp_incar_HILLS_W = Quantity(
605
+ type=np.float64,
606
+ shape=[],
607
+ description="""
608
+ HILLS_W specifies the width of the Gaussian hill (in units of the corresponding
609
+ collective variable) used in metadynamics (in case VASP was compiled with
610
+ -Dtbdyn).
611
+ """,
612
+ categories=[x_vasp_incar_param],
613
+ )
614
+
615
+ x_vasp_incar_HITOLER = Quantity(
616
+ type=np.float64,
617
+ shape=[],
618
+ description="""
619
+ HITOLER specifies the convergence parameter for iterative Hirschfeld partitioning
620
+ (DFT-TS/HI).
621
+ """,
622
+ categories=[x_vasp_incar_param],
623
+ )
624
+
625
+ x_vasp_incar_I_CONSTRAINED_M = Quantity(
626
+ type=np.int32,
627
+ shape=[],
628
+ description="""
629
+ I_CONSTRAINED_M switches on the constrained local moments approach.
630
+ """,
631
+ categories=[x_vasp_incar_param],
632
+ )
633
+
634
+ x_vasp_incar_IALGO = Quantity(
635
+ type=np.int32,
636
+ shape=[],
637
+ description="""
638
+ IALGO selects the algorithm used to optimize the orbitals. WARNING
639
+ """,
640
+ categories=[x_vasp_incar_param],
641
+ )
642
+
643
+ x_vasp_incar_IBAND = Quantity(
644
+ type=np.uint32,
645
+ shape=['1..x_vasp_incar_NBANDS'],
646
+ description="""
647
+ Controls which bands are used in the calculation of Band decomposed charge
648
+ densities. Check also NBMOD and EINT.
649
+ """,
650
+ categories=[x_vasp_incar_param],
651
+ )
652
+
653
+ x_vasp_incar_IBRION = Quantity(
654
+ type=np.int32,
655
+ shape=[],
656
+ description="""
657
+ IBRION determines how the ions are updated and moved.
658
+ """,
659
+ categories=[x_vasp_incar_param],
660
+ )
661
+
662
+ x_vasp_incar_ICHARG = Quantity(
663
+ type=np.int32,
664
+ shape=[],
665
+ description="""
666
+ ICHARG determines how VASP constructs the <i>initial</i> charge density.
667
+ """,
668
+ categories=[x_vasp_incar_param],
669
+ )
670
+
671
+ x_vasp_incar_ICHIBARE = Quantity(
672
+ type=np.int32,
673
+ shape=[],
674
+ description="""
675
+ determines the order of the finite difference stencil used to calculate the
676
+ magnetic susceptibility.
677
+ """,
678
+ categories=[x_vasp_incar_param],
679
+ )
680
+
681
+ x_vasp_incar_ICORELEVEL = Quantity(
682
+ type=np.int32,
683
+ shape=[],
684
+ description="""
685
+ ICORELEVEL controls whether the core energies are explicitely calculated or not
686
+ and how they are calculated.
687
+ """,
688
+ categories=[x_vasp_incar_param],
689
+ )
690
+
691
+ x_vasp_incar_IDIPOL = Quantity(
692
+ type=np.int32,
693
+ shape=[],
694
+ description="""
695
+ IDIPOL switches on monopole/dipole and quadrupole corrections to the total energy.
696
+ """,
697
+ categories=[x_vasp_incar_param],
698
+ )
699
+
700
+ x_vasp_incar_IEPSILON = Quantity(
701
+ type=np.int32,
702
+ shape=[],
703
+ description="""
704
+ The flag IEPSILON determines along which Cartesien the E field is applied.
705
+ """,
706
+ categories=[x_vasp_incar_param],
707
+ )
708
+
709
+ x_vasp_incar_IGPAR = Quantity(
710
+ type=np.int32,
711
+ shape=[],
712
+ description="""
713
+ This tag specifies the socalled parallel or $G_{||}$ direction in the integration
714
+ over the reciprocal space unit cell needed for LCALCPOL.
715
+ """,
716
+ categories=[x_vasp_incar_param],
717
+ )
718
+
719
+ x_vasp_incar_IMAGES = Quantity(
720
+ type=np.int32,
721
+ shape=[],
722
+ description="""
723
+ IMAGES defines the number of interpolated geometries between the initial and final
724
+ state in Elastic Band calculations
725
+ """,
726
+ categories=[x_vasp_incar_param],
727
+ )
728
+
729
+ x_vasp_incar_IMIX = Quantity(
730
+ type=np.int32,
731
+ shape=[],
732
+ description="""
733
+ IMIX specifies the type of mixing.
734
+ """,
735
+ categories=[x_vasp_incar_param],
736
+ )
737
+
738
+ x_vasp_incar_INCREM = Quantity(
739
+ type=np.float64,
740
+ shape=['x'],
741
+ description="""
742
+ INCREM controls the transformation velocity in the slow-growth approach (in case
743
+ VASP was compiled with -Dtbdyn).
744
+ """,
745
+ categories=[x_vasp_incar_param],
746
+ )
747
+
748
+ x_vasp_incar_INIMIX = Quantity(
749
+ type=np.int32,
750
+ shape=[],
751
+ description="""
752
+ INIMIX determines the functional form of the initial mixing matrix in the Broyden
753
+ scheme (IMIX=4).
754
+ """,
755
+ categories=[x_vasp_incar_param],
756
+ )
757
+
758
+ x_vasp_incar_INIWAV = Quantity(
759
+ type=np.int32,
760
+ shape=[],
761
+ description="""
762
+ INIWAV specifies how to set up the initial orbitals in case ISTART=0.
763
+ """,
764
+ categories=[x_vasp_incar_param],
765
+ )
766
+
767
+ x_vasp_incar_IPEAD = Quantity(
768
+ type=np.int32,
769
+ shape=[],
770
+ description="""
771
+ IPEAD specifies the order of the finite difference stencil used to compute the
772
+ derivative of the cell-periodic part of the orbitals w.r.t. **k** (LPEAD=.TRUE.),
773
+ and the derivative of the polarization w.r.t. the orbitals, for (LCALCEPS=.TRUE.,
774
+ or EFIELD_PEAD$\\not=$0).
775
+ """,
776
+ categories=[x_vasp_incar_param],
777
+ )
778
+
779
+ x_vasp_incar_ISIF = Quantity(
780
+ type=np.int32,
781
+ shape=[],
782
+ description="""
783
+ ISIF determines whether the stress tensor is calculated and which principal
784
+ degrees-of-freedom are allowed to change in relaxation and molecular dynamics
785
+ runs.
786
+ """,
787
+ categories=[x_vasp_incar_param],
788
+ )
789
+
790
+ x_vasp_incar_ISMEAR = Quantity(
791
+ type=np.int32,
792
+ shape=[],
793
+ description="""
794
+ ISMEAR determines how the partial occupancies $f_{n\\mathbf{k}}$ are set for each
795
+ orbital. SIGMA determines the width of the smearing in eV.
796
+ """,
797
+ categories=[x_vasp_incar_param],
798
+ )
799
+
800
+ x_vasp_incar_ISPIN = Quantity(
801
+ type=np.int32,
802
+ shape=[],
803
+ description="""
804
+ ISPIN specifies spin polarization.
805
+ """,
806
+ categories=[x_vasp_incar_param],
807
+ )
808
+
809
+ x_vasp_incar_ISTART = Quantity(
810
+ type=np.int32,
811
+ shape=[],
812
+ description="""
813
+ ISTART determines whether or not to read the WAVECAR file.
814
+ """,
815
+ categories=[x_vasp_incar_param],
816
+ )
817
+
818
+ x_vasp_incar_ISYM = Quantity(
819
+ type=np.int32,
820
+ shape=[],
821
+ description="""
822
+ ISYM determines the way VASP treats symmetry.
823
+ """,
824
+ categories=[x_vasp_incar_param],
825
+ )
826
+
827
+ x_vasp_incar_IVDW = Quantity(
828
+ type=np.int32,
829
+ shape=[],
830
+ description="""
831
+ This tag controls whether vdW corrections are calculated or not. If they are
832
+ calculated IVDW controls how they are calculated.
833
+ """,
834
+ categories=[x_vasp_incar_param],
835
+ )
836
+
837
+ x_vasp_incar_IWAVPR = Quantity(
838
+ type=np.int32,
839
+ shape=[],
840
+ description="""
841
+ IWAVPR determines how orbitals and/or charge densities are extrapolated from one
842
+ ionic configuration to the next configuration.
843
+ """,
844
+ categories=[x_vasp_incar_param],
845
+ )
846
+
847
+ x_vasp_incar_KBLOCK = Quantity(
848
+ type=np.int32,
849
+ shape=[],
850
+ description="""
851
+ After KBLOCK*NBLOCK ionic steps the averaged pair correlation function and DOS are
852
+ written to the files PCDAT and DOSCAR. More details can be found on the page
853
+ describing the tag NBLOCK.
854
+ """,
855
+ categories=[x_vasp_incar_param],
856
+ )
857
+
858
+ x_vasp_incar_KGAMMA = Quantity(
859
+ type=bool,
860
+ shape=[],
861
+ description="""
862
+ Determines whether the _k_-points (determined by the tag KSPACING if KPOINTS file
863
+ is not present) are center around (KGAMMA=.TRUE.), or shifted away
864
+ (KGAMMA=.FALSE.) from the $\\Gamma$ point.
865
+ """,
866
+ categories=[x_vasp_incar_param],
867
+ )
868
+
869
+ x_vasp_incar_KPAR = Quantity(
870
+ type=np.int32,
871
+ shape=[],
872
+ description="""
873
+ KPAR determines the number of **k**-points that are to be treated in parallel
874
+ (available as of VASP.5.3.2).
875
+ """,
876
+ categories=[x_vasp_incar_param],
877
+ )
878
+
879
+ x_vasp_incar_KPOINT_BSE = Quantity(
880
+ type=np.int32,
881
+ shape=[],
882
+ description="""
883
+ The flag KPOINT_BSE allows to calculate the dielectric matrix at one of the
884
+ kpoints used to sample the Brillouin zone. NOTE: Either specify one or three
885
+ integers (FIXME)
886
+ """,
887
+ categories=[x_vasp_incar_param],
888
+ )
889
+
890
+ x_vasp_incar_KPUSE = Quantity(
891
+ type=np.int32,
892
+ shape=['1..x_vasp_number_of_k_points'],
893
+ description="""
894
+ Specifies which k-points are used in the evaluation of the partial dos (Band
895
+ decomposed charge densities).
896
+ """,
897
+ categories=[x_vasp_incar_param],
898
+ )
899
+
900
+ x_vasp_incar_KSPACING = Quantity(
901
+ type=np.float64,
902
+ shape=[],
903
+ description="""
904
+ The tag KSPACING determines the number of k-points if the KPOINTS file is not
905
+ present.
906
+ """,
907
+ categories=[x_vasp_incar_param],
908
+ )
909
+
910
+ x_vasp_incar_LADDER = Quantity(
911
+ type=bool,
912
+ shape=[],
913
+ description="""
914
+ Controls whether the ladder diagrams are included in the BSE calculation.
915
+ """,
916
+ categories=[x_vasp_incar_param],
917
+ )
918
+
919
+ x_vasp_incar_LAECHG = Quantity(
920
+ type=bool,
921
+ shape=[],
922
+ description="""
923
+ When LAECHG=.TRUE. the all-electron charge density will be reconstructed
924
+ explicitly and written out to file.
925
+ """,
926
+ categories=[x_vasp_incar_param],
927
+ )
928
+
929
+ x_vasp_incar_LAMBDA = Quantity(
930
+ type=np.float64,
931
+ shape=[],
932
+ description="""
933
+ LAMBDA sets the weight with which the penalty terms of the constrained local
934
+ moment approach enter into the total energy expression and the Hamiltonian.
935
+ """,
936
+ categories=[x_vasp_incar_param],
937
+ )
938
+
939
+ x_vasp_incar_LANGEVIN_GAMMA = Quantity(
940
+ type=np.float64,
941
+ shape=['number_of_atomic_species'],
942
+ description="""
943
+ LANGEVIN_GAMMA specifies the friction coefficients (in ps$^{-1}$) for atomic
944
+ degrees-of-freedom when using a Langevin thermostat (in case VASP was compiled
945
+ with -Dtbdyn).
946
+ """,
947
+ categories=[x_vasp_incar_param],
948
+ )
949
+
950
+ x_vasp_incar_LANGEVIN_GAMMA_L = Quantity(
951
+ type=np.float64,
952
+ shape=[],
953
+ description="""
954
+ LANGEVIN_GAMMA_L specifies the friction coefficient (in ps$^{-1}$) for lattice
955
+ degrees-of-freedom in case of Parrinello-Rahman dynamics (in case VASP was
956
+ compiled with -Dtbdyn).
957
+ """,
958
+ categories=[x_vasp_incar_param],
959
+ )
960
+
961
+ x_vasp_incar_LASPH = Quantity(
962
+ type=bool,
963
+ shape=[],
964
+ description="""
965
+ include non-spherical contributions related to the gradient of the density in the
966
+ PAW spheres.
967
+ """,
968
+ categories=[x_vasp_incar_param],
969
+ )
970
+
971
+ x_vasp_incar_LASYNC = Quantity(
972
+ type=bool,
973
+ shape=[],
974
+ description="""
975
+ This tag controls the overlap in communication.
976
+ """,
977
+ categories=[x_vasp_incar_param],
978
+ )
979
+
980
+ x_vasp_incar_LATTICE_CONSTRAINTS = Quantity(
981
+ type=bool,
982
+ shape=[3],
983
+ description="""
984
+ The tag LATTICE_CONSTRAINTS determines whether the lattice dynamics are released
985
+ (LATTICE_CONSTRAINTS=.TRUE.) in the given directions or not.
986
+ """,
987
+ categories=[x_vasp_incar_param],
988
+ )
989
+
990
+ x_vasp_incar_LBERRY = Quantity(
991
+ type=bool,
992
+ shape=[],
993
+ description="""
994
+ This tag is used in the the evaluation of the Berry phase expression for the
995
+ electronic polarization of an insulating system.
996
+ """,
997
+ categories=[x_vasp_incar_param],
998
+ )
999
+
1000
+ x_vasp_incar_LBLUEOUT = Quantity(
1001
+ type=bool,
1002
+ shape=[],
1003
+ description="""
1004
+ for LBLUEOUT=.TRUE., VASP writes output for the free-energy gradient calculation
1005
+ to the REPORT-file (in case VASP was compiled with -Dtbdyn).
1006
+ """,
1007
+ categories=[x_vasp_incar_param],
1008
+ )
1009
+
1010
+ x_vasp_incar_LBONE = Quantity(
1011
+ type=bool,
1012
+ shape=[],
1013
+ description="""
1014
+ LBONE adds the small B-component to the chemical shift tensor.
1015
+ """,
1016
+ categories=[x_vasp_incar_param],
1017
+ )
1018
+
1019
+ x_vasp_incar_LCALCEPS = Quantity(
1020
+ type=bool,
1021
+ shape=[],
1022
+ description="""
1023
+ for LCALCEPS=.TRUE. the macroscopic ion-clamped static dielectric tensor, Born
1024
+ effective charge tensors, and the ion-clamped piezoelectric tensor of the system
1025
+ are determined from the response to finite electric fields.
1026
+ """,
1027
+ categories=[x_vasp_incar_param],
1028
+ )
1029
+
1030
+ x_vasp_incar_LCALCPOL = Quantity(
1031
+ type=bool,
1032
+ shape=[],
1033
+ description="""
1034
+ LCALCPOL=.TRUE. switches on the evaluation of the Berry phase expressions for the
1035
+ macroscopic electronic polarization in accordance with the so-called Modern Theory
1036
+ of Polarization.
1037
+ """,
1038
+ categories=[x_vasp_incar_param],
1039
+ )
1040
+
1041
+ x_vasp_incar_LCHARG = Quantity(
1042
+ type=bool,
1043
+ shape=[],
1044
+ description="""
1045
+ LCHARG determines whether the charge densities (files CHGCAR and CHG) are written.
1046
+ """,
1047
+ categories=[x_vasp_incar_param],
1048
+ )
1049
+
1050
+ x_vasp_incar_LCHIMAG = Quantity(
1051
+ type=bool,
1052
+ shape=[],
1053
+ description="""
1054
+ calculate the chemical shifts by means of linear response.
1055
+ """,
1056
+ categories=[x_vasp_incar_param],
1057
+ )
1058
+
1059
+ x_vasp_incar_LCORR = Quantity(
1060
+ type=bool,
1061
+ shape=[],
1062
+ description="""
1063
+ Controls whether Harris corrections are calculated or not.
1064
+ """,
1065
+ categories=[x_vasp_incar_param],
1066
+ )
1067
+
1068
+ x_vasp_incar_LDAU = Quantity(
1069
+ type=bool,
1070
+ shape=[],
1071
+ description="""
1072
+ LDAU=.TRUE. switches on the L(S)DA+U.
1073
+ """,
1074
+ categories=[x_vasp_incar_param],
1075
+ )
1076
+
1077
+ x_vasp_incar_LDAUJ = Quantity(
1078
+ type=np.float64,
1079
+ shape=['number_of_atomic_species'],
1080
+ description="""
1081
+ LDAUJ specifies the strength of the effective on-site exchange interactions.
1082
+ """,
1083
+ categories=[x_vasp_incar_param],
1084
+ )
1085
+
1086
+ x_vasp_incar_LDAUL = Quantity(
1087
+ type=np.int32,
1088
+ shape=['number_of_atomic_species'],
1089
+ description="""
1090
+ LDAUL specifies the _l_-quantum number for which the on-site interaction is added.
1091
+ """,
1092
+ categories=[x_vasp_incar_param],
1093
+ )
1094
+
1095
+ x_vasp_incar_LDAUPRINT = Quantity(
1096
+ type=np.int32,
1097
+ shape=[],
1098
+ description="""
1099
+ LDAUPRINT controls the verbosity of the L(S)DA+U routines.
1100
+ """,
1101
+ categories=[x_vasp_incar_param],
1102
+ )
1103
+
1104
+ x_vasp_incar_LDAUTYPE = Quantity(
1105
+ type=np.int32,
1106
+ shape=[],
1107
+ description="""
1108
+ LDAUTYPE specifies which type of L(S)DA+U approach will be used.
1109
+ """,
1110
+ categories=[x_vasp_incar_param],
1111
+ )
1112
+
1113
+ x_vasp_incar_LDAUU = Quantity(
1114
+ type=np.float64,
1115
+ shape=['number_of_atomic_species'],
1116
+ description="""
1117
+ LDAUU specifies the strength of the effective on-site Coulomb interactions.
1118
+ """,
1119
+ categories=[x_vasp_incar_param],
1120
+ )
1121
+
1122
+ x_vasp_incar_LDIAG = Quantity(
1123
+ type=bool,
1124
+ shape=[],
1125
+ description="""
1126
+ This tag determines whether a subspace diagonalization is performed or not within
1127
+ the main algorithm selected by IALGO.
1128
+ """,
1129
+ categories=[x_vasp_incar_param],
1130
+ )
1131
+
1132
+ x_vasp_incar_LDIPOL = Quantity(
1133
+ type=bool,
1134
+ shape=[],
1135
+ description="""
1136
+ LDIPOL switches on corrections to the potential and forces in VASP. Can be applied
1137
+ for charged molecules and molecules and slabs with a net dipole moment.
1138
+ """,
1139
+ categories=[x_vasp_incar_param],
1140
+ )
1141
+
1142
+ x_vasp_incar_LEFG = Quantity(
1143
+ type=bool,
1144
+ shape=[],
1145
+ description="""
1146
+ The LEFG Computes the Electric Field Gradient at positions of the atomic nuclei.
1147
+ """,
1148
+ categories=[x_vasp_incar_param],
1149
+ )
1150
+
1151
+ x_vasp_incar_LELF = Quantity(
1152
+ type=bool,
1153
+ shape=[],
1154
+ description="""
1155
+ LELF determines whether to create an ELFCAR file or not.
1156
+ """,
1157
+ categories=[x_vasp_incar_param],
1158
+ )
1159
+
1160
+ x_vasp_incar_LEPSILON = Quantity(
1161
+ type=bool,
1162
+ shape=[],
1163
+ description="""
1164
+ LEPSILON=.TRUE. determines the static dielectric matrix, ion-clamped piezoelectric
1165
+ tensor and the Born effective charges using density functional perturbation
1166
+ theory.
1167
+ """,
1168
+ categories=[x_vasp_incar_param],
1169
+ )
1170
+
1171
+ x_vasp_incar_LFOCKAEDFT = Quantity(
1172
+ type=bool,
1173
+ shape=[],
1174
+ description="""
1175
+ LFOCKAEDFT forces VASP to use the same charge augmentation for the Hartree and DFT
1176
+ exchange correlation part as is used in the Fock exchange and the many body beyond
1177
+ DFT methods, such as RPA, MP2 etc.
1178
+ """,
1179
+ categories=[x_vasp_incar_param],
1180
+ )
1181
+
1182
+ x_vasp_incar_LHARTREE = Quantity(
1183
+ type=bool,
1184
+ shape=[],
1185
+ description="""
1186
+ Controls whether the bubble diagrams are included in the BSE calculation.
1187
+ """,
1188
+ categories=[x_vasp_incar_param],
1189
+ )
1190
+
1191
+ x_vasp_incar_LHFCALC = Quantity(
1192
+ type=bool,
1193
+ shape=[],
1194
+ description="""
1195
+ LHFCALC specifies whether Hartree-Fock/DFT hybrid functional type calculations are
1196
+ performed.
1197
+ """,
1198
+ categories=[x_vasp_incar_param],
1199
+ )
1200
+
1201
+ x_vasp_incar_LHYPERFINE = Quantity(
1202
+ type=bool,
1203
+ shape=[],
1204
+ description="""
1205
+ compute the hyperfine tensors at the atomic sites (available as of vasp.5.3.2).
1206
+ """,
1207
+ categories=[x_vasp_incar_param],
1208
+ )
1209
+
1210
+ x_vasp_incar_LKPROJ = Quantity(
1211
+ type=bool,
1212
+ shape=[],
1213
+ description="""
1214
+ switches on the **k**-point projection scheme.
1215
+ """,
1216
+ categories=[x_vasp_incar_param],
1217
+ )
1218
+
1219
+ x_vasp_incar_LLRAUG = Quantity(
1220
+ type=bool,
1221
+ shape=[],
1222
+ description="""
1223
+ LLRAUG calculates the two-center contributions to the chemical shift tensor.
1224
+ """,
1225
+ categories=[x_vasp_incar_param],
1226
+ )
1227
+
1228
+ x_vasp_incar_LMAXFOCK = Quantity(
1229
+ type=np.int32,
1230
+ shape=[],
1231
+ description="""
1232
+ LMAXFOCK sets the maximum angular momentum quantum number _L_ for the augmentation
1233
+ of charge densities in Hartree-Fock type routines.
1234
+ """,
1235
+ categories=[x_vasp_incar_param],
1236
+ )
1237
+
1238
+ x_vasp_incar_LMAXFOCKAE = Quantity(
1239
+ type=np.int32,
1240
+ shape=[],
1241
+ description="""
1242
+ NMAXFOCKAE and LMAXFOCKAE determine whether the overlap densities in the Fock
1243
+ exchange and correlated wave function methods are accurately reconstructed on the
1244
+ plane wave grid. This flag generally only applies to the Fock-exchange part as
1245
+ well as many-body post DFT methods (GW, RPA, MP2, etc.).
1246
+ """,
1247
+ categories=[x_vasp_incar_param],
1248
+ )
1249
+
1250
+ x_vasp_incar_LMAXMIX = Quantity(
1251
+ type=np.int32,
1252
+ shape=[],
1253
+ description="""
1254
+ LMAXMIX controls up to which l-quantum number the one-center PAW charge densities
1255
+ are passed through the charge density mixer and written to the CHGCAR file.
1256
+ """,
1257
+ categories=[x_vasp_incar_param],
1258
+ )
1259
+
1260
+ x_vasp_incar_LMAXPAW = Quantity(
1261
+ type=np.int32,
1262
+ shape=[],
1263
+ description="""
1264
+ LMAXPAW sets the maximum _l_-quantum number for the evaluation of the one-center
1265
+ terms on the radial support grids in the PAW method.
1266
+ """,
1267
+ categories=[x_vasp_incar_param],
1268
+ )
1269
+
1270
+ x_vasp_incar_LMAXTAU = Quantity(
1271
+ type=np.int32,
1272
+ shape=[],
1273
+ description="""
1274
+ LMAXTAU is the maximum _l_-quantum number included in the PAW one-center expansion
1275
+ of the kinetic energy density.
1276
+ """,
1277
+ categories=[x_vasp_incar_param],
1278
+ )
1279
+
1280
+ x_vasp_incar_LMIXTAU = Quantity(
1281
+ type=bool,
1282
+ shape=[],
1283
+ description="""
1284
+ send the kinetic energy density through the density mixer as well.
1285
+ """,
1286
+ categories=[x_vasp_incar_param],
1287
+ )
1288
+
1289
+ x_vasp_incar_LMONO = Quantity(
1290
+ type=bool,
1291
+ shape=[],
1292
+ description="""
1293
+ LMONO switches on monopole-monopole corrections for the total energy.
1294
+ """,
1295
+ categories=[x_vasp_incar_param],
1296
+ )
1297
+
1298
+ x_vasp_incar_LNABLA = Quantity(
1299
+ type=bool,
1300
+ shape=[],
1301
+ description="""
1302
+ LNABLA=.TRUE. evaluates the transversal expression for the frequency dependent
1303
+ dielectric matrix.
1304
+ """,
1305
+ categories=[x_vasp_incar_param],
1306
+ )
1307
+
1308
+ x_vasp_incar_LNMR_SYM_RED = Quantity(
1309
+ type=bool,
1310
+ shape=[],
1311
+ description="""
1312
+ discard symmetry operations that are not consistent with the way _k_-space
1313
+ derivative are calculated in the linear response calculations of chemical shifts.
1314
+ """,
1315
+ categories=[x_vasp_incar_param],
1316
+ )
1317
+
1318
+ x_vasp_incar_LNONCOLLINEAR = Quantity(
1319
+ type=bool,
1320
+ shape=[],
1321
+ description="""
1322
+ LNONCOLLINEAR specifies whether fully non-collinear magnetic calculations are
1323
+ performed.
1324
+ """,
1325
+ categories=[x_vasp_incar_param],
1326
+ )
1327
+
1328
+ x_vasp_incar_LOCPROJ = Quantity(
1329
+ type=str,
1330
+ shape=[],
1331
+ description="""
1332
+ by means of the LOCPROJ-tag one may specify a (set of) local function(s) on which
1333
+ the orbitals are to be projected. These projections are written to the PROJCAR,
1334
+ LOCPROJ, and vasprun.xml files.
1335
+ """,
1336
+ categories=[x_vasp_incar_param],
1337
+ )
1338
+
1339
+ x_vasp_incar_LOPTICS = Quantity(
1340
+ type=bool,
1341
+ shape=[],
1342
+ description="""
1343
+ LOPTICS=.TRUE. calculates the frequency dependent dielectric matrix after the
1344
+ electronic ground state has been determined.
1345
+ """,
1346
+ categories=[x_vasp_incar_param],
1347
+ )
1348
+
1349
+ x_vasp_incar_LORBIT = Quantity(
1350
+ type=str,
1351
+ shape=[],
1352
+ description="""
1353
+ LORBIT, together with an appropriate RWIGS, determines whether the PROCAR or
1354
+ PROOUT files are written.
1355
+ """,
1356
+ categories=[x_vasp_incar_param],
1357
+ )
1358
+
1359
+ x_vasp_incar_LORBMOM = Quantity(
1360
+ type=bool,
1361
+ shape=[],
1362
+ description="""
1363
+ LORBMOM specifies whether the orbital moments are written out or not (in a
1364
+ calculation using LSORBIT=.TRUE.).
1365
+ """,
1366
+ categories=[x_vasp_incar_param],
1367
+ )
1368
+
1369
+ x_vasp_incar_LPARD = Quantity(
1370
+ type=bool,
1371
+ shape=[],
1372
+ description="""
1373
+ Determines whether partial (band or k-point decomposed) charge densities are
1374
+ evaluated. See also 'Band-decomposed charge densities' .
1375
+ """,
1376
+ categories=[x_vasp_incar_param],
1377
+ )
1378
+
1379
+ x_vasp_incar_LPEAD = Quantity(
1380
+ type=bool,
1381
+ shape=[],
1382
+ description="""
1383
+ for LPEAD=.TRUE., the derivative of the cell-periodic part of the orbitals w.r.t.
1384
+ **k** is calculated using finite differences.
1385
+ """,
1386
+ categories=[x_vasp_incar_param],
1387
+ )
1388
+
1389
+ x_vasp_incar_LPLANE = Quantity(
1390
+ type=bool,
1391
+ shape=[],
1392
+ description="""
1393
+ LPLANE switches on the plane-wise data distribution in real space.
1394
+ """,
1395
+ categories=[x_vasp_incar_param],
1396
+ )
1397
+
1398
+ x_vasp_incar_LREAL = Quantity(
1399
+ type=bool,
1400
+ shape=[],
1401
+ description="""
1402
+ LREAL determines whether the projection operators are evaluated in real-space or
1403
+ in reciprocal space.
1404
+ """,
1405
+ categories=[x_vasp_incar_param],
1406
+ )
1407
+
1408
+ x_vasp_incar_LRPA = Quantity(
1409
+ type=bool,
1410
+ shape=[],
1411
+ description="""
1412
+ LRPA=.TRUE. includes local field effect on the Hartree level only.
1413
+ """,
1414
+ categories=[x_vasp_incar_param],
1415
+ )
1416
+
1417
+ x_vasp_incar_LSCAAWARE = Quantity(
1418
+ type=bool,
1419
+ shape=[],
1420
+ description="""
1421
+ LSCAAWARE controls the distribution of the Hamilton matrix.
1422
+ """,
1423
+ categories=[x_vasp_incar_param],
1424
+ )
1425
+
1426
+ x_vasp_incar_LSCALAPACK = Quantity(
1427
+ type=bool,
1428
+ shape=[],
1429
+ description="""
1430
+ LSCALAPACK controls the use of scaLAPACK.
1431
+ """,
1432
+ categories=[x_vasp_incar_param],
1433
+ )
1434
+
1435
+ x_vasp_incar_LSCALU = Quantity(
1436
+ type=bool,
1437
+ shape=[],
1438
+ description="""
1439
+ LSCALU switches on the parallel LU decomposition (using scaLAPACK) in the
1440
+ orthonormalization of the wave functions.
1441
+ """,
1442
+ categories=[x_vasp_incar_param],
1443
+ )
1444
+
1445
+ x_vasp_incar_LSCSGRAD = Quantity(
1446
+ type=bool,
1447
+ shape=[],
1448
+ description="""
1449
+ LSCSGRAD decides whether to compute gradients in the calculation of the MBD
1450
+ dispersion energy.
1451
+ """,
1452
+ categories=[x_vasp_incar_param],
1453
+ )
1454
+
1455
+ x_vasp_incar_LSELFENERGY = Quantity(
1456
+ type=bool,
1457
+ shape=[],
1458
+ description="""
1459
+ This tag controls whether the frequency dependent self-energy is calculated or
1460
+ not.
1461
+ """,
1462
+ categories=[x_vasp_incar_param],
1463
+ )
1464
+
1465
+ x_vasp_incar_LSEPB = Quantity(
1466
+ type=bool,
1467
+ shape=[],
1468
+ description="""
1469
+ Specifies whether the charge density is calculated for every band separately and
1470
+ written to a file PARCHG.nb.* (LSEPB=.TRUE.) or whether charge density is merged
1471
+ for all selected bands and written to the files PARCHG.ALLB.* or PARCHG.
1472
+ """,
1473
+ categories=[x_vasp_incar_param],
1474
+ )
1475
+
1476
+ x_vasp_incar_LSEPK = Quantity(
1477
+ type=bool,
1478
+ shape=[],
1479
+ description="""
1480
+ Specifies whether the charge density of every k-point is write to the files
1481
+ PARCHG.*.nk (LSEPK=.TRUE.) or whether it is merged to a single file. If the merged
1482
+ file is written, then the weight of each k-point is determined from the KPOINTS
1483
+ file, otherwise the k-point weights of one are chosen.
1484
+ """,
1485
+ categories=[x_vasp_incar_param],
1486
+ )
1487
+
1488
+ x_vasp_incar_LSORBIT = Quantity(
1489
+ type=bool,
1490
+ shape=[],
1491
+ description="""
1492
+ LSORBIT specifies whether spin-orbit coupling is taken into account.
1493
+ """,
1494
+ categories=[x_vasp_incar_param],
1495
+ )
1496
+
1497
+ x_vasp_incar_LSPECTRAL = Quantity(
1498
+ type=bool,
1499
+ shape=[],
1500
+ description="""
1501
+ LSPECTRAL specifies to use the spectral method.
1502
+ """,
1503
+ categories=[x_vasp_incar_param],
1504
+ )
1505
+
1506
+ x_vasp_incar_LSPECTRALGW = Quantity(
1507
+ type=bool,
1508
+ shape=[],
1509
+ description="""
1510
+ LSPECTRALGW specifies to use the spectral method for calculating the self-energy.
1511
+ """,
1512
+ categories=[x_vasp_incar_param],
1513
+ )
1514
+
1515
+ x_vasp_incar_LSPIRAL = Quantity(
1516
+ type=bool,
1517
+ shape=[],
1518
+ description="""
1519
+ set LSPIRAL=.TRUE. to represent spin spirals by means of a generalized Bloch
1520
+ condition.
1521
+ """,
1522
+ categories=[x_vasp_incar_param],
1523
+ )
1524
+
1525
+ x_vasp_incar_LSUBROT = Quantity(
1526
+ type=bool,
1527
+ shape=[],
1528
+ description="""
1529
+ LSUBROT determines whether an optimal rotation matrix between the occupied and
1530
+ unoccupied block is sought, when a direct optimization of the energy functional is
1531
+ performed (i.e. ALGO = All | Damped).
1532
+ """,
1533
+ categories=[x_vasp_incar_param],
1534
+ )
1535
+
1536
+ x_vasp_incar_LTHOMAS = Quantity(
1537
+ type=bool,
1538
+ shape=[],
1539
+ description="""
1540
+ LTHOMAS selects a decomposition of the exchange functional based on Thomas-Fermi
1541
+ screening.
1542
+ """,
1543
+ categories=[x_vasp_incar_param],
1544
+ )
1545
+
1546
+ x_vasp_incar_LUSE_VDW = Quantity(
1547
+ type=bool,
1548
+ shape=[],
1549
+ description="""
1550
+ The flag LUSE_VDW determines whether the VdW-DF functional of Langreth and
1551
+ Lundqvist et al. is used or not.
1552
+ """,
1553
+ categories=[x_vasp_incar_param],
1554
+ )
1555
+
1556
+ x_vasp_incar_LVDW_EWALD = Quantity(
1557
+ type=bool,
1558
+ shape=[],
1559
+ description="""
1560
+ LVDW_EWALD decides whether lattice summation in $E_{disp}$ expression by means of
1561
+ Ewald's summation is computed in the DFT-D2 method (available in VASP.5.3.4 and
1562
+ later).
1563
+ """,
1564
+ categories=[x_vasp_incar_param],
1565
+ )
1566
+
1567
+ x_vasp_incar_LVDW_ONECELL = Quantity(
1568
+ type=bool,
1569
+ shape=[3],
1570
+ description="""
1571
+ LVDW_ONECELL can be used to disable vdW interaction with mirror image in X Y Z
1572
+ direction. This is advisable for molecular calculations in the gas phase. In all
1573
+ other cases, use the default.
1574
+ """,
1575
+ categories=[x_vasp_incar_param],
1576
+ )
1577
+
1578
+ x_vasp_incar_LVDWEXPANSION = Quantity(
1579
+ type=bool,
1580
+ shape=[],
1581
+ description="""
1582
+ LVDWEXPANSION decides whether to write the two- to six- body contributions to MBD
1583
+ dispersion energy in the OUTCAR file.
1584
+ """,
1585
+ categories=[x_vasp_incar_param],
1586
+ )
1587
+
1588
+ x_vasp_incar_LVHAR = Quantity(
1589
+ type=bool,
1590
+ shape=[],
1591
+ description="""
1592
+ This tag determines whether the total local potential (saved in the file LOCPOT)
1593
+ contains the entire local potential (ionic + Hartree + exchange correlation) or
1594
+ the electrostatic contributions only (ionic + Hartree).
1595
+ """,
1596
+ categories=[x_vasp_incar_param],
1597
+ )
1598
+
1599
+ x_vasp_incar_LVTOT = Quantity(
1600
+ type=bool,
1601
+ shape=[],
1602
+ description="""
1603
+ LVTOT determines whether the total local potential is written to the LOCPOT file.
1604
+ """,
1605
+ categories=[x_vasp_incar_param],
1606
+ )
1607
+
1608
+ x_vasp_incar_LWANNIER90 = Quantity(
1609
+ type=bool,
1610
+ shape=[],
1611
+ description="""
1612
+ LWANNIER90=.TRUE. switches on the interface between VASP and WANNIER90.
1613
+ """,
1614
+ categories=[x_vasp_incar_param],
1615
+ )
1616
+
1617
+ x_vasp_incar_LWANNIER90_RUN = Quantity(
1618
+ type=bool,
1619
+ shape=[],
1620
+ description="""
1621
+ LWANNIER90_RUN executes wannier_setup (see LWANNIER90=.TRUE.) and subsequently
1622
+ runs WANNIER90 in library mode (wannier_run).
1623
+ """,
1624
+ categories=[x_vasp_incar_param],
1625
+ )
1626
+
1627
+ x_vasp_incar_LWAVE = Quantity(
1628
+ type=bool,
1629
+ shape=[],
1630
+ description="""
1631
+ LWAVE determines whether the wavefunctions are written to the WAVECAR file at the
1632
+ end of a run.
1633
+ """,
1634
+ categories=[x_vasp_incar_param],
1635
+ )
1636
+
1637
+ x_vasp_incar_LWRITE_MMN_AMN = Quantity(
1638
+ type=bool,
1639
+ shape=[],
1640
+ description="""
1641
+ LWRITE_MMN_AMN=.TRUE. tells the VASP2WANNIER90 interface to write the
1642
+ wannier90.mmn and wannier90.amn files.
1643
+ """,
1644
+ categories=[x_vasp_incar_param],
1645
+ )
1646
+
1647
+ x_vasp_incar_LWRITE_UNK = Quantity(
1648
+ type=bool,
1649
+ shape=[],
1650
+ description="""
1651
+ LWRITE_UNK decides whether the cell-periodic part of the relevant Bloch functions
1652
+ is written.
1653
+ """,
1654
+ categories=[x_vasp_incar_param],
1655
+ )
1656
+
1657
+ x_vasp_incar_LWRITE_WANPROJ = Quantity(
1658
+ type=bool,
1659
+ shape=[],
1660
+ description="""
1661
+ LWRITE_WANPROJ determines whether the Wannier projection fille WANPROJ is written.
1662
+ """,
1663
+ categories=[x_vasp_incar_param],
1664
+ )
1665
+
1666
+ x_vasp_incar_LZEROZ = Quantity(
1667
+ type=bool,
1668
+ shape=[],
1669
+ description="""
1670
+ for LZEROZ=.TRUE. the _z_-component of the spin-spiral magnetisation density will
1671
+ be forced to be and to remain zero.
1672
+ """,
1673
+ categories=[x_vasp_incar_param],
1674
+ )
1675
+
1676
+ x_vasp_incar_M_CONSTR = Quantity(
1677
+ type=np.float64,
1678
+ shape=['3*number_of_atoms'],
1679
+ description="""
1680
+ M_CONSTR specifies the desired local magnetic moment (size and/or direction) for
1681
+ the constrained local moments approach.
1682
+ """,
1683
+ categories=[x_vasp_incar_param],
1684
+ )
1685
+
1686
+ x_vasp_incar_MAGMOM = Quantity(
1687
+ type=np.float64,
1688
+ shape=['number_of_atoms'],
1689
+ description="""
1690
+ MAGMOM Specifies the initial magnetic moment for each atom, if and only if
1691
+ ICHARG=2, or if ICHARG=1 and the CHGCAR file contains no magnetisation density
1692
+ """,
1693
+ categories=[x_vasp_incar_param],
1694
+ )
1695
+
1696
+ x_vasp_incar_MAXMEM = Quantity(
1697
+ type=np.int32,
1698
+ shape=[],
1699
+ description="""
1700
+ MAXMEM specifies the maximum memory one MPI rank will attempt to allocate (in
1701
+ MByte).
1702
+ """,
1703
+ categories=[x_vasp_incar_param],
1704
+ )
1705
+
1706
+ x_vasp_incar_MAXMIX = Quantity(
1707
+ type=np.int32,
1708
+ shape=[],
1709
+ description="""
1710
+ MAXMIX specifies the maximum number steps stored in Broyden mixer IMIX=4).
1711
+ """,
1712
+ categories=[x_vasp_incar_param],
1713
+ )
1714
+
1715
+ x_vasp_incar_MDALGO = Quantity(
1716
+ type=np.int32,
1717
+ shape=[],
1718
+ description="""
1719
+ MDALGO specifies the molecular dynamics simulation protocol (in case IBRION=0 and
1720
+ VASP was compiled with -Dtbdyn).
1721
+ """,
1722
+ categories=[x_vasp_incar_param],
1723
+ )
1724
+
1725
+ x_vasp_incar_METAGGA = Quantity(
1726
+ type=str,
1727
+ shape=[],
1728
+ description="""
1729
+ selects one of various meta-GGA functionals.
1730
+ """,
1731
+ categories=[x_vasp_incar_param],
1732
+ )
1733
+
1734
+ x_vasp_incar_MINROT = Quantity(
1735
+ type=np.float64,
1736
+ shape=[],
1737
+ description="""
1738
+ The flag MINROT defines the value for which the dimer is rotated only if the
1739
+ predicted rotation angle is greater than MINROT (rad.) in the Improved Dimer
1740
+ Method.
1741
+ """,
1742
+ categories=[x_vasp_incar_param],
1743
+ )
1744
+
1745
+ x_vasp_incar_MIXPRE = Quantity(
1746
+ type=np.int32,
1747
+ shape=[],
1748
+ description="""
1749
+ MIXPRE specifies the metric in the Broyden mixing scheme(IMIX=4).
1750
+ """,
1751
+ categories=[x_vasp_incar_param],
1752
+ )
1753
+
1754
+ x_vasp_incar_ML_FF_AFILT2_MB = Quantity(
1755
+ type=np.float64,
1756
+ shape=[],
1757
+ description="""
1758
+ This tag sets the filtering parameter for the angular filtering for
1759
+ ML_FF_IAFILT2_MB in the machine learning force-field method.
1760
+ """,
1761
+ categories=[x_vasp_incar_param],
1762
+ )
1763
+
1764
+ x_vasp_incar_ML_FF_CDOUB = Quantity(
1765
+ type=np.float64,
1766
+ shape=[],
1767
+ description="""
1768
+ This flag controls the necessity of DFT calculations in the machine learning force
1769
+ field method.
1770
+ """,
1771
+ categories=[x_vasp_incar_param],
1772
+ )
1773
+
1774
+ x_vasp_incar_ML_FF_CSF = Quantity(
1775
+ type=np.float64,
1776
+ shape=[],
1777
+ description="""
1778
+ This flag sets the threshold for the spilling factor in the machine learning force
1779
+ field method.
1780
+ """,
1781
+ categories=[x_vasp_incar_param],
1782
+ )
1783
+
1784
+ x_vasp_incar_ML_FF_CSIG = Quantity(
1785
+ type=np.float64,
1786
+ shape=[],
1787
+ description="""
1788
+ Parameter used in the automatic determination of threshold for Bayesian error
1789
+ estimation in the machine learning force field method.
1790
+ """,
1791
+ categories=[x_vasp_incar_param],
1792
+ )
1793
+
1794
+ x_vasp_incar_ML_FF_CSLOPE = Quantity(
1795
+ type=np.float64,
1796
+ shape=[],
1797
+ description="""
1798
+ Parameter used in the automatic determination of threshold for Bayesian error
1799
+ estimation in the machine learning force field method.
1800
+ """,
1801
+ categories=[x_vasp_incar_param],
1802
+ )
1803
+
1804
+ x_vasp_incar_ML_FF_CTIFOR = Quantity(
1805
+ type=np.float64,
1806
+ shape=[],
1807
+ description="""
1808
+ This flag sets the threshold for the Bayesian error estimation on the force in the
1809
+ machine learning force field method.
1810
+ """,
1811
+ categories=[x_vasp_incar_param],
1812
+ )
1813
+
1814
+ x_vasp_incar_ML_FF_EATOM = Quantity(
1815
+ type=np.float64,
1816
+ shape=['number_of_atoms'],
1817
+ description="""
1818
+ Reference total energies of isolated atoms used in the machine learning force
1819
+ field method.
1820
+ """,
1821
+ categories=[x_vasp_incar_param],
1822
+ )
1823
+
1824
+ x_vasp_incar_ML_FF_IAFILT2_MB = Quantity(
1825
+ type=np.int32,
1826
+ shape=[],
1827
+ description="""
1828
+ This tag specifies the type of angular filtering used in the machine learning
1829
+ force field method.
1830
+ """,
1831
+ categories=[x_vasp_incar_param],
1832
+ )
1833
+
1834
+ x_vasp_incar_ML_FF_IBROAD1_MB = Quantity(
1835
+ type=np.int32,
1836
+ shape=[],
1837
+ description="""
1838
+ This tag determines how the atomic distribution is broadened for the radial
1839
+ descriptor within the machine learning force field method.
1840
+ """,
1841
+ categories=[x_vasp_incar_param],
1842
+ )
1843
+
1844
+ x_vasp_incar_ML_FF_IBROAD2_MB = Quantity(
1845
+ type=np.int32,
1846
+ shape=[],
1847
+ description="""
1848
+ This tag determines how the atomic distribution is broadened for the angular
1849
+ descriptor within the machine learning force field method.
1850
+ """,
1851
+ categories=[x_vasp_incar_param],
1852
+ )
1853
+
1854
+ x_vasp_incar_ML_FF_ICOUPLE_MB = Quantity(
1855
+ type=np.int32,
1856
+ shape=['number_of_atoms'],
1857
+ description="""
1858
+ This tag specifies the atoms where the coupling parameter is introduced to
1859
+ calculate the chemical potential within the machine learning force field method.
1860
+ """,
1861
+ categories=[x_vasp_incar_param],
1862
+ )
1863
+
1864
+ x_vasp_incar_ML_FF_ICUT1_MB = Quantity(
1865
+ type=np.int32,
1866
+ shape=[],
1867
+ description="""
1868
+ This tag specifies the type of cutoff function used for the radial descriptor in
1869
+ the machine learning force field method.
1870
+ """,
1871
+ categories=[x_vasp_incar_param],
1872
+ )
1873
+
1874
+ x_vasp_incar_ML_FF_ICUT2_MB = Quantity(
1875
+ type=np.int32,
1876
+ shape=[],
1877
+ description="""
1878
+ This tag specifies the type of cutoff function used for the angular descriptor in
1879
+ the machine learning force field method.
1880
+ """,
1881
+ categories=[x_vasp_incar_param],
1882
+ )
1883
+
1884
+ x_vasp_incar_ML_FF_IERR = Quantity(
1885
+ type=np.int32,
1886
+ shape=[],
1887
+ description="""
1888
+ This tag selects the error estimation method used in the machine learning force
1889
+ field method.
1890
+ """,
1891
+ categories=[x_vasp_incar_param],
1892
+ )
1893
+
1894
+ x_vasp_incar_ML_FF_IREG_MB = Quantity(
1895
+ type=np.int32,
1896
+ shape=[],
1897
+ description="""
1898
+ This tag specifies whether the regularization parameters are kept constant or not
1899
+ in the machine learning force field method.
1900
+ """,
1901
+ categories=[x_vasp_incar_param],
1902
+ )
1903
+
1904
+ x_vasp_incar_ML_FF_ISAMPLE = Quantity(
1905
+ type=np.int32,
1906
+ shape=[],
1907
+ description="""
1908
+ This tag controls the sampling in the machine learning force field method.
1909
+ """,
1910
+ categories=[x_vasp_incar_param],
1911
+ )
1912
+
1913
+ x_vasp_incar_ML_FF_ISCALE_TOTEN_MB = Quantity(
1914
+ type=np.int32,
1915
+ shape=[],
1916
+ description="""
1917
+ This tag specifies how to scale the energy data for the many-body term in the
1918
+ machine learning force field method.
1919
+ """,
1920
+ categories=[x_vasp_incar_param],
1921
+ )
1922
+
1923
+ x_vasp_incar_ML_FF_ISOAP1_MB = Quantity(
1924
+ type=np.int32,
1925
+ shape=[],
1926
+ description="""
1927
+ This tag defines the type of the SOAP kernel for the radial descriptor in the
1928
+ machine learning force field method.
1929
+ """,
1930
+ categories=[x_vasp_incar_param],
1931
+ )
1932
+
1933
+ x_vasp_incar_ML_FF_ISOAP2_MB = Quantity(
1934
+ type=np.int32,
1935
+ shape=[],
1936
+ description="""
1937
+ This tag defines the type of the SOAP kernel for the angular descriptor in the
1938
+ machine learning force field method.
1939
+ """,
1940
+ categories=[x_vasp_incar_param],
1941
+ )
1942
+
1943
+ x_vasp_incar_ML_FF_ISTART = Quantity(
1944
+ type=np.int32,
1945
+ shape=[],
1946
+ description="""
1947
+ This tag decides if and how calculations are continued from existing data in
1948
+ machine learning force field method.
1949
+ """,
1950
+ categories=[x_vasp_incar_param],
1951
+ )
1952
+
1953
+ x_vasp_incar_ML_FF_IWEIGHT = Quantity(
1954
+ type=np.int32,
1955
+ shape=[],
1956
+ description="""
1957
+ Flag to control the weighting of training data in the machine learning force field
1958
+ method.
1959
+ """,
1960
+ categories=[x_vasp_incar_param],
1961
+ )
1962
+
1963
+ x_vasp_incar_ML_FF_LAFILT2_MB = Quantity(
1964
+ type=bool,
1965
+ shape=[],
1966
+ description="""
1967
+ This tag specifies whether angular filtering is applied or not within the machine
1968
+ learning force field method.
1969
+ """,
1970
+ categories=[x_vasp_incar_param],
1971
+ )
1972
+
1973
+ x_vasp_incar_ML_FF_LBASIS_DISCARD = Quantity(
1974
+ type=bool,
1975
+ shape=[],
1976
+ description="""
1977
+ This variable specifies whether the basis sets are thrown away when its number
1978
+ exceeds ML_FF_MB_MB in the machine learning force field method.
1979
+ """,
1980
+ categories=[x_vasp_incar_param],
1981
+ )
1982
+
1983
+ x_vasp_incar_ML_FF_LCONF_DISCARD = Quantity(
1984
+ type=bool,
1985
+ shape=[],
1986
+ description="""
1987
+ This flag decides whether configurations that do not provide local reference
1988
+ configurations are discarded or not in the machine learning force field method.
1989
+ """,
1990
+ categories=[x_vasp_incar_param],
1991
+ )
1992
+
1993
+ x_vasp_incar_ML_FF_LCOUPLE_MB = Quantity(
1994
+ type=bool,
1995
+ shape=[],
1996
+ description="""
1997
+ This tag specifies whether coupling parameters are used for the calculation of
1998
+ chemical potentials is used or not within the machine learning force field method.
1999
+ """,
2000
+ categories=[x_vasp_incar_param],
2001
+ )
2002
+
2003
+ x_vasp_incar_ML_FF_LCRITERIA = Quantity(
2004
+ type=bool,
2005
+ shape=[],
2006
+ description="""
2007
+ Decides whether the threshold in the learning decision step for the Bayesian error
2008
+ estimation is renewed or not in the machine learning force field methods.
2009
+ """,
2010
+ categories=[x_vasp_incar_param],
2011
+ )
2012
+
2013
+ x_vasp_incar_ML_FF_LEATOM_MB = Quantity(
2014
+ type=bool,
2015
+ shape=[],
2016
+ description="""
2017
+ This term specifies whether the total atomic energy is written out or not.
2018
+ """,
2019
+ categories=[x_vasp_incar_param],
2020
+ )
2021
+
2022
+ x_vasp_incar_ML_FF_LHEAT_MB = Quantity(
2023
+ type=bool,
2024
+ shape=[],
2025
+ description="""
2026
+ This flag specifies whether the heat flux is calculated or not in the machine
2027
+ learning force field method.
2028
+ """,
2029
+ categories=[x_vasp_incar_param],
2030
+ )
2031
+
2032
+ x_vasp_incar_ML_FF_LMAX2_MB = Quantity(
2033
+ type=np.int32,
2034
+ shape=[],
2035
+ description="""
2036
+ This tag specifies the maximum angular momentum quantum number of spherical
2037
+ harmonics used to expand atomic distributions within the machine learning force
2038
+ field method.
2039
+ """,
2040
+ categories=[x_vasp_incar_param],
2041
+ )
2042
+
2043
+ x_vasp_incar_ML_FF_LMLFF = Quantity(
2044
+ type=bool,
2045
+ shape=[],
2046
+ description="""
2047
+ Main control tag whether to use machine learned force fields or not.
2048
+ """,
2049
+ categories=[x_vasp_incar_param],
2050
+ )
2051
+
2052
+ x_vasp_incar_ML_FF_LMLMB = Quantity(
2053
+ type=bool,
2054
+ shape=[],
2055
+ description="""
2056
+ This controls whether the many-body interaction term is included in the machine
2057
+ learning force field method.
2058
+ """,
2059
+ categories=[x_vasp_incar_param],
2060
+ )
2061
+
2062
+ x_vasp_incar_ML_FF_LNORM1_MB = Quantity(
2063
+ type=bool,
2064
+ shape=[],
2065
+ description="""
2066
+ This tag specifies whether the radial descriptor is normalized (by dividing
2067
+ through it's norm) or not.
2068
+ """,
2069
+ categories=[x_vasp_incar_param],
2070
+ )
2071
+
2072
+ x_vasp_incar_ML_FF_LNORM2_MB = Quantity(
2073
+ type=bool,
2074
+ shape=[],
2075
+ description="""
2076
+ This tag specifies whether the angular descriptor is normalized (by dividing
2077
+ through it's norm) or not.
2078
+ """,
2079
+ categories=[x_vasp_incar_param],
2080
+ )
2081
+
2082
+ x_vasp_incar_ML_FF_MB_MB = Quantity(
2083
+ type=np.int32,
2084
+ shape=[],
2085
+ description="""
2086
+ This flag sets the maximum number of basis sets describing the many-body
2087
+ interactions in the machine learning force field method.
2088
+ """,
2089
+ categories=[x_vasp_incar_param],
2090
+ )
2091
+
2092
+ x_vasp_incar_ML_FF_MCONF = Quantity(
2093
+ type=np.int32,
2094
+ shape=[],
2095
+ description="""
2096
+ This flag sets the maximum number of configurations used for training in the
2097
+ machine learning force field method.
2098
+ """,
2099
+ categories=[x_vasp_incar_param],
2100
+ )
2101
+
2102
+ x_vasp_incar_ML_FF_MCONF_NEW = Quantity(
2103
+ type=np.int32,
2104
+ shape=[],
2105
+ description="""
2106
+ This flag sets the number of configurations that are stored temporally as
2107
+ candidates for the training data in the machine learning force field method.
2108
+ """,
2109
+ categories=[x_vasp_incar_param],
2110
+ )
2111
+
2112
+ x_vasp_incar_ML_FF_MHIS = Quantity(
2113
+ type=np.int32,
2114
+ shape=[],
2115
+ description="""
2116
+ This flag sets the number of estimated errors stored in memory to determine the
2117
+ threshold for the Bayesian error in the machine learning force field method.
2118
+ """,
2119
+ categories=[x_vasp_incar_param],
2120
+ )
2121
+
2122
+ x_vasp_incar_ML_FF_MRB1_MB = Quantity(
2123
+ type=np.int32,
2124
+ shape=[],
2125
+ description="""
2126
+ This tag sets the number of radial basis sets used to expand the atomic
2127
+ distribution for the radial descriptor within the machine learning force field
2128
+ method.
2129
+ """,
2130
+ categories=[x_vasp_incar_param],
2131
+ )
2132
+
2133
+ x_vasp_incar_ML_FF_MRB2_MB = Quantity(
2134
+ type=np.int32,
2135
+ shape=[],
2136
+ description="""
2137
+ This tag sets the number of radial basis sets used to expand the atomic
2138
+ distribution for the angular descriptor withtin the machine learning force field
2139
+ method.
2140
+ """,
2141
+ categories=[x_vasp_incar_param],
2142
+ )
2143
+
2144
+ x_vasp_incar_ML_FF_MSPL1_MB = Quantity(
2145
+ type=np.int32,
2146
+ shape=[],
2147
+ description="""
2148
+ This tag sets the number of points for the radial grid used in the spline
2149
+ interpolation for the radial descriptor within the machine learning force field
2150
+ method.
2151
+ """,
2152
+ categories=[x_vasp_incar_param],
2153
+ )
2154
+
2155
+ x_vasp_incar_ML_FF_MSPL2_MB = Quantity(
2156
+ type=np.int32,
2157
+ shape=[],
2158
+ description="""
2159
+ This tag sets the number of points for the radial grid used in the spline
2160
+ interpolation of the angular descriptor within the machine learning force field
2161
+ method.
2162
+ """,
2163
+ categories=[x_vasp_incar_param],
2164
+ )
2165
+
2166
+ x_vasp_incar_ML_FF_NATOM_COUPLED_MB = Quantity(
2167
+ type=np.int32,
2168
+ shape=[],
2169
+ description="""
2170
+ This tag specifies the number of atoms for which a coupling parameter is
2171
+ introduced to calculate the chemical potential within the machine learning force
2172
+ field method.
2173
+ """,
2174
+ categories=[x_vasp_incar_param],
2175
+ )
2176
+
2177
+ x_vasp_incar_ML_FF_NDIM_SCALAPACK = Quantity(
2178
+ type=np.int32,
2179
+ shape=[],
2180
+ description="""
2181
+ This flag sets the dimension of the ScaLAPACK grids used in the machine learning
2182
+ force field method.
2183
+ """,
2184
+ categories=[x_vasp_incar_param],
2185
+ )
2186
+
2187
+ x_vasp_incar_ML_FF_NHYP1_MB = Quantity(
2188
+ type=np.int32,
2189
+ shape=[],
2190
+ description="""
2191
+ Polynomial power of the radial kernel.
2192
+ """,
2193
+ categories=[x_vasp_incar_param],
2194
+ )
2195
+
2196
+ x_vasp_incar_ML_FF_NHYP2_MB = Quantity(
2197
+ type=np.int32,
2198
+ shape=[],
2199
+ description="""
2200
+ Polynomial parameter (power) of the SOAP kernel.
2201
+ """,
2202
+ categories=[x_vasp_incar_param],
2203
+ )
2204
+
2205
+ x_vasp_incar_ML_FF_NMDINT = Quantity(
2206
+ type=np.int32,
2207
+ shape=[],
2208
+ description="""
2209
+ Tag to control the minimum interval to get training samples in the machine
2210
+ learning force field method.
2211
+ """,
2212
+ categories=[x_vasp_incar_param],
2213
+ )
2214
+
2215
+ x_vasp_incar_ML_FF_NR1_MB = Quantity(
2216
+ type=np.int32,
2217
+ shape=[],
2218
+ description="""
2219
+ This tag determines the number of grid points used to execute radial integrations
2220
+ to compute the radial descriptor within the machine learning force field method.
2221
+ """,
2222
+ categories=[x_vasp_incar_param],
2223
+ )
2224
+
2225
+ x_vasp_incar_ML_FF_NR2_MB = Quantity(
2226
+ type=np.int32,
2227
+ shape=[],
2228
+ description="""
2229
+ This tag determines the number of grid points used to execute radial integrations
2230
+ to compute the angular descriptor within the machine learning force field method.
2231
+ """,
2232
+ categories=[x_vasp_incar_param],
2233
+ )
2234
+
2235
+ x_vasp_incar_ML_FF_NWRITE = Quantity(
2236
+ type=np.int32,
2237
+ shape=[],
2238
+ description="""
2239
+ This tag controls part of the output within the machine learning force field
2240
+ method.
2241
+ """,
2242
+ categories=[x_vasp_incar_param],
2243
+ )
2244
+
2245
+ x_vasp_incar_ML_FF_RCOUPLE_MB = Quantity(
2246
+ type=np.float64,
2247
+ shape=[],
2248
+ description="""
2249
+ This tag specifies the value of the coupling parameter for the calculation of the
2250
+ chemical potential within the machine learning force field method.
2251
+ """,
2252
+ categories=[x_vasp_incar_param],
2253
+ )
2254
+
2255
+ x_vasp_incar_ML_FF_RCUT1_MB = Quantity(
2256
+ type=np.float64,
2257
+ shape=[],
2258
+ description="""
2259
+ This flag sets the cutoff radius for the radial descriptor in the machine learning
2260
+ force field method.
2261
+ """,
2262
+ categories=[x_vasp_incar_param],
2263
+ )
2264
+
2265
+ x_vasp_incar_ML_FF_RCUT2_MB = Quantity(
2266
+ type=np.float64,
2267
+ shape=[],
2268
+ description="""
2269
+ This flag sets the cutoff radius for the angular descriptor in the machine
2270
+ learning force field method.
2271
+ """,
2272
+ categories=[x_vasp_incar_param],
2273
+ )
2274
+
2275
+ x_vasp_incar_ML_FF_SIGV0_MB = Quantity(
2276
+ type=np.float64,
2277
+ shape=[],
2278
+ description="""
2279
+ This flag sets the initial noise parameter in the machine learning force field
2280
+ method.
2281
+ """,
2282
+ categories=[x_vasp_incar_param],
2283
+ )
2284
+
2285
+ x_vasp_incar_ML_FF_SIGW0_MB = Quantity(
2286
+ type=np.float64,
2287
+ shape=[],
2288
+ description="""
2289
+ This flag sets the initial precision parameter in the machine learning force field
2290
+ method.
2291
+ """,
2292
+ categories=[x_vasp_incar_param],
2293
+ )
2294
+
2295
+ x_vasp_incar_ML_FF_SION1_MB = Quantity(
2296
+ type=np.float64,
2297
+ shape=[],
2298
+ description="""
2299
+ This tag specifies the width of the Gaussian functions used for broadening the
2300
+ atomic distributions for the radial descriptor within the machine learning force
2301
+ field method.
2302
+ """,
2303
+ categories=[x_vasp_incar_param],
2304
+ )
2305
+
2306
+ x_vasp_incar_ML_FF_SION2_MB = Quantity(
2307
+ type=np.float64,
2308
+ shape=[],
2309
+ description="""
2310
+ This tag specifies the width of the Gaussian functions used for broadening the
2311
+ atomic distributions of the angular descriptor within the machine learning force
2312
+ field method.
2313
+ """,
2314
+ categories=[x_vasp_incar_param],
2315
+ )
2316
+
2317
+ x_vasp_incar_ML_FF_W1_MB = Quantity(
2318
+ type=np.float64,
2319
+ shape=[],
2320
+ description="""
2321
+ This tag defines the weight for the radial descriptor within the machine learning
2322
+ force field method.
2323
+ """,
2324
+ categories=[x_vasp_incar_param],
2325
+ )
2326
+
2327
+ x_vasp_incar_ML_FF_W2_MB = Quantity(
2328
+ type=np.float64,
2329
+ shape=[],
2330
+ description="""
2331
+ This tag defines the weight for the angular descriptor within the machine learning
2332
+ force field method.
2333
+ """,
2334
+ categories=[x_vasp_incar_param],
2335
+ )
2336
+
2337
+ x_vasp_incar_ML_FF_WTIFOR = Quantity(
2338
+ type=np.float64,
2339
+ shape=[],
2340
+ description="""
2341
+ This tag sets the weight for the scaling of the forces in the training data within
2342
+ the machine learning force field method.
2343
+ """,
2344
+ categories=[x_vasp_incar_param],
2345
+ )
2346
+
2347
+ x_vasp_incar_ML_FF_WTOTEN = Quantity(
2348
+ type=np.float64,
2349
+ shape=[],
2350
+ description="""
2351
+ This tag sets the weight for the scaling of the total energy in the training data
2352
+ within the machine learning force field method.
2353
+ """,
2354
+ categories=[x_vasp_incar_param],
2355
+ )
2356
+
2357
+ x_vasp_incar_ML_FF_WTSIF = Quantity(
2358
+ type=np.float64,
2359
+ shape=[],
2360
+ description="""
2361
+ This tag sets the weight for the scaling of the total energy in the training data
2362
+ within the machine learning force field method.
2363
+ """,
2364
+ categories=[x_vasp_incar_param],
2365
+ )
2366
+
2367
+ x_vasp_incar_NBANDS = Quantity(
2368
+ type=np.int32,
2369
+ shape=[],
2370
+ description="""
2371
+ NBANDS determines the actual number of bands in the calculation.
2372
+ """,
2373
+ categories=[x_vasp_incar_param],
2374
+ )
2375
+
2376
+ x_vasp_incar_NBANDSGW = Quantity(
2377
+ type=np.int32,
2378
+ shape=[],
2379
+ description="""
2380
+ The flag determines how many QP energies are calculated and updated in GW type
2381
+ calculations.
2382
+ """,
2383
+ categories=[x_vasp_incar_param],
2384
+ )
2385
+
2386
+ x_vasp_incar_NBANDSO = Quantity(
2387
+ type=np.int32,
2388
+ shape=[],
2389
+ description="""
2390
+ NBANDSO determines how many occupied orbitals are included in the Casida/BSE
2391
+ calculations or time-propagation.
2392
+ """,
2393
+ categories=[x_vasp_incar_param],
2394
+ )
2395
+
2396
+ x_vasp_incar_NBANDSV = Quantity(
2397
+ type=np.int32,
2398
+ shape=[],
2399
+ description="""
2400
+ NBANDSV determines how many unoccupied orbitals are included in the Casida/BSE
2401
+ calculations or timepropagation.
2402
+ """,
2403
+ categories=[x_vasp_incar_param],
2404
+ )
2405
+
2406
+ x_vasp_incar_NBLK = Quantity(
2407
+ type=np.int32,
2408
+ shape=[],
2409
+ description="""
2410
+ NBLK determines the blocking factor in many BLAS level 3 routines.
2411
+ """,
2412
+ categories=[x_vasp_incar_param],
2413
+ )
2414
+
2415
+ x_vasp_incar_NBLOCK = Quantity(
2416
+ type=np.int32,
2417
+ shape=[],
2418
+ description="""
2419
+ After NBLOCK ionic steps the pair correlation function and the DOS are calculated
2420
+ and the ionic configuration is written to the XDATCAR-file.
2421
+ """,
2422
+ categories=[x_vasp_incar_param],
2423
+ )
2424
+
2425
+ x_vasp_incar_NBMOD = Quantity(
2426
+ type=np.int32,
2427
+ shape=[],
2428
+ description="""
2429
+ Controls which bands are used in the calculation of Band decomposed charge
2430
+ densities. Check also IBAND and EINT.
2431
+ """,
2432
+ categories=[x_vasp_incar_param],
2433
+ )
2434
+
2435
+ x_vasp_incar_NBSEEIG = Quantity(
2436
+ type=np.int32,
2437
+ shape=[],
2438
+ description="""
2439
+ NBSEEIG sets the number number of BSE eigenvectors written to the BSEFATBAND
2440
+ output file.
2441
+ """,
2442
+ categories=[x_vasp_incar_param],
2443
+ )
2444
+
2445
+ x_vasp_incar_NCORE = Quantity(
2446
+ type=np.int32,
2447
+ shape=[],
2448
+ description="""
2449
+ NCORE determines the number of compute cores that work on an individual orbital
2450
+ (available as of VASP.5.2.13).
2451
+ """,
2452
+ categories=[x_vasp_incar_param],
2453
+ )
2454
+
2455
+ x_vasp_incar_NCRPA_BANDS = Quantity(
2456
+ type=np.int32,
2457
+ shape=['1..x_vasp_incar_NBANDS'],
2458
+ description="""
2459
+ Controls which bands are excluded in CRPA. Check also NTARGET_STATES.
2460
+ """,
2461
+ categories=[x_vasp_incar_param],
2462
+ )
2463
+
2464
+ x_vasp_incar_NDAV = Quantity(
2465
+ type=np.int32,
2466
+ shape=[],
2467
+ description="""
2468
+ NDAV sets the maximum number of iterative steps per bands per RMM-DIIS step
2469
+ (IALGO=4X).
2470
+ """,
2471
+ categories=[x_vasp_incar_param],
2472
+ )
2473
+
2474
+ x_vasp_incar_NEDOS = Quantity(
2475
+ type=np.int32,
2476
+ shape=[],
2477
+ description="""
2478
+ NEDOS specifies number of gridpoints on which the DOS is evaluated
2479
+ """,
2480
+ categories=[x_vasp_incar_param],
2481
+ )
2482
+
2483
+ x_vasp_incar_NELECT = Quantity(
2484
+ type=np.float64,
2485
+ shape=[],
2486
+ description="""
2487
+ NELECT sets the number of electrons.
2488
+ """,
2489
+ categories=[x_vasp_incar_param],
2490
+ )
2491
+
2492
+ x_vasp_incar_NELM = Quantity(
2493
+ type=np.int32,
2494
+ shape=[],
2495
+ description="""
2496
+ NELM sets the maximum number of electronic SC (selfconsistency) steps which may be
2497
+ performed.
2498
+ """,
2499
+ categories=[x_vasp_incar_param],
2500
+ )
2501
+
2502
+ x_vasp_incar_NELMDL = Quantity(
2503
+ type=np.int32,
2504
+ shape=[],
2505
+ description="""
2506
+ NELMDL specifies the number of non-selfconsistent steps at the beginning.
2507
+ """,
2508
+ categories=[x_vasp_incar_param],
2509
+ )
2510
+
2511
+ x_vasp_incar_NELMIN = Quantity(
2512
+ type=np.int32,
2513
+ shape=[],
2514
+ description="""
2515
+ NELMIN specifies the minimum number of electronic SCF steps.
2516
+ """,
2517
+ categories=[x_vasp_incar_param],
2518
+ )
2519
+
2520
+ x_vasp_incar_NFREE = Quantity(
2521
+ type=np.int32,
2522
+ shape=[],
2523
+ description="""
2524
+ depending on IBRION, NFREE specifies the number of remembered steps in the history
2525
+ of ionic convergence runs, or the number of ionic displacements in frozen phonon
2526
+ calculations.
2527
+ """,
2528
+ categories=[x_vasp_incar_param],
2529
+ )
2530
+
2531
+ x_vasp_incar_NGX = Quantity(
2532
+ type=np.int32,
2533
+ shape=[],
2534
+ description="""
2535
+ NGX sets the number of grid points in the FFT-grid along the first lattice vector.
2536
+ """,
2537
+ categories=[x_vasp_incar_param],
2538
+ )
2539
+
2540
+ x_vasp_incar_NGXF = Quantity(
2541
+ type=np.int32,
2542
+ shape=[],
2543
+ description="""
2544
+ NGXF sets the number of grid points in the fine FFT-grid along the first lattice
2545
+ vector.
2546
+ """,
2547
+ categories=[x_vasp_incar_param],
2548
+ )
2549
+
2550
+ x_vasp_incar_NGY = Quantity(
2551
+ type=np.int32,
2552
+ shape=[],
2553
+ description="""
2554
+ NGY sets the number of grid points in the FFT-grid along the second lattice
2555
+ vector.
2556
+ """,
2557
+ categories=[x_vasp_incar_param],
2558
+ )
2559
+
2560
+ x_vasp_incar_NGYF = Quantity(
2561
+ type=np.int32,
2562
+ shape=[],
2563
+ description="""
2564
+ NGYF sets the number of grid points in the fine FFT-grid along the second lattice
2565
+ vector.
2566
+ """,
2567
+ categories=[x_vasp_incar_param],
2568
+ )
2569
+
2570
+ x_vasp_incar_NGYROMAG = Quantity(
2571
+ type=np.float64,
2572
+ shape=['number_of_atomic_species'],
2573
+ description="""
2574
+ NGYROMAG specifies the nuclear gyromagnetic ratios (in MHz, for H<sub>0</sub> = 1
2575
+ T) for the atomic types on the POTCAR file.
2576
+ """,
2577
+ categories=[x_vasp_incar_param],
2578
+ )
2579
+
2580
+ x_vasp_incar_NGZ = Quantity(
2581
+ type=np.int32,
2582
+ shape=[],
2583
+ description="""
2584
+ NGZ sets the number of grid points in the FFT-grid along the third lattice vector.
2585
+ """,
2586
+ categories=[x_vasp_incar_param],
2587
+ )
2588
+
2589
+ x_vasp_incar_NGZF = Quantity(
2590
+ type=np.int32,
2591
+ shape=[],
2592
+ description="""
2593
+ NGZF sets the number of grid points in the fine FFT-grid along the first lattice
2594
+ vector.
2595
+ """,
2596
+ categories=[x_vasp_incar_param],
2597
+ )
2598
+
2599
+ x_vasp_incar_NKRED = Quantity(
2600
+ type=np.int32,
2601
+ shape=[],
2602
+ description="""
2603
+ NKRED specifies an uniform reduction factor for the **q**-point grid
2604
+ representation of the exact exchange potential and the correlation part in GW
2605
+ calculations.
2606
+ """,
2607
+ categories=[x_vasp_incar_param],
2608
+ )
2609
+
2610
+ x_vasp_incar_NKREDX = Quantity(
2611
+ type=np.int32,
2612
+ shape=[],
2613
+ description="""
2614
+ NKREDX specifies a reduction factor for the **q**-point grid representation of the
2615
+ exact exchange potential along reciprocal space direction **b**<sub>1</sub>.
2616
+ """,
2617
+ categories=[x_vasp_incar_param],
2618
+ )
2619
+
2620
+ x_vasp_incar_NKREDY = Quantity(
2621
+ type=np.int32,
2622
+ shape=[],
2623
+ description="""
2624
+ NKREDY specifies a reduction factor for the **q**-point grid representation of the
2625
+ exact exchange potential along reciprocal space direction **b**<sub>2</sub>.
2626
+ """,
2627
+ categories=[x_vasp_incar_param],
2628
+ )
2629
+
2630
+ x_vasp_incar_NKREDZ = Quantity(
2631
+ type=np.int32,
2632
+ shape=[],
2633
+ description="""
2634
+ NKREDZ specifies a reduction factor for the **q**-point grid representation of the
2635
+ exact exchange potential along reciprocal space direction **b**<sub>3</sub>.
2636
+ """,
2637
+ categories=[x_vasp_incar_param],
2638
+ )
2639
+
2640
+ x_vasp_incar_NLSPLINE = Quantity(
2641
+ type=bool,
2642
+ shape=[],
2643
+ description="""
2644
+ construct the PAW projectors in reciprocal space using spline interpolation so
2645
+ that they are _k_-differentiable.
2646
+ """,
2647
+ categories=[x_vasp_incar_param],
2648
+ )
2649
+
2650
+ x_vasp_incar_NMAXFOCKAE = Quantity(
2651
+ type=np.int32,
2652
+ shape=[],
2653
+ description="""
2654
+ NMAXFOCKAE and LMAXFOCKAE determine whether the overlap densities in the Fock
2655
+ exchange and correlated wave function methods are accurately reconstructed on the
2656
+ plane wave grid. This flag generally only applies to the Fock-exchange part as
2657
+ well as many-body post DFT methods (GW, RPA, MP2, etc.).
2658
+ """,
2659
+ categories=[x_vasp_incar_param],
2660
+ )
2661
+
2662
+ x_vasp_incar_NOMEGA = Quantity(
2663
+ type=np.int32,
2664
+ shape=[],
2665
+ description="""
2666
+ NOMEGA specifies the number of (imaginary) frequency and imaginary time grid
2667
+ points.
2668
+ """,
2669
+ categories=[x_vasp_incar_param],
2670
+ )
2671
+
2672
+ x_vasp_incar_NOMEGAPAR = Quantity(
2673
+ type=np.int32,
2674
+ shape=[],
2675
+ description="""
2676
+ NOMEGAPAR available as of VASP.6, specifies the number of processor groups sharing
2677
+ the same imaginary frequency grid points..
2678
+ """,
2679
+ categories=[x_vasp_incar_param],
2680
+ )
2681
+
2682
+ x_vasp_incar_NOMEGAR = Quantity(
2683
+ type=np.int32,
2684
+ shape=[],
2685
+ description="""
2686
+ NOMEGAR specifies the number of frequency grid points along the real axis.
2687
+ """,
2688
+ categories=[x_vasp_incar_param],
2689
+ )
2690
+
2691
+ x_vasp_incar_NPACO = Quantity(
2692
+ type=np.int32,
2693
+ shape=[],
2694
+ description="""
2695
+ NPACO sets the number of slots in the pair-correlation function written to PCDAT.
2696
+ """,
2697
+ categories=[x_vasp_incar_param],
2698
+ )
2699
+
2700
+ x_vasp_incar_NPAR = Quantity(
2701
+ type=np.int32,
2702
+ shape=[],
2703
+ description="""
2704
+ NPAR determines the number of bands that are treated in parallel.
2705
+ """,
2706
+ categories=[x_vasp_incar_param],
2707
+ )
2708
+
2709
+ x_vasp_incar_NPPSTR = Quantity(
2710
+ type=np.int32,
2711
+ shape=[],
2712
+ description="""
2713
+ NPPSTR specifies the number of k-points on the strings in the IGPAR direction.
2714
+ """,
2715
+ categories=[x_vasp_incar_param],
2716
+ )
2717
+
2718
+ x_vasp_incar_NSIM = Quantity(
2719
+ type=np.int32,
2720
+ shape=[],
2721
+ description="""
2722
+ NSIM sets the number of bands that are optimized simultaneously by the RMM-DIIS
2723
+ algorithm.
2724
+ """,
2725
+ categories=[x_vasp_incar_param],
2726
+ )
2727
+
2728
+ x_vasp_incar_NSUBSYS = Quantity(
2729
+ type=np.int32,
2730
+ shape=[],
2731
+ description="""
2732
+ NSUBSYS defines the atomic subsystems in calculations with multiple Anderson
2733
+ thermostats (in case VASP was compiled with -Dtbdyn).
2734
+ """,
2735
+ categories=[x_vasp_incar_param],
2736
+ )
2737
+
2738
+ x_vasp_incar_NSW = Quantity(
2739
+ type=np.int32,
2740
+ shape=[],
2741
+ description="""
2742
+ NSW sets the maximum number of ionic steps.
2743
+ """,
2744
+ categories=[x_vasp_incar_param],
2745
+ )
2746
+
2747
+ x_vasp_incar_NTARGET_STATES = Quantity(
2748
+ type=np.int32,
2749
+ shape=['x_vasp_incar_NBANDS'],
2750
+ description="""
2751
+ Controls which Wannier states are excluded in CRPA. Check also NCRPA_BANDS.
2752
+ """,
2753
+ categories=[x_vasp_incar_param],
2754
+ )
2755
+
2756
+ x_vasp_incar_NTAUPAR = Quantity(
2757
+ type=np.int32,
2758
+ shape=[],
2759
+ description="""
2760
+ NTAUPAR available as of VASP.6, specifies the number of MPI groups sharing same
2761
+ imaginary time grid points. The default value of NTAUPAR is set automatically and
2762
+ depends on MAXMEM, the available memory for each rank on one node.
2763
+ """,
2764
+ categories=[x_vasp_incar_param],
2765
+ )
2766
+
2767
+ x_vasp_incar_NUPDOWN = Quantity(
2768
+ type=np.int32,
2769
+ shape=[],
2770
+ description="""
2771
+ Sets the difference between the number of electrons in the up and down spin
2772
+ components.
2773
+ """,
2774
+ categories=[x_vasp_incar_param],
2775
+ )
2776
+
2777
+ x_vasp_incar_NWRITE = Quantity(
2778
+ type=np.int32,
2779
+ shape=[],
2780
+ description="""
2781
+ This flag determines how much will be written to the file OUTCAR ('verbosity
2782
+ flag').
2783
+ """,
2784
+ categories=[x_vasp_incar_param],
2785
+ )
2786
+
2787
+ x_vasp_incar_ODDONLY = Quantity(
2788
+ type=bool,
2789
+ shape=[],
2790
+ description="""
2791
+ ODDONLY=.TRUE. selects a subset of **k**-points for the representation of the Fock
2792
+ exchange potential, with _C_<sub>1</sub>=_C_<sub>2</sub>=_C_<sub>3</sub>=1, and
2793
+ _n_<sub>1</sub>+_n_<sub>2</sub>+_n_<sub>3</sub> odd.
2794
+ """,
2795
+ categories=[x_vasp_incar_param],
2796
+ )
2797
+
2798
+ x_vasp_incar_ODDONLYGW = Quantity(
2799
+ type=bool,
2800
+ shape=[],
2801
+ description="""
2802
+ ODDONLYGW allows to avoid the inclusion of the point in the evaluation of
2803
+ response functions (in GW calculations).
2804
+ """,
2805
+ categories=[x_vasp_incar_param],
2806
+ )
2807
+
2808
+ x_vasp_incar_OFIELD_A = Quantity(
2809
+ type=np.float64,
2810
+ shape=[],
2811
+ description="""
2812
+ The flag OFIELD_A sets the desired order parameter *Q*<sub>6</sub> in the
2813
+ Interface pinning method.
2814
+ """,
2815
+ categories=[x_vasp_incar_param],
2816
+ )
2817
+
2818
+ x_vasp_incar_OFIELD_KAPPA = Quantity(
2819
+ type=np.float64,
2820
+ shape=[],
2821
+ description="""
2822
+ The flag OFIELD_KAPPA sets the strength of bias potential in units of 'eV/(unit of
2823
+ Q)$^2$' in the Interface pinning method.
2824
+ """,
2825
+ categories=[x_vasp_incar_param],
2826
+ )
2827
+
2828
+ x_vasp_incar_OFIELD_Q6_FAR = Quantity(
2829
+ type=np.float64,
2830
+ shape=[],
2831
+ description="""
2832
+ The flag OFIELD_Q6_FAR sets the far fading distance (in Angstroms) for the
2833
+ computation of a continuous to *Q*<sub>6</sub> parameter in the Interface pinning
2834
+ method.
2835
+ """,
2836
+ categories=[x_vasp_incar_param],
2837
+ )
2838
+
2839
+ x_vasp_incar_OFIELD_Q6_NEAR = Quantity(
2840
+ type=np.float64,
2841
+ shape=[],
2842
+ description="""
2843
+ The flag OFIELD_Q6_NEAR sets the near fading distance (in Angstroms) for the
2844
+ computation of a continuous *Q*<sub>6</sub> parameter in the Interface pinning
2845
+ method.
2846
+ """,
2847
+ categories=[x_vasp_incar_param],
2848
+ )
2849
+
2850
+ x_vasp_incar_OMEGAMAX = Quantity(
2851
+ type=np.float64,
2852
+ shape=[],
2853
+ description="""
2854
+ OMEGAMAX specifies the maximum frequency for dense part of the frequency grid. For
2855
+ CRPA calculations, OMEGAMAX is the frequency point of the interaction.
2856
+ """,
2857
+ categories=[x_vasp_incar_param],
2858
+ )
2859
+
2860
+ x_vasp_incar_OMEGAMIN = Quantity(
2861
+ type=np.float64,
2862
+ shape=[],
2863
+ description="""
2864
+ minimum frequency in the frequency grid.
2865
+ """,
2866
+ categories=[x_vasp_incar_param],
2867
+ )
2868
+
2869
+ x_vasp_incar_OMEGATL = Quantity(
2870
+ type=np.float64,
2871
+ shape=[],
2872
+ description="""
2873
+ OMEGATL specifies the maximum frequency for coarse part of the frequency grid.
2874
+ """,
2875
+ categories=[x_vasp_incar_param],
2876
+ )
2877
+
2878
+ x_vasp_incar_PARAM1 = Quantity(
2879
+ type=np.float64,
2880
+ shape=[],
2881
+ description="""
2882
+ The flag PARAM1 determines the first parameter used in the enhancement factor of
2883
+ the optPBE-vdW and optB88-vdW functional.
2884
+ """,
2885
+ categories=[x_vasp_incar_param],
2886
+ )
2887
+
2888
+ x_vasp_incar_PARAM2 = Quantity(
2889
+ type=np.float64,
2890
+ shape=[],
2891
+ description="""
2892
+ The flag PARAM2 determines the second parameter used in the enhancement factor of
2893
+ the optPBE-vdW and optB88-vdW functional.
2894
+ """,
2895
+ categories=[x_vasp_incar_param],
2896
+ )
2897
+
2898
+ x_vasp_incar_PFLAT = Quantity(
2899
+ type=bool,
2900
+ shape=[],
2901
+ description="""
2902
+ Control flag for the output of the profiling routines.
2903
+ """,
2904
+ categories=[x_vasp_incar_param],
2905
+ )
2906
+
2907
+ x_vasp_incar_PHON_LBOSE = Quantity(
2908
+ type=bool,
2909
+ shape=[],
2910
+ description="""
2911
+ This flag determines whether random structures in the Monte-Carlo (MC) sampling
2912
+ are created according to Bose-Einstein or Maxwell-Boltzmann statistics.
2913
+ """,
2914
+ categories=[x_vasp_incar_param],
2915
+ )
2916
+
2917
+ x_vasp_incar_PHON_LMC = Quantity(
2918
+ type=bool,
2919
+ shape=[],
2920
+ description="""
2921
+ This flag controls whether electron-phonon interactions from Monte-Carlo sampling
2922
+ are calculated or not.
2923
+ """,
2924
+ categories=[x_vasp_incar_param],
2925
+ )
2926
+
2927
+ x_vasp_incar_PHON_NSTRUCT = Quantity(
2928
+ type=np.int32,
2929
+ shape=[],
2930
+ description="""
2931
+ This flag sets the number of structures for electron-phonon interactions from
2932
+ Monte-Carlo (MC) sampling.
2933
+ """,
2934
+ categories=[x_vasp_incar_param],
2935
+ )
2936
+
2937
+ x_vasp_incar_PHON_NTLIST = Quantity(
2938
+ type=np.int32,
2939
+ shape=[],
2940
+ description="""
2941
+ This flag sets the number temperatures for that the electron-phonon interactions
2942
+ using the ZG configuration is evaluated.
2943
+ """,
2944
+ categories=[x_vasp_incar_param],
2945
+ )
2946
+
2947
+ x_vasp_incar_PHON_TLIST = Quantity(
2948
+ type=np.int32,
2949
+ shape=['x_vasp_incar_PHON_NTLIST'],
2950
+ description="""
2951
+ This flag provides the list of temperatures for that the electron-phonon
2952
+ interactions using the ZG configuration is evaluated.
2953
+ """,
2954
+ categories=[x_vasp_incar_param],
2955
+ )
2956
+
2957
+ x_vasp_incar_PLEVEL = Quantity(
2958
+ type=np.int32,
2959
+ shape=[],
2960
+ description="""
2961
+ Control flag for the output of the profiling routines.
2962
+ """,
2963
+ categories=[x_vasp_incar_param],
2964
+ )
2965
+
2966
+ x_vasp_incar_PMASS = Quantity(
2967
+ type=np.float64,
2968
+ shape=[],
2969
+ description="""
2970
+ PMASS assigns a fictitious mass (in amu) to the lattice degrees-of-freedom in case
2971
+ of Parrinello-Rahman dynamics (in case VASP was compiled with -Dtbdyn).
2972
+ """,
2973
+ categories=[x_vasp_incar_param],
2974
+ )
2975
+
2976
+ x_vasp_incar_POMASS = Quantity(
2977
+ type=np.float64,
2978
+ shape=[],
2979
+ description="""
2980
+ POMASS describes the mass of each atomic sphere in atomic units.
2981
+ """,
2982
+ categories=[x_vasp_incar_param],
2983
+ )
2984
+
2985
+ x_vasp_incar_POTIM = Quantity(
2986
+ type=np.float64,
2987
+ shape=[],
2988
+ description="""
2989
+ POTIM sets the time step (MD) or step width scaling (ionic relaxations).
2990
+ """,
2991
+ categories=[x_vasp_incar_param],
2992
+ )
2993
+
2994
+ x_vasp_incar_PREC = Quantity(
2995
+ type=str,
2996
+ shape=[],
2997
+ description="""
2998
+ PREC specifies the precision mode.
2999
+ """,
3000
+ categories=[x_vasp_incar_param],
3001
+ )
3002
+
3003
+ x_vasp_incar_PRECFOCK = Quantity(
3004
+ type=str,
3005
+ shape=[],
3006
+ description="""
3007
+ PRECFOCK controls the FFT grids used in the exact exchange routines (Hartree-Fock
3008
+ and hybrid functionals).
3009
+ """,
3010
+ categories=[x_vasp_incar_param],
3011
+ )
3012
+
3013
+ x_vasp_incar_PROUTINE = Quantity(
3014
+ type=np.int32,
3015
+ shape=[],
3016
+ description="""
3017
+ Control flag for the output of the profiling routines.
3018
+ """,
3019
+ categories=[x_vasp_incar_param],
3020
+ )
3021
+
3022
+ x_vasp_incar_PSTRESS = Quantity(
3023
+ type=np.float64,
3024
+ shape=[],
3025
+ description="""
3026
+ This flag controls whether Pulay corrections are added to the stress tensor or
3027
+ not. In molecular dynamics calculations it controls the pressure. The unit of
3028
+ PSTRESS is in kB.
3029
+ """,
3030
+ categories=[x_vasp_incar_param],
3031
+ )
3032
+
3033
+ x_vasp_incar_PSUBSYS = Quantity(
3034
+ type=np.float64,
3035
+ shape=['1..3'],
3036
+ description="""
3037
+ PSUBSYS sets the collision probabilities for the atoms in each atomic subsystem in
3038
+ calculations with multiple Anderson thermostats (in case VASP was compiled with
3039
+ -Dtbdyn). Note: 0 ≤ PSUBSYS ≤ 1
3040
+ """,
3041
+ categories=[x_vasp_incar_param],
3042
+ )
3043
+
3044
+ x_vasp_incar_PTHRESHOLD = Quantity(
3045
+ type=np.float64,
3046
+ shape=[],
3047
+ description="""
3048
+ Control flag for the output of the profiling routines.
3049
+ """,
3050
+ categories=[x_vasp_incar_param],
3051
+ )
3052
+
3053
+ x_vasp_incar_QMAXFOCKAE = Quantity(
3054
+ type=np.float64,
3055
+ shape=['1..x_vasp_number_of_k_points'],
3056
+ description="""
3057
+ The parameter QMAXFOCKAE controls at which wave vectors the local augmentation
3058
+ charges are fitted to obtain an accurate charge augmentation on the plane wave
3059
+ grid.
3060
+ """,
3061
+ categories=[x_vasp_incar_param],
3062
+ )
3063
+
3064
+ x_vasp_incar_QSPIRAL = Quantity(
3065
+ type=np.float64,
3066
+ shape=[3],
3067
+ description="""
3068
+ the QSPIRAL-tag specifies the spin spiral propagation vector.
3069
+ """,
3070
+ categories=[x_vasp_incar_param],
3071
+ )
3072
+
3073
+ x_vasp_incar_QUAD_EFG = Quantity(
3074
+ type=np.float64,
3075
+ shape=['number_of_atomic_species'],
3076
+ description="""
3077
+ nuclear quadrupole moment (in millbarn) for the atomic types on the POTCAR file.
3078
+ """,
3079
+ categories=[x_vasp_incar_param],
3080
+ )
3081
+
3082
+ x_vasp_incar_RANDOM_SEED = Quantity(
3083
+ type=np.int32,
3084
+ shape=['x'],
3085
+ description="""
3086
+ RANDOM_SEED specifies the seed of the random-number-generator (in case VASP was
3087
+ compiled with -Dtbdyn).
3088
+ """,
3089
+ categories=[x_vasp_incar_param],
3090
+ )
3091
+
3092
+ x_vasp_incar_ROPT = Quantity(
3093
+ type=np.float64,
3094
+ shape=['number_of_atomic_species'],
3095
+ description="""
3096
+ ROPT determines how precise the projectors are represented in real space.
3097
+ """,
3098
+ categories=[x_vasp_incar_param],
3099
+ )
3100
+
3101
+ x_vasp_incar_RWIGS = Quantity(
3102
+ type=np.float64,
3103
+ shape=['number_of_atomic_species'],
3104
+ description="""
3105
+ RWIGS specifies the Wigner-Seitz radius for each atom type.
3106
+ """,
3107
+ categories=[x_vasp_incar_param],
3108
+ )
3109
+
3110
+ x_vasp_incar_SAXIS = Quantity(
3111
+ type=np.float64,
3112
+ shape=[3],
3113
+ description="""
3114
+ SAXIS specifies the quantisation axis for noncollinear spins.
3115
+ """,
3116
+ categories=[x_vasp_incar_param],
3117
+ )
3118
+
3119
+ x_vasp_incar_SCSRAD = Quantity(
3120
+ type=np.float64,
3121
+ shape=[],
3122
+ description="""
3123
+ SCSRAD defines the cutoff radius (in Angs ) used in the calculation of
3124
+ $\\tau_{ij}$ within the Tkatchenko-Scheffler method. Self-consistent screening in
3125
+ Tkatchenko-Scheffler method.
3126
+ """,
3127
+ categories=[x_vasp_incar_param],
3128
+ )
3129
+
3130
+ x_vasp_incar_SHAKEMAXITER = Quantity(
3131
+ type=np.int32,
3132
+ shape=[],
3133
+ description="""
3134
+ SHAKEMAXITER specifies the maximum number of iterations in the SHAKE algorithm (in
3135
+ case VASP was compiled with -Dtbdyn).
3136
+ """,
3137
+ categories=[x_vasp_incar_param],
3138
+ )
3139
+
3140
+ x_vasp_incar_SHAKETOL = Quantity(
3141
+ type=np.float64,
3142
+ shape=[],
3143
+ description="""
3144
+ SHAKETOL specifies the tolerance for the SHAKE algorithm (in case VASP was
3145
+ compiled with -Dtbdyn).
3146
+ """,
3147
+ categories=[x_vasp_incar_param],
3148
+ )
3149
+
3150
+ x_vasp_incar_SIGMA = Quantity(
3151
+ type=np.float64,
3152
+ shape=[],
3153
+ description="""
3154
+ SIGMA specifies the width of the smearing in eV.
3155
+ """,
3156
+ categories=[x_vasp_incar_param],
3157
+ )
3158
+
3159
+ x_vasp_incar_SMASS = Quantity(
3160
+ type=np.float64,
3161
+ shape=[],
3162
+ description="""
3163
+ SMASS controls the velocities during an ab-initio molecular dynamics run.
3164
+ """,
3165
+ categories=[x_vasp_incar_param],
3166
+ )
3167
+
3168
+ x_vasp_incar_SMEARINGS = Quantity(
3169
+ type=np.int32,
3170
+ shape=['x_vasp_incar_NSW'],
3171
+ description="""
3172
+ SMEARINGS defines the smearing parameters for ISMEAR=-3 in the calculation of the
3173
+ partial occupancies.
3174
+ """,
3175
+ categories=[x_vasp_incar_param],
3176
+ )
3177
+
3178
+ x_vasp_incar_SPRING = Quantity(
3179
+ type=np.int32,
3180
+ shape=[],
3181
+ description="""
3182
+ SPRING gives the <i>spring constant</i> between the images as used in the elastic
3183
+ band method.
3184
+ """,
3185
+ categories=[x_vasp_incar_param],
3186
+ )
3187
+
3188
+ x_vasp_incar_STEP_MAX = Quantity(
3189
+ type=np.float64,
3190
+ shape=[],
3191
+ description="""
3192
+ The flag STEP_MAX defines the trust radius (upper limit) for the optimization step
3193
+ (in Angs ) in the Improved Dimer Method.
3194
+ """,
3195
+ categories=[x_vasp_incar_param],
3196
+ )
3197
+
3198
+ x_vasp_incar_STEP_SIZE = Quantity(
3199
+ type=np.float64,
3200
+ shape=[],
3201
+ description="""
3202
+ The flag STEP_SIZE defines the trial step size for the optimization step (in Angs
3203
+ ) in the Improved Dimer Method.
3204
+ """,
3205
+ categories=[x_vasp_incar_param],
3206
+ )
3207
+
3208
+ x_vasp_incar_SYMPREC = Quantity(
3209
+ type=np.float64,
3210
+ shape=[],
3211
+ description="""
3212
+ SYMPREC determines to which accuracy the positions in the POSCAR file must be
3213
+ specified (as of VASP.4.4.4).
3214
+ """,
3215
+ categories=[x_vasp_incar_param],
3216
+ )
3217
+
3218
+ x_vasp_incar_SYSTEM = Quantity(
3219
+ type=str,
3220
+ shape=[],
3221
+ description="""
3222
+ The 'title string' defined by SYSTEM is for the user only and should help the user
3223
+ to identify what he wants to do with this specific input file.
3224
+ """,
3225
+ categories=[x_vasp_incar_param],
3226
+ )
3227
+
3228
+ x_vasp_incar_TEBEG = Quantity(
3229
+ type=np.float64,
3230
+ shape=[],
3231
+ description="""
3232
+ TEBEG sets the start temperature for an ab-initio molecular dynamics run
3233
+ (IBRION=0) and other routines (e.g. Electron-phonon interactions from Monte-Carlo
3234
+ sampling).
3235
+ """,
3236
+ categories=[x_vasp_incar_param],
3237
+ )
3238
+
3239
+ x_vasp_incar_TEEND = Quantity(
3240
+ type=np.float64,
3241
+ shape=[],
3242
+ description="""
3243
+ TEEND sets the final temperature for an ab-initio molecular dynamics run
3244
+ (IBRION=0; SMASS=−1).
3245
+ """,
3246
+ categories=[x_vasp_incar_param],
3247
+ )
3248
+
3249
+ x_vasp_incar_TIME = Quantity(
3250
+ type=np.float64,
3251
+ shape=[],
3252
+ description="""
3253
+ TIME controls the time step for IALGO=5X and for the initial (steepest descent)
3254
+ phase of IALGO=4X.
3255
+ """,
3256
+ categories=[x_vasp_incar_param],
3257
+ )
3258
+
3259
+ x_vasp_incar_TSUBSYS = Quantity(
3260
+ type=np.float64,
3261
+ shape=[3],
3262
+ description="""
3263
+ TSUBSYS sets the temperatures for the atomic subsystems in calculations with
3264
+ multiple Anderson thermostats (in case VASP was compiled with -Dtbdyn).
3265
+ """,
3266
+ categories=[x_vasp_incar_param],
3267
+ )
3268
+
3269
+ x_vasp_incar_VALUE_MAX = Quantity(
3270
+ type=np.float64,
3271
+ shape=['x'],
3272
+ description="""
3273
+ VALUE_MAX sets the upper limits for the monitoring of geometric parameters (in
3274
+ case VASP was compiled with -Dtbdyn).
3275
+ """,
3276
+ categories=[x_vasp_incar_param],
3277
+ )
3278
+
3279
+ x_vasp_incar_VALUE_MIN = Quantity(
3280
+ type=np.float64,
3281
+ shape=['x'],
3282
+ description="""
3283
+ VALUE_MIN sets the lower limits for the monitoring of geometric parameters (in
3284
+ case VASP was compiled with -Dtbdyn).
3285
+ """,
3286
+ categories=[x_vasp_incar_param],
3287
+ )
3288
+
3289
+ x_vasp_incar_VCUTOFF = Quantity(
3290
+ type=np.float64,
3291
+ shape=[],
3292
+ description="""
3293
+ The parameter VCUTOFF sets the energy cutoff for bare Coulomb matrix elements and
3294
+ controls the basis set for the bare Coulomb interaction.
3295
+ """,
3296
+ categories=[x_vasp_incar_param],
3297
+ )
3298
+
3299
+ x_vasp_incar_VDW_A1 = Quantity(
3300
+ type=np.float64,
3301
+ shape=[],
3302
+ description="""
3303
+ VDW_A1 defines the damping function parameter in the DFT-D3 method.
3304
+ """,
3305
+ categories=[x_vasp_incar_param],
3306
+ )
3307
+
3308
+ x_vasp_incar_VDW_A2 = Quantity(
3309
+ type=np.float64,
3310
+ shape=[],
3311
+ description="""
3312
+ VDW_A2 defines the damping function parameter in the DFT-D3 method.
3313
+ """,
3314
+ categories=[x_vasp_incar_param],
3315
+ )
3316
+
3317
+ x_vasp_incar_VDW_C6 = Quantity(
3318
+ type=np.float64,
3319
+ shape=['x'],
3320
+ description="""
3321
+ VDW_C6 defines the $C_6$ parameters (units: J.nm$^6$mol$^{-1}$ ) for each species
3322
+ defined in the POSCAR file within the DFT-D2 method.
3323
+ """,
3324
+ categories=[x_vasp_incar_param],
3325
+ )
3326
+
3327
+ x_vasp_incar_VDW_CNRADIUS = Quantity(
3328
+ type=np.float64,
3329
+ shape=[],
3330
+ description="""
3331
+ VDW_CNRADIUS defines the cutoff radius (in Angs ) for the calculation of the
3332
+ coordination numbers used in the DFT-D3 method.
3333
+ """,
3334
+ categories=[x_vasp_incar_param],
3335
+ )
3336
+
3337
+ x_vasp_incar_VDW_D = Quantity(
3338
+ type=np.float64,
3339
+ shape=[],
3340
+ description="""
3341
+ VDW_D defines the damping parameter _d_ in the DFT-D2method.
3342
+ """,
3343
+ categories=[x_vasp_incar_param],
3344
+ )
3345
+
3346
+ x_vasp_incar_VDW_R0 = Quantity(
3347
+ type=np.float64,
3348
+ shape=['number_of_atomic_species'],
3349
+ description="""
3350
+ VDW_R0 defines the $R_0$ parameters (units: Angs ) for each species defined in the
3351
+ POSCAR file within the DFT-D2 method.
3352
+ """,
3353
+ categories=[x_vasp_incar_param],
3354
+ )
3355
+
3356
+ x_vasp_incar_VDW_RADIUS = Quantity(
3357
+ type=np.float64,
3358
+ shape=[],
3359
+ description="""
3360
+ VDW_RADIUS defines the cutoff radius (in Angs) for the pair interactions used in
3361
+ the DFT-D2 and DFT-D3 method.
3362
+ """,
3363
+ categories=[x_vasp_incar_param],
3364
+ )
3365
+
3366
+ x_vasp_incar_VDW_S6 = Quantity(
3367
+ type=np.float64,
3368
+ shape=[],
3369
+ description="""
3370
+ VDW_S6 defines the global scaling factor _S_6_ in the DFT-D2 method.
3371
+ """,
3372
+ categories=[x_vasp_incar_param],
3373
+ )
3374
+
3375
+ x_vasp_incar_VDW_S8 = Quantity(
3376
+ type=np.float64,
3377
+ shape=[],
3378
+ description="""
3379
+ VDW_S8 defines the damping function parameter $s_8$ in the DFT-D3 method.
3380
+ """,
3381
+ categories=[x_vasp_incar_param],
3382
+ )
3383
+
3384
+ x_vasp_incar_VDW_SR = Quantity(
3385
+ type=np.float64,
3386
+ shape=[],
3387
+ description="""
3388
+ VDW_SR defines the damping function parameter $S_R$ (or scaling factor) in the
3389
+ DFT-D2 and DFT-D3 method.
3390
+ """,
3391
+ categories=[x_vasp_incar_param],
3392
+ )
3393
+
3394
+ x_vasp_incar_VOSKOWN = Quantity(
3395
+ type=np.int32,
3396
+ shape=[],
3397
+ description="""
3398
+ Determines whether Vosko-Wilk-Nusair interpolation is used or not.
3399
+ """,
3400
+ categories=[x_vasp_incar_param],
3401
+ )
3402
+
3403
+ x_vasp_incar_WC = Quantity(
3404
+ type=np.float64,
3405
+ shape=[],
3406
+ description="""
3407
+ WC specifies the weight factor for each step in Broyden mixing scheme (IMIX=4).
3408
+ """,
3409
+ categories=[x_vasp_incar_param],
3410
+ )
3411
+
3412
+ x_vasp_incar_WEIMIN = Quantity(
3413
+ type=np.float64,
3414
+ shape=[],
3415
+ description="""
3416
+ WEIMIN specifies the maximum weight for a band to be considered empty.
3417
+ """,
3418
+ categories=[x_vasp_incar_param],
3419
+ )
3420
+
3421
+ x_vasp_incar_ZVAL = Quantity(
3422
+ type=np.float64,
3423
+ shape=[],
3424
+ description="""
3425
+ ZVAL describes the valency of each atomic sphere.
3426
+ """,
3427
+ categories=[x_vasp_incar_param],
3428
+ )