Debian Codegraph @

GUI/PWgui/doc/pwdocs/INPUT_PW.html

raw
1
2 <html>
3 <body>
4 <pre>
5
6 ------------------------------------------------------------------------
7 INPUT FILE DESCRIPTION
8
9 Program: pw.x / PWscf / Quantum Espresso (version: 6.6)
10 ------------------------------------------------------------------------
11
12
13 Input data format: { } = optional, [ ] = it depends, | = or
14
15 All quantities whose dimensions are not explicitly specified are in
16 RYDBERG ATOMIC UNITS. Charge is "number" charge (i.e. not multiplied
17 by e); potentials are in energy units (i.e. they are multiplied by e).
18
19 BEWARE: TABS, DOS &lt;CR&gt;&lt;LF&gt; CHARACTERS ARE POTENTIAL SOURCES OF TROUBLE
20
21 Namelists must appear in the order given below.
22 Comment lines in namelists can be introduced by a "!", exactly as in
23 fortran code. Comments lines in cards can be introduced by
24 either a "!" or a "#" character in the first position of a line.
25 Do not start any line in cards with a "/" character.
26 Leave a space between card names and card options, e.g.
27 ATOMIC_POSITIONS (bohr), not ATOMIC_POSITIONS(bohr)
28 Do not start any line in cards with a "/" character.
29
30
31 Structure of the input data:
32 ===============================================================================
33
34 &CONTROL
35 ...
36 /
37
38 &SYSTEM
39 ...
40 /
41
42 &ELECTRONS
43 ...
44 /
45
46 [ &IONS
47 ...
48 / ]
49
50 [ &CELL
51 ...
52 / ]
53
54 ATOMIC_SPECIES
55 X Mass_X PseudoPot_X
56 Y Mass_Y PseudoPot_Y
57 Z Mass_Z PseudoPot_Z
58
59 ATOMIC_POSITIONS { alat | bohr | crystal | angstrom | crystal_sg }
60 X 0.0 0.0 0.0 {if_pos(1) if_pos(2) if_pos(3)}
61 Y 0.5 0.0 0.0
62 Z O.0 0.2 0.2
63
64 K_POINTS { tpiba | automatic | crystal | gamma | tpiba_b | crystal_b | tpiba_c | crystal_c }
65 if (gamma)
66 nothing to read
67 if (automatic)
68 nk1, nk2, nk3, k1, k2, k3
69 if (not automatic)
70 nks
71 xk_x, xk_y, xk_z, wk
72 if (tpipa_b or crystal_b in a 'bands' calculation) see Doc/brillouin_zones.pdf
73
74 [ CELL_PARAMETERS { alat | bohr | angstrom }
75 v1(1) v1(2) v1(3)
76 v2(1) v2(2) v2(3)
77 v3(1) v3(2) v3(3) ]
78
79 [ OCCUPATIONS
80 f_inp1(1) f_inp1(2) f_inp1(3) ... f_inp1(10)
81 f_inp1(11) f_inp1(12) ... f_inp1(nbnd)
82 [ f_inp2(1) f_inp2(2) f_inp2(3) ... f_inp2(10)
83 f_inp2(11) f_inp2(12) ... f_inp2(nbnd) ] ]
84
85 [ CONSTRAINTS
86 nconstr { constr_tol }
87 constr_type(.) constr(1,.) constr(2,.) [ constr(3,.) constr(4,.) ] { constr_target(.) } ]
88
89 [ ATOMIC_FORCES
90 label_1 Fx(1) Fy(1) Fz(1)
91 .....
92 label_n Fx(n) Fy(n) Fz(n) ]
93
94 [ ADDITIONAL_K_POINTS
95 see: K_POINTS ]
96
97
98
99 ========================================================================
100 NAMELIST: &CONTROL
101
102 +--------------------------------------------------------------------
103 Variable: calculation
104
105 Type: CHARACTER
106 Default: 'scf'
107 Description:
108 A string describing the task to be performed. Options are:
109 'scf'
110 'nscf'
111 'bands'
112 'relax'
113 'md'
114 'vc-relax'
115 'vc-md'
116
117 (vc = variable-cell).
118 +--------------------------------------------------------------------
119
120 +--------------------------------------------------------------------
121 Variable: title
122
123 Type: CHARACTER
124 Default: ' '
125 Description: reprinted on output.
126 +--------------------------------------------------------------------
127
128 +--------------------------------------------------------------------
129 Variable: verbosity
130
131 Type: CHARACTER
132 Default: 'low'
133 Description:
134 Currently two verbosity levels are implemented:
135 'high'
136 'low'
137
138 'debug' and 'medium' have the same effect as 'high';
139 'default' and 'minimal' as 'low'
140 +--------------------------------------------------------------------
141
142 +--------------------------------------------------------------------
143 Variable: restart_mode
144
145 Type: CHARACTER
146 Default: 'from_scratch'
147 Description:
148 Available options are:
149
150 'from_scratch' :
151 From scratch. This is the normal way to perform a PWscf calculation
152
153 'restart' :
154 From previous interrupted run. Use this switch only if you want to
155 continue, using the same number of processors and parallelization,
156 an interrupted calculation. Do not use to start a new one, or to
157 perform a non-scf calculations. Works only if the calculation was
158 cleanly stopped using variable "max_seconds", or by user request
159 with an "exit file" (i.e.: create a file "prefix".EXIT, in directory
160 "outdir"; see variables "prefix", "outdir"). The default for
161 "startingwfc" and "startingpot" is set to 'file'.
162 +--------------------------------------------------------------------
163
164 +--------------------------------------------------------------------
165 Variable: wf_collect
166
167 Type: LOGICAL
168 Default: .TRUE.
169 Description: This flag controls the way wavefunctions are stored to disk :
170
171 .TRUE. collect wavefunctions from all processors, store them
172 into the output data directory "outdir"/"prefix".save
173 The resulting format is portable to a different number
174 of processors, or different kind of parallelization
175
176 .FALSE. OBSOLETE - NO LONGER IMPLEMENTED
177 do not collect wavefunctions, leave them in temporary
178 local files (one per processor). The resulting format
179 is readable only on the same number of processors and
180 with the same kind of parallelization used to write it.
181
182 Note that this flag has no effect on reading, only on writing.
183 +--------------------------------------------------------------------
184
185 +--------------------------------------------------------------------
186 Variable: nstep
187
188 Type: INTEGER
189 Description: number of molecular-dynamics or structural optimization steps
190 performed in this run. If set to 0, the code performs a quick
191 "dry run", stopping just after initialization. This is useful
192 to check for input correctness and to have the summary printed.
193 Default: 1 if "calculation" == 'scf', 'nscf', 'bands';
194 50 for the other cases
195 +--------------------------------------------------------------------
196
197 +--------------------------------------------------------------------
198 Variable: iprint
199
200 Type: INTEGER
201 Default: write only at convergence
202 Description: band energies are written every iprint iterations
203 +--------------------------------------------------------------------
204
205 +--------------------------------------------------------------------
206 Variable: tstress
207
208 Type: LOGICAL
209 Default: .false.
210 Description: calculate stress. It is set to .TRUE. automatically if
211 "calculation" == 'vc-md' or 'vc-relax'
212 +--------------------------------------------------------------------
213
214 +--------------------------------------------------------------------
215 Variable: tprnfor
216
217 Type: LOGICAL
218 Description: calculate forces. It is set to .TRUE. automatically if
219 "calculation" == 'relax','md','vc-md'
220 +--------------------------------------------------------------------
221
222 +--------------------------------------------------------------------
223 Variable: dt
224
225 Type: REAL
226 Default: 20.D0
227 Description: time step for molecular dynamics, in Rydberg atomic units
228 (1 a.u.=4.8378 * 10^-17 s : beware, the CP code uses
229 Hartree atomic units, half that much!!!)
230 +--------------------------------------------------------------------
231
232 +--------------------------------------------------------------------
233 Variable: outdir
234
235 Type: CHARACTER
236 Default: value of the ESPRESSO_TMPDIR environment variable if set;
237 current directory ('./') otherwise
238 Description: input, temporary, output files are found in this directory,
239 see also "wfcdir"
240 +--------------------------------------------------------------------
241
242 +--------------------------------------------------------------------
243 Variable: wfcdir
244
245 Type: CHARACTER
246 Default: same as "outdir"
247 Description: This directory specifies where to store files generated by
248 each processor (*.wfc{N}, *.igk{N}, etc.). Useful for
249 machines without a parallel file system: set "wfcdir" to
250 a local file system, while "outdir" should be a parallel
251 or network file system, visible to all processors. Beware:
252 in order to restart from interrupted runs, or to perform
253 further calculations using the produced data files, you
254 may need to copy files to "outdir". Works only for pw.x.
255 +--------------------------------------------------------------------
256
257 +--------------------------------------------------------------------
258 Variable: prefix
259
260 Type: CHARACTER
261 Default: 'pwscf'
262 Description: prepended to input/output filenames:
263 prefix.wfc, prefix.rho, etc.
264 +--------------------------------------------------------------------
265
266 +--------------------------------------------------------------------
267 Variable: lkpoint_dir
268
269 Type: LOGICAL
270 Default: .true.
271 Description: If .false. a subdirectory for each k_point is not opened
272 in the "prefix".save directory; Kohn-Sham eigenvalues are
273 stored instead in a single file for all k-points. Currently
274 doesn't work together with "wf_collect"
275 +--------------------------------------------------------------------
276
277 +--------------------------------------------------------------------
278 Variable: max_seconds
279
280 Type: REAL
281 Default: 1.D+7, or 150 days, i.e. no time limit
282 Description: Jobs stops after "max_seconds" CPU time. Use this option
283 in conjunction with option "restart_mode" if you need to
284 split a job too long to complete into shorter jobs that
285 fit into your batch queues.
286 +--------------------------------------------------------------------
287
288 +--------------------------------------------------------------------
289 Variable: etot_conv_thr
290
291 Type: REAL
292 Default: 1.0D-4
293 Description: Convergence threshold on total energy (a.u) for ionic
294 minimization: the convergence criterion is satisfied
295 when the total energy changes less than "etot_conv_thr"
296 between two consecutive scf steps. Note that "etot_conv_thr"
297 is extensive, like the total energy.
298 See also "forc_conv_thr" - both criteria must be satisfied
299 +--------------------------------------------------------------------
300
301 +--------------------------------------------------------------------
302 Variable: forc_conv_thr
303
304 Type: REAL
305 Default: 1.0D-3
306 Description: Convergence threshold on forces (a.u) for ionic minimization:
307 the convergence criterion is satisfied when all components of
308 all forces are smaller than "forc_conv_thr".
309 See also "etot_conv_thr" - both criteria must be satisfied
310 +--------------------------------------------------------------------
311
312 +--------------------------------------------------------------------
313 Variable: disk_io
314
315 Type: CHARACTER
316 Default: see below
317 Description:
318 Specifies the amount of disk I/O activity:
319 (only for binary files and xml data file in data directory;
320 other files printed at each molecular dynamics / structural
321 optimization step are not controlled by this option )
322
323 'high' :
324 save charge to disk at each SCF step,
325 keep wavefunctions on disk (in "distributed" format),
326 save mixing data as well.
327 Do not use this option unless you have a good reason!
328 It is no longer needed to specify 'high' in order to be able
329 to restart from an interrupted calculation (see "restart_mode")
330
331 'medium' :
332 save charge to disk at each SCF step,
333 keep wavefunctions on disk only if more than one k-point,
334 per process is present, otherwise keep them in memory;
335 save them to disk only at the end (in "portable" format)
336
337 'low' :
338 save charge to disk at each SCF step,
339 keep wavefunctions in memory (for all k-points),
340 save them to disk only at the end (in "portable" format).
341 Reduces I/O but increases memory wrt the previous cases
342
343 'nowf' :
344 save to disk only the xml data file,
345 never save wavefunctions and charge density
346
347 'none' :
348 do not save anything to disk
349
350 Default is 'low' for the scf case, 'medium' otherwise.
351 Note that the needed RAM increases as disk I/O decreases
352 +--------------------------------------------------------------------
353
354 +--------------------------------------------------------------------
355 Variable: pseudo_dir
356
357 Type: CHARACTER
358 Default: value of the $ESPRESSO_PSEUDO environment variable if set;
359 '$HOME/espresso/pseudo/' otherwise
360 Description: directory containing pseudopotential files
361 +--------------------------------------------------------------------
362
363 +--------------------------------------------------------------------
364 Variable: tefield
365
366 Type: LOGICAL
367 Default: .FALSE.
368 Description: If .TRUE. a saw-like potential simulating an electric field
369 is added to the bare ionic potential. See variables "edir",
370 "eamp", "emaxpos", "eopreg" for the form and size of
371 the added potential.
372 +--------------------------------------------------------------------
373
374 +--------------------------------------------------------------------
375 Variable: dipfield
376
377 Type: LOGICAL
378 Default: .FALSE.
379 Description: If .TRUE. and "tefield"==.TRUE. a dipole correction is also
380 added to the bare ionic potential - implements the recipe
381 of L. Bengtsson, PRB 59, 12301 (1999). See variables "edir",
382 "emaxpos", "eopreg" for the form of the correction. Must
383 be used ONLY in a slab geometry, for surface calculations,
384 with the discontinuity FALLING IN THE EMPTY SPACE.
385 +--------------------------------------------------------------------
386
387 +--------------------------------------------------------------------
388 Variable: lelfield
389
390 Type: LOGICAL
391 Default: .FALSE.
392 Description: If .TRUE. a homogeneous finite electric field described
393 through the modern theory of the polarization is applied.
394 This is different from "tefield" == .true. !
395 +--------------------------------------------------------------------
396
397 +--------------------------------------------------------------------
398 Variable: nberrycyc
399
400 Type: INTEGER
401 Default: 1
402 Description: In the case of a finite electric field ( "lelfield" == .TRUE. )
403 it defines the number of iterations for converging the
404 wavefunctions in the electric field Hamiltonian, for each
405 external iteration on the charge density
406 +--------------------------------------------------------------------
407
408 +--------------------------------------------------------------------
409 Variable: lorbm
410
411 Type: LOGICAL
412 Default: .FALSE.
413 Description: If .TRUE. perform orbital magnetization calculation.
414 If finite electric field is applied ("lelfield"==.true.) only Kubo terms are computed
415 [for details see New J. Phys. 12, 053032 (2010), doi:10.1088/1367-2630/12/5/053032].
416
417 The type of calculation is 'nscf' and should be performed on an automatically
418 generated uniform grid of k points.
419
420 Works ONLY with norm-conserving pseudopotentials.
421 +--------------------------------------------------------------------
422
423 +--------------------------------------------------------------------
424 Variable: lberry
425
426 Type: LOGICAL
427 Default: .FALSE.
428 Description: If .TRUE. perform a Berry phase calculation.
429 See the header of PW/src/bp_c_phase.f90 for documentation.
430 +--------------------------------------------------------------------
431
432 +--------------------------------------------------------------------
433 Variable: gdir
434
435 Type: INTEGER
436 Description: For Berry phase calculation: direction of the k-point
437 strings in reciprocal space. Allowed values: 1, 2, 3
438 1=first, 2=second, 3=third reciprocal lattice vector
439 For calculations with finite electric fields
440 ("lelfield"==.true.) "gdir" is the direction of the field.
441 +--------------------------------------------------------------------
442
443 +--------------------------------------------------------------------
444 Variable: nppstr
445
446 Type: INTEGER
447 Description: For Berry phase calculation: number of k-points to be
448 calculated along each symmetry-reduced string.
449 The same for calculation with finite electric fields
450 ("lelfield"==.true.).
451 +--------------------------------------------------------------------
452
453 +--------------------------------------------------------------------
454 Variable: lfcpopt
455
456 Type: LOGICAL
457 See: fcp_mu
458 Default: .FALSE.
459 Description: If .TRUE. perform a constant bias potential (constant-mu) calculation
460 for a static system with ESM method. See the header of PW/src/fcp.f90
461 for documentation.
462
463 NB:
464 - The total energy displayed in 'prefix.out' includes the potentiostat
465 contribution (-mu*N).
466 - "calculation" must be 'relax'.
467 - "assume_isolated" = 'esm' and "esm_bc" = 'bc2' or 'bc3' must be set
468 in "SYSTEM" namelist.
469 +--------------------------------------------------------------------
470
471 +--------------------------------------------------------------------
472 Variable: gate
473
474 Type: LOGICAL
475 Default: .FALSE.
476 See: zgate, relaxz, block, block_1, block_2, block_height
477 Description: In the case of charged cells ("tot_charge" .ne. 0) setting gate = .TRUE.
478 represents the counter charge (i.e. -tot_charge) not by a homogeneous
479 background charge but with a charged plate, which is placed at "zgate"
480 (see below). Details of the gate potential can be found in
481 T. Brumme, M. Calandra, F. Mauri; PRB 89, 245406 (2014).
482 Note, that in systems which are not symmetric with respect to the plate,
483 one needs to enable the dipole correction! ("dipfield"=.true.).
484 Currently, symmetry can be used with gate=.true. but carefully check
485 that no symmetry is included which maps z to -z even if in principle one
486 could still use them for symmetric systems (i.e. no dipole correction).
487 For "nosym"=.false. verbosity is set to 'high'.
488 Note: this option was called "monopole" in v6.0 and 6.1 of pw.x
489 +--------------------------------------------------------------------
490
491 ===END OF NAMELIST======================================================
492
493
494 ========================================================================
495 NAMELIST: &SYSTEM
496
497 +--------------------------------------------------------------------
498 Variable: ibrav
499
500 Type: INTEGER
501 Status: REQUIRED
502 Description: Bravais-lattice index. Optional only if space_group is set.
503 If ibrav /= 0, specify EITHER [ "celldm"(1)-"celldm"(6) ]
504 OR [ "A", "B", "C", "cosAB", "cosAC", "cosBC" ]
505 but NOT both. The lattice parameter "alat" is set to
506 alat = celldm(1) (in a.u.) or alat = A (in Angstrom);
507 see below for the other parameters.
508 For ibrav=0 specify the lattice vectors in "CELL_PARAMETERS",
509 optionally the lattice parameter alat = celldm(1) (in a.u.)
510 or = A (in Angstrom). If not specified, the lattice parameter is
511 taken from "CELL_PARAMETERS"
512 IMPORTANT NOTICE 1:
513 with ibrav=0 lattice vectors must be given with a sufficiently large
514 number of digits and with the correct symmetry, or else symmetry
515 detection may fail and strange problems may arise in symmetrization.
516 IMPORTANT NOTICE 2:
517 do not use celldm(1) or A as a.u. to Ang conversion factor,
518 use the true lattice parameters or nothing,
519 specify units in "CELL_PARAMETERS" and "ATOMIC_POSITIONS"
520
521 ibrav structure celldm(2)-celldm(6)
522 or: b,c,cosbc,cosac,cosab
523 0 free
524 crystal axis provided in input: see card "CELL_PARAMETERS"
525
526 1 cubic P (sc)
527 v1 = a(1,0,0), v2 = a(0,1,0), v3 = a(0,0,1)
528
529 2 cubic F (fcc)
530 v1 = (a/2)(-1,0,1), v2 = (a/2)(0,1,1), v3 = (a/2)(-1,1,0)
531
532 3 cubic I (bcc)
533 v1 = (a/2)(1,1,1), v2 = (a/2)(-1,1,1), v3 = (a/2)(-1,-1,1)
534 -3 cubic I (bcc), more symmetric axis:
535 v1 = (a/2)(-1,1,1), v2 = (a/2)(1,-1,1), v3 = (a/2)(1,1,-1)
536
537 4 Hexagonal and Trigonal P celldm(3)=c/a
538 v1 = a(1,0,0), v2 = a(-1/2,sqrt(3)/2,0), v3 = a(0,0,c/a)
539
540 5 Trigonal R, 3fold axis c celldm(4)=cos(gamma)
541 The crystallographic vectors form a three-fold star around
542 the z-axis, the primitive cell is a simple rhombohedron:
543 v1 = a(tx,-ty,tz), v2 = a(0,2ty,tz), v3 = a(-tx,-ty,tz)
544 where c=cos(gamma) is the cosine of the angle gamma between
545 any pair of crystallographic vectors, tx, ty, tz are:
546 tx=sqrt((1-c)/2), ty=sqrt((1-c)/6), tz=sqrt((1+2c)/3)
547 -5 Trigonal R, 3fold axis &lt;111&gt; celldm(4)=cos(gamma)
548 The crystallographic vectors form a three-fold star around
549 &lt;111&gt;. Defining a' = a/sqrt(3) :
550 v1 = a' (u,v,v), v2 = a' (v,u,v), v3 = a' (v,v,u)
551 where u and v are defined as
552 u = tz - 2*sqrt(2)*ty, v = tz + sqrt(2)*ty
553 and tx, ty, tz as for case ibrav=5
554 Note: if you prefer x,y,z as axis in the cubic limit,
555 set u = tz + 2*sqrt(2)*ty, v = tz - sqrt(2)*ty
556 See also the note in Modules/latgen.f90
557
558 6 Tetragonal P (st) celldm(3)=c/a
559 v1 = a(1,0,0), v2 = a(0,1,0), v3 = a(0,0,c/a)
560
561 7 Tetragonal I (bct) celldm(3)=c/a
562 v1=(a/2)(1,-1,c/a), v2=(a/2)(1,1,c/a), v3=(a/2)(-1,-1,c/a)
563
564 8 Orthorhombic P celldm(2)=b/a
565 celldm(3)=c/a
566 v1 = (a,0,0), v2 = (0,b,0), v3 = (0,0,c)
567
568 9 Orthorhombic base-centered(bco) celldm(2)=b/a
569 celldm(3)=c/a
570 v1 = (a/2, b/2,0), v2 = (-a/2,b/2,0), v3 = (0,0,c)
571 -9 as 9, alternate description
572 v1 = (a/2,-b/2,0), v2 = (a/2, b/2,0), v3 = (0,0,c)
573 91 Orthorhombic one-face base-centered A-type
574 celldm(2)=b/a
575 celldm(3)=c/a
576 v1 = (a, 0, 0), v2 = (0,b/2,-c/2), v3 = (0,b/2,c/2)
577
578 10 Orthorhombic face-centered celldm(2)=b/a
579 celldm(3)=c/a
580 v1 = (a/2,0,c/2), v2 = (a/2,b/2,0), v3 = (0,b/2,c/2)
581
582 11 Orthorhombic body-centered celldm(2)=b/a
583 celldm(3)=c/a
584 v1=(a/2,b/2,c/2), v2=(-a/2,b/2,c/2), v3=(-a/2,-b/2,c/2)
585
586 12 Monoclinic P, unique axis c celldm(2)=b/a
587 celldm(3)=c/a,
588 celldm(4)=cos(ab)
589 v1=(a,0,0), v2=(b*cos(gamma),b*sin(gamma),0), v3 = (0,0,c)
590 where gamma is the angle between axis a and b.
591 -12 Monoclinic P, unique axis b celldm(2)=b/a
592 celldm(3)=c/a,
593 celldm(5)=cos(ac)
594 v1 = (a,0,0), v2 = (0,b,0), v3 = (c*cos(beta),0,c*sin(beta))
595 where beta is the angle between axis a and c
596
597 13 Monoclinic base-centered celldm(2)=b/a
598 (unique axis c) celldm(3)=c/a,
599 celldm(4)=cos(gamma)
600 v1 = ( a/2, 0, -c/2),
601 v2 = (b*cos(gamma), b*sin(gamma), 0 ),
602 v3 = ( a/2, 0, c/2),
603 where gamma=angle between axis a and b projected on xy plane
604
605 -13 Monoclinic base-centered celldm(2)=b/a
606 (unique axis b) celldm(3)=c/a,
607 celldm(5)=cos(beta)
608 v1 = ( a/2, b/2, 0),
609 v2 = ( -a/2, b/2, 0),
610 v3 = (c*cos(beta), 0, c*sin(beta)),
611 where beta=angle between axis a and c projected on xz plane
612 IMPORTANT NOTICE: until QE v.6.4.1, axis for ibrav=-13 had a
613 different definition: v1(old) =-v2(now), v2(old) = v1(now)
614
615 14 Triclinic celldm(2)= b/a,
616 celldm(3)= c/a,
617 celldm(4)= cos(bc),
618 celldm(5)= cos(ac),
619 celldm(6)= cos(ab)
620 v1 = (a, 0, 0),
621 v2 = (b*cos(gamma), b*sin(gamma), 0)
622 v3 = (c*cos(beta), c*(cos(alpha)-cos(beta)cos(gamma))/sin(gamma),
623 c*sqrt( 1 + 2*cos(alpha)cos(beta)cos(gamma)
624 - cos(alpha)^2-cos(beta)^2-cos(gamma)^2 )/sin(gamma) )
625 where alpha is the angle between axis b and c
626 beta is the angle between axis a and c
627 gamma is the angle between axis a and b
628 +--------------------------------------------------------------------
629
630 ///---
631 EITHER:
632
633 +--------------------------------------------------------------------
634 Variable: celldm(i), i=1,6
635
636 Type: REAL
637 See: ibrav
638 Description: Crystallographic constants - see the "ibrav" variable.
639 Specify either these OR "A","B","C","cosAB","cosBC","cosAC" NOT both.
640 Only needed values (depending on "ibrav") must be specified
641 alat = "celldm"(1) is the lattice parameter "a" (in BOHR)
642 If "ibrav"==0, only "celldm"(1) is used if present;
643 cell vectors are read from card "CELL_PARAMETERS"
644 +--------------------------------------------------------------------
645
646 OR:
647
648 +--------------------------------------------------------------------
649 Variables: A, B, C, cosAB, cosAC, cosBC
650
651 Type: REAL
652 See: ibrav
653 Description: Traditional crystallographic constants:
654
655 a,b,c in ANGSTROM
656 cosAB = cosine of the angle between axis a and b (gamma)
657 cosAC = cosine of the angle between axis a and c (beta)
658 cosBC = cosine of the angle between axis b and c (alpha)
659
660 The axis are chosen according to the value of @ref ibrav.
661 Specify either these OR @ref celldm but NOT both.
662 Only needed values (depending on @ref ibrav) must be specified.
663
664 The lattice parameter alat = A (in ANGSTROM ).
665
666 If @ref ibrav == 0, only A is used if present, and
667 cell vectors are read from card @ref CELL_PARAMETERS.
668 +--------------------------------------------------------------------
669
670 \\\---
671
672 +--------------------------------------------------------------------
673 Variable: nat
674
675 Type: INTEGER
676 Status: REQUIRED
677 Description: number of atoms in the unit cell (ALL atoms, except if
678 space_group is set, in which case, INEQUIVALENT atoms)
679 +--------------------------------------------------------------------
680
681 +--------------------------------------------------------------------
682 Variable: ntyp
683
684 Type: INTEGER
685 Status: REQUIRED
686 Description: number of types of atoms in the unit cell
687 +--------------------------------------------------------------------
688
689 +--------------------------------------------------------------------
690 Variable: nbnd
691
692 Type: INTEGER
693 Default: for an insulator, "nbnd" = number of valence bands
694 ("nbnd" = # of electrons /2);
695 for a metal, 20% more (minimum 4 more)
696 Description: Number of electronic states (bands) to be calculated.
697 Note that in spin-polarized calculations the number of
698 k-point, not the number of bands per k-point, is doubled
699 +--------------------------------------------------------------------
700
701 +--------------------------------------------------------------------
702 Variable: tot_charge
703
704 Type: REAL
705 Default: 0.0
706 Description: Total charge of the system. Useful for simulations with charged cells.
707 By default the unit cell is assumed to be neutral (tot_charge=0).
708 tot_charge=+1 means one electron missing from the system,
709 tot_charge=-1 means one additional electron, and so on.
710
711 In a periodic calculation a compensating jellium background is
712 inserted to remove divergences if the cell is not neutral.
713 +--------------------------------------------------------------------
714
715 +--------------------------------------------------------------------
716 Variable: starting_charge(i), i=1,ntyp
717
718 Type: REAL
719 Default: 0.0
720 Description: starting charge on atomic type 'i',
721 to create starting potential with "startingpot" = 'atomic'.
722 +--------------------------------------------------------------------
723
724 +--------------------------------------------------------------------
725 Variable: tot_magnetization
726
727 Type: REAL
728 Default: -1 [unspecified]
729 Description: Total majority spin charge - minority spin charge.
730 Used to impose a specific total electronic magnetization.
731 If unspecified then tot_magnetization variable is ignored and
732 the amount of electronic magnetization is determined during
733 the self-consistent cycle.
734 +--------------------------------------------------------------------
735
736 +--------------------------------------------------------------------
737 Variable: starting_magnetization(i), i=1,ntyp
738
739 Type: REAL
740 Default: 0
741 Description: Starting spin polarization on atomic type 'i' in a spin
742 polarized (LSDA or noncollinear/spin-orbit) calculation.
743 Allowed values range between -1 (all spins down for the
744 valence electrons of atom type 'i') to 1 (all spins up).
745 If you expect a nonzero magnetization in your ground state,
746 you MUST either specify a nonzero value for at least one
747 atomic type, or constrain the magnetization using variable
748 "tot_magnetization" for LSDA, "constrained_magnetization"
749 for noncollinear/spin-orbit calculations. If you don't,
750 you will get a nonmagnetic (zero magnetization) state.
751 In order to perform LSDA calculations for an antiferromagnetic
752 state, define two different atomic species corresponding to
753 sublattices of the same atomic type.
754
755 NOTE 1: "starting_magnetization" is ignored in most BUT NOT ALL
756 cases in non-scf calculations: it is safe to keep the same
757 values for the scf and subsequent non-scf calculation.
758
759 NOTE 2: If you fix the magnetization with
760 "tot_magnetization", do not specify "starting_magnetization".
761
762 NOTE 3: In the noncollinear/spin-orbit case, starting with zero
763 starting_magnetization on all atoms imposes time reversal
764 symmetry. The magnetization is never calculated and is
765 set to zero (the internal variable domag is set to .FALSE.).
766 +--------------------------------------------------------------------
767
768 +--------------------------------------------------------------------
769 Variable: ecutwfc
770
771 Type: REAL
772 Status: REQUIRED
773 Description: kinetic energy cutoff (Ry) for wavefunctions
774 +--------------------------------------------------------------------
775
776 +--------------------------------------------------------------------
777 Variable: ecutrho
778
779 Type: REAL
780 Default: 4 * "ecutwfc"
781 Description: Kinetic energy cutoff (Ry) for charge density and potential
782 For norm-conserving pseudopotential you should stick to the
783 default value, you can reduce it by a little but it will
784 introduce noise especially on forces and stress.
785 If there are ultrasoft PP, a larger value than the default is
786 often desirable (ecutrho = 8 to 12 times "ecutwfc", typically).
787 PAW datasets can often be used at 4*"ecutwfc", but it depends
788 on the shape of augmentation charge: testing is mandatory.
789 The use of gradient-corrected functional, especially in cells
790 with vacuum, or for pseudopotential without non-linear core
791 correction, usually requires an higher values of ecutrho
792 to be accurately converged.
793 +--------------------------------------------------------------------
794
795 +--------------------------------------------------------------------
796 Variable: ecutfock
797
798 Type: REAL
799 Default: ecutrho
800 Description: Kinetic energy cutoff (Ry) for the exact exchange operator in
801 EXX type calculations. By default this is the same as "ecutrho"
802 but in some EXX calculations, a significant speed-up can be obtained
803 by reducing ecutfock, at the expense of some loss in accuracy.
804 Must be .gt. "ecutwfc". Not implemented for stress calculation
805 and for US-PP and PAW pseudopotentials.
806 Use with care, especially in metals where it may give raise
807 to instabilities.
808 +--------------------------------------------------------------------
809
810 +--------------------------------------------------------------------
811 Variables: nr1, nr2, nr3
812
813 Type: INTEGER
814 Description: Three-dimensional FFT mesh (hard grid) for charge
815 density (and scf potential). If not specified
816 the grid is calculated based on the cutoff for
817 charge density (see also @ref ecutrho)
818 Note: you must specify all three dimensions for this setting to
819 be used.
820 +--------------------------------------------------------------------
821
822 +--------------------------------------------------------------------
823 Variables: nr1s, nr2s, nr3s
824
825 Type: INTEGER
826 Description: Three-dimensional mesh for wavefunction FFT and for the smooth
827 part of charge density ( smooth grid ).
828 Coincides with @ref nr1, @ref nr2, @ref nr3 if @ref ecutrho = 4 * ecutwfc ( default )
829 Note: you must specify all three dimensions for this setting to
830 be used.
831 +--------------------------------------------------------------------
832
833 +--------------------------------------------------------------------
834 Variable: nosym
835
836 Type: LOGICAL
837 Default: .FALSE.
838 Description: if (.TRUE.) symmetry is not used. Consequences:
839
840 - if a list of k points is provided in input, it is used
841 "as is": symmetry-inequivalent k-points are not generated,
842 and the charge density is not symmetrized;
843
844 - if a uniform (Monkhorst-Pack) k-point grid is provided in
845 input, it is expanded to cover the entire Brillouin Zone,
846 irrespective of the crystal symmetry.
847 Time reversal symmetry is assumed so k and -k are considered
848 as equivalent unless "noinv"=.true. is specified.
849
850 Do not use this option unless you know exactly what you want
851 and what you get. May be useful in the following cases:
852 - in low-symmetry large cells, if you cannot afford a k-point
853 grid with the correct symmetry
854 - in MD simulations
855 - in calculations for isolated atoms
856 +--------------------------------------------------------------------
857
858 +--------------------------------------------------------------------
859 Variable: nosym_evc
860
861 Type: LOGICAL
862 Default: .FALSE.
863 Description: if (.TRUE.) symmetry is not used, and k points are
864 forced to have the symmetry of the Bravais lattice;
865 an automatically generated Monkhorst-Pack grid will contain
866 all points of the grid over the entire Brillouin Zone,
867 plus the points rotated by the symmetries of the Bravais
868 lattice which were not in the original grid. The same
869 applies if a k-point list is provided in input instead
870 of a Monkhorst-Pack grid. Time reversal symmetry is assumed
871 so k and -k are equivalent unless "noinv"=.true. is specified.
872 This option differs from "nosym" because it forces k-points
873 in all cases to have the full symmetry of the Bravais lattice
874 (not all uniform grids have such property!)
875 +--------------------------------------------------------------------
876
877 +--------------------------------------------------------------------
878 Variable: noinv
879
880 Type: LOGICAL
881 Default: .FALSE.
882 Description: if (.TRUE.) disable the usage of k =&gt; -k symmetry
883 (time reversal) in k-point generation
884 +--------------------------------------------------------------------
885
886 +--------------------------------------------------------------------
887 Variable: no_t_rev
888
889 Type: LOGICAL
890 Default: .FALSE.
891 Description: if (.TRUE.) disable the usage of magnetic symmetry operations
892 that consist in a rotation + time reversal.
893 +--------------------------------------------------------------------
894
895 +--------------------------------------------------------------------
896 Variable: force_symmorphic
897
898 Type: LOGICAL
899 Default: .FALSE.
900 Description: if (.TRUE.) force the symmetry group to be symmorphic by disabling
901 symmetry operations having an associated fractionary translation
902 +--------------------------------------------------------------------
903
904 +--------------------------------------------------------------------
905 Variable: use_all_frac
906
907 Type: LOGICAL
908 Default: .FALSE.
909 Description: if (.FALSE.) force real-space FFT grids to be commensurate with
910 fractionary translations of non-symmorphic symmetry operations,
911 if present (e.g.: if a fractional translation (0,0,c/4) exists,
912 the FFT dimension along the c axis must be multiple of 4).
913 if (.TRUE.) do not impose any constraints to FFT grids, even in
914 the presence of non-symmorphic symmetry operations.
915 BEWARE: use_all_frac=.TRUE. may lead to wrong results for
916 hybrid functionals and phonon calculations. Both cases use
917 symmetrization in real space that works for non-symmorphic
918 operations only if the real-space FFT grids are commensurate.
919 +--------------------------------------------------------------------
920
921 +--------------------------------------------------------------------
922 Variable: occupations
923
924 Type: CHARACTER
925 Description:
926 Available options are:
927
928 'smearing' :
929 gaussian smearing for metals;
930 see variables "smearing" and "degauss"
931
932 'tetrahedra' :
933 Tetrahedron method, Bloechl's version:
934 P.E. Bloechl, PRB 49, 16223 (1994)
935 Requires uniform grid of k-points, to be
936 automatically generated (see card "K_POINTS").
937 Well suited for calculation of DOS,
938 less so (because not variational) for
939 force/optimization/dynamics calculations.
940
941 'tetrahedra_lin' :
942 Original linear tetrahedron method.
943 To be used only as a reference;
944 the optimized tetrahedron method is more efficient.
945
946 'tetrahedra_opt' :
947 Optimized tetrahedron method:
948 see M. Kawamura, PRB 89, 094515 (2014).
949 Can be used for phonon calculations as well.
950
951 'fixed' :
952 for insulators with a gap
953
954 'from_input' :
955 The occupation are read from input file,
956 card "OCCUPATIONS". Option valid only for a
957 single k-point, requires "nbnd" to be set
958 in input. Occupations should be consistent
959 with the value of "tot_charge".
960 +--------------------------------------------------------------------
961
962 +--------------------------------------------------------------------
963 Variable: one_atom_occupations
964
965 Type: LOGICAL
966 Default: .FALSE.
967 Description: This flag is used for isolated atoms ("nat"=1) together with
968 "occupations"='from_input'. If it is .TRUE., the wavefunctions
969 are ordered as the atomic starting wavefunctions, independently
970 from their eigenvalue. The occupations indicate which atomic
971 states are filled.
972
973 The order of the states is written inside the UPF pseudopotential file.
974 In the scalar relativistic case:
975 S -&gt; l=0, m=0
976 P -&gt; l=1, z, x, y
977 D -&gt; l=2, r^2-3z^2, xz, yz, xy, x^2-y^2
978
979 In the noncollinear magnetic case (with or without spin-orbit),
980 each group of states is doubled. For instance:
981 P -&gt; l=1, z, x, y for spin up, l=1, z, x, y for spin down.
982 Up and down is relative to the direction of the starting
983 magnetization.
984
985 In the case with spin-orbit and time-reversal
986 ("starting_magnetization"=0.0) the atomic wavefunctions are
987 radial functions multiplied by spin-angle functions.
988 For instance:
989 P -&gt; l=1, j=1/2, m_j=-1/2,1/2. l=1, j=3/2,
990 m_j=-3/2, -1/2, 1/2, 3/2.
991
992 In the magnetic case with spin-orbit the atomic wavefunctions
993 can be forced to be spin-angle functions by setting
994 "starting_spin_angle" to .TRUE..
995 +--------------------------------------------------------------------
996
997 +--------------------------------------------------------------------
998 Variable: starting_spin_angle
999
1000 Type: LOGICAL
1001 Default: .FALSE.
1002 Description: In the spin-orbit case when "domag"=.TRUE., by default,
1003 the starting wavefunctions are initialized as in scalar
1004 relativistic noncollinear case without spin-orbit.
1005
1006 By setting "starting_spin_angle"=.TRUE. this behaviour can
1007 be changed and the initial wavefunctions are radial
1008 functions multiplied by spin-angle functions.
1009
1010 When "domag"=.FALSE. the initial wavefunctions are always
1011 radial functions multiplied by spin-angle functions
1012 independently from this flag.
1013
1014 When "lspinorb" is .FALSE. this flag is not used.
1015 +--------------------------------------------------------------------
1016
1017 +--------------------------------------------------------------------
1018 Variable: degauss
1019
1020 Type: REAL
1021 Default: 0.D0 Ry
1022 Description: value of the gaussian spreading (Ry) for brillouin-zone
1023 integration in metals.
1024 +--------------------------------------------------------------------
1025
1026 +--------------------------------------------------------------------
1027 Variable: smearing
1028
1029 Type: CHARACTER
1030 Default: 'gaussian'
1031 Description:
1032 Available options are:
1033
1034 'gaussian', 'gauss' :
1035 ordinary Gaussian spreading (Default)
1036
1037 'methfessel-paxton', 'm-p', 'mp' :
1038 Methfessel-Paxton first-order spreading
1039 (see PRB 40, 3616 (1989)).
1040
1041 'marzari-vanderbilt', 'cold', 'm-v', 'mv' :
1042 Marzari-Vanderbilt-DeVita-Payne cold smearing
1043 (see PRL 82, 3296 (1999))
1044
1045 'fermi-dirac', 'f-d', 'fd' :
1046 smearing with Fermi-Dirac function
1047 +--------------------------------------------------------------------
1048
1049 +--------------------------------------------------------------------
1050 Variable: nspin
1051
1052 Type: INTEGER
1053 Default: 1
1054 Description: nspin = 1 : non-polarized calculation (default)
1055
1056 nspin = 2 : spin-polarized calculation, LSDA
1057 (magnetization along z axis)
1058
1059 nspin = 4 : spin-polarized calculation, noncollinear
1060 (magnetization in generic direction)
1061 DO NOT specify "nspin" in this case;
1062 specify "noncolin"=.TRUE. instead
1063 +--------------------------------------------------------------------
1064
1065 +--------------------------------------------------------------------
1066 Variable: noncolin
1067
1068 Type: LOGICAL
1069 Default: .false.
1070 Description: if .true. the program will perform a noncollinear calculation.
1071 +--------------------------------------------------------------------
1072
1073 +--------------------------------------------------------------------
1074 Variable: ecfixed
1075
1076 Type: REAL
1077 Default: 0.0
1078 See: q2sigma
1079 +--------------------------------------------------------------------
1080
1081 +--------------------------------------------------------------------
1082 Variable: qcutz
1083
1084 Type: REAL
1085 Default: 0.0
1086 See: q2sigma
1087 +--------------------------------------------------------------------
1088
1089 +--------------------------------------------------------------------
1090 Variable: q2sigma
1091
1092 Type: REAL
1093 Default: 0.1
1094 Description: ecfixed, qcutz, q2sigma: parameters for modified functional to be
1095 used in variable-cell molecular dynamics (or in stress calculation).
1096 "ecfixed" is the value (in Rydberg) of the constant-cutoff;
1097 "qcutz" and "q2sigma" are the height and the width (in Rydberg)
1098 of the energy step for reciprocal vectors whose square modulus
1099 is greater than "ecfixed". In the kinetic energy, G^2 is
1100 replaced by G^2 + qcutz * (1 + erf ( (G^2 - ecfixed)/q2sigma) )
1101 See: M. Bernasconi et al, J. Phys. Chem. Solids 56, 501 (1995),
1102 doi:10.1016/0022-3697(94)00228-2
1103 +--------------------------------------------------------------------
1104
1105 +--------------------------------------------------------------------
1106 Variable: input_dft
1107
1108 Type: CHARACTER
1109 Default: read from pseudopotential files
1110 Description: Exchange-correlation functional: eg 'PBE', 'BLYP' etc
1111 See Modules/funct.f90 for allowed values.
1112 Overrides the value read from pseudopotential files.
1113 Use with care and if you know what you are doing!
1114 +--------------------------------------------------------------------
1115
1116 +--------------------------------------------------------------------
1117 Variable: ace
1118
1119 Type: LOGICAL
1120 Default: true
1121 Description: Use Adaptively Compressed Exchange operator as in
1122 Lin Lin, J. Chem. Theory Comput. 2016, 12, 2242--2249, doi:10.1021/acs.jctc.6b00092
1123
1124 Set to false to use standard Exchange (much slower)
1125 +--------------------------------------------------------------------
1126
1127 +--------------------------------------------------------------------
1128 Variable: exx_fraction
1129
1130 Type: REAL
1131 Default: it depends on the specified functional
1132 Description: Fraction of EXX for hybrid functional calculations. In the case of
1133 "input_dft"='PBE0', the default value is 0.25, while for "input_dft"='B3LYP'
1134 the "exx_fraction" default value is 0.20.
1135 +--------------------------------------------------------------------
1136
1137 +--------------------------------------------------------------------
1138 Variable: screening_parameter
1139
1140 Type: REAL
1141 Default: 0.106
1142 Description: screening_parameter for HSE like hybrid functionals.
1143 For more information, see:
1144 J. Chem. Phys. 118, 8207 (2003), doi:10.1063/1.1564060
1145 J. Chem. Phys. 124, 219906 (2006), doi:10.1063/1.2204597
1146 +--------------------------------------------------------------------
1147
1148 +--------------------------------------------------------------------
1149 Variable: exxdiv_treatment
1150
1151 Type: CHARACTER
1152 Default: 'gygi-baldereschi'
1153 Description:
1154 Specific for EXX. It selects the kind of approach to be used
1155 for treating the Coulomb potential divergencies at small q vectors.
1156
1157 'gygi-baldereschi' :
1158 appropriate for cubic and quasi-cubic supercells
1159
1160 'vcut_spherical' :
1161 appropriate for cubic and quasi-cubic supercells
1162
1163 'vcut_ws' :
1164 appropriate for strongly anisotropic supercells, see also "ecutvcut".
1165
1166 'none' :
1167 sets Coulomb potential at G,q=0 to 0.0 (required for GAU-PBE)
1168 +--------------------------------------------------------------------
1169
1170 +--------------------------------------------------------------------
1171 Variable: x_gamma_extrapolation
1172
1173 Type: LOGICAL
1174 Default: .true.
1175 Description: Specific for EXX. If .true., extrapolate the G=0 term of the
1176 potential (see README in examples/EXX_example for more)
1177 Set this to .false. for GAU-PBE.
1178 +--------------------------------------------------------------------
1179
1180 +--------------------------------------------------------------------
1181 Variable: ecutvcut
1182
1183 Type: REAL
1184 Default: 0.0 Ry
1185 See: exxdiv_treatment
1186 Description: Reciprocal space cutoff for correcting Coulomb potential
1187 divergencies at small q vectors.
1188 +--------------------------------------------------------------------
1189
1190 +--------------------------------------------------------------------
1191 Variables: nqx1, nqx2, nqx3
1192
1193 Type: INTEGER
1194 Description: Three-dimensional mesh for q (k1-k2) sampling of
1195 the Fock operator (EXX). Can be smaller than
1196 the number of k-points.
1197
1198 Currently this defaults to the size of the k-point mesh used.
1199 In QE =&lt; 5.0.2 it defaulted to nqx1=nqx2=nqx3=1.
1200 +--------------------------------------------------------------------
1201
1202 +--------------------------------------------------------------------
1203 Variable: localization_thr
1204
1205 Type: REAL
1206 Default: 0.0
1207 Description: Overlap threshold over which the exchange integral over a pair of localized orbitals
1208 is included in the evaluation of EXX operator. Any value greater than 0.0 triggers
1209 the SCDM localization and the evaluation on EXX using the localized orbitals.
1210 Very small value of the threshold should yield the same result as the default EXX
1211 evaluation
1212 +--------------------------------------------------------------------
1213
1214 +--------------------------------------------------------------------
1215 Variable: lda_plus_u
1216
1217 Type: LOGICAL
1218 Default: .FALSE.
1219 Status: DFT+U (formerly known as LDA+U) currently works only for
1220 a few selected elements. Modify Modules/set_hubbard_l.f90 and
1221 PW/src/tabd.f90 if you plan to use DFT+U with an element that
1222 is not configured there.
1223 Description: Specify "lda_plus_u" = .TRUE. to enable DFT+U, DFT+U+V, or DFT+U+J calculations.
1224 See: Anisimov, Zaanen, and Andersen, PRB 44, 943 (1991);
1225 Anisimov et al., PRB 48, 16929 (1993);
1226 Liechtenstein, Anisimov, and Zaanen, PRB 52, R5467 (1994).
1227 You must specify, for each Hubbard atom, the value of
1228 U and (optionally) V, J, alpha of the Hubbard model (all in eV):
1229 see "lda_plus_u_kind", "Hubbard_U", "Hubbard_V",
1230 "Hubbard_J", "Hubbard_alpha"
1231 +--------------------------------------------------------------------
1232
1233 +--------------------------------------------------------------------
1234 Variable: lda_plus_u_kind
1235
1236 Type: INTEGER
1237 Default: 0
1238 Description:
1239 Specifies the type of calculation:
1240
1241 lda_plus_u_kind = 0 :
1242 DFT+U simplified version of Cococcioni and de Gironcoli,
1243 PRB 71, 035105 (2005), using "Hubbard_U"
1244
1245 lda_plus_u_kind = 1 :
1246 DFT+U rotationally invariant scheme of Liechtenstein et al.,
1247 using "Hubbard_U" and "Hubbard_J"
1248
1249 lda_plus_u_kind = 2 :
1250 DFT+U+V simplified version of Campo Jr and Cococcioni,
1251 J. Phys.: Condens. Matter 22, 055602 (2010), doi:10.1088/0953-8984/22/5/055602,
1252 using "Hubbard_V"
1253 +--------------------------------------------------------------------
1254
1255 +--------------------------------------------------------------------
1256 Variable: Hubbard_U(i), i=1,ntyp
1257
1258 Type: REAL
1259 Default: 0.D0 for all species
1260 Description: Hubbard_U(i): U parameter (eV) for species i, DFT+U calculation
1261 +--------------------------------------------------------------------
1262
1263 +--------------------------------------------------------------------
1264 Variable: Hubbard_J0(i), i=1,ntype
1265
1266 Type: REAL
1267 Default: 0.D0 for all species
1268 Description: Hubbard_J0(i): J0 parameter (eV) for species i, DFT+U+J calculation,
1269 see PRB 84, 115108 (2011) for details.
1270 +--------------------------------------------------------------------
1271
1272 +--------------------------------------------------------------------
1273 Variable: Hubbard_V(na,nb,k), (na,nb,k)=(1,1,1) ... (natx,27*natx,4)
1274
1275 Type: REAL
1276 Default: 0.D0 for all elements
1277 Description: Hubbard_V(na,nb,k): V parameters (eV) between atoms na and nb,
1278 used in DFT+U+V calculations (only for "lda_plus_u_kind"=2).
1279 The atomic indices na and nb correspond to the atomic positions
1280 in the "ATOMIC_POSITIONS" card (this is not the same as Hubbard_U
1281 which is specified for "ATOMIC_SPECIES").
1282
1283 When na=nb, then "Hubbard_V"(na,na,k) is the on-site "Hubbard_U"
1284 for the atom na.
1285
1286 natx=50 (if needed it can be changed in /Modules/parameters.f90)
1287
1288 The index k controls the "interaction type" (k=1 is used for the
1289 simplest DFT+U+V calculation):
1290 k=1 - interaction between standard orbitals (both on na and nb);
1291 k=2 - interaction between standard (on na) and background (on nb) orbitals;
1292 k=3 - interaction between background orbitals (both on na and nb);
1293 k=4 - interaction between background (on na) and standard (on nb) orbitals.
1294
1295 Standard orbitals correspond to the main Hubbard channel (e.g. d electrons
1296 in transition metals) and background orbitals correspond to the secondary
1297 Hubbard channel (e.g. p electrons in transition metals).
1298 +--------------------------------------------------------------------
1299
1300 +--------------------------------------------------------------------
1301 Variable: Hubbard_alpha(i), i=1,ntyp
1302
1303 Type: REAL
1304 Default: 0.D0 for all species
1305 Description: Hubbard_alpha(i) is the perturbation (on atom i, in eV)
1306 used to compute U (and V) with the linear-response method of
1307 Cococcioni and de Gironcoli, PRB 71, 035105 (2005)
1308 (only for "lda_plus_u_kind"=0 and 2).
1309
1310 Note: Hubbard U and V can be computed using the HP code
1311 which is based on density-functional perturbation theory,
1312 and it gives exactly the same result as the method of
1313 Cococcioni and de Gironcoli.
1314 +--------------------------------------------------------------------
1315
1316 +--------------------------------------------------------------------
1317 Variable: Hubbard_beta(i), i=1,ntyp
1318
1319 Type: REAL
1320 Default: 0.D0 for all species
1321 Description: Hubbard_beta(i) is the perturbation (on atom i, in eV)
1322 used to compute J0 with the linear-response method of
1323 Cococcioni and de Gironcoli, PRB 71, 035105 (2005)
1324 (only for "lda_plus_u_kind"=0 and 2). See also
1325 PRB 84, 115108 (2011).
1326 +--------------------------------------------------------------------
1327
1328 +--------------------------------------------------------------------
1329 Variable: Hubbard_J(i,ityp), (i,ityp)=(1,1) ... (3,ntyp)
1330
1331 Type: REAL
1332 Default: 0.D0 for all species
1333 Description: Hubbard_J(i,ityp): J parameters (eV) for species ityp,
1334 used in DFT+U calculations (only for "lda_plus_u_kind"=1)
1335
1336 For p orbitals: J = Hubbard_J(1,ityp);
1337 For d orbitals: J = Hubbard_J(1,ityp), B = Hubbard_J(2,ityp);
1338 For f orbitals: J = Hubbard_J(1,ityp), E2 = Hubbard_J(2,ityp),
1339 E3= Hubbard_J(3,ityp).
1340
1341 If B or E2 or E3 are not specified or set to 0 they will be
1342 calculated from J using atomic ratios.
1343 +--------------------------------------------------------------------
1344
1345 +--------------------------------------------------------------------
1346 Variable: starting_ns_eigenvalue(m,ispin,ityp), (m,ispin,ityp)=(1,1,1) ... (2*lmax+1,nspin or npol,ntyp)
1347
1348 Type: REAL
1349 Default: -1.d0 that means NOT SET
1350 Description: In the first iteration of an DFT+U run it overwrites
1351 the m-th eigenvalue of the ns occupation matrix for the
1352 ispin component of atomic species ityp.
1353 For the noncollinear case, the ispin index runs up to npol=2
1354 The value lmax is given by the maximum angular momentum
1355 number to which the Hubbard U is applied.
1356 Leave unchanged eigenvalues that are not set.
1357 This is useful to suggest the desired orbital occupations
1358 when the default choice takes another path.
1359 +--------------------------------------------------------------------
1360
1361 +--------------------------------------------------------------------
1362 Variable: U_projection_type
1363
1364 Type: CHARACTER
1365 Default: 'atomic'
1366 Description:
1367 Only active when "lda_plus_U" is .true., specifies the type
1368 of projector on localized orbital to be used in the DFT+U
1369 scheme.
1370
1371 Currently available choices:
1372
1373 'atomic' :
1374 use atomic wfc's (as they are) to build the projector
1375
1376 'ortho-atomic' :
1377 use Lowdin orthogonalized atomic wfc's
1378
1379 'norm-atomic' :
1380 Lowdin normalization of atomic wfc. Keep in mind:
1381 atomic wfc are not orthogonalized in this case.
1382 This is a "quick and dirty" trick to be used when
1383 atomic wfc from the pseudopotential are not
1384 normalized (and thus produce occupation whose
1385 value exceeds unity). If orthogonalized wfc are
1386 not needed always try 'atomic' first.
1387
1388 'file' :
1389 use the information from file "prefix".atwfc that must
1390 have been generated previously, for instance by pmw.x
1391 (see PP/src/poormanwannier.f90 for details).
1392
1393 'pseudo' :
1394 use the pseudopotential projectors. The charge density
1395 outside the atomic core radii is excluded.
1396 N.B.: for atoms with +U, a pseudopotential with the
1397 all-electron atomic wavefunctions is required (i.e.,
1398 as generated by ld1.x with lsave_wfc flag).
1399
1400 NB: forces and stress currently implemented only for the
1401 'atomic' and 'pseudo' choice.
1402 +--------------------------------------------------------------------
1403
1404 +--------------------------------------------------------------------
1405 Variable: Hubbard_parameters
1406
1407 Type: CHARACTER
1408 Default: 'input'
1409 Description:
1410 Available choices:
1411
1412 'input' :
1413 read the "Hubbard_U" (or "Hubbard_V") parameters from
1414 the PW input file
1415
1416 'file' :
1417 read the "Hubbard_V" parameters from the file "parameters.in"
1418 which can be generated after the linear-response calculation
1419 (using the HP code). This option has a higher priority over
1420 the "Hubbard_V" if they are specified in the input. This option
1421 can be used only when "lda_plus_u_kind" = 2.
1422 +--------------------------------------------------------------------
1423
1424 +--------------------------------------------------------------------
1425 Variable: ensemble_energies
1426
1427 Type: LOGICAL
1428 Default: .false.
1429 Description: If "ensemble_energies" = .true., an ensemble of xc energies
1430 is calculated non-selfconsistently for perturbed
1431 exchange-enhancement factors and LDA vs. PBE correlation
1432 ratios after each converged electronic ground state
1433 calculation.
1434
1435 Ensemble energies can be analyzed with the 'bee' utility
1436 included with libbeef.
1437
1438 Requires linking against libbeef.
1439 "input_dft" must be set to a BEEF-type functional
1440 (e.g. input_dft = 'BEEF-vdW')
1441 +--------------------------------------------------------------------
1442
1443 +--------------------------------------------------------------------
1444 Variable: edir
1445
1446 Type: INTEGER
1447 Description: The direction of the electric field or dipole correction is
1448 parallel to the bg(:,edir) reciprocal lattice vector, so the
1449 potential is constant in planes defined by FFT grid points;
1450 "edir" = 1, 2 or 3. Used only if "tefield" is .TRUE.
1451 +--------------------------------------------------------------------
1452
1453 +--------------------------------------------------------------------
1454 Variable: emaxpos
1455
1456 Type: REAL
1457 Default: 0.5D0
1458 Description: Position of the maximum of the saw-like potential along crystal
1459 axis "edir", within the unit cell (see below), 0 &lt; emaxpos &lt; 1
1460 Used only if "tefield" is .TRUE.
1461 +--------------------------------------------------------------------
1462
1463 +--------------------------------------------------------------------
1464 Variable: eopreg
1465
1466 Type: REAL
1467 Default: 0.1D0
1468 Description: Zone in the unit cell where the saw-like potential decreases.
1469 ( see below, 0 &lt; eopreg &lt; 1 ). Used only if "tefield" is .TRUE.
1470 +--------------------------------------------------------------------
1471
1472 +--------------------------------------------------------------------
1473 Variable: eamp
1474
1475 Type: REAL
1476 Default: 0.001 a.u.
1477 Description: Amplitude of the electric field, in ***Hartree*** a.u.;
1478 1 a.u. = 51.4220632*10^10 V/m. Used only if "tefield"==.TRUE.
1479 The saw-like potential increases with slope "eamp" in the
1480 region from ("emaxpos"+"eopreg"-1) to ("emaxpos"), then decreases
1481 to 0 until ("emaxpos"+"eopreg"), in units of the crystal
1482 vector "edir". Important: the change of slope of this
1483 potential must be located in the empty region, or else
1484 unphysical forces will result.
1485 +--------------------------------------------------------------------
1486
1487 +--------------------------------------------------------------------
1488 Variable: angle1(i), i=1,ntyp
1489
1490 Type: REAL
1491 Description: The angle expressed in degrees between the initial
1492 magnetization and the z-axis. For noncollinear calculations
1493 only; index i runs over the atom types.
1494 +--------------------------------------------------------------------
1495
1496 +--------------------------------------------------------------------
1497 Variable: angle2(i), i=1,ntyp
1498
1499 Type: REAL
1500 Description: The angle expressed in degrees between the projection
1501 of the initial magnetization on x-y plane and the x-axis.
1502 For noncollinear calculations only.
1503 +--------------------------------------------------------------------
1504
1505 +--------------------------------------------------------------------
1506 Variable: lforcet
1507
1508 Type: LOGICAL
1509 Description: When starting a non collinear calculation using an existing density
1510 file from a collinear lsda calculation assumes previous density points in
1511 z direction and rotates it in the direction described by "angle1" and
1512 "angle2" variables for atomic type 1
1513 +--------------------------------------------------------------------
1514
1515 +--------------------------------------------------------------------
1516 Variable: constrained_magnetization
1517
1518 Type: CHARACTER
1519 See: lambda, fixed_magnetization
1520 Default: 'none'
1521 Description:
1522 Used to perform constrained calculations in magnetic systems.
1523 Currently available choices:
1524
1525 'none' :
1526 no constraint
1527
1528 'total' :
1529 total magnetization is constrained by
1530 adding a penalty functional to the total energy:
1531
1532 LAMBDA * SUM_{i} ( magnetization(i) - fixed_magnetization(i) )**2
1533
1534 where the sum over i runs over the three components of
1535 the magnetization. Lambda is a real number (see below).
1536 Noncolinear case only. Use "tot_magnetization" for LSDA
1537
1538 'atomic' :
1539 atomic magnetization are constrained to the defined
1540 starting magnetization adding a penalty:
1541
1542 LAMBDA * SUM_{i,itype} ( magnetic_moment(i,itype) - mcons(i,itype) )**2
1543
1544 where i runs over the cartesian components (or just z
1545 in the collinear case) and itype over the types (1-ntype).
1546 mcons(:,:) array is defined from starting_magnetization,
1547 (also from angle1, angle2 in the noncollinear case).
1548 lambda is a real number
1549
1550 'total direction' :
1551 the angle theta of the total magnetization
1552 with the z axis (theta = fixed_magnetization(3))
1553 is constrained:
1554
1555 LAMBDA * ( arccos(magnetization(3)/mag_tot) - theta )**2
1556
1557 where mag_tot is the modulus of the total magnetization.
1558
1559 'atomic direction' :
1560 not all the components of the atomic
1561 magnetic moment are constrained but only the cosine
1562 of angle1, and the penalty functional is:
1563
1564 LAMBDA * SUM_{itype} ( mag_mom(3,itype)/mag_mom_tot - cos(angle1(ityp)) )**2
1565
1566 N.B.: symmetrization may prevent to reach the desired orientation
1567 of the magnetization. Try not to start with very highly symmetric
1568 configurations or use the nosym flag (only as a last remedy)
1569 +--------------------------------------------------------------------
1570
1571 +--------------------------------------------------------------------
1572 Variable: fixed_magnetization(i), i=1,3
1573
1574 Type: REAL
1575 See: constrained_magnetization
1576 Default: 0.d0
1577 Description: total magnetization vector (x,y,z components) to be kept
1578 fixed when "constrained_magnetization"=='total'
1579 +--------------------------------------------------------------------
1580
1581 +--------------------------------------------------------------------
1582 Variable: lambda
1583
1584 Type: REAL
1585 See: constrained_magnetization
1586 Default: 1.d0
1587 Description: parameter used for constrained_magnetization calculations
1588 N.B.: if the scf calculation does not converge, try to reduce lambda
1589 to obtain convergence, then restart the run with a larger lambda
1590 +--------------------------------------------------------------------
1591
1592 +--------------------------------------------------------------------
1593 Variable: report
1594
1595 Type: INTEGER
1596 Default: -1
1597 Description: determines when atomic magnetic moments are printed on output:
1598 report = 0 never
1599 report =-1 at the beginning of the scf and at convergence
1600 report = N as -1, plus every N scf iterations
1601 +--------------------------------------------------------------------
1602
1603 +--------------------------------------------------------------------
1604 Variable: lspinorb
1605
1606 Type: LOGICAL
1607 Description: if .TRUE. the noncollinear code can use a pseudopotential with
1608 spin-orbit.
1609 +--------------------------------------------------------------------
1610
1611 +--------------------------------------------------------------------
1612 Variable: assume_isolated
1613
1614 Type: CHARACTER
1615 Default: 'none'
1616 Description:
1617 Used to perform calculation assuming the system to be
1618 isolated (a molecule or a cluster in a 3D supercell).
1619
1620 Currently available choices:
1621
1622 'none' :
1623 (default): regular periodic calculation w/o any correction.
1624
1625 'makov-payne', 'm-p', 'mp' :
1626 the Makov-Payne correction to the
1627 total energy is computed. An estimate of the vacuum
1628 level is also calculated so that eigenvalues can be
1629 properly aligned. ONLY FOR CUBIC SYSTEMS ("ibrav"=1,2,3).
1630 Theory: G.Makov, and M.C.Payne,
1631 "Periodic boundary conditions in ab initio
1632 calculations" , PRB 51, 4014 (1995).
1633
1634 'martyna-tuckerman', 'm-t', 'mt' :
1635 Martyna-Tuckerman correction
1636 to both total energy and scf potential. Adapted from:
1637 G.J. Martyna, and M.E. Tuckerman,
1638 "A reciprocal space based method for treating long
1639 range interactions in ab-initio and force-field-based
1640 calculation in clusters", J. Chem. Phys. 110, 2810 (1999),
1641 doi:10.1063/1.477923.
1642
1643 'esm' :
1644 Effective Screening Medium Method.
1645 For polarized or charged slab calculation, embeds
1646 the simulation cell within an effective semi-
1647 infinite medium in the perpendicular direction
1648 (along z). Embedding regions can be vacuum or
1649 semi-infinite metal electrodes (use "esm_bc" to
1650 choose boundary conditions). If between two
1651 electrodes, an optional electric field
1652 ('esm_efield') may be applied. Method described in
1653 M. Otani and O. Sugino, "First-principles calculations
1654 of charged surfaces and interfaces: A plane-wave
1655 nonrepeated slab approach", PRB 73, 115407 (2006).
1656
1657 NB:
1658 - Two dimensional (xy plane) average charge density
1659 and electrostatic potentials are printed out to
1660 'prefix.esm1'.
1661
1662 - Requires cell with a_3 lattice vector along z,
1663 normal to the xy plane, with the slab centered
1664 around z=0. Also requires symmetry checking to be
1665 disabled along z, either by setting "nosym" = .TRUE.
1666 or by very slight displacement (i.e., 5e-4 a.u.)
1667 of the slab along z.
1668
1669 - Components of the total stress; sigma_xy, sigma_yz,
1670 sigma_zz, sigma_zy, and sigma_zx are meaningless
1671 because ESM stress routines calculate only
1672 components of stress; sigma_xx, sigma_xy, sigma_yx,
1673 and sigma_yy.
1674
1675 - In case of calculation='vc-relax', use
1676 cell_dofree='2Dxy' or other parameters so that
1677 c-vector along z-axis should not be moved.
1678
1679 See "esm_bc", "esm_efield", "esm_w", "esm_nfit".
1680
1681 '2D' :
1682 Truncation of the Coulomb interaction in the z direction
1683 for structures periodic in the x-y plane. Total energy,
1684 forces and stresses are computed in a two-dimensional framework.
1685 Linear-response calculations () done on top of a self-consistent
1686 calculation with this flag will automatically be performed in
1687 the 2D framework as well. Please refer to:
1688 Sohier, T., Calandra, M., & Mauri, F. (2017), Density functional
1689 perturbation theory for gated two-dimensional heterostructures:
1690 Theoretical developments and application to flexural phonons in graphene.
1691 Physical Review B, 96(7), 75448. https://doi.org/10.1103/PhysRevB.96.075448
1692
1693 NB:
1694 - The length of the unit-cell along the z direction should
1695 be larger than twice the thickness of the 2D material
1696 (including electrons). A reasonable estimate for a
1697 layer's thickness could be the interlayer distance in the
1698 corresponding layered bulk material. Otherwise,
1699 the atomic thickness + 10 bohr should be a safe estimate.
1700 There is also a lower limit of 20 bohr imposed by the cutoff
1701 radius used to read pseudopotentials (see read_pseudo.f90 in Modules).
1702
1703 - As for ESM above, only in-plane stresses make sense and one
1704 should use cell_dofree='2Dxy' in a vc-relax calculation.
1705 +--------------------------------------------------------------------
1706
1707 +--------------------------------------------------------------------
1708 Variable: esm_bc
1709
1710 Type: CHARACTER
1711 See: assume_isolated
1712 Default: 'pbc'
1713 Description:
1714 If "assume_isolated" = 'esm', determines the boundary
1715 conditions used for either side of the slab.
1716
1717 Currently available choices:
1718
1719 'pbc' :
1720 (default): regular periodic calculation (no ESM).
1721
1722 'bc1' :
1723 Vacuum-slab-vacuum (open boundary conditions).
1724
1725 'bc2' :
1726 Metal-slab-metal (dual electrode configuration).
1727 See also "esm_efield".
1728
1729 'bc3' :
1730 Vacuum-slab-metal
1731 +--------------------------------------------------------------------
1732
1733 +--------------------------------------------------------------------
1734 Variable: esm_w
1735
1736 Type: REAL
1737 See: assume_isolated
1738 Default: 0.d0
1739 Description: If "assume_isolated" = 'esm', determines the position offset
1740 [in a.u.] of the start of the effective screening region,
1741 measured relative to the cell edge. (ESM region begins at
1742 z = +/- [L_z/2 + esm_w] ).
1743 +--------------------------------------------------------------------
1744
1745 +--------------------------------------------------------------------
1746 Variable: esm_efield
1747
1748 Type: REAL
1749 See: assume_isolated
1750 Default: 0.d0
1751 Description: If "assume_isolated" = 'esm' and "esm_bc" = 'bc2', gives the
1752 magnitude of the electric field [Ry/a.u.] to be applied
1753 between semi-infinite ESM electrodes.
1754 +--------------------------------------------------------------------
1755
1756 +--------------------------------------------------------------------
1757 Variable: esm_nfit
1758
1759 Type: INTEGER
1760 See: assume_isolated
1761 Default: 4
1762 Description: If "assume_isolated" = 'esm', gives the number of z-grid points
1763 for the polynomial fit along the cell edge.
1764 +--------------------------------------------------------------------
1765
1766 +--------------------------------------------------------------------
1767 Variable: fcp_mu
1768
1769 Type: REAL
1770 See: lfcpopt
1771 Default: 0.d0
1772 Description: If "lfcpopt" = .TRUE., gives the target Fermi energy [Ry]. One can start
1773 with appropriate total charge of the system by giving 'tot_charge'.
1774 +--------------------------------------------------------------------
1775
1776 +--------------------------------------------------------------------
1777 Variable: vdw_corr
1778
1779 Type: CHARACTER
1780 Default: 'none'
1781 See: london_s6, london_rcut, london_c6, london_rvdw,
1782 dftd3_version, dftd3_threebody, ts_vdw_econv_thr, ts_vdw_isolated, xdm_a1, xdm_a2
1783 Description:
1784 Type of Van der Waals correction. Allowed values:
1785
1786 'grimme-d2', 'Grimme-D2', 'DFT-D', 'dft-d' :
1787 Semiempirical Grimme's DFT-D2. Optional variables:
1788 "london_s6", "london_rcut", "london_c6", "london_rvdw"
1789 S. Grimme, J. Comp. Chem. 27, 1787 (2006), doi:10.1002/jcc.20495
1790 V. Barone et al., J. Comp. Chem. 30, 934 (2009), doi:10.1002/jcc.21112
1791
1792 'grimme-d3', 'Grimme-D3', 'DFT-D3', 'dft-d3' :
1793 Semiempirical Grimme's DFT-D3. Optional variables:
1794 "dftd3_version", "dftd3_threebody"
1795 S. Grimme et al, J. Chem. Phys 132, 154104 (2010), doi:10.1002/jcc.20495
1796
1797 'TS', 'ts', 'ts-vdw', 'ts-vdW', 'tkatchenko-scheffler' :
1798 Tkatchenko-Scheffler dispersion corrections with first-principle derived
1799 C6 coefficients.
1800 Optional variables: "ts_vdw_econv_thr", "ts_vdw_isolated"
1801 See A. Tkatchenko and M. Scheffler, PRL 102, 073005 (2009).
1802
1803 'XDM', 'xdm' :
1804 Exchange-hole dipole-moment model. Optional variables: "xdm_a1", "xdm_a2"
1805 A. D. Becke et al., J. Chem. Phys. 127, 154108 (2007), doi:10.1063/1.2795701
1806 A. Otero de la Roza et al., J. Chem. Phys. 136, 174109 (2012),
1807 doi:10.1063/1.4705760
1808
1809 Note that non-local functionals (eg vdw-DF) are NOT specified here but in "input_dft"
1810 +--------------------------------------------------------------------
1811
1812 +--------------------------------------------------------------------
1813 Variable: london
1814
1815 Type: LOGICAL
1816 Default: .FALSE.
1817 Status: OBSOLESCENT, same as "vdw_corr"='DFT-D'
1818 +--------------------------------------------------------------------
1819
1820 +--------------------------------------------------------------------
1821 Variable: london_s6
1822
1823 Type: REAL
1824 Default: 0.75
1825 Description: global scaling parameter for DFT-D. Default is good for PBE.
1826 +--------------------------------------------------------------------
1827
1828 +--------------------------------------------------------------------
1829 Variable: london_c6(i), i=1,ntyp
1830
1831 Type: REAL
1832 Default: standard Grimme-D2 values
1833 Description: atomic C6 coefficient of each atom type
1834
1835 ( if not specified default values from S. Grimme, J. Comp. Chem. 27, 1787 (2006),
1836 doi:10.1002/jcc.20495 are used; see file Modules/mm_dispersion.f90 )
1837 +--------------------------------------------------------------------
1838
1839 +--------------------------------------------------------------------
1840 Variable: london_rvdw(i), i=1,ntyp
1841
1842 Type: REAL
1843 Default: standard Grimme-D2 values
1844 Description: atomic vdw radii of each atom type
1845
1846 ( if not specified default values from S. Grimme, J. Comp. Chem. 27, 1787 (2006),
1847 doi:10.1002/jcc.20495 are used; see file Modules/mm_dispersion.f90 )
1848 +--------------------------------------------------------------------
1849
1850 +--------------------------------------------------------------------
1851 Variable: london_rcut
1852
1853 Type: REAL
1854 Default: 200
1855 Description: cutoff radius (a.u.) for dispersion interactions
1856 +--------------------------------------------------------------------
1857
1858 +--------------------------------------------------------------------
1859 Variable: dftd3_version
1860
1861 Type: integer
1862 Default: 3
1863 Description:
1864 Version of Grimme implementation of Grimme-D3:
1865
1866 dftd3_version = 2 :
1867 Original Grimme-D2 parametrization
1868
1869 dftd3_version = 3 :
1870 Grimme-D3 (zero damping)
1871
1872 dftd3_version = 4 :
1873 Grimme-D3 (BJ damping)
1874
1875 dftd3_version = 5 :
1876 Grimme-D3M (zero damping)
1877
1878 dftd3_version = 6 :
1879 Grimme-D3M (BJ damping)
1880
1881 NOTE: not all functionals are parametrized.
1882 +--------------------------------------------------------------------
1883
1884 +--------------------------------------------------------------------
1885 Variable: dftd3_threebody
1886
1887 Type: LOGICAL
1888 Default: TRUE
1889 Description: Turn three-body terms in Grimme-D3 on. If .false. two-body contributions
1890 only are computed, using two-body parameters of Grimme-D3.
1891 If dftd3_version=2, three-body contribution is always disabled.
1892 +--------------------------------------------------------------------
1893
1894 +--------------------------------------------------------------------
1895 Variable: ts_vdw_econv_thr
1896
1897 Type: REAL
1898 Default: 1.D-6
1899 Description: Optional: controls the convergence of the vdW energy (and forces). The default value
1900 is a safe choice, likely too safe, but you do not gain much in increasing it
1901 +--------------------------------------------------------------------
1902
1903 +--------------------------------------------------------------------
1904 Variable: ts_vdw_isolated
1905
1906 Type: LOGICAL
1907 Default: .FALSE.
1908 Description: Optional: set it to .TRUE. when computing the Tkatchenko-Scheffler vdW energy
1909 for an isolated (non-periodic) system.
1910 +--------------------------------------------------------------------
1911
1912 +--------------------------------------------------------------------
1913 Variable: xdm
1914
1915 Type: LOGICAL
1916 Default: .FALSE.
1917 Status: OBSOLESCENT, same as "vdw_corr"='xdm'
1918 +--------------------------------------------------------------------
1919
1920 +--------------------------------------------------------------------
1921 Variable: xdm_a1
1922
1923 Type: REAL
1924 Default: 0.6836
1925 Description: Damping function parameter a1 (adimensional). It is NOT necessary to give
1926 a value if the functional is one of B86bPBE, PW86PBE, PBE, BLYP. For functionals
1927 in this list, the coefficients are given in:
1928 http://schooner.chem.dal.ca/wiki/XDM
1929 A. Otero de la Roza, E. R. Johnson, J. Chem. Phys. 138, 204109 (2013),
1930 doi:10.1063/1.4705760
1931 +--------------------------------------------------------------------
1932
1933 +--------------------------------------------------------------------
1934 Variable: xdm_a2
1935
1936 Type: REAL
1937 Default: 1.5045
1938 Description: Damping function parameter a2 (angstrom). It is NOT necessary to give
1939 a value if the functional is one of B86bPBE, PW86PBE, PBE, BLYP. For functionals
1940 in this list, the coefficients are given in:
1941 http://schooner.chem.dal.ca/wiki/XDM
1942 A. Otero de la Roza, E. R. Johnson, J. Chem. Phys. 138, 204109 (2013),
1943 doi:10.1063/1.4705760
1944 +--------------------------------------------------------------------
1945
1946 +--------------------------------------------------------------------
1947 Variable: space_group
1948
1949 Type: INTEGER
1950 Default: 0
1951 Description: The number of the space group of the crystal, as given
1952 in the International Tables of Crystallography A (ITA).
1953 This allows to give in input only the inequivalent atomic
1954 positions. The positions of all the symmetry equivalent atoms
1955 are calculated by the code. Used only when the atomic positions
1956 are of type crystal_sg. See also "uniqueb",
1957 "origin_choice", "rhombohedral"
1958 +--------------------------------------------------------------------
1959
1960 +--------------------------------------------------------------------
1961 Variable: uniqueb
1962
1963 Type: LOGICAL
1964 Default: .FALSE.
1965 Description: Used only for monoclinic lattices. If .TRUE. the b
1966 unique "ibrav" (-12 or -13) are used, and symmetry
1967 equivalent positions are chosen assuming that the
1968 twofold axis or the mirror normal is parallel to the
1969 b axis. If .FALSE. it is parallel to the c axis.
1970 +--------------------------------------------------------------------
1971
1972 +--------------------------------------------------------------------
1973 Variable: origin_choice
1974
1975 Type: INTEGER
1976 Default: 1
1977 Description: Used only for space groups that in the ITA allow
1978 the use of two different origins. "origin_choice"=1,
1979 means the first origin, while "origin_choice"=2 is the
1980 second origin.
1981 +--------------------------------------------------------------------
1982
1983 +--------------------------------------------------------------------
1984 Variable: rhombohedral
1985
1986 Type: LOGICAL
1987 Default: .TRUE.
1988 Description: Used only for rhombohedral space groups.
1989 When .TRUE. the coordinates of the inequivalent atoms are
1990 given with respect to the rhombohedral axes, when .FALSE.
1991 the coordinates of the inequivalent atoms are given with
1992 respect to the hexagonal axes. They are converted internally
1993 to the rhombohedral axes and "ibrav"=5 is used in both cases.
1994 +--------------------------------------------------------------------
1995
1996 ///---
1997 VARIABLES USED ONLY IF "GATE" = .TRUE.
1998
1999 +--------------------------------------------------------------------
2000 Variable: zgate
2001
2002 Type: REAL
2003 Default: 0.5
2004 Description: used only if "gate" = .TRUE.
2005 Specifies the position of the charged plate which represents
2006 the counter charge in doped systems ("tot_charge" .ne. 0).
2007 In units of the unit cell length in z direction, "zgate" in ]0,1[
2008 Details of the gate potential can be found in
2009 T. Brumme, M. Calandra, F. Mauri; PRB 89, 245406 (2014).
2010 +--------------------------------------------------------------------
2011
2012 +--------------------------------------------------------------------
2013 Variable: relaxz
2014
2015 Type: LOGICAL
2016 Default: .FALSE.
2017 Description: used only if "gate" = .TRUE.
2018 Allows the relaxation of the system towards the charged plate.
2019 Use carefully and utilize either a layer of fixed atoms or a
2020 potential barrier ("block"=.TRUE.) to avoid the atoms moving to
2021 the position of the plate or the dipole of the dipole
2022 correction ("dipfield"=.TRUE.).
2023 +--------------------------------------------------------------------
2024
2025 +--------------------------------------------------------------------
2026 Variable: block
2027
2028 Type: LOGICAL
2029 Default: .FALSE.
2030 Description: used only if "gate" = .TRUE.
2031 Adds a potential barrier to the total potential seen by the
2032 electrons to mimic a dielectric in field effect configuration
2033 and/or to avoid electrons spilling into the vacuum region for
2034 electron doping. Potential barrier is from "block_1" to "block_2" and
2035 has a height of block_height.
2036 If "dipfield" = .TRUE. then "eopreg" is used for a smooth increase and
2037 decrease of the potential barrier.
2038 +--------------------------------------------------------------------
2039
2040 +--------------------------------------------------------------------
2041 Variable: block_1
2042
2043 Type: REAL
2044 Default: 0.45
2045 Description: used only if "gate" = .TRUE. and "block" = .TRUE.
2046 lower beginning of the potential barrier, in units of the
2047 unit cell size along z, "block_1" in ]0,1[
2048 +--------------------------------------------------------------------
2049
2050 +--------------------------------------------------------------------
2051 Variable: block_2
2052
2053 Type: REAL
2054 Default: 0.55
2055 Description: used only if "gate" = .TRUE. and "block" = .TRUE.
2056 upper beginning of the potential barrier, in units of the
2057 unit cell size along z, "block_2" in ]0,1[
2058 +--------------------------------------------------------------------
2059
2060 +--------------------------------------------------------------------
2061 Variable: block_height
2062
2063 Type: REAL
2064 Default: 0.1
2065 Description: used only if "gate" = .TRUE. and "block" = .TRUE.
2066 Height of the potential barrier in Rydberg.
2067 +--------------------------------------------------------------------
2068
2069 \\\---
2070
2071 ===END OF NAMELIST======================================================
2072
2073
2074 ========================================================================
2075 NAMELIST: &ELECTRONS
2076
2077 +--------------------------------------------------------------------
2078 Variable: electron_maxstep
2079
2080 Type: INTEGER
2081 Default: 100
2082 Description: maximum number of iterations in a scf step
2083 +--------------------------------------------------------------------
2084
2085 +--------------------------------------------------------------------
2086 Variable: scf_must_converge
2087
2088 Type: LOGICAL
2089 Default: .TRUE.
2090 Description: If .false. do not stop molecular dynamics or ionic relaxation
2091 when electron_maxstep is reached. Use with care.
2092 +--------------------------------------------------------------------
2093
2094 +--------------------------------------------------------------------
2095 Variable: conv_thr
2096
2097 Type: REAL
2098 Default: 1.D-6
2099 Description: Convergence threshold for selfconsistency:
2100 estimated energy error &lt; conv_thr
2101 (note that conv_thr is extensive, like the total energy).
2102
2103 For non-self-consistent calculations, conv_thr is used
2104 to set the default value of the threshold (ethr) for
2105 iterative diagonalizazion: see "diago_thr_init"
2106 +--------------------------------------------------------------------
2107
2108 +--------------------------------------------------------------------
2109 Variable: adaptive_thr
2110
2111 Type: LOGICAL
2112 Default: .FALSE
2113 Description: If .TRUE. this turns on the use of an adaptive "conv_thr" for
2114 the inner scf loops when using EXX.
2115 +--------------------------------------------------------------------
2116
2117 +--------------------------------------------------------------------
2118 Variable: conv_thr_init
2119
2120 Type: REAL
2121 Default: 1.D-3
2122 Description: When "adaptive_thr" = .TRUE. this is the convergence threshold
2123 used for the first scf cycle.
2124 +--------------------------------------------------------------------
2125
2126 +--------------------------------------------------------------------
2127 Variable: conv_thr_multi
2128
2129 Type: REAL
2130 Default: 1.D-1
2131 Description: When "adaptive_thr" = .TRUE. the convergence threshold for
2132 each scf cycle is given by:
2133 max( "conv_thr", "conv_thr_multi" * dexx )
2134 +--------------------------------------------------------------------
2135
2136 +--------------------------------------------------------------------
2137 Variable: mixing_mode
2138
2139 Type: CHARACTER
2140 Default: 'plain'
2141 Description:
2142 Available options are:
2143
2144 'plain' :
2145 charge density Broyden mixing
2146
2147 'TF' :
2148 as above, with simple Thomas-Fermi screening
2149 (for highly homogeneous systems)
2150
2151 'local-TF' :
2152 as above, with local-density-dependent TF screening
2153 (for highly inhomogeneous systems)
2154 +--------------------------------------------------------------------
2155
2156 +--------------------------------------------------------------------
2157 Variable: mixing_beta
2158
2159 Type: REAL
2160 Default: 0.7D0
2161 Description: mixing factor for self-consistency
2162 +--------------------------------------------------------------------
2163
2164 +--------------------------------------------------------------------
2165 Variable: mixing_ndim
2166
2167 Type: INTEGER
2168 Default: 8
2169 Description: number of iterations used in mixing scheme.
2170 If you are tight with memory, you may reduce it to 4 or so.
2171 +--------------------------------------------------------------------
2172
2173 +--------------------------------------------------------------------
2174 Variable: mixing_fixed_ns
2175
2176 Type: INTEGER
2177 Default: 0
2178 Description: For DFT+U : number of iterations with fixed ns ( ns is the
2179 atomic density appearing in the Hubbard term ).
2180 +--------------------------------------------------------------------
2181
2182 +--------------------------------------------------------------------
2183 Variable: diagonalization
2184
2185 Type: CHARACTER
2186 Default: 'david'
2187 Description:
2188 Available options are:
2189
2190 'david' :
2191 Davidson iterative diagonalization with overlap matrix
2192 (default). Fast, may in some rare cases fail.
2193
2194 'cg' :
2195 Conjugate-gradient-like band-by-band diagonalization.
2196 MUCH slower than 'david' but uses less memory and is
2197 (a little bit) more robust.
2198
2199 'ppcg' :
2200 PPCG iterative diagonalization
2201
2202 'paro', 'ParO' :
2203 ParO iterative diagonalization
2204 +--------------------------------------------------------------------
2205
2206 +--------------------------------------------------------------------
2207 Variable: diago_thr_init
2208
2209 Type: REAL
2210 Description: Convergence threshold (ethr) for iterative diagonalization
2211 (the check is on eigenvalue convergence).
2212
2213 For scf calculations: default is 1.D-2 if starting from a
2214 superposition of atomic orbitals; 1.D-5 if starting from a
2215 charge density. During self consistency the threshold
2216 is automatically reduced (but never below 1.D-13) when
2217 approaching convergence.
2218
2219 For non-scf calculations: default is ("conv_thr"/N elec)/10.
2220 +--------------------------------------------------------------------
2221
2222 +--------------------------------------------------------------------
2223 Variable: diago_cg_maxiter
2224
2225 Type: INTEGER
2226 Description: For conjugate gradient diagonalization: max number of iterations
2227 +--------------------------------------------------------------------
2228
2229 +--------------------------------------------------------------------
2230 Variable: diago_david_ndim
2231
2232 Type: INTEGER
2233 Default: 2
2234 Description: For Davidson diagonalization: dimension of workspace
2235 (number of wavefunction packets, at least 2 needed).
2236 A larger value may yield a smaller number of iterations in
2237 the algorithm but uses more memory and more CPU time in
2238 subspace diagonalization (cdiaghg/rdiaghg). You may try
2239 "diago_david_ndim"=4 if you are not tight on memory
2240 and if the time spent in subspace diagonalization is small
2241 compared to the time spent in h_psi
2242 +--------------------------------------------------------------------
2243
2244 +--------------------------------------------------------------------
2245 Variable: diago_full_acc
2246
2247 Type: LOGICAL
2248 Default: .FALSE.
2249 Description: If .TRUE. all the empty states are diagonalized at the same level
2250 of accuracy of the occupied ones. Otherwise the empty states are
2251 diagonalized using a larger threshold (this should not affect
2252 total energy, forces, and other ground-state properties).
2253 +--------------------------------------------------------------------
2254
2255 +--------------------------------------------------------------------
2256 Variable: efield
2257
2258 Type: REAL
2259 Default: 0.D0
2260 Description: Amplitude of the finite electric field (in Ry a.u.;
2261 1 a.u. = 36.3609*10^10 V/m). Used only if "lelfield"==.TRUE.
2262 and if k-points ("K_POINTS" card) are not automatic.
2263 +--------------------------------------------------------------------
2264
2265 +--------------------------------------------------------------------
2266 Variable: efield_cart(i), i=1,3
2267
2268 Type: REAL
2269 Default: (0.D0, 0.D0, 0.D0)
2270 Description: Finite electric field (in Ry a.u.=36.3609*10^10 V/m) in
2271 cartesian axis. Used only if "lelfield"==.TRUE. and if
2272 k-points ("K_POINTS" card) are automatic.
2273 +--------------------------------------------------------------------
2274
2275 +--------------------------------------------------------------------
2276 Variable: efield_phase
2277
2278 Type: CHARACTER
2279 Default: 'none'
2280 Description:
2281 Available options are:
2282
2283 'read' :
2284 set the zero of the electronic polarization (with "lelfield"==.true..)
2285 to the result of a previous calculation
2286
2287 'write' :
2288 write on disk data on electronic polarization to be read in another
2289 calculation
2290
2291 'none' :
2292 none of the above points
2293 +--------------------------------------------------------------------
2294
2295 +--------------------------------------------------------------------
2296 Variable: startingpot
2297
2298 Type: CHARACTER
2299 Description:
2300 Available options are:
2301
2302 'atomic' :
2303 starting potential from atomic charge superposition
2304 (default for scf, *relax, *md)
2305
2306 'file' :
2307 start from existing "charge-density.xml" file in the
2308 directory specified by variables "prefix" and "outdir"
2309 For nscf and bands calculation this is the default
2310 and the only sensible possibility.
2311 +--------------------------------------------------------------------
2312
2313 +--------------------------------------------------------------------
2314 Variable: startingwfc
2315
2316 Type: CHARACTER
2317 Default: 'atomic+random'
2318 Description:
2319 Available options are:
2320
2321 'atomic' :
2322 Start from superposition of atomic orbitals.
2323 If not enough atomic orbitals are available,
2324 fill with random numbers the remaining wfcs
2325 The scf typically starts better with this option,
2326 but in some high-symmetry cases one can "loose"
2327 valence states, ending up in the wrong ground state.
2328
2329 'atomic+random' :
2330 As above, plus a superimposed "randomization"
2331 of atomic orbitals. Prevents the "loss" of states
2332 mentioned above.
2333
2334 'random' :
2335 Start from random wfcs. Slower start of scf but safe.
2336 It may also reduce memory usage in conjunction with
2337 "diagonalization"='cg'.
2338
2339 'file' :
2340 Start from an existing wavefunction file in the
2341 directory specified by variables "prefix" and "outdir".
2342 +--------------------------------------------------------------------
2343
2344 +--------------------------------------------------------------------
2345 Variable: tqr
2346
2347 Type: LOGICAL
2348 Default: .FALSE.
2349 Description: If .true., use a real-space algorithm for augmentation
2350 charges of ultrasoft pseudopotentials and PAWsets.
2351 Faster but numerically less accurate than the default
2352 G-space algorithm. Use with care and after testing!
2353 +--------------------------------------------------------------------
2354
2355 +--------------------------------------------------------------------
2356 Variable: real_space
2357
2358 Type: LOGICAL
2359 Default: .FALSE.
2360 Description: If .true., exploit real-space localization to compute
2361 matrix elements for nonlocal projectors. Faster and in
2362 principle better scaling than the default G-space algorithm,
2363 but numerically less accurate, may lead to some loss of
2364 translational invariance. Use with care and after testing!
2365 +--------------------------------------------------------------------
2366
2367 ===END OF NAMELIST======================================================
2368
2369
2370 ========================================================================
2371 NAMELIST: &IONS
2372
2373 REQUIRED IF "CALCULATION" == 'RELAX', 'MD', 'VC-RELAX', OR 'VC-MD'
2374 OPTIONAL FOR "CALCULATION" == 'SCF' (ONLY "ION_POSITIONS" IS USED)
2375
2376 +--------------------------------------------------------------------
2377 Variable: ion_positions
2378
2379 Type: CHARACTER
2380 Default: 'default'
2381 Description:
2382 Available options are:
2383
2384 'default' :
2385 if restarting, use atomic positions read from the
2386 restart file; in all other cases, use atomic
2387 positions from standard input.
2388
2389 'from_input' :
2390 read atomic positions from standard input, even if restarting.
2391 +--------------------------------------------------------------------
2392
2393 +--------------------------------------------------------------------
2394 Variable: ion_velocities
2395
2396 Type: CHARACTER
2397 Default: 'default'
2398 Description:
2399 Initial ionic velocities. Available options are:
2400
2401 'default' :
2402 start a new simulation from random thermalized
2403 distribution of velocities if "tempw" is set,
2404 with zero velocities otherwise; restart from
2405 atomic velocities read from the restart file
2406
2407 'from_input' :
2408 start or continue the simulation with atomic
2409 velocities read from standard input - see card
2410 "ATOMIC_VELOCITIES"
2411 +--------------------------------------------------------------------
2412
2413 +--------------------------------------------------------------------
2414 Variable: ion_dynamics
2415
2416 Type: CHARACTER
2417 Description:
2418 Specify the type of ionic dynamics.
2419
2420 For different type of calculation different possibilities are
2421 allowed and different default values apply:
2422
2423 CASE ( "calculation" == 'relax' )
2424
2425 'bfgs' :
2426 (default) use BFGS quasi-newton algorithm,
2427 based on the trust radius procedure,
2428 for structural relaxation
2429
2430 'damp' :
2431 use damped (quick-min Verlet)
2432 dynamics for structural relaxation
2433 Can be used for constrained
2434 optimisation: see "CONSTRAINTS" card
2435
2436 CASE ( "calculation" == 'md' )
2437
2438 'verlet' :
2439 (default) use Verlet algorithm to integrate
2440 Newton's equation. For constrained
2441 dynamics, see "CONSTRAINTS" card
2442
2443 'langevin' :
2444 ion dynamics is over-damped Langevin
2445
2446 'langevin-smc' :
2447 over-damped Langevin with Smart Monte Carlo:
2448 see R.J. Rossky, JCP, 69, 4628 (1978), doi:10.1063/1.436415
2449
2450 CASE ( "calculation" == 'vc-relax' )
2451
2452 'bfgs' :
2453 (default) use BFGS quasi-newton algorithm;
2454 cell_dynamics must be 'bfgs' too
2455
2456 'damp' :
2457 use damped (Beeman) dynamics for
2458 structural relaxation
2459
2460 CASE ( "calculation" == 'vc-md' )
2461
2462 'beeman' :
2463 (default) use Beeman algorithm to integrate
2464 Newton's equation
2465 +--------------------------------------------------------------------
2466
2467 +--------------------------------------------------------------------
2468 Variable: pot_extrapolation
2469
2470 Type: CHARACTER
2471 Default: 'atomic'
2472 Description:
2473 Used to extrapolate the potential from preceding ionic steps.
2474
2475 'none' :
2476 no extrapolation
2477
2478 'atomic' :
2479 extrapolate the potential as if it was a sum of
2480 atomic-like orbitals
2481
2482 'first_order' :
2483 extrapolate the potential with first-order
2484 formula
2485
2486 'second_order' :
2487 as above, with second order formula
2488
2489 Note: 'first_order' and 'second-order' extrapolation make sense
2490 only for molecular dynamics calculations
2491 +--------------------------------------------------------------------
2492
2493 +--------------------------------------------------------------------
2494 Variable: wfc_extrapolation
2495
2496 Type: CHARACTER
2497 Default: 'none'
2498 Description:
2499 Used to extrapolate the wavefunctions from preceding ionic steps.
2500
2501 'none' :
2502 no extrapolation
2503
2504 'first_order' :
2505 extrapolate the wave-functions with first-order formula.
2506
2507 'second_order' :
2508 as above, with second order formula.
2509
2510 Note: 'first_order' and 'second-order' extrapolation make sense
2511 only for molecular dynamics calculations
2512 +--------------------------------------------------------------------
2513
2514 +--------------------------------------------------------------------
2515 Variable: remove_rigid_rot
2516
2517 Type: LOGICAL
2518 Default: .FALSE.
2519 Description: This keyword is useful when simulating the dynamics and/or the
2520 thermodynamics of an isolated system. If set to true the total
2521 torque of the internal forces is set to zero by adding new forces
2522 that compensate the spurious interaction with the periodic
2523 images. This allows for the use of smaller supercells.
2524
2525 BEWARE: since the potential energy is no longer consistent with
2526 the forces (it still contains the spurious interaction with the
2527 repeated images), the total energy is not conserved anymore.
2528 However the dynamical and thermodynamical properties should be
2529 in closer agreement with those of an isolated system.
2530 Also the final energy of a structural relaxation will be higher,
2531 but the relaxation itself should be faster.
2532 +--------------------------------------------------------------------
2533
2534 ///---
2535 VARIABLES USED FOR MOLECULAR DYNAMICS
2536
2537 +--------------------------------------------------------------------
2538 Variable: ion_temperature
2539
2540 Type: CHARACTER
2541 Default: 'not_controlled'
2542 Description:
2543 Available options are:
2544
2545 'rescaling' :
2546 control ionic temperature via velocity rescaling
2547 (first method) see parameters "tempw", "tolp", and
2548 "nraise" (for VC-MD only). This rescaling method
2549 is the only one currently implemented in VC-MD
2550
2551 'rescale-v' :
2552 control ionic temperature via velocity rescaling
2553 (second method) see parameters "tempw" and "nraise"
2554
2555 'rescale-T' :
2556 scale temperature of the thermostat every "nraise" steps
2557 by "delta_t", starting from "tempw".
2558 The temperature is controlled via velocitiy rescaling.
2559
2560 'reduce-T' :
2561 reduce temperature of the thermostat every "nraise" steps
2562 by the (negative) value "delta_t", starting from "tempw".
2563 If "delta_t" is positive, the target temperature is augmented.
2564 The temperature is controlled via velocitiy rescaling.
2565
2566 'berendsen' :
2567 control ionic temperature using "soft" velocity
2568 rescaling - see parameters "tempw" and "nraise"
2569
2570 'andersen' :
2571 control ionic temperature using Andersen thermostat
2572 see parameters "tempw" and "nraise"
2573
2574 'svr' :
2575 control ionic temperature using stochastic-velocity rescaling
2576 (Donadio, Bussi, Parrinello, J. Chem. Phys. 126, 014101, 2007),
2577 with parameters "tempw" and "nraise".
2578
2579 'initial' :
2580 initialize ion velocities to temperature "tempw"
2581 and leave uncontrolled further on
2582
2583 'not_controlled' :
2584 (default) ionic temperature is not controlled
2585 +--------------------------------------------------------------------
2586
2587 +--------------------------------------------------------------------
2588 Variable: tempw
2589
2590 Type: REAL
2591 Default: 300.D0
2592 Description: Starting temperature (Kelvin) in MD runs
2593 target temperature for most thermostats.
2594 +--------------------------------------------------------------------
2595
2596 +--------------------------------------------------------------------
2597 Variable: tolp
2598
2599 Type: REAL
2600 Default: 100.D0
2601 Description: Tolerance for velocity rescaling. Velocities are rescaled if
2602 the run-averaged and target temperature differ more than tolp.
2603 +--------------------------------------------------------------------
2604
2605 +--------------------------------------------------------------------
2606 Variable: delta_t
2607
2608 Type: REAL
2609 Default: 1.D0
2610 Description: if "ion_temperature" == 'rescale-T' :
2611 at each step the instantaneous temperature is multiplied
2612 by delta_t; this is done rescaling all the velocities.
2613
2614 if "ion_temperature" == 'reduce-T' :
2615 every 'nraise' steps the instantaneous temperature is
2616 reduced by -"delta_t" (i.e. "delta_t" &lt; 0 is added to T)
2617
2618 The instantaneous temperature is calculated at the end of
2619 every ionic move and BEFORE rescaling. This is the temperature
2620 reported in the main output.
2621
2622 For "delta_t" &lt; 0, the actual average rate of heating or cooling
2623 should be roughly C*delta_t/(nraise*dt) (C=1 for an
2624 ideal gas, C=0.5 for a harmonic solid, theorem of energy
2625 equipartition between all quadratic degrees of freedom).
2626 +--------------------------------------------------------------------
2627
2628 +--------------------------------------------------------------------
2629 Variable: nraise
2630
2631 Type: INTEGER
2632 Default: 1
2633 Description: if "ion_temperature" == 'reduce-T' :
2634 every "nraise" steps the instantaneous temperature is
2635 reduced by -"delta_t" (i.e. "delta_t" is added to the temperature)
2636
2637 if "ion_temperature" == 'rescale-v' :
2638 every "nraise" steps the average temperature, computed from
2639 the last "nraise" steps, is rescaled to "tempw"
2640
2641 if "ion_temperature" == 'rescaling' and "calculation" == 'vc-md' :
2642 every "nraise" steps the instantaneous temperature
2643 is rescaled to "tempw"
2644
2645 if "ion_temperature" == 'berendsen' :
2646 the "rise time" parameter is given in units of the time step:
2647 tau = nraise*dt, so dt/tau = 1/nraise
2648
2649 if "ion_temperature" == 'andersen' :
2650 the "collision frequency" parameter is given as nu=1/tau
2651 defined above, so nu*dt = 1/nraise
2652
2653 if "ion_temperature" == 'svr' :
2654 the "characteristic time" of the thermostat is set to
2655 tau = nraise*dt
2656 +--------------------------------------------------------------------
2657
2658 +--------------------------------------------------------------------
2659 Variable: refold_pos
2660
2661 Type: LOGICAL
2662 Default: .FALSE.
2663 Description: This keyword applies only in the case of molecular dynamics or
2664 damped dynamics. If true the ions are refolded at each step into
2665 the supercell.
2666 +--------------------------------------------------------------------
2667
2668 \\\---
2669
2670 ///---
2671 KEYWORDS USED ONLY IN BFGS CALCULATIONS
2672
2673 +--------------------------------------------------------------------
2674 Variable: upscale
2675
2676 Type: REAL
2677 Default: 100.D0
2678 Description: Max reduction factor for "conv_thr" during structural optimization
2679 "conv_thr" is automatically reduced when the relaxation
2680 approaches convergence so that forces are still accurate,
2681 but "conv_thr" will not be reduced to less that "conv_thr" / "upscale".
2682 +--------------------------------------------------------------------
2683
2684 +--------------------------------------------------------------------
2685 Variable: bfgs_ndim
2686
2687 Type: INTEGER
2688 Default: 1
2689 Description: Number of old forces and displacements vectors used in the
2690 PULAY mixing of the residual vectors obtained on the basis
2691 of the inverse hessian matrix given by the BFGS algorithm.
2692 When "bfgs_ndim" = 1, the standard quasi-Newton BFGS method is
2693 used.
2694 (bfgs only)
2695 +--------------------------------------------------------------------
2696
2697 +--------------------------------------------------------------------
2698 Variable: trust_radius_max
2699
2700 Type: REAL
2701 Default: 0.8D0
2702 Description: Maximum ionic displacement in the structural relaxation.
2703 (bfgs only)
2704 +--------------------------------------------------------------------
2705
2706 +--------------------------------------------------------------------
2707 Variable: trust_radius_min
2708
2709 Type: REAL
2710 Default: 1.D-3
2711 Description: Minimum ionic displacement in the structural relaxation
2712 BFGS is reset when "trust_radius" &lt; "trust_radius_min".
2713 (bfgs only)
2714 +--------------------------------------------------------------------
2715
2716 +--------------------------------------------------------------------
2717 Variable: trust_radius_ini
2718
2719 Type: REAL
2720 Default: 0.5D0
2721 Description: Initial ionic displacement in the structural relaxation.
2722 (bfgs only)
2723 +--------------------------------------------------------------------
2724
2725 +--------------------------------------------------------------------
2726 Variable: w_1
2727
2728 Type: REAL
2729 Default: 0.01D0
2730 See: w_2
2731 +--------------------------------------------------------------------
2732
2733 +--------------------------------------------------------------------
2734 Variable: w_2
2735
2736 Type: REAL
2737 Default: 0.5D0
2738 Description: Parameters used in line search based on the Wolfe conditions.
2739 (bfgs only)
2740 +--------------------------------------------------------------------
2741
2742 \\\---
2743
2744 ===END OF NAMELIST======================================================
2745
2746
2747 ========================================================================
2748 NAMELIST: &CELL
2749
2750 INPUT THIS NAMELIST ONLY IF "CALCULATION" == 'VC-RELAX' OR 'VC-MD'
2751
2752 +--------------------------------------------------------------------
2753 Variable: cell_dynamics
2754
2755 Type: CHARACTER
2756 Description:
2757 Specify the type of dynamics for the cell.
2758 For different type of calculation different possibilities
2759 are allowed and different default values apply:
2760
2761 CASE ( "calculation" == 'vc-relax' )
2762
2763 'none' :
2764 no dynamics
2765
2766 'sd' :
2767 steepest descent ( not implemented )
2768
2769 'damp-pr' :
2770 damped (Beeman) dynamics of the Parrinello-Rahman extended lagrangian
2771
2772 'damp-w' :
2773 damped (Beeman) dynamics of the new Wentzcovitch extended lagrangian
2774
2775 'bfgs' :
2776 BFGS quasi-newton algorithm (default)
2777 "ion_dynamics" must be 'bfgs' too
2778
2779 CASE ( "calculation" == 'vc-md' )
2780
2781 'none' :
2782 no dynamics
2783
2784 'pr' :
2785 (Beeman) molecular dynamics of the Parrinello-Rahman extended lagrangian
2786
2787 'w' :
2788 (Beeman) molecular dynamics of the new Wentzcovitch extended lagrangian
2789 +--------------------------------------------------------------------
2790
2791 +--------------------------------------------------------------------
2792 Variable: press
2793
2794 Type: REAL
2795 Default: 0.D0
2796 Description: Target pressure [KBar] in a variable-cell md or relaxation run.
2797 +--------------------------------------------------------------------
2798
2799 +--------------------------------------------------------------------
2800 Variable: wmass
2801
2802 Type: REAL
2803 Default: 0.75*Tot_Mass/pi**2 for Parrinello-Rahman MD;
2804 0.75*Tot_Mass/pi**2/Omega**(2/3) for Wentzcovitch MD
2805 Description: Fictitious cell mass [amu] for variable-cell simulations
2806 (both 'vc-md' and 'vc-relax')
2807 +--------------------------------------------------------------------
2808
2809 +--------------------------------------------------------------------
2810 Variable: cell_factor
2811
2812 Type: REAL
2813 Default: 2.0 for variable-cell calculations, 1.0 otherwise
2814 Description: Used in the construction of the pseudopotential tables.
2815 It should exceed the maximum linear contraction of the
2816 cell during a simulation.
2817 +--------------------------------------------------------------------
2818
2819 +--------------------------------------------------------------------
2820 Variable: press_conv_thr
2821
2822 Type: REAL
2823 Default: 0.5D0 Kbar
2824 Description: Convergence threshold on the pressure for variable cell
2825 relaxation ('vc-relax' : note that the other convergence
2826 thresholds for ionic relaxation apply as well).
2827 +--------------------------------------------------------------------
2828
2829 +--------------------------------------------------------------------
2830 Variable: cell_dofree
2831
2832 Type: CHARACTER
2833 Default: 'all'
2834 Description:
2835 Select which of the cell parameters should be moved:
2836
2837 'all' :
2838 all axis and angles are moved
2839
2840 'ibrav' :
2841 all axis and angles are moved, but the lattice remains consistent with the initial ibrav choice
2842
2843 'x' :
2844 only the x component of axis 1 (v1_x) is moved
2845
2846 'y' :
2847 only the y component of axis 2 (v2_y) is moved
2848
2849 'z' :
2850 only the z component of axis 3 (v3_z) is moved
2851
2852 'xy' :
2853 only v1_x and v2_y are moved
2854
2855 'xz' :
2856 only v1_x and v3_z are moved
2857
2858 'yz' :
2859 only v2_y and v3_z are moved
2860
2861 'xyz' :
2862 only v1_x, v2_y, v3_z are moved
2863
2864 'shape' :
2865 all axis and angles, keeping the volume fixed
2866
2867 'volume' :
2868 the volume changes, keeping all angles fixed (i.e. only celldm(1) changes)
2869
2870 '2Dxy' :
2871 only x and y components are allowed to change
2872
2873 '2Dshape' :
2874 as above, keeping the area in xy plane fixed
2875
2876 'epitaxial_ab' :
2877 fix axis 1 and 2 while allowing axis 3 to move
2878
2879 'epitaxial_ac' :
2880 fix axis 1 and 3 while allowing axis 2 to move
2881
2882 'epitaxial_bc' :
2883 fix axis 2 and 3 while allowing axis 1 to move
2884
2885 BEWARE: if axis are not orthogonal, some of these options do not
2886 work (symmetry is broken). If you are not happy with them,
2887 edit subroutine init_dofree in file Modules/cell_base.f90
2888 +--------------------------------------------------------------------
2889
2890 ===END OF NAMELIST======================================================
2891
2892
2893 ========================================================================
2894 CARD: ATOMIC_SPECIES
2895
2896 /////////////////////////////////////////
2897 // Syntax: //
2898 /////////////////////////////////////////
2899
2900 ATOMIC_SPECIES
2901 X(1) Mass_X(1) PseudoPot_X(1)
2902 X(2) Mass_X(2) PseudoPot_X(2)
2903 . . .
2904 X(ntyp) Mass_X(ntyp) PseudoPot_X(ntyp)
2905
2906 /////////////////////////////////////////
2907
2908 DESCRIPTION OF ITEMS:
2909
2910 +--------------------------------------------------------------------
2911 Variable: X
2912
2913 Type: CHARACTER
2914 Description: label of the atom. Acceptable syntax:
2915 chemical symbol X (1 or 2 characters, case-insensitive)
2916 or chemical symbol plus a number or a letter, as in
2917 "Xn" (e.g. Fe1) or "X_*" or "X-*" (e.g. C1, C_h;
2918 max total length cannot exceed 3 characters)
2919 +--------------------------------------------------------------------
2920
2921 +--------------------------------------------------------------------
2922 Variable: Mass_X
2923
2924 Type: REAL
2925 Description: mass of the atomic species [amu: mass of C = 12]
2926 Used only when performing Molecular Dynamics run
2927 or structural optimization runs using Damped MD.
2928 Not actually used in all other cases (but stored
2929 in data files, so phonon calculations will use
2930 these values unless other values are provided)
2931 +--------------------------------------------------------------------
2932
2933 +--------------------------------------------------------------------
2934 Variable: PseudoPot_X
2935
2936 Type: CHARACTER
2937 Description: File containing PP for this species.
2938
2939 The pseudopotential file is assumed to be in the new UPF format.
2940 If it doesn't work, the pseudopotential format is determined by
2941 the file name:
2942
2943 *.vdb or *.van Vanderbilt US pseudopotential code
2944 *.RRKJ3 Andrea Dal Corso's code (old format)
2945 none of the above old PWscf norm-conserving format
2946 +--------------------------------------------------------------------
2947
2948 ===END OF CARD==========================================================
2949
2950
2951 ========================================================================
2952 CARD: ATOMIC_POSITIONS { alat | bohr | angstrom | crystal | crystal_sg }
2953
2954 ________________________________________________________________________
2955 * IF calculation == 'bands' OR calculation == 'nscf' :
2956
2957 Specified atomic positions will be IGNORED and those from the
2958 previous scf calculation will be used instead !!!
2959
2960
2961 * ELSE :
2962
2963 /////////////////////////////////////////
2964 // Syntax: //
2965 /////////////////////////////////////////
2966
2967 ATOMIC_POSITIONS { alat | bohr | angstrom | crystal | crystal_sg }
2968 X(1) x(1) y(1) z(1) { if_pos(1)(1) if_pos(2)(1) if_pos(3)(1) }
2969 X(2) x(2) y(2) z(2) { if_pos(1)(2) if_pos(2)(2) if_pos(3)(2) }
2970 . . .
2971 X(nat) x(nat) y(nat) z(nat) { if_pos(1)(nat) if_pos(2)(nat) if_pos(3)(nat) }
2972
2973 /////////////////////////////////////////
2974
2975
2976 ENDIF
2977 ________________________________________________________________________
2978
2979 DESCRIPTION OF ITEMS:
2980
2981 +--------------------------------------------------------------------
2982 Card's flags: { alat | bohr | angstrom | crystal | crystal_sg }
2983
2984 Default: (DEPRECATED) alat
2985 Description:
2986 Units for ATOMIC_POSITIONS:
2987
2988 alat :
2989 atomic positions are in cartesian coordinates, in
2990 units of the lattice parameter (either celldm(1)
2991 or A). If no option is specified, 'alat' is assumed;
2992 not specifying units is DEPRECATED and will no
2993 longer be allowed in the future
2994
2995 bohr :
2996 atomic positions are in cartesian coordinate,
2997 in atomic units (i.e. Bohr radii)
2998
2999 angstrom :
3000 atomic positions are in cartesian coordinates, in Angstrom
3001
3002 crystal :
3003 atomic positions are in crystal coordinates, i.e.
3004 in relative coordinates of the primitive lattice
3005 vectors as defined either in card "CELL_PARAMETERS"
3006 or via the ibrav + celldm / a,b,c... variables
3007
3008 crystal_sg :
3009 atomic positions are in crystal coordinates, i.e.
3010 in relative coordinates of the primitive lattice.
3011 This option differs from the previous one because
3012 in this case only the symmetry inequivalent atoms
3013 are given. The variable "space_group" must indicate
3014 the space group number used to find the symmetry
3015 equivalent atoms. The other variables that control
3016 this option are uniqueb, origin_choice, and
3017 rhombohedral.
3018 +--------------------------------------------------------------------
3019
3020
3021 +--------------------------------------------------------------------
3022 Variable: X
3023
3024 Type: CHARACTER
3025 Description: label of the atom as specified in "ATOMIC_SPECIES"
3026 +--------------------------------------------------------------------
3027
3028 +--------------------------------------------------------------------
3029 Variables: x, y, z
3030
3031 Type: REAL
3032 Description: atomic positions
3033
3034 NOTE: each atomic coordinate can also be specified as a simple algebraic expression.
3035 To be interpreted correctly expression must NOT contain any blank
3036 space and must NOT start with a "+" sign. The available expressions are:
3037
3038 + (plus), - (minus), / (division), * (multiplication), ^ (power)
3039
3040 All numerical constants included are considered as double-precision numbers;
3041 i.e. 1/2 is 0.5, not zero. Other functions, such as sin, sqrt or exp are
3042 not available, although sqrt can be replaced with ^(1/2).
3043
3044 Example:
3045 C 1/3 1/2*3^(-1/2) 0
3046
3047 is equivalent to
3048
3049 C 0.333333 0.288675 0.000000
3050
3051 Please note that this feature is NOT supported by XCrysDen (which will
3052 display a wrong structure, or nothing at all).
3053
3054 When atomic positions are of type crystal_sg coordinates can be given
3055 in the following four forms (Wyckoff positions):
3056 C 1a
3057 C 8g x
3058 C 24m x y
3059 C 48n x y z
3060 The first form must be used when the Wyckoff letter determines uniquely
3061 all three coordinates, forms 2,3,4 when the Wyckoff letter and 1,2,3
3062 coordinates respectively are needed.
3063
3064 The forms:
3065 C 8g x x x
3066 C 24m x x y
3067 are not allowed, but
3068 C x x x
3069 C x x y
3070 C x y z
3071 are correct.
3072 +--------------------------------------------------------------------
3073
3074 +--------------------------------------------------------------------
3075 Variables: if_pos(1), if_pos(2), if_pos(3)
3076
3077 Type: INTEGER
3078 Default: 1
3079 Description: component i of the force for this atom is multiplied by if_pos(i),
3080 which must be either 0 or 1. Used to keep selected atoms and/or
3081 selected components fixed in MD dynamics or
3082 structural optimization run.
3083
3084 With crystal_sg atomic coordinates the constraints are copied in all equivalent
3085 atoms.
3086 +--------------------------------------------------------------------
3087
3088 ===END OF CARD==========================================================
3089
3090
3091 ========================================================================
3092 CARD: K_POINTS { tpiba | automatic | crystal | gamma | tpiba_b | crystal_b | tpiba_c | crystal_c }
3093
3094 ________________________________________________________________________
3095 * IF tpiba OR crystal OR tpiba_b OR crystal_b OR tpiba_c OR crystal_c :
3096
3097 /////////////////////////////////////////
3098 // Syntax: //
3099 /////////////////////////////////////////
3100
3101 K_POINTS tpiba | crystal | tpiba_b | crystal_b | tpiba_c | crystal_c
3102 nks
3103 xk_x(1) xk_y(1) xk_z(1) wk(1)
3104 xk_x(2) xk_y(2) xk_z(2) wk(2)
3105 . . .
3106 xk_x(nks) xk_y(nks) xk_z(nks) wk(nks)
3107
3108 /////////////////////////////////////////
3109
3110
3111 * ELSE IF automatic :
3112
3113 /////////////////////////////////////////
3114 // Syntax: //
3115 /////////////////////////////////////////
3116
3117 K_POINTS automatic
3118 nk1 nk2 nk3 sk1 sk2 sk3
3119
3120 /////////////////////////////////////////
3121
3122
3123 * ELSE IF gamma :
3124
3125 /////////////////////////////////////////
3126 // Syntax: //
3127 /////////////////////////////////////////
3128
3129 K_POINTS gamma
3130
3131 /////////////////////////////////////////
3132
3133
3134 ENDIF
3135 ________________________________________________________________________
3136
3137 DESCRIPTION OF ITEMS:
3138
3139 +--------------------------------------------------------------------
3140 Card's flags: { tpiba | automatic | crystal | gamma | tpiba_b | crystal_b | tpiba_c | crystal_c }
3141
3142 Default: tbipa
3143 Description:
3144 K_POINTS options are:
3145
3146 tpiba :
3147 read k-points in cartesian coordinates,
3148 in units of 2 pi/a (default)
3149
3150 automatic :
3151 automatically generated uniform grid of k-points, i.e,
3152 generates ( nk1, nk2, nk3 ) grid with ( sk1, sk2, sk3 ) offset.
3153 nk1, nk2, nk3 as in Monkhorst-Pack grids
3154 k1, k2, k3 must be 0 ( no offset ) or 1 ( grid displaced
3155 by half a grid step in the corresponding direction )
3156 BEWARE: only grids having the full symmetry of the crystal
3157 work with tetrahedra. Some grids with offset may not work.
3158
3159 crystal :
3160 read k-points in crystal coordinates, i.e. in relative
3161 coordinates of the reciprocal lattice vectors
3162
3163 gamma :
3164 use k = 0 (no need to list k-point specifications after card)
3165 In this case wavefunctions can be chosen as real,
3166 and specialized subroutines optimized for calculations
3167 at the gamma point are used (memory and cpu requirements
3168 are reduced by approximately one half).
3169
3170 tpiba_b :
3171 Used for band-structure plots.
3172 See Doc/brillouin_zones.pdf for usage of BZ labels;
3173 otherwise, k-points are in units of 2 pi/a.
3174 nks points specify nks-1 lines in reciprocal space.
3175 Every couple of points identifies the initial and
3176 final point of a line. pw.x generates N intermediate
3177 points of the line where N is the weight of the first point.
3178
3179 crystal_b :
3180 As tpiba_b, but k-points are in crystal coordinates.
3181 See Doc/brillouin_zones.pdf for usage of BZ labels.
3182
3183 tpiba_c :
3184 Used for band-structure contour plots.
3185 k-points are in units of 2 pi/a. nks must be 3.
3186 3 k-points k_0, k_1, and k_2 specify a rectangle
3187 in reciprocal space of vertices k_0, k_1, k_2,
3188 k_1 + k_2 - k_0: k_0 + \alpha (k_1-k_0)+
3189 \beta (k_2-k_0) with 0 &lt;\alpha,\beta &lt; 1.
3190 The code produces a uniform mesh n1 x n2
3191 k points in this rectangle. n1 and n2 are
3192 the weights of k_1 and k_2. The weight of k_0
3193 is not used.
3194
3195 crystal_c :
3196 As tpiba_c, but k-points are in crystal coordinates.
3197 +--------------------------------------------------------------------
3198
3199
3200 +--------------------------------------------------------------------
3201 Variable: nks
3202
3203 Type: INTEGER
3204 Description: Number of supplied special k-points.
3205 +--------------------------------------------------------------------
3206
3207 +--------------------------------------------------------------------
3208 Variables: xk_x, xk_y, xk_z, wk
3209
3210 Type: REAL
3211 Description: Special k-points (xk_x/y/z) in the irreducible Brillouin Zone
3212 (IBZ) of the lattice (with all symmetries) and weights (wk)
3213 See the literature for lists of special points and
3214 the corresponding weights.
3215
3216 If the symmetry is lower than the full symmetry
3217 of the lattice, additional points with appropriate
3218 weights are generated. Notice that such procedure
3219 assumes that ONLY k-points in the IBZ are provided in input
3220
3221 In a non-scf calculation, weights do not affect the results.
3222 If you just need eigenvalues and eigenvectors (for instance,
3223 for a band-structure plot), weights can be set to any value
3224 (for instance all equal to 1).
3225 +--------------------------------------------------------------------
3226
3227 +--------------------------------------------------------------------
3228 Variables: nk1, nk2, nk3
3229
3230 Type: INTEGER
3231 Description: These parameters specify the k-point grid
3232 (nk1 x nk2 x nk3) as in Monkhorst-Pack grids.
3233 +--------------------------------------------------------------------
3234
3235 +--------------------------------------------------------------------
3236 Variables: sk1, sk2, sk3
3237
3238 Type: INTEGER
3239 Description: The grid offsets; sk1, sk2, sk3 must be
3240 0 ( no offset ) or 1 ( grid displaced by
3241 half a grid step in the corresponding direction ).
3242 +--------------------------------------------------------------------
3243
3244 ===END OF CARD==========================================================
3245
3246
3247 ========================================================================
3248 CARD: ADDITIONAL_K_POINTS
3249
3250 OPTIONAL CARD. ADDS A LIST OF K-POINTS WITH ZERO WEIGHT, AFTER THOSE USED FOR THE SCF CALCULATION.
3251 WHEN DOING AN EXX CALCULATION AND NQ1X, NQ2X OR NQ3X ARE DIFFERENT FROM ONE, ALSO INCLUDE THE
3252 REQUIRED K+Q POINTS. THE MAIN USE OF THIS CARD IS DO BAND PLOTS WITH EXX.
3253
3254 /////////////////////////////////////////
3255 // Syntax: //
3256 /////////////////////////////////////////
3257
3258 ADDITIONAL_K_POINTS
3259 Same as K_POINTS, but does not accept 'automatic'.
3260
3261
3262 /////////////////////////////////////////
3263
3264 ===END OF CARD==========================================================
3265
3266
3267 ========================================================================
3268 CARD: CELL_PARAMETERS { alat | bohr | angstrom }
3269
3270 OPTIONAL CARD, NEEDED ONLY IF "IBRAV" == 0 IS SPECIFIED, IGNORED OTHERWISE !
3271
3272 /////////////////////////////////////////
3273 // Syntax: //
3274 /////////////////////////////////////////
3275
3276 CELL_PARAMETERS { alat | bohr | angstrom }
3277 v1(1) v1(2) v1(3)
3278 v2(1) v2(2) v2(3)
3279 v3(1) v3(2) v3(3)
3280
3281 /////////////////////////////////////////
3282
3283 DESCRIPTION OF ITEMS:
3284
3285 +--------------------------------------------------------------------
3286 Card's flags: { alat | bohr | angstrom }
3287
3288 Description: Unit for lattice vectors; options are:
3289
3290 'bohr' / 'angstrom':
3291 lattice vectors in bohr-radii / angstrom.
3292 In this case the lattice parameter alat = sqrt(v1*v1).
3293
3294 'alat' / nothing specified:
3295 lattice vectors in units of the lattice parameter (either
3296 "celldm"(1) or "A"). Not specifying units is DEPRECATED
3297 and will not be allowed in the future.
3298
3299 If neither unit nor lattice parameter are specified,
3300 'bohr' is assumed - DEPRECATED, will no longer be allowed
3301 +--------------------------------------------------------------------
3302
3303
3304 +--------------------------------------------------------------------
3305 Variables: v1, v2, v3
3306
3307 Type: REAL
3308 Description: Crystal lattice vectors (in cartesian axis):
3309 v1(1) v1(2) v1(3) ... 1st lattice vector
3310 v2(1) v2(2) v2(3) ... 2nd lattice vector
3311 v3(1) v3(2) v3(3) ... 3rd lattice vector
3312 +--------------------------------------------------------------------
3313
3314 ===END OF CARD==========================================================
3315
3316
3317 ========================================================================
3318 CARD: CONSTRAINTS
3319
3320 OPTIONAL CARD, USED FOR CONSTRAINED DYNAMICS OR CONSTRAINED OPTIMISATIONS
3321 (ONLY IF "ION_DYNAMICS"=='DAMP' OR 'VERLET', VARIABLE-CELL EXCEPTED)
3322
3323 When this card is present the SHAKE algorithm is automatically used.
3324
3325 /////////////////////////////////////////
3326 // Syntax: //
3327 /////////////////////////////////////////
3328
3329 CONSTRAINTS
3330 nconstr { constr_tol }
3331 constr_type(1) constr(1)(1) constr(2)(1) [ constr(3)(1) constr(4)(1) ] { constr_target(1) }
3332 constr_type(2) constr(1)(2) constr(2)(2) [ constr(3)(2) constr(4)(2) ] { constr_target(2) }
3333 . . .
3334 constr_type(nconstr) constr(1)(nconstr) constr(2)(nconstr) [ constr(3)(nconstr) constr(4)(nconstr) ] { constr_target(nconstr) }
3335
3336 /////////////////////////////////////////
3337
3338 DESCRIPTION OF ITEMS:
3339
3340 +--------------------------------------------------------------------
3341 Variable: nconstr
3342
3343 Type: INTEGER
3344 Description: Number of constraints.
3345 +--------------------------------------------------------------------
3346
3347 +--------------------------------------------------------------------
3348 Variable: constr_tol
3349
3350 Type: REAL
3351 Description: Tolerance for keeping the constraints satisfied.
3352 +--------------------------------------------------------------------
3353
3354 +--------------------------------------------------------------------
3355 Variable: constr_type
3356
3357 Type: CHARACTER
3358 Description:
3359 Type of constraint :
3360
3361 'type_coord' :
3362 constraint on global coordination-number, i.e. the
3363 average number of atoms of type B surrounding the
3364 atoms of type A. The coordination is defined by
3365 using a Fermi-Dirac.
3366 (four indexes must be specified).
3367
3368 'atom_coord' :
3369 constraint on local coordination-number, i.e. the
3370 average number of atoms of type A surrounding a
3371 specific atom. The coordination is defined by
3372 using a Fermi-Dirac.
3373 (four indexes must be specified).
3374
3375 'distance' :
3376 constraint on interatomic distance
3377 (two atom indexes must be specified).
3378
3379 'planar_angle' :
3380 constraint on planar angle
3381 (three atom indexes must be specified).
3382
3383 'torsional_angle' :
3384 constraint on torsional angle
3385 (four atom indexes must be specified).
3386
3387 'bennett_proj' :
3388 constraint on the projection onto a given direction
3389 of the vector defined by the position of one atom
3390 minus the center of mass of the others.
3391 G. Roma, J.P. Crocombette: J. Nucl. Mater. 403, 32 (2010),
3392 doi:10.1016/j.jnucmat.2010.06.001
3393 +--------------------------------------------------------------------
3394
3395 +--------------------------------------------------------------------
3396 Variables: constr(1), constr(2), constr(3), constr(4)
3397
3398 Description: These variables have different meanings for different constraint types:
3399
3400 @b 'type_coord' :
3401 @i constr(1) is the first index of the atomic type involved
3402 @i constr(2) is the second index of the atomic type involved
3403 @i constr(3) is the cut-off radius for estimating the coordination
3404 @i constr(4) is a smoothing parameter
3405
3406 @b 'atom_coord' :
3407 @i constr(1) is the atom index of the atom with constrained coordination
3408 @i constr(2) is the index of the atomic type involved in the coordination
3409 @i constr(3) is the cut-off radius for estimating the coordination
3410 @i constr(4) is a smoothing parameter
3411
3412 @b 'distance' :
3413 atoms indices object of the constraint, as they appear in
3414 the @ref ATOMIC_POSITIONS card
3415
3416 @b 'planar_angle', @b 'torsional_angle' :
3417 atoms indices object of the constraint, as they appear in the
3418 @ref ATOMIC_POSITIONS card (beware the order)
3419
3420 @b 'bennett_proj' :
3421 @i constr(1) is the index of the atom whose position is constrained.
3422 @i constr(2:4) are the three coordinates of the vector that specifies
3423 the constraint direction.
3424 +--------------------------------------------------------------------
3425
3426 +--------------------------------------------------------------------
3427 Variable: constr_target
3428
3429 Type: REAL
3430 Description: Target for the constrain ( angles are specified in degrees ).
3431 This variable is optional.
3432 +--------------------------------------------------------------------
3433
3434 ===END OF CARD==========================================================
3435
3436
3437 ========================================================================
3438 CARD: OCCUPATIONS
3439
3440 OPTIONAL CARD, USED ONLY IF "OCCUPATIONS" == 'FROM_INPUT', IGNORED OTHERWISE !
3441
3442 /////////////////////////////////////////
3443 // Syntax: //
3444 /////////////////////////////////////////
3445
3446 OCCUPATIONS
3447 f_inp1(1) f_inp1(2) . . . f_inp1(nbnd)
3448 [ f_inp2(1) f_inp2(2) . . . f_inp2(nbnd) ]
3449
3450
3451 /////////////////////////////////////////
3452
3453 DESCRIPTION OF ITEMS:
3454
3455 +--------------------------------------------------------------------
3456 Variable: f_inp1
3457
3458 Type: REAL
3459 Description: Occupations of individual states (MAX 10 PER ROW).
3460 For spin-polarized calculations, these are majority spin states.
3461 +--------------------------------------------------------------------
3462
3463 +--------------------------------------------------------------------
3464 Variable: f_inp2
3465
3466 Type: REAL
3467 Description: Occupations of minority spin states (MAX 10 PER ROW)
3468 To be specified only for spin-polarized calculations.
3469 +--------------------------------------------------------------------
3470
3471 ===END OF CARD==========================================================
3472
3473
3474 ========================================================================
3475 CARD: ATOMIC_VELOCITIES { a.u }
3476
3477 OPTIONAL CARD, READS VELOCITIES FROM STANDARD INPUT
3478
3479 /////////////////////////////////////////
3480 // Syntax: //
3481 /////////////////////////////////////////
3482
3483 ATOMIC_VELOCITIES { a.u }
3484 V(1) vx(1) vy(1) vz(1)
3485 V(2) vx(2) vy(2) vz(2)
3486 . . .
3487 V(nat) vx(nat) vy(nat) vz(nat)
3488
3489 /////////////////////////////////////////
3490
3491 DESCRIPTION OF ITEMS:
3492
3493 +--------------------------------------------------------------------
3494 Card's flags: { a.u }
3495
3496 +--------------------------------------------------------------------
3497
3498
3499 +--------------------------------------------------------------------
3500 Variable: V
3501
3502 Type: CHARACTER
3503 Description: label of the atom as specified in ATOMIC_SPECIES
3504 +--------------------------------------------------------------------
3505
3506 +--------------------------------------------------------------------
3507 Variables: vx, vy, vz
3508
3509 Type: REAL
3510 Description: atomic velocities along x y and z direction
3511 +--------------------------------------------------------------------
3512
3513 ===END OF CARD==========================================================
3514
3515
3516 ========================================================================
3517 CARD: ATOMIC_FORCES
3518
3519 OPTIONAL CARD USED TO SPECIFY EXTERNAL FORCES ACTING ON ATOMS.
3520
3521 BEWARE: if the sum of external forces is not zero, the center of mass of
3522 the system will move
3523
3524 /////////////////////////////////////////
3525 // Syntax: //
3526 /////////////////////////////////////////
3527
3528 ATOMIC_FORCES
3529 X(1) fx(1) fy(1) fz(1)
3530 X(2) fx(2) fy(2) fz(2)
3531 . . .
3532 X(nat) fx(nat) fy(nat) fz(nat)
3533
3534 /////////////////////////////////////////
3535
3536 DESCRIPTION OF ITEMS:
3537
3538 +--------------------------------------------------------------------
3539 Variable: X
3540
3541 Type: CHARACTER
3542 Description: label of the atom as specified in "ATOMIC_SPECIES"
3543 +--------------------------------------------------------------------
3544
3545 +--------------------------------------------------------------------
3546 Variables: fx, fy, fz
3547
3548 Type: REAL
3549 Description: external force on atom X (cartesian components, Ry/a.u. units)
3550 +--------------------------------------------------------------------
3551
3552 ===END OF CARD==========================================================
3553
3554
3555 This file has been created by helpdoc utility on Wed Dec 02 08:04:48 CET 2020
3556
3557 </pre>
3558 </body>
3559 </html>