Skip to content

Commit ae6dcfc

Browse files
authored
Merge branch 'develop' into fft15
2 parents 03ee34a + 6dbaae8 commit ae6dcfc

File tree

86 files changed

+2204
-1057
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

86 files changed

+2204
-1057
lines changed

docs/advanced/elec_properties/band.md

Lines changed: 23 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,40 @@
11
# Extracting Band Structure
22

3-
ABACUS can calculate the energy band structure, and the examples can be found in [examples/band](https://github.com/deepmodeling/abacus-develop/tree/develop/examples/band).
4-
Similar to the [DOS case](https://abacus-rtd.readthedocs.io/en/latest/advanced/elec_properties/dos.html), we first, do a ground-state energy calculation ***with one additional keyword "[out_chg](https://abacus-rtd.readthedocs.io/en/latest/advanced/input_files/input-main.html#out-chg)" in the INPUT file***:
3+
In ABACUS, in order to obtain the eigenvalues of Hamiltonian, or generally called band structure, examples can be found in [examples/band](https://github.com/deepmodeling/abacus-develop/tree/develop/examples/band).
4+
Similar to the [DOS case](https://abacus-rtd.readthedocs.io/en/latest/advanced/elec_properties/dos.html), one first needs to perform a ground-state energy calculation ***with one additional keyword "[out_chg](https://abacus-rtd.readthedocs.io/en/latest/advanced/input_files/input-main.html#out-chg)" in the INPUT file***:
55

66
```
7-
out_chg 1
7+
out_chg 1
88
```
99

10-
This will produce the converged charge density, which is contained in the file SPIN1_CHG.cube.
11-
Then, use the same `STRU` file, pseudopotential file and atomic orbital file (and the local density matrix file onsite.dm if DFT+U is used) to do a non-self-consistent calculation. In this example, the potential is constructed from the ground-state charge density from the proceeding calculation. Now the INPUT file is like:
10+
With this input parameter, the converged charge density will be output in the files such as `chgs1.cube`, `chgs2.cube`, etc.
11+
Then, one can use the same `STRU` file, pseudopotential files and atomic orbital files (and the local density matrix file onsite.dm if DFT+U is used) to do a non-self-consistent (NSCF) calculation. In this example, the potential is constructed from the ground-state charge density from the proceeding calculation. Now the INPUT file is like:
1212

1313
```
1414
INPUT_PARAMETERS
1515
#Parameters (General)
16-
ntype 1
17-
nbands 8
18-
calculation nscf
19-
basis_type lcao
20-
read_file_dir ./
16+
nbands 8
17+
calculation nscf
18+
basis_type lcao
19+
read_file_dir ./
2120
2221
#Parameters (Accuracy)
23-
ecutwfc 60
24-
scf_nmax 50
25-
scf_thr 1.0e-9
26-
pw_diag_thr 1.0e-7
22+
ecutwfc 60
23+
scf_nmax 50
24+
scf_thr 1.0e-9
25+
pw_diag_thr 1.0e-7
2726
2827
#Parameters (File)
29-
init_chg file
30-
out_band 1
28+
init_chg file
29+
out_band 1
3130
out_proj_band 1
3231
3332
#Parameters (Smearing)
3433
smearing_method gaussian
35-
smearing_sigma 0.02
34+
smearing_sigma 0.02
3635
```
3736

38-
Here the the relevant k-point file KPT looks like,
37+
Here is a relevant k-point file KPT (in LINE mode):
3938

4039
```
4140
K_POINTS # keyword for start
@@ -49,16 +48,16 @@ Line # line-mode
4948
0.0 0.0 0.0 1 # G
5049
```
5150

52-
This means we are using:
51+
This means we are using the following k-points:
5352

54-
- 6 number of k points, here means 6 k points:
53+
- 6 k points, here means 6 k points:
5554
(0.5, 0.0, 0.5) (0.0, 0.0, 0.0) (0.5, 0.5, 0.5) (0.5, 0.25, 0.75) (0.375, 0.375, 0.75) (0.0, 0.0,
5655
0.0)
5756
- 20/1 number of k points along the segment line, which is constructed by two adjacent k
5857
points.
5958

60-
Run the program, and you will see a file named BANDS_1.dat in the output directory. Plot it
61-
to get energy band structure.
59+
Next, run ABACUS and you will see a file named `eigs1.txt` in the output directory.
60+
Plot it and you will obtain the energy band structure!
6261

6362
If "out_proj_band" set 1, it will also produce the projected band structure in a file called PBAND_1 in xml format.
6463

@@ -77,8 +76,8 @@ The rest of the files arranged in sections, each section with a header such as b
7776

7877
```
7978
<orbital
80-
index=" 1"
81-
atom_index=" 1"
79+
index=" 1"
80+
atom_index=" 1"
8281
species="Si"
8382
l=" 0"
8483
m=" 0"

docs/advanced/elec_properties/hs_matrix.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ and
1212

1313
## out_mat_hs
1414

15-
Users may set the keyword [out_mat_hs](../input_files/input-main.md#out_mat_hs) to true for outputting the upper triangular part of the Hamiltonian matrices and overlap matrices for each k point into files in the directory `OUT.${suffix}`. It is available for both gamma_only and multi-k calculations.
15+
Users can set the keyword [out_mat_hs](../input_files/input-main.md#out_mat_hs) to true for outputting the upper triangular part of the Hamiltonian matrices and overlap matrices for each k point into files in the directory `OUT.${suffix}`. It is available for both gamma_only and multi-k calculations.
1616

1717
The files are named `data-$k-H` and `data-$k-S`, where `$k` is a composite index consisting of the k point index as well as the spin index. The corresponding sequence of the orbitals can be seen in [Basis Set](../pp_orb.md#basis-set).
1818

@@ -35,7 +35,7 @@ The rest of the file contains the upper triangular part of the specified matrice
3535

3636
The output of R-space matrices is controlled by the keyword [out_mat_hs2](../input_files/input-main.md#out_mat_hs2). This functionality is not available for gamma_only calculations. To generate such matrices for gamma only calculations, users should turn off [gamma_only](../input_files/input-main.md#gamma_only), and explicitly specify that gamma point is the only k point in the KPT file.
3737

38-
For single-point SCF calculations, if nspin = 1 or nspin = 4, two files `data-HR-sparse_SPIN0.csr` and `data-SR-sparse_SPIN0.csr` are generated, which contain the Hamiltonian matrix $H(R)$ and overlap matrix $S(R)$ respectively. For nspin = 2, three files `data-HR-sparse_SPIN0.csr` and `data-HR-sparse_SPIN1.csr` and `data-SR-sparse_SPIN0.csr` are created, where the first two contain $H(R)$ for spin up and spin down, respectively.
38+
For single-point SCF calculations, if nspin = 1 or nspin = 4, two files `hrs1_nao.csr` and `sr_nao.csr` are generated, which contain the Hamiltonian matrix $H(R)$ and overlap matrix $S(R)$ respectively. For nspin = 2, three files `hrs1_nao.csr` and `hrs2_nao.csr` and `sr_nao.csr` are created, where the first two files correspodn to $H(R)$ for spin up and spin down, respectively.
3939

4040
As for molecular dynamics calculations, the format is controlled by [out_interval](../input_files/input-main.md#out_interval) and [out_app_flag](../input_files/input-main.md#out_app_flag) in the same manner as the position matrix as detailed in [out_mat_r](../input_files/input-main.md#out_mat_r).
4141

@@ -74,4 +74,4 @@ We provide [examples](https://github.com/deepmodeling/abacus-develop/tree/develo
7474
- out_hs_multik : writing H(k) and S(k) for multi-k calculation
7575
- out_s_multik : running get_S for multi-k calculation
7676

77-
Reference output files are provided in each directory.
77+
Reference output files are provided in each directory.

0 commit comments

Comments
 (0)