← Back to branch summary

~ubuntu-branches/debian/sid/lammps/sid

« back to all changes in this revision

Viewing changes to doc/dump.html

  • Committer: Package Import Robot
  • Author(s): Anton Gladky
  • Date: 2015-04-29 23:44:49 UTC
  • mfrom: (5.1.3 experimental)
  • Revision ID: package-import@ubuntu.com-20150429234449-mbhy9utku6hp6oq8
Tags: 0~20150313.gitfa668e1-1
Upload into unstable.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/dump.html
25
25
 
26
26
<LI>group-ID = ID of the group of atoms to be dumped 
27
27
 
28
 
<LI>style = <I>atom</I> or <I>atom/mpiio</I> or <I>cfg</I> or <I>dcd</I> or <I>xtc</I> or <I>xyz</I> or <I>xyz/mpiio</I> or <I>image</I> or <I>movie</I> or <I>molfile</I> or <I>local</I> or <I>custom</I> or <I>custom/mpiio</I> 
 
28
<LI>style = <I>atom</I> or <I>atom/mpiio</I> or <I>cfg</I> or <I>cfg/mpiio</I> or <I>dcd</I> or <I>xtc</I> or <I>xyz</I> or <I>xyz/mpiio</I> or <I>image</I> or <I>movie</I> or <I>molfile</I> or <I>local</I> or <I>custom</I> or <I>custom/mpiio</I> 
29
29
 
30
30
<LI>N = dump every this many timesteps 
31
31
 
36
36
<PRE>  <I>atom</I> args = none
37
37
  <I>atom/mpiio</I> args = none
38
38
  <I>cfg</I> args = same as <I>custom</I> args, see below
 
39
  <I>cfg/mpiio</I> args = same as <I>custom</I> args, see below
39
40
  <I>dcd</I> args = none
40
41
  <I>xtc</I> args = none
41
42
  <I>xyz</I> args = none 
57
58
      f_ID[N] = Nth column of local array calculated by a fix with ID 
58
59
</PRE>
59
60
<PRE>  <I>custom</I> of <I>custom/mpiio</I> args = list of atom attributes
60
 
    possible attributes = id, mol, type, element, mass,
 
61
    possible attributes = id, mol, proc, procp1, type, element, mass,
61
62
                          x, y, z, xs, ys, zs, xu, yu, zu, 
62
63
                          xsu, ysu, zsu, ix, iy, iz,
63
64
                          vx, vy, vz, fx, fy, fz,
64
65
                          q, mux, muy, muz, mu,
65
66
                          radius, diameter, omegax, omegay, omegaz,
66
67
                          angmomx, angmomy, angmomz, tqx, tqy, tqz,
67
 
                          spin, eradius, ervel, erforce,
68
68
                          c_ID, c_ID[N], f_ID, f_ID[N], v_name 
69
69
</PRE>
70
70
<PRE>      id = atom ID
71
71
      mol = molecule ID
 
72
      proc = ID of processor that owns atom
 
73
      procp1 = ID+1 of processor that owns atom
72
74
      type = atom type
73
75
      element = name of atom element, as defined by <A HREF = "dump_modify.html">dump_modify</A> command
74
76
      mass = atom mass
86
88
      omegax,omegay,omegaz = angular velocity of spherical particle
87
89
      angmomx,angmomy,angmomz = angular momentum of aspherical particle
88
90
      tqx,tqy,tqz = torque on finite-size particles
89
 
      spin = electron spin
90
 
      eradius = electron radius
91
 
      ervel = electron radial velocity
92
 
      erforce = electron radial force
93
91
      c_ID = per-atom vector calculated by a compute with ID
94
92
      c_ID[N] = Nth column of per-atom array calculated by a compute with ID
95
93
      f_ID = per-atom vector calculated by a fix with ID
96
94
      f_ID[N] = Nth column of per-atom array calculated by a fix with ID
97
 
      v_name = per-atom vector calculated by an atom-style variable with name 
 
95
      v_name = per-atom vector calculated by an atom-style variable with name
 
96
      d_name = per-atom floating point vector with name, managed by fix property/atom
 
97
      i_name = per-atom integer vector with name, managed by fix property/atom 
98
98
</PRE>
99
99
 
