Debian Codegraph @

GUI/PWgui/doc/pwdocs/INPUT_PP.html

raw
1
2 <html>
3 <body>
4 <pre>
5
6 ------------------------------------------------------------------------
7 INPUT FILE DESCRIPTION
8
9 Program: pp.x / PWscf / Quantum Espresso (version: 6.6)
10 ------------------------------------------------------------------------
11
12
13 Purpose of pp.x: data analysis and plotting.
14
15 The code performs two steps:
16
17 (1) reads the output produced by pw.x, extracts and calculates
18 the desired quantity/quantities (rho, V, ...)
19
20 (2) writes the desired quantity to file in a suitable format for
21 various types of plotting and various plotting programs
22
23 The input data of this program is read from standard input
24 or from file and has the following format:
25
26 NAMELIST &INPUTPP
27 containing the variables for step (1), followed by
28
29 NAMELIST &PLOT
30 containing the variables for step (2)
31
32 The two steps can be performed independently. In order to perform
33 only step (2), leave namelist &INPUTPP blank. In order to perform
34 only step (1), do not specify namelist &PLOT
35
36 Intermediate results from step 1 can be saved to disk (see
37 variable "filplot" in &INPUTPP) and later read in step 2.
38 Since the file with intermediate results is formatted, it
39 can be safely transferred to a different machine. This
40 also allows plotting of a linear combination (for instance,
41 charge differences) by saving two intermediate files and
42 combining them (see variables "weight" and "filepp" in &PLOT)
43
44 All output quantities are in ATOMIC (RYDBERG) UNITS unless
45 otherwise explicitly specified.
46 All charge densities integrate to the NUMBER of electrons
47 not to the total charge.
48 All potentials have the dimension of an energy (e*V, not V).
49
50
51
52 ========================================================================
53 NAMELIST: &INPUTPP
54
55 +--------------------------------------------------------------------
56 Variable: prefix
57
58 Type: CHARACTER
59 Description: prefix of files saved by program pw.x
60 +--------------------------------------------------------------------
61
62 +--------------------------------------------------------------------
63 Variable: outdir
64
65 Type: CHARACTER
66 Description: directory containing the input data, i.e. the same as in pw.x
67 Default: value of the ESPRESSO_TMPDIR environment variable if set;
68 current directory ('./') otherwise
69 +--------------------------------------------------------------------
70
71 +--------------------------------------------------------------------
72 Variable: filplot
73
74 Type: CHARACTER
75 Description: file "filplot" contains the quantity selected by plot_num
76 (can be saved for further processing)
77 +--------------------------------------------------------------------
78
79 +--------------------------------------------------------------------
80 Variable: plot_num
81
82 Type: INTEGER
83 Description: Selects what to save in filplot:
84
85 0 = electron (pseudo-)charge density
86
87 1 = total potential V_bare + V_H + V_xc
88
89 2 = local ionic potential V_bare
90
91 3 = local density of states at specific energy or grid of energies
92 (number of states per volume, in bohr^3, per energy unit, in Ry)
93
94 4 = local density of electronic entropy
95
96 5 = STM images
97 Tersoff and Hamann, PRB 31, 805 (1985)
98
99 6 = spin polarization (rho(up)-rho(down))
100
101 7 = contribution of selected wavefunction(s) to the
102 (pseudo-)charge density. For norm-conserving PPs,
103 |psi|^2 (psi=selected wavefunction). Noncollinear case:
104 contribution of the given state to the charge or
105 to the magnetization along the direction indicated
106 by spin_component (0 = charge, 1 = x, 2 = y, 3 = z )
107
108 8 = electron localization function (ELF)
109
110 9 = charge density minus superposition of atomic densities
111
112 10 = integrated local density of states (ILDOS)
113 from "emin" to "emax" (emin, emax in eV)
114 if "emax" is not specified, "emax"=E_fermi
115
116 11 = the V_bare + V_H potential
117
118 12 = the sawtooth electric field potential (if present)
119
120 13 = the noncollinear magnetization.
121
122 17 = all-electron valence charge density
123 can be performed for PAW calculations only
124 requires a very dense real-space grid!
125
126 18 = The exchange and correlation magnetic field in the noncollinear case
127
128 19 = Reduced density gradient
129 ( J. Chem. Theory Comput. 7, 625 (2011), doi:10.1021/ct100641a )
130 Set the isosurface between 0.3 and 0.6 to plot the
131 non-covalent interactions (see also plot_num = 20)
132
133 20 = Product of the electron density (charge) and the second
134 eigenvalue of the electron-density Hessian matrix;
135 used to colorize the RDG plot (plot_num = 19)
136
137 21 = all-electron charge density (valence+core).
138 For PAW calculations only; requires a very dense real-space grid.
139
140 22 = kinetic energy density (for meta-GGA and XDM only)
141 +--------------------------------------------------------------------
142
143 ________________________________________________________________________
144 * IF plot_num=0 :
145
146 OPTIONS FOR TOTAL CHARGE (PLOT_NUM=0):
147
148 +--------------------------------------------------------------------
149 Variable: spin_component
150
151 Type: INTEGER
152 Default: 0
153 Description: 0 = total charge (default value),
154 1 = spin up charge,
155 2 = spin down charge.
156 +--------------------------------------------------------------------
157
158
159 * ELSE IF plot_num=1 :
160
161 OPTIONS FOR TOTAL POTENTIAL (PLOT_NUM=1):
162
163 +--------------------------------------------------------------------
164 Variable: spin_component
165
166 Type: INTEGER
167 Default: 0
168 Description: 0 = spin averaged potential (default value),
169 1 = spin up potential,
170 2 = spin down potential.
171 +--------------------------------------------------------------------
172
173
174 * ELSE IF plot_num=3 :
175
176 OPTIONS FOR LDOS (PLOT_NUM=3):
177 LDOS IS PLOTTED ON GRID [EMIN, EMAX] WITH SPACING DELTA_E.
178
179 +--------------------------------------------------------------------
180 Variable: emin
181
182 Type: REAL
183 Default: e_fermi
184 Description: lower boundary of energy grid (in eV).
185
186 Defaults to Fermi energy.
187 +--------------------------------------------------------------------
188
189 +--------------------------------------------------------------------
190 Variable: emax
191
192 Type: REAL
193 Status: OPTIONAL
194 Description: upper boundary of energy grid (in eV).
195
196 Defaults to Fermi energy.
197 +--------------------------------------------------------------------
198
199 +--------------------------------------------------------------------
200 Variable: delta_e
201
202 Type: REAL
203 Default: 0.1
204 Status: OPTIONAL
205 Description: spacing of energy grid (in eV).
206 +--------------------------------------------------------------------
207
208 +--------------------------------------------------------------------
209 Variable: degauss_ldos
210
211 Type: REAL
212 Default: degauss (converted to eV)
213 Status: OPTIONAL
214 Description: broadening of energy levels for LDOS (in eV).
215
216 Defaults to broadening degauss specified for electronic smearing
217 in pw.x calculation.
218 +--------------------------------------------------------------------
219
220
221 * ELSE IF plot_num=5 :
222
223 OPTIONS FOR STM IMAGES (PLOT_NUM=5):
224
225 +--------------------------------------------------------------------
226 Variable: sample_bias
227
228 Type: REAL
229 Description: the bias of the sample (Ry) in stm images
230 +--------------------------------------------------------------------
231
232
233 * ELSE IF plot_num=7 :
234
235 OPTIONS FOR |PSI|^2 (PLOT_NUM=7):
236
237 +--------------------------------------------------------------------
238 Variable: kpoint(i), i=1,2
239
240 Type: INTEGER
241 Description: Unpolarized and noncollinear case:
242 k-point(s) to be plotted
243 LSDA:
244 k-point(s) and spin polarization to be plotted
245 (spin-up and spin-down correspond to different k-points!)
246
247 To plot a single kpoint ikpt, specify kpoint=ikpt or kpoint(1)=ikpt
248 To plot a range of kpoints [imin, imax], specify kpoint(1)=imin and kpoint(2)=imax
249 +--------------------------------------------------------------------
250
251 +--------------------------------------------------------------------
252 Variable: kband(i), i=1,2
253
254 Type: INTEGER
255 Description: Band(s) to be plotted.
256
257 To plot a single band ibnd, specify kband=ibnd or kband(1)=ibnd
258 To plot a range of bands [imin, imax], specify kband(1)=imin and kband(2)=imax
259 +--------------------------------------------------------------------
260
261 +--------------------------------------------------------------------
262 Variable: lsign
263
264 Type: LOGICAL
265 Description: if true and k point is Gamma, plot |psi|^2 sign(psi)
266 +--------------------------------------------------------------------
267
268 +--------------------------------------------------------------------
269 Variable: spin_component(i), i=1,2
270
271 Type: INTEGER
272 Default: 0
273 Status: OPTIONAL
274 Description: Noncollinear case only:
275 plot the contribution of the given state(s) to the charge
276 or to the magnetization along the direction(s) indicated
277 by spin_component:
278 0 = charge (default),
279 1 = x,
280 2 = y,
281 3 = z.
282
283 Ignored in unpolarized or LSDA case
284
285 To plot a single component ispin, specify spin_component=ispin or spin_component(1)=ispin
286 To plot a range of components [imin, imax], specify spin_component(1)=imin and spin_component(2)=imax
287 +--------------------------------------------------------------------
288
289
290 * ELSE IF plot_num=10 :
291
292 OPTIONS FOR ILDOS (PLOT_NUM=10):
293
294 +--------------------------------------------------------------------
295 Variable: emin
296
297 Type: REAL
298 Description: lower energy boundary (in eV)
299 +--------------------------------------------------------------------
300
301 +--------------------------------------------------------------------
302 Variable: emax
303
304 Type: REAL
305 Description: upper energy boundary (in eV),
306 i.e. compute ILDOS from "emin" to "emax"
307 +--------------------------------------------------------------------
308
309 +--------------------------------------------------------------------
310 Variable: spin_component
311
312 Type: INTEGER
313 Default: 0
314 Description: for LSDA case only: plot the contribution to ILDOS of
315 0 = spin-up + spin-down (default)
316 1 = spin-up only
317 2 = spin-down only
318 +--------------------------------------------------------------------
319
320
321 * ELSE IF plot_num=13 :
322
323 OPTIONS FOR NONCOLLINEAR MAGNETIZATION (PLOT_NUM=13):
324
325 +--------------------------------------------------------------------
326 Variable: spin_component
327
328 Type: INTEGER
329 Default: 0
330 Description: 0 = absolute value (default value)
331 1 = x component of the magnetization
332 2 = y component of the magnetization
333 3 = z component of the magnetization
334 +--------------------------------------------------------------------
335
336
337 * ELSE IF plot_num=17 :
338
339 OPTIONS FOR RECONSTRUCTED CHARGE DENSITY (PLOT_NUM=17):
340
341 +--------------------------------------------------------------------
342 Variable: spin_component
343
344 Type: INTEGER
345 Default: 0
346 Description: 0 = total charge (default value),
347 1 = spin up charge,
348 2 = spin down charge.
349 +--------------------------------------------------------------------
350
351
352 * ELSE IF plot_num=22 :
353
354 OPTIONS FOR KINETIC ENERGY DENSITY (PLOT_NUM=22),
355 LSDA CASE ONLY:
356
357 +--------------------------------------------------------------------
358 Variable: spin_component
359
360 Type: INTEGER
361 Default: 0
362 Description: 0 = total density (default value),
363 1 = spin up density,
364 2 = spin down density.
365 +--------------------------------------------------------------------
366
367
368 ENDIF
369 ________________________________________________________________________
370
371 ===END OF NAMELIST======================================================
372
373
374 ========================================================================
375 NAMELIST: &PLOT
376
377 +--------------------------------------------------------------------
378 Variable: nfile
379
380 Type: INTEGER
381 Default: 1
382 Status: OPTIONAL
383 Description: the number of data files to read
384 +--------------------------------------------------------------------
385
386 ///---
387 +--------------------------------------------------------------------
388 Variable: filepp(i), i=1,nfile
389
390 Type: CHARACTER
391 Default: filepp(1)=filplot
392 Description: nfile = 1 : file containing the quantity to be plotted
393 nfile &gt; 1 : see "weight"
394 +--------------------------------------------------------------------
395
396 +--------------------------------------------------------------------
397 Variable: weight(i), i=1,nfile
398
399 Type: REAL
400 Default: weight(1)=1.0
401 Description: weighing factors: assuming that rho(i) is the quantity
402 read from filepp(i), the quantity that will be plotted is:
403
404 weight(1)*rho(1) + weight(2)*rho(2) + weight(3)*rho(3) + ...
405 +--------------------------------------------------------------------
406
407 BEWARE: atomic coordinates are read from the first file;
408 if their number is different for different files,
409 the first file must have the largest number of atoms
410
411 \\\---
412
413 +--------------------------------------------------------------------
414 Variable: iflag
415
416 Type: INTEGER
417 Description: 0 = 1D plot of the spherical average
418 1 = 1D plot
419 2 = 2D plot
420 3 = 3D plot
421 4 = 2D polar plot on a sphere
422 +--------------------------------------------------------------------
423
424 +--------------------------------------------------------------------
425 Variable: output_format
426
427 Type: INTEGER
428 Description: (ignored on 1D plot)
429
430 0 = format suitable for gnuplot (1D)
431
432 1 = obsolete format no longer supported
433
434 2 = format suitable for plotrho (2D)
435
436 3 = format suitable for XCRYSDEN (2D or user-supplied 3D region)
437
438 4 = obsolete format no longer supported
439
440 5 = format suitable for XCRYSDEN (3D, using entire FFT grid)
441
442 6 = format as gaussian cube file (3D)
443 (can be read by many programs)
444
445 7 = format suitable for gnuplot (2D) x, y, f(x,y)
446 +--------------------------------------------------------------------
447
448 +--------------------------------------------------------------------
449 Variable: fileout
450
451 Type: CHARACTER
452 Default: standard output
453 Description: name of the file to which the plot is written
454 +--------------------------------------------------------------------
455
456 +--------------------------------------------------------------------
457 Variable: interpolation
458
459 Type: CHARACTER
460 Default: 'fourier'
461 Description:
462 Type of interpolation:
463 'fourier'
464
465 'bspline' :
466 (EXPERIMENTAL)
467 +--------------------------------------------------------------------
468
469 ________________________________________________________________________
470 * IF iflag = 0 or 1 :
471
472 THE FOLLOWING VARIABLES ARE REQUIRED:
473
474 +--------------------------------------------------------------------
475 Variable: e1(i), i=1,3
476
477 Type: REAL
478 Description: 3D vector which determines the plotting line (in alat units)
479 +--------------------------------------------------------------------
480
481 +--------------------------------------------------------------------
482 Variable: x0(i), i=1,3
483
484 Type: REAL
485 Description: 3D vector, origin of the line (in alat units)
486 +--------------------------------------------------------------------
487
488 +--------------------------------------------------------------------
489 Variable: nx
490
491 Type: INTEGER
492 Description: number of points in the line:
493
494 rho(i) = rho( x0 + e1 * (i-1)/(nx-1) ), i=1, nx
495 +--------------------------------------------------------------------
496
497
498 * ELSE IF iflag = 2 :
499
500 THE FOLLOWING VARIABLES ARE REQUIRED:
501
502 +--------------------------------------------------------------------
503 Variables: e1(i), e2(i), i=1,3
504
505 Type: REAL
506 Description: 3D vectors which determine the plotting plane (in alat units)
507
508 BEWARE: @b e1 and @b e2 must be orthogonal
509 +--------------------------------------------------------------------
510
511 +--------------------------------------------------------------------
512 Variable: x0(i), i=1,3
513
514 Type: REAL
515 Description: 3D vector, origin of the plane (in alat units)
516 +--------------------------------------------------------------------
517
518 +--------------------------------------------------------------------
519 Variables: nx, ny
520
521 Type: INTEGER
522 Description: Number of points in the plane:
523
524 rho(i,j) = rho( x0 + e1 * (i-1)/(nx-1)
525 + e2 * (j-1)/(ny-1) ), i=1,nx ; j=1,ny
526 +--------------------------------------------------------------------
527
528
529 * ELSE IF iflag = 3 :
530
531 THE FOLLOWING VARIABLES ARE OPTIONAL:
532
533 +--------------------------------------------------------------------
534 Variables: e1(i), e2(i), e3(i), i=1,3
535
536 Type: REAL
537 Description: 3D vectors which determine the plotting parallelepiped
538 (if present, must be orthogonal)
539
540 @ref e1, @ref e2, and @ref e3 are in alat units !
541 +--------------------------------------------------------------------
542
543 +--------------------------------------------------------------------
544 Variable: x0(i), i=1,3
545
546 Type: REAL
547 Description: 3D vector, origin of the parallelepiped
548
549 "x0" is in alat units !
550 +--------------------------------------------------------------------
551
552 +--------------------------------------------------------------------
553 Variables: nx, ny, nz
554
555 Type: INTEGER
556 Description: Number of points in the parallelepiped:
557
558 rho(i,j,k) = rho( x0 + e1 * (i-1)/nx
559 + e2 * (j-1)/ny
560 + e3 * (k-1)/nz ),
561 i = 1, nx ; j = 1, ny ; k = 1, nz
562
563 - If @ref output_format = 3 (XCRYSDEN), the above variables
564 are used to determine the grid to plot.
565
566 - If @ref output_format = 5 (XCRYSDEN), the above variables
567 are ignored, the entire FFT grid is written in the
568 XCRYSDEN format - works for any crystal axis (VERY FAST)
569
570 - If @ref e1, @ref e2, @ref e3, @ref x0 are present,
571 and @ref e1, @ref e2, @ref e3 are parallel to xyz
572 and parallel to crystal axis, a subset of the FFT
573 grid that approximately covers the parallelepiped
574 defined by @ref e1, @ref e2, @ref e3, @ref x0, is
575 written - untested, might be obsolete
576
577 - Otherwise, the required 3D grid is generated from the
578 Fourier components (may be VERY slow)
579 +--------------------------------------------------------------------
580
581
582 * ELSE IF iflag = 4 :
583
584 THE FOLLOWING VARIABLES ARE REQUIRED:
585
586 +--------------------------------------------------------------------
587 Variable: radius
588
589 Type: REAL
590 Description: Radius of the sphere (alat units), centered at (0,0,0)
591 +--------------------------------------------------------------------
592
593 +--------------------------------------------------------------------
594 Variables: nx, ny
595
596 Type: INTEGER
597 Description: Number of points in the polar plane:
598
599 phi(i) = 2 pi * (i - 1)/(nx-1), i=1, nx
600 theta(j) = pi * (j - 1)/(ny-1), j=1, ny
601 +--------------------------------------------------------------------
602
603
604 ENDIF
605 ________________________________________________________________________
606
607 ===END OF NAMELIST======================================================
608
609
610 This file has been created by helpdoc utility on Wed Dec 02 08:04:45 CET 2020
611
612 </pre>
613 </body>
614 </html>