Skip to content

Commit 0176e01

Browse files
committed
modify the documentation
1 parent 060a489 commit 0176e01

2 files changed

Lines changed: 36 additions & 11 deletions

File tree

doc/gpumd/input_parameters/fix.rst

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,28 @@ This keyword can be used to fix (freeze) a group of atoms
99

1010
Syntax
1111
------
12-
This keyword requires a single parameter which is the label of the group in which the atoms are to be fixed (velocities and forces are always set to zero such that the atoms in the group do not move).
12+
This keyword accepts 1 or 2 parameters.
13+
The atoms in the specified group will be fixed (velocities and forces are always set to zero such that the atoms do not move).
1314
The full command reads::
1415

1516
fix <group_label>
17+
fix <grouping_method> <group_label>
1618

17-
Here, the :attr:`group_label` refers to the grouping method 0 defined in the :ref:`simulation model file <model_xyz>`.
19+
- If only :attr:`group_label` is given, grouping method 0 is used by default.
20+
- If :attr:`grouping_method` is also specified, the given grouping method defined in the :ref:`simulation model file <model_xyz>` will be used.
21+
22+
Example
23+
-------
24+
25+
Fix group 0 using the default grouping method 0::
26+
27+
fix 0
28+
29+
Fix group 2 using grouping method 1::
30+
31+
fix 1 2
1832

1933
Caveats
2034
-------
21-
This keyword is not propagating, which means that it only affects the simulation within the run it belongs to.
35+
* This keyword is not propagating, which means that it only affects the simulation within the run it belongs to.
36+
* When both :attr:`fix` and :ref:`move <kw_move>` are used, they must use the same grouping method.

doc/gpumd/input_parameters/move.rst

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,15 @@ This keyword is used to move part of the system with a constant velocity.
1010
Syntax
1111
------
1212

13-
The :attr:`move` keyword requires 4 parameters::
13+
The :attr:`move` keyword accepts 4 or 5 parameters::
1414

1515
move <moving_group_id> <velocity_x> <velocity_y> <velocity_z>
16+
move <grouping_method> <moving_group_id> <velocity_x> <velocity_y> <velocity_z>
1617

17-
Here, :attr:`moving_group_id` specifies the group id for the moving part, which should be defined in the grouping method 0.
18-
The next three parameters specify the moving velocity vector, in units of Ångstrom/fs.
18+
- If only :attr:`moving_group_id` and velocities are given, grouping method 0 is used by default.
19+
- If :attr:`grouping_method` is also specified, the given grouping method defined in the :ref:`simulation model file <model_xyz>` will be used.
20+
21+
The last three parameters specify the moving velocity vector, in units of Ångstrom/fs.
1922

2023

2124
Example
@@ -28,12 +31,19 @@ One can first equilibrate the system and then move one group of atoms and at the
2831
run 1000000
2932

3033
# production stage
31-
ensemble nvt_scr 300 300 100
32-
fix 0 # fix atoms in group 0
33-
move 1 0.001 0 0 # move atoms in group 1, with a speed of 0.001 Ångstrom/fs in the x direction
34+
ensemble nvt_ber 300 300 100
35+
fix 0 # fix atoms in group 0 (default grouping method 0)
36+
move 1 0.001 0 0 # move atoms in group 1 (default grouping method 0)
37+
run 1000000
38+
39+
Using a specific grouping method::
40+
41+
ensemble nvt_ber 300 300 100
42+
fix 1 0 # fix group 0 in grouping method 1
43+
move 1 1 0.001 0 0 # move group 1 in grouping method 1
3444
run 1000000
3545

3646
Caveats
3747
-------
38-
* One cannot use NPT when using this keyword.
39-
* Currently, the moving group must be defined in the grouping method 0. This might be extended in a future version.
48+
* One cannot use NPT when using this keyword. Only ``nvt_ber``, ``nvt_nhc``, ``nvt_bdp``, and ``heat_lan`` ensembles are supported.
49+
* When both :ref:`fix <kw_fix>` and :attr:`move` are used, they must use the same grouping method.

0 commit comments

Comments
 (0)