100
100
</UL>
108
108
dump 4b flow custom 100 dump.%.myforce id type c_myF[3] v_ke
109
109
dump 2 inner cfg 10 dump.snap.*.cfg mass type xs ys zs vx vy vz
110
110
dump snap all cfg 100 dump.config.*.cfg mass type xs ys zs id type c_Stress[2]
111
 
dump 1 all xtc 1000 file.xtc
112
 
dump e_data all custom 100 dump.eff id type x y z spin eradius fx fy fz eforce 
 
111
dump 1 all xtc 1000 file.xtc 
113
112
</PRE>
114
113
<P><B>Description:</B>
115
114
</P>
151
150
atom ID is on by default. See the <A HREF = "dump_modify.html">dump_modify</A> doc
152
151
page for details.
153
152
</P>
154
 
<P>As explained below, the <I>atom/mpiio</I>, <I>custom/mpiio</I>, and <I>xyz/mpiio</I>
155
 
styles are identical in command syntax and in the format of the dump
156
 
files they create, to the corresponding styles without "mpiio", except
157
 
the single dump file they produce is written in parallel via the
158
 
MPI-IO library.  For the remainder of this doc page, you should thus
159
 
consider the <I>atom</I> and <I>atom/mpiio</I> styles (etc) to be
160
 
inter-changeable.  The one exception is how the filename is specified
161
 
for the MPI-IO styles, as explained below.
 
153
<P>As explained below, the <I>atom/mpiio</I>, <I>cfg/mpiio</I>, <I>custom/mpiio</I>, and
 
154
<I>xyz/mpiio</I> styles are identical in command syntax and in the format
 
155
of the dump files they create, to the corresponding styles without
 
156
"mpiio", except the single dump file they produce is written in
 
157
parallel via the MPI-IO library.  For the remainder of this doc page,
 
158
you should thus consider the <I>atom</I> and <I>atom/mpiio</I> styles (etc) to
 
159
be inter-changeable.  The one exception is how the filename is
 
160
specified for the MPI-IO styles, as explained below.
162
161
</P>
163
162
<HR>
164
163
 
369
368
<P>Note that using the "*" and "%" characters together can produce a
370
369
large number of small dump files!
371
370
</P>
372
 
<P>For the <I>atom/mpiio</I>, <I>custom/mpiio</I>, and <I>xyz/mpiio</I> styles, a single
373
 
dump file is written in parallel via the MPI-IO library, which is part
374
 
of the MPI standard for versions 2.0 and above.  Using MPI-IO requires
375
 
two steps.  First, build LAMMPS with its MPIIO package installed, e.g.
 
371
<P>For the <I>atom/mpiio</I>, <I>cfg/mpiio</I>, <I>custom/mpiio</I>, and <I>xyz/mpiio</I>
 
372
styles, a single dump file is written in parallel via the MPI-IO
 
373
library, which is part of the MPI standard for versions 2.0 and above.
 
374
Using MPI-IO requires two steps.  First, build LAMMPS with its MPIIO
 
375
package installed, e.g.
376
376
</P>
377
377
<PRE>make yes-mpiio    # installs the MPIIO package
378
378
make g++          # build LAMMPS for your platform 
465
465
<P>This section explains the atom attributes that can be specified as
466
466
part of the <I>custom</I> and <I>cfg</I> styles.
467
467
</P>
468
 
<P>The <I>id</I>, <I>mol</I>, <I>type</I>, <I>element</I>, <I>mass</I>, <I>vx</I>, <I>vy</I>, <I>vz</I>, <I>fx</I>, <I>fy</I>,
469
 
<I>fz</I>, <I>q</I> attributes are self-explanatory.
 
468
<P>The <I>id</I>, <I>mol</I>, <I>proc</I>, <I>procp1</I>, <I>type</I>, <I>element</I>, <I>mass</I>, <I>vx</I>,
 
469
<I>vy</I>, <I>vz</I>, <I>fx</I>, <I>fy</I>, <I>fz</I>, <I>q</I> attributes are self-explanatory.
470
470
</P>
471
471
<P><I>Id</I> is the atom ID.  <I>Mol</I> is the molecule ID, included in the data
472
 
file for molecular systems.  <I>Type</I> is the atom type.  <I>Element</I> is
473
 
typically the chemical name of an element, which you must assign to
474
 
each type via the <A HREF = "dump_modify.html">dump_modify element</A> command.
475
 
