Commands
========

This section describes how a LIGGGHTS(R)-PUBLIC input script is formatted and the
input script commands used to define a LIGGGHTS(R)-PUBLIC simulation.


.. contents:: 
		:local:
		:depth: 1
   




.. _cmd_1:

.. _comm:

List of all commands
-------------------------------------------

This section lists all LIGGGHTS commands alphabetically, with a separate
listing below of styles within certain commands. Note
that some style options for some commands are part of 
packages, which means they cannot be used unless the package was
included when LAMMPS was built.  Not all packages are included in a
default build.  These dependencies are listed as Restrictions
in the command's documentation.

+------------------------------------+------------------------------------+------------------------------------+----------------------------------------+----------------------------------------+----------------------------------------+
| :doc:`atom_modify <atom_modify>`   | :doc:`atom_style <atom_style>`     | :doc:`bond_coeff <bond_coeff>`     | :doc:`bond_style <bond_style>`         | :doc:`boundary <boundary>`             | :doc:`box <box>`                       |
+------------------------------------+------------------------------------+------------------------------------+----------------------------------------+----------------------------------------+----------------------------------------+
| :doc:`change_box <change_box>`     | :doc:`clear <clear>`               | :doc:`communicate <communicate>`   | :doc:`compute <compute>`               | :doc:`compute_modify <compute_modify>` | :doc:`create_atoms <create_atoms>`     |
+------------------------------------+------------------------------------+------------------------------------+----------------------------------------+----------------------------------------+----------------------------------------+
| :doc:`create_box <create_box>`     | :doc:`delete_atoms <delete_atoms>` | :doc:`delete_bonds <delete_bonds>` | :doc:`dielectric <dielectric>`         | :doc:`dimension <dimension>`           | :doc:`displace_atoms <displace_atoms>` |
+------------------------------------+------------------------------------+------------------------------------+----------------------------------------+----------------------------------------+----------------------------------------+
| :doc:`dump <dump>`                 | :doc:`dump_modify <dump_modify>`   | :doc:`echo <echo>`                 | :doc:`fix <fix>`                       | :doc:`fix_modify <fix_modify>`         | :doc:`group <group>`                   |
+------------------------------------+------------------------------------+------------------------------------+----------------------------------------+----------------------------------------+----------------------------------------+
| :doc:`if <if>`                     | :doc:`include <include>`           | :doc:`info <info>`                 | :doc:`jump <jump>`                     | :doc:`label <label>`                   | :doc:`lattice <lattice>`               |
+------------------------------------+------------------------------------+------------------------------------+----------------------------------------+----------------------------------------+----------------------------------------+
| :doc:`log <log>`                   | :doc:`mass <mass>`                 | :doc:`neigh_modify <neigh_modify>` | :doc:`neigh_settings <neigh_modify>`   | :doc:`neighbor <neighbor>`             | :doc:`neighbor_skin <neighbor>`        |
+------------------------------------+------------------------------------+------------------------------------+----------------------------------------+----------------------------------------+----------------------------------------+
| :doc:`newton <newton>`             | :doc:`next <next>`                 | :doc:`orient <orient>`             | :doc:`origin <origin>`                 | :doc:`pair_coeff <pair_coeff>`         | :doc:`pair_style <pair_style>`         |
+------------------------------------+------------------------------------+------------------------------------+----------------------------------------+----------------------------------------+----------------------------------------+
| :doc:`partition <partition>`       | :doc:`print <print>`               | :doc:`processors <processors>`     | :doc:`quit <quit>`                     | :doc:`read_data <read_data>`           | :doc:`read_dump <read_dump>`           |
+------------------------------------+------------------------------------+------------------------------------+----------------------------------------+----------------------------------------+----------------------------------------+
| :doc:`read_restart <read_restart>` | :doc:`region <region>`             | :doc:`replicate <replicate>`       | :doc:`reset_timestep <reset_timestep>` | :doc:`restart <restart>`               | :doc:`run <run>`                       |
+------------------------------------+------------------------------------+------------------------------------+----------------------------------------+----------------------------------------+----------------------------------------+
| :doc:`run_style <run_style>`       | :doc:`set <set>`                   | :doc:`shell <shell>`               | :doc:`thermo <thermo>`                 | :doc:`thermo_modify <thermo_modify>`   | :doc:`thermo_style <thermo_style>`     |
+------------------------------------+------------------------------------+------------------------------------+----------------------------------------+----------------------------------------+----------------------------------------+
| :doc:`timestep <timestep>`         | :doc:`uncompute <uncompute>`       | :doc:`undump <undump>`             | :doc:`unfix <unfix>`                   | :doc:`units <units>`                   | :doc:`variable <variable>`             |
+------------------------------------+------------------------------------+------------------------------------+----------------------------------------+----------------------------------------+----------------------------------------+
| :doc:`velocity <velocity>`         | :doc:`write_data <write_data>`     | :doc:`write_dump <write_dump>`     | :doc:`write_restart <write_restart>`   |                                        |                                        |
+------------------------------------+------------------------------------+------------------------------------+----------------------------------------+----------------------------------------+----------------------------------------+


