Skip to content

Commit fdede5e

Browse files
committed
Doc: correct the filename of dm
1 parent 1009827 commit fdede5e

3 files changed

Lines changed: 17 additions & 12 deletions

File tree

docs/advanced/elec_properties/density_matrix.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,10 @@ out_dmk 1
77
After finishing the calculation, the density matrix is written into `OUT.${suffix}/`.
88

99
For current develop versions:
10-
- gamma-only (`gamma_only = 1`): `dm_nao.csr` (`nspin=1/4`) or `dms1_nao.csr` and `dms2_nao.csr` (`nspin=2`)
11-
- multi-k (`gamma_only = 0`): `dmk1_nao.csr`, `dmk2_nao.csr`, ... (`nspin=1/4`) or `dmk1s1_nao.csr`, `dmk1s2_nao.csr`, ... (`nspin=2`)
10+
- gamma-only (`gamma_only = 1`): `dmg1_nao.txt` (`nspin=1/4`) or `dms1g1_nao.txt` and `dms2g1_nao.txt` (`nspin=2`)
11+
- multi-k (`gamma_only = 0`): `dmk1g1_nao.txt`, `dmk2g1_nao.txt`, ... (`nspin=1/4`) or `dmk1s1g1_nao.txt`, `dmk1s2g1_nao.txt`, ... (`nspin=2`)
12+
13+
Here `g{istep}` denotes the geometry/step index in the output filename.
1214

1315
For 3.10-LTS, the corresponding keyword is `out_dm`, and file names follow the legacy style such as `SPIN1_DM` and `SPIN2_DM`.
1416

docs/advanced/input_files/input-main.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1802,13 +1802,15 @@
18021802

18031803
- **Type**: Boolean \[Integer\](optional)
18041804
- **Availability**: *Numerical atomic orbital basis*
1805-
- **Description**: Whether to output the density matrix for each k-point into files in the folder OUT.${suffix}. The files are named as:
1805+
- **Description**: Whether to output the density matrix for each k-point into files in the folder OUT.${suffix}. For current develop versions, out_dmk writes *_nao.txt files and includes a g{istep} index in the file name:
18061806
- For gamma only case:
1807-
- nspin = 1 and 4: dm_nao.csr;
1808-
- nspin = 2: dms1_nao.csr and dms2_nao.csr for the two spin channels.
1807+
- nspin = 1 and 4: dmg1_nao.txt;
1808+
- nspin = 2: dms1g1_nao.txt and dms2g1_nao.txt for the two spin channels.
18091809
- For multi-k points case:
1810-
- nspin = 1 and 4: dmk1_nao.csr, dmk2_nao.csr, ...;
1811-
- nspin = 2: dmk1s1_nao.csr... and dmk1s2_nao.csr... for the two spin channels.
1810+
- nspin = 1 and 4: dmk1g1_nao.txt, dmk2g1_nao.txt, ...;
1811+
- nspin = 2: dmk1s1g1_nao.txt... and dmk1s2g1_nao.txt... for the two spin channels.
1812+
1813+
Here, g{istep} denotes the geometry/step index in the output file name.
18121814

18131815
> Note: Version difference (develop vs 3.10-LTS):
18141816
>

docs/parameters.yaml

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2856,13 +2856,14 @@ parameters:
28562856
category: Output information
28572857
type: "Boolean \\[Integer\\](optional)"
28582858
description: |
2859-
Whether to output the density matrix for each k-point into files in the folder OUT.${suffix}. The files are named as:
2859+
Whether to output the density matrix for each k-point into files in the folder OUT.${suffix}. For current develop versions, out_dmk writes *_nao.txt files and includes a g{istep} index in the file name:
28602860
* For gamma only case:
2861-
* nspin = 1 and 4: dm_nao.csr;
2862-
* nspin = 2: dms1_nao.csr and dms2_nao.csr for the two spin channels.
2861+
* nspin = 1 and 4: dmg1_nao.txt;
2862+
* nspin = 2: dms1g1_nao.txt and dms2g1_nao.txt for the two spin channels.
28632863
* For multi-k points case:
2864-
* nspin = 1 and 4: dmk1_nao.csr, dmk2_nao.csr, ...;
2865-
* nspin = 2: dmk1s1_nao.csr... and dmk1s2_nao.csr... for the two spin channels.
2864+
* nspin = 1 and 4: dmk1g1_nao.txt, dmk2g1_nao.txt, ...;
2865+
* nspin = 2: dmk1s1g1_nao.txt... and dmk1s2g1_nao.txt... for the two spin channels.
2866+
Here, g{istep} denotes the geometry/step index in the output file name.
28662867
28672868
[NOTE] Version difference (develop vs 3.10-LTS):
28682869
* In develop, out_dmk supports both gamma-only and multi-k-point density-matrix output.

0 commit comments

Comments
 (0)