Debian Codegraph @

GUI/PWgui/doc/pwdocs/INPUT_NEB.html

raw
1
2 <html>
3 <body>
4 <pre>
5
6 ------------------------------------------------------------------------
7 INPUT FILE DESCRIPTION
8
9 Program: neb.x / NEB / 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
17
18 BEWARE: TABS, DOS &lt;CR&gt;&lt;LF&gt; CHARACTERS ARE POTENTIAL SOURCES OF TROUBLE
19
20 neb.x DOES NOT READ FROM STANDARD INPUT !
21
22 There are two ways for running a calculation with neb.x:
23
24 (1) specifying a file to parse with the ./neb.x -inp or ./neb.x -input
25 command line option.
26
27 (2) or specifying the number of copies of PWscf inputs with the ./neb.x -input_images
28
29 For case (1) a file containing special KEYWORDS (aka SUPERCARDS) has to be
30 written (see below). These KEYWORDS tell the parser which part of the file
31 contains the neb specifics and which part contains the energy/force engine
32 input (at the moment only PW). After the parsing, different files are
33 generated: neb.dat, with the neb specific variables, and a set of pw_*.in
34 PWscf input files, i.e., one for each input position. All options for a
35 single SCF calculation apply.
36
37 The general structure of the file to be parsed is:
38 ==================================================
39
40 BEGIN
41 BEGIN_PATH_INPUT
42 ... neb specific namelists and cards
43 END_PATH_INPUT
44
45 BEGIN_ENGINE_INPUT
46 ...pw specific namelists and cards
47 BEGIN_POSITIONS
48 FIRST_IMAGE
49 ...pw ATOMIC_POSITIONS card
50 INTERMEDIATE_IMAGE
51 ...pw ATOMIC_POSITIONS card
52 LAST_IMAGE
53 ...pw ATOMIC_POSITIONS card
54 END_POSITIONS
55 ... other pw specific cards
56 END_ENGINE_INPUT
57 END
58
59
60 For case (2) neb.dat and all pw_1.in, pw_2.in ... should be already present.
61
62 Structure of the NEB-only input data (file neb.dat):
63 ====================================================
64
65 &PATH
66 ...
67 /
68
69 [ CLIMBING_IMAGES
70 list of images, separated by a comma ]
71
72
73
74 ########################################################################
75 | SUPERCARD: BEGIN/END
76 | this supercard is enclosed within the keywords:
77 |
78 | BEGIN
79 | ... content of the supercard here ...
80 | END
81 |
82 | The syntax of supercard's content follows below:
83
84 ########################################################################
85 | SUPERCARD: BEGIN_PATH_INPUT/END_PATH_INPUT
86 | this supercard is enclosed within the keywords:
87 |
88 | BEGIN_PATH_INPUT
89 | ... content of the supercard here ...
90 | END_PATH_INPUT
91 |
92 | The syntax of supercard's content follows below:
93
94 ========================================================================
95 NAMELIST: &PATH
96
97 +--------------------------------------------------------------------
98 Variable: string_method
99
100 Type: CHARACTER
101 Default: 'neb'
102 Description:
103 A string describing the task to be performed. Options are:
104
105 'neb' :
106 nudget-elastic-band
107
108 'smd' :
109 string-method-dynamics
110 +--------------------------------------------------------------------
111
112 +--------------------------------------------------------------------
113 Variable: restart_mode
114
115 Type: CHARACTER
116 Default: 'from_scratch'
117 Description:
118 Options are:
119
120 'from_scratch' :
121 from scratch
122
123 'restart' :
124 from previous interrupted run
125 +--------------------------------------------------------------------
126
127 +--------------------------------------------------------------------
128 Variable: nstep_path
129
130 Type: INTEGER
131 Description: number of ionic + electronic steps
132 Default: 1
133 +--------------------------------------------------------------------
134
135 +--------------------------------------------------------------------
136 Variable: num_of_images
137
138 Type: INTEGER
139 Default: 0
140 Description: Number of points used to discretize the path
141 (it must be larger than 3).
142 +--------------------------------------------------------------------
143
144 +--------------------------------------------------------------------
145 Variable: opt_scheme
146
147 Type: CHARACTER
148 Default: 'quick-min'
149 Description:
150 Specify the type of optimization scheme:
151
152 'sd' :
153 steepest descent
154
155 'broyden' :
156 quasi-Newton Broyden's second method (suggested)
157
158 'broyden2' :
159 another variant of the quasi-Newton Broyden's
160 second method to be tested and compared with the
161 previous one.
162
163 'quick-min' :
164 an optimisation algorithm based on the
165 projected velocity Verlet scheme
166
167 'langevin' :
168 finite temperature langevin dynamics of the
169 string (smd only). It is used to compute the
170 average path and the free-energy profile.
171 +--------------------------------------------------------------------
172
173 +--------------------------------------------------------------------
174 Variable: CI_scheme
175
176 Type: CHARACTER
177 Default: 'no-CI'
178 Description:
179 Specify the type of Climbing Image scheme:
180
181 'no-CI' :
182 climbing image is not used
183
184 'auto' :
185 original CI scheme. The image highest in energy
186 does not feel the effect of springs and is
187 allowed to climb along the path
188
189 'manual' :
190 images that have to climb are manually selected.
191 See also "CLIMBING_IMAGES" card
192 +--------------------------------------------------------------------
193
194 +--------------------------------------------------------------------
195 Variable: first_last_opt
196
197 Type: LOGICAL
198 Default: .FALSE.
199 Description: Also the first and the last configurations are optimized
200 "on the fly" (these images do not feel the effect of the springs).
201 +--------------------------------------------------------------------
202
203 +--------------------------------------------------------------------
204 Variable: minimum_image
205
206 Type: LOGICAL
207 Default: .FALSE.
208 Description: Assume a "minimum image criterion" to build the path. If an atom
209 moves by more than half the length of a crystal axis between one
210 image and the next in the input (before interpolation),
211 an appropriate periodic replica of that atom is chosen.
212 Useful to avoid jumps in the initial reaction path.
213 +--------------------------------------------------------------------
214
215 +--------------------------------------------------------------------
216 Variable: temp_req
217
218 Type: REAL
219 Default: 0.D0 Kelvin
220 Description: Temperature used for the langevin dynamics of the string.
221 +--------------------------------------------------------------------
222
223 +--------------------------------------------------------------------
224 Variable: ds
225
226 Type: REAL
227 Default: 1.D0
228 Description: Optimisation step length ( Hartree atomic units ).
229 If "opt_scheme"=="broyden", ds is used as a guess for the
230 diagonal part of the Jacobian matrix.
231 +--------------------------------------------------------------------
232
233 +--------------------------------------------------------------------
234 Variables: k_max, k_min
235
236 Type: REAL
237 Default: 0.1D0 Hartree atomic units
238 Description: Set them to use a Variable Elastic Constants scheme
239 elastic constants are in the range [ k_min, k_max ]
240 this is useful to rise the resolution around the saddle point.
241 +--------------------------------------------------------------------
242
243 +--------------------------------------------------------------------
244 Variable: path_thr
245
246 Type: REAL
247 Default: 0.05D0 eV / Angstrom
248 Description: The simulation stops when the error ( the norm of the force
249 orthogonal to the path in eV/A ) is less than path_thr.
250 +--------------------------------------------------------------------
251
252 +--------------------------------------------------------------------
253 Variable: use_masses
254
255 Type: LOGICAL
256 Default: .FALSE.
257 Description: If. TRUE. the optimisation of the path is performed using
258 mass-weighted coordinates. Useful together with quick-min
259 optimization scheme, if some bonds are much stiffer than
260 others. By assigning a larger (fictitious) mass to atoms
261 with stiff bonds, one may use a longer time step "ds"
262 +--------------------------------------------------------------------
263
264 +--------------------------------------------------------------------
265 Variable: use_freezing
266
267 Type: LOGICAL
268 Default: .FALSE.
269 Description: If. TRUE. the images are optimised according to their error:
270 only those images with an error larger than half of the largest
271 are optimised. The other images are kept frozen.
272 +--------------------------------------------------------------------
273
274 +--------------------------------------------------------------------
275 Variable: lfcpopt
276
277 Type: LOGICAL
278 See: fcp_mu
279 Default: .FALSE.
280 Description: If .TRUE. perform a constant bias potential (constant-mu)
281 calculation with ESM method (assume_isolated = 'esm' and
282 esm_bc = 'bc2' or 'bc3' must be set in SYSTEM namelist).
283 "fcp_mu" gives the target Fermi energy.
284 See the header of PW/src/fcp.f90 for documentation
285 +--------------------------------------------------------------------
286
287 +--------------------------------------------------------------------
288 Variable: fcp_mu
289
290 Type: REAL
291 See: lfcpopt
292 Default: 0.d0
293 Description: If "lfcpopt" == .TRUE., gives the target Fermi energy [Ry].
294 One can specify the total charge of the system for the first
295 and last image by giving "fcp_tot_charge_first" and "fcp_tot_charge_last"
296 so that the Fermi energy of these systems will be the target value,
297 otherwise "first_last_opt" should be .TRUE.
298 +--------------------------------------------------------------------
299
300 +--------------------------------------------------------------------
301 Variable: fcp_tot_charge_first
302
303 Type: REAL
304 See: lfcpopt
305 Default: 0.d0
306 Description: Total charge of the system ('tot_charge') for the first image.
307 Initial 'tot_charge' for intermediate images will be given by
308 linear interpolation of "fcp_tot_charge_first" and "fcp_tot_charge_last"
309 +--------------------------------------------------------------------
310
311 +--------------------------------------------------------------------
312 Variable: fcp_tot_charge_last
313
314 Type: REAL
315 See: lfcpopt
316 Default: 0.d0
317 Description: Total charge of the system ('tot_charge') for the last image.
318 Initial 'tot_charge' for intermediate images will be given by
319 linear interpolation of "fcp_tot_charge_first" and "fcp_tot_charge_last"
320 +--------------------------------------------------------------------
321
322 ===END OF NAMELIST======================================================
323
324
325 ========================================================================
326 CARD: CLIMBING_IMAGES
327
328 OPTIONAL CARD, NEEDED ONLY IF "CI_SCHEME" == 'MANUAL', IGNORED OTHERWISE !
329
330 /////////////////////////////////////////
331 // Syntax: //
332 /////////////////////////////////////////
333
334 CLIMBING_IMAGES
335 index1, index2, ... indexN
336
337 /////////////////////////////////////////
338
339 DESCRIPTION OF ITEMS:
340
341 +--------------------------------------------------------------------
342 Variables: index1, index2, ... indexN
343
344 Type: INTEGER
345 Description: index1, index2, ..., indexN are indices of the images to which the
346 Climbing-Image procedure apply. If more than one image is specified
347 they must be separated by a comma.
348 +--------------------------------------------------------------------
349
350
351 ===END OF CARD==========================================================
352
353
354 ### END OF SUPERCARD : BEGIN_PATH_INPUT/END_PATH_INPUT ################
355
356
357 ########################################################################
358 | SUPERCARD: BEGIN_ENGINE_INPUT/END_ENGINE_INPUT
359 | this supercard is enclosed within the keywords:
360 |
361 | BEGIN_ENGINE_INPUT
362 | ... content of the supercard here ...
363 | END_ENGINE_INPUT
364 |
365 | The syntax of supercard's content follows below:
366
367 Here comes the pw.x specific namelists and cards (see file: "" or INPUT_PW.txt)
368 with the exception of "ATOMIC_POSITIONS" cards, which are specified separately within the
369 "BEGIN_POSITIONS"/END_POSITIONS supercard as described below.
370
371 So the input that follows here is of the following structure:
372
373 &CONTROL
374 ...
375 /
376 &SYSTEM
377 ...
378 /
379 &ELECTRONS
380 ...
381 /
382 ...
383
384 ########################################################################
385 | SUPERCARD: BEGIN_POSITIONS/END_POSITIONS
386 | this supercard is enclosed within the keywords:
387 |
388 | BEGIN_POSITIONS
389 | ... content of the supercard here ...
390 | END_POSITIONS
391 |
392 | The syntax of supercard's content follows below:
393
394 NB:
395 Atomic positions for all the images are specified within the "BEGIN_POSITIONS" / END_POSITIONS
396 supercard, where each instance of "ATOMIC_POSITIONS" card is prefixed either by "FIRST_IMAGE",
397 "INTERMEDIATE_IMAGE", or "LAST_IMAGE" keywords.
398
399 Note that intermediate images are optional, i.e., there can be none or any number of
400 "INTERMEDIATE_IMAGE" images.
401
402 ########################################################################
403 | SUPERCARD: FIRST_IMAGE
404 | this supercard starts with the keyword:
405 |
406 | FIRST_IMAGE
407 | ... content of the supercard here ...
408 |
409 | The syntax of supercard's content follows below:
410
411 ========================================================================
412 CARD: ATOMIC_POSITIONS { alat | bohr | angstrom | crystal | crystal_sg }
413
414 For the description of ATOMIC_POSITIONS card see file: "" or INPUT_PW.txt
415
416 ===END OF CARD==========================================================
417
418
419 ### END OF SUPERCARD : FIRST_IMAGE ####################################
420
421
422 ########################################################################
423 | SUPERCARD: INTERMEDIATE_IMAGE
424 | this supercard starts with the keyword:
425 |
426 | INTERMEDIATE_IMAGE
427 | ... content of the supercard here ...
428 |
429 | REMARK:
430 | There can be any number (including zero) of INTERMEDIATE_IMAGE supercards.
431 |
432 | The syntax of supercard's content follows below:
433
434 ========================================================================
435 CARD: ATOMIC_POSITIONS { alat | bohr | angstrom | crystal | crystal_sg }
436
437 For the description of ATOMIC_POSITIONS card see file: "" or INPUT_PW.txt
438
439 ===END OF CARD==========================================================
440
441
442 ### END OF SUPERCARD : INTERMEDIATE_IMAGE #############################
443
444
445 ########################################################################
446 | SUPERCARD: LAST_IMAGE
447 | this supercard starts with the keyword:
448 |
449 | LAST_IMAGE
450 | ... content of the supercard here ...
451 |
452 | The syntax of supercard's content follows below:
453
454 ========================================================================
455 CARD: ATOMIC_POSITIONS { alat | bohr | angstrom | crystal | crystal_sg }
456
457 For the description of ATOMIC_POSITIONS card see file: "" or INPUT_PW.txt
458
459 ===END OF CARD==========================================================
460
461
462 ### END OF SUPERCARD : LAST_IMAGE #####################################
463
464
465 ### END OF SUPERCARD : BEGIN_POSITIONS/END_POSITIONS ##################
466
467
468 Here can follow other pw specific cards ...
469
470 ### END OF SUPERCARD : BEGIN_ENGINE_INPUT/END_ENGINE_INPUT ############
471
472
473 ### END OF SUPERCARD : BEGIN/END ######################################
474
475
476 This file has been created by helpdoc utility on Wed Dec 02 08:04:42 CET 2020
477
478 </pre>
479 </body>
480 </html>