Skip to content

Commit a6389c6

Browse files
committed
update input-main
1 parent 0ffead9 commit a6389c6

File tree

1 file changed

+29
-30
lines changed

1 file changed

+29
-30
lines changed

docs/advanced/input_files/input-main.md

Lines changed: 29 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1005,23 +1005,22 @@ calculations.
10051005
- **Type**: Real
10061006
- **Description**:
10071007

1008-
- 0.0: the total number of electrons will be calculated by the sum of valence electrons (i.e. assuming neutral system).
1008+
- 0.0: The total number of electrons will be calculated by the sum of valence electrons (i.e. assuming neutral system).
10091009
- `>0.0`: this denotes the total number of electrons in the system. Must be less than 2*nbands.
10101010
- **Default**: 0.0
10111011

10121012
### nelec_delta
10131013

10141014
- **Type**: Real
1015-
- **Description**:
1016-
the total number of electrons will be calculated by `nelec`+`nelec_delta`.
1015+
- **Description**: The total number of electrons will be calculated by `nelec`+`nelec_delta`.
10171016
- **Default**: 0.0
10181017

10191018
### nupdown
10201019

10211020
- **Type**: Real
10221021
- **Description**:
10231022
- 0.0: no constrain apply to system.
1024-
- `>0.0`: this denotes the difference number of electrons between spin-up and spin-down in the system. The range of value must in [-nelec ~ nelec]. It is one method of constraint DFT, the fermi energy level will separate to E_Fermi_up and E_Fermi_down.
1023+
- `>0.0`: The different number of electrons between spin-up and spin-down channels. The range of value must be in [-nelec ~ nelec]. It is one type of constrainted DFT method, two Fermi energies will be calculated.
10251024
- **Default**: 0.0
10261025

