Skip to content

Commit 90c40b4

Browse files
committed
Update Manual
1 parent b5f401a commit 90c40b4

2 files changed

Lines changed: 16 additions & 31 deletions

File tree

doc/gpumd/input_files/kpoints_in.rst

Lines changed: 10 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -7,29 +7,22 @@ k-points (``kpoints.in``)
77

88
This file is used to specify the k points needed for phonon calculations.
99

10-
File format 1 (before version 5.0)
10+
File format
1111
-----------
1212

1313
The format of this file must be as follows:
1414

1515
.. code::
16-
17-
N_kpoints
18-
kx(0) ky(0) kz(0)
19-
kx(1) ky(1) kz(1)
20-
...
21-
kx(N_kpoints-1) ky(N_kpoints-1) kz(N_kpoints-1)
22-
23-
Here,
24-
* ``N_kpoints`` is the number of k points you want to consider.
25-
* The remaining lines give the k vectors (in units of 1/Å) you want to consider.
26-
* The user has to make sure that the k vectors are defined in the reciprocal space with respect to the unit cell chosen.
16+
# high symmetry points
17+
points_x(0) points_y(0) points_z(0) name(0)
18+
points_x(1) points_y(1) points_z(1) name(1)
19+
...
2720

2821

29-
File format 2 (starting from version 5.0)
30-
-----------
22+
Example
23+
-------
3124

32-
The format of this file must be as follows:
25+
For example, the command::
3326

3427
.. code::
3528
@@ -38,6 +31,8 @@ The format of this file must be as follows:
3831
0.333 0.333 0 K
3932
0 0 0 G
4033
34+
or
35+
4136
.. code::
4237
4338
0 0 0 G

doc/gpumd/input_parameters/compute_phonon.rst

Lines changed: 6 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -17,44 +17,34 @@ To use this keyword, please make sure the following files have been preprared in
1717

1818
* - Input filename
1919
- Brief description
20-
* - ``basis.in``
21-
- Define the mapping from the atom label to the basis label (before version 5.0)
2220
* - ``kpoints.in``
23-
- Specify the :math:`\boldsymbol{k}`-points (before version 5.0)
24-
- High Symmetric Point Path (starting from version 5.0)
21+
- High Symmetric Point Path, coordinates and names
22+
23+
24+
To use this keyword, :attr:`replicate` keywords must write head in the :attr:`run.in` file.
2525

2626
Syntax
2727
------
2828

2929
This keyword is used as follows::
3030

31-
compute_phonon <cutoff> <displacement>
32-
33-
or
34-
3531
compute_phonon <displacement>
3632

37-
:attr:`cutoff` is the cutoff distance (in units of Å) for calculating the force constants. (before version 5.0)
38-
3933
:attr:`displacement` is the displacement (in units of Å) for calculating the force constants using the finite-displacement method.
4034

4135
Example
4236
-------
4337

4438
For example, the command::
4539

46-
compute_phonon 5.0 0.01
47-
48-
or
49-
5040
compute_phonon 0.01
5141

52-
means that one wants to compute the phonon dispersion using a cutoff distance of 5 Å and a displacement of 0.01 Å.
42+
means that one wants to compute the phonon dispersion using a displacement of 0.01 Å.
5343

5444
Caveats
5545
-------
5646

57-
if use version 5.0 or later, :attr:`replicate` keywords must write head in the :attr:`run.in` file.
47+
5848
This keyword should occur after all the :attr:`potential` keywords.
5949

6050
For two-body potentials, the cutoff distance for force constants can be the same as that for force evaluations.

0 commit comments

Comments
 (0)