Skip to content

Commit 07aa270

Browse files
authored
Merge pull request #262 from phoebe-team/doc-fix-kq-grids
Correct tutorial statement about commensurate k/q grids
2 parents e94eb59 + 4e607ed commit 07aa270

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

doc/sphinx/source/tutorials/elWanTransport.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ Now, we use the ``ph.x`` executable from our patched QE to run a phonon calculat
128128
electron_phonon = "epa"
129129
/
130130

131-
The values of ``nqX`` select the Monkhorst-Pack grid of q-points centered at Gamma, for which we will compute the phonon properties.
131+
The values of ``nqX`` select the Monkhorst-Pack grid of q-points centered at Gamma, for which we will compute the phonon properties. This grid needs to be commensurate (divide evenly) the grid of the SCF calculation.
132132
Also, it's important that ``prefix`` and ``outdir`` are the same as those used in the ``pw.x`` calculation from step 2.
133133
Use a good value of ``tr2_ph`` (smaller is better, but harder to converge), which (indirectly) checks the convergence of phonon frequencies.
134134

@@ -152,7 +152,7 @@ These files contain the electron-phonon coupling matrix elements to be used by P
152152

153153
* There are restrictions to the choice of k and q points.
154154
The ``K_POINTS`` in ``pw.x`` must be ``automatic``. The ``K_POINTS`` must be gamma centered.
155-
And the q-point mesh must be the same as the k-point mesh.
155+
The q-point mesh must be commensurate with the k-point mesh.
156156

157157
* In the current release, we don't support spin-polarized calculations or spin-orbit calculations. Support for this will come in a later release (as we need to implement spin-related symmetries).
158158

@@ -184,7 +184,7 @@ Step 5: Non-self-consistent run
184184
-------------------------------
185185

186186
We now start the process of Wannierizing the electronic band structure.
187-
Before running Wannier90, we need to compute the electronic band structure on the full grid of k-points as a starting point for the Wannier calculation.
187+
Before running Wannier90, we need to compute the electronic band structure on the full grid of k-points as a starting point for the Wannier calculation. This k-grid must be the same as the original SCF mesh.
188188
You can check that the ``bands.in`` file is essentially identical to the `scf.in` file, except that we:
189189

190190
* Modified the calculation parameter to ``calculation = "bands"``, which indicates to QE that we will use the charge density computed in Step 2 to recompute the wavefunctions. Don't set this parameter to ``"nscf"``, as this has a slightly different output.

0 commit comments

Comments
 (0)