Skip to content

Commit 514681b

Browse files
committed
Doc: Update the document of input parameters
1 parent 9efba37 commit 514681b

File tree

2 files changed

+16
-2
lines changed

2 files changed

+16
-2
lines changed

docs/advanced/input_files/input-main.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -161,6 +161,7 @@
161161
- [nbands\_istate](#nbands_istate)
162162
- [bands\_to\_print](#bands_to_print)
163163
- [if\_separate\_k](#if_separate_k)
164+
- [out\_elf](#out_elf)
164165
- [Density of states](#density-of-states)
165166
- [dos\_edelta\_ev](#dos_edelta_ev)
166167
- [dos\_sigma](#dos_sigma)
@@ -1520,7 +1521,7 @@ These variables are used to control the output of properties.
15201521
- **Type**: Integer \[Integer\](optional)
15211522
- **Description**:
15221523
The first integer controls whether to output the charge density on real space grids:
1523-
- 1. Output the charge density (in Bohr^-3) on real space grids into the density files in the folder `OUT.${suffix}`. The files are named as:
1524+
- 1: Output the charge density (in Bohr^-3) on real space grids into the density files in the folder `OUT.${suffix}`. The files are named as:
15241525
- nspin = 1: SPIN1_CHG.cube;
15251526
- nspin = 2: SPIN1_CHG.cube, and SPIN2_CHG.cube;
15261527
- nspin = 4: SPIN1_CHG.cube, SPIN2_CHG.cube, SPIN3_CHG.cube, and SPIN4_CHG.cube.
@@ -1800,6 +1801,19 @@ The band (KS orbital) energy for each (k-point, spin, band) will be printed in t
18001801
- **Description**: Specifies whether to write the partial charge densities for all k-points to individual files or merge them. **Warning**: Enabling symmetry may produce incorrect results due to incorrect k-point weights. Therefore, when calculating partial charge densities, it is strongly recommended to set `symmetry = -1`.
18011802
- **Default**: false
18021803

1804+
### out_elf
1805+
1806+
- **Type**: Boolean
1807+
- **Availability**: Only for Kohn-Sham DFT and Orbital Free DFT.
1808+
- **Description**: Whether to output the electron localization function (ELF) in the folder `OUT.${suffix}`. The files are named as
1809+
- nspin = 1:
1810+
- ELF.cube: ${\rm{ELF}} = \frac{1}{1+\chi^2}$, $\chi = \frac{\frac{1}{2}\sum_{i}{f_i |\nabla\psi_{i}|^2} - \frac{|\nabla\rho|^2}{8\rho}}{\frac{3}{10}(3\pi^2)^{2/3}\rho^{5/3}}$;
1811+
- nspin = 2:
1812+
- ELF_SPIN1.cube, ELF_SPIN2.cube: ${\rm{ELF}}_\sigma = \frac{1}{1+\chi_\sigma^2}$, $\chi_\sigma = \frac{\frac{1}{2}\sum_{i}{f_i |\nabla\psi_{i,\sigma}|^2} - \frac{|\nabla\rho_\sigma|^2}{8\rho_\sigma}}{\frac{3}{10}(6\pi^2)^{2/3}\rho_\sigma^{5/3}}$;
1813+
- ELF.cube: ${\rm{ELF}} = \frac{1}{1+\chi^2}$, $\chi = \frac{\frac{1}{2}\sum_{i,\sigma}{f_i |\nabla\psi_{i,\sigma}|^2} - \sum_{\sigma}{\frac{|\nabla\rho_\sigma|^2}{8\rho_\sigma}}}{\sum_{\sigma}{\frac{3}{10}(6\pi^2)^{2/3}\rho_\sigma^{5/3}}}$;
1814+
1815+
- **Default**: false
1816+
18031817
[back to top](#full-list-of-input-keywords)
18041818

18051819
## Density of states

source/module_io/write_elf.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ void write_elf(
111111
{
112112
for (int is = 0; is < nspin; ++is)
113113
{
114-
std::string fn_temp = out_dir + "/ELF" + std::to_string(is) + ".cube";
114+
std::string fn_temp = out_dir + "/ELF_SPIN" + std::to_string(is) + ".cube";
115115
int ispin = is + 1;
116116

117117
ModuleIO::write_cube(

0 commit comments

Comments
 (0)