Skip to content

Commit e324425

Browse files
committed
update documents
1 parent 9bc15ba commit e324425

File tree

1 file changed

+47
-42
lines changed

1 file changed

+47
-42
lines changed

docs/advanced/input_files/input-main.md

Lines changed: 47 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -539,7 +539,7 @@ These variables are used to control general system parameters.
539539
- **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.
540540
> 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.
541541
- **Default**: 1.0e-6
542-
- **Unit**: Bohr
542+
- **Unit**: Bohr
543543

544544
### symmetry_autoclose
545545

@@ -574,7 +574,7 @@ These variables are used to control general system parameters.
574574
- bcc: body-centered cubic
575575
- hexagonal: hexagonal
576576
- trigonal: trigonal
577-
- st: simple tetragona
577+
- st: simple tetragonal
578578
- bct: body-centered tetragonal
579579
- so: orthorhombic
580580
- baco: base-centered orthorhombic
@@ -771,15 +771,17 @@ These variables are used to control the plane wave related parameters.
771771
### ecutwfc
772772

773773
- **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.
775775
> `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
777778

778779
### ecutrho
779780

780781
- **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.
782783
- **Default**: 4*ecutwfc
784+
- **Unit**: Ry
783785

784786
### nx, ny, nz
785787

@@ -897,20 +899,23 @@ These variables are used to control the numerical atomic orbitals related parame
897899
### lcao_dk
898900

899901
- **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`.
901903
- **Default**: 0.01
904+
- **Unit**: Bohr${}^{-1}$
902905

903906
### lcao_dr
904907

905908
- **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.
907910
- **Default**: 0.01
911+
- **Unit**: Bohr
908912

909913
### lcao_rmax
910914

911915
- **Type**: Real
912-
- **Description**: Maximum distance (in Bohr) for the two-center integration table.
916+
- **Description**: Maximum distance for the two-center integration table.
913917
- **Default**: 30
918+
- **Unit**: Bohr
914919

915920
### search_radius
916921

@@ -984,8 +989,8 @@ calculations.
984989

985990
Then the user has to correct the input file and restart the calculation.
986991
- **Default**:
987-
- **PW basis**: cg.
988-
- **LCAO basis**:
992+
- PW basis: cg.
993+
- LCAO basis:
989994
- genelpa (if compiling option `USE_ELPA` has been set)
990995
- lapack (if compiling option `ENABLE_MPI` has not been set)
991996
- 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
11861191
- **Type**: Boolean
11871192
- **Availability**: Only relevant for meta-GGA calculations.
11881193
- **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.
11911196
- **Default**: False
11921197

11931198
### mixing_dftu
11941199

11951200
- **Type**: Boolean
11961201
- **Availability**: Only relevant for DFT+U calculations.
11971202
- **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.
12001205
- **Default**: False
12011206

12021207
### gamma_only
12031208

12041209
- **Type**: Integer
12051210
- **Availability**: Only used in localized orbitals set
12061211
- **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.
12091214

12101215
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.
12111216

@@ -1241,8 +1246,8 @@ Note: In new angle mixing, you should set `mixing_beta_mag >> mixing_beta`. The
12411246

12421247
- **Type**: Integer
12431248
- **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**.
12461251

12471252
- **Default**: 1 (plane-wave basis), or 2 (localized atomic orbital basis).
12481253

@@ -1251,8 +1256,8 @@ Note: In new angle mixing, you should set `mixing_beta_mag >> mixing_beta`. The
12511256
- **Type**: bool
12521257
- **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.
12531258

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.
12561261

12571262
- **Default**: false
12581263

@@ -1279,25 +1284,25 @@ Note: In new angle mixing, you should set `mixing_beta_mag >> mixing_beta`. The
12791284

12801285
- **Type**: String
12811286
- **Description**: Methods to do extrapolation of density when ABACUS is doing geometry relaxations or molecular dynamics.
1282-
- **atomic**: atomic extrapolation.
1283-
- **first-order**: first-order extrapolation.
1284-
- **second-order**: second-order extrapolation.
1287+
- atomic: atomic extrapolation.
1288+
- first-order: first-order extrapolation.
1289+
- second-order: second-order extrapolation.
12851290
- **Default**: first-order (geometry relaxations), second-order (molecular dynamics), else atomic
12861291

12871292
### lspinorb
12881293

12891294
- **Type**: Boolean
12901295
- **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.
12931298
- **Default**: False
12941299

12951300
### noncolin
12961301

12971302
- **Type**: Boolean
12981303
- **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.
13011306
- **Default**: False
13021307

13031308
### soc_lambda
@@ -1454,14 +1459,14 @@ These variables are used to control the geometry relaxation.
14541459
### force_thr
14551460

14561461
- **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.
14581463
- **Default**: 0.001
14591464
- **Unit**: Ry/Bohr (25.7112 eV/Angstrom)
14601465

14611466
### force_thr_ev
14621467

14631468
- **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.
14651470
- **Default**: 0.0257112
14661471
- **Unit**: eV/Angstrom (0.03889 Ry/Bohr)
14671472

@@ -1532,15 +1537,15 @@ These variables are used to control the geometry relaxation.
15321537
- **Type**: String
15331538
- **Availability**: only used when `calculation` set to `cell-relax`
15341539
- **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
15441549

15451550
> Note : fixed_axes = "shape" and "volume" are only available for [relax_new](#relax_new) = True
15461551
@@ -1551,8 +1556,8 @@ These variables are used to control the geometry relaxation.
15511556
- **Type**: Boolean
15521557
- **Availability**: Must be used along with [relax_new](#relax_new) set to True, and a specific [latname](#latname) must be provided
15531558
- **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
15561561

15571562
> 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.
15581563
@@ -1562,8 +1567,8 @@ These variables are used to control the geometry relaxation.
15621567

15631568
- **Type**: Boolean
15641569
- **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).
15671572
- **Default**: False
15681573

15691574
### cell_factor

0 commit comments

Comments
 (0)