You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/advanced/input_files/input-main.md
+47-42Lines changed: 47 additions & 42 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -539,7 +539,7 @@ These variables are used to control general system parameters.
539
539
-**Description**: The accuracy for symmetry analysis. Typically, the default value is good enough, but if the lattice parameters or atom positions in STRU file are not accurate enough, this value should be enlarged.
540
540
> Note: if *[calculation](#calculation)==cell_relax*, this value can be dynamically changed corresponding to the variation of accuracy of the lattice parameters and atom positions during the relaxation. The new value will be printed in `OUT.${suffix}/running_cell-relax.log` in that case.
541
541
-**Default**: 1.0e-6
542
-
-**Unit**: Bohr
542
+
-**Unit**: Bohr
543
543
544
544
### symmetry_autoclose
545
545
@@ -574,7 +574,7 @@ These variables are used to control general system parameters.
574
574
- bcc: body-centered cubic
575
575
- hexagonal: hexagonal
576
576
- trigonal: trigonal
577
-
- st: simple tetragona
577
+
- st: simple tetragonal
578
578
- bct: body-centered tetragonal
579
579
- so: orthorhombic
580
580
- baco: base-centered orthorhombic
@@ -771,15 +771,17 @@ These variables are used to control the plane wave related parameters.
771
771
### ecutwfc
772
772
773
773
-**Type**: Real
774
-
-**Description**: Energy cutoff for plane wave functions, the unit is **Rydberg**. Note that even for localized orbitals basis, you still need to setup an energy cutoff for this system. Because our local pseudopotential parts and the related force are calculated from plane wave basis set, etc. Also, because our orbitals are generated by matching localized orbitals to a chosen set of wave functions from a certain energy cutoff, this set of localize orbitals is most accurate under this same plane wave energy cutoff.
774
+
-**Description**: Energy cutoff for plane wave functions. Note that even for localized orbitals basis, you still need to setup an energy cutoff for this system. Because our local pseudopotential parts and the related force are calculated from plane wave basis set, etc. Also, because our orbitals are generated by matching localized orbitals to a chosen set of wave functions from a certain energy cutoff, this set of localize orbitals is most accurate under this same plane wave energy cutoff.
775
775
> `ecutwfc` and `ecutrho` can be set simultaneously. Besides, if only one parameter is set, abacus will automatically set another parameter based on the 4-time relationship. If both parameters are not set, the default values will be employed.
776
-
-**Default**: 50 Ry (PW basis), 100 Ry (LCAO basis)
776
+
-**Default**: 50 for PW basis, 100 for LCAO basis
777
+
-**Unit**: Ry
777
778
778
779
### ecutrho
779
780
780
781
-**Type**: Real
781
-
-**Description**: Energy cutoff for charge density and potential, the unit is **Rydberg**. For norm-conserving pseudopotential you should stick to the default value, you can reduce it by a little but it will introduce noise especially on forces and stress. For ultrasoft pseudopotential a larger value than the default is often desirable (`ecutrho` = 8 to 12 times `ecutwfc`, typically). The use of gradient-corrected functional, especially in cells with vacuum, or for pseudopotential without non-linear core correction, usually requires an higher values of `ecutrho` to be accurately converged.
782
+
-**Description**: Energy cutoff for charge density and potential. For norm-conserving pseudopotential you should stick to the default value, you can reduce it by a little but it will introduce noise especially on forces and stress. For ultrasoft pseudopotential a larger value than the default is often desirable (`ecutrho` = 8 to 12 times `ecutwfc`, typically). The use of gradient-corrected functional, especially in cells with vacuum, or for pseudopotential without non-linear core correction, usually requires an higher values of `ecutrho` to be accurately converged.
782
783
-**Default**: 4*ecutwfc
784
+
-**Unit**: Ry
783
785
784
786
### nx, ny, nz
785
787
@@ -897,20 +899,23 @@ These variables are used to control the numerical atomic orbitals related parame
897
899
### lcao_dk
898
900
899
901
-**Type**: Real
900
-
-**Description**: k spacing (in Bohr${}^{-1}$) for two-center integrals. The two-center integration table are obtained via a k space integral on a uniform grid with spacing `lcao_dk`.
902
+
-**Description**: the interval of k points for two-center integrals. The two-center integration table are obtained via a k space integral on a uniform grid with spacing `lcao_dk`.
901
903
-**Default**: 0.01
904
+
-**Unit**: Bohr${}^{-1}$
902
905
903
906
### lcao_dr
904
907
905
908
-**Type**: Real
906
-
-**Description**: r spacing (in Bohr) of the integration table of two-center integrals.
909
+
-**Description**: r spacing of the integration table of two-center integrals.
907
910
-**Default**: 0.01
911
+
-**Unit**: Bohr
908
912
909
913
### lcao_rmax
910
914
911
915
-**Type**: Real
912
-
-**Description**: Maximum distance (in Bohr) for the two-center integration table.
916
+
-**Description**: Maximum distance for the two-center integration table.
913
917
-**Default**: 30
918
+
-**Unit**: Bohr
914
919
915
920
### search_radius
916
921
@@ -984,8 +989,8 @@ calculations.
984
989
985
990
Then the user has to correct the input file and restart the calculation.
986
991
-**Default**:
987
-
-**PW basis**: cg.
988
-
-**LCAO basis**:
992
+
- PW basis: cg.
993
+
- LCAO basis:
989
994
- genelpa (if compiling option `USE_ELPA` has been set)
990
995
- lapack (if compiling option `ENABLE_MPI` has not been set)
991
996
- scalapack_gvx (if compiling option `USE_ELPA` has not been set and compiling option `ENABLE_MPI` has been set)
@@ -1186,26 +1191,26 @@ Note: In new angle mixing, you should set `mixing_beta_mag >> mixing_beta`. The
1186
1191
-**Type**: Boolean
1187
1192
-**Availability**: Only relevant for meta-GGA calculations.
1188
1193
-**Description**: Whether to mix the kinetic energy density.
1189
-
-**True**: The kinetic energy density will also be mixed. It seems for general cases, SCF converges fine even without this mixing. However, if there is difficulty in converging SCF for meta-GGA, it might be helpful to turn this on.
1190
-
-**False**: The kinetic energy density will not be mixed.
1194
+
- True: The kinetic energy density will also be mixed. It seems for general cases, SCF converges fine even without this mixing. However, if there is difficulty in converging SCF for meta-GGA, it might be helpful to turn this on.
1195
+
- False: The kinetic energy density will not be mixed.
1191
1196
-**Default**: False
1192
1197
1193
1198
### mixing_dftu
1194
1199
1195
1200
-**Type**: Boolean
1196
1201
-**Availability**: Only relevant for DFT+U calculations.
1197
1202
-**Description**: Whether to mix the occupation matrices.
1198
-
-**True**: The occupation matrices will also be mixed by plain mixing. From experience this is not very helpful if the +U calculation does not converge.
1199
-
-**False**: The occupation matrices will not be mixed.
1203
+
- True: The occupation matrices will also be mixed by plain mixing. From experience this is not very helpful if the +U calculation does not converge.
1204
+
- False: The occupation matrices will not be mixed.
1200
1205
-**Default**: False
1201
1206
1202
1207
### gamma_only
1203
1208
1204
1209
-**Type**: Integer
1205
1210
-**Availability**: Only used in localized orbitals set
1206
1211
-**Description**: Whether to use gamma_only algorithm.
1207
-
-**0**: more than one k-point is used and the ABACUS is slower compared to the gamma only algorithm.
1208
-
-**1**: ABACUS uses gamma only, the algorithm is faster and you don't need to specify the k-points file.
1212
+
-0: more than one k-point is used and the ABACUS is slower compared to the gamma only algorithm.
1213
+
-1: ABACUS uses gamma only, the algorithm is faster and you don't need to specify the k-points file.
1209
1214
1210
1215
Note: If gamma_only is set to 1, the KPT file will be overwritten. So make sure to turn off gamma_only for multi-k calculations.
1211
1216
@@ -1241,8 +1246,8 @@ Note: In new angle mixing, you should set `mixing_beta_mag >> mixing_beta`. The
1241
1246
1242
1247
-**Type**: Integer
1243
1248
-**Description**: Choose the calculation method of convergence criterion.
1244
-
-**1**: the criterion is defined as $\Delta\rho_G = \frac{1}{2}\iint{\frac{\Delta\rho(r)\Delta\rho(r')}{|r-r'|}d^3r d^3r'}$, which is used in SCF of PW basis with unit Ry.
1245
-
-**2**: the criterion is defined as $\Delta\rho_R = \frac{1}{N_e}\int{|\Delta\rho(r)|d^3r}$, where $N_e$ is the number of electron, which is used in SCF of LCAO with unit **dimensionless**.
1249
+
-1: the criterion is defined as $\Delta\rho_G = \frac{1}{2}\iint{\frac{\Delta\rho(r)\Delta\rho(r')}{|r-r'|}d^3r d^3r'}$, which is used in SCF of PW basis with unit Ry.
1250
+
-2: the criterion is defined as $\Delta\rho_R = \frac{1}{N_e}\int{|\Delta\rho(r)|d^3r}$, where $N_e$ is the number of electron, which is used in SCF of LCAO with unit **dimensionless**.
1246
1251
1247
1252
-**Default**: 1 (plane-wave basis), or 2 (localized atomic orbital basis).
1248
1253
@@ -1251,8 +1256,8 @@ Note: In new angle mixing, you should set `mixing_beta_mag >> mixing_beta`. The
1251
1256
-**Type**: bool
1252
1257
-**Description**: For systems that are difficult to converge, the SCF process may exhibit oscillations in charge density, preventing further progress toward the specified convergence criteria and resulting in continuous oscillation until the maximum number of steps is reached; this greatly wastes computational resources. To address this issue, this function allows ABACUS to terminate the SCF process early upon detecting oscillations, thus reducing subsequent meaningless calculations. The detection of oscillations is based on the slope of the logarithm of historical drho values.. To this end, Least Squares Method is used to calculate the slope of the logarithmically taken drho for the previous `scf_os_ndim` iterations. If the calculated slope is larger than `scf_os_thr`, stop the SCF.
1253
1258
1254
-
-**0**: The SCF will continue to run regardless of whether there is oscillation or not.
1255
-
-**1**: If the calculated slope is larger than `scf_os_thr`, stop the SCF.
1259
+
-0: The SCF will continue to run regardless of whether there is oscillation or not.
1260
+
-1: If the calculated slope is larger than `scf_os_thr`, stop the SCF.
1256
1261
1257
1262
-**Default**: false
1258
1263
@@ -1279,25 +1284,25 @@ Note: In new angle mixing, you should set `mixing_beta_mag >> mixing_beta`. The
1279
1284
1280
1285
-**Type**: String
1281
1286
-**Description**: Methods to do extrapolation of density when ABACUS is doing geometry relaxations or molecular dynamics.
-**Description**: Whether to consider spin-orbital coupling effect in the calculation.
1291
-
-**True**: Consider spin-orbital coupling effect, and `nspin` is also automatically set to 4.
1292
-
-**False**: Do not consider spin-orbital coupling effect.
1296
+
- True: Consider spin-orbital coupling effect, and `nspin` is also automatically set to 4.
1297
+
- False: Do not consider spin-orbital coupling effect.
1293
1298
-**Default**: False
1294
1299
1295
1300
### noncolin
1296
1301
1297
1302
-**Type**: Boolean
1298
1303
-**Description**: Whether to allow non-collinear polarization, in which case the coupling between spin up and spin down will be taken into account.
1299
-
-**True**: Allow non-collinear polarization, and `nspin` is also automatically set to 4.
1300
-
-**False**: Do not allow non-collinear polarization.
1304
+
- True: Allow non-collinear polarization, and `nspin` is also automatically set to 4.
1305
+
- False: Do not allow non-collinear polarization.
1301
1306
-**Default**: False
1302
1307
1303
1308
### soc_lambda
@@ -1454,14 +1459,14 @@ These variables are used to control the geometry relaxation.
1454
1459
### force_thr
1455
1460
1456
1461
-**Type**: Real
1457
-
-**Description**: Threshold of the force convergence in Ry/Bohr. The threshold is compared with the largest force among all of the atoms. The recommended value for using atomic orbitals is 0.04 eV/Angstrom (0.0016 Ry/Bohr). The parameter is equivalent to [force_thr_ev](#force_thr_ev) except for the unit. You may choose either you like.
1462
+
-**Description**: Threshold of the force convergence. The threshold is compared with the largest force among all of the atoms. The recommended value for using atomic orbitals is 0.04 eV/Angstrom (0.0016 Ry/Bohr). The parameter is equivalent to [force_thr_ev](#force_thr_ev) except for the unit, you can choose either you like.
1458
1463
-**Default**: 0.001
1459
1464
-**Unit**: Ry/Bohr (25.7112 eV/Angstrom)
1460
1465
1461
1466
### force_thr_ev
1462
1467
1463
1468
-**Type**: Real
1464
-
-**Description**: Threshold of the force convergence in eV/Angstrom. The threshold is compared with the largest force among all of the atoms. The recommended value for using atomic orbitals is 0.04 eV/Angstrom (0.0016 Ry/Bohr). The parameter is equivalent to [force_thr](#force_thr) except for the unit. You may choose either you like.
1469
+
-**Description**: Threshold of the force convergence. The threshold is compared with the largest force among all of the atoms. The recommended value for using atomic orbitals is 0.04 eV/Angstrom (0.0016 Ry/Bohr). The parameter is equivalent to [force_thr](#force_thr) except for the unit. You may choose either you like.
1465
1470
-**Default**: 0.0257112
1466
1471
-**Unit**: eV/Angstrom (0.03889 Ry/Bohr)
1467
1472
@@ -1532,15 +1537,15 @@ These variables are used to control the geometry relaxation.
1532
1537
-**Type**: String
1533
1538
-**Availability**: only used when `calculation` set to `cell-relax`
1534
1539
-**Description**: Axes that are fixed during cell relaxation. Possible choices are:
1535
-
-**None**: default; all of the axes can relax
1536
-
-**volume**: relaxation with fixed volume
1537
-
-**shape**: fix shape but change volume (i.e. only lattice constant changes)
1538
-
-**a**: fix a axis during relaxation
1539
-
-**b**: fix b axis during relaxation
1540
-
-**c**: fix c axis during relaxation
1541
-
-**ab**: fix both a and b axes during relaxation
1542
-
-**ac**: fix both a and c axes during relaxation
1543
-
-**bc**: fix both b and c axes during relaxation
1540
+
- None**: default; all of the axes can relax
1541
+
- volume**: relaxation with fixed volume
1542
+
- shape**: fix shape but change volume (i.e. only lattice constant changes)
1543
+
-a: fix a axis during relaxation
1544
+
-b: fix b axis during relaxation
1545
+
-c: fix c axis during relaxation
1546
+
-ab: fix both a and b axes during relaxation
1547
+
-ac: fix both a and c axes during relaxation
1548
+
-bc: fix both b and c axes during relaxation
1544
1549
1545
1550
> Note : fixed_axes = "shape" and "volume" are only available for [relax_new](#relax_new) = True
1546
1551
@@ -1551,8 +1556,8 @@ These variables are used to control the geometry relaxation.
1551
1556
-**Type**: Boolean
1552
1557
-**Availability**: Must be used along with [relax_new](#relax_new) set to True, and a specific [latname](#latname) must be provided
1553
1558
-**Description**:
1554
-
-**True**: the lattice type will be preserved during relaxation
1555
-
-**False**: No restrictions are exerted during relaxation in terms of lattice type
1559
+
- True: the lattice type will be preserved during relaxation
1560
+
- False: No restrictions are exerted during relaxation in terms of lattice type
1556
1561
1557
1562
> Note: it is possible to use `fixed_ibrav` with `fixed_axes`, but please make sure you know what you are doing. For example, if we are doing relaxation of a simple cubic lattice (`latname` = "sc"), and we use `fixed_ibrav` along with `fixed_axes` = "volume", then the cell is never allowed to move and as a result, the relaxation never converges.
1558
1563
@@ -1562,8 +1567,8 @@ These variables are used to control the geometry relaxation.
1562
1567
1563
1568
-**Type**: Boolean
1564
1569
-**Description**:
1565
-
-**True**: The direct coordinates of atoms will be preserved during variable-cell relaxation.
1566
-
-**False**: No restrictions are exerted on positions of all atoms. However, users can still fix certain components of certain atoms by using the `m` keyword in `STRU` file. For the latter option, check the end of this [instruction](stru.md).
1570
+
- True: The direct coordinates of atoms will be preserved during variable-cell relaxation.
1571
+
- False: No restrictions are exerted on positions of all atoms. However, users can still fix certain components of certain atoms by using the `m` keyword in `STRU` file. For the latter option, check the end of this [instruction](stru.md).
0 commit comments