----------


bond_style potentials
---------------------

See the :doc:`bond_style <bond_style>` command for an overview of bond
potentials.  Click on the style itself for a full description:

+---------------------------------+-----------------------------+-------------------------+
| :doc:`harmonic <bond_harmonic>` | :doc:`hybrid <bond_hybrid>` | :doc:`none <bond_none>` |
+---------------------------------+-----------------------------+-------------------------+

compute styles
--------------

See the :doc:`compute <compute>` command for one-line descriptions of
each style or click on the style itself for a full description:

+----------------------------------------------------------+------------------------------------------------------------+--------------------------------------------------------------------+--------------------------------------------------+
| :doc:`atom/molecule <compute_atom_molecule>`             | :doc:`bond/local <compute_bond_local>`                     | :doc:`centro/atom <compute_centro_atom>`                           | :doc:`cluster/atom <compute_cluster_atom>`       |
+----------------------------------------------------------+------------------------------------------------------------+--------------------------------------------------------------------+--------------------------------------------------+
| :doc:`cna/atom <compute_cna_atom>`                       | :doc:`com <compute_com>`                                   | :doc:`com/molecule <compute_com_molecule>`                         | :doc:`contact/atom <compute_contact_atom>`       |
+----------------------------------------------------------+------------------------------------------------------------+--------------------------------------------------------------------+--------------------------------------------------+
| :doc:`contact/atom/gran <compute_contact_atom>`          | :doc:`coord/atom <compute_coord_atom>`                     | :doc:`coord/gran <compute_coord_gran>`                             | :doc:`displace/atom <compute_displace_atom>`     |
+----------------------------------------------------------+------------------------------------------------------------+--------------------------------------------------------------------+--------------------------------------------------+
| :doc:`erotate <compute_erotate>`                         | :doc:`erotate/asphere <compute_erotate_asphere>`           | :doc:`erotate/multisphere <compute_erotate_multisphere>`           | :doc:`erotate/sphere <compute_erotate_sphere>`   |
+----------------------------------------------------------+------------------------------------------------------------+--------------------------------------------------------------------+--------------------------------------------------+
| :doc:`erotate/sphere/atom <compute_erotate_sphere_atom>` | :doc:`erotate/superquadric <compute_erotate_superquadric>` | :doc:`group/group <compute_group_group>`                           | :doc:`gyration <compute_gyration>`               |
+----------------------------------------------------------+------------------------------------------------------------+--------------------------------------------------------------------+--------------------------------------------------+
| :doc:`gyration/molecule <compute_gyration_molecule>`     | :doc:`inertia/molecule <compute_inertia_molecule>`         | :doc:`ke <compute_ke>`                                             | :doc:`ke/atom <compute_ke_atom>`                 |
+----------------------------------------------------------+------------------------------------------------------------+--------------------------------------------------------------------+--------------------------------------------------+
| :doc:`ke/multisphere <compute_ke_multisphere>`           | :doc:`msd <compute_msd>`                                   | :doc:`msd/molecule <compute_msd_molecule>`                         | :doc:`msd/nongauss <compute_msd_nongauss>`       |
+----------------------------------------------------------+------------------------------------------------------------+--------------------------------------------------------------------+--------------------------------------------------+
| :doc:`multisphere <compute_rigid>`                       | :doc:`multisphere/single <compute_rigid>`                  | :doc:`nparticles/tracer/region <compute_nparticles_tracer_region>` | :doc:`pair/gran/local <compute_pair_gran_local>` |
+----------------------------------------------------------+------------------------------------------------------------+--------------------------------------------------------------------+--------------------------------------------------+
| :doc:`pe <compute_pe>`                                   | :doc:`pe/atom <compute_pe_atom>`                           | :doc:`pressure <compute_pressure>`                                 | :doc:`property/atom <compute_property_atom>`     |
+----------------------------------------------------------+------------------------------------------------------------+--------------------------------------------------------------------+--------------------------------------------------+
| :doc:`property/local <compute_property_local>`           | :doc:`property/molecule <compute_property_molecule>`       | :doc:`rdf <compute_rdf>`                                           | :doc:`reduce <compute_reduce>`                   |
+----------------------------------------------------------+------------------------------------------------------------+--------------------------------------------------------------------+--------------------------------------------------+
| :doc:`reduce/region <compute_reduce>`                    | :doc:`rigid <compute_rigid>`                               | :doc:`slice <compute_slice>`                                       | :doc:`stress/atom <compute_stress_atom>`         |
+----------------------------------------------------------+------------------------------------------------------------+--------------------------------------------------------------------+--------------------------------------------------+
| :doc:`voronoi/atom <compute_voronoi_atom>`               | :doc:`wall/gran/local <compute_pair_gran_local>`           |                                                                    |                                                  |
+----------------------------------------------------------+------------------------------------------------------------+--------------------------------------------------------------------+--------------------------------------------------+

