Skip to content

Commit 6aeb447

Browse files
jingan-181Fisherd99
authored andcommitted
Update Wannier90 interface document. (deepmodeling#5714)
1 parent 974a84b commit 6aeb447

File tree

4 files changed

+15
-10
lines changed

4 files changed

+15
-10
lines changed

docs/advanced/interface/Wannier90.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33
[Wannier90](http://www.wannier.org/) is a useful package to generating the maximally-localized Wannier functions (MLWFs), which can be used to compute advanced electronic properties. Some post-processing tools (such as WannierTools, etc.) will use MLWFs for further analysis and calculations.
44

5-
Currently ABACUS provides an interface to Wannier90 package. The users are assumed to be familiar with the use of Wannier90. The ABACUS-Wannier90 interface is only suitable for nspin=1 or 2, not for nspin=4 or spin-orbit coupling (SOC).
5+
Currently ABACUS provides an interface to Wannier90 package. The users are assumed to be familiar with the use of Wannier90. The ABACUS-Wannier90 interface is suitable for nspin=1, 2, 4 (including lspinorb=1).
66

77
To construct the MLWFs using the wave functions of ABACUS generally requires four steps. Here we use the diamond as an example which can be found in [examples/interface_wannier90/](https://github.com/abacusmodeling/abacus-develop/tree/develop/examples/interface_wannier90).
88

9-
1. Enter the `ABACUS_towannier90/` folder, prepare a Wannier90 input file `diamond.win`, which is the main input file for Wannier90. Then To generate `diamond.nnkp` file by running Wannier90, which ABACUS will read later:
9+
1. Enter the `ABACUS_towannier90_pw/` folder, prepare a Wannier90 input file `diamond.win`, which is the main input file for Wannier90. Then To generate `diamond.nnkp` file by running Wannier90, which ABACUS will read later:
1010

1111
```
1212
wannier90 -pp diamond.win
@@ -73,17 +73,22 @@ To construct the MLWFs using the wave functions of ABACUS generally requires fou
7373
```
7474
INPUT_PARAMETERS
7575
76+
pseudo_dir ../../../tests/PP_ORB
77+
orbital_dir ../../../tests/PP_ORB
7678
ntype 1
7779
ecutwfc 50
7880
nbands 4
81+
smearing_method fixed
7982
calculation nscf
8083
scf_nmax 50
8184
pw_diag_thr 1.0e-12
82-
scf_thr 1.0e-15
85+
scf_thr 1.0e-13
8386
init_chg file
84-
symmetry 0
87+
symmetry -1
8588
towannier90 1
8689
nnkpfile diamond.nnkp
90+
basis_type pw
91+
out_wannier_unk 0
8792
```
8893
8994
There are seven interface-related parameters in the `INPUT` file:
@@ -97,7 +102,7 @@ To construct the MLWFs using the wave functions of ABACUS generally requires fou
97102
- [out_wannier_unk](../input_files/input-main.md#out_wannier_unk): control whether to output the "UNK.*" file.
98103
- [out_wannier_wvfn_formatted](../input_files/input-main.md#out_wannier_wvfn_formatted): control what format of the Wannier function file to output, `true`: output the formatted text file; `false`: output the binary file. Note that the `wvfn_formatted` option in `*.win` file (input file of Wannier90) has to be set accordingly with this option.
99104
100-
Note: You need to turn off the symmetry during the entire nscf calculation.
105+
**Note: You need to turn off the symmetry during the entire nscf calculation.**
101106
102107
To setup the `KPT` file according to the `diamond.win` file, which is similar to "begin kpoints ..." in the `diamond.win` file:
103108

examples/interface_wannier90/ABACUS_towannier90_lcao/INPUT-nscf

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ scf_nmax 50
1010
pw_diag_thr 1.0e-12
1111
scf_thr 1.0e-13
1212
init_chg file
13-
symmetry 0
13+
symmetry -1
1414
towannier90 1
1515
nnkpfile diamond.nnkp
16-
basis_type lcao
16+
basis_type lcao
1717
wannier_method 2
1818
out_wannier_unk 0

examples/interface_wannier90/ABACUS_towannier90_lcao_in_pw/INPUT-nscf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ scf_nmax 50
1010
pw_diag_thr 1.0e-12
1111
scf_thr 1.0e-13
1212
init_chg file
13-
symmetry 0
13+
symmetry -1
1414
towannier90 1
1515
nnkpfile diamond.nnkp
1616
basis_type lcao

examples/interface_wannier90/ABACUS_towannier90_pw/INPUT-nscf

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ scf_nmax 50
1111
pw_diag_thr 1.0e-12
1212
scf_thr 1.0e-13
1313
init_chg file
14-
symmetry 0
14+
symmetry -1
1515
towannier90 1
1616
nnkpfile diamond.nnkp
17-
basis_type pw
17+
basis_type pw
1818
out_wannier_unk 0

0 commit comments

Comments
 (0)