From 0e5c36676f1dc94e44da763d91388b88797408a0 Mon Sep 17 00:00:00 2001
From: sjplimp
The LAMMPS distribution includes an examples sub-directory with -several sample problems. Each problem is in a sub-directory of its -own. Most are 2d models so that they run quickly, requiring at most a -couple of minutes to run on a desktop machine. Each problem has an -input script (in.*) and produces a log file (log.*) and dump file -(dump.*) when it runs. Some use a data file (data.*) of initial -coordinates as additional input. A few sample log file outputs on -different machines and different numbers of processors are included in -the directories to compare your answers to. E.g. a log file like -log.crack.foo.P means it ran on P processors of machine “foo”.
-For examples that use input data files, many of them were produced by -Pizza.py or setup tools described in the -Additional Tools section of the LAMMPS -documentation and provided with the LAMMPS distribution.
+The LAMMPS distribution includes an examples sub-directory with many +sample problems. Many are 2d models that run quickly are are +straightforward to visualize, requiring at most a couple of minutes to +run on a desktop machine. Each problem has an input script (in.*) and +produces a log file (log.*) when it runs. Some use a data file +(data.*) of initial coordinates as additional input. A few sample log +file run on different machines and different numbers of processors are +included in the directories to compare your answers to. E.g. a log +file like log.date.crack.foo.P means the “crack” example was run on P +processors of machine “foo” on that date (i.e. with that version of +LAMMPS).
+Many of the input files have commented-out lines for creating dump +files and image files.
If you uncomment the dump command in the input script, a text dump file will be produced, which can be animated by various visualization programs. It can @@ -160,69 +163,77 @@ script, and assuming you have built LAMMPS with a JPG library, JPG snapshot images will be produced when the simulation runs. They can be quickly post-processed into a movie using commands described on the dump image doc page.
-Animations of many of these examples can be viewed on the Movies -section of the LAMMPS WWW Site.
-These are the sample problems in the examples sub-directories:
+Animations of many of the examples can be viewed on the Movies section +of the LAMMPS web site.
+There are two kinds of sub-directories in the examples dir. Lowercase +dirs contain one or a few simple, quick-to-run problems. Uppercase +dirs contain up to several complex scripts that illustrate a +particular kind of simulation method or model. Some of these run for +longer times, e.g. to measure a particular quantity.
+Lists of both kinds of directories are given below.
+| balance | +|
| accelerate | +run with various acceleration options (OpenMP, GPU, Phi) | +
| balance | dynamic load balancing, 2d system |
| body | +|
| body | body particles, 2d system |
| colloid | +|
| colloid | big colloid particles in a small particle solvent, 2d system |
| comb | +|
| comb | models using the COMB potential |
| coreshell | +core/shell model using CORESHELL package | +
| crack | crack propagation in a 2d solid |
| cuda | use of the USER-CUDA package for GPU acceleration |
| dipole | +|
| deposit | +deposit atoms and molecules on a surface | +
| dipole | point dipolar particles, 2d system |
| dreiding | +|
| dreiding | methanol via Dreiding FF |
| eim | +|
| eim | NaCl using the EIM potential |
| ellipse | +|
| ellipse | ellipsoidal particles in spherical solvent, 2d system |
| flow | +|
| flow | Couette and Poiseuille flow in a 2d channel |
| friction | +|
| friction | frictional contact of spherical asperities between 2d surfaces |
| gpu | -use of the GPU package for GPU acceleration | -
| hugoniostat | Hugoniostat shock dynamics |
| indent | spherical indenter into a 2d solid |
| intel | -use of the USER-INTEL package for CPU or Intel(R) Xeon Phi(TM) coprocessor | -
| kim | +|
| kim | use of potentials in Knowledge Base for Interatomic Models (KIM) |
| line | -line segment particles in 2d rigid bodies | -
| meam | MEAM test for SiC and shear (same as shear examples) |
| prd | parallel replica dynamics of vacancy diffusion in bulk Si |
| qeq | +|
| python | +using embedded Python in a LAMMPS input script | +
| qeq | use of the QEQ package for charge equilibration |
| reax | +|
| reax | RDX and TATB models using the ReaxFF |
| rigid | +|
| rigid | rigid bodies modeled as independent or coupled |
| shear | +|
| shear | sideways shear applied to 2d solid, with and without a void |
| snap | +|
| snap | NVE dynamics for BCC tantalum crystal using SNAP potential |
| srd | +|
| srd | stochastic rotation dynamics (SRD) particles as solvent |
| streitz | +use of Streitz/Mintmire potential with charge equilibration | +
| tad | temperature-accelerated dynamics of vacancy diffusion in bulk Si |
| tri | -triangular particles in rigid bodies | +
| vashishta | +use of the Vashishta potential |
vashishta: models using the Vashishta potential
-Here is how you might run and visualize one of the sample problems:
+Here is how you can run and visualize one of the sample problems:
cd indent
cp ../../src/lmp_linux . # copy LAMMPS executable to this dir
lmp_linux -in in.indent # run the problem
Running the simulation produces the files dump.indent and -log.lammps. You can visualize the dump file as follows:
-../../tools/xmovie/xmovie -scale dump.indent
-If you uncomment the dump image line(s) in the input -script a series of JPG images will be produced by the run. These can -be viewed individually or turned into a movie or animated by tools -like ImageMagick or QuickTime or various Windows-based tools. See the +script a series of JPG images will be produced by the run (assuming +you built LAMMPS with JPG support; see Section start 2.2 for details). These can be viewed +individually or turned into a movie or animated by tools like +ImageMagick or QuickTime or various Windows-based tools. See the dump image doc page for more details. E.g. this Imagemagick command would create a GIF file suitable for viewing in a browser.
% convert -loop 1 *.jpg foo.gif
There is also a COUPLE directory with examples of how to use LAMMPS as -a library, either by itself or in tandem with another code or library. -See the COUPLE/README file to get started.
-There is also an ELASTIC directory with an example script for -computing elastic constants at zero temperature, using an Si example. See -the ELASTIC/in.elastic file for more info.
-There is also an ELASTIC_T directory with an example script for -computing elastic constants at finite temperature, using an Si example. See -the ELASTIC_T/in.elastic file for more info.
-There is also a USER directory which contains subdirectories of -user-provided examples for user packages. See the README files in -those directories for more info. See the -Section_start.html file for more info about user -packages.
+| ASPHERE | +various aspherical particle models, using ellipsoids, rigid bodies, line/triangle particles, etc | +
| COUPLE | +examples of how to use LAMMPS as a library | +
| DIFFUSE | +compute diffusion coefficients via several methods | +
| ELASTIC | +compute elastic constants at zero temperature | +
| ELASTIC_T | +compute elastic constants at finite temperature | +
| KAPPA | +compute thermal conductivity via several methods | +
| MC | +using LAMMPS in a Monte Carlo mode to relax the energy of a system | +
| USER | +examples for USER packages and USER-contributed commands | +
| VISCOSITY | +compute viscosity via several methods | +
Nearly all of these directories have README files which give more +details on how to understand and use their contents.
+The USER directory has a large number of sub-directories which +correspond by name to a USER package. They contain scripts that +illustrate how to use the command(s) provided in that package. Many +of the sub-directories have their own README files which give further +instructions. See the Section packages doc +page for more info on specific USER packages.
+Note
-The sub-sections below are still being filled in, as of Feb -2016.
+The USER package sub-sections below are still being filled in, +as of March 2016.
Unless otherwise noted below, every package is independent of all the others. I.e. any package can be included or excluded in a LAMMPS @@ -311,10 +314,7 @@ name links to a sub-section below with more details.
The “Authors” column lists a name(s) if a specific person is responible for creating and maintaining the package.
-(1) The FLD package was created by Amit Kumar and Michael Bybee from -Jonathan Higdon’s group at UIUC.
+(1) The COLLOID package includes Fast Lubrication Dynamics pair styles +which were created by Amit Kumar and Michael Bybee from Jonathan +Higdon’s group at UIUC.
(2) The OPT package was created by James Fischer (High Performance Technologies), David Richie, and Vincent Natoli (Stone Ridge Technolgy).
(3) The KIM package was created by Valeriu Smirichinski, Ryan Elliott, and Ellad Tadmor (U Minn).
-(4) The KOKKOS package was created primarily by Christian Trott -(Sandia). It uses the Kokkos library which was developed by Carter -Edwards, Christian, and collaborators at Sandia.
+(4) The KOKKOS package was created primarily by Christian Trott and +Stan Moore (Sandia). It uses the Kokkos library which was developed +by Carter Edwards, Christian Trott, and others at Sandia.
The “Doc page” column links to either a sub-section of the Section_howto of the manual, or an input script command implemented as part of the package, or to additional @@ -644,8 +632,8 @@ p.s.: are we ever going to get commit messages from you? ;-)
Contents: Aspherical particle models for ellipsoids, 2d lines, 3d -triangles.
+Contents: Several computes, time-integration fixes, and pair styles +for aspherical particle models: ellipsoids, 2d lines, 3d triangles.
To install via make or Make.py:
make yes-asphere
make machine
@@ -662,13 +650,18 @@ make machine
Make.py -p ^asphere -a machine
-Supporting info: examples/ASPHERE, examples/ellipse, Section howto
-6.14, pair gayberne
+Supporting info: Section howto 6.14,
+pair_style gayberne, pair_style resquared,
+doc/PDF/pair_gayberne_extra.pdf,
+doc/PDF/pair_resquared_extra.pdf,
+examples/ASPHERE, examples/ellipse
Contents:
+Contents: Support for body-style particles. Computes, +time-integration fixes, pair styles, as well as the body styles +themselves. See the body doc page for an overview.
To install via make or Make.py:
make yes-body
make machine
@@ -685,12 +678,14 @@ make machine
Make.py -p ^body -a machine
-Supporting info: examples/body
+Supporting info: atom_style body, body,
+pair_style body, examples/body
Contents:
+Contents: Bond, angle, dihedral, improper, and pair styles for the +COMPASS CLASS2 molecular force field.
To install via make or Make.py:
make yes-class2
make machine
@@ -707,12 +702,16 @@ make machine
Make.py -p ^class2 -a machine
-Supporting info:
+Supporting info: bond_style class2, angle_style class2, dihedral_style class2, improper_style class2, pair_style lj/class2
Contents:
+Contents: Support for coarse-grained colloidal particles. Wall fix +and pair styles that implement colloidal interaction models for +finite-size particles. This includes the Fast Lubrication Dynamics +method for hydrodynamic interactions, which is a simplified +approximation to Stokesian dynamics.
To install via make or Make.py:
make yes-colloid
make machine
@@ -729,12 +728,19 @@ make machine
Make.py -p ^colloid -a machine
-Supporting info: examples/colloid, examples/srd
+Supporting info: fix wall/colloid, pair_style colloid, pair_style yukawa/colloid, pair_style brownian, pair_style lubricate, pair_style lubricateU, examples/colloid, examples/srd
Contents:
+Contents: Support for compressed output of dump files via the zlib +compression library, using dump styles with a “gz” in their style +name.
+Building with the COMPRESS package assumes you have the zlib +compression library available on your system. The build uses the +lib/compress/Makefile.lammps file in the compile/link process. You +should only need to edit this file if the LAMMPS build cannot find the +zlib info it specifies.
To install via make or Make.py:
make yes-compress
make machine
@@ -751,12 +757,17 @@ make machine
Make.py -p ^compress -a machine
-Supporting info:
+Supporting info: src/COMPRESS/README, lib/compress/README, dump atom/gz, dump cfg/gz, dump custom/gz, dump xyz/gz
Contents:
+Contents: Compute and pair styles that implement the adiabatic +core/shell model for polarizability. The compute temp/cs command +measures the temperature of a system with core/shell particles. The +pair styles augment Born, Buckingham, and Lennard-Jones styles with +core/shell capabilities. See Section howto 6.26 for an overview of how to use the +package.
To install via make or Make.py:
make yes-coreshell
make machine
@@ -773,12 +784,15 @@ make machine
Make.py -p ^coreshell -a machine
-Supporting info: examples/coreshell, Section howto 6.26
+Supporting info: Section howto 6.26, compute temp/cs,
+pair_style born/coul/long/cs, pair_style buck/coul/long/cs, pair_style
+lj/cut/coul/long/cs”_pair_lj.html, examples/coreshell
Contents:
+Contents: An atom style and several pair styles to support point +dipole models with short-range or long-range interactions.
To install via make or Make.py:
make yes-dipole
make machine
@@ -795,40 +809,48 @@ make machine
Make.py -p ^dipole -a machine
-Supporting info: examples/dipole
-
-Contents:
-To install via make or Make.py:
-make yes-fld
-make machine
-Make.py -p fld -a machine
-To un-install via make or Make.py:
-make no-fld
-make machine
-Make.py -p ^fld -a machine
-Supporting info:
+Supporting info: atom_style dipole, pair_style lj/cut/dipole/cut, pair_style lj/cut/dipole/long, pair_style lj/long/dipole/long, examples/dipole
Contents:
+Contents: Dozens of pair styles and a version of the PPPM long-range +Coulombic solver for NVIDIA GPUs. All of them have a “gpu” in their +style name. Section accelerate gpu gives +details of what hardware and Cuda software is required on your system, +and how to build and use this package. See the KOKKOS and USER-CUDA +packages, which also have GPU-enabled styles.
+Building LAMMPS with the GPU package requires first building the GPU +library itself, which is a set of C and Cuda files in lib/gpu. +Details of how to do this are in lib/gpu/README. As illustrated +below, perform a “make” using one of the Makefile.machine files in +lib/gpu which should create a lib/reax/libgpu.a file. +Makefile.linux.* and Makefile.xk7 are examples for different +platforms. There are 3 important settings in the Makefile.machine you +use:
+See example Makefile.machine files in lib/gpu for the syntax of these +settings. See lib/gpu/Makefile.linux.double for ARCH settings for +various NVIDIA GPUs. The “make” also creates a +lib/gpu/Makefile.lammps file. This file has settings that enable +LAMMPS to link with Cuda libraries. If the settings in +Makefile.lammps for your machine are not correct, the LAMMPS link will +fail. Note that the Make.py script has a “-gpu” option to allow the +GPU library (with several of its options) and LAMMPS to be built in +one step, with Type “python src/Make.py -h -gpu” to see the details.
To install via make or Make.py:
-make yes-gpu
+cd ~/lammps/lib/gpu
+make -f Makefile.linux.mixed # for example
+cd ~/lammps/src
+make yes-gpu
make machine
-Make.py -p gpu -a machine
+Make.py -p gpu -gpu mode=mixed arch=35 -a machine
To un-install via make or Make.py:
@@ -839,12 +861,16 @@ make machine
Make.py -p ^gpu -a machine
-Supporting info: examples/accelerate, bench/FERMI, bench/KEPLER
+Supporting info: src/GPU/README, lib/gpu/README, Section acclerate, Section accelerate gpu, Pair Styles section of Section commands 3.5 for any pair style listed with a (g),
+kspace_style, package gpu,
+examples/accelerate, bench/FERMI, bench/KEPLER
-4.1.10. GRANULAR package¶
-Contents:
+4.1.9. GRANULAR package¶
+Contents: Fixes and pair styles that support models of finite-size
+granular particles, which interact with each other and boundaries via
+frictional and dissipative potentials.
To install via make or Make.py:
make yes-granular
make machine
@@ -861,12 +887,19 @@ make machine
Make.py -p ^granular -a machine
-Supporting info: examples/pour, bench/in.chute, Section howto 6.6
+Supporting info: Section howto 6.6, fix pour, fix wall/gran, pair_style gran/hooke, pair_style gran/hertz/history, examples/pour, bench/in.chute
-4.1.11. KIM package¶
-Contents:
+4.1.10. KIM package¶
+Contents: A pair style that interfaces to the Knowledge Base for
+Interatomic Models (KIM) repository of interatomic potentials, so that
+KIM potentials can be used in a LAMMPS simulation.
+To build LAMMPS with the KIM package you must have previously
+installed the KIM API (library) on your system. The lib/kim/README
+file explains how to download and install KIM. Building with the KIM
+package also uses the lib/kim/Makefile.lammps file in the compile/link
+process. You should not need to edit this file.
To install via make or Make.py:
make yes-kim
make machine
@@ -883,54 +916,72 @@ make machine
Make.py -p ^kim -a machine
-Supporting info: examples/kim
+Supporting info: src/KIM/README, lib/kim/README, pair_style kim, examples/kim
-4.1.12. KOKKOS package¶
-Contents:
-To install via make or Make.py:
-make yes-kokkow
-make machine
-
-
-Make.py -p kokkow -a machine
+4.1.11. KOKKOS package¶
+Contents: Dozens of atom, pair, bond, angle, dihedral, improper styles
+which run with the Kokkos library to provide optimization for
+multicore CPUs (via OpenMP), NVIDIA GPUs, or the Intel Xeon Phi (in
+native mode). All of them have a “kk” in their style name. Section accelerate kokkos gives details of what
+hardware and software is required on your system, and how to build and
+use this package. See the GPU, OPT, USER-CUDA, USER-INTEL, USER-OMP
+packages, which also provide optimizations for the same range of
+hardware.
+Building with the KOKKOS package requires choosing which of 3 hardware
+options you are optimizing for: CPU acceleration via OpenMP, GPU
+acceleration, or Intel Xeon Phi. (You can build multiple times to
+create LAMMPS executables for different hardware.) It also requires a
+C++11 compatible compiler. For GPUs, the NVIDIA “nvcc” compiler is
+used, and an appopriate KOKKOS_ARCH setting should be made in your
+Makefile.machine for your GPU hardware and NVIDIA software.
+The simplest way to do this is to use Makefile.kokkos_cuda or
+Makefile.kokkos_omp or Makefile.kokkos_phi in src/MAKE/OPTIONS, via
+“make kokkos_cuda” or “make kokkos_omp” or “make kokkos_phi”. (Check
+the KOKKOS_ARCH setting in Makefile.kokkos_cuda), Or, as illustrated
+below, you can use the Make.py script with its “-kokkos” option to
+choose which hardware to build for. Type “python src/Make.py -h
+-kokkos” to see the details. If these methods do not work on your
+system, you will need to read the Section accelerate kokkos doc page for details of what
+Makefile.machine settings are needed.
+To install via make or Make.py for each of 3 hardware options:
+make yes-kokkos
+make kokkos_omp # for CPUs with OpenMP
+make kokkos_cuda # for GPUs, check the KOKKOS_ARCH setting in Makefile.kokkos_cuda
+make kokkos_phi # for Xeon Phis
+Make.py -p kokkos -kokkos omp -a machine # for CPUs with OpenMP
+Make.py -p kokkos -kokkos cuda arch=35 -a machine # for GPUs of style arch
+Make.py -p kokkos -kokkos phi -a machine # for Xeon Phis
To un-install via make or Make.py:
-make no-kokkow
+make no-kokkos
make machine
-Make.py -p ^kokkow -a machine
+Make.py -p ^kokkos -a machine
-Supporting info:
-For the KOKKOS package, you have 3 choices when building. You can
-build with OMP or Cuda or Phi support. Phi support uses Xeon Phi
-chips in “native” mode. This can be done by setting the following
-variables in your Makefile.machine:
-
-- for OMP support, set OMP = yes
-- for Cuda support, set OMP = yes and CUDA = yes
-- for Phi support, set OMP = yes and MIC = yes
-
-These can also be set as additional arguments to the make command, e.g.
-make g++ OMP=yes MIC=yes
-
-
-Building the KOKKOS package with CUDA support requires a Makefile
-machine that uses the NVIDIA “nvcc” compiler, as well as an
-appropriate “arch” setting appropriate to the GPU hardware and NVIDIA
-software you have on your machine. See
-src/MAKE/OPTIONS/Makefile.kokkos_cuda for an example of such a machine
-Makefile.
-Examples: examples/accelerate, bench/FERMI, bench/KEPLER
+Supporting info: src/KOKKOS/README, lib/kokkos/README, Section acclerate, Section accelerate kokkos, Pair Styles section of Section commands 3.5 for any pair style listed
+with a (k), package kokkos,
+examples/accelerate, bench/FERMI, bench/KEPLER
-4.1.13. KSPACE package¶
-Contents:
+4.1.12. KSPACE package¶
+Contents: A variety of long-range Coulombic solvers, and pair styles
+which compute the corresponding short-range portion of the pairwise
+Coulombic interactions. These include Ewald, particle-particle
+particle-mesh (PPPM), and multilevel summation method (MSM) solvers.
+Building with the KSPACE package requires a 1d FFT library be present
+on your system for use by the PPPM solvers. This can be the KISS FFT
+library provided with LAMMPS, or 3rd party libraries like FFTW or a
+vendor-supplied FFT library. See step 6 of Section start 2.2.2 of the manual for details of how
+to select different FFT options in your machine Makefile. The Make.py
+tool has an “-fft” option which can insert these settings into your
+machine Makefile automatically. Type “python src/Make.py -h -fft” to
+see the details.
To install via make or Make.py:
make yes-kspace
make machine
@@ -947,14 +998,18 @@ make machine
Make.py -p ^kspace -a machine
-Supporting info:
-Examples: examples/peptide, bench/in.rhodo
-Doc: Section howto 6.7, Section howto 6.8, Section howto 6.9
+Supporting info: kspace_style,
+doc/PDF/kspace.pdf, Section howto 6.7, Section howto 6.8, Section howto 6.9, pair_style coul,
+other pair style command doc pages which have “long” or “msm” in their
+style name, examples/peptide, bench/in.rhodo
-4.1.14. MANYBODY package¶
-Contents:
+4.1.13. MANYBODY package¶
+Contents: A variety of many-body and bond-order potentials. These
+include (AI)REBO, EAM, EIM, BOP, Stillinger-Weber, and Tersoff
+potentials. Do a directory listing, “ls src/MANYBODY”, to see
+the full list.
To install via make or Make.py:
make yes-manybody
make machine
@@ -972,12 +1027,16 @@ make machine
Supporting info:
-Examples: examples/comb, examples/eim, examples/nb3d, examples/vashishta
+Examples: Pair Styles section of Section commands 3.5, examples/comb, examples/eim,
+examples/nb3d, examples/vashishta
-4.1.15. MC package¶
-Contents:
+4.1.14. MC package¶
+Contents: Several fixes and a pair style that have Monte Carlo (MC) or
+MC-like attributes. These include fixes for creating, breaking, and
+swapping bonds, and for performing atomic swaps and grand-canonical MC
+in conjuction with dynamics.
To install via make or Make.py:
make yes-mc
make machine
@@ -994,18 +1053,43 @@ make machine
Make.py -p ^mc -a machine
-Supporting info:
+Supporting info: fix atom/swap, fix bond/break, fix bond/create, fix bond/swap,
+fix gcmc, pair_style dsmc
-4.1.16. MEAM package¶
-Contents:
+4.1.15. MEAM package¶
+Contents: A pair style for the modified embedded atom (MEAM)
+potential.
+Building LAMMPS with the MEAM package requires first building the MEAM
+library itself, which is a set of Fortran 95 files in lib/meam.
+Details of how to do this are in lib/meam/README. As illustrated
+below, perform a “make” using one of the Makefile.machine files in
+lib/meam which should create a lib/meam/libmeam.a file.
+Makefile.gfortran and Makefile.ifort are examples for the GNU Fortran
+and Intel Fortran compilers. The “make” also copies a
+lib/meam/Makefile.lammps.machine file to lib/meam/Makefile.lammps.
+This file has settings that enable the C++ compiler used to build
+LAMMPS to link with a Fortran library (typically the 2 compilers to be
+consistent e.g. both Intel compilers, or both GNU compilers). If the
+settings in Makefile.lammps for your compilers and machine are not
+correct, the LAMMPS link will fail. Note that the Make.py script has
+a “-meam” option to allow the MEAM library and LAMMPS to be built in
+one step. Type “python src/Make.py -h -meam” to see the details.
+
+Note
+The MEAM potential can run dramatically faster if built with the
+Intel Fortran compiler, rather than the GNU Fortran compiler.
+
To install via make or Make.py:
-make yes-meam
+cd ~/lammps/lib/meam
+make -f Makefile.gfortran # for example
+cd ~/lammps/src
+make yes-meam
make machine
-Make.py -p meam -a machine
+Make.py -p meam -meam make=gfortran -a machine
To un-install via make or Make.py:
@@ -1016,12 +1100,15 @@ make machine
Make.py -p ^meam -a machine
-Supporting info: examples/meam
+Supporting info: lib/meam/README, pair_style meam,
+examples/meam
-4.1.17. MISC package¶
-Contents:
+4.1.16. MISC package¶
+Contents: A variety of computes, fixes, and pair styles that are not
+commonly used, but don’t align with other packages. Do a directory
+listing, “ls src/MISC”, to see the list of commands.
To install via make or Make.py:
make yes-misc
make machine
@@ -1038,12 +1125,15 @@ make machine
Make.py -p ^misc -a machine
-Supporting info: examples/misc
+Supporting info: compute ti, fix evaporate, fix tmm, fix viscosity, examples/misc
-4.1.18. MOLECULE package¶
-Contents:
+4.1.17. MOLECULE package¶
+Contents: A large number of atom, pair, bond, angle, dihedral,
+improper styles that are used to model molecular systems with fixed
+covalent bonds. The pair styles include terms for the Dreiding
+(hydrogen-bonding) and CHARMM force fields, and TIP4P water model.
To install via make or Make.py:
make yes-molecule
make machine
@@ -1060,12 +1150,20 @@ make machine
Make.py -p ^molecule -a machine
-Supporting info: examples/micelle, examples/peptide, bench/in.chain, bench/in.rhodo, Section howto 6.3
+Supporting info:atom_style,
+bond_style, angle_style,
+dihedral_style,
+improper_style, pair_style hbond/dreiding/lj, pair_style lj/charmm/coul/charmm, Section howto 6.3, examples/micelle, examples/peptide,
+bench/in.chain, bench/in.rhodo
-4.1.19. MPIIO package¶
-Contents:
+4.1.18. MPIIO package¶
+Contents: Support for parallel output/input of dump and restart files
+via the MPIIO library, which is part of the standard message-passing
+interface (MPI) library. It adds dump styles with a
+“mpiio” in their style name. Restart files with an ”.mpiio” suffix
+are also written and read in parallel.
To install via make or Make.py:
make yes-mpiio
make machine
@@ -1082,12 +1180,23 @@ make machine
Make.py -p ^mpiio -a machine
-Supporting info:
+Supporting info: dump, restart,
+write_restart, read_restart
-4.1.20. OPT package¶
-Contents:
+4.1.19. OPT package¶
+Contents: A handful of pair styles with an “opt” in their style name
+which are optimized for improved CPU performance on single or multiple
+cores. These include EAM, LJ, CHARMM, and Morse potentials. Section accelerate opt gives details of how to build and
+use this package. See the KOKKOS, USER-INTEL, and USER-OMP packages,
+which also have styles optimized for CPU performance.
+Some C++ compilers, like the Intel compiler, require the compile flag
+“-restrict” to build LAMMPS with the OPT package. It should be added
+to the CCFLAGS line of your Makefile.machine. Or use Makefile.opt in
+src/MAKE/OPTIONS, via “make opt”. For compilers that use the flag,
+the Make.py command adds it automatically to the Makefile.auto file it
+creates and uses.
To install via make or Make.py:
make yes-opt
make machine
@@ -1104,17 +1213,16 @@ make machine
Make.py -p ^opt -a machine
-Supporting info: examples/accelerate, bench/KEPLER
-For the OPT package, your Makefile.machine needs an additional
-settings for CCFLAGS.
-
-- CCFLAGS: add -restrict
-
+Supporting info: Section acclerate, Section accelerate opt, Pair Styles section of Section commands 3.5 for any pair style listed
+with an (o), examples/accelerate, bench/KEPLER
-4.1.21. PERI package¶
-Contents:
+4.1.20. PERI package¶
+Contents: Support for the Peridynamics method, a particle-based
+meshless continuum model. The package includes an atom style, several
+computes which calculate diagnostics, and several Peridynamic pair
+styles which implement different materials models.
To install via make or Make.py:
make yes-peri
make machine
@@ -1131,34 +1239,69 @@ make machine
Make.py -p ^peri -a machine
-Supporting info: examples/peri
+Supporting info:
+doc/PDF/PDLammps_overview.pdf,
+doc/PDF/PDLammps_EPS.pdf,
+doc/PDF/PDLammps_VES.pdf, atom_style peri, compute damage,
+pair_style peri/pmb, examples/peri
-4.1.22. POEMS package¶
-Contents:
+4.1.21. POEMS package¶
+Contents: A fix that wraps the Parallelizable Open source Efficient
+Multibody Software (POEMS) librar, which is able to simulate the
+dynamics of articulated body systems. These are systems with multiple
+rigid bodies (collections of atoms or particles) whose motion is
+coupled by connections at hinge points.
+Building LAMMPS with the POEMS package requires first building the
+POEMS library itself, which is a set of C++ files in lib/poems.
+Details of how to do this are in lib/poems/README. As illustrated
+below, perform a “make” using one of the Makefile.machine files in
+lib/poems which should create a lib/meam/libpoems.a file.
+Makefile.g++ and Makefile.icc are examples for the GNU and Intel C++
+compilers. The “make” also creates a lib/poems/Makefile.lammps file
+which you should not need to change. Note the Make.py script has a
+“-poems” option to allow the POEMS library and LAMMPS to be built in
+one step. Type “python src/Make.py -h -poems” to see the details.
To install via make or Make.py:
-make yes-poems
+cd ~/lammps/lib/poems
+make -f Makefile.g++ # for example
+cd ~/lammps/src
+make yes-poems
make machine
-Make.py -p poems -a machine
+Make.py -p poems -poems make=g++ -a machine
To un-install via make or Make.py:
-make no-poems
+make no-meam
make machine
-Make.py -p ^poems -a machine
+Make.py -p ^meam -a machine
-Supporting info: examples/rigid
+Supporting info: src/POEMS/README, lib/poems/README,
+fix_poems, examples/rigid
-4.1.23. PYTHON package¶
-Contents:
+4.1.22. PYTHON package¶
+Contents: A python command which allow you to execute
+Python code from a LAMMPS input script. The code can be in a separate
+file or embedded in the input script itself. See Section python 11.2 for an overview of using Python from
+LAMMPS and Section python for other ways to use
+LAMMPS and Python together.
+Building with the PYTHON package assumes you have a Python shared
+library available on your system, which needs to be a Python 2
+version, 2.6 or later. Python 3 is not supported. The build uses the
+contents of the lib/python/Makefile.lammps file to find all the Python
+files required in the build/link process. See the lib/python/README
+file if the settings in that file do not work on your system. Note
+that the Make.py script has a “-python” option to allow an alternate
+lib/python/Makefile.lammps file to be specified and LAMMPS to be built
+in one step. Type “python src/Make.py -h -python” to see the details.
To install via make or Make.py:
make yes-python
make machine
@@ -1179,8 +1322,10 @@ make machine
-4.1.24. QEQ package¶
-Contents:
+4.1.23. QEQ package¶
+Contents: Several fixes for performing charge equilibration (QEq) via
+severeal different algorithms. These can be used with pair styles
+that use QEq as part of their formulation.
To install via make or Make.py:
make yes-qeq
make machine
@@ -1197,18 +1342,38 @@ make machine
Make.py -p ^qeq -a machine
-Supporting info: examples/qeq
+Supporting info: fix qeq/*, examples/qeq
-4.1.25. REAX package¶
-Contents:
+4.1.24. REAX package¶
+Contents: A pair style for the ReaxFF potential, a universal reactive
+force field, as well as a fix reax/bonds command
+for monitoring molecules as bonds are created and destroyed.
+Building LAMMPS with the REAX package requires first building the REAX
+library itself, which is a set of Fortran 95 files in lib/reax.
+Details of how to do this are in lib/reax/README. As illustrated
+below, perform a “make” using one of the Makefile.machine files in
+lib/reax which should create a lib/reax/libreax.a file.
+Makefile.gfortran and Makefile.ifort are examples for the GNU Fortran
+and Intel Fortran compilers. The “make” also copies a
+lib/reax/Makefile.lammps.machine file to lib/reax/Makefile.lammps.
+This file has settings that enable the C++ compiler used to build
+LAMMPS to link with a Fortran library (typically the 2 compilers to be
+consistent e.g. both Intel compilers, or both GNU compilers). If the
+settings in Makefile.lammps for your compilers and machine are not
+correct, the LAMMPS link will fail. Note that the Make.py script has
+a “-reax” option to allow the REAX library and LAMMPS to be built in
+one step. Type “python src/Make.py -h -reax” to see the details.
To install via make or Make.py:
-make yes-reax
+cd ~/lammps/lib/reax
+make -f Makefile.gfortran # for example
+cd ~/lammps/src
+make yes-reax
make machine
-Make.py -p reax -a machine
+Make.py -p reax -reax make=gfortran -a machine
To un-install via make or Make.py:
@@ -1219,12 +1384,22 @@ make machine
Make.py -p ^reax -a machine
-Supporting info: examples/reax
+Supporting info: lib/reax/README, pair_style reax,
+fix reax/bonds, examples/reax
-4.1.26. REPLICA package¶
-Contents:
+4.1.25. REPLICA package¶
+Contents: A collection of multi-replica methods that are used by
+invoking multiple instances (replicas) of LAMMPS
+simulations. Communication between individual replicas is performed in
+different ways by the different methods. See Section howto 6.5 for an overview of how to run
+multi-replica simulations in LAMMPS. Multi-replica methods included
+in the package are nudged elastic band (NEB), parallel replica
+dynamics (PRD), temperature accelerated dynamics (TAD), parallel
+tempering, and a verlet/split algorithm for performing long-range
+Coulombics on one set of processors, and the remainded of the force
+field calcalation on another set.
To install via make or Make.py:
make yes-replica
make machine
@@ -1241,12 +1416,18 @@ make machine
Make.py -p ^replica -a machine
-Supporting info: examples/neb, examples/prd, examples/tad, Section howto 6.5
+Supporting info: Section howto 6.5,
+neb, prd, tad, temper,
+run_style verlet/split, examples/neb, examples/prd,
+examples/tad
-4.1.27. RIGID package¶
-Contents:
+4.1.26. RIGID package¶
+Contents: A collection of computes and fixes which enforce rigid
+constraints on collections of atoms or particles. This includes SHAKE
+and RATTLE, as well as variants of rigid-body time integrators for a
+few large bodies or many small bodies.
To install via make or Make.py:
make yes-rigid
make machine
@@ -1263,12 +1444,14 @@ make machine
Make.py -p ^rigid -a machine
-Supporting info: examples/ASPHERE, examples/rigid
+Supporting info: compute erotate/rigid,
+fix shake, fix rattle, fix rigid/*, examples/ASPHERE, examples/rigid
-4.1.28. SHOCK package¶
-Contents:
+4.1.27. SHOCK package¶
+Contents: A small number of fixes useful for running impact
+simulations where a shock-wave passes through a material.
To install via make or Make.py:
make yes-shock
make machine
@@ -1285,12 +1468,15 @@ make machine
Make.py -p ^shock -a machine
-Supporting info: examples/hugoniostat, examples/msst
+Supporting info: fix append/atoms, fix msst, fix nphug, fix wall/piston, examples/hugoniostat, examples/msst
-4.1.29. SNAP package¶
-Contents:
+4.1.28. SNAP package¶
+Contents: A pair style for the spectral neighbor analysis potential
+(SNAP), which is an empirical potential which can be quantum accurate
+when fit to an archive of DFT data. Computes useful for analyzing
+properties of the potential are also included.
To install via make or Make.py:
make yes-snap
make machine
@@ -1307,12 +1493,15 @@ make machine
Make.py -p ^snap -a machine
-Supporting info: examples/snap
+Supporting info: pair snap, compute sna/atom, compute snad/atom,
+compute snav/atom, examples/snap
-4.1.30. SRD package¶
-Contents:
+4.1.29. SRD package¶
+Contents: Two fixes which implement the Stochastic Rotation Dynamics
+(SRD) method for coarse-graining of a solvent, typically around large
+colloidal-scale particles.
To install via make or Make.py:
make yes-srd
make machine
@@ -1329,18 +1518,41 @@ make machine
Make.py -p ^srd -a machine
-Supporting info:
+Supporting info: fix srd, fix wall/srd, examples/srd, examples/ASPHERE
-4.1.31. VORONOI package¶
-Contents:
+4.1.30. VORONOI package¶
+Contents: A compute voronoi/atom command
+which computes the Voronoi tesselation of a collection of atoms or
+particles by wrapping the Voro++ lib
+To build LAMMPS with the KIM package you must have previously
+installed the KIM API (library) on your system. The lib/kim/README
+file explains how to download and install KIM. Building with the KIM
+package also uses the lib/kim/Makefile.lammps file in the compile/link
+process. You should not need to edit this file.
+To build LAMMPS with the VORONOI package you must have previously
+installed the Voro++ library on your system. The lib/voronoi/README
+file explains how to download and install Voro++. There is a
+lib/voronoi/install.py script which automates the process. Type
+“python install.py” to see instructions. The final step is to create
+soft links in the lib/voronoi directory for “includelink” and
+“liblink” which point to installed Voro++ directories. Building with
+the VORONOI package uses the contents of the
+lib/voronoi/Makefile.lammps file in the compile/link process. You
+should not need to edit this file. Note that the Make.py script has a
+“-voronoi” option to allow the Voro++ library to be downloaded and/or
+installed and LAMMPS to be built in one step. Type “python
+src/Make.py -h -voronoi” to see the details.
To install via make or Make.py:
-make yes-voronoi
+cd ~/lammps/lib/voronoi
+python install.py -g -b -l # download Voro++, build in lib/voronoi, create links
+cd ~/lammps/src
+make yes-voronoi
make machine
-Make.py -p voronoi -a machine
+Make.py -p voronoi -voronoi install="-g -b -l" -a machine
To un-install via make or Make.py:
@@ -1351,12 +1563,13 @@ make machine
Make.py -p ^voronoi -a machine
-Supporting info: examples/voronoi
+Supporting info: src/VORONOI/README, lib/voronoi/README, compute voronoi/atom, examples/voronoi
-4.1.32. XTC package¶
-Contents:
+4.1.31. XTC package¶
+Contents: A dump xtc command for writing snapshots in the
+XTC format used by the GROMACS MD package.
To install via make or Make.py:
make yes-xtc
make machine
@@ -1373,7 +1586,7 @@ make machine
Make.py -p ^xtc -a machine
-Supporting info:
+Supporting info: dump xtc
@@ -1797,143 +2010,152 @@ See details on all of this below for individual packages.
4.2.1. USER-ATC package¶
-Contents:
+Contents: ATC stands for atoms-to-continuum. This package implements
+a fix atc command to either couple MD with continuum
+finite element equations or perform on-the-fly post-processing of
+atomic information to continuum fields. See src/USER-ATC/README for
+more details.
+To build LAMMPS with this package ...
To install via make or Make.py:
+make yes-user-atc
+make machine
+
+
+Make.py -p atc -a machine
+
+
To un-install via make or Make.py:
-Supporting info:
-This package implements a “fix atc” command which can be used in a
-LAMMPS input script. This fix can be employed to either do concurrent
-coupling of MD with FE-based physics surrogates or on-the-fly
-post-processing of atomic information to continuum fields.
-See the doc page for the fix atc command to get started. At the
-bottom of the doc page are many links to additional documentation
-contained in the doc/USER/atc directory.
-There are example scripts for using this package in examples/USER/atc.
-This package uses an external library in lib/atc which must be
-compiled before making LAMMPS. See the lib/atc/README file and the
-LAMMPS manual for information on building LAMMPS with external
-libraries.
-The primary people who created this package are Reese Jones (rjones at
-sandia.gov), Jeremy Templeton (jatempl at sandia.gov) and Jon
-Zimmerman (jzimmer at sandia.gov) at Sandia. Contact them directly if
-you have questions.
-Examples: examples/USER/atc
+make no-user-atc
+make machine
+
+
+Make.py -p ^atc -a machine
+
+
+Supporting info:src/USER-ATC/README, fix atc,
+examples/USER/atc
+Authors: Reese Jones (rjones at sandia.gov), Jeremy Templeton (jatempl
+at sandia.gov) and Jon Zimmerman (jzimmer at sandia.gov) at Sandia.
+Contact them directly if you have questions.
4.2.2. USER-AWPMD package¶
-Contents:
+Contents: AWPMD stands for Antisymmetrized Wave Packet Molecular
+Dynamics. This package implements an atom, pair, and fix style which
+allows electrons to be treated as explicit particles in an MD
+calculation. See src/USER-AWPMD/README for more details.
+To build LAMMPS with this package ...
To install via make or Make.py:
+make yes-user-atc
+make machine
+
+
+Make.py -p atc -a machine
+
+
To un-install via make or Make.py:
-Supporting info:
-This package contains a LAMMPS implementation of the Antisymmetrized
-Wave Packet Molecular Dynamics (AWPMD) method.
-See the doc page for the pair_style awpmd/cut command to get started.
-There are example scripts for using this package in examples/USER/awpmd.
-This package uses an external library in lib/awpmd which must be
-compiled before making LAMMPS. See the lib/awpmd/README file and the
-LAMMPS manual for information on building LAMMPS with external
-libraries.
-The person who created this package is Ilya Valuev at the JIHT in
-Russia (valuev at physik.hu-berlin.de). Contact him directly if you
-have questions.
-Examples: examples/USER/awpmd
+make no-user-atc
+make machine
+
+
+Make.py -p ^atc -a machine
+
+
+Supporting info: src/USER-AWPMD/README, fix awpmd/cut, examples/USER/awpmd
+Author: Ilya Valuev at the JIHT in Russia (valuev at
+physik.hu-berlin.de). Contact him directly if you have questions.
4.2.3. USER-CG-CMM package¶
-Contents:
+Contents: CG-CMM stands for coarse-grained ??. This package
+implements several pair styles and an angle style using the coarse
+grained parametrization of Shinoda, DeVane, Klein, Mol Sim, 33, 27
+(2007) (SDK), with extensions to simulate ionic liquids, electrolytes,
+lipids and charged amino acids. See src/USER-CG-CMM/README for more
+details.
To install via make or Make.py:
-make yes-body
+make yes-user-atc
make machine
-Make.py -p body -a machine
+Make.py -p atc -a machine
To un-install via make or Make.py:
-make no-body
+make no-user-atc
make machine
-Make.py -p ^body -a machine
+Make.py -p ^atc -a machine
-Supporting info:
-This package implements 3 commands which can be used in a LAMMPS input
-script:
-
-- pair_style lj/sdk
-- pair_style lj/sdk/coul/long
-- angle_style sdk
-
-These styles allow coarse grained MD simulations with the
-parametrization of Shinoda, DeVane, Klein, Mol Sim, 33, 27 (2007)
-(SDK), with extensions to simulate ionic liquids, electrolytes, lipids
-and charged amino acids.
-See the doc pages for these commands for details.
-There are example scripts for using this package in
-examples/USER/cg-cmm.
-This is the second generation implementation reducing the the clutter
-of the previous version. For many systems with electrostatics, it will
-be faster to use pair_style hybrid/overlay with lj/sdk and coul/long
-instead of the combined lj/sdk/coul/long style. since the number of
-charged atom types is usually small. For any other coulomb
-interactions this is now required. To exploit this property, the use
-of the kspace_style pppm/cg is recommended over regular pppm. For all
-new styles, input file backward compatibility is provided. The old
-implementation is still available through appending the /old
-suffix. These will be discontinued and removed after the new
-implementation has been fully validated.
-The current version of this package should be considered beta
-quality. The CG potentials work correctly for “normal” situations, but
-have not been testing with all kinds of potential parameters and
-simulation systems.
-The person who created this package is Axel Kohlmeyer at Temple U
-(akohlmey at gmail.com). Contact him directly if you have questions.
-Examples: examples/USER/cg-cmm
+Supporting info: src/USER-CG-CMM/README, pair lj/sdk,
+pair lj/sdk/coul/long, angle sdk,
+examples/USER/cg-cmm
+Author: Axel Kohlmeyer at Temple U (akohlmey at gmail.com). Contact
+him directly if you have questions.
4.2.4. USER-COLVARS package¶
-Contents:
+Contents: COLVARS stands for collective variables which can be used to
+implement Adaptive Biasing Force, Metadynamics, Steered MD, Umbrella
+Sampling and Restraints. This package implements a fix colvars command which wraps a COLVARS library which
+can perform those kinds of simulations. See src/USER-COLVARS/README
+for more details.
+To build LAMMPS with this package ...
To install via make or Make.py:
+make yes-user-atc
+make machine
+
+
+Make.py -p atc -a machine
+
+
To un-install via make or Make.py:
-Supporting info:
-This package implements the “fix colvars” command which can be
-used in a LAMMPS input script.
-This fix allows to use “collective variables” to implement
-Adaptive Biasing Force, Metadynamics, Steered MD, Umbrella
-Sampling and Restraints. This code consists of two parts:
-
-- A portable collective variable module library written and maintained
-- by Giacomo Fiorin (ICMS, Temple University, Philadelphia, PA, USA) and
-- Jerome Henin (LISM, CNRS, Marseille, France). This code is located in
-- the directory lib/colvars and needs to be compiled first. The colvars
-- fix and an interface layer, exchanges information between LAMMPS and
-- the collective variable module.
-
-See the doc page of fix colvars for more details.
-There are example scripts for using this package in
-examples/USER/colvars
-This is a very new interface that does not yet support all
-features in the module and will see future optimizations
-and improvements. The colvars module library is also available
-in NAMD has been thoroughly used and tested there. Bugs and
-problems are likely due to the interface layers code.
-Thus the current version of this package should be considered
-beta quality.
-The person who created this package is Axel Kohlmeyer at Temple U
-(akohlmey at gmail.com). Contact him directly if you have questions.
-Examples: examples/USER/colvars
-Contents:
-To install via make or Make.py:
-To un-install via make or Make.py:
-Supporting info:
+make no-user-atc
+make machine
+
+
+Make.py -p ^atc -a machine
+
+
+Supporting info:
+doc/PDF/colvars-refman-lammps.pdf,
+src/USER-COLVARS/README, lib/colvars/README, fix colvars, examples/USER/colvars
+Authors: Axel Kohlmeyer at Temple U (akohlmey at gmail.com) wrote the
+fix. The COLVARS library itself is written and maintained by Giacomo
+Fiorin (ICMS, Temple University, Philadelphia, PA, USA) and Jerome
+Henin (LISM, CNRS, Marseille, France). Contact them directly if you
+have questions.
4.2.5. USER-CUDA package¶
+Contents: A fix atc command (atoms to continuum) to
+either couple of MD with FE-based physics surrogates or on-the-fly
+post-processing of atomic information to continuum fields. See
+src/USER-ATC/README for more details.
+To build LAMMPS with this package ...
+To install via make or Make.py:
+make yes-user-atc
+make machine
+
+
+Make.py -p atc -a machine
+
+
+To un-install via make or Make.py:
+make no-user-atc
+make machine
+
+
+Make.py -p ^atc -a machine
+
+
+Supporting info: fix atc, examples/USER/atc
This package provides acceleration of various LAMMPS pair styles, fix
styles, compute styles, and long-range Coulombics via PPPM for NVIDIA
GPUs.
@@ -1949,253 +2171,227 @@ libraries.
University of Technology Ilmenau, Germany (christian.trott at
tu-ilmenau.de). Contact him directly if you have questions.
Examples: examples/accelerate, bench/FERMI, bench/KEPLER
-Contents:
-To install via make or Make.py:
-To un-install via make or Make.py:
-Supporting info:
4.2.6. USER-DIFFRACTION package¶
-This package contains the commands neeed to calculate x-ray and
-electron diffraction intensities based on kinematic diffraction
-theory.
-See these doc pages and their related commands to get started:
-
-The person who created this package is Shawn P. Coleman
-(shawn.p.coleman8.ctr at mail.mil) while at the University of
-Arkansas. Contact him directly if you have questions.
-Examples: examples/USER/diffraction
-Contents:
+Contents: This packages implements two computes and a fix for
+calculating x-ray and electron diffraction intensities based on
+kinematic diffraction theory. See src/USER-DIFFRACTION/README for
+more details.
To install via make or Make.py:
-make yes-body
+make yes-user-atc
make machine
-Make.py -p body -a machine
+Make.py -p atc -a machine
To un-install via make or Make.py:
-make no-body
+make no-user-atc
make machine
-Make.py -p ^body -a machine
+Make.py -p ^atc -a machine
-Supporting info:
+Supporting info: compute saed, compute xrd, fix saed.vtk,
+examples/USER/diffraction
+Author: Shawn P. Coleman (shawn.p.coleman8.ctr at mail.mil) while at
+the University of Arkansas. Contact him directly if you have
+questions.
4.2.7. USER-DPD package¶
-This package implements the dissipative particle dynamics (DPD) method
-under isothermal, isoenergetic, isobaric and isenthalpic conditions.
-The DPD equations of motion are integrated efficiently through the
-Shardlow splitting algorithm.
-See these doc pages and their related commands to get started:
-
-- compute dpd
-- compute dpd/atom
-- fix_eos/cv
-- fix_eos/table
-- fix_shardlow
-- pair_dpd/conservative
-- pair_dpd/fdt
-- pair_dpd/fdt/energy
-
-There are example scripts for using this package in examples/USER/dpd.
-The people who created this package are James Larentzos
-(james.p.larentzos.civ at mail.mil), Timothy Mattox (Timothy.Mattox at
-engilitycorp.com) and John Brennan (john.k.brennan.civ at mail.mil).
-Contact them directly if you have questions.
+Contents: DPD stands for dissipative particle dynamics, This package
+implements DPD for isothermal, isoenergetic, isobaric and isenthalpic
+conditions. The DPD equations of motion are integrated efficiently
+through the Shardlow splitting algorithm. See src/USER-DPD/README for
+more details.
To install via make or Make.py:
-make yes-body
+make yes-user-atc
make machine
-Make.py -p body -a machine
+Make.py -p atc -a machine
To un-install via make or Make.py:
-make no-body
+make no-user-atc
make machine
-Make.py -p ^body -a machine
+Make.py -p ^atc -a machine
-Examples: examples/USER/dpd
+Supporting info: /src/USER-DPD/README, compute dpd
+compute dpd/atom
+fix_eos/cv fix_eos/table
+fix_shardlow
+pair_dpd/conservative
+pair_dpd/fdt
+pair_dpd/fdt/energy, examples/USER/dpd
+Authors: James Larentzos (ARL) (james.p.larentzos.civ at mail.mil),
+Timothy Mattox (Engility Corp) (Timothy.Mattox at engilitycorp.com)
+and John Brennan (ARL) (john.k.brennan.civ at mail.mil). Contact them
+directly if you have questions.
4.2.8. USER-DRUDE package¶
-Contents:
+Contents: This package contains methods for simulating polarizable
+systems using thermalized Drude oscillators. It has computes, fixes,
+and pair styles for this purpose. See Section howto 6.27 for an overview of how to use the
+package. See src/USER-DRUDE/README for additional details. There are
+auxiliary tools for using this package in tools/drude.
To install via make or Make.py:
-To un-install via make or Make.py:
-Supporting info:
-This package implements methods for simulating polarizable systems
-in LAMMPS using thermalized Drude oscillators.
-See these doc pages and their related commands to get started:
-
-- Drude tutorial
-- fix drude
-- compute temp/drude
-- fix langevin/drude
-- fix drude/transform/...
-- pair thole
-
-There are auxiliary tools for using this package in tools/drude.
-The person who created this package is Alain Dequidt at Universite
-Blaise Pascal Clermont-Ferrand (alain.dequidt at univ-bpclermont.fr)
-Contact him directly if you have questions. Co-authors: Julien Devemy,
-Agilio Padua.
-To install via make or Make.py:
-make yes-body
+make yes-user-atc
make machine
-Make.py -p body -a machine
+Make.py -p atc -a machine
To un-install via make or Make.py:
-make no-body
+make no-user-atc
make machine
-Make.py -p ^body -a machine
+Make.py -p ^atc -a machine
-Examples: examples/USER/drude
-Doc: Section howto 6.27
+Supporting info: Section howto 6.27,
+src/USER-DRUDE/README, fix drude, fix drude/transform/*, compute temp/drude, pair thole,
+pair lj/cut/thole/long, examples/USER/drude,
+tools/drude
+Authors: Alain Dequidt at Universite Blaise Pascal Clermont-Ferrand
+(alain.dequidt at univ-bpclermont.fr); co-authors: Julien Devemy,
+Agilio Padua. Contact them directly if you have questions.
4.2.9. USER-EFF package¶
-Contents:
+Contents: EFF stands for electron force field. This package contains
+atom, pair, fix and compute styles which implement the eFF as
+described in A. Jaramillo-Botero, J. Su, Q. An, and W.A. Goddard III,
+JCC, 2010. The eFF potential was first introduced by Su and Goddard,
+in 2007. See src/USER-EFF/README for more details. There are
+auxiliary tools for using this package in tools/eff; see its README
+file.
To install via make or Make.py:
+make yes-user-atc
+make machine
+
+
+Make.py -p atc -a machine
+
+
To un-install via make or Make.py:
+make no-user-atc
+make machine
+
+
+Make.py -p ^atc -a machine
+
+
+Supporting info: atom_style electron, compute temp/eff, fix langevin/eff, fix nve/eff,
+pair eff/cut, examples/USER/eff, tools/eff
Supporting info:
-This package contains a LAMMPS implementation of the electron Force
-Field (eFF) currently under development at Caltech, as described in
-A. Jaramillo-Botero, J. Su, Q. An, and W.A. Goddard III, JCC,
-2010. The eFF potential was first introduced by Su and Goddard, in
-2007.
-eFF can be viewed as an approximation to QM wave packet dynamics and
-Fermionic molecular dynamics, combining the ability of electronic
-structure methods to describe atomic structure, bonding, and chemistry
-in materials, and of plasma methods to describe nonequilibrium
-dynamics of large systems with a large number of highly excited
-electrons. We classify it as a mixed QM-classical approach rather than
-a conventional force field method, which introduces QM-based terms (a
-spin-dependent repulsion term to account for the Pauli exclusion
-principle and the electron wavefunction kinetic energy associated with
-the Heisenberg principle) that reduce, along with classical
-electrostatic terms between nuclei and electrons, to the sum of a set
-of effective pairwise potentials. This makes eFF uniquely suited to
-simulate materials over a wide range of temperatures and pressures
-where electronically excited and ionized states of matter can occur
-and coexist.
-The necessary customizations to the LAMMPS core are in place to
-enable the correct handling of explicit electron properties during
-minimization and dynamics.
-See the doc page for the pair_style eff/cut command to get started.
-There are example scripts for using this package in
-examples/USER/eff.
-There are auxiliary tools for using this package in tools/eff.
-The person who created this package is Andres Jaramillo-Botero at
-CalTech (ajaramil at wag.caltech.edu). Contact him directly if you
-have questions.
-To install via make or Make.py:
-make yes-body
-make machine
-
-
-Make.py -p body -a machine
-
-
-To un-install via make or Make.py:
-make no-body
-make machine
-
-
-Make.py -p ^body -a machine
-
-
-Examples: examples/USER/eff
+Author: Andres Jaramillo-Botero at CalTech (ajaramil at
+wag.caltech.edu). Contact him directly if you have questions.
4.2.10. USER-FEP package¶
-Contents:
+Contents: FEP stands for free energy perturbation. This package
+provides methods for performing FEP simulations by using a fix adapt/fep command with soft-core pair potentials,
+which have a “soft” in their style name. See src/USER-FEP/README for
+more details. There are auxiliary tools for using this package in
+tools/fep; see its README file.
To install via make or Make.py:
-To un-install via make or Make.py:
-Supporting info:
-This package provides methods for performing free energy perturbation
-simulations with soft-core pair potentials in LAMMPS.
-See these doc pages and their related commands to get started:
-
-The person who created this package is Agilio Padua at Universite
-Blaise Pascal Clermont-Ferrand (agilio.padua at univ-bpclermont.fr)
-Contact him directly if you have questions.
-To install via make or Make.py:
-make yes-body
+make yes-user-atc
make machine
-Make.py -p body -a machine
+Make.py -p atc -a machine
To un-install via make or Make.py:
-make no-body
+make no-user-atc
make machine
-Make.py -p ^body -a machine
+Make.py -p ^atc -a machine
-Examples: examples/USER/fep
+Supporting info: src/USER-FEP/README, fix adapt/fep, compute fep,
+pair_style */soft, examples/USER/fep
+Author: Agilio Padua at Universite Blaise Pascal Clermont-Ferrand
+(agilio.padua at univ-bpclermont.fr). Contact him directly if you have
+questions.
4.2.11. USER-H5MD package¶
-Contents:
+Contents: H5MD stands for HDF5 for MD. HDF5 is a binary,
+portable, self-describing file format, used by many scientific
+simulations. H5MD is a format for molecular simulations, built on top
+of HDF5. This package implements a dump h5md command
+to output LAMMPS snapshots in this format. See src/USER-H5MD/README
+for more details.
+To build LAMMPS with this package ...
To install via make or Make.py:
+make yes-user-atc
+make machine
+
+
+Make.py -p atc -a machine
+
+
To un-install via make or Make.py:
-Supporting info:
-This package contains a dump h5md command for
-performing a dump of atom properties in HDF5 format. HDF5 files are binary, portable and self-describing and can be
-examined and used by a variety of auxiliary tools. The output HDF5
-files are structured in a format called H5MD, which was designed to
-store molecular data, and can be used and produced by various MD and
-MD-related codes. The dump h5md command gives a
-citation to a paper describing the format.
-The person who created this package and the underlying H5MD format is
-Pierre de Buyl at KU Leuven (see http://pdebuyl.be). Contact him
+
make no-user-atc
+make machine
+
+
+Make.py -p ^atc -a machine
+
+
+Supporting info: src/USER-H5MD/README, lib/h5md/README, dump h5md
+Author: Pierre de Buyl at KU Leuven (see http://pdebuyl.be) created
+this package as well as the H5MD format and library. Contact him
directly if you have questions.
4.2.12. USER-INTEL package¶
-Contents:
+Contents: Dozens of pair, bond, angle, dihedral, and improper styles
+that are optimized for Intel CPUs and the Intel Xeon Phi (in offload
+mode). All of them have an “intel” in their style name. Section accelerate intel gives details of what hardware
+and compilers are required on your system, and how to build and use
+this package. Also see src/USER-INTEL/README for more details. See
+the KOKKOS, OPT, and USER-OMP packages, which also have CPU and
+Phi-enabled styles.
To install via make or Make.py:
+make yes-user-atc
+make machine
+
+
+Make.py -p atc -a machine
+
+
To un-install via make or Make.py:
-Supporting info:
-This package provides options for performing neighbor list and
-non-bonded force calculations in single, mixed, or double precision
-and also a capability for accelerating calculations with an
-Intel(R) Xeon Phi(TM) coprocessor.
-See this section of the manual to get started:
+make no-user-atc
+make machine
+
+
+Make.py -p ^atc -a machine
+
+
+Supporting info: examples/accelerate, src/USER-INTEL/TEST
Section_accelerate
-The person who created this package is W. Michael Brown at Intel
-(michael.w.brown at intel.com). Contact him directly if you have questions.
+Author: Mike Brown at Intel (michael.w.brown at intel.com). Contact
+him directly if you have questions.
For the USER-INTEL package, you have 2 choices when building. You can
build with CPU or Phi support. The latter uses Xeon Phi chips in
“offload” mode. Each of these modes requires additional settings in
@@ -2214,14 +2410,32 @@ your Makefile.machine for CCFLAGS and LINKFLAGS.
-offload-option,mic,compiler,"-fp-model fast=2 -mGLOB_default_function_attrs="gather_scatter_loop_unroll=4""
-Examples: examples/accelerate, bench/KEPLER
+Examples:
4.2.13. USER-LB package¶
-Contents:
+Contents: A fix atc command (atoms to continuum) to
+either couple of MD with FE-based physics surrogates or on-the-fly
+post-processing of atomic information to continuum fields. See
+src/USER-ATC/README for more details.
To install via make or Make.py:
+make yes-user-atc
+make machine
+
+
+Make.py -p atc -a machine
+
+
To un-install via make or Make.py:
+make no-user-atc
+make machine
+
+
+Make.py -p ^atc -a machine
+
+
+Supporting info: fix atc, examples/USER/atc
Supporting info:
This package contains a LAMMPS implementation of a background
Lattice-Boltzmann fluid, which can be used to model MD particles
@@ -2231,30 +2445,32 @@ influenced by hydrodynamic forces.
The people who created this package are Frances Mackay (fmackay at
uwo.ca) and Colin (cdennist at uwo.ca) Denniston, University of
Western Ontario. Contact them directly if you have questions.
-To install via make or Make.py:
-make yes-body
-make machine
-
-
-Make.py -p body -a machine
-
-
-To un-install via make or Make.py:
-make no-body
-make machine
-
-
-Make.py -p ^body -a machine
-
-
Examples: examples/USER/lb
4.2.14. USER-MGPT package¶
-Contents:
+Contents: A fix atc command (atoms to continuum) to
+either couple of MD with FE-based physics surrogates or on-the-fly
+post-processing of atomic information to continuum fields. See
+src/USER-ATC/README for more details.
To install via make or Make.py:
+make yes-user-atc
+make machine
+
+
+Make.py -p atc -a machine
+
+
To un-install via make or Make.py:
+make no-user-atc
+make machine
+
+
+Make.py -p ^atc -a machine
+
+
+Supporting info: fix atc, examples/USER/atc
Supporting info:
This package contains a fast implementation for LAMMPS of
quantum-based MGPT multi-ion potentials. The MGPT or model GPT method
@@ -2275,30 +2491,32 @@ Oppelstrup at LLNL.
The persons who created the USER-MGPT package are Tomas Oppelstrup
(oppelstrup2@llnl.gov) and John Moriarty (moriarty2@llnl.gov)
Contact them directly if you have any questions.
-To install via make or Make.py:
-make yes-body
-make machine
-
-
-Make.py -p body -a machine
-
-
-To un-install via make or Make.py:
-make no-body
-make machine
-
-
-Make.py -p ^body -a machine
-
-
Examples: examples/USER/mgpt
4.2.15. USER-MISC package¶
-Contents:
+Contents: A fix atc command (atoms to continuum) to
+either couple of MD with FE-based physics surrogates or on-the-fly
+post-processing of atomic information to continuum fields. See
+src/USER-ATC/README for more details.
To install via make or Make.py:
+make yes-user-atc
+make machine
+
+
+Make.py -p atc -a machine
+
+
To un-install via make or Make.py:
+make no-user-atc
+make machine
+
+
+Make.py -p ^atc -a machine
+
+
+Supporting info: fix atc, examples/USER/atc
Supporting info:
The files in this package are a potpourri of (mostly) unrelated
features contributed to LAMMPS by users. Each feature is a single
@@ -2313,30 +2531,32 @@ compute, pair, etc sections.
src/USER-MISC/README file.
You should contact the author directly if you have specific questions
about the feature or its coding.
-To install via make or Make.py:
-make yes-body
-make machine
-
-
-Make.py -p body -a machine
-
-
-To un-install via make or Make.py:
-make no-body
-make machine
-
-
-Make.py -p ^body -a machine
-
-
Examples: examples/USER/misc
4.2.16. USER-MOLFILE package¶
-Contents:
+Contents: A fix atc command (atoms to continuum) to
+either couple of MD with FE-based physics surrogates or on-the-fly
+post-processing of atomic information to continuum fields. See
+src/USER-ATC/README for more details.
To install via make or Make.py:
+make yes-user-atc
+make machine
+
+
+Make.py -p atc -a machine
+
+
To un-install via make or Make.py:
+make no-user-atc
+make machine
+
+
+Make.py -p ^atc -a machine
+
+
+Supporting info: fix atc, examples/USER/atc
Supporting info:
This package contains a dump molfile command which uses molfile
plugins that are bundled with the
@@ -2357,9 +2577,27 @@ application itself.
4.2.17. USER-OMP package¶
-Contents:
+Contents: A fix atc command (atoms to continuum) to
+either couple of MD with FE-based physics surrogates or on-the-fly
+post-processing of atomic information to continuum fields. See
+src/USER-ATC/README for more details.
To install via make or Make.py:
+make yes-user-atc
+make machine
+
+
+Make.py -p atc -a machine
+
+
To un-install via make or Make.py:
+make no-user-atc
+make machine
+
+
+Make.py -p ^atc -a machine
+
+
+Supporting info: fix atc, examples/USER/atc
Supporting info:
This package provides OpenMP multi-threading support and
other optimizations of various LAMMPS pair styles, dihedral
@@ -2379,6 +2617,27 @@ settings for CCFLAGS and LINKFLAGS.
4.2.18. USER-PHONON package¶
+Contents: A fix atc command (atoms to continuum) to
+either couple of MD with FE-based physics surrogates or on-the-fly
+post-processing of atomic information to continuum fields. See
+src/USER-ATC/README for more details.
+To install via make or Make.py:
+make yes-user-atc
+make machine
+
+
+Make.py -p atc -a machine
+
+
+To un-install via make or Make.py:
+make no-user-atc
+make machine
+
+
+Make.py -p ^atc -a machine
+
+
+Supporting info: fix atc, examples/USER/atc
This package contains a fix phonon command that calculates dynamical
matrices, which can then be used to compute phonon dispersion
relations, directly from molecular dynamics simulations.
@@ -2387,30 +2646,32 @@ relations, directly from molecular dynamics simulations.
The person who created this package is Ling-Ti Kong (konglt at
sjtu.edu.cn) at Shanghai Jiao Tong University. Contact him directly
if you have questions.
-To install via make or Make.py:
-make yes-body
-make machine
-
-
-Make.py -p body -a machine
-
-
-To un-install via make or Make.py:
-make no-body
-make machine
-
-
-Make.py -p ^body -a machine
-
-
Examples: examples/USER/phonon
4.2.19. USER-QMMM package¶
-Contents:
+Contents: A fix atc command (atoms to continuum) to
+either couple of MD with FE-based physics surrogates or on-the-fly
+post-processing of atomic information to continuum fields. See
+src/USER-ATC/README for more details.
To install via make or Make.py:
+make yes-user-atc
+make machine
+
+
+Make.py -p atc -a machine
+
+
To un-install via make or Make.py:
+make no-user-atc
+make machine
+
+
+Make.py -p ^atc -a machine
+
+
+Supporting info: fix atc, examples/USER/atc
Supporting info:
This package provides a fix qmmm command which allows LAMMPS to be
used in a QM/MM simulation, currently only in combination with pw.x
@@ -2429,9 +2690,27 @@ without changes to LAMMPS itself.
4.2.20. USER-QTB package¶
-Contents:
+Contents: A fix atc command (atoms to continuum) to
+either couple of MD with FE-based physics surrogates or on-the-fly
+post-processing of atomic information to continuum fields. See
+src/USER-ATC/README for more details.
To install via make or Make.py:
+make yes-user-atc
+make machine
+
+
+Make.py -p atc -a machine
+
+
To un-install via make or Make.py:
+make no-user-atc
+make machine
+
+
+Make.py -p ^atc -a machine
+
+
+Supporting info: fix atc, examples/USER/atc
Supporting info:
This package provides a self-consistent quantum treatment of the
vibrational modes in a classical molecular dynamics simulation. By
@@ -2451,53 +2730,59 @@ bath with the shocked system.
The person who created this package is Yuan Shen (sy0302 at
stanford.edu) at Stanford University. Contact him directly if you
have questions.
-To install via make or Make.py:
-make yes-body
-make machine
-
-
-Make.py -p body -a machine
-
-
-To un-install via make or Make.py:
-make no-body
-make machine
-
-
-Make.py -p ^body -a machine
-
-
Examples: examples/USER/qtb
4.2.21. USER-QUIP package¶
-Contents:
+Contents: A fix atc command (atoms to continuum) to
+either couple of MD with FE-based physics surrogates or on-the-fly
+post-processing of atomic information to continuum fields. See
+src/USER-ATC/README for more details.
To install via make or Make.py:
+make yes-user-atc
+make machine
+
+
+Make.py -p atc -a machine
+
+
To un-install via make or Make.py:
+make no-user-atc
+make machine
+
+
+Make.py -p ^atc -a machine
+
+
+Supporting info: fix atc, examples/USER/atc
Supporting info:
Examples: examples/USER/quip
4.2.22. USER-REAXC package¶
-Contents:
+Contents: A fix atc command (atoms to continuum) to
+either couple of MD with FE-based physics surrogates or on-the-fly
+post-processing of atomic information to continuum fields. See
+src/USER-ATC/README for more details.
To install via make or Make.py:
-make yes-body
+make yes-user-atc
make machine
-Make.py -p body -a machine
+Make.py -p atc -a machine
To un-install via make or Make.py:
-make no-body
+make no-user-atc
make machine
-Make.py -p ^body -a machine
+Make.py -p ^atc -a machine
+Supporting info: fix atc, examples/USER/atc
Supporting info:
This package contains a implementation for LAMMPS of the ReaxFF force
field. ReaxFF uses distance-dependent bond-order functions to
@@ -2528,9 +2813,27 @@ questions.
4.2.23. USER-SMD package¶
-Contents:
+Contents: A fix atc command (atoms to continuum) to
+either couple of MD with FE-based physics surrogates or on-the-fly
+post-processing of atomic information to continuum fields. See
+src/USER-ATC/README for more details.
To install via make or Make.py:
+make yes-user-atc
+make machine
+
+
+Make.py -p atc -a machine
+
+
To un-install via make or Make.py:
+make no-user-atc
+make machine
+
+
+Make.py -p ^atc -a machine
+
+
+Supporting info: fix atc, examples/USER/atc
Supporting info:
This package implements smoothed Mach dynamics (SMD) in
LAMMPS. Currently, the package has the following features:
@@ -2557,23 +2860,27 @@ you have questions.
4.2.24. USER-SMTBQ package¶
-Contents:
+Contents: A fix atc command (atoms to continuum) to
+either couple of MD with FE-based physics surrogates or on-the-fly
+post-processing of atomic information to continuum fields. See
+src/USER-ATC/README for more details.
To install via make or Make.py:
-make yes-body
+make yes-user-atc
make machine
-Make.py -p body -a machine
+Make.py -p atc -a machine
To un-install via make or Make.py:
-make no-body
+make no-user-atc
make machine
-Make.py -p ^body -a machine
+Make.py -p ^atc -a machine
+Supporting info: fix atc, examples/USER/atc
Supporting info:
This package implements the Second Moment Tight Binding - QEq (SMTB-Q)
potential for the description of ionocovalent bonds in oxides.
@@ -2590,23 +2897,27 @@ them directly if you have any questions.
4.2.25. USER-SPH package¶
-Contents:
+Contents: A fix atc command (atoms to continuum) to
+either couple of MD with FE-based physics surrogates or on-the-fly
+post-processing of atomic information to continuum fields. See
+src/USER-ATC/README for more details.
To install via make or Make.py:
-make yes-body
+make yes-user-atc
make machine
-Make.py -p body -a machine
+Make.py -p atc -a machine
To un-install via make or Make.py:
-make no-body
+make no-user-atc
make machine
-Make.py -p ^body -a machine
+Make.py -p ^atc -a machine
+Supporting info: fix atc, examples/USER/atc
Supporting info:
This package implements smoothed particle hydrodynamics (SPH) in
LAMMPS. Currently, the package has the following features:
@@ -2631,33 +2942,54 @@ you have questions.
4.2.26. USER-TALLY package¶
-Contents:
+Contents: A fix atc command (atoms to continuum) to
+either couple of MD with FE-based physics surrogates or on-the-fly
+post-processing of atomic information to continuum fields. See
+src/USER-ATC/README for more details.
To install via make or Make.py:
-make yes-body
+make yes-user-atc
make machine
-Make.py -p body -a machine
+Make.py -p atc -a machine
To un-install via make or Make.py:
-make no-body
+make no-user-atc
make machine
-Make.py -p ^body -a machine
+Make.py -p ^atc -a machine
+Supporting info: fix atc, examples/USER/atc
Supporting info:
Examples: examples/USER/tally
4.2.27. USER-VTK package¶
-Contents:
+Contents: A fix atc command (atoms to continuum) to
+either couple of MD with FE-based physics surrogates or on-the-fly
+post-processing of atomic information to continuum fields. See
+src/USER-ATC/README for more details.
To install via make or Make.py:
+make yes-user-atc
+make machine
+
+
+Make.py -p atc -a machine
+
+
To un-install via make or Make.py:
-Supporting info:
+make no-user-atc
+make machine
+
+
+Make.py -p ^atc -a machine
+
+
+Supporting info: fix atc, examples/USER/atc
Examples: examples/USER/tally
diff --git a/doc/Section_packages.txt b/doc/Section_packages.txt
index 3bf6585f15..31e5093735 100644
--- a/doc/Section_packages.txt
+++ b/doc/Section_packages.txt
@@ -34,10 +34,14 @@ has a summary of what the package contains. It has specific
instructions on how to install it, build or obtain any auxiliary
library it requires, and any Makefile.machine changes it requires. It
also lists pointers to examples of its use or documentation provided
-in the LAMMPS distribution.
+in the LAMMPS distribution. If you want to know the complete list of
+commands that a package adds to LAMMPS, simply list the files in its
+directory, e.g. "ls src/GRANULAR". Source files with names that start
+with compute, fix, pair, bond, etc correspond to command styles with
+the same names.
-NOTE: The sub-sections below are still being filled in, as of Feb
-2016.
+NOTE: The USER package sub-sections below are still being filled in,
+as of March 2016.
Unless otherwise noted below, every package is independent of all the
others. I.e. any package can be included or excluded in a LAMMPS
@@ -63,15 +67,14 @@ Package, Description, Author(s), Doc page, Example, Library
"ASPHERE"_#ASPHERE, aspherical particles, -, "Section_howto 6.14"_Section_howto.html#howto_14, ellipse, -
"BODY"_#BODY, body-style particles, -, "body"_body.html, body, -
"CLASS2"_#CLASS2, class 2 force fields, -, "pair_style lj/class2"_pair_class2.html, -, -
-"COLLOID"_#COLLOID, colloidal particles, -, "atom_style colloid"_atom_style.html, colloid, -
+"COLLOID"_#COLLOID, colloidal particles, Kumar (1), "atom_style colloid"_atom_style.html, colloid, -
"COMPRESS"_#COMPRESS, I/O compression, Axel Kohlmeyer (Temple U), "dump */gz"_dump.html, -, -
"CORESHELL"_#CORESHELL, adiabatic core/shell model, Hendrik Heenen (Technical U of Munich), "Section_howto 6.25"_Section_howto.html#howto_25, coreshell, -
"DIPOLE"_#DIPOLE, point dipole particles, -, "pair_style dipole/cut"_pair_dipole.html, dipole, -
-"FLD"_#FLD, Fast Lubrication Dynamics, Kumar & Bybee & Higdon (1), "pair_style lubricateU"_pair_lubricateU.html, -, -
"GPU"_#GPU, GPU-enabled styles, Mike Brown (ORNL), "Section accelerate"_accelerate_gpu.html, gpu, lib/gpu
"GRANULAR"_#GRANULAR, granular systems, -, "Section_howto 6.6"_Section_howto.html#howto_6, pour, -
"KIM"_#KIM, openKIM potentials, Smirichinski & Elliot & Tadmor (3), "pair_style kim"_pair_kim.html, kim, KIM
-"KOKKOS"_#KOKKOS, Kokkos-enabled styles, Trott & Edwards (4), "Section_accelerate"_accelerate_kokkos.html, kokkos, lib/kokkos
+"KOKKOS"_#KOKKOS, Kokkos-enabled styles, Trott & Moore (4), "Section_accelerate"_accelerate_kokkos.html, kokkos, lib/kokkos
"KSPACE"_#KSPACE, long-range Coulombic solvers, -, "kspace_style"_kspace_style.html, peptide, -
"MANYBODY"_#MANYBODY, many-body potentials, -, "pair_style tersoff"_pair_tersoff.html, shear, -
"MEAM"_#MEAM, modified EAM potential, Greg Wagner (Sandia), "pair_style meam"_pair_meam.html, meam, lib/meam
@@ -94,8 +97,9 @@ Package, Description, Author(s), Doc page, Example, Library
The "Authors" column lists a name(s) if a specific person is
responible for creating and maintaining the package.
-(1) The FLD package was created by Amit Kumar and Michael Bybee from
-Jonathan Higdon's group at UIUC.
+(1) The COLLOID package includes Fast Lubrication Dynamics pair styles
+which were created by Amit Kumar and Michael Bybee from Jonathan
+Higdon's group at UIUC.
(2) The OPT package was created by James Fischer (High Performance
Technologies), David Richie, and Vincent Natoli (Stone Ridge
@@ -104,9 +108,9 @@ Technolgy).
(3) The KIM package was created by Valeriu Smirichinski, Ryan Elliott,
and Ellad Tadmor (U Minn).
-(4) The KOKKOS package was created primarily by Christian Trott
-(Sandia). It uses the Kokkos library which was developed by Carter
-Edwards, Christian, and collaborators at Sandia.
+(4) The KOKKOS package was created primarily by Christian Trott and
+Stan Moore (Sandia). It uses the Kokkos library which was developed
+by Carter Edwards, Christian Trott, and others at Sandia.
The "Doc page" column links to either a sub-section of the
"Section_howto"_Section_howto.html of the manual, or an input script
@@ -130,8 +134,8 @@ p.s.: are we ever going to get commit messages from you? ;-)
ASPHERE package :link(ASPHERE),h5
-Contents: Aspherical particle models for ellipsoids, 2d lines, 3d
-triangles.
+Contents: Several computes, time-integration fixes, and pair styles
+for aspherical particle models: ellipsoids, 2d lines, 3d triangles.
To install via make or Make.py:
@@ -147,14 +151,20 @@ make machine :pre
Make.py -p ^asphere -a machine :pre
-Supporting info: examples/ASPHERE, examples/ellipse, Section howto
-6.14, pair gayberne
+Supporting info: "Section howto 6.14"_Section_howto.html#howto_14,
+"pair_style gayberne"_pair_gayberne.html, "pair_style
+resquared"_pair_resquared.html,
+"doc/PDF/pair_gayberne_extra.pdf"_PDF/pair_gayberne_extra.pdf,
+"doc/PDF/pair_resquared_extra.pdf"_PDF/pair_resquared_extra.pdf,
+examples/ASPHERE, examples/ellipse
:line
BODY package :link(BODY),h5
-Contents:
+Contents: Support for body-style particles. Computes,
+time-integration fixes, pair styles, as well as the body styles
+themselves. See the "body"_body.html doc page for an overview.
To install via make or Make.py:
@@ -170,13 +180,15 @@ make machine :pre
Make.py -p ^body -a machine :pre
-Supporting info: examples/body
+Supporting info: "atom_style body"_atom_style.html, "body"_body.html,
+"pair_style body"_pair_body.html, examples/body
:line
CLASS2 package :link(CLASS2),h5
-Contents:
+Contents: Bond, angle, dihedral, improper, and pair styles for the
+COMPASS CLASS2 molecular force field.
To install via make or Make.py:
@@ -192,13 +204,20 @@ make machine :pre
Make.py -p ^class2 -a machine :pre
-Supporting info:
+Supporting info: "bond_style class2"_bond_class2.html, "angle_style
+class2"_angle_class2.html, "dihedral_style
+class2"_dihedral_class2.html, "improper_style
+class2"_improper_class2.html, "pair_style lj/class2"_pair_class2.html
:line
COLLOID package :link(COLLOID),h5
-Contents:
+Contents: Support for coarse-grained colloidal particles. Wall fix
+and pair styles that implement colloidal interaction models for
+finite-size particles. This includes the Fast Lubrication Dynamics
+method for hydrodynamic interactions, which is a simplified
+approximation to Stokesian dynamics.
To install via make or Make.py:
@@ -214,13 +233,26 @@ make machine :pre
Make.py -p ^colloid -a machine :pre
-Supporting info: examples/colloid, examples/srd
-
+Supporting info: "fix wall/colloid"_fix_wall.html, "pair_style
+colloid"_pair_colloid.html, "pair_style
+yukawa/colloid"_pair_yukawa_colloid.html, "pair_style
+brownian"_pair_brownian.html, "pair_style
+lubricate"_pair_lubricate.html, "pair_style
+lubricateU"_pair_lubricateU.html, examples/colloid, examples/srd
+
:line
COMPRESS package :link(COMPRESS),h5
-Contents:
+Contents: Support for compressed output of dump files via the zlib
+compression library, using dump styles with a "gz" in their style
+name.
+
+Building with the COMPRESS package assumes you have the zlib
+compression library available on your system. The build uses the
+lib/compress/Makefile.lammps file in the compile/link process. You
+should only need to edit this file if the LAMMPS build cannot find the
+zlib info it specifies.
To install via make or Make.py:
@@ -236,13 +268,21 @@ make machine :pre
Make.py -p ^compress -a machine :pre
-Supporting info:
+Supporting info: src/COMPRESS/README, lib/compress/README, "dump
+atom/gz"_dump.html, "dump cfg/gz"_dump.html, "dump
+custom/gz"_dump.html, "dump xyz/gz"_dump.html
:line
CORESHELL package :link(CORESHELL),h5
-Contents:
+Contents: Compute and pair styles that implement the adiabatic
+core/shell model for polarizability. The compute temp/cs command
+measures the temperature of a system with core/shell particles. The
+pair styles augment Born, Buckingham, and Lennard-Jones styles with
+core/shell capabilities. See "Section howto
+6.26"_Section_howto.html#howto_26 for an overview of how to use the
+package.
To install via make or Make.py:
@@ -258,13 +298,18 @@ make machine :pre
Make.py -p ^coreshell -a machine :pre
-Supporting info: examples/coreshell, Section howto 6.26
+Supporting info: "Section howto
+6.26"_Section_howto.html#howto_26, "compute temp/cs"_compute_temp_cs.html,
+"pair_style born/coul/long/cs"_pair_cs.html, "pair_style
+buck/coul/long/cs"_pair_cs.html, pair_style
+lj/cut/coul/long/cs"_pair_lj.html, examples/coreshell
:line
DIPOLE package :link(DIPOLE),h5
-Contents:
+Contents: An atom style and several pair styles to support point
+dipole models with short-range or long-range interactions.
To install via make or Make.py:
@@ -280,42 +325,54 @@ make machine :pre
Make.py -p ^dipole -a machine :pre
-Supporting info: examples/dipole
-
-:line
-
-FLD package :link(FLD),h5
-
-Contents:
-
-To install via make or Make.py:
-
-make yes-fld
-make machine :pre
-
-Make.py -p fld -a machine :pre
-
-To un-install via make or Make.py:
-
-make no-fld
-make machine :pre
-
-Make.py -p ^fld -a machine :pre
-
-Supporting info:
+Supporting info: "atom_style dipole"_atom_style.html, "pair_style
+lj/cut/dipole/cut"_pair_dipole.html, "pair_style
+lj/cut/dipole/long"_pair_dipole.html, "pair_style
+lj/long/dipole/long"_pair_dipole.html, examples/dipole
:line
GPU package :link(GPU),h5
-Contents:
+Contents: Dozens of pair styles and a version of the PPPM long-range
+Coulombic solver for NVIDIA GPUs. All of them have a "gpu" in their
+style name. "Section accelerate gpu"_accelerate_gpu.html gives
+details of what hardware and Cuda software is required on your system,
+and how to build and use this package. See the KOKKOS and USER-CUDA
+packages, which also have GPU-enabled styles.
+
+Building LAMMPS with the GPU package requires first building the GPU
+library itself, which is a set of C and Cuda files in lib/gpu.
+Details of how to do this are in lib/gpu/README. As illustrated
+below, perform a "make" using one of the Makefile.machine files in
+lib/gpu which should create a lib/reax/libgpu.a file.
+Makefile.linux.* and Makefile.xk7 are examples for different
+platforms. There are 3 important settings in the Makefile.machine you
+use:
+
+CUDA_HOME = where NVIDIA Cuda software is installed on your system
+CUDA_ARCH = appropriate to your GPU hardware
+CUDA_PREC = precision (double, mixed, single) you desire :ul
+
+See example Makefile.machine files in lib/gpu for the syntax of these
+settings. See lib/gpu/Makefile.linux.double for ARCH settings for
+various NVIDIA GPUs. The "make" also creates a
+lib/gpu/Makefile.lammps file. This file has settings that enable
+LAMMPS to link with Cuda libraries. If the settings in
+Makefile.lammps for your machine are not correct, the LAMMPS link will
+fail. Note that the Make.py script has a "-gpu" option to allow the
+GPU library (with several of its options) and LAMMPS to be built in
+one step, with Type "python src/Make.py -h -gpu" to see the details.
To install via make or Make.py:
+cd ~/lammps/lib/gpu
+make -f Makefile.linux.mixed # for example
+cd ~/lammps/src
make yes-gpu
make machine :pre
-Make.py -p gpu -a machine :pre
+Make.py -p gpu -gpu mode=mixed arch=35 -a machine :pre
To un-install via make or Make.py:
@@ -324,13 +381,20 @@ make machine :pre
Make.py -p ^gpu -a machine :pre
-Supporting info: examples/accelerate, bench/FERMI, bench/KEPLER
+Supporting info: src/GPU/README, lib/gpu/README, "Section
+acclerate"_Section_accelerate.html, "Section accelerate
+gpu"_accelerate_gpu.html, Pair Styles section of "Section commands
+3.5"_Section_commands.html#cmd_5 for any pair style listed with a (g),
+"kspace_style"_kspace_style.html, "package gpu"_package.html,
+examples/accelerate, bench/FERMI, bench/KEPLER
:line
GRANULAR package :link(GRANULAR),h5
-Contents:
+Contents: Fixes and pair styles that support models of finite-size
+granular particles, which interact with each other and boundaries via
+frictional and dissipative potentials.
To install via make or Make.py:
@@ -346,13 +410,24 @@ make machine :pre
Make.py -p ^granular -a machine :pre
-Supporting info: examples/pour, bench/in.chute, Section howto 6.6
+Supporting info: "Section howto 6.6"_Section_howto.html#howto_6, "fix
+pour"_fix_pour.html, "fix wall/gran"_fix_wall_gran.html, "pair_style
+gran/hooke"_pair_gran.html, "pair_style
+gran/hertz/history"_pair_gran.html, examples/pour, bench/in.chute
:line
KIM package :link(KIM),h5
-Contents:
+Contents: A pair style that interfaces to the Knowledge Base for
+Interatomic Models (KIM) repository of interatomic potentials, so that
+KIM potentials can be used in a LAMMPS simulation.
+
+To build LAMMPS with the KIM package you must have previously
+installed the KIM API (library) on your system. The lib/kim/README
+file explains how to download and install KIM. Building with the KIM
+package also uses the lib/kim/Makefile.lammps file in the compile/link
+process. You should not need to edit this file.
To install via make or Make.py:
@@ -368,57 +443,85 @@ make machine :pre
Make.py -p ^kim -a machine :pre
-Supporting info: examples/kim
+Supporting info: src/KIM/README, lib/kim/README, "pair_style
+kim"_pair_kim.html, examples/kim
:line
KOKKOS package :link(KOKKOS),h5
-Contents:
+Contents: Dozens of atom, pair, bond, angle, dihedral, improper styles
+which run with the Kokkos library to provide optimization for
+multicore CPUs (via OpenMP), NVIDIA GPUs, or the Intel Xeon Phi (in
+native mode). All of them have a "kk" in their style name. "Section
+accelerate kokkos"_accelerate_kokkos.html gives details of what
+hardware and software is required on your system, and how to build and
+use this package. See the GPU, OPT, USER-CUDA, USER-INTEL, USER-OMP
+packages, which also provide optimizations for the same range of
+hardware.
-To install via make or Make.py:
+Building with the KOKKOS package requires choosing which of 3 hardware
+options you are optimizing for: CPU acceleration via OpenMP, GPU
+acceleration, or Intel Xeon Phi. (You can build multiple times to
+create LAMMPS executables for different hardware.) It also requires a
+C++11 compatible compiler. For GPUs, the NVIDIA "nvcc" compiler is
+used, and an appopriate KOKKOS_ARCH setting should be made in your
+Makefile.machine for your GPU hardware and NVIDIA software.
-make yes-kokkow
-make machine :pre
+The simplest way to do this is to use Makefile.kokkos_cuda or
+Makefile.kokkos_omp or Makefile.kokkos_phi in src/MAKE/OPTIONS, via
+"make kokkos_cuda" or "make kokkos_omp" or "make kokkos_phi". (Check
+the KOKKOS_ARCH setting in Makefile.kokkos_cuda), Or, as illustrated
+below, you can use the Make.py script with its "-kokkos" option to
+choose which hardware to build for. Type "python src/Make.py -h
+-kokkos" to see the details. If these methods do not work on your
+system, you will need to read the "Section accelerate
+kokkos"_accelerate_kokkos.html doc page for details of what
+Makefile.machine settings are needed.
-Make.py -p kokkow -a machine :pre
+To install via make or Make.py for each of 3 hardware options:
+
+make yes-kokkos
+make kokkos_omp # for CPUs with OpenMP
+make kokkos_cuda # for GPUs, check the KOKKOS_ARCH setting in Makefile.kokkos_cuda
+make kokkos_phi # for Xeon Phis :pre
+
+Make.py -p kokkos -kokkos omp -a machine # for CPUs with OpenMP
+Make.py -p kokkos -kokkos cuda arch=35 -a machine # for GPUs of style arch
+Make.py -p kokkos -kokkos phi -a machine # for Xeon Phis
To un-install via make or Make.py:
-make no-kokkow
+make no-kokkos
make machine :pre
-Make.py -p ^kokkow -a machine :pre
+Make.py -p ^kokkos -a machine :pre
-Supporting info:
+Supporting info: src/KOKKOS/README, lib/kokkos/README, "Section
+acclerate"_Section_accelerate.html, "Section accelerate
+kokkos"_accelerate_kokkos.html, Pair Styles section of "Section
+commands 3.5"_Section_commands.html#cmd_5 for any pair style listed
+with a (k), "package kokkos"_package.html,
+examples/accelerate, bench/FERMI, bench/KEPLER
-For the KOKKOS package, you have 3 choices when building. You can
-build with OMP or Cuda or Phi support. Phi support uses Xeon Phi
-chips in "native" mode. This can be done by setting the following
-variables in your Makefile.machine:
-
-for OMP support, set OMP = yes
-for Cuda support, set OMP = yes and CUDA = yes
-for Phi support, set OMP = yes and MIC = yes :ul
-
-These can also be set as additional arguments to the make command, e.g.
-
-make g++ OMP=yes MIC=yes :pre
-
-Building the KOKKOS package with CUDA support requires a Makefile
-machine that uses the NVIDIA "nvcc" compiler, as well as an
-appropriate "arch" setting appropriate to the GPU hardware and NVIDIA
-software you have on your machine. See
-src/MAKE/OPTIONS/Makefile.kokkos_cuda for an example of such a machine
-Makefile.
-
-Examples: examples/accelerate, bench/FERMI, bench/KEPLER
-
:line
KSPACE package :link(KSPACE),h5
-Contents:
+Contents: A variety of long-range Coulombic solvers, and pair styles
+which compute the corresponding short-range portion of the pairwise
+Coulombic interactions. These include Ewald, particle-particle
+particle-mesh (PPPM), and multilevel summation method (MSM) solvers.
+
+Building with the KSPACE package requires a 1d FFT library be present
+on your system for use by the PPPM solvers. This can be the KISS FFT
+library provided with LAMMPS, or 3rd party libraries like FFTW or a
+vendor-supplied FFT library. See step 6 of "Section start
+2.2.2"_Section_start.html#start_2_2 of the manual for details of how
+to select different FFT options in your machine Makefile. The Make.py
+tool has an "-fft" option which can insert these settings into your
+machine Makefile automatically. Type "python src/Make.py -h -fft" to
+see the details.
To install via make or Make.py:
@@ -434,17 +537,22 @@ make machine :pre
Make.py -p ^kspace -a machine :pre
-Supporting info:
-
-Examples: examples/peptide, bench/in.rhodo
-
-Doc: Section howto 6.7, Section howto 6.8, Section howto 6.9
+Supporting info: "kspace_style"_kspace_style.html,
+"doc/PDF/kspace.pdf"_PDF/kspace.pdf, "Section howto
+6.7"_Section_howto.html#howto_7, "Section howto
+6.8"_Section_howto.html#howto_8, "Section howto
+6.9"_Section_howto.html#howto_9, "pair_style coul"_pair_coul.html,
+other pair style command doc pages which have "long" or "msm" in their
+style name, examples/peptide, bench/in.rhodo
:line
MANYBODY package :link(MANYBODY),h5
-Contents:
+Contents: A variety of many-body and bond-order potentials. These
+include (AI)REBO, EAM, EIM, BOP, Stillinger-Weber, and Tersoff
+potentials. Do a directory listing, "ls src/MANYBODY", to see
+the full list.
To install via make or Make.py:
@@ -462,13 +570,18 @@ Make.py -p ^manybody -a machine :pre
Supporting info:
-Examples: examples/comb, examples/eim, examples/nb3d, examples/vashishta
+Examples: Pair Styles section of "Section commands
+3.5"_Section_commands.html#cmd_5, examples/comb, examples/eim,
+examples/nb3d, examples/vashishta
:line
MC package :link(MC),h5
-Contents:
+Contents: Several fixes and a pair style that have Monte Carlo (MC) or
+MC-like attributes. These include fixes for creating, breaking, and
+swapping bonds, and for performing atomic swaps and grand-canonical MC
+in conjuction with dynamics.
To install via make or Make.py:
@@ -484,20 +597,46 @@ make machine :pre
Make.py -p ^mc -a machine :pre
-Supporting info:
+Supporting info: "fix atom/swap"_fix_atom_swap.html, "fix
+bond/break"_fix_bond_break.html, "fix
+bond/create"_fix_bond_create.html, "fix bond/swap"_fix_bond_swap.html,
+"fix gcmc"_fix_gcmc.html, "pair_style dsmc"_pair_dsmc.html
:line
MEAM package :link(MEAM),h5
-Contents:
+Contents: A pair style for the modified embedded atom (MEAM)
+potential.
+
+Building LAMMPS with the MEAM package requires first building the MEAM
+library itself, which is a set of Fortran 95 files in lib/meam.
+Details of how to do this are in lib/meam/README. As illustrated
+below, perform a "make" using one of the Makefile.machine files in
+lib/meam which should create a lib/meam/libmeam.a file.
+Makefile.gfortran and Makefile.ifort are examples for the GNU Fortran
+and Intel Fortran compilers. The "make" also copies a
+lib/meam/Makefile.lammps.machine file to lib/meam/Makefile.lammps.
+This file has settings that enable the C++ compiler used to build
+LAMMPS to link with a Fortran library (typically the 2 compilers to be
+consistent e.g. both Intel compilers, or both GNU compilers). If the
+settings in Makefile.lammps for your compilers and machine are not
+correct, the LAMMPS link will fail. Note that the Make.py script has
+a "-meam" option to allow the MEAM library and LAMMPS to be built in
+one step. Type "python src/Make.py -h -meam" to see the details.
+
+NOTE: The MEAM potential can run dramatically faster if built with the
+Intel Fortran compiler, rather than the GNU Fortran compiler.
To install via make or Make.py:
+cd ~/lammps/lib/meam
+make -f Makefile.gfortran # for example
+cd ~/lammps/src
make yes-meam
make machine :pre
-Make.py -p meam -a machine :pre
+Make.py -p meam -meam make=gfortran -a machine :pre
To un-install via make or Make.py:
@@ -506,13 +645,16 @@ make machine :pre
Make.py -p ^meam -a machine :pre
-Supporting info: examples/meam
+Supporting info: lib/meam/README, "pair_style meam"_pair_meam.html,
+examples/meam
:line
MISC package :link(MISC),h5
-Contents:
+Contents: A variety of computes, fixes, and pair styles that are not
+commonly used, but don't align with other packages. Do a directory
+listing, "ls src/MISC", to see the list of commands.
To install via make or Make.py:
@@ -528,13 +670,18 @@ make machine :pre
Make.py -p ^misc -a machine :pre
-Supporting info: examples/misc
+Supporting info: "compute ti"_compute_ti.html, "fix
+evaporate"_fix_evaporate.html, "fix tmm"_fix_ttm.html, "fix
+viscosity"_fix_viscosity.html, examples/misc
:line
MOLECULE package :link(MOLECULE),h5
-Contents:
+Contents: A large number of atom, pair, bond, angle, dihedral,
+improper styles that are used to model molecular systems with fixed
+covalent bonds. The pair styles include terms for the Dreiding
+(hydrogen-bonding) and CHARMM force fields, and TIP4P water model.
To install via make or Make.py:
@@ -550,13 +697,24 @@ make machine :pre
Make.py -p ^molecule -a machine :pre
-Supporting info: examples/micelle, examples/peptide, bench/in.chain, bench/in.rhodo, Section howto 6.3
-
+Supporting info:"atom_style"_atom_style.html,
+"bond_style"_bond_style.html, "angle_style"_angle_style.html,
+"dihedral_style"_dihedral_style.html,
+"improper_style"_improper_style.html, "pair_style
+hbond/dreiding/lj"_pair_hbond_dreiding.html, "pair_style
+lj/charmm/coul/charmm"_pair_charmm.html, "Section howto
+6.3"_Section_howto.html#howto_3, examples/micelle, examples/peptide,
+bench/in.chain, bench/in.rhodo
+
:line
MPIIO package :link(MPIIO),h5
-Contents:
+Contents: Support for parallel output/input of dump and restart files
+via the MPIIO library, which is part of the standard message-passing
+interface (MPI) library. It adds "dump styles"_dump.html with a
+"mpiio" in their style name. Restart files with an ".mpiio" suffix
+are also written and read in parallel.
To install via make or Make.py:
@@ -572,13 +730,26 @@ make machine :pre
Make.py -p ^mpiio -a machine :pre
-Supporting info:
+Supporting info: "dump"_dump.html, "restart"_restart.html,
+"write_restart"_write_restart.html, "read_restart"_read_restart.html
:line
OPT package :link(OPT),h5
-Contents:
+Contents: A handful of pair styles with an "opt" in their style name
+which are optimized for improved CPU performance on single or multiple
+cores. These include EAM, LJ, CHARMM, and Morse potentials. "Section
+accelerate opt"_accelerate_opt.html gives details of how to build and
+use this package. See the KOKKOS, USER-INTEL, and USER-OMP packages,
+which also have styles optimized for CPU performance.
+
+Some C++ compilers, like the Intel compiler, require the compile flag
+"-restrict" to build LAMMPS with the OPT package. It should be added
+to the CCFLAGS line of your Makefile.machine. Or use Makefile.opt in
+src/MAKE/OPTIONS, via "make opt". For compilers that use the flag,
+the Make.py command adds it automatically to the Makefile.auto file it
+creates and uses.
To install via make or Make.py:
@@ -594,18 +765,19 @@ make machine :pre
Make.py -p ^opt -a machine :pre
-Supporting info: examples/accelerate, bench/KEPLER
-
-For the OPT package, your Makefile.machine needs an additional
-settings for CCFLAGS.
-
-CCFLAGS: add -restrict :ul
+Supporting info: "Section acclerate"_Section_accelerate.html, "Section
+accelerate opt"_accelerate_opt.html, Pair Styles section of "Section
+commands 3.5"_Section_commands.html#cmd_5 for any pair style listed
+with an (o), examples/accelerate, bench/KEPLER
:line
PERI package :link(PERI),h5
-Contents:
+Contents: Support for the Peridynamics method, a particle-based
+meshless continuum model. The package includes an atom style, several
+computes which calculate diagnostics, and several Peridynamic pair
+styles which implement different materials models.
To install via make or Make.py:
@@ -621,35 +793,74 @@ make machine :pre
Make.py -p ^peri -a machine :pre
-Supporting info: examples/peri
+Supporting info:
+"doc/PDF/PDLammps_overview.pdf"_PDF/PDLammps_overview.pdf,
+"doc/PDF/PDLammps_EPS.pdf"_PDF/PDLammps_EPS.pdf,
+"doc/PDF/PDLammps_VES.pdf"_PDF/PDLammps_VES.pdf, "atom_style
+peri"_atom_style.html, "compute damage"_compute_damage.html,
+"pair_style peri/pmb"_pair_peri.html, examples/peri
:line
POEMS package :link(POEMS),h5
-Contents:
+Contents: A fix that wraps the Parallelizable Open source Efficient
+Multibody Software (POEMS) librar, which is able to simulate the
+dynamics of articulated body systems. These are systems with multiple
+rigid bodies (collections of atoms or particles) whose motion is
+coupled by connections at hinge points.
+
+Building LAMMPS with the POEMS package requires first building the
+POEMS library itself, which is a set of C++ files in lib/poems.
+Details of how to do this are in lib/poems/README. As illustrated
+below, perform a "make" using one of the Makefile.machine files in
+lib/poems which should create a lib/meam/libpoems.a file.
+Makefile.g++ and Makefile.icc are examples for the GNU and Intel C++
+compilers. The "make" also creates a lib/poems/Makefile.lammps file
+which you should not need to change. Note the Make.py script has a
+"-poems" option to allow the POEMS library and LAMMPS to be built in
+one step. Type "python src/Make.py -h -poems" to see the details.
To install via make or Make.py:
+cd ~/lammps/lib/poems
+make -f Makefile.g++ # for example
+cd ~/lammps/src
make yes-poems
make machine :pre
-Make.py -p poems -a machine :pre
+Make.py -p poems -poems make=g++ -a machine :pre
To un-install via make or Make.py:
-make no-poems
+make no-meam
make machine :pre
-Make.py -p ^poems -a machine :pre
+Make.py -p ^meam -a machine :pre
-Supporting info: examples/rigid
+Supporting info: src/POEMS/README, lib/poems/README,
+"fix_poems"_fix_poems.html, examples/rigid
:line
PYTHON package :link(PYTHON),h5
-Contents:
+Contents: A "python"_python.html command which allow you to execute
+Python code from a LAMMPS input script. The code can be in a separate
+file or embedded in the input script itself. See "Section python
+11.2"_Section_python.html#py_2" for an overview of using Python from
+LAMMPS and "Section python"_Section_python.html" for other ways to use
+LAMMPS and Python together.
+
+Building with the PYTHON package assumes you have a Python shared
+library available on your system, which needs to be a Python 2
+version, 2.6 or later. Python 3 is not supported. The build uses the
+contents of the lib/python/Makefile.lammps file to find all the Python
+files required in the build/link process. See the lib/python/README
+file if the settings in that file do not work on your system. Note
+that the Make.py script has a "-python" option to allow an alternate
+lib/python/Makefile.lammps file to be specified and LAMMPS to be built
+in one step. Type "python src/Make.py -h -python" to see the details.
To install via make or Make.py:
@@ -671,7 +882,9 @@ Supporting info: examples/python
QEQ package :link(QEQ),h5
-Contents:
+Contents: Several fixes for performing charge equilibration (QEq) via
+severeal different algorithms. These can be used with pair styles
+that use QEq as part of their formulation.
To install via make or Make.py:
@@ -687,20 +900,41 @@ make machine :pre
Make.py -p ^qeq -a machine :pre
-Supporting info: examples/qeq
+Supporting info: "fix qeq/*"_fix_qeq.html, examples/qeq
:line
REAX package :link(REAX),h5
-Contents:
+Contents: A pair style for the ReaxFF potential, a universal reactive
+force field, as well as a "fix reax/bonds"_fix_reax_bonds.html command
+for monitoring molecules as bonds are created and destroyed.
+
+Building LAMMPS with the REAX package requires first building the REAX
+library itself, which is a set of Fortran 95 files in lib/reax.
+Details of how to do this are in lib/reax/README. As illustrated
+below, perform a "make" using one of the Makefile.machine files in
+lib/reax which should create a lib/reax/libreax.a file.
+Makefile.gfortran and Makefile.ifort are examples for the GNU Fortran
+and Intel Fortran compilers. The "make" also copies a
+lib/reax/Makefile.lammps.machine file to lib/reax/Makefile.lammps.
+This file has settings that enable the C++ compiler used to build
+LAMMPS to link with a Fortran library (typically the 2 compilers to be
+consistent e.g. both Intel compilers, or both GNU compilers). If the
+settings in Makefile.lammps for your compilers and machine are not
+correct, the LAMMPS link will fail. Note that the Make.py script has
+a "-reax" option to allow the REAX library and LAMMPS to be built in
+one step. Type "python src/Make.py -h -reax" to see the details.
To install via make or Make.py:
+cd ~/lammps/lib/reax
+make -f Makefile.gfortran # for example
+cd ~/lammps/src
make yes-reax
make machine :pre
-Make.py -p reax -a machine :pre
+Make.py -p reax -reax make=gfortran -a machine :pre
To un-install via make or Make.py:
@@ -709,13 +943,24 @@ make machine :pre
Make.py -p ^reax -a machine :pre
-Supporting info: examples/reax
+Supporting info: lib/reax/README, "pair_style reax"_pair_reax.html,
+"fix reax/bonds"_fix_reax_bonds.html, examples/reax
:line
REPLICA package :link(REPLICA),h5
-Contents:
+Contents: A collection of multi-replica methods that are used by
+invoking multiple instances (replicas) of LAMMPS
+simulations. Communication between individual replicas is performed in
+different ways by the different methods. See "Section howto
+6.5"_Section_howto.html#howto_5 for an overview of how to run
+multi-replica simulations in LAMMPS. Multi-replica methods included
+in the package are nudged elastic band (NEB), parallel replica
+dynamics (PRD), temperature accelerated dynamics (TAD), parallel
+tempering, and a verlet/split algorithm for performing long-range
+Coulombics on one set of processors, and the remainded of the force
+field calcalation on another set.
To install via make or Make.py:
@@ -731,13 +976,19 @@ make machine :pre
Make.py -p ^replica -a machine :pre
-Supporting info: examples/neb, examples/prd, examples/tad, Section howto 6.5
+Supporting info: "Section howto 6.5"_Section_howto.html#howto_5,
+"neb"_neb.html, "prd"_prd.html, "tad"_tad.html, "temper"_temper.html,
+"run_style verlet/split"_run_style.html, examples/neb, examples/prd,
+examples/tad
:line
RIGID package :link(RIGID),h5
-Contents:
+Contents: A collection of computes and fixes which enforce rigid
+constraints on collections of atoms or particles. This includes SHAKE
+and RATTLE, as well as variants of rigid-body time integrators for a
+few large bodies or many small bodies.
To install via make or Make.py:
@@ -753,13 +1004,16 @@ make machine :pre
Make.py -p ^rigid -a machine :pre
-Supporting info: examples/ASPHERE, examples/rigid
+Supporting info: "compute erotate/rigid"_compute_erotate_rigid.html,
+"fix shake"_fix_shake.html, "fix rattle"_fix_rattle.html, "fix
+rigid/*"_fix_rigid.html, examples/ASPHERE, examples/rigid
:line
SHOCK package :link(SHOCK),h5
-Contents:
+Contents: A small number of fixes useful for running impact
+simulations where a shock-wave passes through a material.
To install via make or Make.py:
@@ -775,13 +1029,18 @@ make machine :pre
Make.py -p ^shock -a machine :pre
-Supporting info: examples/hugoniostat, examples/msst
+Supporting info: "fix append/atoms"_fix_append_atoms.html, "fix
+msst"_fix_msst.html, "fix nphug"_fix_nphug.html, "fix
+wall/piston"_fix_wall_piston.html, examples/hugoniostat, examples/msst
:line
SNAP package :link(SNAP),h5
-Contents:
+Contents: A pair style for the spectral neighbor analysis potential
+(SNAP), which is an empirical potential which can be quantum accurate
+when fit to an archive of DFT data. Computes useful for analyzing
+properties of the potential are also included.
To install via make or Make.py:
@@ -797,13 +1056,17 @@ make machine :pre
Make.py -p ^snap -a machine :pre
-Supporting info: examples/snap
+Supporting info: "pair snap"_pair_snap.html, "compute
+sna/atom"_compute_sna_atom.html, "compute snad/atom"_compute_sna.html,
+"compute snav/atom"_compute_sna.html, examples/snap
:line
SRD package :link(SRD),h5
-Contents:
+Contents: Two fixes which implement the Stochastic Rotation Dynamics
+(SRD) method for coarse-graining of a solvent, typically around large
+colloidal-scale particles.
To install via make or Make.py:
@@ -819,20 +1082,47 @@ make machine :pre
Make.py -p ^srd -a machine :pre
-Supporting info:
+Supporting info: "fix srd"_fix_srd.html, "fix
+wall/srd"_fix_wall_srd.html, examples/srd, examples/ASPHERE
:line
VORONOI package :link(VORONOI),h5
-Contents:
+Contents: A "compute voronoi/atom"_compute_voronoi_atom.html command
+which computes the Voronoi tesselation of a collection of atoms or
+particles by wrapping the Voro++ lib
+
+To build LAMMPS with the KIM package you must have previously
+installed the KIM API (library) on your system. The lib/kim/README
+file explains how to download and install KIM. Building with the KIM
+package also uses the lib/kim/Makefile.lammps file in the compile/link
+process. You should not need to edit this file.
+
+
+To build LAMMPS with the VORONOI package you must have previously
+installed the Voro++ library on your system. The lib/voronoi/README
+file explains how to download and install Voro++. There is a
+lib/voronoi/install.py script which automates the process. Type
+"python install.py" to see instructions. The final step is to create
+soft links in the lib/voronoi directory for "includelink" and
+"liblink" which point to installed Voro++ directories. Building with
+the VORONOI package uses the contents of the
+lib/voronoi/Makefile.lammps file in the compile/link process. You
+should not need to edit this file. Note that the Make.py script has a
+"-voronoi" option to allow the Voro++ library to be downloaded and/or
+installed and LAMMPS to be built in one step. Type "python
+src/Make.py -h -voronoi" to see the details.
To install via make or Make.py:
+cd ~/lammps/lib/voronoi
+python install.py -g -b -l # download Voro++, build in lib/voronoi, create links
+cd ~/lammps/src
make yes-voronoi
make machine :pre
-Make.py -p voronoi -a machine :pre
+Make.py -p voronoi -voronoi install="-g -b -l" -a machine :pre
To un-install via make or Make.py:
@@ -841,13 +1131,15 @@ make machine :pre
Make.py -p ^voronoi -a machine :pre
-Supporting info: examples/voronoi
+Supporting info: src/VORONOI/README, lib/voronoi/README, "compute
+voronoi/atom"_compute_voronoi_atom.html, examples/voronoi
:line
XTC package :link(XTC),h5
-Contents:
+Contents: A "dump xtc"_dump.html command for writing snapshots in the
+XTC format used by the GROMACS MD package.
To install via make or Make.py:
@@ -863,7 +1155,7 @@ make machine :pre
Make.py -p ^xtc -a machine :pre
-Supporting info:
+Supporting info: "dump xtc"_dump.html
:line
@@ -952,184 +1244,164 @@ See details on all of this below for individual packages.
USER-ATC package :link(USER-ATC),h5
-Contents:
-
+Contents: ATC stands for atoms-to-continuum. This package implements
+a "fix atc"_fix_atc.html command to either couple MD with continuum
+finite element equations or perform on-the-fly post-processing of
+atomic information to continuum fields. See src/USER-ATC/README for
+more details.
+
+To build LAMMPS with this package ...
+
To install via make or Make.py:
-
+
+make yes-user-atc
+make machine :pre
+
+Make.py -p atc -a machine :pre
+
To un-install via make or Make.py:
-
-Supporting info:
-
-This package implements a "fix atc" command which can be used in a
-LAMMPS input script. This fix can be employed to either do concurrent
-coupling of MD with FE-based physics surrogates or on-the-fly
-post-processing of atomic information to continuum fields.
-See the doc page for the fix atc command to get started. At the
-bottom of the doc page are many links to additional documentation
-contained in the doc/USER/atc directory.
+make no-user-atc
+make machine :pre
-There are example scripts for using this package in examples/USER/atc.
+Make.py -p ^atc -a machine :pre
-This package uses an external library in lib/atc which must be
-compiled before making LAMMPS. See the lib/atc/README file and the
-LAMMPS manual for information on building LAMMPS with external
-libraries.
+Supporting info:src/USER-ATC/README, "fix atc"_fix_atc.html,
+examples/USER/atc
-The primary people who created this package are Reese Jones (rjones at
-sandia.gov), Jeremy Templeton (jatempl at sandia.gov) and Jon
-Zimmerman (jzimmer at sandia.gov) at Sandia. Contact them directly if
-you have questions.
-
-Examples: examples/USER/atc
+Authors: Reese Jones (rjones at sandia.gov), Jeremy Templeton (jatempl
+at sandia.gov) and Jon Zimmerman (jzimmer at sandia.gov) at Sandia.
+Contact them directly if you have questions.
:line
USER-AWPMD package :link(USER-AWPMD),h5
-Contents:
-
+Contents: AWPMD stands for Antisymmetrized Wave Packet Molecular
+Dynamics. This package implements an atom, pair, and fix style which
+allows electrons to be treated as explicit particles in an MD
+calculation. See src/USER-AWPMD/README for more details.
+
+To build LAMMPS with this package ...
+
To install via make or Make.py:
-
+
+make yes-user-atc
+make machine :pre
+
+Make.py -p atc -a machine :pre
+
To un-install via make or Make.py:
-
-Supporting info:
-
-This package contains a LAMMPS implementation of the Antisymmetrized
-Wave Packet Molecular Dynamics (AWPMD) method.
-See the doc page for the pair_style awpmd/cut command to get started.
+make no-user-atc
+make machine :pre
-There are example scripts for using this package in examples/USER/awpmd.
+Make.py -p ^atc -a machine :pre
-This package uses an external library in lib/awpmd which must be
-compiled before making LAMMPS. See the lib/awpmd/README file and the
-LAMMPS manual for information on building LAMMPS with external
-libraries.
+Supporting info: src/USER-AWPMD/README, "fix
+awpmd/cut"_pair_awpmd_cut.html, examples/USER/awpmd
-The person who created this package is Ilya Valuev at the JIHT in
-Russia (valuev at physik.hu-berlin.de). Contact him directly if you
-have questions.
-
-Examples: examples/USER/awpmd
+Author: Ilya Valuev at the JIHT in Russia (valuev at
+physik.hu-berlin.de). Contact him directly if you have questions.
:line
USER-CG-CMM package :link(USER-CG-CMM),h5
-Contents:
-
+Contents: CG-CMM stands for coarse-grained ??. This package
+implements several pair styles and an angle style using the coarse
+grained parametrization of Shinoda, DeVane, Klein, Mol Sim, 33, 27
+(2007) (SDK), with extensions to simulate ionic liquids, electrolytes,
+lipids and charged amino acids. See src/USER-CG-CMM/README for more
+details.
+
To install via make or Make.py:
-make yes-body
+make yes-user-atc
make machine :pre
-Make.py -p body -a machine :pre
+Make.py -p atc -a machine :pre
To un-install via make or Make.py:
-make no-body
+make no-user-atc
make machine :pre
-Make.py -p ^body -a machine :pre
+Make.py -p ^atc -a machine :pre
-Supporting info:
-
-This package implements 3 commands which can be used in a LAMMPS input
-script:
+Supporting info: src/USER-CG-CMM/README, "pair lj/sdk"_pair_sdk.html,
+"pair lj/sdk/coul/long"_pair_sdk.html, "angle sdk"_angle_sdk.html,
+examples/USER/cg-cmm
-pair_style lj/sdk
-pair_style lj/sdk/coul/long
-angle_style sdk :ul
-
-These styles allow coarse grained MD simulations with the
-parametrization of Shinoda, DeVane, Klein, Mol Sim, 33, 27 (2007)
-(SDK), with extensions to simulate ionic liquids, electrolytes, lipids
-and charged amino acids.
-
-See the doc pages for these commands for details.
-
-There are example scripts for using this package in
-examples/USER/cg-cmm.
-
-This is the second generation implementation reducing the the clutter
-of the previous version. For many systems with electrostatics, it will
-be faster to use pair_style hybrid/overlay with lj/sdk and coul/long
-instead of the combined lj/sdk/coul/long style. since the number of
-charged atom types is usually small. For any other coulomb
-interactions this is now required. To exploit this property, the use
-of the kspace_style pppm/cg is recommended over regular pppm. For all
-new styles, input file backward compatibility is provided. The old
-implementation is still available through appending the /old
-suffix. These will be discontinued and removed after the new
-implementation has been fully validated.
-
-The current version of this package should be considered beta
-quality. The CG potentials work correctly for "normal" situations, but
-have not been testing with all kinds of potential parameters and
-simulation systems.
-
-The person who created this package is Axel Kohlmeyer at Temple U
-(akohlmey at gmail.com). Contact him directly if you have questions.
-
-Examples: examples/USER/cg-cmm
+Author: Axel Kohlmeyer at Temple U (akohlmey at gmail.com). Contact
+him directly if you have questions.
:line
USER-COLVARS package :link(USER-COLVARS),h5
-Contents:
-
+Contents: COLVARS stands for collective variables which can be used to
+implement Adaptive Biasing Force, Metadynamics, Steered MD, Umbrella
+Sampling and Restraints. This package implements a "fix
+colvars"_fix_colvars.html command which wraps a COLVARS library which
+can perform those kinds of simulations. See src/USER-COLVARS/README
+for more details.
+
+To build LAMMPS with this package ...
+
To install via make or Make.py:
-
+
+make yes-user-atc
+make machine :pre
+
+Make.py -p atc -a machine :pre
+
To un-install via make or Make.py:
-
-Supporting info:
-
-This package implements the "fix colvars" command which can be
-used in a LAMMPS input script.
-This fix allows to use "collective variables" to implement
-Adaptive Biasing Force, Metadynamics, Steered MD, Umbrella
-Sampling and Restraints. This code consists of two parts:
+make no-user-atc
+make machine :pre
-A portable collective variable module library written and maintained
-by Giacomo Fiorin (ICMS, Temple University, Philadelphia, PA, USA) and
-Jerome Henin (LISM, CNRS, Marseille, France). This code is located in
-the directory lib/colvars and needs to be compiled first. The colvars
-fix and an interface layer, exchanges information between LAMMPS and
-the collective variable module. :ul
+Make.py -p ^atc -a machine :pre
-See the doc page of "fix colvars"_fix_colvars.html for more details.
+Supporting info:
+"doc/PDF/colvars-refman-lammps.pdf"_PDF/colvars-refman-lammps.pdf,
+src/USER-COLVARS/README, lib/colvars/README, "fix
+colvars"_fix_colvars.html, examples/USER/colvars
-There are example scripts for using this package in
-examples/USER/colvars
-
-This is a very new interface that does not yet support all
-features in the module and will see future optimizations
-and improvements. The colvars module library is also available
-in NAMD has been thoroughly used and tested there. Bugs and
-problems are likely due to the interface layers code.
-Thus the current version of this package should be considered
-beta quality.
-
-The person who created this package is Axel Kohlmeyer at Temple U
-(akohlmey at gmail.com). Contact him directly if you have questions.
-
-Examples: examples/USER/colvars
-
-Contents:
-
-To install via make or Make.py:
-
-To un-install via make or Make.py:
-
-Supporting info:
+Authors: Axel Kohlmeyer at Temple U (akohlmey at gmail.com) wrote the
+fix. The COLVARS library itself is written and maintained by Giacomo
+Fiorin (ICMS, Temple University, Philadelphia, PA, USA) and Jerome
+Henin (LISM, CNRS, Marseille, France). Contact them directly if you
+have questions.
:line
USER-CUDA package :link(USER-CUDA),h5
+Contents: A "fix atc"_fix_atc.html command (atoms to continuum) to
+either couple of MD with FE-based physics surrogates or on-the-fly
+post-processing of atomic information to continuum fields. See
+src/USER-ATC/README for more details.
+
+To build LAMMPS with this package ...
+
+To install via make or Make.py:
+
+make yes-user-atc
+make machine :pre
+
+Make.py -p atc -a machine :pre
+
+To un-install via make or Make.py:
+
+make no-user-atc
+make machine :pre
+
+Make.py -p ^atc -a machine :pre
+
+Supporting info: "fix atc"_fix_atc.html, examples/USER/atc
+
+
This package provides acceleration of various LAMMPS pair styles, fix
styles, compute styles, and long-range Coulombics via PPPM for NVIDIA
GPUs.
@@ -1151,301 +1423,249 @@ University of Technology Ilmenau, Germany (christian.trott at
tu-ilmenau.de). Contact him directly if you have questions.
Examples: examples/accelerate, bench/FERMI, bench/KEPLER
-
-Contents:
-
-To install via make or Make.py:
-
-To un-install via make or Make.py:
-
-Supporting info:
:line
USER-DIFFRACTION package :link(USER-DIFFRACTION),h5
-This package contains the commands neeed to calculate x-ray and
-electron diffraction intensities based on kinematic diffraction
-theory.
+Contents: This packages implements two computes and a fix for
+calculating x-ray and electron diffraction intensities based on
+kinematic diffraction theory. See src/USER-DIFFRACTION/README for
+more details.
-See these doc pages and their related commands to get started:
-
-"compute xrd"_compute_xrd.html
-"compute saed"_compute_saed.html
-"fix saed/vtk"_fix_saed_vtk.html :ul
-
-The person who created this package is Shawn P. Coleman
-(shawn.p.coleman8.ctr at mail.mil) while at the University of
-Arkansas. Contact him directly if you have questions.
-
-Examples: examples/USER/diffraction
-
-Contents:
-
To install via make or Make.py:
-make yes-body
+make yes-user-atc
make machine :pre
-Make.py -p body -a machine :pre
+Make.py -p atc -a machine :pre
To un-install via make or Make.py:
-make no-body
+make no-user-atc
make machine :pre
-Make.py -p ^body -a machine :pre
+Make.py -p ^atc -a machine :pre
+
+Supporting info: "compute saed"_compute_saed.html, "compute
+xrd"_compute_xrd.html, "fix saed.vtk"_fix_saed_vtk.html,
+examples/USER/diffraction
+
+Author: Shawn P. Coleman (shawn.p.coleman8.ctr at mail.mil) while at
+the University of Arkansas. Contact him directly if you have
+questions.
-Supporting info:
-
:line
USER-DPD package :link(USER-DPD),h5
-This package implements the dissipative particle dynamics (DPD) method
-under isothermal, isoenergetic, isobaric and isenthalpic conditions.
-The DPD equations of motion are integrated efficiently through the
-Shardlow splitting algorithm.
-
-See these doc pages and their related commands to get started:
-
-"compute dpd"_compute_dpd.html
-"compute dpd/atom"_compute_dpd_atom.html
-"fix_eos/cv"_fix_eos_table.html
-"fix_eos/table"_fix_eos_table.html
-"fix_shardlow"_fix_shardlow.html
-"pair_dpd/conservative"_pair_dpd_conservative.html
-"pair_dpd/fdt"_pair_dpd_fdt.html
-"pair_dpd/fdt/energy"_pair_dpd_fdt.html :ul
-
-There are example scripts for using this package in examples/USER/dpd.
-
-The people who created this package are James Larentzos
-(james.p.larentzos.civ at mail.mil), Timothy Mattox (Timothy.Mattox at
-engilitycorp.com) and John Brennan (john.k.brennan.civ at mail.mil).
-Contact them directly if you have questions.
+Contents: DPD stands for dissipative particle dynamics, This package
+implements DPD for isothermal, isoenergetic, isobaric and isenthalpic
+conditions. The DPD equations of motion are integrated efficiently
+through the Shardlow splitting algorithm. See src/USER-DPD/README for
+more details.
To install via make or Make.py:
-make yes-body
+make yes-user-atc
make machine :pre
-Make.py -p body -a machine :pre
+Make.py -p atc -a machine :pre
To un-install via make or Make.py:
-make no-body
+make no-user-atc
make machine :pre
-Make.py -p ^body -a machine :pre
+Make.py -p ^atc -a machine :pre
-Examples: examples/USER/dpd
+Supporting info: /src/USER-DPD/README, "compute dpd"_compute_dpd.html
+"compute dpd/atom"_compute_dpd_atom.html
+"fix_eos/cv"_fix_eos_table.html "fix_eos/table"_fix_eos_table.html
+"fix_shardlow"_fix_shardlow.html
+"pair_dpd/conservative"_pair_dpd_conservative.html
+"pair_dpd/fdt"_pair_dpd_fdt.html
+"pair_dpd/fdt/energy"_pair_dpd_fdt.html, examples/USER/dpd
+
+Authors: James Larentzos (ARL) (james.p.larentzos.civ at mail.mil),
+Timothy Mattox (Engility Corp) (Timothy.Mattox at engilitycorp.com)
+and John Brennan (ARL) (john.k.brennan.civ at mail.mil). Contact them
+directly if you have questions.
:line
USER-DRUDE package :link(USER-DRUDE),h5
-Contents:
-
-To install via make or Make.py:
-
-To un-install via make or Make.py:
-
-Supporting info:
-
-This package implements methods for simulating polarizable systems
-in LAMMPS using thermalized Drude oscillators.
-
-See these doc pages and their related commands to get started:
-
-"Drude tutorial"_tutorial_drude.html
-"fix drude"_fix_drude.html
-"compute temp/drude"_compute_temp_drude.html
-"fix langevin/drude"_fix_langevin_drude.html
-"fix drude/transform/..."_fix_drude_transform.html
-"pair thole"_pair_thole.html :ul
-
-There are auxiliary tools for using this package in tools/drude.
-
-The person who created this package is Alain Dequidt at Universite
-Blaise Pascal Clermont-Ferrand (alain.dequidt at univ-bpclermont.fr)
-Contact him directly if you have questions. Co-authors: Julien Devemy,
-Agilio Padua.
+Contents: This package contains methods for simulating polarizable
+systems using thermalized Drude oscillators. It has computes, fixes,
+and pair styles for this purpose. See "Section howto
+6.27"_Section_howto.html#howto_27 for an overview of how to use the
+package. See src/USER-DRUDE/README for additional details. There are
+auxiliary tools for using this package in tools/drude.
To install via make or Make.py:
-make yes-body
+make yes-user-atc
make machine :pre
-Make.py -p body -a machine :pre
+Make.py -p atc -a machine :pre
To un-install via make or Make.py:
-make no-body
+make no-user-atc
make machine :pre
-Make.py -p ^body -a machine :pre
+Make.py -p ^atc -a machine :pre
-Examples: examples/USER/drude
+Supporting info: "Section howto 6.27"_Section_howto.html#howto_27,
+src/USER-DRUDE/README, "fix drude"_fix_drude.html, "fix
+drude/transform/*"_fix_drude_transform.html, "compute
+temp/drude"_compute_temp_drude.html, "pair thole"_pair_thole.html,
+"pair lj/cut/thole/long"_pair_thole.html, examples/USER/drude,
+tools/drude
-Doc: Section howto 6.27
+Authors: Alain Dequidt at Universite Blaise Pascal Clermont-Ferrand
+(alain.dequidt at univ-bpclermont.fr); co-authors: Julien Devemy,
+Agilio Padua. Contact them directly if you have questions.
:line
USER-EFF package :link(USER-EFF),h5
-Contents:
-
+Contents: EFF stands for electron force field. This package contains
+atom, pair, fix and compute styles which implement the eFF as
+described in A. Jaramillo-Botero, J. Su, Q. An, and W.A. Goddard III,
+JCC, 2010. The eFF potential was first introduced by Su and Goddard,
+in 2007. See src/USER-EFF/README for more details. There are
+auxiliary tools for using this package in tools/eff; see its README
+file.
+
To install via make or Make.py:
-
+
+make yes-user-atc
+make machine :pre
+
+Make.py -p atc -a machine :pre
+
To un-install via make or Make.py:
-
+
+make no-user-atc
+make machine :pre
+
+Make.py -p ^atc -a machine :pre
+
+Supporting info: "atom_style electron"_atom_style.html, "compute
+temp/eff"_compute_temp_eff.html, "fix
+langevin/eff"_fix_langevin_eff.html, "fix nve/eff"_fix_nve_eff.html,
+"pair eff/cut"_pair_eff.html, examples/USER/eff, tools/eff
+
Supporting info:
-
-This package contains a LAMMPS implementation of the electron Force
-Field (eFF) currently under development at Caltech, as described in
-A. Jaramillo-Botero, J. Su, Q. An, and W.A. Goddard III, JCC,
-2010. The eFF potential was first introduced by Su and Goddard, in
-2007.
-eFF can be viewed as an approximation to QM wave packet dynamics and
-Fermionic molecular dynamics, combining the ability of electronic
-structure methods to describe atomic structure, bonding, and chemistry
-in materials, and of plasma methods to describe nonequilibrium
-dynamics of large systems with a large number of highly excited
-electrons. We classify it as a mixed QM-classical approach rather than
-a conventional force field method, which introduces QM-based terms (a
-spin-dependent repulsion term to account for the Pauli exclusion
-principle and the electron wavefunction kinetic energy associated with
-the Heisenberg principle) that reduce, along with classical
-electrostatic terms between nuclei and electrons, to the sum of a set
-of effective pairwise potentials. This makes eFF uniquely suited to
-simulate materials over a wide range of temperatures and pressures
-where electronically excited and ionized states of matter can occur
-and coexist.
-
-The necessary customizations to the LAMMPS core are in place to
-enable the correct handling of explicit electron properties during
-minimization and dynamics.
-
-See the doc page for the pair_style eff/cut command to get started.
-
-There are example scripts for using this package in
-examples/USER/eff.
-
-There are auxiliary tools for using this package in tools/eff.
-
-The person who created this package is Andres Jaramillo-Botero at
-CalTech (ajaramil at wag.caltech.edu). Contact him directly if you
-have questions.
-
-To install via make or Make.py:
-
-make yes-body
-make machine :pre
-
-Make.py -p body -a machine :pre
-
-To un-install via make or Make.py:
-
-make no-body
-make machine :pre
-
-Make.py -p ^body -a machine :pre
-
-Examples: examples/USER/eff
+Author: Andres Jaramillo-Botero at CalTech (ajaramil at
+wag.caltech.edu). Contact him directly if you have questions.
:line
USER-FEP package :link(USER-FEP),h5
-Contents:
-
-To install via make or Make.py:
-
-To un-install via make or Make.py:
-
-Supporting info:
-
-This package provides methods for performing free energy perturbation
-simulations with soft-core pair potentials in LAMMPS.
-
-See these doc pages and their related commands to get started:
-
-"fix adapt/fep"_fix_adapt_fep.html
-"compute fep"_compute_fep.html
-"soft pair styles"_pair_lj_soft.html :ul
-
-The person who created this package is Agilio Padua at Universite
-Blaise Pascal Clermont-Ferrand (agilio.padua at univ-bpclermont.fr)
-Contact him directly if you have questions.
+Contents: FEP stands for free energy perturbation. This package
+provides methods for performing FEP simulations by using a "fix
+adapt/fep"_fix_adapt_fep.html command with soft-core pair potentials,
+which have a "soft" in their style name. See src/USER-FEP/README for
+more details. There are auxiliary tools for using this package in
+tools/fep; see its README file.
To install via make or Make.py:
-make yes-body
+make yes-user-atc
make machine :pre
-Make.py -p body -a machine :pre
+Make.py -p atc -a machine :pre
To un-install via make or Make.py:
-make no-body
+make no-user-atc
make machine :pre
-Make.py -p ^body -a machine :pre
+Make.py -p ^atc -a machine :pre
-Examples: examples/USER/fep
+Supporting info: src/USER-FEP/README, "fix
+adapt/fep"_fix_adapt_fep.html, "compute fep"_compute_fep.html,
+"pair_style */soft"_pair_lj_soft.html, examples/USER/fep
+
+Author: Agilio Padua at Universite Blaise Pascal Clermont-Ferrand
+(agilio.padua at univ-bpclermont.fr). Contact him directly if you have
+questions.
:line
USER-H5MD package :link(USER-H5MD),h5
-Contents:
-
-To install via make or Make.py:
-
-To un-install via make or Make.py:
-
-Supporting info:
-
-This package contains a "dump h5md"_dump_h5md.html command for
-performing a dump of atom properties in HDF5 format. "HDF5
-files"_HDF5 are binary, portable and self-describing and can be
-examined and used by a variety of auxiliary tools. The output HDF5
-files are structured in a format called H5MD, which was designed to
-store molecular data, and can be used and produced by various MD and
-MD-related codes. The "dump h5md"_doc/dump_h5md.html command gives a
-citation to a paper describing the format.
+Contents: H5MD stands for HDF5 for MD. "HDF5"_HDF5 is a binary,
+portable, self-describing file format, used by many scientific
+simulations. H5MD is a format for molecular simulations, built on top
+of HDF5. This package implements a "dump h5md"_dump_h5md.html command
+to output LAMMPS snapshots in this format. See src/USER-H5MD/README
+for more details.
:link(HDF5,http://www.hdfgroup.org/HDF5/)
-The person who created this package and the underlying H5MD format is
-Pierre de Buyl at KU Leuven (see http://pdebuyl.be). Contact him
+To build LAMMPS with this package ...
+
+To install via make or Make.py:
+
+make yes-user-atc
+make machine :pre
+
+Make.py -p atc -a machine :pre
+
+To un-install via make or Make.py:
+
+make no-user-atc
+make machine :pre
+
+Make.py -p ^atc -a machine :pre
+
+Supporting info: src/USER-H5MD/README, lib/h5md/README, "dump
+h5md"_dump_h5md.html
+
+Author: Pierre de Buyl at KU Leuven (see http://pdebuyl.be) created
+this package as well as the H5MD format and library. Contact him
directly if you have questions.
:line
USER-INTEL package :link(USER-INTEL),h5
-Contents:
-
+Contents: Dozens of pair, bond, angle, dihedral, and improper styles
+that are optimized for Intel CPUs and the Intel Xeon Phi (in offload
+mode). All of them have an "intel" in their style name. "Section
+accelerate intel"_accelerate_intel.html gives details of what hardware
+and compilers are required on your system, and how to build and use
+this package. Also see src/USER-INTEL/README for more details. See
+the KOKKOS, OPT, and USER-OMP packages, which also have CPU and
+Phi-enabled styles.
+
To install via make or Make.py:
-
+
+make yes-user-atc
+make machine :pre
+
+Make.py -p atc -a machine :pre
+
To un-install via make or Make.py:
-
-Supporting info:
-
-This package provides options for performing neighbor list and
-non-bonded force calculations in single, mixed, or double precision
-and also a capability for accelerating calculations with an
-Intel(R) Xeon Phi(TM) coprocessor.
-
-See this section of the manual to get started:
+
+make no-user-atc
+make machine :pre
+
+Make.py -p ^atc -a machine :pre
+
+Supporting info: examples/accelerate, src/USER-INTEL/TEST
"Section_accelerate"_Section_accelerate.html#acc_9
-The person who created this package is W. Michael Brown at Intel
-(michael.w.brown at intel.com). Contact him directly if you have questions.
+Author: Mike Brown at Intel (michael.w.brown at intel.com). Contact
+him directly if you have questions.
For the USER-INTEL package, you have 2 choices when building. You can
build with CPU or Phi support. The latter uses Xeon Phi chips in
@@ -1466,17 +1686,32 @@ And also add this to CCFLAGS:
-offload-option,mic,compiler,"-fp-model fast=2 -mGLOB_default_function_attrs=\"gather_scatter_loop_unroll=4\"" :pre
-Examples: examples/accelerate, bench/KEPLER
+Examples:
:line
USER-LB package :link(USER-LB),h5
-Contents:
-
+Contents: A "fix atc"_fix_atc.html command (atoms to continuum) to
+either couple of MD with FE-based physics surrogates or on-the-fly
+post-processing of atomic information to continuum fields. See
+src/USER-ATC/README for more details.
+
To install via make or Make.py:
-
+
+make yes-user-atc
+make machine :pre
+
+Make.py -p atc -a machine :pre
+
To un-install via make or Make.py:
+
+make no-user-atc
+make machine :pre
+
+Make.py -p ^atc -a machine :pre
+
+Supporting info: "fix atc"_fix_atc.html, examples/USER/atc
Supporting info:
@@ -1492,32 +1727,33 @@ The people who created this package are Frances Mackay (fmackay at
uwo.ca) and Colin (cdennist at uwo.ca) Denniston, University of
Western Ontario. Contact them directly if you have questions.
-To install via make or Make.py:
-
-make yes-body
-make machine :pre
-
-Make.py -p body -a machine :pre
-
-To un-install via make or Make.py:
-
-make no-body
-make machine :pre
-
-Make.py -p ^body -a machine :pre
-
Examples: examples/USER/lb
:line
USER-MGPT package :link(USER-MGPT),h5
-Contents:
-
+Contents: A "fix atc"_fix_atc.html command (atoms to continuum) to
+either couple of MD with FE-based physics surrogates or on-the-fly
+post-processing of atomic information to continuum fields. See
+src/USER-ATC/README for more details.
+
To install via make or Make.py:
-
+
+make yes-user-atc
+make machine :pre
+
+Make.py -p atc -a machine :pre
+
To un-install via make or Make.py:
-
+
+make no-user-atc
+make machine :pre
+
+Make.py -p ^atc -a machine :pre
+
+Supporting info: "fix atc"_fix_atc.html, examples/USER/atc
+
Supporting info:
This package contains a fast implementation for LAMMPS of
@@ -1544,32 +1780,33 @@ The persons who created the USER-MGPT package are Tomas Oppelstrup
(oppelstrup2@llnl.gov) and John Moriarty (moriarty2@llnl.gov)
Contact them directly if you have any questions.
-To install via make or Make.py:
-
-make yes-body
-make machine :pre
-
-Make.py -p body -a machine :pre
-
-To un-install via make or Make.py:
-
-make no-body
-make machine :pre
-
-Make.py -p ^body -a machine :pre
-
Examples: examples/USER/mgpt
:line
USER-MISC package :link(USER-MISC),h5
-Contents:
-
+Contents: A "fix atc"_fix_atc.html command (atoms to continuum) to
+either couple of MD with FE-based physics surrogates or on-the-fly
+post-processing of atomic information to continuum fields. See
+src/USER-ATC/README for more details.
+
To install via make or Make.py:
-
+
+make yes-user-atc
+make machine :pre
+
+Make.py -p atc -a machine :pre
+
To un-install via make or Make.py:
-
+
+make no-user-atc
+make machine :pre
+
+Make.py -p ^atc -a machine :pre
+
+Supporting info: "fix atc"_fix_atc.html, examples/USER/atc
+
Supporting info:
The files in this package are a potpourri of (mostly) unrelated
@@ -1591,32 +1828,33 @@ src/USER-MISC/README file.
You should contact the author directly if you have specific questions
about the feature or its coding.
-To install via make or Make.py:
-
-make yes-body
-make machine :pre
-
-Make.py -p body -a machine :pre
-
-To un-install via make or Make.py:
-
-make no-body
-make machine :pre
-
-Make.py -p ^body -a machine :pre
-
Examples: examples/USER/misc
:line
USER-MOLFILE package :link(USER-MOLFILE),h5
-Contents:
-
+Contents: A "fix atc"_fix_atc.html command (atoms to continuum) to
+either couple of MD with FE-based physics surrogates or on-the-fly
+post-processing of atomic information to continuum fields. See
+src/USER-ATC/README for more details.
+
To install via make or Make.py:
-
+
+make yes-user-atc
+make machine :pre
+
+Make.py -p atc -a machine :pre
+
To un-install via make or Make.py:
-
+
+make no-user-atc
+make machine :pre
+
+Make.py -p ^atc -a machine :pre
+
+Supporting info: "fix atc"_fix_atc.html, examples/USER/atc
+
Supporting info:
This package contains a dump molfile command which uses molfile
@@ -1643,12 +1881,27 @@ The person who created this package is Axel Kohlmeyer at Temple U
USER-OMP package :link(USER-OMP),h5
-Contents:
-
+Contents: A "fix atc"_fix_atc.html command (atoms to continuum) to
+either couple of MD with FE-based physics surrogates or on-the-fly
+post-processing of atomic information to continuum fields. See
+src/USER-ATC/README for more details.
+
To install via make or Make.py:
-
+
+make yes-user-atc
+make machine :pre
+
+Make.py -p atc -a machine :pre
+
To un-install via make or Make.py:
-
+
+make no-user-atc
+make machine :pre
+
+Make.py -p ^atc -a machine :pre
+
+Supporting info: "fix atc"_fix_atc.html, examples/USER/atc
+
Supporting info:
This package provides OpenMP multi-threading support and
@@ -1674,6 +1927,27 @@ Examples: examples/accelerate, bench/KEPLER
USER-PHONON package :link(USER-PHONON),h5
+Contents: A "fix atc"_fix_atc.html command (atoms to continuum) to
+either couple of MD with FE-based physics surrogates or on-the-fly
+post-processing of atomic information to continuum fields. See
+src/USER-ATC/README for more details.
+
+To install via make or Make.py:
+
+make yes-user-atc
+make machine :pre
+
+Make.py -p atc -a machine :pre
+
+To un-install via make or Make.py:
+
+make no-user-atc
+make machine :pre
+
+Make.py -p ^atc -a machine :pre
+
+Supporting info: "fix atc"_fix_atc.html, examples/USER/atc
+
This package contains a fix phonon command that calculates dynamical
matrices, which can then be used to compute phonon dispersion
relations, directly from molecular dynamics simulations.
@@ -1686,32 +1960,33 @@ The person who created this package is Ling-Ti Kong (konglt at
sjtu.edu.cn) at Shanghai Jiao Tong University. Contact him directly
if you have questions.
-To install via make or Make.py:
-
-make yes-body
-make machine :pre
-
-Make.py -p body -a machine :pre
-
-To un-install via make or Make.py:
-
-make no-body
-make machine :pre
-
-Make.py -p ^body -a machine :pre
-
Examples: examples/USER/phonon
:line
USER-QMMM package :link(USER-QMMM),h5
-Contents:
-
+Contents: A "fix atc"_fix_atc.html command (atoms to continuum) to
+either couple of MD with FE-based physics surrogates or on-the-fly
+post-processing of atomic information to continuum fields. See
+src/USER-ATC/README for more details.
+
To install via make or Make.py:
-
+
+make yes-user-atc
+make machine :pre
+
+Make.py -p atc -a machine :pre
+
To un-install via make or Make.py:
-
+
+make no-user-atc
+make machine :pre
+
+Make.py -p ^atc -a machine :pre
+
+Supporting info: "fix atc"_fix_atc.html, examples/USER/atc
+
Supporting info:
This package provides a fix qmmm command which allows LAMMPS to be
@@ -1738,12 +2013,27 @@ The person who created this package is Axel Kohlmeyer at Temple U
:line
USER-QTB package :link(USER-QTB),h5
-
-Contents:
-
+
+Contents: A "fix atc"_fix_atc.html command (atoms to continuum) to
+either couple of MD with FE-based physics surrogates or on-the-fly
+post-processing of atomic information to continuum fields. See
+src/USER-ATC/README for more details.
+
To install via make or Make.py:
-
+
+make yes-user-atc
+make machine :pre
+
+Make.py -p atc -a machine :pre
+
To un-install via make or Make.py:
+
+make no-user-atc
+make machine :pre
+
+Make.py -p ^atc -a machine :pre
+
+Supporting info: "fix atc"_fix_atc.html, examples/USER/atc
Supporting info:
@@ -1770,32 +2060,33 @@ The person who created this package is Yuan Shen (sy0302 at
stanford.edu) at Stanford University. Contact him directly if you
have questions.
-To install via make or Make.py:
-
-make yes-body
-make machine :pre
-
-Make.py -p body -a machine :pre
-
-To un-install via make or Make.py:
-
-make no-body
-make machine :pre
-
-Make.py -p ^body -a machine :pre
-
Examples: examples/USER/qtb
:line
USER-QUIP package :link(USER-QUIP),h5
-Contents:
-
+Contents: A "fix atc"_fix_atc.html command (atoms to continuum) to
+either couple of MD with FE-based physics surrogates or on-the-fly
+post-processing of atomic information to continuum fields. See
+src/USER-ATC/README for more details.
+
To install via make or Make.py:
-
+
+make yes-user-atc
+make machine :pre
+
+Make.py -p atc -a machine :pre
+
To un-install via make or Make.py:
-
+
+make no-user-atc
+make machine :pre
+
+Make.py -p ^atc -a machine :pre
+
+Supporting info: "fix atc"_fix_atc.html, examples/USER/atc
+
Supporting info:
Examples: examples/USER/quip
@@ -1804,21 +2095,26 @@ Examples: examples/USER/quip
USER-REAXC package :link(USER-REAXC),h5
-Contents:
-
+Contents: A "fix atc"_fix_atc.html command (atoms to continuum) to
+either couple of MD with FE-based physics surrogates or on-the-fly
+post-processing of atomic information to continuum fields. See
+src/USER-ATC/README for more details.
+
To install via make or Make.py:
-make yes-body
+make yes-user-atc
make machine :pre
-Make.py -p body -a machine :pre
+Make.py -p atc -a machine :pre
To un-install via make or Make.py:
-make no-body
+make no-user-atc
make machine :pre
-Make.py -p ^body -a machine :pre
+Make.py -p ^atc -a machine :pre
+
+Supporting info: "fix atc"_fix_atc.html, examples/USER/atc
Supporting info:
@@ -1859,12 +2155,27 @@ Examples: examples/reax
USER-SMD package :link(USER-SMD),h5
-Contents:
-
+Contents: A "fix atc"_fix_atc.html command (atoms to continuum) to
+either couple of MD with FE-based physics surrogates or on-the-fly
+post-processing of atomic information to continuum fields. See
+src/USER-ATC/README for more details.
+
To install via make or Make.py:
-
+
+make yes-user-atc
+make machine :pre
+
+Make.py -p atc -a machine :pre
+
To un-install via make or Make.py:
-
+
+make no-user-atc
+make machine :pre
+
+Make.py -p ^atc -a machine :pre
+
+Supporting info: "fix atc"_fix_atc.html, examples/USER/atc
+
Supporting info:
This package implements smoothed Mach dynamics (SMD) in
@@ -1900,21 +2211,26 @@ Examples: examples/USER/smd
USER-SMTBQ package :link(USER-SMTBQ),h5
-Contents:
-
+Contents: A "fix atc"_fix_atc.html command (atoms to continuum) to
+either couple of MD with FE-based physics surrogates or on-the-fly
+post-processing of atomic information to continuum fields. See
+src/USER-ATC/README for more details.
+
To install via make or Make.py:
-make yes-body
+make yes-user-atc
make machine :pre
-Make.py -p body -a machine :pre
+Make.py -p atc -a machine :pre
To un-install via make or Make.py:
-make no-body
+make no-user-atc
make machine :pre
-Make.py -p ^body -a machine :pre
+Make.py -p ^atc -a machine :pre
+
+Supporting info: "fix atc"_fix_atc.html, examples/USER/atc
Supporting info:
@@ -1939,21 +2255,26 @@ Examples: examples/USER/smtbq
USER-SPH package :link(USER-SPH),h5
-Contents:
-
+Contents: A "fix atc"_fix_atc.html command (atoms to continuum) to
+either couple of MD with FE-based physics surrogates or on-the-fly
+post-processing of atomic information to continuum fields. See
+src/USER-ATC/README for more details.
+
To install via make or Make.py:
-make yes-body
+make yes-user-atc
make machine :pre
-Make.py -p body -a machine :pre
+Make.py -p atc -a machine :pre
To un-install via make or Make.py:
-make no-body
+make no-user-atc
make machine :pre
-Make.py -p ^body -a machine :pre
+Make.py -p ^atc -a machine :pre
+
+Supporting info: "fix atc"_fix_atc.html, examples/USER/atc
Supporting info:
@@ -1988,21 +2309,26 @@ Examples: examples/USER/sph
USER-TALLY package :link(USER-TALLY),h5
-Contents:
+Contents: A "fix atc"_fix_atc.html command (atoms to continuum) to
+either couple of MD with FE-based physics surrogates or on-the-fly
+post-processing of atomic information to continuum fields. See
+src/USER-ATC/README for more details.
To install via make or Make.py:
-make yes-body
+make yes-user-atc
make machine :pre
-Make.py -p body -a machine :pre
+Make.py -p atc -a machine :pre
To un-install via make or Make.py:
-make no-body
+make no-user-atc
make machine :pre
-Make.py -p ^body -a machine :pre
+Make.py -p ^atc -a machine :pre
+
+Supporting info: "fix atc"_fix_atc.html, examples/USER/atc
Supporting info:
@@ -2012,12 +2338,25 @@ Examples: examples/USER/tally
USER-VTK package :link(USER-VTK),h5
-Contents:
+Contents: A "fix atc"_fix_atc.html command (atoms to continuum) to
+either couple of MD with FE-based physics surrogates or on-the-fly
+post-processing of atomic information to continuum fields. See
+src/USER-ATC/README for more details.
To install via make or Make.py:
+make yes-user-atc
+make machine :pre
+
+Make.py -p atc -a machine :pre
+
To un-install via make or Make.py:
-Supporting info:
+make no-user-atc
+make machine :pre
+
+Make.py -p ^atc -a machine :pre
+
+Supporting info: "fix atc"_fix_atc.html, examples/USER/atc
Examples: examples/USER/tally
diff --git a/doc/Section_perf.html b/doc/Section_perf.html
index 166caa7357..f21f85c93d 100644
--- a/doc/Section_perf.html
+++ b/doc/Section_perf.html
@@ -137,12 +137,17 @@
8. Performance & scalability¶
-LAMMPS performance on several prototypical benchmarks and machines is
-discussed on the Benchmarks page of the LAMMPS WWW Site where
-CPU timings and parallel efficiencies are listed. Here, the
-benchmarks are described briefly and some useful rules of thumb about
-their performance are highlighted.
-These are the 5 benchmark problems:
+Current LAMMPS performance is discussed on the Benchmarks page of the
+LAMMPS WWW Site where CPU timings and parallel efficiencies are
+listed. The page has several sections, which are briefly described
+below:
+
+- CPU performance on 5 standard problems, strong and weak scaling
+- GPU and Xeon Phi performance on same and related problems
+- Comparison of cost of interatomic potentials
+- Performance of huge, billion-atom problems
+
+The 5 standard problems are as follow:
- LJ = atomic fluid, Lennard-Jones potential with 2.5 sigma cutoff (55
@@ -161,73 +166,46 @@ field with a 10 Angstrom LJ cutoff (440 neighbors per atom),
particle-particle particle-mesh (PPPM) for long-range Coulombics, NPT
integration
-The input files for running the benchmarks are included in the LAMMPS
-distribution, as are sample output files. Each of the 5 problems has
-32,000 atoms and runs for 100 timesteps. Each can be run as a serial
-benchmarks (on one processor) or in parallel. In parallel, each
-benchmark can be run as a fixed-size or scaled-size problem. For
-fixed-size benchmarking, the same 32K atom problem is run on various
-numbers of processors. For scaled-size benchmarking, the model size
-is increased with the number of processors. E.g. on 8 processors, a
-256K-atom problem is run; on 1024 processors, a 32-million atom
-problem is run, etc.
-A useful metric from the benchmarks is the CPU cost per atom per
-timestep. Since LAMMPS performance scales roughly linearly with
-problem size and timesteps, the run time of any problem using the same
-model (atom style, force field, cutoff, etc) can then be estimated.
-For example, on a 1.7 GHz Pentium desktop machine (Intel icc compiler
-under Red Hat Linux), the CPU run-time in seconds/atom/timestep for
-the 5 problems is
-
-
-
-
-
-
-
-
-
-
-Problem:
-LJ
-Chain
-EAM
-Chute
-Rhodopsin
-
-CPU/atom/step:
-4.55E-6
-2.18E-6
-9.38E-6
-2.18E-6
-1.11E-4
-
-Ratio to LJ:
-1.0
-0.48
-2.06
-0.48
-24.5
-
-
-
-The ratios mean that if the atomic LJ system has a normalized cost of
-1.0, the bead-spring chains and granular systems run 2x faster, while
-the EAM metal and solvated protein models run 2x and 25x slower
-respectively. The bulk of these cost differences is due to the
-expense of computing a particular pairwise force field for a given
-number of neighbors per atom.
-Performance on a parallel machine can also be predicted from the
-one-processor timings if the parallel efficiency can be estimated.
-The communication bandwidth and latency of a particular parallel
-machine affects the efficiency. On most machines LAMMPS will give
-fixed-size parallel efficiencies on these benchmarks above 50% so long
-as the atoms/processor count is a few 100 or greater - i.e. on 64 to
-128 processors. Likewise, scaled-size parallel efficiencies will
-typically be 80% or greater up to very large processor counts. The
-benchmark data on the LAMMPS WWW Site gives specific examples on
-some different machines, including a run of 3/4 of a billion LJ atoms
-on 1500 processors that ran at 85% parallel efficiency.
+Input files for these 5 problems are provided in the bench directory
+of the LAMMPS distribution. Each has 32,000 atoms and runs for 100
+timesteps. The size of the problem (number of atoms) can be varied
+using command-line switches as described in the bench/README file.
+This is an easy way to test performance and either strong or weak
+scalability on your machine.
+The bench directory includes a few log.* files that show performance
+of these 5 problems on 1 or 4 cores of Linux desktop. The bench/FERMI
+and bench/KEPLER dirs have input files and scripts and instructions
+for running the same (or similar) problems using OpenMP or GPU or Xeon
+Phi acceleration options. See the README files in those dirs and the
+Section accelerate doc pages for
+instructions on how to build LAMMPS and run on that kind of hardware.
+The bench/POTENTIALS directory has input files which correspond to the
+table of results on the
+Potentials section of
+the Benchmarks web page. So you can also run those test problems on
+your machine.
+The billion-atom section
+of the Benchmarks web page has performance data for very large
+benchmark runs of simple Lennard-Jones (LJ) models, which use the
+bench/in.lj input script.
+
+For all the benchmarks, a useful metric is the CPU cost per atom per
+timestep. Since performance scales roughly linearly with problem size
+and timesteps for all LAMMPS models (i.e. inteatomic or coarse-grained
+potentials), the run time of any problem using the same model (atom
+style, force field, cutoff, etc) can then be estimated.
+Performance on a parallel machine can also be predicted from one-core
+or one-node timings if the parallel efficiency can be estimated. The
+communication bandwidth and latency of a particular parallel machine
+affects the efficiency. On most machines LAMMPS will give parallel
+efficiencies on these benchmarks above 50% so long as the number of
+atoms/core is a few 100 or greater, and closer to 100% for large
+numbers of atoms/core. This is for all-MPI mode with one MPI task per
+core. For nodes with accelerator options or hardware (OpenMP, GPU,
+Phi), you should first measure single node performance. Then you can
+estimate parallel performance for multi-node runs using the same logic
+as for all-MPI mode, except that now you will typically need many more
+atoms/node to achieve good scalability.
diff --git a/doc/Section_perf.txt b/doc/Section_perf.txt
index 896d522cac..d1cafa0bda 100644
--- a/doc/Section_perf.txt
+++ b/doc/Section_perf.txt
@@ -8,13 +8,17 @@
8. Performance & scalability :h3
-LAMMPS performance on several prototypical benchmarks and machines is
-discussed on the Benchmarks page of the "LAMMPS WWW Site"_lws where
-CPU timings and parallel efficiencies are listed. Here, the
-benchmarks are described briefly and some useful rules of thumb about
-their performance are highlighted.
+Current LAMMPS performance is discussed on the Benchmarks page of the
+"LAMMPS WWW Site"_lws where CPU timings and parallel efficiencies are
+listed. The page has several sections, which are briefly described
+below:
-These are the 5 benchmark problems:
+CPU performance on 5 standard problems, strong and weak scaling
+GPU and Xeon Phi performance on same and related problems
+Comparison of cost of interatomic potentials
+Performance of huge, billion-atom problems :ul
+
+The 5 standard problems are as follow:
LJ = atomic fluid, Lennard-Jones potential with 2.5 sigma cutoff (55
neighbors per atom), NVE integration :olb,l
@@ -34,44 +38,49 @@ field with a 10 Angstrom LJ cutoff (440 neighbors per atom),
particle-particle particle-mesh (PPPM) for long-range Coulombics, NPT
integration :ole,l
-The input files for running the benchmarks are included in the LAMMPS
-distribution, as are sample output files. Each of the 5 problems has
-32,000 atoms and runs for 100 timesteps. Each can be run as a serial
-benchmarks (on one processor) or in parallel. In parallel, each
-benchmark can be run as a fixed-size or scaled-size problem. For
-fixed-size benchmarking, the same 32K atom problem is run on various
-numbers of processors. For scaled-size benchmarking, the model size
-is increased with the number of processors. E.g. on 8 processors, a
-256K-atom problem is run; on 1024 processors, a 32-million atom
-problem is run, etc.
+Input files for these 5 problems are provided in the bench directory
+of the LAMMPS distribution. Each has 32,000 atoms and runs for 100
+timesteps. The size of the problem (number of atoms) can be varied
+using command-line switches as described in the bench/README file.
+This is an easy way to test performance and either strong or weak
+scalability on your machine.
-A useful metric from the benchmarks is the CPU cost per atom per
-timestep. Since LAMMPS performance scales roughly linearly with
-problem size and timesteps, the run time of any problem using the same
-model (atom style, force field, cutoff, etc) can then be estimated.
-For example, on a 1.7 GHz Pentium desktop machine (Intel icc compiler
-under Red Hat Linux), the CPU run-time in seconds/atom/timestep for
-the 5 problems is
+The bench directory includes a few log.* files that show performance
+of these 5 problems on 1 or 4 cores of Linux desktop. The bench/FERMI
+and bench/KEPLER dirs have input files and scripts and instructions
+for running the same (or similar) problems using OpenMP or GPU or Xeon
+Phi acceleration options. See the README files in those dirs and the
+"Section accelerate"_Section_accelerate.html doc pages for
+instructions on how to build LAMMPS and run on that kind of hardware.
-Problem:, LJ, Chain, EAM, Chute, Rhodopsin
-CPU/atom/step:, 4.55E-6, 2.18E-6, 9.38E-6, 2.18E-6, 1.11E-4
-Ratio to LJ:, 1.0, 0.48, 2.06, 0.48, 24.5 :tb(ea=c,ca1=r)
+The bench/POTENTIALS directory has input files which correspond to the
+table of results on the
+"Potentials"_http://lammps.sandia.gov/bench.html#potentials section of
+the Benchmarks web page. So you can also run those test problems on
+your machine.
-The ratios mean that if the atomic LJ system has a normalized cost of
-1.0, the bead-spring chains and granular systems run 2x faster, while
-the EAM metal and solvated protein models run 2x and 25x slower
-respectively. The bulk of these cost differences is due to the
-expense of computing a particular pairwise force field for a given
-number of neighbors per atom.
+The "billion-atom"_http://lammps.sandia.gov/bench.html#billion section
+of the Benchmarks web page has performance data for very large
+benchmark runs of simple Lennard-Jones (LJ) models, which use the
+bench/in.lj input script.
-Performance on a parallel machine can also be predicted from the
-one-processor timings if the parallel efficiency can be estimated.
-The communication bandwidth and latency of a particular parallel
-machine affects the efficiency. On most machines LAMMPS will give
-fixed-size parallel efficiencies on these benchmarks above 50% so long
-as the atoms/processor count is a few 100 or greater - i.e. on 64 to
-128 processors. Likewise, scaled-size parallel efficiencies will
-typically be 80% or greater up to very large processor counts. The
-benchmark data on the "LAMMPS WWW Site"_lws gives specific examples on
-some different machines, including a run of 3/4 of a billion LJ atoms
-on 1500 processors that ran at 85% parallel efficiency.
+:line
+
+For all the benchmarks, a useful metric is the CPU cost per atom per
+timestep. Since performance scales roughly linearly with problem size
+and timesteps for all LAMMPS models (i.e. inteatomic or coarse-grained
+potentials), the run time of any problem using the same model (atom
+style, force field, cutoff, etc) can then be estimated.
+
+Performance on a parallel machine can also be predicted from one-core
+or one-node timings if the parallel efficiency can be estimated. The
+communication bandwidth and latency of a particular parallel machine
+affects the efficiency. On most machines LAMMPS will give parallel
+efficiencies on these benchmarks above 50% so long as the number of
+atoms/core is a few 100 or greater, and closer to 100% for large
+numbers of atoms/core. This is for all-MPI mode with one MPI task per
+core. For nodes with accelerator options or hardware (OpenMP, GPU,
+Phi), you should first measure single node performance. Then you can
+estimate parallel performance for multi-node runs using the same logic
+as for all-MPI mode, except that now you will typically need many more
+atoms/node to achieve good scalability.
diff --git a/doc/_sources/Section_example.txt b/doc/_sources/Section_example.txt
index d5f6744d5c..2e44b4fc95 100644
--- a/doc/_sources/Section_example.txt
+++ b/doc/_sources/Section_example.txt
@@ -1,21 +1,20 @@
Example problems
================
-The LAMMPS distribution includes an examples sub-directory with
-several sample problems. Each problem is in a sub-directory of its
-own. Most are 2d models so that they run quickly, requiring at most a
-couple of minutes to run on a desktop machine. Each problem has an
-input script (in.*) and produces a log file (log.*) and dump file
-(dump.*) when it runs. Some use a data file (data.*) of initial
-coordinates as additional input. A few sample log file outputs on
-different machines and different numbers of processors are included in
-the directories to compare your answers to. E.g. a log file like
-log.crack.foo.P means it ran on P processors of machine "foo".
+The LAMMPS distribution includes an examples sub-directory with many
+sample problems. Many are 2d models that run quickly are are
+straightforward to visualize, requiring at most a couple of minutes to
+run on a desktop machine. Each problem has an input script (in.*) and
+produces a log file (log.*) when it runs. Some use a data file
+(data.*) of initial coordinates as additional input. A few sample log
+file run on different machines and different numbers of processors are
+included in the directories to compare your answers to. E.g. a log
+file like log.date.crack.foo.P means the "crack" example was run on P
+processors of machine "foo" on that date (i.e. with that version of
+LAMMPS).
-For examples that use input data files, many of them were produced by
-`Pizza.py `_ or setup tools described in the
-:doc:`Additional Tools ` section of the LAMMPS
-documentation and provided with the LAMMPS distribution.
+Many of the input files have commented-out lines for creating dump
+files and image files.
If you uncomment the :doc:`dump ` command in the input script, a
text dump file will be produced, which can be animated by various
@@ -28,94 +27,109 @@ snapshot images will be produced when the simulation runs. They can
be quickly post-processed into a movie using commands described on the
:doc:`dump image ` doc page.
-Animations of many of these examples can be viewed on the Movies
-section of the `LAMMPS WWW Site `_.
+Animations of many of the examples can be viewed on the Movies section
+of the `LAMMPS web site `_.
-These are the sample problems in the examples sub-directories:
+There are two kinds of sub-directories in the examples dir. Lowercase
+dirs contain one or a few simple, quick-to-run problems. Uppercase
+dirs contain up to several complex scripts that illustrate a
+particular kind of simulation method or model. Some of these run for
+longer times, e.g. to measure a particular quantity.
-+-------------+----------------------------------------------------------------------------+
-| balance | dynamic load balancing, 2d system |
-+-------------+----------------------------------------------------------------------------+
-| body | body particles, 2d system |
-+-------------+----------------------------------------------------------------------------+
-| colloid | big colloid particles in a small particle solvent, 2d system |
-+-------------+----------------------------------------------------------------------------+
-| comb | models using the COMB potential |
-+-------------+----------------------------------------------------------------------------+
-| crack | crack propagation in a 2d solid |
-+-------------+----------------------------------------------------------------------------+
-| cuda | use of the USER-CUDA package for GPU acceleration |
-+-------------+----------------------------------------------------------------------------+
-| dipole | point dipolar particles, 2d system |
-+-------------+----------------------------------------------------------------------------+
-| dreiding | methanol via Dreiding FF |
-+-------------+----------------------------------------------------------------------------+
-| eim | NaCl using the EIM potential |
-+-------------+----------------------------------------------------------------------------+
-| ellipse | ellipsoidal particles in spherical solvent, 2d system |
-+-------------+----------------------------------------------------------------------------+
-| flow | Couette and Poiseuille flow in a 2d channel |
-+-------------+----------------------------------------------------------------------------+
-| friction | frictional contact of spherical asperities between 2d surfaces |
-+-------------+----------------------------------------------------------------------------+
-| gpu | use of the GPU package for GPU acceleration |
-+-------------+----------------------------------------------------------------------------+
-| hugoniostat | Hugoniostat shock dynamics |
-+-------------+----------------------------------------------------------------------------+
-| indent | spherical indenter into a 2d solid |
-+-------------+----------------------------------------------------------------------------+
-| intel | use of the USER-INTEL package for CPU or Intel(R) Xeon Phi(TM) coprocessor |
-+-------------+----------------------------------------------------------------------------+
-| kim | use of potentials in Knowledge Base for Interatomic Models (KIM) |
-+-------------+----------------------------------------------------------------------------+
-| line | line segment particles in 2d rigid bodies |
-+-------------+----------------------------------------------------------------------------+
-| meam | MEAM test for SiC and shear (same as shear examples) |
-+-------------+----------------------------------------------------------------------------+
-| melt | rapid melt of 3d LJ system |
-+-------------+----------------------------------------------------------------------------+
-| micelle | self-assembly of small lipid-like molecules into 2d bilayers |
-+-------------+----------------------------------------------------------------------------+
-| min | energy minimization of 2d LJ melt |
-+-------------+----------------------------------------------------------------------------+
-| msst | MSST shock dynamics |
-+-------------+----------------------------------------------------------------------------+
-| nb3b | use of nonbonded 3-body harmonic pair style |
-+-------------+----------------------------------------------------------------------------+
-| neb | nudged elastic band (NEB) calculation for barrier finding |
-+-------------+----------------------------------------------------------------------------+
-| nemd | non-equilibrium MD of 2d sheared system |
-+-------------+----------------------------------------------------------------------------+
-| obstacle | flow around two voids in a 2d channel |
-+-------------+----------------------------------------------------------------------------+
-| peptide | dynamics of a small solvated peptide chain (5-mer) |
-+-------------+----------------------------------------------------------------------------+
-| peri | Peridynamic model of cylinder impacted by indenter |
-+-------------+----------------------------------------------------------------------------+
-| pour | pouring of granular particles into a 3d box, then chute flow |
-+-------------+----------------------------------------------------------------------------+
-| prd | parallel replica dynamics of vacancy diffusion in bulk Si |
-+-------------+----------------------------------------------------------------------------+
-| qeq | use of the QEQ package for charge equilibration |
-+-------------+----------------------------------------------------------------------------+
-| reax | RDX and TATB models using the ReaxFF |
-+-------------+----------------------------------------------------------------------------+
-| rigid | rigid bodies modeled as independent or coupled |
-+-------------+----------------------------------------------------------------------------+
-| shear | sideways shear applied to 2d solid, with and without a void |
-+-------------+----------------------------------------------------------------------------+
-| snap | NVE dynamics for BCC tantalum crystal using SNAP potential |
-+-------------+----------------------------------------------------------------------------+
-| srd | stochastic rotation dynamics (SRD) particles as solvent |
-+-------------+----------------------------------------------------------------------------+
-| tad | temperature-accelerated dynamics of vacancy diffusion in bulk Si |
-+-------------+----------------------------------------------------------------------------+
-| tri | triangular particles in rigid bodies |
-+-------------+----------------------------------------------------------------------------+
+Lists of both kinds of directories are given below.
-vashishta: models using the Vashishta potential
-Here is how you might run and visualize one of the sample problems:
+----------
+
+
+Lowercase directories
+---------------------
+
++-------------+------------------------------------------------------------------+
+| accelerate | run with various acceleration options (OpenMP, GPU, Phi) |
++-------------+------------------------------------------------------------------+
+| balance | dynamic load balancing, 2d system |
++-------------+------------------------------------------------------------------+
+| body | body particles, 2d system |
++-------------+------------------------------------------------------------------+
+| colloid | big colloid particles in a small particle solvent, 2d system |
++-------------+------------------------------------------------------------------+
+| comb | models using the COMB potential |
++-------------+------------------------------------------------------------------+
+| coreshell | core/shell model using CORESHELL package |
++-------------+------------------------------------------------------------------+
+| crack | crack propagation in a 2d solid |
++-------------+------------------------------------------------------------------+
+| cuda | use of the USER-CUDA package for GPU acceleration |
++-------------+------------------------------------------------------------------+
+| deposit | deposit atoms and molecules on a surface |
++-------------+------------------------------------------------------------------+
+| dipole | point dipolar particles, 2d system |
++-------------+------------------------------------------------------------------+
+| dreiding | methanol via Dreiding FF |
++-------------+------------------------------------------------------------------+
+| eim | NaCl using the EIM potential |
++-------------+------------------------------------------------------------------+
+| ellipse | ellipsoidal particles in spherical solvent, 2d system |
++-------------+------------------------------------------------------------------+
+| flow | Couette and Poiseuille flow in a 2d channel |
++-------------+------------------------------------------------------------------+
+| friction | frictional contact of spherical asperities between 2d surfaces |
++-------------+------------------------------------------------------------------+
+| hugoniostat | Hugoniostat shock dynamics |
++-------------+------------------------------------------------------------------+
+| indent | spherical indenter into a 2d solid |
++-------------+------------------------------------------------------------------+
+| kim | use of potentials in Knowledge Base for Interatomic Models (KIM) |
++-------------+------------------------------------------------------------------+
+| meam | MEAM test for SiC and shear (same as shear examples) |
++-------------+------------------------------------------------------------------+
+| melt | rapid melt of 3d LJ system |
++-------------+------------------------------------------------------------------+
+| micelle | self-assembly of small lipid-like molecules into 2d bilayers |
++-------------+------------------------------------------------------------------+
+| min | energy minimization of 2d LJ melt |
++-------------+------------------------------------------------------------------+
+| msst | MSST shock dynamics |
++-------------+------------------------------------------------------------------+
+| nb3b | use of nonbonded 3-body harmonic pair style |
++-------------+------------------------------------------------------------------+
+| neb | nudged elastic band (NEB) calculation for barrier finding |
++-------------+------------------------------------------------------------------+
+| nemd | non-equilibrium MD of 2d sheared system |
++-------------+------------------------------------------------------------------+
+| obstacle | flow around two voids in a 2d channel |
++-------------+------------------------------------------------------------------+
+| peptide | dynamics of a small solvated peptide chain (5-mer) |
++-------------+------------------------------------------------------------------+
+| peri | Peridynamic model of cylinder impacted by indenter |
++-------------+------------------------------------------------------------------+
+| pour | pouring of granular particles into a 3d box, then chute flow |
++-------------+------------------------------------------------------------------+
+| prd | parallel replica dynamics of vacancy diffusion in bulk Si |
++-------------+------------------------------------------------------------------+
+| python | using embedded Python in a LAMMPS input script |
++-------------+------------------------------------------------------------------+
+| qeq | use of the QEQ package for charge equilibration |
++-------------+------------------------------------------------------------------+
+| reax | RDX and TATB models using the ReaxFF |
++-------------+------------------------------------------------------------------+
+| rigid | rigid bodies modeled as independent or coupled |
++-------------+------------------------------------------------------------------+
+| shear | sideways shear applied to 2d solid, with and without a void |
++-------------+------------------------------------------------------------------+
+| snap | NVE dynamics for BCC tantalum crystal using SNAP potential |
++-------------+------------------------------------------------------------------+
+| srd | stochastic rotation dynamics (SRD) particles as solvent |
++-------------+------------------------------------------------------------------+
+| streitz | use of Streitz/Mintmire potential with charge equilibration |
++-------------+------------------------------------------------------------------+
+| tad | temperature-accelerated dynamics of vacancy diffusion in bulk Si |
++-------------+------------------------------------------------------------------+
+| vashishta | use of the Vashishta potential |
++-------------+------------------------------------------------------------------+
+
+Here is how you can run and visualize one of the sample problems:
.. parsed-literal::
@@ -124,16 +138,16 @@ Here is how you might run and visualize one of the sample problems:
lmp_linux -in in.indent # run the problem
Running the simulation produces the files *dump.indent* and
-*log.lammps*. You can visualize the dump file as follows:
-
-.. parsed-literal::
-
- ../../tools/xmovie/xmovie -scale dump.indent
+*log.lammps*. You can visualize the dump file of snapshots with a
+variety of 3rd-party tools highlighted on the
+`Visualization `_ page of the LAMMPS
+web site.
If you uncomment the :doc:`dump image ` line(s) in the input
-script a series of JPG images will be produced by the run. These can
-be viewed individually or turned into a movie or animated by tools
-like ImageMagick or QuickTime or various Windows-based tools. See the
+script a series of JPG images will be produced by the run (assuming
+you built LAMMPS with JPG support; see :doc:`Section start 2.2 ` for details). These can be viewed
+individually or turned into a movie or animated by tools like
+ImageMagick or QuickTime or various Windows-based tools. See the
:doc:`dump image ` doc page for more details. E.g. this
Imagemagick command would create a GIF file suitable for viewing in a
browser.
@@ -146,23 +160,38 @@ browser.
----------
-There is also a COUPLE directory with examples of how to use LAMMPS as
-a library, either by itself or in tandem with another code or library.
-See the COUPLE/README file to get started.
+Uppercase directories
+---------------------
-There is also an ELASTIC directory with an example script for
-computing elastic constants at zero temperature, using an Si example. See
-the ELASTIC/in.elastic file for more info.
++-----------+--------------------------------------------------------------------------------------------------+
+| ASPHERE | various aspherical particle models, using ellipsoids, rigid bodies, line/triangle particles, etc |
++-----------+--------------------------------------------------------------------------------------------------+
+| COUPLE | examples of how to use LAMMPS as a library |
++-----------+--------------------------------------------------------------------------------------------------+
+| DIFFUSE | compute diffusion coefficients via several methods |
++-----------+--------------------------------------------------------------------------------------------------+
+| ELASTIC | compute elastic constants at zero temperature |
++-----------+--------------------------------------------------------------------------------------------------+
+| ELASTIC_T | compute elastic constants at finite temperature |
++-----------+--------------------------------------------------------------------------------------------------+
+| KAPPA | compute thermal conductivity via several methods |
++-----------+--------------------------------------------------------------------------------------------------+
+| MC | using LAMMPS in a Monte Carlo mode to relax the energy of a system |
++-----------+--------------------------------------------------------------------------------------------------+
+| USER | examples for USER packages and USER-contributed commands |
++-----------+--------------------------------------------------------------------------------------------------+
+| VISCOSITY | compute viscosity via several methods |
++-----------+--------------------------------------------------------------------------------------------------+
-There is also an ELASTIC_T directory with an example script for
-computing elastic constants at finite temperature, using an Si example. See
-the ELASTIC_T/in.elastic file for more info.
+Nearly all of these directories have README files which give more
+details on how to understand and use their contents.
-There is also a USER directory which contains subdirectories of
-user-provided examples for user packages. See the README files in
-those directories for more info. See the
-:doc:`Section_start.html ` file for more info about user
-packages.
+The USER directory has a large number of sub-directories which
+correspond by name to a USER package. They contain scripts that
+illustrate how to use the command(s) provided in that package. Many
+of the sub-directories have their own README files which give further
+instructions. See the :doc:`Section packages ` doc
+page for more info on specific USER packages.
.. _lws: http://lammps.sandia.gov
diff --git a/doc/_sources/Section_packages.txt b/doc/_sources/Section_packages.txt
index c7d06c676c..d9b5137ec5 100644
--- a/doc/_sources/Section_packages.txt
+++ b/doc/_sources/Section_packages.txt
@@ -26,12 +26,16 @@ has a summary of what the package contains. It has specific
instructions on how to install it, build or obtain any auxiliary
library it requires, and any Makefile.machine changes it requires. It
also lists pointers to examples of its use or documentation provided
-in the LAMMPS distribution.
+in the LAMMPS distribution. If you want to know the complete list of
+commands that a package adds to LAMMPS, simply list the files in its
+directory, e.g. "ls src/GRANULAR". Source files with names that start
+with compute, fix, pair, bond, etc correspond to command styles with
+the same names.
.. note::
- The sub-sections below are still being filled in, as of Feb
- 2016.
+ The USER package sub-sections below are still being filled in,
+ as of March 2016.
Unless otherwise noted below, every package is independent of all the
others. I.e. any package can be included or excluded in a LAMMPS
@@ -67,7 +71,7 @@ name links to a sub-section below with more details.
+------------------------------+--------------------------------------+----------------------------------------+----------------------------------------------------+-----------+------------+
| :ref:`CLASS2 ` | class 2 force fields | - | :doc:`pair_style lj/class2 ` | - | - |
+------------------------------+--------------------------------------+----------------------------------------+----------------------------------------------------+-----------+------------+
-| :ref:`COLLOID ` | colloidal particles | - | :doc:`atom_style colloid ` | colloid | - |
+| :ref:`COLLOID ` | colloidal particles | Kumar (1) | :doc:`atom_style colloid ` | colloid | - |
+------------------------------+--------------------------------------+----------------------------------------+----------------------------------------------------+-----------+------------+
| :ref:`COMPRESS ` | I/O compression | Axel Kohlmeyer (Temple U) | :doc:`dump */gz ` | - | - |
+------------------------------+--------------------------------------+----------------------------------------+----------------------------------------------------+-----------+------------+
@@ -75,15 +79,13 @@ name links to a sub-section below with more details.
+------------------------------+--------------------------------------+----------------------------------------+----------------------------------------------------+-----------+------------+
| :ref:`DIPOLE ` | point dipole particles | - | :doc:`pair_style dipole/cut ` | dipole | - |
+------------------------------+--------------------------------------+----------------------------------------+----------------------------------------------------+-----------+------------+
-| :ref:`FLD ` | Fast Lubrication Dynamics | Kumar & Bybee & Higdon (1) | :doc:`pair_style lubricateU ` | - | - |
-+------------------------------+--------------------------------------+----------------------------------------+----------------------------------------------------+-----------+------------+
| :ref:`GPU ` | GPU-enabled styles | Mike Brown (ORNL) | :doc:`Section accelerate ` | gpu | lib/gpu |
+------------------------------+--------------------------------------+----------------------------------------+----------------------------------------------------+-----------+------------+
| :ref:`GRANULAR ` | granular systems | - | :ref:`Section_howto 6.6 ` | pour | - |
+------------------------------+--------------------------------------+----------------------------------------+----------------------------------------------------+-----------+------------+
| :ref:`KIM ` | openKIM potentials | Smirichinski & Elliot & Tadmor (3) | :doc:`pair_style kim ` | kim | KIM |
+------------------------------+--------------------------------------+----------------------------------------+----------------------------------------------------+-----------+------------+
-| :ref:`KOKKOS ` | Kokkos-enabled styles | Trott & Edwards (4) | :doc:`Section_accelerate ` | kokkos | lib/kokkos |
+| :ref:`KOKKOS ` | Kokkos-enabled styles | Trott & Moore (4) | :doc:`Section_accelerate ` | kokkos | lib/kokkos |
+------------------------------+--------------------------------------+----------------------------------------+----------------------------------------------------+-----------+------------+
| :ref:`KSPACE ` | long-range Coulombic solvers | - | :doc:`kspace_style ` | peptide | - |
+------------------------------+--------------------------------------+----------------------------------------+----------------------------------------------------+-----------+------------+
@@ -125,8 +127,9 @@ name links to a sub-section below with more details.
The "Authors" column lists a name(s) if a specific person is
responible for creating and maintaining the package.
-(1) The FLD package was created by Amit Kumar and Michael Bybee from
-Jonathan Higdon's group at UIUC.
+(1) The COLLOID package includes Fast Lubrication Dynamics pair styles
+which were created by Amit Kumar and Michael Bybee from Jonathan
+Higdon's group at UIUC.
(2) The OPT package was created by James Fischer (High Performance
Technologies), David Richie, and Vincent Natoli (Stone Ridge
@@ -135,9 +138,9 @@ Technolgy).
(3) The KIM package was created by Valeriu Smirichinski, Ryan Elliott,
and Ellad Tadmor (U Minn).
-(4) The KOKKOS package was created primarily by Christian Trott
-(Sandia). It uses the Kokkos library which was developed by Carter
-Edwards, Christian, and collaborators at Sandia.
+(4) The KOKKOS package was created primarily by Christian Trott and
+Stan Moore (Sandia). It uses the Kokkos library which was developed
+by Carter Edwards, Christian Trott, and others at Sandia.
The "Doc page" column links to either a sub-section of the
:doc:`Section_howto ` of the manual, or an input script
@@ -166,8 +169,8 @@ p.s.: are we ever going to get commit messages from you? ;-)
ASPHERE package
^^^^^^^^^^^^^^^
-Contents: Aspherical particle models for ellipsoids, 2d lines, 3d
-triangles.
+Contents: Several computes, time-integration fixes, and pair styles
+for aspherical particle models: ellipsoids, 2d lines, 3d triangles.
To install via make or Make.py:
@@ -191,8 +194,11 @@ To un-install via make or Make.py:
Make.py -p ^asphere -a machine
-Supporting info: examples/ASPHERE, examples/ellipse, Section howto
-6.14, pair gayberne
+Supporting info: :ref:`Section howto 6.14 `,
+:doc:`pair_style gayberne `, :doc:`pair_style resquared `,
+`doc/PDF/pair_gayberne_extra.pdf `_,
+`doc/PDF/pair_resquared_extra.pdf `_,
+examples/ASPHERE, examples/ellipse
----------
@@ -203,7 +209,9 @@ Supporting info: examples/ASPHERE, examples/ellipse, Section howto
BODY package
^^^^^^^^^^^^
-Contents:
+Contents: Support for body-style particles. Computes,
+time-integration fixes, pair styles, as well as the body styles
+themselves. See the :doc:`body ` doc page for an overview.
To install via make or Make.py:
@@ -227,7 +235,8 @@ To un-install via make or Make.py:
Make.py -p ^body -a machine
-Supporting info: examples/body
+Supporting info: :doc:`atom_style body `, :doc:`body `,
+:doc:`pair_style body `, examples/body
----------
@@ -238,7 +247,8 @@ Supporting info: examples/body
CLASS2 package
^^^^^^^^^^^^^^
-Contents:
+Contents: Bond, angle, dihedral, improper, and pair styles for the
+COMPASS CLASS2 molecular force field.
To install via make or Make.py:
@@ -262,7 +272,7 @@ To un-install via make or Make.py:
Make.py -p ^class2 -a machine
-Supporting info:
+Supporting info: :doc:`bond_style class2 `, :doc:`angle_style class2 `, :doc:`dihedral_style class2 `, :doc:`improper_style class2 `, :doc:`pair_style lj/class2 `
----------
@@ -273,7 +283,11 @@ Supporting info:
COLLOID package
^^^^^^^^^^^^^^^
-Contents:
+Contents: Support for coarse-grained colloidal particles. Wall fix
+and pair styles that implement colloidal interaction models for
+finite-size particles. This includes the Fast Lubrication Dynamics
+method for hydrodynamic interactions, which is a simplified
+approximation to Stokesian dynamics.
To install via make or Make.py:
@@ -297,7 +311,7 @@ To un-install via make or Make.py:
Make.py -p ^colloid -a machine
-Supporting info: examples/colloid, examples/srd
+Supporting info: :doc:`fix wall/colloid `, :doc:`pair_style colloid `, :doc:`pair_style yukawa/colloid `, :doc:`pair_style brownian `, :doc:`pair_style lubricate `, :doc:`pair_style lubricateU `, examples/colloid, examples/srd
----------
@@ -308,7 +322,15 @@ Supporting info: examples/colloid, examples/srd
COMPRESS package
^^^^^^^^^^^^^^^^
-Contents:
+Contents: Support for compressed output of dump files via the zlib
+compression library, using dump styles with a "gz" in their style
+name.
+
+Building with the COMPRESS package assumes you have the zlib
+compression library available on your system. The build uses the
+lib/compress/Makefile.lammps file in the compile/link process. You
+should only need to edit this file if the LAMMPS build cannot find the
+zlib info it specifies.
To install via make or Make.py:
@@ -332,7 +354,7 @@ To un-install via make or Make.py:
Make.py -p ^compress -a machine
-Supporting info:
+Supporting info: src/COMPRESS/README, lib/compress/README, :doc:`dump atom/gz `, :doc:`dump cfg/gz `, :doc:`dump custom/gz `, :doc:`dump xyz/gz `
----------
@@ -343,7 +365,12 @@ Supporting info:
CORESHELL package
^^^^^^^^^^^^^^^^^
-Contents:
+Contents: Compute and pair styles that implement the adiabatic
+core/shell model for polarizability. The compute temp/cs command
+measures the temperature of a system with core/shell particles. The
+pair styles augment Born, Buckingham, and Lennard-Jones styles with
+core/shell capabilities. See :ref:`Section howto 6.26 ` for an overview of how to use the
+package.
To install via make or Make.py:
@@ -367,7 +394,9 @@ To un-install via make or Make.py:
Make.py -p ^coreshell -a machine
-Supporting info: examples/coreshell, Section howto 6.26
+Supporting info: :ref:`Section howto 6.26 `, :doc:`compute temp/cs `,
+:doc:`pair_style born/coul/long/cs `, :doc:`pair_style buck/coul/long/cs `, pair_style
+lj/cut/coul/long/cs"_pair_lj.html, examples/coreshell
----------
@@ -378,7 +407,8 @@ Supporting info: examples/coreshell, Section howto 6.26
DIPOLE package
^^^^^^^^^^^^^^
-Contents:
+Contents: An atom style and several pair styles to support point
+dipole models with short-range or long-range interactions.
To install via make or Make.py:
@@ -402,42 +432,7 @@ To un-install via make or Make.py:
Make.py -p ^dipole -a machine
-Supporting info: examples/dipole
-
-
-----------
-
-
-.. _FLD:
-
-FLD package
-^^^^^^^^^^^
-
-Contents:
-
-To install via make or Make.py:
-
-.. parsed-literal::
-
- make yes-fld
- make machine
-
-.. parsed-literal::
-
- Make.py -p fld -a machine
-
-To un-install via make or Make.py:
-
-.. parsed-literal::
-
- make no-fld
- make machine
-
-.. parsed-literal::
-
- Make.py -p ^fld -a machine
-
-Supporting info:
+Supporting info: :doc:`atom_style dipole `, :doc:`pair_style lj/cut/dipole/cut `, :doc:`pair_style lj/cut/dipole/long `, :doc:`pair_style lj/long/dipole/long `, examples/dipole
----------
@@ -448,18 +443,49 @@ Supporting info:
GPU package
^^^^^^^^^^^
-Contents:
+Contents: Dozens of pair styles and a version of the PPPM long-range
+Coulombic solver for NVIDIA GPUs. All of them have a "gpu" in their
+style name. :doc:`Section accelerate gpu