dump styles
-----------

See the :doc:`dump <dump>` command for one-line descriptions
of each style or click on the style itself for a full description:

+-------------------------------------+---------------------------+---------------------------------------------+---------------------------+
| :doc:`custom/vtk <dump_custom_vtk>` | :doc:`image <dump_image>` | :doc:`local/gran/vtk <dump_local_gran_vtk>` | :doc:`movie <dump_image>` |
+-------------------------------------+---------------------------+---------------------------------------------+---------------------------+

fix styles
----------

See the :doc:`fix <fix>` command for one-line descriptions
of each style or click on the style itself for a full description:

+--------------------------------------------------------------------------+------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+------------------------------------------------------------------------+
| :doc:`adapt <fix_adapt>`                                                 | :doc:`addforce <fix_addforce>`                                                     | :doc:`ave/atom <fix_ave_atom>`                                                       | :doc:`ave/correlate <fix_ave_correlate>`                               |
+--------------------------------------------------------------------------+------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+------------------------------------------------------------------------+
| :doc:`ave/euler <fix_ave_euler>`                                         | :doc:`ave/histo <fix_ave_histo>`                                                   | :doc:`ave/spatial <fix_ave_spatial>`                                                 | :doc:`ave/time <fix_ave_time>`                                         |
+--------------------------------------------------------------------------+------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+------------------------------------------------------------------------+
| :doc:`aveforce <fix_aveforce>`                                           | :doc:`bond/break <fix_bond_break>`                                                 | :doc:`bond/create <fix_bond_create>`                                                 | :doc:`box/relax <fix_box_relax>`                                       |
+--------------------------------------------------------------------------+------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+------------------------------------------------------------------------+
| :doc:`buoyancy <fix_buoyancy>`                                           | :doc:`check/timestep/gran <fix_check_timestep_gran>`                               | :doc:`continuum/weighted <fix_continuum_weighted>`                                   | :doc:`couple/cfd <fix_couple_cfd>`                                     |
+--------------------------------------------------------------------------+------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+------------------------------------------------------------------------+
| :doc:`deform <fix_deform>`                                               | :doc:`drag <fix_drag>`                                                             | :doc:`dt/reset <fix_dt_reset>`                                                       | :doc:`efield <fix_efield>`                                             |
+--------------------------------------------------------------------------+------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+------------------------------------------------------------------------+
| :doc:`enforce2d <fix_enforce2d>`                                         | :doc:`external <fix_external>`                                                     | :doc:`freeze <fix_freeze>`                                                           | :doc:`gravity <fix_gravity>`                                           |
+--------------------------------------------------------------------------+------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+------------------------------------------------------------------------+
| :doc:`heat/gran <fix_heat_gran_conduction>`                              | :doc:`heat/gran/conduction <fix_heat_gran_conduction>`                             | :doc:`insert/pack <fix_insert_pack>`                                                 | :doc:`insert/rate/region <fix_insert_rate_region>`                     |
+--------------------------------------------------------------------------+------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+------------------------------------------------------------------------+
| :doc:`insert/stream <fix_insert_stream>`                                 | :doc:`lineforce <fix_lineforce>`                                                   | :doc:`massflow/mesh <fix_massflow_mesh>`                                             | :doc:`massflow/mesh/sieve <fix_massflow_mesh_sieve>`                   |
+--------------------------------------------------------------------------+------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+------------------------------------------------------------------------+
| :doc:`mesh/surface <fix_mesh_surface>`                                   | :doc:`mesh/surface/planar <fix_mesh_surface>`                                      | :doc:`momentum <fix_momentum>`                                                       | :doc:`move <fix_move>`                                                 |
+--------------------------------------------------------------------------+------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+------------------------------------------------------------------------+
| :doc:`move/mesh <fix_move_mesh>`                                         | :doc:`multicontact/halfspace <fix_multicontact_halfspace>`                         | :doc:`multisphere <fix_multisphere>`                                                 | :doc:`multisphere/break <fix_multisphere_break>`                       |
+--------------------------------------------------------------------------+------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+------------------------------------------------------------------------+
| :doc:`nve <fix_nve>`                                                     | :doc:`nve/asphere <fix_nve_asphere>`                                               | :doc:`nve/asphere/noforce <fix_nve_asphere_noforce>`                                 | :doc:`nve/limit <fix_nve_limit>`                                       |
+--------------------------------------------------------------------------+------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+------------------------------------------------------------------------+
| :doc:`nve/line <fix_nve_line>`                                           | :doc:`nve/noforce <fix_nve_noforce>`                                               | :doc:`nve/sphere <fix_nve_sphere>`                                                   | :doc:`nve/superquadric <fix_nve_superquadric>`                         |
+--------------------------------------------------------------------------+------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+------------------------------------------------------------------------+
| :doc:`particledistribution/discrete <fix_particledistribution_discrete>` | :doc:`particledistribution/discrete/massbased <fix_particledistribution_discrete>` | :doc:`particledistribution/discrete/numberbased <fix_particledistribution_discrete>` | :doc:`particletemplate/multisphere <fix_particletemplate_multisphere>` |
+--------------------------------------------------------------------------+------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+------------------------------------------------------------------------+
| :doc:`particletemplate/sphere <fix_particletemplate_sphere>`             | :doc:`particletemplate/superquadric <fix_particletemplate_superquadric>`           | :doc:`planeforce <fix_planeforce>`                                                   | :doc:`poems <fix_poems>`                                               |
+--------------------------------------------------------------------------+------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+------------------------------------------------------------------------+
| :doc:`print <fix_print>`                                                 | :doc:`property/atom <fix_property>`                                                | :doc:`property/atom/regiontracer/time <fix_property_atom_region_tracer_time>`        | :doc:`property/atom/tracer <fix_property_atom_tracer>`                 |
+--------------------------------------------------------------------------+------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+------------------------------------------------------------------------+
| :doc:`property/atom/tracer/stream <fix_property_atom_tracer_stream>`     | :doc:`property/global <fix_property>`                                              | :doc:`rigid <fix_rigid>`                                                             | :doc:`rigid/nph <fix_rigid>`                                           |
+--------------------------------------------------------------------------+------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+------------------------------------------------------------------------+
| :doc:`rigid/npt <fix_rigid>`                                             | :doc:`rigid/nve <fix_rigid>`                                                       | :doc:`rigid/nvt <fix_rigid>`                                                         | :doc:`rigid/small <fix_rigid>`                                         |
+--------------------------------------------------------------------------+------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+------------------------------------------------------------------------+
| :doc:`setforce <fix_setforce>`                                           | :doc:`sph/density/continuity <fix_sph_density_continuity>`                         | :doc:`sph/density/corr <fix_sph_density_corr>`                                       | :doc:`sph/density/summation <fix_sph_density_summation>`               |
+--------------------------------------------------------------------------+------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+------------------------------------------------------------------------+
| :doc:`sph/pressure <fix_sph_pressure>`                                   | :doc:`spring <fix_spring>`                                                         | :doc:`spring/rg <fix_spring_rg>`                                                     | :doc:`spring/self <fix_spring_self>`                                   |
+--------------------------------------------------------------------------+------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+------------------------------------------------------------------------+
| :doc:`store/force <fix_store_force>`                                     | :doc:`store/state <fix_store_state>`                                               | :doc:`viscous <fix_viscous>`                                                         | :doc:`wall/gran <fix_wall_gran>`                                       |
+--------------------------------------------------------------------------+------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+------------------------------------------------------------------------+
| :doc:`wall/reflect <fix_wall_reflect>`                                   | :doc:`wall/region <fix_wall_region>`                                               | :doc:`wall/region/sph <fix_wall_region_sph>`                                         |                                                                        |
+--------------------------------------------------------------------------+------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+------------------------------------------------------------------------+

pair_style potentials
---------------------

See the :doc:`pair_style <pair_style>` command for an overview of pair
potentials.  Click on the style itself for a full description:

+---------------------------+-------------------------+---------------------------------------------------------+-------------------------------------+
| :doc:`bubble <pair_gran>` | :doc:`gran <pair_gran>` | :doc:`hybrid <pair_hybrid>`                             | :doc:`hybrid/overlay <pair_hybrid>` |
+---------------------------+-------------------------+---------------------------------------------------------+-------------------------------------+
| :doc:`none <pair_none>`   | :doc:`soft <pair_soft>` | :doc:`sph/artVisc/tensCorr <pair_sph_artvisc_tenscorr>` |                                     |
+---------------------------+-------------------------+---------------------------------------------------------+-------------------------------------+


.. _liws: http://www.cfdem.com
.. _ld: Manual.html
.. _lc: Section_commands.html#comm