Skip to content

Commit 600d9bd

Browse files
committed
add the decription of output file
1 parent 81c18e9 commit 600d9bd

1 file changed

Lines changed: 28 additions & 7 deletions

File tree

doc/gpumd/input_parameters/compute_chunk.rst

Lines changed: 28 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -106,18 +106,39 @@ Output file
106106
-----------
107107

108108
The results are written to ``compute_chunk.out``.
109-
For each output time, there is one line per chunk with the following format::
109+
The file is appended to if it already exists.
110+
For each output time, there are :math:`N_\text{chunk}` consecutive lines (one per chunk), with the following format per line::
110111

111112
<chunk_id> <coord1> [<coord2>] [<coord3>] <avg_count> <value1> [<value2>] ...
112113

113-
where:
114+
The columns are:
114115

115-
* :attr:`chunk_id` is the zero-based index of the chunk.
116-
* :attr:`coord1` (and :attr:`coord2`, :attr:`coord3` for 2D/3D binning) are the center coordinates of the chunk in Ångströms.
117-
* :attr:`avg_count` is the time-averaged number of atoms in the chunk.
118-
* :attr:`value1`, :attr:`value2`, ... are the time-averaged values of the requested quantities, in the order they were specified in the command.
116+
* :attr:`chunk_id`: the zero-based index of the chunk (dimensionless integer).
117+
* :attr:`coord1` (and :attr:`coord2`, :attr:`coord3` for 2D/3D binning): the center coordinates (in units of Å) of the chunk along the corresponding binning axis.
118+
* :attr:`avg_count`: the time-averaged number of atoms in the chunk (dimensionless).
119+
* :attr:`value1`, :attr:`value2`, ...: the time-averaged values of the requested quantities, in the same order as specified in the command. The units for each quantity are:
119120

120-
Output blocks for successive time points are separated by blank lines.
121+
- :attr:`temperature`: K
122+
- :attr:`density/number`: Å\ :sup:`-3` (number of atoms per volume)
123+
- :attr:`density/mass`: amu/Å\ :sup:`3` (total atomic mass per volume)
124+
- :attr:`vx`, :attr:`vy`, :attr:`vz`: Å/fs
125+
- :attr:`fx`, :attr:`fy`, :attr:`fz`: eV/Å
126+
127+
The temperature is computed from the kinetic energy of the atoms in each chunk as :math:`T = 2 E_\text{k} / (3 k_\text{B} N)`, where :math:`E_\text{k}` is the total kinetic energy, :math:`N` is the atom count, and :math:`k_\text{B}` is the Boltzmann constant.
128+
The velocity and force values are per-atom averages within each chunk.
129+
130+
For example, the command::
131+
132+
compute_chunk 10 100 bin/1d z lower 2.0 temperature density/number
133+
134+
produces output lines of the form::
135+
136+
0 1.000000 52.0 3.0012345678e+02 2.5000000000e-02
137+
1 3.000000 48.0 2.9876543210e+02 2.4000000000e-02
138+
...
139+
140+
Here, each line contains: chunk index, bin center along z (Å), average atom count, temperature (K), and number density (Å\ :sup:`-3`).
141+
The output blocks for successive time points are written consecutively with no blank line separator; each block contains exactly :math:`N_\text{chunk}` lines.
121142

122143

123144
Caveats

0 commit comments

Comments
 (0)