jianmu
/
lammps
forked from lijiext/lammps
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
lammps/doc/Section_packages.html

1591 lines
66 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>4. Packages &mdash; LAMMPS 15 May 2015 version documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/sphinxcontrib-images/LightBox2/lightbox2/css/lightbox.css" type="text/css" />
<link rel="top" title="LAMMPS 15 May 2015 version documentation" href="index.html"/>
<link rel="next" title="5. Accelerating LAMMPS performance" href="Section_accelerate.html"/>
<link rel="prev" title="3. Commands" href="Section_commands.html"/>
<script src="_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-nav-search">
<a href="Manual.html" class="icon icon-home"> LAMMPS
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="Section_intro.html">1. Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="Section_start.html">2. Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="Section_commands.html">3. Commands</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="">4. Packages</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#standard-packages">4.1. Standard packages</a></li>
<li class="toctree-l2"><a class="reference internal" href="#build-instructions-for-compress-package">4.2. Build instructions for COMPRESS package</a></li>
<li class="toctree-l2"><a class="reference internal" href="#build-instructions-for-gpu-package">4.3. Build instructions for GPU package</a></li>
<li class="toctree-l2"><a class="reference internal" href="#build-instructions-for-kim-package">4.4. Build instructions for KIM package</a></li>
<li class="toctree-l2"><a class="reference internal" href="#build-instructions-for-kokkos-package">4.5. Build instructions for KOKKOS package</a></li>
<li class="toctree-l2"><a class="reference internal" href="#build-instructions-for-kspace-package">4.6. Build instructions for KSPACE package</a></li>
<li class="toctree-l2"><a class="reference internal" href="#build-instructions-for-meam-package">4.7. Build instructions for MEAM package</a></li>
<li class="toctree-l2"><a class="reference internal" href="#build-instructions-for-poems-package">4.8. Build instructions for POEMS package</a></li>
<li class="toctree-l2"><a class="reference internal" href="#build-instructions-for-python-package">4.9. Build instructions for PYTHON package</a></li>
<li class="toctree-l2"><a class="reference internal" href="#build-instructions-for-reax-package">4.10. Build instructions for REAX package</a></li>
<li class="toctree-l2"><a class="reference internal" href="#build-instructions-for-voronoi-package">4.11. Build instructions for VORONOI package</a></li>
<li class="toctree-l2"><a class="reference internal" href="#build-instructions-for-xtc-package">4.12. Build instructions for XTC package</a></li>
<li class="toctree-l2"><a class="reference internal" href="#user-packages">4.13. User packages</a></li>
<li class="toctree-l2"><a class="reference internal" href="#user-atc-package">4.14. USER-ATC package</a></li>
<li class="toctree-l2"><a class="reference internal" href="#user-awpmd-package">4.15. USER-AWPMD package</a></li>
<li class="toctree-l2"><a class="reference internal" href="#user-cg-cmm-package">4.16. USER-CG-CMM package</a></li>
<li class="toctree-l2"><a class="reference internal" href="#user-colvars-package">4.17. USER-COLVARS package</a></li>
<li class="toctree-l2"><a class="reference internal" href="#user-cuda-package">4.18. USER-CUDA package</a></li>
<li class="toctree-l2"><a class="reference internal" href="#user-diffraction-package">4.19. USER-DIFFRACTION package</a></li>
<li class="toctree-l2"><a class="reference internal" href="#user-drude-package">4.20. USER-DRUDE package</a></li>
<li class="toctree-l2"><a class="reference internal" href="#user-eff-package">4.21. USER-EFF package</a></li>
<li class="toctree-l2"><a class="reference internal" href="#user-fep-package">4.22. USER-FEP package</a></li>
<li class="toctree-l2"><a class="reference internal" href="#user-h5md-package">4.23. USER-H5MD package</a></li>
<li class="toctree-l2"><a class="reference internal" href="#user-intel-package">4.24. USER-INTEL package</a></li>
<li class="toctree-l2"><a class="reference internal" href="#user-lb-package">4.25. USER-LB package</a></li>
<li class="toctree-l2"><a class="reference internal" href="#user-mgpt-package">4.26. USER-MGPT package</a></li>
<li class="toctree-l2"><a class="reference internal" href="#user-misc-package">4.27. USER-MISC package</a></li>
<li class="toctree-l2"><a class="reference internal" href="#user-molfile-package">4.28. USER-MOLFILE package</a></li>
<li class="toctree-l2"><a class="reference internal" href="#user-omp-package">4.29. USER-OMP package</a></li>
<li class="toctree-l2"><a class="reference internal" href="#user-phonon-package">4.30. USER-PHONON package</a></li>
<li class="toctree-l2"><a class="reference internal" href="#user-qmmm-package">4.31. USER-QMMM package</a></li>
<li class="toctree-l2"><a class="reference internal" href="#user-qtb-package">4.32. USER-QTB package</a></li>
<li class="toctree-l2"><a class="reference internal" href="#user-reaxc-package">4.33. USER-REAXC package</a></li>
<li class="toctree-l2"><a class="reference internal" href="#user-smd-package">4.34. USER-SMD package</a></li>
<li class="toctree-l2"><a class="reference internal" href="#user-smtbq-package">4.35. USER-SMTBQ package</a></li>
<li class="toctree-l2"><a class="reference internal" href="#user-sph-package">4.36. USER-SPH package</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Section_accelerate.html">5. Accelerating LAMMPS performance</a></li>
<li class="toctree-l1"><a class="reference internal" href="Section_howto.html">6. How-to discussions</a></li>
<li class="toctree-l1"><a class="reference internal" href="Section_example.html">7. Example problems</a></li>
<li class="toctree-l1"><a class="reference internal" href="Section_perf.html">8. Performance &amp; scalability</a></li>
<li class="toctree-l1"><a class="reference internal" href="Section_tools.html">9. Additional tools</a></li>
<li class="toctree-l1"><a class="reference internal" href="Section_modify.html">10. Modifying &amp; extending LAMMPS</a></li>
<li class="toctree-l1"><a class="reference internal" href="Section_python.html">11. Python interface to LAMMPS</a></li>
<li class="toctree-l1"><a class="reference internal" href="Section_errors.html">12. Errors</a></li>
<li class="toctree-l1"><a class="reference internal" href="Section_history.html">13. Future and history</a></li>
</ul>
</div>
&nbsp;
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="Manual.html">LAMMPS</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="Manual.html">Docs</a> &raquo;</li>
<li>4. Packages</li>
<li class="wy-breadcrumbs-aside">
<a href="http://lammps.sandia.gov">Website</a>
<a href="Section_commands.html#comm">Commands</a>
</li>
</ul>
<hr/>
<div class="rst-footer-buttons" style="margin-bottom: 1em" role="navigation" aria-label="footer navigation">
<a href="Section_accelerate.html" class="btn btn-neutral float-right" title="5. Accelerating LAMMPS performance" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="Section_commands.html" class="btn btn-neutral" title="3. Commands" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="packages">
<h1>4. Packages<a class="headerlink" href="#packages" title="Permalink to this headline"></a></h1>
<p>This section gives a quick overview of the add-on packages that extend
LAMMPS functionality.</p>
<div class="line-block">
<div class="line">4.1 <a class="reference internal" href="#pkg-1"><span>Standard packages</span></a></div>
<div class="line">4.2 <a class="reference internal" href="#pkg-2"><span>User packages</span></a></div>
<div class="line"><br /></div>
</div>
<p>LAMMPS includes many optional packages, which are groups of files that
enable a specific set of features. For example, force fields for
molecular systems or granular systems are in packages. You can see
the list of all packages by typing &#8220;make package&#8221; from within the src
directory of the LAMMPS distribution.</p>
<p>See <a class="reference internal" href="Section_start.html#start-3"><span>Section_start 3</span></a> of the manual for
details on how to include/exclude specific packages as part of the
LAMMPS build process, and for more details about the differences
between standard packages and user packages.</p>
<p>Unless otherwise noted below, every package is independent of all the
others. I.e. any package can be included or excluded in a LAMMPS
build, independent of all other packages. However, note that some
packages include commands derived from commands in other packages. If
the other package is not installed, the derived command from the new
package will also not be installed when you include the new one.
E.g. the pair lj/cut/coul/long/omp command from the USER-OMP package
will not be installed as part of the USER-OMP package if the KSPACE
package is not also installed, since it contains the pair
lj/cut/coul/long command. If you later install the KSPACE pacakge and
the USER-OMP package is already installed, both the pair
lj/cut/coul/long and lj/cut/coul/long/omp commands will be installed.</p>
<p>The two tables below list currently available packages in LAMMPS, with
a one-line descriptions of each. The sections below give a few more
details, including instructions for building LAMMPS with the package,
either via the make command or the Make.py tool described in <a class="reference internal" href="Section_start.html#start-4"><span>Section 2.4</span></a>.</p>
<div class="section" id="standard-packages">
<span id="pkg-1"></span><h2>4.1. Standard packages<a class="headerlink" href="#standard-packages" title="Permalink to this headline"></a></h2>
<p>The current list of standard packages is as follows.</p>
<table border="1" class="docutils">
<colgroup>
<col width="7%" />
<col width="23%" />
<col width="24%" />
<col width="32%" />
<col width="7%" />
<col width="7%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>Package</td>
<td>Description</td>
<td>Author(s)</td>
<td>Doc page</td>
<td>Example</td>
<td>Library</td>
</tr>
<tr class="row-even"><td>ASPHERE</td>
<td>aspherical particles</td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
<td><a class="reference internal" href="Section_howto.html#howto-14"><span>Section_howto 6.14</span></a></td>
<td>ellipse</td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
</tr>
<tr class="row-odd"><td>BODY</td>
<td>body-style particles</td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
<td><a class="reference internal" href="body.html"><em>body</em></a></td>
<td>body</td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
</tr>
<tr class="row-even"><td>CLASS2</td>
<td>class 2 force fields</td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
<td><a class="reference internal" href="pair_class2.html"><em>pair_style lj/class2</em></a></td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
</tr>
<tr class="row-odd"><td>COLLOID</td>
<td>colloidal particles</td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
<td><a class="reference internal" href="atom_style.html"><em>atom_style colloid</em></a></td>
<td>colloid</td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
</tr>
<tr class="row-even"><td>COMPRESS</td>
<td>I/O compression</td>
<td>Axel Kohlmeyer (Temple U)</td>
<td><a class="reference internal" href="dump.html"><em>dump */gz</em></a></td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
</tr>
<tr class="row-odd"><td>CORESHELL</td>
<td>adiabatic core/shell model</td>
<td>Hendrik Heenen (Technical U of Munich)</td>
<td><a class="reference internal" href="Section_howto.html#howto-25"><span>Section_howto 6.25</span></a></td>
<td>coreshell</td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
</tr>
<tr class="row-even"><td>DIPOLE</td>
<td>point dipole particles</td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
<td><a class="reference internal" href="pair_dipole.html"><em>pair_style dipole/cut</em></a></td>
<td>dipole</td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
</tr>
<tr class="row-odd"><td>FLD</td>
<td>Fast Lubrication Dynamics</td>
<td>Kumar &amp; Bybee &amp; Higdon (1)</td>
<td><a class="reference internal" href="pair_lubricateU.html"><em>pair_style lubricateU</em></a></td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
</tr>
<tr class="row-even"><td>GPU</td>
<td>GPU-enabled styles</td>
<td>Mike Brown (ORNL)</td>
<td><a class="reference internal" href="accelerate_gpu.html"><em>Section accelerate</em></a></td>
<td>gpu</td>
<td>lib/gpu</td>
</tr>
<tr class="row-odd"><td>GRANULAR</td>
<td>granular systems</td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
<td><a class="reference internal" href="Section_howto.html#howto-6"><span>Section_howto 6.6</span></a></td>
<td>pour</td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
</tr>
<tr class="row-even"><td>KIM</td>
<td>openKIM potentials</td>
<td>Smirichinski &amp; Elliot &amp; Tadmor (3)</td>
<td><a class="reference internal" href="pair_kim.html"><em>pair_style kim</em></a></td>
<td>kim</td>
<td>KIM</td>
</tr>
<tr class="row-odd"><td>KOKKOS</td>
<td>Kokkos-enabled styles</td>
<td>Trott &amp; Edwards (4)</td>
<td><a class="reference internal" href="accelerate_kokkos.html"><em>Section_accelerate</em></a></td>
<td>kokkos</td>
<td>lib/kokkos</td>
</tr>
<tr class="row-even"><td>KSPACE</td>
<td>long-range Coulombic solvers</td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
<td><a class="reference internal" href="kspace_style.html"><em>kspace_style</em></a></td>
<td>peptide</td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
</tr>
<tr class="row-odd"><td>MANYBODY</td>
<td>many-body potentials</td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
<td><a class="reference internal" href="pair_tersoff.html"><em>pair_style tersoff</em></a></td>
<td>shear</td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
</tr>
<tr class="row-even"><td>MEAM</td>
<td>modified EAM potential</td>
<td>Greg Wagner (Sandia)</td>
<td><a class="reference internal" href="pair_meam.html"><em>pair_style meam</em></a></td>
<td>meam</td>
<td>lib/meam</td>
</tr>
<tr class="row-odd"><td>MC</td>
<td>Monte Carlo options</td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
<td><a class="reference internal" href="fix_gcmc.html"><em>fix gcmc</em></a></td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
</tr>
<tr class="row-even"><td>MOLECULE</td>
<td>molecular system force fields</td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
<td><a class="reference internal" href="Section_howto.html#howto-3"><span>Section_howto 6.3</span></a></td>
<td>peptide</td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
</tr>
<tr class="row-odd"><td>OPT</td>
<td>optimized pair styles</td>
<td>Fischer &amp; Richie &amp; Natoli (2)</td>
<td><a class="reference internal" href="accelerate_opt.html"><em>Section accelerate</em></a></td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
</tr>
<tr class="row-even"><td>PERI</td>
<td>Peridynamics models</td>
<td>Mike Parks (Sandia)</td>
<td><a class="reference internal" href="pair_peri.html"><em>pair_style peri</em></a></td>
<td>peri</td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
</tr>
<tr class="row-odd"><td>POEMS</td>
<td>coupled rigid body motion</td>
<td>Rudra Mukherjee (JPL)</td>
<td><a class="reference internal" href="fix_poems.html"><em>fix poems</em></a></td>
<td>rigid</td>
<td>lib/poems</td>
</tr>
<tr class="row-even"><td>PYTHON</td>
<td>embed Python code in an input script</td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
<td><a class="reference internal" href="python.html"><em>python</em></a></td>
<td>python</td>
<td>lib/python</td>
</tr>
<tr class="row-odd"><td>REAX</td>
<td>ReaxFF potential</td>
<td>Aidan Thompson (Sandia)</td>
<td><a class="reference internal" href="pair_reax.html"><em>pair_style reax</em></a></td>
<td>reax</td>
<td>lib/reax</td>
</tr>
<tr class="row-even"><td>REPLICA</td>
<td>multi-replica methods</td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
<td><a class="reference internal" href="Section_howto.html#howto-5"><span>Section_howto 6.5</span></a></td>
<td>tad</td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
</tr>
<tr class="row-odd"><td>RIGID</td>
<td>rigid bodies</td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
<td><a class="reference internal" href="fix_rigid.html"><em>fix rigid</em></a></td>
<td>rigid</td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
</tr>
<tr class="row-even"><td>SHOCK</td>
<td>shock loading methods</td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
<td><a class="reference internal" href="fix_msst.html"><em>fix msst</em></a></td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
</tr>
<tr class="row-odd"><td>SNAP</td>
<td>quantum-fit potential</td>
<td>Aidan Thompson (Sandia)</td>
<td><a class="reference internal" href="pair_snap.html"><em>pair snap</em></a></td>
<td>snap</td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
</tr>
<tr class="row-even"><td>SRD</td>
<td>stochastic rotation dynamics</td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
<td><a class="reference internal" href="fix_srd.html"><em>fix srd</em></a></td>
<td>srd</td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
</tr>
<tr class="row-odd"><td>VORONOI</td>
<td>Voronoi tesselations</td>
<td>Daniel Schwen (LANL)</td>
<td><a class="reference internal" href="compute_voronoi_atom.html"><em>compute voronoi/atom</em></a></td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
<td>Voro++</td>
</tr>
<tr class="row-even"><td>XTC</td>
<td>dumps in XTC format</td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
<td><a class="reference internal" href="dump.html"><em>dump</em></a></td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
</tr>
<tr class="row-odd"><td>&nbsp;</td>
<td>&nbsp;</td>
<td>&nbsp;</td>
<td>&nbsp;</td>
<td>&nbsp;</td>
<td>&nbsp;</td>
</tr>
</tbody>
</table>
<p>The &#8220;Authors&#8221; column lists a name(s) if a specific person is
responible for creating and maintaining the package.
More details on
multiple authors are give below.</p>
<p>(1) The FLD package was created by Amit Kumar and Michael Bybee from
Jonathan Higdon&#8217;s group at UIUC.</p>
<p>(2) The OPT package was created by James Fischer (High Performance
Technologies), David Richie, and Vincent Natoli (Stone Ridge
Technolgy).</p>
<p>(3) The KIM package was created by Valeriu Smirichinski, Ryan Elliott,
and Ellad Tadmor (U Minn).</p>
<p>(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.</p>
<p>The &#8220;Doc page&#8221; column links to either a portion of the
<a class="reference internal" href="Section_howto.html"><em>Section_howto</em></a> of the manual, or an input script
command implemented as part of the package.</p>
<p>The &#8220;Example&#8221; column is a sub-directory in the examples directory of
the distribution which has an input script that uses the package.
E.g. &#8220;peptide&#8221; refers to the examples/peptide directory.</p>
<p>The &#8220;Library&#8221; column lists an external library which must be built
first and which LAMMPS links to when it is built. If it is listed as
lib/package, then the code for the library is under the lib directory
of the LAMMPS distribution. See the lib/package/README file for info
on how to build the library. If it is not listed as lib/package, then
it is a third-party library not included in the LAMMPS distribution.
See the src/package/README or src/package/Makefile.lammps file for
info on where to download the library. <a class="reference internal" href="Section_start.html#start-3-3"><span>Section start</span></a> of the manual also gives details
on how to build LAMMPS with both kinds of auxiliary libraries.</p>
<p>Except where explained below, all of these packages can be installed,
and LAMMPS re-built, by issuing these commands from the src dir.</p>
<div class="highlight-python"><div class="highlight"><pre>make yes-package
make machine
or
Make.py -p package -a machine
</pre></div>
</div>
<p>To un-install the package and re-build LAMMPS without it:</p>
<div class="highlight-python"><div class="highlight"><pre>make no-package
make machine
or
Make.py -p ^package -a machine
</pre></div>
</div>
<p>&#8220;Package&#8221; is the name of the package in lower-case letters,
e.g. asphere or rigid, and &#8220;machine&#8221; is the build target, e.g. mpi or
serial.</p>
</div>
<div class="section" id="build-instructions-for-compress-package">
<h2>4.2. Build instructions for COMPRESS package<a class="headerlink" href="#build-instructions-for-compress-package" title="Permalink to this headline"></a></h2>
</div>
<div class="section" id="build-instructions-for-gpu-package">
<h2>4.3. Build instructions for GPU package<a class="headerlink" href="#build-instructions-for-gpu-package" title="Permalink to this headline"></a></h2>
</div>
<div class="section" id="build-instructions-for-kim-package">
<h2>4.4. Build instructions for KIM package<a class="headerlink" href="#build-instructions-for-kim-package" title="Permalink to this headline"></a></h2>
</div>
<div class="section" id="build-instructions-for-kokkos-package">
<h2>4.5. Build instructions for KOKKOS package<a class="headerlink" href="#build-instructions-for-kokkos-package" title="Permalink to this headline"></a></h2>
</div>
<div class="section" id="build-instructions-for-kspace-package">
<h2>4.6. Build instructions for KSPACE package<a class="headerlink" href="#build-instructions-for-kspace-package" title="Permalink to this headline"></a></h2>
</div>
<div class="section" id="build-instructions-for-meam-package">
<h2>4.7. Build instructions for MEAM package<a class="headerlink" href="#build-instructions-for-meam-package" title="Permalink to this headline"></a></h2>
</div>
<div class="section" id="build-instructions-for-poems-package">
<h2>4.8. Build instructions for POEMS package<a class="headerlink" href="#build-instructions-for-poems-package" title="Permalink to this headline"></a></h2>
</div>
<div class="section" id="build-instructions-for-python-package">
<h2>4.9. Build instructions for PYTHON package<a class="headerlink" href="#build-instructions-for-python-package" title="Permalink to this headline"></a></h2>
</div>
<div class="section" id="build-instructions-for-reax-package">
<h2>4.10. Build instructions for REAX package<a class="headerlink" href="#build-instructions-for-reax-package" title="Permalink to this headline"></a></h2>
</div>
<div class="section" id="build-instructions-for-voronoi-package">
<h2>4.11. Build instructions for VORONOI package<a class="headerlink" href="#build-instructions-for-voronoi-package" title="Permalink to this headline"></a></h2>
</div>
<div class="section" id="build-instructions-for-xtc-package">
<h2>4.12. Build instructions for XTC package<a class="headerlink" href="#build-instructions-for-xtc-package" title="Permalink to this headline"></a></h2>
<hr class="docutils" />
</div>
<div class="section" id="user-packages">
<span id="pkg-2"></span><h2>4.13. User packages<a class="headerlink" href="#user-packages" title="Permalink to this headline"></a></h2>
<p>The current list of user-contributed packages is as follows:</p>
<table border="1" class="docutils">
<colgroup>
<col width="8%" />
<col width="21%" />
<col width="22%" />
<col width="25%" />
<col width="8%" />
<col width="10%" />
<col width="6%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>Package</td>
<td>Description</td>
<td>Author(s)</td>
<td>Doc page</td>
<td>Example</td>
<td>Pic/movie</td>
<td>Library</td>
</tr>
<tr class="row-even"><td>USER-ATC</td>
<td>atom-to-continuum coupling</td>
<td>Jones &amp; Templeton &amp; Zimmerman (1)</td>
<td><a class="reference internal" href="fix_atc.html"><em>fix atc</em></a></td>
<td>USER/atc</td>
<td><a class="reference external" href="http://lammps.sandia.gov/pictures.html#atc">atc</a></td>
<td>lib/atc</td>
</tr>
<tr class="row-odd"><td>USER-AWPMD</td>
<td>wave-packet MD</td>
<td>Ilya Valuev (JIHT)</td>
<td><a class="reference internal" href="pair_awpmd.html"><em>pair_style awpmd/cut</em></a></td>
<td>USER/awpmd</td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
<td>lib/awpmd</td>
</tr>
<tr class="row-even"><td>USER-CG-CMM</td>
<td>coarse-graining model</td>
<td>Axel Kohlmeyer (Temple U)</td>
<td><a class="reference internal" href="pair_sdk.html"><em>pair_style lj/sdk</em></a></td>
<td>USER/cg-cmm</td>
<td><a class="reference external" href="http://lammps.sandia.gov/pictures.html#cg">cg</a></td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
</tr>
<tr class="row-odd"><td>USER-COLVARS</td>
<td>collective variables</td>
<td>Fiorin &amp; Henin &amp; Kohlmeyer (2)</td>
<td><a class="reference internal" href="fix_colvars.html"><em>fix colvars</em></a></td>
<td>USER/colvars</td>
<td><a class="reference external" href="colvars">colvars</a></td>
<td>lib/colvars</td>
</tr>
<tr class="row-even"><td>USER-CUDA</td>
<td>NVIDIA GPU styles</td>
<td>Christian Trott (U Tech Ilmenau)</td>
<td><a class="reference internal" href="accelerate_cuda.html"><em>Section accelerate</em></a></td>
<td>USER/cuda</td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
<td>lib/cuda</td>
</tr>
<tr class="row-odd"><td>USER-DIFFRACTION</td>
<td>virutal x-ray and electron diffraction</td>
<td>Shawn Coleman (ARL)</td>
<td><a class="reference internal" href="compute_xrd.html"><em>compute xrd</em></a></td>
<td>USER/diffraction</td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
</tr>
<tr class="row-even"><td>USER-DRUDE</td>
<td>Drude oscillators</td>
<td>Dequidt &amp; Devemy &amp; Padua (3)</td>
<td><a class="reference internal" href="tutorial_drude.html"><em>tutorial</em></a></td>
<td>USER/drude</td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
</tr>
<tr class="row-odd"><td>USER-EFF</td>
<td>electron force field</td>
<td>Andres Jaramillo-Botero (Caltech)</td>
<td><a class="reference internal" href="pair_eff.html"><em>pair_style eff/cut</em></a></td>
<td>USER/eff</td>
<td><a class="reference external" href="http://lammps.sandia.gov/movies.html#eff">eff</a></td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
</tr>
<tr class="row-even"><td>USER-FEP</td>
<td>free energy perturbation</td>
<td>Agilio Padua (U Blaise Pascal Clermont-Ferrand)</td>
<td><a class="reference internal" href="compute_fep.html"><em>compute fep</em></a></td>
<td>USER/fep</td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
</tr>
<tr class="row-odd"><td>USER-H5MD</td>
<td>dump output via HDF5</td>
<td>Pierre de Buyl (KU Leuven)</td>
<td><a class="reference internal" href="dump_h5md.html"><em>dump h5md</em></a></td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
<td>lib/h5md</td>
</tr>
<tr class="row-even"><td>USER-INTEL</td>
<td>Vectorized CPU and Intel(R) coprocessor styles</td>
<td><ol class="first last upperalpha simple" start="23">
<li>Michael Brown (Intel)</li>
</ol>
</td>
<td><a class="reference internal" href="accelerate_intel.html"><em>Section accelerate</em></a></td>
<td>examples/intel</td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
</tr>
<tr class="row-odd"><td>USER-LB</td>
<td>Lattice Boltzmann fluid</td>
<td>Colin Denniston (U Western Ontario)</td>
<td><a class="reference internal" href="fix_lb_fluid.html"><em>fix lb/fluid</em></a></td>
<td>USER/lb</td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
</tr>
<tr class="row-even"><td>USER-MGPT</td>
<td>fast MGPT multi-ion potentials</td>
<td>Tomas Oppelstrup &amp; John Moriarty (LLNL)</td>
<td><a class="reference internal" href="pair_mgpt.html"><em>pair_style mgpt</em></a></td>
<td>USER/mgpt</td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
</tr>
<tr class="row-odd"><td>USER-MISC</td>
<td>single-file contributions</td>
<td>USER-MISC/README</td>
<td>USER-MISC/README</td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
</tr>
<tr class="row-even"><td>USER-MOLFILE</td>
<td><a class="reference external" href="http://www.ks.uiuc.edu/Research/vmd">VMD</a> molfile plug-ins</td>
<td>Axel Kohlmeyer (Temple U)</td>
<td><a class="reference internal" href="dump_molfile.html"><em>dump molfile</em></a></td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
<td>VMD-MOLFILE</td>
</tr>
<tr class="row-odd"><td>USER-OMP</td>
<td>OpenMP threaded styles</td>
<td>Axel Kohlmeyer (Temple U)</td>
<td><a class="reference internal" href="accelerate_omp.html"><em>Section accelerate</em></a></td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
</tr>
<tr class="row-even"><td>USER-PHONON</td>
<td>phonon dynamical matrix</td>
<td>Ling-Ti Kong (Shanghai Jiao Tong U)</td>
<td><a class="reference internal" href="fix_phonon.html"><em>fix phonon</em></a></td>
<td>USER/phonon</td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
</tr>
<tr class="row-odd"><td>USER-QMMM</td>
<td>QM/MM coupling</td>
<td>Axel Kohlmeyer (Temple U)</td>
<td><a class="reference internal" href="fix_qmmm.html"><em>fix qmmm</em></a></td>
<td>USER/qmmm</td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
<td>lib/qmmm</td>
</tr>
<tr class="row-even"><td>USER-QTB</td>
<td>quantum nuclear effects</td>
<td>Yuan Shen (Stanford)</td>
<td><a class="reference internal" href="fix_qtb.html"><em>fix qtb</em></a> <a class="reference internal" href="fix_qbmsst.html"><em>fix_qbmsst</em></a></td>
<td>qtb</td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
</tr>
<tr class="row-odd"><td>USER-QUIP</td>
<td>QUIP/libatoms interface</td>
<td>Albert Bartok-Partay (U Cambridge)</td>
<td><a class="reference internal" href="pair_quip.html"><em>pair_style quip</em></a></td>
<td>USER/quip</td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
<td>lib/quip</td>
</tr>
<tr class="row-even"><td>USER-REAXC</td>
<td>C version of ReaxFF</td>
<td>Metin Aktulga (LBNL)</td>
<td><a class="reference internal" href="pair_reax_c.html"><em>pair_style reaxc</em></a></td>
<td>reax</td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
</tr>
<tr class="row-odd"><td>USER-SMD</td>
<td>smoothed Mach dynamics</td>
<td>Georg Ganzenmuller (EMI)</td>
<td><a class="reference external" href="PDF/SMD_LAMMPS_userguide.pdf">userguide.pdf</a></td>
<td>USER/smd</td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
</tr>
<tr class="row-even"><td>USER-SMTBQ</td>
<td>Second Moment Tight Binding - QEq potential</td>
<td>Salles &amp; Maras &amp; Politano &amp; Tetot (4)</td>
<td><a class="reference internal" href="pair_smtbq.html"><em>pair_style smtbq</em></a></td>
<td>USER/smtbq</td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
</tr>
<tr class="row-odd"><td>USER-SPH</td>
<td>smoothed particle hydrodynamics</td>
<td>Georg Ganzenmuller (EMI)</td>
<td><a class="reference external" href="PDF/SPH_LAMMPS_userguide.pdf">userguide.pdf</a></td>
<td>USER/sph</td>
<td><a class="reference external" href="http://lammps.sandia.gov/movies.html#sph">sph</a></td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
</tr>
<tr class="row-even"><td>USER-TALLY</td>
<td>Pairwise tallied computes</td>
<td>Axel Kohlmeyer (Temple U)</td>
<td><code class="xref doc docutils literal"><span class="pre">compute</span></code></td>
<td>USER/tally</td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
<td><ul class="first last simple">
<li></li>
</ul>
</td>
</tr>
<tr class="row-odd"><td>&nbsp;</td>
<td>&nbsp;</td>
<td>&nbsp;</td>
<td>&nbsp;</td>
<td>&nbsp;</td>
<td>&nbsp;</td>
<td>&nbsp;</td>
</tr>
</tbody>
</table>
<p>The &#8220;Authors&#8221; column lists a name(s) if a specific person is
responible for creating and maintaining the package.</p>
<p>(1) The ATC package was created by Reese Jones, Jeremy Templeton, and
Jon Zimmerman (Sandia).</p>
<p>(2) The COLVARS package was created by Axel Kohlmeyer (Temple U) using
the colvars module library written by Giacomo Fiorin (Temple U) and
Jerome Henin (LISM, Marseille, France).</p>
<p>(3) The DRUDE package was created by Alain Dequidt (U Blaise Pascal
Clermont-Ferrand) and co-authors Julien Devemy (CNRS) and Agilio Padua
(U Blaise Pascal).</p>
<p>(4) The SMTBQ package was created by Nicolas Salles, Emile Maras,
Olivier Politano, and Robert Tetot (LAAS-CNRS, France).</p>
<p>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
library from.</p>
<p>The &#8220;Doc page&#8221; column links to either a portion of the
<a class="reference internal" href="Section_howto.html"><em>Section_howto</em></a> of the manual, or an input script
command implemented as part of the package, or to additional
documentation provided within the package.</p>
<p>The &#8220;Example&#8221; column is a sub-directory in the examples directory of
the distribution which has an input script that uses the package.
E.g. &#8220;peptide&#8221; refers to the examples/peptide directory. USER/cuda
refers to the examples/USER/cuda directory.</p>
<p>The &#8220;Library&#8221; column lists an external library which must be built
first and which LAMMPS links to when it is built. If it is listed as
lib/package, then the code for the library is under the lib directory
of the LAMMPS distribution. See the lib/package/README file for info
on how to build the library. If it 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 library. <a class="reference internal" href="Section_start.html#start-3-3"><span>Section start</span></a> of the
manual also gives details on how to build LAMMPS with both kinds of
auxiliary libraries.</p>
<p>Except where explained below, all of these packages can be installed,
and LAMMPS re-built, by issuing these commands from the src dir.</p>
<div class="highlight-python"><div class="highlight"><pre>make yes-user-package
make machine
or
Make.py -p package -a machine
</pre></div>
</div>
<p>To un-install the package and re-build LAMMPS without it:</p>
<div class="highlight-python"><div class="highlight"><pre>make no-user-package
make machine
or
Make.py -p ^package -a machine
</pre></div>
</div>
<p>&#8220;Package&#8221; is the name of the package (in this case without the user
prefix) in lower-case letters, e.g. drude or phonon, and &#8220;machine&#8221; is
the build target, e.g. mpi or serial.</p>
</div>
<div class="section" id="user-atc-package">
<h2>4.14. USER-ATC package<a class="headerlink" href="#user-atc-package" title="Permalink to this headline"></a></h2>
<p>This package implements a &#8220;fix atc&#8221; 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.</p>
<p>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.</p>
<p>There are example scripts for using this package in examples/USER/atc.</p>
<p>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.</p>
<p>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.</p>
</div>
<hr class="docutils" />
<div class="section" id="user-awpmd-package">
<h2>4.15. USER-AWPMD package<a class="headerlink" href="#user-awpmd-package" title="Permalink to this headline"></a></h2>
<p>This package contains a LAMMPS implementation of the Antisymmetrized
Wave Packet Molecular Dynamics (AWPMD) method.</p>
<p>See the doc page for the pair_style awpmd/cut command to get started.</p>
<p>There are example scripts for using this package in examples/USER/awpmd.</p>
<p>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.</p>
<p>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.</p>
</div>
<hr class="docutils" />
<div class="section" id="user-cg-cmm-package">
<h2>4.16. USER-CG-CMM package<a class="headerlink" href="#user-cg-cmm-package" title="Permalink to this headline"></a></h2>
<p>This package implements 3 commands which can be used in a LAMMPS input
script:</p>
<ul class="simple">
<li>pair_style lj/sdk</li>
<li>pair_style lj/sdk/coul/long</li>
<li>angle_style sdk</li>
</ul>
<p>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.</p>
<p>See the doc pages for these commands for details.</p>
<p>There are example scripts for using this package in
examples/USER/cg-cmm.</p>
<p>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.</p>
<p>The current version of this package should be considered beta
quality. The CG potentials work correctly for &#8220;normal&#8221; situations, but
have not been testing with all kinds of potential parameters and
simulation systems.</p>
<p>The person who created this package is Axel Kohlmeyer at Temple U
(akohlmey at gmail.com). Contact him directly if you have questions.</p>
</div>
<hr class="docutils" />
<div class="section" id="user-colvars-package">
<h2>4.17. USER-COLVARS package<a class="headerlink" href="#user-colvars-package" title="Permalink to this headline"></a></h2>
<p>This package implements the &#8220;fix colvars&#8221; command which can be
used in a LAMMPS input script.</p>
<p>This fix allows to use &#8220;collective variables&#8221; to implement
Adaptive Biasing Force, Metadynamics, Steered MD, Umbrella
Sampling and Restraints. This code consists of two parts:</p>
<ul class="simple">
<li>A portable collective variable module library written and maintained</li>
<li>by Giacomo Fiorin (ICMS, Temple University, Philadelphia, PA, USA) and</li>
<li>Jerome Henin (LISM, CNRS, Marseille, France). This code is located in</li>
<li>the directory lib/colvars and needs to be compiled first. The colvars</li>
<li>fix and an interface layer, exchanges information between LAMMPS and</li>
<li>the collective variable module.</li>
</ul>
<p>See the doc page of <a class="reference internal" href="fix_colvars.html"><em>fix colvars</em></a> for more details.</p>
<p>There are example scripts for using this package in
examples/USER/colvars</p>
<p>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.</p>
<p>The person who created this package is Axel Kohlmeyer at Temple U
(akohlmey at gmail.com). Contact him directly if you have questions.</p>
</div>
<hr class="docutils" />
<div class="section" id="user-cuda-package">
<h2>4.18. USER-CUDA package<a class="headerlink" href="#user-cuda-package" title="Permalink to this headline"></a></h2>
<p>This package provides acceleration of various LAMMPS pair styles, fix
styles, compute styles, and long-range Coulombics via PPPM for NVIDIA
GPUs.</p>
<p>See this section of the manual to get started:</p>
<p><span class="xref std std-ref">Section_accelerate</span></p>
<p>There are example scripts for using this package in
examples/USER/cuda.</p>
<p>This package uses an external library in lib/cuda which must be
compiled before making LAMMPS. See the lib/cuda/README file and the
LAMMPS manual for information on building LAMMPS with external
libraries.</p>
<p>The person who created this package is Christian Trott at the
University of Technology Ilmenau, Germany (christian.trott at
tu-ilmenau.de). Contact him directly if you have questions.</p>
</div>
<hr class="docutils" />
<div class="section" id="user-diffraction-package">
<h2>4.19. USER-DIFFRACTION package<a class="headerlink" href="#user-diffraction-package" title="Permalink to this headline"></a></h2>
<p>This package contains the commands neeed to calculate x-ray and
electron diffraction intensities based on kinematic diffraction
theory.</p>
<p>See these doc pages and their related commands to get started:</p>
<ul class="simple">
<li><a class="reference internal" href="compute_xrd.html"><em>compute xrd</em></a></li>
<li><a class="reference internal" href="compute_saed.html"><em>compute saed</em></a></li>
<li><a class="reference internal" href="fix_saed_vtk.html"><em>fix saed/vtk</em></a></li>
</ul>
<p>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.</p>
</div>
<hr class="docutils" />
<div class="section" id="user-drude-package">
<h2>4.20. USER-DRUDE package<a class="headerlink" href="#user-drude-package" title="Permalink to this headline"></a></h2>
<p>This package implements methods for simulating polarizable systems
in LAMMPS using thermalized Drude oscillators.</p>
<p>See these doc pages and their related commands to get started:</p>
<ul class="simple">
<li><a class="reference internal" href="tutorial_drude.html"><em>Drude tutorial</em></a></li>
<li><a class="reference internal" href="fix_drude.html"><em>fix drude</em></a></li>
<li><a class="reference internal" href="compute_temp_drude.html"><em>compute temp/drude</em></a></li>
<li><a class="reference internal" href="fix_langevin_drude.html"><em>fix langevin/drude</em></a></li>
<li><a class="reference internal" href="fix_drude_transform.html"><em>fix drude/transform/...</em></a></li>
<li><a class="reference internal" href="pair_thole.html"><em>pair thole</em></a></li>
</ul>
<p>There are auxiliary tools for using this package in tools/drude.</p>
<p>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.</p>
</div>
<hr class="docutils" />
<div class="section" id="user-eff-package">
<h2>4.21. USER-EFF package<a class="headerlink" href="#user-eff-package" title="Permalink to this headline"></a></h2>
<p>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.</p>
<p>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.</p>
<p>The necessary customizations to the LAMMPS core are in place to
enable the correct handling of explicit electron properties during
minimization and dynamics.</p>
<p>See the doc page for the pair_style eff/cut command to get started.</p>
<p>There are example scripts for using this package in
examples/USER/eff.</p>
<p>There are auxiliary tools for using this package in tools/eff.</p>
<p>The person who created this package is Andres Jaramillo-Botero at
CalTech (ajaramil at wag.caltech.edu). Contact him directly if you
have questions.</p>
</div>
<hr class="docutils" />
<div class="section" id="user-fep-package">
<h2>4.22. USER-FEP package<a class="headerlink" href="#user-fep-package" title="Permalink to this headline"></a></h2>
<p>This package provides methods for performing free energy perturbation
simulations with soft-core pair potentials in LAMMPS.</p>
<p>See these doc pages and their related commands to get started:</p>
<ul class="simple">
<li><a class="reference internal" href="fix_adapt_fep.html"><em>fix adapt/fep</em></a></li>
<li><a class="reference internal" href="compute_fep.html"><em>compute fep</em></a></li>
<li><a class="reference internal" href="pair_lj_soft.html"><em>soft pair styles</em></a></li>
</ul>
<p>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.</p>
</div>
<hr class="docutils" />
<div class="section" id="user-h5md-package">
<h2>4.23. USER-H5MD package<a class="headerlink" href="#user-h5md-package" title="Permalink to this headline"></a></h2>
<p>This package contains a <a class="reference internal" href="dump_h5md.html"><em>dump h5md</em></a> command for
performing a dump of atom properties in HDF5 format. <a class="reference external" href="http://www.hdfgroup.org/HDF5/">HDF5 files</a> 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 <code class="xref doc docutils literal"><span class="pre">dump</span> <span class="pre">h5md</span></code> command gives a
citation to a paper describing the format.</p>
<p>The person who created this package and the underlying H5MD format is
Pierre de Buyl at KU Leuven (see <a class="reference external" href="http://pdebuyl.be">http://pdebuyl.be</a>). Contact him
directly if you have questions.</p>
</div>
<hr class="docutils" />
<div class="section" id="user-intel-package">
<h2>4.24. USER-INTEL package<a class="headerlink" href="#user-intel-package" title="Permalink to this headline"></a></h2>
<p>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.</p>
<p>See this section of the manual to get started:</p>
<p><span class="xref std std-ref">Section_accelerate</span></p>
<p>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.</p>
</div>
<hr class="docutils" />
<div class="section" id="user-lb-package">
<h2>4.25. USER-LB package<a class="headerlink" href="#user-lb-package" title="Permalink to this headline"></a></h2>
<p>This package contains a LAMMPS implementation of a background
Lattice-Boltzmann fluid, which can be used to model MD particles
influenced by hydrodynamic forces.</p>
<p>See this doc page and its related commands to get started:</p>
<p><a class="reference internal" href="fix_lb_fluid.html"><em>fix lb/fluid</em></a></p>
<p>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.</p>
</div>
<hr class="docutils" />
<div class="section" id="user-mgpt-package">
<h2>4.26. USER-MGPT package<a class="headerlink" href="#user-mgpt-package" title="Permalink to this headline"></a></h2>
<p>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
theory (GPT) through a series of systematic approximations valid for
mid-period transition metals with nearly half-filled d bands. The
MGPT method was originally developed by John Moriarty at Lawrence
Livermore National Lab (LLNL).</p>
<p>In the general matrix representation of MGPT, which can also be
applied to f-band actinide metals, the multi-ion potentials are
evaluated on the fly during a simulation through d- or f-state matrix
multiplication, and the forces that move the ions are determined
analytically. The <em>mgpt</em> pair style in this package calculates forces
and energies using an optimized matrix-MGPT algorithm due to Tomas
Oppelstrup at LLNL.</p>
<p>See this doc page to get started:</p>
<p><a class="reference internal" href="pair_mgpt.html"><em>pair_style mgpt</em></a></p>
<p>The persons who created the USER-MGPT package are Tomas Oppelstrup
(<a class="reference external" href="mailto:oppelstrup2&#37;&#52;&#48;llnl&#46;gov">oppelstrup2<span>&#64;</span>llnl<span>&#46;</span>gov</a>) and John Moriarty (<a class="reference external" href="mailto:moriarty2&#37;&#52;&#48;llnl&#46;gov">moriarty2<span>&#64;</span>llnl<span>&#46;</span>gov</a>)
Contact them directly if you have any questions.</p>
</div>
<hr class="docutils" />
<div class="section" id="user-misc-package">
<h2>4.27. USER-MISC package<a class="headerlink" href="#user-misc-package" title="Permalink to this headline"></a></h2>
<p>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 (<a href="#id2"><span class="problematic" id="id3">*</span></a>.cpp and <a href="#id4"><span class="problematic" id="id5">*</span></a>.h).</p>
<p>More information about each feature can be found by reading its doc
page in the LAMMPS doc directory. The doc page which lists all LAMMPS
input script commands is as follows:</p>
<p><a class="reference internal" href="Section_commands.html#cmd-5"><span>Section_commands</span></a></p>
<p>User-contributed features are listed at the bottom of the fix,
compute, pair, etc sections.</p>
<p>The list of features and author of each is given in the
src/USER-MISC/README file.</p>
<p>You should contact the author directly if you have specific questions
about the feature or its coding.</p>
</div>
<hr class="docutils" />
<div class="section" id="user-molfile-package">
<h2>4.28. USER-MOLFILE package<a class="headerlink" href="#user-molfile-package" title="Permalink to this headline"></a></h2>
<p>This package contains a dump molfile command which uses molfile
plugins that are bundled with the
<a class="reference external" href="http://www.ks.uiuc.edu/Research/vmd">VMD</a> molecular visualization and
analysis program, to enable LAMMPS to dump its information in formats
compatible with various molecular simulation tools.</p>
<p>The package only provides the interface code, not the plugins. These
can be obtained from a VMD installation which has to match the
platform that you are using to compile LAMMPS for. By adding plugins
to VMD, support for new file formats can be added to LAMMPS (or VMD or
other programs that use them) without having to recompile the
application itself.</p>
<p>See this doc page to get started:</p>
<p><span class="xref std std-ref">dump molfile</span></p>
<p>The person who created this package is Axel Kohlmeyer at Temple U
(akohlmey at gmail.com). Contact him directly if you have questions.</p>
</div>
<hr class="docutils" />
<div class="section" id="user-omp-package">
<h2>4.29. USER-OMP package<a class="headerlink" href="#user-omp-package" title="Permalink to this headline"></a></h2>
<p>This package provides OpenMP multi-threading support and
other optimizations of various LAMMPS pair styles, dihedral
styles, and fix styles.</p>
<p>See this section of the manual to get started:</p>
<p><span class="xref std std-ref">Section_accelerate</span></p>
<p>The person who created this package is Axel Kohlmeyer at Temple U
(akohlmey at gmail.com). Contact him directly if you have questions.</p>
</div>
<hr class="docutils" />
<div class="section" id="user-phonon-package">
<h2>4.30. USER-PHONON package<a class="headerlink" href="#user-phonon-package" title="Permalink to this headline"></a></h2>
<p>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.</p>
<p>See this doc page to get started:</p>
<p><a class="reference internal" href="fix_phonon.html"><em>fix phonon</em></a></p>
<p>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.</p>
</div>
<hr class="docutils" />
<div class="section" id="user-qmmm-package">
<h2>4.31. USER-QMMM package<a class="headerlink" href="#user-qmmm-package" title="Permalink to this headline"></a></h2>
<p>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 <a class="reference external" href="http://www.quantum-espresso.org">Quantum ESPRESSO</a> package.</p>
<p>The current implementation only supports an ONIOM style mechanical
coupling to the Quantum ESPRESSO plane wave DFT package.
Electrostatic coupling is in preparation and the interface has been
written in a manner that coupling to other QM codes should be possible
without changes to LAMMPS itself.</p>
<p>See this doc page to get started:</p>
<p><a class="reference internal" href="fix_qmmm.html"><em>fix qmmm</em></a></p>
<p>as well as the lib/qmmm/README file.</p>
<p>The person who created this package is Axel Kohlmeyer at Temple U
(akohlmey at gmail.com). Contact him directly if you have questions.</p>
</div>
<hr class="docutils" />
<div class="section" id="user-qtb-package">
<h2>4.32. USER-QTB package<a class="headerlink" href="#user-qtb-package" title="Permalink to this headline"></a></h2>
<p>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
point energy into the system, alter the energy power spectrum and the
heat capacity towards their quantum nature. This package could be of
interest if one wants to model systems at temperatures lower than
their classical limits or when temperatures ramp up across the
classical limits in the simulation.</p>
<p>See these two doc pages to get started:</p>
<p><a class="reference internal" href="fix_qtb.html"><em>fix qtb</em></a> provides quantum nulcear correction through a
colored thermostat and can be used with other time integration schemes
like <a class="reference internal" href="fix_nve.html"><em>fix nve</em></a> or <a class="reference internal" href="fix_nh.html"><em>fix nph</em></a>.</p>
<p><a class="reference internal" href="fix_qbmsst.html"><em>fix qbmsst</em></a> enables quantum nuclear correction of a
multi-scale shock technique simulation by coupling the quantum thermal
bath with the shocked system.</p>
<p>The person who created this package is Yuan Shen (sy0302 at
stanford.edu) at Stanford University. Contact him directly if you
have questions.</p>
</div>
<hr class="docutils" />
<div class="section" id="user-reaxc-package">
<h2>4.33. USER-REAXC package<a class="headerlink" href="#user-reaxc-package" title="Permalink to this headline"></a></h2>
<p>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
energy. It was originally developed by Adri van Duin and the Goddard
group at CalTech.</p>
<p>The USER-REAXC version of ReaxFF (pair_style reax/c), implemented in
C, should give identical or very similar results to pair_style reax,
which is a ReaxFF implementation on top of a Fortran library, a
version of which library was originally authored by Adri van Duin.</p>
<p>The reax/c version should be somewhat faster and more scalable,
particularly with respect to the charge equilibration calculation. It
should also be easier to build and use since there are no complicating
issues with Fortran memory allocation or linking to a Fortran library.</p>
<p>For technical details about this implemention of ReaxFF, see
this paper:</p>
<p>Parallel and Scalable Reactive Molecular Dynamics: Numerical Methods
and Algorithmic Techniques, H. M. Aktulga, J. C. Fogarty,
S. A. Pandit, A. Y. Grama, Parallel Computing, in press (2011).</p>
<p>See the doc page for the pair_style reax/c command for details
of how to use it in LAMMPS.</p>
<p>The person who created this package is Hasan Metin Aktulga (hmaktulga
at lbl.gov), while at Purdue University. Contact him directly, or
Aidan Thompson at Sandia (athomps at sandia.gov), if you have
questions.</p>
</div>
<hr class="docutils" />
<div class="section" id="user-smd-package">
<h2>4.34. USER-SMD package<a class="headerlink" href="#user-smd-package" title="Permalink to this headline"></a></h2>
<p>This package implements smoothed Mach dynamics (SMD) in
LAMMPS. Currently, the package has the following features:</p>
<ul class="simple">
<li>Does liquids via traditional Smooth Particle Hydrodynamics (SPH)</li>
<li>Also solves solids mechanics problems via a state of the art
stabilized meshless method with hourglass control.</li>
<li>Can specify hydrostatic interactions independently from material
strength models, i.e. pressure and deviatoric stresses are separated.</li>
<li>Many material models available (Johnson-Cook, plasticity with
hardening, Mie-Grueneisen, Polynomial EOS). Easy to add new
material models.</li>
<li>Rigid boundary conditions (walls) can be loaded as surface geometries
from <a href="#id7"><span class="problematic" id="id8">*</span></a>.STL files.</li>
</ul>
<p>See the file doc/PDF/SMD_LAMMPS_userguide.pdf to get started.</p>
<p>There are example scripts for using this package in examples/USER/smd.</p>
<p>The person who created this package is Georg Ganzenmuller at the
Fraunhofer-Institute for High-Speed Dynamics, Ernst Mach Institute in
Germany (georg.ganzenmueller at emi.fhg.de). Contact him directly if
you have questions.</p>
</div>
<hr class="docutils" />
<div class="section" id="user-smtbq-package">
<h2>4.35. USER-SMTBQ package<a class="headerlink" href="#user-smtbq-package" title="Permalink to this headline"></a></h2>
<p>This package implements the Second Moment Tight Binding - QEq (SMTB-Q)
potential for the description of ionocovalent bonds in oxides.</p>
<p>There are example scripts for using this package in
examples/USER/smtbq.</p>
<p>See this doc page to get started:</p>
<p><a class="reference internal" href="pair_smtbq.html"><em>pair_style smtbq</em></a></p>
<p>The persons who created the USER-SMTBQ package are Nicolas Salles,
Emile Maras, Olivier Politano, Robert Tetot, who can be contacted at
these email addreses: <a class="reference external" href="mailto:lammps&#37;&#52;&#48;u-bourgogne&#46;fr">lammps<span>&#64;</span>u-bourgogne<span>&#46;</span>fr</a>, <a class="reference external" href="mailto:nsalles&#37;&#52;&#48;laas&#46;fr">nsalles<span>&#64;</span>laas<span>&#46;</span>fr</a>. Contact
them directly if you have any questions.</p>
</div>
<hr class="docutils" />
<div class="section" id="user-sph-package">
<h2>4.36. USER-SPH package<a class="headerlink" href="#user-sph-package" title="Permalink to this headline"></a></h2>
<p>This package implements smoothed particle hydrodynamics (SPH) in
LAMMPS. Currently, the package has the following features:</p>
<ul class="simple">
<li>Tait, ideal gas, Lennard-Jones equation of states, full support for
complete (i.e. internal-energy dependent) equations of state</li>
<li>Plain or Monaghans XSPH integration of the equations of motion</li>
<li>Density continuity or density summation to propagate the density field</li>
<li>Commands to set internal energy and density of particles from the
input script</li>
<li>Output commands to access internal energy and density for dumping and
thermo output</li>
</ul>
<p>See the file doc/PDF/SPH_LAMMPS_userguide.pdf to get started.</p>
<p>There are example scripts for using this package in examples/USER/sph.</p>
<p>The person who created this package is Georg Ganzenmuller at the
Fraunhofer-Institute for High-Speed Dynamics, Ernst Mach Institute in
Germany (georg.ganzenmueller at emi.fhg.de). Contact him directly if
you have questions.</p>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="Section_accelerate.html" class="btn btn-neutral float-right" title="5. Accelerating LAMMPS performance" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="Section_commands.html" class="btn btn-neutral" title="3. Commands" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright .
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'15 May 2015 version',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script type="text/javascript" src="_static/sphinxcontrib-images/LightBox2/lightbox2/js/jquery-1.11.0.min.js"></script>
<script type="text/javascript" src="_static/sphinxcontrib-images/LightBox2/lightbox2/js/lightbox.min.js"></script>
<script type="text/javascript" src="_static/sphinxcontrib-images/LightBox2/lightbox2-customize/jquery-noconflict.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink