This is the first step for moving the documentation format from *.txt to the *.rst format. In the last years we've been automatically converting txt files from Steve's markup into RST to generate the documentation pages via Sphinx. The decision has now been made to fully migrate to RST and avoid the conversion in the future. This will enable us to fully use RST and Sphinx to improve the documentation. For the intermediate period, while there are still pending PRs with documentation changes, we will keep both source files and update the RST files accordingly.
138 lines
3.6 KiB
ReStructuredText
138 lines
3.6 KiB
ReStructuredText
Commands by category
|
|
====================
|
|
|
|
This page lists most of the LAMMPS commands, grouped by category. The
|
|
:doc:`General commands <Commands_all>` doc page lists all general commands
|
|
alphabetically. Style options for entries like fix, compute, pair etc.
|
|
have their own pages where they are listed alphabetically.
|
|
|
|
Initialization:
|
|
|
|
* :doc:`newton <newton>`,
|
|
* :doc:`package <package>`,
|
|
* :doc:`processors <processors>`,
|
|
* :doc:`suffix <suffix>`,
|
|
* :doc:`units <units>`
|
|
|
|
Setup simulation box:
|
|
|
|
* :doc:`boundary <boundary>`,
|
|
* :doc:`box <box>`,
|
|
* :doc:`change\_box <change_box>`,
|
|
* :doc:`create\_box <create_box>`,
|
|
* :doc:`dimension <dimension>`,
|
|
* :doc:`lattice <lattice>`,
|
|
* :doc:`region <region>`
|
|
|
|
Setup atoms:
|
|
|
|
* :doc:`atom\_modify <atom_modify>`,
|
|
* :doc:`atom\_style <atom_style>`,
|
|
* :doc:`balance <balance>`,
|
|
* :doc:`create\_atoms <create_atoms>`,
|
|
* :doc:`create\_bonds <create_bonds>`,
|
|
* :doc:`delete\_atoms <delete_atoms>`,
|
|
* :doc:`delete\_bonds <delete_bonds>`,
|
|
* :doc:`displace\_atoms <displace_atoms>`,
|
|
* :doc:`group <group>`,
|
|
* :doc:`mass <mass>`,
|
|
* :doc:`molecule <molecule>`,
|
|
* :doc:`read\_data <read_data>`,
|
|
* :doc:`read\_dump <read_dump>`,
|
|
* :doc:`read\_restart <read_restart>`,
|
|
* :doc:`replicate <replicate>`,
|
|
* :doc:`set <set>`,
|
|
* :doc:`velocity <velocity>`
|
|
|
|
Force fields:
|
|
|
|
* :doc:`angle\_coeff <angle_coeff>`,
|
|
* :doc:`angle\_style <angle_style>`,
|
|
* :doc:`bond\_coeff <bond_coeff>`,
|
|
* :doc:`bond\_style <bond_style>`,
|
|
* :doc:`bond\_write <bond_write>`,
|
|
* :doc:`dielectric <dielectric>`,
|
|
* :doc:`dihedral\_coeff <dihedral_coeff>`,
|
|
* :doc:`dihedral\_style <dihedral_style>`,
|
|
* :doc:`improper\_coeff <improper_coeff>`,
|
|
* :doc:`improper\_style <improper_style>`,
|
|
* :doc:`kspace\_modify <kspace_modify>`,
|
|
* :doc:`kspace\_style <kspace_style>`,
|
|
* :doc:`pair\_coeff <pair_coeff>`,
|
|
* :doc:`pair\_modify <pair_modify>`,
|
|
* :doc:`pair\_style <pair_style>`,
|
|
* :doc:`pair\_write <pair_write>`,
|
|
* :doc:`special\_bonds <special_bonds>`
|
|
|
|
Settings:
|
|
|
|
* :doc:`comm\_modify <comm_modify>`,
|
|
* :doc:`comm\_style <comm_style>`,
|
|
* :doc:`info <info>`,
|
|
* :doc:`min\_modify <min_modify>`,
|
|
* :doc:`min\_style <min_style>`,
|
|
* :doc:`neigh\_modify <neigh_modify>`,
|
|
* :doc:`neighbor <neighbor>`,
|
|
* :doc:`partition <partition>`,
|
|
* :doc:`reset\_timestep <reset_timestep>`,
|
|
* :doc:`run\_style <run_style>`,
|
|
* :doc:`timer <timer>`,
|
|
* :doc:`timestep <timestep>`
|
|
|
|
Operations within timestepping (fixes) and diagnostics (computes):
|
|
|
|
* :doc:`compute <compute>`,
|
|
* :doc:`compute\_modify <compute_modify>`,
|
|
* :doc:`fix <fix>`,
|
|
* :doc:`fix\_modify <fix_modify>`,
|
|
* :doc:`uncompute <uncompute>`,
|
|
* :doc:`unfix <unfix>`
|
|
|
|
Output:
|
|
|
|
* :doc:`dump image <dump_image>`,
|
|
* :doc:`dump movie <dump_image>`,
|
|
* :doc:`dump <dump>`,
|
|
* :doc:`dump\_modify <dump_modify>`,
|
|
* :doc:`restart <restart>`,
|
|
* :doc:`thermo <thermo>`,
|
|
* :doc:`thermo\_modify <thermo_modify>`,
|
|
* :doc:`thermo\_style <thermo_style>`,
|
|
* :doc:`undump <undump>`,
|
|
* :doc:`write\_coeff <write_coeff>`,
|
|
* :doc:`write\_data <write_data>`,
|
|
* :doc:`write\_dump <write_dump>`,
|
|
* :doc:`write\_restart <write_restart>`
|
|
|
|
Actions:
|
|
|
|
* :doc:`minimize <minimize>`,
|
|
* :doc:`neb <neb>`,
|
|
* :doc:`neb\_spin <neb_spin>`,
|
|
* :doc:`prd <prd>`,
|
|
* :doc:`rerun <rerun>`,
|
|
* :doc:`run <run>`,
|
|
* :doc:`tad <tad>`,
|
|
* :doc:`temper <temper>`
|
|
|
|
Input script control:
|
|
|
|
* :doc:`clear <clear>`,
|
|
* :doc:`echo <echo>`,
|
|
* :doc:`if <if>`,
|
|
* :doc:`include <include>`,
|
|
* :doc:`jump <jump>`,
|
|
* :doc:`label <label>`,
|
|
* :doc:`log <log>`,
|
|
* :doc:`next <next>`,
|
|
* :doc:`print <print>`,
|
|
* :doc:`python <python>`,
|
|
* :doc:`quit <quit>`,
|
|
* :doc:`shell <shell>`,
|
|
* :doc:`variable <variable>`
|
|
|
|
|
|
.. _lws: http://lammps.sandia.gov
|
|
.. _ld: Manual.html
|
|
.. _lc: Commands_all.html
|