Skip to content

Commit 0b0c48d

Browse files
committed
Keep docs up to date
1 parent bf88b74 commit 0b0c48d

2 files changed

Lines changed: 206 additions & 91 deletions

File tree

docs/advanced/input_files/input-main.md

Lines changed: 81 additions & 89 deletions
Original file line numberDiff line numberDiff line change
@@ -169,12 +169,6 @@
169169
- [out\_stru](#out_stru)
170170
- [out\_level](#out_level)
171171
- [out\_mat\_hs](#out_mat_hs)
172-
- [out\_mat\_h\_t](#out_mat_h_t)
173-
- [out\_mat\_h\_vl](#out_mat_h_vl)
174-
- [out\_mat\_h\_vnl](#out_mat_h_vnl)
175-
- [out\_mat\_h\_vh](#out_mat_h_vh)
176-
- [out\_mat\_h\_vxc](#out_mat_h_vxc)
177-
- [out\_mat\_h\_exx](#out_mat_h_exx)
178172
- [out\_mat\_hs2](#out_mat_hs2)
179173
- [out\_mat\_tk](#out_mat_tk)
180174
- [out\_mat\_r](#out_mat_r)
@@ -186,6 +180,12 @@
186180
- [out\_mat\_dh\_vh](#out_mat_dh_vh)
187181
- [out\_mat\_dh\_vxc](#out_mat_dh_vxc)
188182
- [out\_mat\_dh\_exx](#out_mat_dh_exx)
183+
- [out\_mat\_h\_t](#out_mat_h_t)
184+
- [out\_mat\_h\_vnl](#out_mat_h_vnl)
185+
- [out\_mat\_h\_vl](#out_mat_h_vl)
186+
- [out\_mat\_h\_vh](#out_mat_h_vh)
187+
- [out\_mat\_h\_vxc](#out_mat_h_vxc)
188+
- [out\_mat\_h\_exx](#out_mat_h_exx)
189189
- [out\_mat\_ds](#out_mat_ds)
190190
- [out\_mat\_xc](#out_mat_xc)
191191
- [out\_mat\_xc2](#out_mat_xc2)
@@ -503,7 +503,6 @@
503503
- [cond\_smear](#cond_smear)
504504
- [cond\_fwhm](#cond_fwhm)
505505
- [cond\_nonlocal](#cond_nonlocal)
506-
- [cond\_mgga\_vel](#cond_mgga_vel)
507506
- [Implicit solvation model](#implicit-solvation-model)
508507
- [imp\_sol](#imp_sol)
509508
- [eb\_k](#eb_k)
@@ -718,6 +717,7 @@
718717
- file: the density will be read in from a binary file charge-density.dat first. If it does not exist, the charge density will be read in from cube files.
719718
- wfc: the density will be calculated by wavefunctions and occupations.
720719
- dm: the density will be calculated by real space density matrix(DMR) of LCAO base.
720+
- dm_no_renormalize: same as dm, but the charge density is not renormalized to the number of electrons.
721721
- hr: the real space Hamiltonian matrix(HR) will be read in from file hrs1_nao.csr in directory read_file_dir.
722722
- auto: Abacus first attempts to read the density from a file; if not found, it defaults to using atomic density.
723723
- **Default**: atomic
@@ -1949,7 +1949,7 @@
19491949

19501950
The corresponding sequence of the orbitals can be seen in Basis Set.
19511951

1952-
Also controlled by out_freq_ion and out_app_flag.
1952+
Also controled by out_freq_ion and out_app_flag.
19531953

19541954
> Note: In the 3.10-LTS version, the file names are WFC_NAO_GAMMA1_ION1.txt and WFC_NAO_K1_ION1.txt, etc.
19551955
- **Default**: 0
@@ -2010,7 +2010,7 @@
20102010

20112011
- **Type**: Boolean \[Integer\](optional)
20122012
- **Availability**: *Numerical atomic orbital basis*
2013-
- **Description**: Whether to print the upper triangular part of the Hamiltonian matrices and overlap matrices for each k-point into files in the directory OUT.${suffix}. The second number controls precision. For more information, please refer to hs_matrix.md. Also controlled by out_freq_ion and out_app_flag.
2013+
- **Description**: Whether to print the upper triangular part of the Hamiltonian matrices and overlap matrices for each k-point into files in the directory OUT.${suffix}. The second number controls precision. For more information, please refer to hs_matrix.md. Also controled by out_freq_ion and out_app_flag.
20142014
- For gamma only case:
20152015
- nspin = 1: hks1_nao.txt for the Hamiltonian matrix and sks1_nao.txt for the overlap matrix;
20162016
- nspin = 2: hks1_nao.txt and hks2_nao.txt for the Hamiltonian matrix and sks1_nao.txt for the overlap matrix. Note that the code will not output sks2_nao.txt because it is the same as sks1_nao.txt;
@@ -2024,54 +2024,6 @@
20242024
- **Default**: False 8
20252025
- **Unit**: Ry
20262026

2027-
### out_mat_h_t
2028-
2029-
- **Type**: Boolean \[Integer\](optional)
2030-
- **Availability**: *Numerical atomic orbital basis (nspin ≠ 4)*
2031-
- **Description**: Whether to print the kinetic energy matrix $T_{\mu\nu}(k) = \langle\phi_\mu|\hat{T}|\phi_\nu\rangle(k)$ for each k-point. The output format and file naming (e.g. `tks1_nao.txt`, `tks1k1_nao.txt`) follow [`out_mat_hs`](#out_mat_hs).
2032-
- **Default**: False 8
2033-
- **Unit**: Ry
2034-
2035-
### out_mat_h_vl
2036-
2037-
- **Type**: Boolean \[Integer\](optional)
2038-
- **Availability**: *Numerical atomic orbital basis (nspin ≠ 4)*
2039-
- **Description**: Whether to print the local pseudopotential matrix $V^L_{\mu\nu}(k) = \langle\phi_\mu|\hat{V}^L|\phi_\nu\rangle(k)$ for each k-point. The output format and file naming (e.g. `vlks1_nao.txt`, `vlks1k1_nao.txt`) follow [`out_mat_hs`](#out_mat_hs).
2040-
- **Default**: False 8
2041-
- **Unit**: Ry
2042-
2043-
### out_mat_h_vnl
2044-
2045-
- **Type**: Boolean \[Integer\](optional)
2046-
- **Availability**: *Numerical atomic orbital basis (nspin ≠ 4)*
2047-
- **Description**: Whether to print the nonlocal pseudopotential (Kleinman–Bylander) matrix $V^{NL}_{\mu\nu}(k) = \langle\phi_\mu|\hat{V}^{NL}|\phi_\nu\rangle(k)$ for each k-point. The output format and file naming (e.g. `vnlks1_nao.txt`, `vnlks1k1_nao.txt`) follow [`out_mat_hs`](#out_mat_hs).
2048-
- **Default**: False 8
2049-
- **Unit**: Ry
2050-
2051-
### out_mat_h_vh
2052-
2053-
- **Type**: Boolean \[Integer\](optional)
2054-
- **Availability**: *Numerical atomic orbital basis (nspin ≠ 4)*
2055-
- **Description**: Whether to print the Hartree matrix $V^H_{\mu\nu}(k) = \langle\phi_\mu|\hat{V}^H|\phi_\nu\rangle(k)$ for each k-point. The output format and file naming (e.g. `vhks1_nao.txt`, `vhks1k1_nao.txt`) follow [`out_mat_hs`](#out_mat_hs).
2056-
- **Default**: False 8
2057-
- **Unit**: Ry
2058-
2059-
### out_mat_h_vxc
2060-
2061-
- **Type**: Boolean \[Integer\](optional)
2062-
- **Availability**: *Numerical atomic orbital basis (nspin ≠ 4)*
2063-
- **Description**: Whether to print the exchange-correlation matrix $V^{XC}_{\mu\nu}(k) = \langle\phi_\mu|\hat{V}^{XC}|\phi_\nu\rangle(k)$ for each k-point. The output format and file naming (e.g. `vxcks1_nao.txt`, `vxcks1k1_nao.txt`) follow [`out_mat_hs`](#out_mat_hs).
2064-
- **Default**: False 8
2065-
- **Unit**: Ry
2066-
2067-
### out_mat_h_exx
2068-
2069-
- **Type**: Boolean \[Integer\](optional)
2070-
- **Availability**: *Numerical atomic orbital basis (nspin ≠ 4, hybrid functional only)*
2071-
- **Description**: Whether to print the exact-exchange matrix $V^{EXX}_{\mu\nu}(k) = \langle\phi_\mu|\hat{V}^{EXX}|\phi_\nu\rangle(k)$ for each k-point. The output format and file naming (e.g. `vexxks1_nao.txt`, `vexxks1k1_nao.txt`) follow [`out_mat_hs`](#out_mat_hs). Requires a hybrid functional (`cal_exx = true`).
2072-
- **Default**: False 8
2073-
- **Unit**: Ry
2074-
20752027
### out_mat_hs2
20762028

20772029
- **Type**: Boolean \[Integer\](optional)
@@ -2106,7 +2058,7 @@
21062058

21072059
- **Type**: Boolean \[Integer\](optional)
21082060
- **Availability**: *Numerical atomic orbital basis (not gamma-only algorithm)*
2109-
- **Description**: Generate files containing the kinetic energy matrix. The optional second parameter controls text output precision. The format will be the same as the Hamiltonian matrix and overlap matrix as mentioned in out_mat_hs2. The name of the files will be trs1_nao.csr and so on. Also controlled by out_freq_ion and out_app_flag.
2061+
- **Description**: Generate files containing the kinetic energy matrix. The optional second parameter controls text output precision. The format will be the same as the Hamiltonian matrix and overlap matrix as mentioned in out_mat_hs2. The name of the files will be trs1_nao.csr and so on. Also controled by out_freq_ion and out_app_flag.
21102062

21112063
> Note: In the 3.10-LTS version, the file name is data-TR-sparse_SPIN0.csr.
21122064
- **Default**: False 8
@@ -2115,81 +2067,128 @@
21152067
### out_mat_dh
21162068

21172069
- **Type**: Integer
2118-
- **Availability**: *Numerical atomic orbital basis*
2119-
- **Description**: Whether to print files containing the derivatives of the Hamiltonian matrix $dH(k)/d\tau_I=d\braket{\phi|\hat{H}|\phi}(k)/d\tau_I$ where $\tau_I$ is the Ith atom position with the dense format as `out_mat_dh`. The names are dhk[x/y/z]_iat[I][_ik]_nao.txt.
2120-
- See also the term-separated output parameters: [`out_mat_dh_t`](#out_mat_dh_t), [`out_mat_dh_vl`](#out_mat_dh_vl), [`out_mat_dh_vnl`](#out_mat_dh_vnl), [`out_mat_dh_vh`](#out_mat_dh_vh), [`out_mat_dh_vxc`](#out_mat_dh_vxc) and [`out_mat_dh_exx`](#out_mat_dh_exx).
2121-
- If not gamma-only, also $\braket{\nabla\phi|\hat{H}\phi}(R)$ of sparse format as `out_mat_hs2` will also be output. The name of the files will be dhrxs1_nao.csr, dhrys1_nao.csr, dhrzs1_nao.csr and so on. Also controlled by out_freq_ion and out_app_flag.
2122-
> Note: In the 3.10-LTS version, the file name is data-dHRx-sparse_SPIN0.csr and so on.
2123-
- **Format**: `<enable> [precision] [iat1 iat2 ...]`
2124-
- The first value (0/1) enables or disables output.
2125-
- The second optional value sets the output precision (number of significant digits, default: 8).
2126-
- Starting from the third value, **1-based atom indices** can be listed to restrict the output to derivatives with respect to those specific atoms only. If no atom indices are given, derivatives are written for all atoms.
2070+
- **Availability**: *Numerical atomic orbital basis (not gamma-only algorithm)*
2071+
- **Description**: Whether to print files containing the derivatives of the Hamiltonian matrix. The format will be the same as the Hamiltonian matrix and overlap matrix as mentioned in out_mat_hs2. The name of the files will be dhrxs1_nao.csr, dhrys1_nao.csr, dhrzs1_nao.csr and so on. Also controled by out_freq_ion and out_app_flag.
21272072

2128-
For example, `out_mat_dh 1 8 1 3` writes dH/dR for atoms 1 and 3 only (1-based indexing).
2073+
Format: &lt;enable&gt; [precision] [iat1 iat2 ...]. The first value (0/1) enables/disables output. The second optional value sets the output precision (default: 8). Starting from the third value, 1-based atom indices can be listed to restrict output to derivatives with respect to those specific atoms only; if no atom indices are given, all atoms are written.
21292074

2075+
> Note: In the 3.10-LTS version, the file name is data-dHRx-sparse_SPIN0.csr and so on.
21302076
- **Default**: 0 8
21312077
- **Unit**: Ry/Bohr
21322078

21332079
### out_mat_dh_t
21342080

21352081
- **Type**: Integer
2136-
- **Availability**: *Numerical atomic orbital basis (nspin ≠ 4)*
2137-
- **Description**: Whether to print files containing the kinetic energy contribution to the Hamiltonian derivative, see [`out_mat_dh`](#out_mat_dh) for the same format. Output files: dhk[x/y/z]_iat[I][_ik]_nao.txt.
2082+
- **Description**: Whether to print files containing the derivatives of the kinetic energy matrix dT/dR.
21382083

2084+
See out_mat_dh for format details (enable, precision, atom indices).
21392085
- **Default**: 0 8
21402086
- **Unit**: Ry/Bohr
21412087

21422088
### out_mat_dh_vl
21432089

21442090
- **Type**: Integer
2145-
- **Availability**: *Numerical atomic orbital basis (nspin ≠ 4)*
2146-
- **Description**: Whether to print files containing the local pseudopotential contribution to the Hamiltonian derivative, see [`out_mat_dh`](#out_mat_dh) for the same format. Output files: dvlk[x/y/z]_iat[I][_ik]_nao.txt.
2091+
- **Description**: Whether to print files containing the derivatives of the local pseudopotential matrix dV^L/dR.
21472092

2093+
See out_mat_dh for format details.
21482094
- **Default**: 0 8
21492095
- **Unit**: Ry/Bohr
21502096

21512097
### out_mat_dh_vnl
21522098

21532099
- **Type**: Integer
2154-
- **Availability**: *Numerical atomic orbital basis (nspin ≠ 4)*
2155-
- **Description**: Whether to print files containing the nonlocal pseudopotential contribution to the Hamiltonian derivative, see [`out_mat_dh`](#out_mat_dh) for the same format. Output files: dvnlk[x/y/z]_iat[I][_ik]_nao.txt.
2100+
- **Description**: Whether to print files containing the derivatives of the nonlocal pseudopotential matrix dV^NL/dR.
21562101

2102+
See out_mat_dh for format details.
21572103
- **Default**: 0 8
21582104
- **Unit**: Ry/Bohr
21592105

21602106
### out_mat_dh_vh
21612107

21622108
- **Type**: Integer
2163-
- **Availability**: *Numerical atomic orbital basis (nspin ≠ 4)*
2164-
- **Description**: Whether to print files containing the Hartree contribution to the Hamiltonian derivative, see [`out_mat_dh`](#out_mat_dh) for the same format. Output files: dvhk[x/y/z]_iat[I][_ik]_nao.txt.
2109+
- **Description**: Whether to print files containing the derivatives of the Hartree matrix dV^H/dR.
21652110

2111+
See out_mat_dh for format details.
21662112
- **Default**: 0 8
21672113
- **Unit**: Ry/Bohr
21682114

21692115
### out_mat_dh_vxc
21702116

21712117
- **Type**: Integer
2172-
- **Availability**: *Numerical atomic orbital basis (nspin ≠ 4)*
2173-
- **Description**: Whether to print files containing the exchange-correlation contribution to the Hamiltonian derivative, see [`out_mat_dh`](#out_mat_dh) for the same format. Output files: dvxck[x/y/z]_iat[I][_ik]_nao.txt.
2118+
- **Description**: Whether to print files containing the derivatives of the XC matrix dV^XC/dR.
21742119

2120+
See out_mat_dh for format details.
21752121
- **Default**: 0 8
21762122
- **Unit**: Ry/Bohr
21772123

21782124
### out_mat_dh_exx
21792125

21802126
- **Type**: Integer
2181-
- **Availability**: *Numerical atomic orbital basis, hybrid functional only (nspin ≠ 4)*
2182-
- Currently only availablewhen compiled with the personal developing branch of LibRI and -DEXX_DEV flag, waiting for the new release of LibRI to remove the flag.
2183-
- **Description**: Whether to print files containing the exact-exchange contribution to the Hamiltonian derivative, see [`out_mat_dh`](#out_mat_dh) for the same format. Output files: dvexxk[x/y/z]_iat[I][_ik]_nao.txt.
2127+
- **Description**: Whether to print files containing the derivatives of the exact-exchange matrix dV^EXX/dR.
21842128

2129+
See out_mat_dh for format details.
21852130
- **Default**: 0 8
21862131
- **Unit**: Ry/Bohr
21872132

2133+
### out_mat_h_t
2134+
2135+
- **Type**: Integer
2136+
- **Description**: Whether to print files containing the kinetic energy matrix T(R) in CSR format.
2137+
2138+
See out_mat_hs2 for format details.
2139+
- **Default**: 0 8
2140+
- **Unit**: Ry
2141+
2142+
### out_mat_h_vnl
2143+
2144+
- **Type**: Integer
2145+
- **Description**: Whether to print files containing the nonlocal pseudopotential matrix Vnl(R) in CSR format.
2146+
2147+
See out_mat_hs2 for format details.
2148+
- **Default**: 0 8
2149+
- **Unit**: Ry
2150+
2151+
### out_mat_h_vl
2152+
2153+
- **Type**: Integer
2154+
- **Description**: Whether to print files containing the local pseudopotential matrix Vl(R) in CSR format.
2155+
2156+
See out_mat_hs2 for format details.
2157+
- **Default**: 0 8
2158+
- **Unit**: Ry
2159+
2160+
### out_mat_h_vh
2161+
2162+
- **Type**: Integer
2163+
- **Description**: Whether to print files containing the Hartree matrix Vh(R) in CSR format.
2164+
2165+
See out_mat_hs2 for format details.
2166+
- **Default**: 0 8
2167+
- **Unit**: Ry
2168+
2169+
### out_mat_h_vxc
2170+
2171+
- **Type**: Integer
2172+
- **Description**: Whether to print files containing the XC matrix Vxc(R) in CSR format.
2173+
2174+
See out_mat_hs2 for format details.
2175+
- **Default**: 0 8
2176+
- **Unit**: Ry
2177+
2178+
### out_mat_h_exx
2179+
2180+
- **Type**: Integer
2181+
- **Description**: Whether to print files containing the exact-exchange matrix Vexx(R) in CSR format.
2182+
2183+
See out_mat_hs2 for format details.
2184+
- **Default**: 0 8
2185+
- **Unit**: Ry
2186+
21882187
### out_mat_ds
21892188

21902189
- **Type**: Boolean \[Integer\](optional)
21912190
- **Availability**: *Numerical atomic orbital basis (not gamma-only algorithm)*
2192-
- **Description**: Whether to print files containing the derivatives of the overlap matrix. The optional second parameter controls text output precision. The format will be the same as the overlap matrix as mentioned in out_mat_dh. The name of the files will be dsxrs1_nao.csr and so on. Also controlled by out_freq_ion and out_app_flag. This feature can be used with calculation get_s.
2191+
- **Description**: Whether to print files containing the derivatives of the overlap matrix. The optional second parameter controls text output precision. The format will be the same as the overlap matrix as mentioned in out_mat_dh. The name of the files will be dsxrs1_nao.csr and so on. Also controled by out_freq_ion and out_app_flag. This feature can be used with calculation get_s.
21932192

21942193
> Note: In the 3.10-LTS version, the file name is data-dSRx-sparse_SPIN0.csr and so on.
21952194
- **Default**: False 8
@@ -4550,13 +4549,6 @@
45504549
- False: .
45514550
- **Default**: True
45524551

4553-
### cond_mgga_vel
4554-
4555-
- **Type**: Boolean
4556-
- **Availability**: [basis_type](#basis_type) = `pw`
4557-
- **Description**: Whether to include the meta-GGA velocity correction from the $v_\tau$ term when calculating velocity matrix $\bra{\psi_i}\hat{v}\ket{\psi_j}$.
4558-
- **Default**: True
4559-
45604552
[back to top](#full-list-of-input-keywords)
45614553

45624554
## Implicit solvation model

0 commit comments

Comments
 (0)