| |
|
|
|
@@ -1026,6 +1041,8 @@ Clermont-Ferrand) and co-authors Julien Devemy (CNRS) and Agilio Padua
(U Blaise Pascal).
(4) The SMTBQ package was created by Nicolas Salles, Emile Maras,
Olivier Politano, and Robert Tetot (LAAS-CNRS, France).
+(4) The USER-DPD package was created by James Larentzos, Timothy
+Mattox, and John Brennan (Army Research Lab (ARL) and Engility Corp).
If the Library is not listed as lib/package, then it is a third-party
library not included in the LAMMPS distribution. See the
src/package/Makefile.lammps file for info on where to download the
@@ -1200,8 +1217,32 @@ theory.
Arkansas. Contact him directly if you have questions.
+
+
4.20. 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:
+
+
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.
+
+
-
4.20. USER-DRUDE package
+
4.21. USER-DRUDE package
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:
@@ -1221,7 +1262,7 @@ Agilio Padua.
-
4.21. USER-EFF package
+
4.22. USER-EFF package
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,
@@ -1255,7 +1296,7 @@ have questions.
-
4.22. USER-FEP package
+
4.23. USER-FEP package
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:
@@ -1270,7 +1311,7 @@ Contact him directly if you have questions.
-
4.23. USER-H5MD package
+
4.24. USER-H5MD package
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
@@ -1284,7 +1325,7 @@ directly if you have questions.
-
4.24. USER-INTEL package
+
4.25. USER-INTEL package
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
@@ -1296,7 +1337,7 @@ Intel(R) Xeon Phi(TM) coprocessor.
-
4.25. USER-LB package
+
4.26. USER-LB package
This package contains a LAMMPS implementation of a background
Lattice-Boltzmann fluid, which can be used to model MD particles
influenced by hydrodynamic forces.
@@ -1308,7 +1349,7 @@ Western Ontario. Contact them directly if you have questions.
-
4.26. USER-MGPT package
+
4.27. USER-MGPT package
This package contains a fast implementation for LAMMPS of
quantum-based MGPT multi-ion potentials. The MGPT or model GPT method
derives from first-principles DFT-based generalized pseudopotential
@@ -1331,7 +1372,7 @@ Contact them directly if you have any questions.
-
4.27. USER-MISC package
+
4.28. USER-MISC package
The files in this package are a potpourri of (mostly) unrelated
features contributed to LAMMPS by users. Each feature is a single
pair of files (*.cpp and *.h).
@@ -1348,7 +1389,7 @@ about the feature or its coding.
-
4.28. USER-MOLFILE package
+
4.29. USER-MOLFILE package
This package contains a dump molfile command which uses molfile
plugins that are bundled with the
VMD molecular visualization and
@@ -1367,7 +1408,7 @@ application itself.
-
4.29. USER-OMP package
+
4.30. USER-OMP package
This package provides OpenMP multi-threading support and
other optimizations of various LAMMPS pair styles, dihedral
styles, and fix styles.
@@ -1378,7 +1419,7 @@ styles, and fix styles.
-
4.30. USER-PHONON package
+
4.31. USER-PHONON package
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.
@@ -1390,7 +1431,7 @@ if you have questions.
-
4.31. USER-QMMM package
+
4.32. USER-QMMM package
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
code from the Quantum ESPRESSO package.
@@ -1407,7 +1448,7 @@ without changes to LAMMPS itself.
-
4.32. USER-QTB package
+
4.33. USER-QTB package
This package provides a self-consistent quantum treatment of the
vibrational modes in a classical molecular dynamics simulation. By
coupling the MD simulation to a colored thermostat, it introduces zero
@@ -1429,7 +1470,7 @@ have questions.
-
4.33. USER-REAXC package
+
4.34. USER-REAXC package
This package contains a implementation for LAMMPS of the ReaxFF force
field. ReaxFF uses distance-dependent bond-order functions to
represent the contributions of chemical bonding to the potential
@@ -1457,7 +1498,7 @@ questions.
-
4.34. USER-SMD package
+
4.35. USER-SMD package
This package implements smoothed Mach dynamics (SMD) in
LAMMPS. Currently, the package has the following features:
@@ -1481,7 +1522,7 @@ you have questions.
-
4.35. USER-SMTBQ package
+
4.36. USER-SMTBQ package
This package implements the Second Moment Tight Binding - QEq (SMTB-Q)
potential for the description of ionocovalent bonds in oxides.
There are example scripts for using this package in
@@ -1495,7 +1536,7 @@ them directly if you have any questions.
-
4.36. USER-SPH package
+
4.37. USER-SPH package
This package implements smoothed particle hydrodynamics (SPH) in
LAMMPS. Currently, the package has the following features:
diff --git a/doc/Section_packages.txt b/doc/Section_packages.txt
index f56fdbce00..9c97e14d24 100644
--- a/doc/Section_packages.txt
+++ b/doc/Section_packages.txt
@@ -200,6 +200,7 @@ USER-CG-CMM, coarse-graining model, Axel Kohlmeyer (Temple U), "pair_style lj/sd
USER-COLVARS, collective variables, Fiorin & Henin & Kohlmeyer (2), "fix colvars"_fix_colvars.html, USER/colvars, "colvars"_colvars, lib/colvars
USER-CUDA, NVIDIA GPU styles, Christian Trott (U Tech Ilmenau), "Section accelerate"_accelerate_cuda.html, USER/cuda, -, lib/cuda
USER-DIFFRACTION, virutal x-ray and electron diffraction, Shawn Coleman (ARL),"compute xrd"_compute_xrd.html, USER/diffraction, -, -
+USER-DPD, dissipative particle dynamics (DPD), Larentzos & Mattox & Brennan (5), src/USER-DPD/README, USER/dpd, -, -
USER-DRUDE, Drude oscillators, Dequidt & Devemy & Padua (3), "tutorial"_tutorial_drude.html, USER/drude, -, -
USER-EFF, electron force field, Andres Jaramillo-Botero (Caltech), "pair_style eff/cut"_pair_eff.html, USER/eff, "eff"_eff, -
USER-FEP, free energy perturbation, Agilio Padua (U Blaise Pascal Clermont-Ferrand), "compute fep"_compute_fep.html, USER/fep, -, -
@@ -244,6 +245,9 @@ Clermont-Ferrand) and co-authors Julien Devemy (CNRS) and Agilio Padua
(4) The SMTBQ package was created by Nicolas Salles, Emile Maras,
Olivier Politano, and Robert Tetot (LAAS-CNRS, France).
+(4) The USER-DPD package was created by James Larentzos, Timothy
+Mattox, and John Brennan (Army Research Lab (ARL) and Engility Corp).
+
If the Library is not listed as lib/package, then it is a third-party
library not included in the LAMMPS distribution. See the
src/package/Makefile.lammps file for info on where to download the
@@ -454,6 +458,33 @@ Arkansas. Contact him directly if you have questions.
:line
+USER-DPD package :h4
+
+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.
+
+:line
+
USER-DRUDE package :h4
This package implements methods for simulating polarizable systems
diff --git a/doc/Section_start.html b/doc/Section_start.html
index 80e0fc84b9..10c092176e 100644
--- a/doc/Section_start.html
+++ b/doc/Section_start.html
@@ -436,8 +436,8 @@ performance.
files for doing particle dumps in XTC format. This is only necessary
if your platform does have its own XDR files available. See the
Restrictions section of the dump command for details.
-Use at most one of the -DLAMMPS_SMALLBIG, -DLAMMPS_BIGBIG, -D-
-DLAMMPS_SMALLSMALL settings. The default is -DLAMMPS_SMALLBIG. These
+
Use at most one of the -DLAMMPS_SMALLBIG, -DLAMMPS_BIGBIG,
+-DLAMMPS_SMALLSMALL settings. The default is -DLAMMPS_SMALLBIG. These
settings refer to use of 4-byte (small) vs 8-byte (big) integers
within LAMMPS, as specified in src/lmptype.h. The only reason to use
the BIGBIG setting is to enable simulation of huge molecular systems
@@ -1288,7 +1288,7 @@ use this executable to run on a single processor by typing something
like: “lmp_win_mpi -in in.lj”.
-
The screen output from LAMMPS is described in the next section. As it
+
The screen output from LAMMPS is described in a section below. As it
runs, LAMMPS also writes a log.lammps file with the same information.
Note that this sequence of commands copies the LAMMPS executable
(lmp_linux) to the directory with the input files. This may not be
diff --git a/doc/Section_start.txt b/doc/Section_start.txt
index f811a22475..41708dc402 100644
--- a/doc/Section_start.txt
+++ b/doc/Section_start.txt
@@ -311,8 +311,8 @@ files for doing particle dumps in XTC format. This is only necessary
if your platform does have its own XDR files available. See the
Restrictions section of the "dump"_dump.html command for details.
-Use at most one of the -DLAMMPS_SMALLBIG, -DLAMMPS_BIGBIG, -D-
-DLAMMPS_SMALLSMALL settings. The default is -DLAMMPS_SMALLBIG. These
+Use at most one of the -DLAMMPS_SMALLBIG, -DLAMMPS_BIGBIG,
+-DLAMMPS_SMALLSMALL settings. The default is -DLAMMPS_SMALLBIG. These
settings refer to use of 4-byte (small) vs 8-byte (big) integers
within LAMMPS, as specified in src/lmptype.h. The only reason to use
the BIGBIG setting is to enable simulation of huge molecular systems
@@ -1266,7 +1266,7 @@ like: "lmp_win_mpi -in in.lj". :l,ule
:line
-The screen output from LAMMPS is described in the next section. As it
+The screen output from LAMMPS is described in a section below. As it
runs, LAMMPS also writes a log.lammps file with the same information.
Note that this sequence of commands copies the LAMMPS executable
diff --git a/doc/_sources/Manual.txt b/doc/_sources/Manual.txt
new file mode 100644
index 0000000000..62a89d1c8e
--- /dev/null
+++ b/doc/_sources/Manual.txt
@@ -0,0 +1,104 @@
+.. raw:: html
+
+
+
+LAMMPS Documentation
+====================
+
+29 Jan 2016 version
+-------------------
+
+Version info:
+-------------
+
+The LAMMPS "version" is the date when it was released, such as 1 May
+2010. LAMMPS is updated continuously. Whenever we fix a bug or add a
+feature, we release it immediately, and post a notice on `this page of the WWW site
`_. Each dated copy of LAMMPS contains all the
+features and bug-fixes up to and including that version date. The
+version date is printed to the screen and logfile every time you run
+LAMMPS. It is also in the file src/version.h and in the LAMMPS
+directory name created when you unpack a tarball, and at the top of
+the first page of the manual (this page).
+
+* If you browse the HTML doc pages on the LAMMPS WWW site, they always
+ describe the most current version of LAMMPS.
+* If you browse the HTML doc pages included in your tarball, they
+ describe the version you have.
+* The `PDF file `_ on the WWW site or in the tarball is updated
+ about once per month. This is because it is large, and we don't want
+ it to be part of every patch.
+* There is also a `Developer.pdf `_ file in the doc
+ directory, which describes the internal structure and algorithms of
+ LAMMPS.
+LAMMPS stands for Large-scale Atomic/Molecular Massively Parallel
+Simulator.
+
+LAMMPS is a classical molecular dynamics simulation code designed to
+run efficiently on parallel computers. It was developed at Sandia
+National Laboratories, a US Department of Energy facility, with
+funding from the DOE. It is an open-source code, distributed freely
+under the terms of the GNU Public License (GPL).
+
+The primary developers of LAMMPS are `Steve Plimpton `_, Aidan
+Thompson, and Paul Crozier who can be contacted at
+sjplimp,athomps,pscrozi at sandia.gov. The `LAMMPS WWW Site `_ at
+http://lammps.sandia.gov has more information about the code and its
+uses.
+
+.. _bug: http://lammps.sandia.gov/bug.html
+
+
+
+.. _sjp: http://www.sandia.gov/~sjplimp
+
+
+
+
+----------
+
+
+The LAMMPS documentation is organized into the following sections. If
+you find errors or omissions in this manual or have suggestions for
+useful information to add, please send an email to the developers so
+we can improve the LAMMPS documentation.
+
+Once you are familiar with LAMMPS, you may want to bookmark :ref:`this page ` at Section_commands.html#comm since
+it gives quick access to documentation for all LAMMPS commands.
+
+`PDF file `_ of the entire manual, generated by
+`htmldoc `_
+
+
+.. toctree::
+ :maxdepth: 2
+ :numbered:
+
+ Section_intro
+ Section_start
+ Section_commands
+ Section_packages
+ Section_accelerate
+ Section_howto
+ Section_example
+ Section_perf
+ Section_tools
+ Section_modify
+ Section_python
+ Section_errors
+ Section_history
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`search`
+
+.. raw:: html
+
+