|
166 | 166 | - [restart\_save](#restart_save) |
167 | 167 | - [rpa](#rpa) |
168 | 168 | - [nbands\_istate](#nbands_istate) |
169 | | - - [bands\_to\_print](#bands_to_print) |
| 169 | + - [out\_pchg](#out_pchg) |
170 | 170 | - [if\_separate\_k](#if_separate_k) |
171 | 171 | - [out\_elf](#out_elf) |
172 | 172 | - [Density of states](#density-of-states) |
@@ -497,8 +497,8 @@ These variables are used to control general system parameters. |
497 | 497 | - relax: perform structure relaxation calculations, the `relax_nmax` parameter depicts the maximal number of ionic iterations |
498 | 498 | - cell-relax: perform cell relaxation calculations |
499 | 499 | - md: perform molecular dynamics simulations |
500 | | - - get_pchg: obtain partial (band-decomposed) charge densities (for LCAO basis only). See `nbands_istate` and `bands_to_print` for more information |
501 | | - - get_wf: obtain wave functions (for LCAO basis only). See `nbands_istate` and `bands_to_print` for more information |
| 500 | + - get_pchg: obtain partial (band-decomposed) charge densities (for LCAO basis only). See `nbands_istate` and `out_pchg` for more information |
| 501 | + - get_wf: obtain wave functions (for LCAO basis only). See `nbands_istate`, `out_wfc_norm` and `out_wfc_re_im` for more information |
502 | 502 | - get_S: obtain the overlap matrix formed by localized orbitals (for LCAO basis with multiple k points). the file name is `SR.csr` with file format being the same as that generated by [out_mat_hs2](#out_mat_hs2) |
503 | 503 | - gen_bessel: generates projectors, i.e., a series of Bessel functions, for the DeePKS method (for LCAO basis only); see also keywords `bessel_descriptor_lmax`, `bessel_descriptor_rcut` and `bessel_descriptor_tolerence`. A file named `jle.orb` will be generated which contains the projectors. An example is provided in examples/H2O-deepks-pw |
504 | 504 | - test_memory: obtain a rough estimation of memory consuption for the calculation |
@@ -1681,14 +1681,14 @@ These variables are used to control the output of properties. |
1681 | 1681 |
|
1682 | 1682 | - **Type**: Integer |
1683 | 1683 | - **Availability**: Numerical atomic orbital basis |
1684 | | -- **Description**: Whether to output the wavefunction coefficients into files in the folder `OUT.${suffix}`. The files are named as `WFC_{GAMMA|K}{index of K point}`, and if [out_app_flag](#out_app_flag) is false, the file name will also contains `_ION{ION step}`, where `ION step` is the index of ionic step: |
| 1684 | +- **Description**: Whether to output the electronic wavefunction coefficients into files and store them in the folder `OUT.${suffix}`. The files are named as `wf{s}{spin index}{k(optinal)}{k-point index}{g(optional)}{geometry index1}{_nao} + {".txt"/".dat"}`. Here, 's' refers to spin, where s1 means spin up channel while s2 means spin down channel, and 's12' refer to spinor wave functions that contains both spin channels with spin-orbital coupling or noncollinear calculations enabled. In addition, if 'gamma_only' is set to 0, then the optinoal k-point sampling index appears with the k-point index attached to the electronic wave function file names. Finally, if [out_app_flag](#out_app_flag) is set to false, the file name contains the optinal 'g' index for each ionic step that may have different geometries, and if [out_app_flag](#out_app_flag) is set to true, the wave functions accumulate during ionic steps. |
1685 | 1685 | - 0: no output |
1686 | 1686 | - 1: (txt format) |
1687 | | - - gamma-only: `WFC_NAO_GAMMA1_ION1.txt` or `WFC_NAO_GAMMA1.txt`, ...; |
1688 | | - - non-gamma-only: `WFC_NAO_K1_ION1.txt` or `WFC_NAO_K1.txt`, ...; |
| 1687 | + - gamma-only: `wfs1_nao.txt` or `wfs2_nao.txt`, ...; |
| 1688 | + - non-gamma-only: `wfs1k1_nao.txt` or `wfs1k2_nao.txt`, ...; |
1689 | 1689 | - 2: (binary format) |
1690 | | - - gamma-only: `WFC_NAO_GAMMA1_ION1.dat` or `WFC_NAO_GAMMA1.dat`, ...; |
1691 | | - - non-gamma-only: `WFC_NAO_K1_ION1.dat` or `WFC_NAO_K1.dat`, .... |
| 1690 | + - gamma-only: `wfs1_nao.dat` or `wfs2_nao.dat`, ...; |
| 1691 | + - non-gamma-only: `wfs1k1_nao.dat` or `wfs1k2_nao.dat`, .... |
1692 | 1692 |
|
1693 | 1693 | The corresponding sequence of the orbitals can be seen in [Basis Set](../pp_orb.md#basis-set). |
1694 | 1694 |
|
@@ -1901,11 +1901,25 @@ The band (KS orbital) energy for each (k-point, spin, band) will be printed in t |
1901 | 1901 | - **Description**: The number of bands around the Fermi level you would like to calculate. `get_wf` means to calculate the envelope functions of wave functions $\Psi_{i}=\Sigma_{\mu}C_{i\mu}\Phi_{\mu}$, where $\Psi_{i}$ is the ith wave function with the band index $i$ and $\Phi_{\mu}$ is the localized atomic orbital set. `get_pchg` means to calculate the density of each wave function $|\Psi_{i}|^{2}$. Specifically, suppose we have highest occupied bands at 100th wave functions. And if you set this variable to 5, it will print five wave functions from 96th to 105th. But before all this can be carried out, the wave functions coefficients should be first calculated and written into a file by setting the flag `out_wfc_lcao = 1`. |
1902 | 1902 | - **Default**: 5 |
1903 | 1903 |
|
1904 | | -### bands_to_print |
| 1904 | +### out_pchg |
1905 | 1905 |
|
1906 | 1906 | - **Type**: String |
1907 | | -- **Availability**: For both PW and LCAO. When `basis_type = lcao`, used when `calculation = get_wf` or `calculation = get_pchg`. |
1908 | | -- **Description**: Specifies the bands to calculate the wave functions/charge densities for, using a space-separated string of 0s and 1s, providing a more flexible selection compared to `nbands_istate`. Each digit in the string corresponds to a band, starting from the first band. A `1` indicates that the charge density should be calculated for that band, while a `0` means the band will be ignored. The parameter allows a compact and flexible notation (similar to [`ocp_set`](#ocp_set)), for example the syntax `1 4*0 5*1 0` is used to denote the selection of bands: `1` means calculate for the first band, `4*0` skips the next four bands, `5*1` means calculate for the following five bands, and the final `0` skips the next band. It's essential that the total count of bands does not exceed the total number of bands (`nbands`); otherwise, it results in an error, and the process exits. The input string must contain only numbers and the asterisk (`*`) for repetition, ensuring correct format and intention of band selection. |
| 1907 | +- **Availability**: For both PW and LCAO. When `basis_type = lcao`, used when `calculation = get_pchg`. |
| 1908 | +- **Description**: Specifies the bands to calculate the charge densities for, using a space-separated string of 0s and 1s, providing a more flexible selection compared to `nbands_istate`. Each digit in the string corresponds to a band, starting from the first band. A `1` indicates that the charge density should be calculated for that band, while a `0` means the band will be ignored. The parameter allows a compact and flexible notation (similar to [`ocp_set`](#ocp_set)), for example the syntax `1 4*0 5*1 0` is used to denote the selection of bands: `1` means calculate for the first band, `4*0` skips the next four bands, `5*1` means calculate for the following five bands, and the final `0` skips the next band. It's essential that the total count of bands does not exceed the total number of bands (`nbands`); otherwise, it results in an error, and the process exits. The input string must contain only numbers and the asterisk (`*`) for repetition, ensuring correct format and intention of band selection. |
| 1909 | +- **Default**: none |
| 1910 | + |
| 1911 | +### out_wfc_norm |
| 1912 | + |
| 1913 | +- **Type**: String |
| 1914 | +- **Availability**: For LCAO, used when `calculation = get_wf`. |
| 1915 | +- **Description**: Specifies the bands to calculate the real-space wave function modulus (norm, or known as the envelope function) $|\psi(r)|$. The syntax and band selection rules are identical to [`out_pchg`](#out_pchg), but the output is the norm of the wave function. |
| 1916 | +- **Default**: none |
| 1917 | + |
| 1918 | +### out_wfc_re_im |
| 1919 | + |
| 1920 | +- **Type**: String |
| 1921 | +- **Availability**: For LCAO, used when `calculation = get_wf`. |
| 1922 | +- **Description**: Specifies the bands to calculate the real and imaginary parts of the wave function $\text{Re}(\psi(r))$ and $\text{Im}(\psi(r))$. The syntax and band selection rules are identical to [`out_pchg`](#out_pchg), but the output contains both the real and imaginary components of the wave function. |
1909 | 1923 | - **Default**: none |
1910 | 1924 |
|
1911 | 1925 | ### if_separate_k |
|
0 commit comments