More generally, it can be any string you wish to associated with an
476
 
atom type.  <I>Mass</I> is the atom mass.  <I>Vx</I>, <I>vy</I>, <I>vz</I>, <I>fx</I>, <I>fy</I>,
477
 
<I>fz</I>, and <I>q</I> are components of atom velocity and force and atomic
478
 
charge.
 
472
file for molecular systems.  <I>Proc</I> is the ID of the processor (0 to
 
473
Nprocs-1) that currently owns the atom.  <I>Procp1</I> is the proc ID+1,
 
474
which can be convenient in place of a <I>type</I> attribute (1 to Ntypes)
 
475
for coloring atoms in a visualization program.  <I>Type</I> is the atom
 
476
type (1 to Ntypes).  <I>Element</I> is typically the chemical name of an
 
477
element, which you must assign to each type via the <A HREF = "dump_modify.html">dump_modify
 
478
element</A> command.  More generally, it can be any
 
479
string you wish to associated with an atom type.  <I>Mass</I> is the atom
 
480
mass.  <I>Vx</I>, <I>vy</I>, <I>vz</I>, <I>fx</I>, <I>fy</I>, <I>fz</I>, and <I>q</I> are components of
 
481
atom velocity and force and atomic charge.
479
482
</P>
480
483
<P>There are several options for outputting atom coordinates.  The <I>x</I>,
481
484
<I>y</I>, <I>z</I> attributes write atom coordinates "unscaled", in the
523
526
can sustain a rotational torque due to interactions with other
524
527
particles.
525
528
</P>
526
 
<P>The <I>spin</I>, <I>eradius</I>, <I>ervel</I>, and <I>erforce</I> attributes are for
527
 
particles that represent nuclei and electrons modeled with the
528
 
electronic force field (EFF).  See <A HREF = "atom_style.html">atom_style
529
 
electron</A> and <A HREF = "pair_eff.html">pair_style eff</A> for more
530
 
details.
531
 
</P>
532
529
<P>The <I>c_ID</I> and <I>c_ID[N]</I> attributes allow per-atom vectors or arrays
533
530
calculated by a <A HREF = "compute.html">compute</A> to be output.  The ID in the
534
531
attribute should be replaced by the actual ID of the compute that has
574
571
this is a very general means of creating quantities to output to a
575
572
dump file.
576
573
</P>
 
574
<P>The <I>d_name</I> and <I>i_name</I> attributes allow to output custom per atom
 
575
floating point or integer properties that are managed by
 
576
<A HREF = "fix_property_atom.html">fix property/atom</A>.
 
577
</P>
577
578
<P>See <A HREF = "Section_modify.html">Section_modify</A> of the manual for information
578
579
on how to add new compute and fix styles to LAMMPS to calculate
579
580
per-atom quantities which could then be output into dump files.
586
587
-DLAMMPS_GZIP option - see the <A HREF = "Section_start.html#start_2">Making
587
588
LAMMPS</A> section of the documentation.
588
589
</P>
589
 
<P>The <I>atom/mpiio</I>, <I>custom/mpiio</I>, and <I>xyz/mpiio</I> styles are part of
590
 
the MPIIO package.  They are only enabled if LAMMPS was built with
591
 
that package.  See the <A HREF = "Section_start.html#start_3">Making LAMMPS</A>
592
 
section for more info.
 
590
<P>The <I>atom/mpiio</I>, <I>cfg/mpiio</I>, <I>custom/mpiio</I>, and <I>xyz/mpiio</I> styles
 
591
are part of the MPIIO package.  They are only enabled if LAMMPS was
 
592
built with that package.  See the <A HREF = "Section_start.html#start_3">Making
 
593
LAMMPS</A> section for more info.
593
594
</P>
594
595
<P>The <I>xtc</I> style is part of the XTC package.  It is only enabled if
595
596
LAMMPS was built with that package.  See the <A HREF = "Section_start.html#start_3">Making
615
616
</P>
616
617
<P><B>Default:</B>
617
618
</P>
618
 
<P>The defaults for the image style are listed on the <A HREF = "dump_image.html">dump
619
 
image</A> doc page.
 
619
<P>The defaults for the <I>image</I> and <I>movie</I> styles are listed on the
 
620
<A HREF = "dump_image.html">dump image</A> doc page.
620
621
</P>
621
622
</HTML>