10271026
### dft_functional
@@ -1030,52 +1029,52 @@ calculations.
10301029
- **Description**: In our package, the XC functional can either be set explicitly using the `dft_functional` keyword in `INPUT` file. If `dft_functional` is not specified, ABACUS will use the xc functional indicated in the pseudopotential file.
10311030
On the other hand, if dft_functional is specified, it will overwrite the functional from pseudopotentials and performs calculation with whichever functional the user prefers. We further offer two ways of supplying exchange-correlation functional. The first is using 'short-hand' names such as 'LDA', 'PBE', 'SCAN'. A complete list of 'short-hand' expressions can be found in [the source code](../../../source/module_hamilt_general/module_xc/xc_functional.cpp). The other way is only available when ***compiling with LIBXC***, and it allows for supplying exchange-correlation functionals as combinations of LIBXC keywords for functional components, joined by a plus sign, for example, dft_functional='LDA_X_1D_EXPONENTIAL+LDA_C_1D_CSC'. The list of LIBXC keywords can be found on its [website](https://libxc.gitlab.io/functionals/). In this way, **we support all the LDA,GGA and mGGA functionals provided by LIBXC**.
10321031

1033-
Furthermore, the old INPUT parameter exx_hybrid_type for hybrid functionals has been absorbed into dft_functional. Options are `hf` (pure Hartree-Fock), `pbe0`(PBE0), `hse` (Note: in order to use HSE functional, LIBXC is required). Note also that HSE has been tested while PBE0 has NOT been fully tested yet, and the maximum CPU cores for running exx in parallel is $N(N+1)/2$, with N being the number of atoms. And forces for hybrid functionals are not supported yet.
1032+
Furthermore, the old INPUT parameter exx_hybrid_type for hybrid functionals has been absorbed into dft_functional. Options are `hf` (pure Hartree-Fock), `pbe0`(PBE0), `hse` (Note: in order to use HSE functional, LIBXC is required). Note also that HSE has been tested while PBE0 has NOT been fully tested yet, and the maximum CPU cores for running exx in parallel is $N(N+1)/2$, with N being the number of atoms.
10341033

10351034
If set to `opt_orb`, the program will not perform hybrid functional calculation. Instead, it is going to generate opt-ABFs as discussed in this [article](https://pubs.acs.org/doi/abs/10.1021/acs.jpclett.0c00481).
1036-
- **Default**: same as UPF file.
1035+
- **Default**: Used the same as DFT functional as specified in the pseudopotential files.
10371036

10381037
### xc_temperature
10391038

10401039
- **Type**: Real
1041-
- **Description**: specifies temperature when using temperature-dependent XC functionals (KSDT and so on).
1042-
- **Default** : 0.0
1040+
- **Description**: Specifies temperature when using temperature-dependent XC functionals (KSDT and so on).
1041+
- **Default**: 0.0
10431042
- **Unit**: Ry
10441043

10451044
### pseudo_rcut
10461045

10471046
- **Type**: Real
1048-
- **Description**: Cut-off of radial integration for pseudopotentials
1047+
- **Description**: Cut-off of radial integration for pseudopotentials.
10491048
- **Default**: 15
10501049
- **Unit**: Bohr
10511050

10521051
### pseudo_mesh
10531052

10541053
- **Type**: Integer
10551054
- **Description**:
1056-
- 0: use our own mesh for radial integration of pseudopotentials
1057-
- 1: use the mesh that is consistent with quantum espresso
1055+
- 0: Use a mesh for radial integration of pseudopotentials.
1056+
- 1: Use the mesh that is consistent with quantum espresso
10581057
- **Default**: 0
10591058

10601059
### nspin
10611060

10621061
- **Type**: Integer
10631062
- **Description**: The number of spin components of wave functions.
1064-
- **1**: Spin degeneracy
1065-
- **2**: Collinear spin polarized.
1066-
- **4**: For the case of [noncollinear polarized](../scf/spin.md#noncollinear-spin-polarized-calculations), nspin will be automatically set to 4 without being specified by the user.
1063+
- 1: Spin degeneracy
1064+
- 2: Collinear spin polarized.
1065+
- 4: For the case of [noncollinear polarized](../scf/spin.md#noncollinear-spin-polarized-calculations), nspin will be automatically set to 4 without being specified by the user.
10671066
- **Default**: 1
10681067

10691068
### smearing_method
10701069

10711070
- **Type**: String
10721071
- **Description**: It indicates which occupation and smearing method is used in the calculation.
1073-
- **fixed**: fixed occupations (available for non-coductors only)
1074-
- **gauss** or **gaussian**: Gaussian smearing method.
1075-
- **mp**: methfessel-paxton smearing method; recommended for metals.
1076-
- **mp2**: 2-nd methfessel-paxton smearing method; recommended for metals.
1077-
- **mv** or **cold**: marzari-vanderbilt smearing method.
1078-
- **fd**: Fermi-Dirac smearing method: $f=1/\{1+\exp[(E-\mu)/kT]\}$ and smearing_sigma below is the temperature $T$ (in Ry).
1072+
- fixed: fixed occupations (available for non-coductors only)
1073+
- gauss or gaussian: Gaussian smearing method.
1074+
- mp: methfessel-paxton smearing method; recommended for metals.
1075+
- mp2: 2-nd methfessel-paxton smearing method; recommended for metals.
1076+
- mv or cold: marzari-vanderbilt smearing method.
1077+
- fd: Fermi-Dirac smearing method: $f=1/\{1+\exp[(E-\mu)/kT]\}$ and smearing_sigma below is the temperature $T$ (in Ry).
10791078
- **Default**: gauss
10801079

10811080
### smearing_sigma
@@ -1096,9 +1095,9 @@ calculations.
10961095

10971096
- **Type**: String
10981097
- **Description**: Charge mixing methods.
1099-
- **plain**: Just simple mixing.
1100-
- **pulay**: Standard Pulay method. [P. Pulay Chemical Physics Letters, (1980)](https://www.sciencedirect.com/science/article/abs/pii/0009261480803964)
1101-
- **broyden**: Simplified modified Broyden method. [D.D. Johnson Physical Review B (1988)](https://journals.aps.org/prb/abstract/10.1103/PhysRevB.38.12807)
1098+
- plain: Just simple mixing.
1099+
- pulay: Standard Pulay method. [P. Pulay Chemical Physics Letters, (1980)](https://www.sciencedirect.com/science/article/abs/pii/0009261480803964)
1100+
- broyden: Simplified modified Broyden method. [D.D. Johnson Physical Review B (1988)](https://journals.aps.org/prb/abstract/10.1103/PhysRevB.38.12807)
11021101

11031102
In general, the convergence of the Broyden method is slightly faster than that of the Pulay method.
11041103
- **Default**: broyden
@@ -1108,10 +1107,10 @@ calculations.
11081107
- **Type**: Real
11091108
- **Description**: In general, the formula of charge mixing can be written as $\rho_{new} = \rho_{old} + \beta * \rho_{update}$, where $\rho_{new}$ represents the new charge density after charge mixing, $\rho_{old}$ represents the charge density in previous step, $\rho_{update}$ is obtained through various mixing methods, and $\beta$ is set by the parameter `mixing_beta`. A lower value of 'mixing_beta' results in less influence of $\rho_{update}$ on $\rho_{new}$, making the self-consistent field (SCF) calculation more stable. However, it may require more steps to achieve convergence.
11101109
We recommend the following options:
1111-
- **0.8**: `nspin=1`
1112-
- **0.4**: `nspin=2` and `nspin=4`
1113-
- **0**: keep charge density unchanged, usually used for restarting with `init_chg=file` or testing.
1114-
- **0.1 or less**: if convergence of SCF calculation is difficult to reach, please try `0 < mixing_beta < 0.1`.
1110+
- 0.8: `nspin=1`
1111+
- 0.4: `nspin=2` and `nspin=4`
1112+
- 0: keep charge density unchanged, usually used for restarting with `init_chg=file` or testing.
1113+
- 0.1 or less: if convergence of SCF calculation is difficult to reach, please try `0 < mixing_beta < 0.1`.
11151114

11161115
Note: For low-dimensional large systems, the setup of `mixing_beta=0.1`, `mixing_ndim=20`, and `mixing_gg0=1.0` usually works well.
11171116

@@ -1152,8 +1151,8 @@ Note that `mixing_beta_mag` is not euqal to `mixing_beta` means that $\rho_{up}$
11521151

11531152
- **Type**: Real
11541153
- **Description**: Whether to perfom Kerker scaling for charge density.
1155-
- **>0**: The high frequency wave vectors will be suppressed by multiplying a scaling factor $\frac{k^2}{k^2+gg0^2}$. Setting `mixing_gg0 = 1.0` is normally a good starting point. Kerker preconditioner will be automatically turned off if `mixing_beta <= 0.1`.
1156-
- **0**: No Kerker scaling is performed.
1154+
- >0: The high frequency wave vectors will be suppressed by multiplying a scaling factor $\frac{k^2}{k^2+gg0^2}$. Setting `mixing_gg0 = 1.0` is normally a good starting point. Kerker preconditioner will be automatically turned off if `mixing_beta <= 0.1`.
1155+
- 0: No Kerker scaling is performed.
11571156

11581157
For systems that are difficult to converge, particularly metallic systems, enabling Kerker scaling may aid in achieving convergence.
11591158
- **Default**: 1.0
@@ -1168,7 +1167,7 @@ Note that `mixing_beta_mag` is not euqal to `mixing_beta` means that $\rho_{up}$
11681167
### mixing_gg0_min
11691168

11701169
- **Type**: Real
1171-
- **Description**: the minimum kerker coefficient
1170+
- **Description**: The minimum kerker coefficient.
11721171
- **Default**: 0.1
11731172

11741173
### mixing_angle

0 commit comments

Comments
 (0)