Compare commits
225 Commits
patch_12Oc
...
patch_17No
| Author | SHA1 | Date | |
|---|---|---|---|
| 4b51719e67 | |||
| 25d7be5f3d | |||
| 74c0e4dd5c | |||
| 073e8a0524 | |||
| 5320bbf585 | |||
| 4448819824 | |||
| 300ac30332 | |||
| 2535e44991 | |||
| cdae794383 | |||
| 8756a1017d | |||
| 22d93fe8fb | |||
| 57124b9b25 | |||
| 03b3834fe3 | |||
| d0124eac95 | |||
| 5685131fe2 | |||
| 22fc92f9d8 | |||
| b9770766a8 | |||
| 9cc0c8badd | |||
| 6e1492a86c | |||
| 9b0987d8c4 | |||
| e453adaf81 | |||
| 8e0fd88697 | |||
| fdcabd7d1d | |||
| c5c8c50e97 | |||
| 72b0841b28 | |||
| 801111a7ab | |||
| bfc478c320 | |||
| 2b75ee761d | |||
| 352e177fcd | |||
| c20ee34c7b | |||
| 95a7f7160e | |||
| 1f38e1a771 | |||
| 9806da69f3 | |||
| fec87c070d | |||
| 3d3a99c082 | |||
| 3e36ec3754 | |||
| 9ed5c4f0fa | |||
| c55fd502e0 | |||
| 71ee2ecaa1 | |||
| bfea3dce7d | |||
| eef862ee1c | |||
| 0cc2fbf1d6 | |||
| ae00666994 | |||
| 51b3b5fb35 | |||
| 176f2c3aa1 | |||
| 3f71bfb185 | |||
| cf3ab51679 | |||
| 59922f894b | |||
| 5e2b9d8bf3 | |||
| 2d132cad6b | |||
| ef6801f8bf | |||
| c81a723642 | |||
| f9eb2a99ce | |||
| 16a02ef27d | |||
| 2c801320c2 | |||
| d20b32092e | |||
| 9de1a2a08f | |||
| cdb5d47e9f | |||
| a23b287a7a | |||
| 31204aab6a | |||
| 25e7d074cf | |||
| 667f4dfe28 | |||
| 21694ca3a8 | |||
| 9b910d5511 | |||
| 054ab6bff3 | |||
| 616420cda8 | |||
| fb3ac9afba | |||
| 7cd7cda2d4 | |||
| db0524278a | |||
| 1ff75eaba2 | |||
| 30dede867a | |||
| a5c6104d64 | |||
| c5869bdee2 | |||
| e7a2c6b5d1 | |||
| 06959a9c59 | |||
| cd65d44d95 | |||
| 45f2e86dd6 | |||
| f8226e8ae5 | |||
| b221b15d24 | |||
| 3a3d96b877 | |||
| 77bbf03f0f | |||
| 7cff08ca0a | |||
| f0131393e0 | |||
| 32e0a58343 | |||
| 60908eeab4 | |||
| 8214555b29 | |||
| f48b71f46b | |||
| 6cc4eb19af | |||
| 7d23a0737e | |||
| 02510ec321 | |||
| 33140e5004 | |||
| 639fb6f444 | |||
| b156771721 | |||
| 5d787f7f16 | |||
| c8f4b55588 | |||
| e13e4031cf | |||
| 782a328080 | |||
| e81ae21dbd | |||
| 7fdd6e2807 | |||
| 2e0d304c7e | |||
| f333d659c2 | |||
| 51e2313fac | |||
| e37d2b5c94 | |||
| c4b86a25a7 | |||
| 218e121b41 | |||
| 93d393aa69 | |||
| 4216be49f3 | |||
| 3870780894 | |||
| c3a1e72183 | |||
| d9891abdf4 | |||
| f9a9e27f5a | |||
| 35753b8f08 | |||
| f028a9a967 | |||
| ef9f7c818e | |||
| 8e61bed2d8 | |||
| 3267b34590 | |||
| 0a417b4016 | |||
| 399c0af150 | |||
| e8b3f79690 | |||
| 21619f6a2f | |||
| 039bda9b61 | |||
| 6929603eef | |||
| 7f3f5e8c38 | |||
| f350500e69 | |||
| d7c77a419d | |||
| efaa8feab5 | |||
| ad5f7c4581 | |||
| 6b33499135 | |||
| 63eada2425 | |||
| 1a436bd7a9 | |||
| 52dd9aee5f | |||
| eca96e21ef | |||
| 9c81ad1ab6 | |||
| f8367e3d0f | |||
| ba6d1528bb | |||
| 182141b850 | |||
| 512c413b7e | |||
| 7b89e47a38 | |||
| e02505c8cc | |||
| be2d155cef | |||
| c243093980 | |||
| ad57a17f48 | |||
| 477ddaf112 | |||
| 4f69d91a99 | |||
| bc44988003 | |||
| db36c8bcc3 | |||
| 991034b632 | |||
| 607246f923 | |||
| 6742fb634a | |||
| ed3f02f249 | |||
| a2e34aab0a | |||
| 6cd6c106ef | |||
| a9572275ee | |||
| 2cf77ff778 | |||
| f022f6d88a | |||
| 8c3f5cb307 | |||
| e8359923f1 | |||
| d2da0fabb4 | |||
| 9954d5d346 | |||
| 3d254780de | |||
| b0cf1ded38 | |||
| 0891ed83a5 | |||
| ffb8eb36da | |||
| 1a10857244 | |||
| 2634468676 | |||
| 58141e0559 | |||
| 393337e7cf | |||
| e0ed218cc4 | |||
| efc7b23bd8 | |||
| 566effc9c9 | |||
| 86f5b51133 | |||
| ccca642b3a | |||
| 019bc0ba0b | |||
| 7b7cb297e6 | |||
| 13ce1037f2 | |||
| 5a6dea7a22 | |||
| 27796b431e | |||
| 2106dce2b3 | |||
| 6e54443d8c | |||
| 2b47fa6653 | |||
| 713b2af067 | |||
| ae77664bdd | |||
| 4502d3276b | |||
| a752966eef | |||
| 1f7693faf2 | |||
| 2c5ea9fc61 | |||
| 3e88fb5355 | |||
| 6eadd45c45 | |||
| 003581c6a8 | |||
| 1f1c87235a | |||
| 394c3bb504 | |||
| 954d536826 | |||
| c5513c4f75 | |||
| e4ff8128f1 | |||
| e7825ba21a | |||
| e77e1f6b8e | |||
| 909ec2c096 | |||
| f67975fd8a | |||
| deceb9d5c6 | |||
| c9c66ca0bd | |||
| d07703efff | |||
| 411ecca8df | |||
| fa984b2c3b | |||
| d11363c7eb | |||
| 5aefb2a882 | |||
| 40f2310a2a | |||
| 2c8a7a318a | |||
| 95cca1bd9f | |||
| 0b426dadc1 | |||
| fcb5271026 | |||
| 4958e114ba | |||
| 2e8edbd2b9 | |||
| da66c1e649 | |||
| e10ea91c5f | |||
| 69cb831705 | |||
| ecb03dd2df | |||
| 8540a9f038 | |||
| 13b6eb1bae | |||
| d80a9def17 | |||
| be4734bdce | |||
| 2551619b07 | |||
| d8bf149edc | |||
| 473b12ded4 | |||
| 27c3149590 | |||
| 3b408d71fe |
4
doc/.gitignore
vendored
@ -1 +1,5 @@
|
||||
/html
|
||||
/LAMMPS.epub
|
||||
/LAMMPS.mobi
|
||||
/Manual.pdf
|
||||
/Developer.pdf
|
||||
|
||||
29
doc/Makefile
@ -8,19 +8,21 @@ VENV = $(BUILDDIR)/docenv
|
||||
TXT2RST = $(VENV)/bin/txt2rst
|
||||
|
||||
PYTHON = $(shell which python3)
|
||||
HAS_PYTHON3 = NO
|
||||
HAS_VIRTUALENV = NO
|
||||
|
||||
ifeq ($(shell which python3 >/dev/null 2>&1; echo $$?), 1)
|
||||
$(error Python3 was not found! Please check README.md for further instructions)
|
||||
ifeq ($(shell which python3 >/dev/null 2>&1; echo $$?), 0)
|
||||
HAS_PYTHON3 = YES
|
||||
endif
|
||||
|
||||
ifeq ($(shell which virtualenv >/dev/null 2>&1; echo $$?), 1)
|
||||
$(error virtualenv was not found! Please check README.md for further instructions)
|
||||
ifeq ($(shell which virtualenv >/dev/null 2>&1; echo $$?), 0)
|
||||
HAS_VIRTUALENV = YES
|
||||
endif
|
||||
|
||||
SOURCES=$(wildcard src/*.txt)
|
||||
OBJECTS=$(SOURCES:src/%.txt=$(RSTDIR)/%.rst)
|
||||
|
||||
.PHONY: help clean-all clean html pdf old venv
|
||||
.PHONY: help clean-all clean epub html pdf old venv
|
||||
|
||||
# ------------------------------------------
|
||||
|
||||
@ -30,6 +32,7 @@ help:
|
||||
@echo " pdf create Manual.pdf and Developer.pdf in this dir"
|
||||
@echo " old create old-style HTML doc pages in old dir"
|
||||
@echo " fetch fetch HTML and PDF files from LAMMPS web site"
|
||||
@echo " epub create ePUB format manual for e-book readers"
|
||||
@echo " clean remove all intermediate RST files"
|
||||
@echo " clean-all reset the entire build environment"
|
||||
@echo " txt2html build txt2html tool"
|
||||
@ -61,6 +64,20 @@ html: $(OBJECTS)
|
||||
@rm -rf html/USER/*/*.[sg]*
|
||||
@echo "Build finished. The HTML pages are in doc/html."
|
||||
|
||||
epub: $(OBJECTS)
|
||||
@mkdir -p epub
|
||||
@rm -f LAMMPS.epub
|
||||
@cp src/JPG/lammps-logo.png epub/
|
||||
@(\
|
||||
. $(VENV)/bin/activate ;\
|
||||
cp -r src/* $(RSTDIR)/ ;\
|
||||
sphinx-build -j 8 -b epub -c utils/sphinx-config -d $(BUILDDIR)/doctrees $(RSTDIR) epub ;\
|
||||
deactivate ;\
|
||||
)
|
||||
@mv epub/LAMMPS.epub .
|
||||
@rm -rf epub
|
||||
@echo "Build finished. The ePUB manual file is created."
|
||||
|
||||
pdf: utils/txt2html/txt2html.exe
|
||||
@(\
|
||||
cd src; \
|
||||
@ -109,6 +126,8 @@ $(RSTDIR)/%.rst : src/%.txt $(TXT2RST)
|
||||
)
|
||||
|
||||
$(VENV):
|
||||
@if [ "$(HAS_PYTHON3)" == "NO" ] ; then echo "Python3 was not found! Please check README.md for further instructions" 1>&2; exit 1; fi
|
||||
@if [ "$(HAS_VIRTUALENV)" == "NO" ] ; then echo "virtualenv was not found! Please check README.md for further instructions" 1>&2; exit 1; fi
|
||||
@( \
|
||||
virtualenv -p $(PYTHON) $(VENV); \
|
||||
. $(VENV)/bin/activate; \
|
||||
|
||||
21
doc/README
@ -1,13 +1,14 @@
|
||||
LAMMPS Documentation
|
||||
|
||||
Depending on how you obtained LAMMPS, this directory has 2 or 3
|
||||
sub-directories and optionally 2 PDF files:
|
||||
sub-directories and optionally 2 PDF files and an ePUB file:
|
||||
|
||||
src content files for LAMMPS documentation
|
||||
html HTML version of the LAMMPS manual (see html/Manual.html)
|
||||
tools tools and settings for building the documentation
|
||||
Manual.pdf large PDF version of entire manual
|
||||
Developer.pdf small PDF with info about how LAMMPS is structured
|
||||
LAMMPS.epub Manual in ePUB format
|
||||
|
||||
If you downloaded LAMMPS as a tarball from the web site, all these
|
||||
directories and files should be included.
|
||||
@ -49,6 +50,7 @@ make pdf # generate 2 PDF files (Manual.pdf,Developer.pdf)
|
||||
make old # generate old-style HTML pages in old dir via txt2html
|
||||
make fetch # fetch HTML doc pages and 2 PDF files from web site
|
||||
# as a tarball and unpack into html dir and 2 PDFs
|
||||
make epub # generate LAMMPS.epub in ePUB format using Sphinx
|
||||
make clean # remove intermediate RST files created by HTML build
|
||||
make clean-all # remove entire build folder and any cached data
|
||||
|
||||
@ -92,5 +94,22 @@ This will install virtualenv from the Python Package Index.
|
||||
|
||||
Installing prerequisites for PDF build
|
||||
|
||||
[TBA]
|
||||
|
||||
----------------
|
||||
|
||||
Installing prerequisites for epub build
|
||||
|
||||
## ePUB
|
||||
|
||||
Same as for HTML. This uses the same tools and configuration
|
||||
files as the HTML tree.
|
||||
|
||||
For converting the generated ePUB file to a mobi format file
|
||||
(for e-book readers like Kindle, that cannot read ePUB), you
|
||||
also need to have the 'ebook-convert' tool from the "calibre"
|
||||
software installed. http://calibre-ebook.com/
|
||||
You first create the ePUB file with 'make epub' and then do:
|
||||
|
||||
ebook-convert LAMMPS.epub LAMMPS.mobi
|
||||
|
||||
|
||||
BIN
doc/src/Eqs/pair_agni.jpg
Normal file
|
After Width: | Height: | Size: 15 KiB |
BIN
doc/src/Eqs/pair_tersoff_mod_c.jpg
Normal file
|
After Width: | Height: | Size: 4.1 KiB |
10
doc/src/Eqs/pair_tersoff_mod_c.tex
Normal file
@ -0,0 +1,10 @@
|
||||
\documentclass[12pt]{article}
|
||||
\pagestyle{empty}
|
||||
|
||||
\begin{document}
|
||||
|
||||
\begin{eqnarray*}
|
||||
V_{ij} & = & f_C(r_{ij}) \left[ f_R(r_{ij}) + b_{ij} f_A(r_{ij}) + c_0 \right]
|
||||
\end{eqnarray*}
|
||||
|
||||
\end{document}
|
||||
|
Before Width: | Height: | Size: 4.0 KiB After Width: | Height: | Size: 4.2 KiB |
@ -3,7 +3,7 @@
|
||||
\begin{document}
|
||||
|
||||
$$
|
||||
P = \frac{N k_B T}{V} + \frac{\sum_{i}^{N} r_i \bullet f_i}{dV}
|
||||
P = \frac{N k_B T}{V} + \frac{\sum_{i}^{N'} r_i \bullet f_i}{dV}
|
||||
$$
|
||||
|
||||
\end{document}
|
||||
|
Before Width: | Height: | Size: 4.9 KiB After Width: | Height: | Size: 5.3 KiB |
@ -4,7 +4,7 @@
|
||||
|
||||
$$
|
||||
P_{IJ} = \frac{\sum_{k}^{N} m_k v_{k_I} v_{k_J}}{V} +
|
||||
\frac{\sum_{k}^{N} r_{k_I} f_{k_J}}{V}
|
||||
\frac{\sum_{k}^{N'} r_{k_I} f_{k_J}}{V}
|
||||
$$
|
||||
|
||||
\end{document}
|
||||
|
||||
BIN
doc/src/JPG/lammps-logo.png
Normal file
|
After Width: | Height: | Size: 4.8 KiB |
@ -1,7 +1,7 @@
|
||||
<!-- HTML_ONLY -->
|
||||
<HEAD>
|
||||
<TITLE>LAMMPS Users Manual</TITLE>
|
||||
<META NAME="docnumber" CONTENT="12 Oct 2016 version">
|
||||
<META NAME="docnumber" CONTENT="17 Nov 2016 version">
|
||||
<META NAME="author" CONTENT="http://lammps.sandia.gov - Sandia National Laboratories">
|
||||
<META NAME="copyright" CONTENT="Copyright (2003) Sandia Corporation. This software and manual is distributed under the GNU General Public License.">
|
||||
</HEAD>
|
||||
@ -21,7 +21,7 @@
|
||||
<H1></H1>
|
||||
|
||||
LAMMPS Documentation :c,h3
|
||||
12 Oct 2016 version :c,h4
|
||||
17 Nov 2016 version :c,h4
|
||||
|
||||
Version info: :h4
|
||||
|
||||
|
||||
@ -106,7 +106,7 @@ the $. Thus $\{myTemp\} and $x refer to variable names "myTemp" and
|
||||
"x".
|
||||
|
||||
How the variable is converted to a text string depends on what style
|
||||
of variable it is; see the "variable"_variable doc page for details.
|
||||
of variable it is; see the "variable"_variable.html doc page for details.
|
||||
It can be a variable that stores multiple text strings, and return one
|
||||
of them. The returned text string can be multiple "words" (space
|
||||
separated) which will then be interpreted as multiple arguments in the
|
||||
@ -528,6 +528,8 @@ These are additional commands in USER packages, which can be used if
|
||||
package"_Section_start.html#start_3.
|
||||
|
||||
"dump custom/vtk"_dump_custom_vtk.html,
|
||||
"dump nc"_dump_nc.html,
|
||||
"dump nc/mpiio"_dump_nc.html,
|
||||
"group2ndx"_group2ndx.html,
|
||||
"ndx2group"_group2ndx.html :tb(c=3,ea=c)
|
||||
|
||||
@ -573,6 +575,7 @@ USER-INTEL, k = KOKKOS, o = USER-OMP, t = OPT.
|
||||
"gcmc"_fix_gcmc.html,
|
||||
"gld"_fix_gld.html,
|
||||
"gravity (o)"_fix_gravity.html,
|
||||
"halt"_fix_halt.html,
|
||||
"heat"_fix_heat.html,
|
||||
"indent"_fix_indent.html,
|
||||
"langevin (k)"_fix_langevin.html,
|
||||
@ -883,6 +886,8 @@ KOKKOS, o = USER-OMP, t = OPT.
|
||||
"body"_pair_body.html,
|
||||
"bop"_pair_bop.html,
|
||||
"born (go)"_pair_born.html,
|
||||
"born/coul/dsf"_pair_born.html,
|
||||
"born/coul/dsf/cs"_pair_born.html,
|
||||
"born/coul/long (go)"_pair_born.html,
|
||||
"born/coul/long/cs"_pair_born.html,
|
||||
"born/coul/msm (o)"_pair_born.html,
|
||||
@ -976,11 +981,12 @@ KOKKOS, o = USER-OMP, t = OPT.
|
||||
"table (gko)"_pair_table.html,
|
||||
"tersoff (gkio)"_pair_tersoff.html,
|
||||
"tersoff/mod (gko)"_pair_tersoff_mod.html,
|
||||
"tersoff/mod/c (o)"_pair_tersoff_mod.html,
|
||||
"tersoff/zbl (gko)"_pair_tersoff_zbl.html,
|
||||
"tip4p/cut (o)"_pair_coul.html,
|
||||
"tip4p/long (o)"_pair_coul.html,
|
||||
"tri/lj"_pair_tri_lj.html,
|
||||
"vashishta (o)"_pair_vashishta.html,
|
||||
"vashishta (ko)"_pair_vashishta.html,
|
||||
"vashishta/table (o)"_pair_vashishta.html,
|
||||
"yukawa (go)"_pair_yukawa.html,
|
||||
"yukawa/colloid (go)"_pair_yukawa_colloid.html,
|
||||
@ -990,6 +996,7 @@ These are additional pair styles in USER packages, which can be used
|
||||
if "LAMMPS is built with the appropriate
|
||||
package"_Section_start.html#start_3.
|
||||
|
||||
"agni (o)"_pair_agni.html,
|
||||
"awpmd/cut"_pair_awpmd.html,
|
||||
"buck/mdf"_pair_mdf.html,
|
||||
"coul/cut/soft (o)"_pair_lj_soft.html,
|
||||
|
||||
@ -8116,11 +8116,11 @@ boundary of a processor's sub-domain has moved more than 1/2 the
|
||||
rebuilt and atoms being migrated to new processors. This also means
|
||||
you may be missing pairwise interactions that need to be computed.
|
||||
The solution is to change the re-neighboring criteria via the
|
||||
"neigh_modify"_neigh_modify command. The safest settings are "delay 0
|
||||
every 1 check yes". Second, it may mean that an atom has moved far
|
||||
outside a processor's sub-domain or even the entire simulation box.
|
||||
This indicates bad physics, e.g. due to highly overlapping atoms, too
|
||||
large a timestep, etc. :dd
|
||||
"neigh_modify"_neigh_modify.html command. The safest settings are
|
||||
"delay 0 every 1 check yes". Second, it may mean that an atom has
|
||||
moved far outside a processor's sub-domain or even the entire
|
||||
simulation box. This indicates bad physics, e.g. due to highly
|
||||
overlapping atoms, too large a timestep, etc. :dd
|
||||
|
||||
{Out of range atoms - cannot compute PPPM} :dt
|
||||
|
||||
@ -8132,11 +8132,11 @@ boundary of a processor's sub-domain has moved more than 1/2 the
|
||||
rebuilt and atoms being migrated to new processors. This also means
|
||||
you may be missing pairwise interactions that need to be computed.
|
||||
The solution is to change the re-neighboring criteria via the
|
||||
"neigh_modify"_neigh_modify command. The safest settings are "delay 0
|
||||
every 1 check yes". Second, it may mean that an atom has moved far
|
||||
outside a processor's sub-domain or even the entire simulation box.
|
||||
This indicates bad physics, e.g. due to highly overlapping atoms, too
|
||||
large a timestep, etc. :dd
|
||||
"neigh_modify"_neigh_modify.html command. The safest settings are
|
||||
"delay 0 every 1 check yes". Second, it may mean that an atom has
|
||||
moved far outside a processor's sub-domain or even the entire
|
||||
simulation box. This indicates bad physics, e.g. due to highly
|
||||
overlapping atoms, too large a timestep, etc. :dd
|
||||
|
||||
{Out of range atoms - cannot compute PPPMDisp} :dt
|
||||
|
||||
@ -8148,11 +8148,11 @@ boundary of a processor's sub-domain has moved more than 1/2 the
|
||||
rebuilt and atoms being migrated to new processors. This also means
|
||||
you may be missing pairwise interactions that need to be computed.
|
||||
The solution is to change the re-neighboring criteria via the
|
||||
"neigh_modify"_neigh_modify command. The safest settings are "delay 0
|
||||
every 1 check yes". Second, it may mean that an atom has moved far
|
||||
outside a processor's sub-domain or even the entire simulation box.
|
||||
This indicates bad physics, e.g. due to highly overlapping atoms, too
|
||||
large a timestep, etc. :dd
|
||||
"neigh_modify"_neigh_modify.html command. The safest settings are
|
||||
"delay 0 every 1 check yes". Second, it may mean that an atom has
|
||||
moved far outside a processor's sub-domain or even the entire
|
||||
simulation box. This indicates bad physics, e.g. due to highly
|
||||
overlapping atoms, too large a timestep, etc. :dd
|
||||
|
||||
{Overflow of allocated fix vector storage} :dt
|
||||
|
||||
|
||||
@ -1854,13 +1854,19 @@ internal LAMMPS operations. Note that LAMMPS classes are defined
|
||||
within a LAMMPS namespace (LAMMPS_NS) if you use them from another C++
|
||||
application.
|
||||
|
||||
Library.cpp contains these 5 basic functions:
|
||||
Library.cpp contains these functions for creating and destroying an
|
||||
instance of LAMMPS and sending it commands to execute. See the
|
||||
documentation in the src/library.cpp file for details:
|
||||
|
||||
void lammps_open(int, char **, MPI_Comm, void **)
|
||||
void lammps_open_no_mpi(int, char **, void **)
|
||||
void lammps_close(void *)
|
||||
int lammps_version(void *)
|
||||
void lammps_file(void *, char *)
|
||||
char *lammps_command(void *, char *) :pre
|
||||
char *lammps_command(void *, char *)
|
||||
void lammps_commands_list(void *, int, char **)
|
||||
void lammps_commands_string(void *, char *)
|
||||
void lammps_free(void *) :pre
|
||||
|
||||
The lammps_open() function is used to initialize LAMMPS, passing in a
|
||||
list of strings as if they were "command-line
|
||||
@ -1880,6 +1886,10 @@ half to the other code and run both codes simultaneously before
|
||||
syncing them up periodically. Or it might instantiate multiple
|
||||
instances of LAMMPS to perform different calculations.
|
||||
|
||||
The lammps_open_no_mpi() function is similar except that no MPI
|
||||
communicator is passed from the caller. Instead, MPI_COMM_WORLD is
|
||||
used to instantiate LAMMPS, and MPI is initialzed if necessary.
|
||||
|
||||
The lammps_close() function is used to shut down an instance of LAMMPS
|
||||
and free all its memory.
|
||||
|
||||
@ -1891,44 +1901,93 @@ changes to the LAMMPS command syntax between versions. The returned
|
||||
LAMMPS version code is an integer (e.g. 2 Sep 2015 results in
|
||||
20150902) that grows with every new LAMMPS version.
|
||||
|
||||
The lammps_file() and lammps_command() functions are used to pass a
|
||||
file or string to LAMMPS as if it were an input script or single
|
||||
command in an input script. Thus the calling code can read or
|
||||
generate a series of LAMMPS commands one line at a time and pass it
|
||||
thru the library interface to setup a problem and then run it,
|
||||
interleaving the lammps_command() calls with other calls to extract
|
||||
information from LAMMPS, perform its own operations, or call another
|
||||
code's library.
|
||||
The lammps_file(), lammps_command(), lammps_commands_list(), and
|
||||
lammps_commands_string() functions are used to pass one or more
|
||||
commands to LAMMPS to execute, the same as if they were coming from an
|
||||
input script.
|
||||
|
||||
Other useful functions are also included in library.cpp. For example:
|
||||
Via these functions, the calling code can read or generate a series of
|
||||
LAMMPS commands one or multiple at a time and pass it thru the library
|
||||
interface to setup a problem and then run it in stages. The caller
|
||||
can interleave the command function calls with operations it performs,
|
||||
calls to extract information from or set information within LAMMPS, or
|
||||
calls to another code's library.
|
||||
|
||||
The lammps_file() function passes the filename of an input script.
|
||||
The lammps_command() function passes a single command as a string.
|
||||
The lammps_commands_list() function passes multiple commands in a
|
||||
char** list. In both lammps_command() and lammps_commands_list(),
|
||||
individual commands may or may not have a trailing newline. The
|
||||
lammps_commands_string() function passes multiple commands
|
||||
concatenated into one long string, separated by newline characters.
|
||||
In both lammps_commands_list() and lammps_commands_string(), a single
|
||||
command can be spread across multiple lines, if the last printable
|
||||
character of all but the last line is "&", the same as if the lines
|
||||
appeared in an input script.
|
||||
|
||||
The lammps_free() function is a clean-up function to free memory that
|
||||
the library allocated previously via other function calls. See
|
||||
comments in src/library.cpp file for which other functions need this
|
||||
clean-up.
|
||||
|
||||
Library.cpp also contains these functions for extracting information
|
||||
from LAMMPS and setting value within LAMMPS. Again, see the
|
||||
documentation in the src/library.cpp file for details, including
|
||||
which quantities can be queried by name:
|
||||
|
||||
void *lammps_extract_global(void *, char *)
|
||||
void *lammps_extract_atom(void *, char *)
|
||||
void *lammps_extract_compute(void *, char *, int, int)
|
||||
void *lammps_extract_fix(void *, char *, int, int, int, int)
|
||||
void *lammps_extract_variable(void *, char *, char *)
|
||||
void *lammps_extract_variable(void *, char *, char *) :pre
|
||||
|
||||
int lammps_set_variable(void *, char *, char *)
|
||||
double lammps_get_thermo(void *, char *) :pre
|
||||
|
||||
int lammps_get_natoms(void *)
|
||||
void lammps_get_coords(void *, double *)
|
||||
void lammps_put_coords(void *, double *) :pre
|
||||
void lammps_gather_atoms(void *, double *)
|
||||
void lammps_scatter_atoms(void *, double *) :pre
|
||||
void lammps_create_atoms(void *, int, tagint *, int *, double *, double *) :pre
|
||||
|
||||
These can extract various global or per-atom quantities from LAMMPS as
|
||||
well as values calculated by a compute, fix, or variable. The
|
||||
"set_variable" function can set an existing string-style variable to a
|
||||
new value, so that subsequent LAMMPS commands can access the variable.
|
||||
The "get" and "put" operations can retrieve and reset atom
|
||||
coordinates. See the library.cpp file and its associated header file
|
||||
library.h for details.
|
||||
The extract functions return a pointer to various global or per-atom
|
||||
quantities stored in LAMMPS or to values calculated by a compute, fix,
|
||||
or variable. The pointer returned by the extract_global() function
|
||||
can be used as a permanent reference to a value which may change. For
|
||||
the other extract functions, the underlying storage may be reallocated
|
||||
as LAMMPS runs, so you need to re-call the function to assure a
|
||||
current pointer or returned value(s).
|
||||
|
||||
The key idea of the library interface is that you can write any
|
||||
functions you wish to define how your code talks to LAMMPS and add
|
||||
them to src/library.cpp and src/library.h, as well as to the "Python
|
||||
interface"_Section_python.html. The routines you add can access or
|
||||
change any LAMMPS data you wish. The examples/COUPLE and python
|
||||
directories have example C++ and C and Python codes which show how a
|
||||
driver code can link to LAMMPS as a library, run LAMMPS on a subset of
|
||||
processors, grab data from LAMMPS, change it, and put it back into
|
||||
LAMMPS.
|
||||
The lammps_set_variable() function can set an existing string-style
|
||||
variable to a new string value, so that subsequent LAMMPS commands can
|
||||
access the variable. The lammps_get_thermo() function returns the
|
||||
current value of a thermo keyword as a double.
|
||||
|
||||
The lammps_get_natoms() function returns the total number of atoms in
|
||||
the system and can be used by the caller to allocate space for the
|
||||
lammps_gather_atoms() and lammps_scatter_atoms() functions. The
|
||||
gather function collects atom info of the requested type (atom coords,
|
||||
types, forces, etc) from all procsesors, orders them by atom ID, and
|
||||
returns a full list to each calling processor. The scatter function
|
||||
does the inverse. It distributes the same kinds of values,
|
||||
passed by the caller, to each atom owned by individual processors.
|
||||
|
||||
The lammps_create_atoms() function takes a list of N atoms as input
|
||||
with atom types and coords (required), an optionally atom IDs and
|
||||
velocities. It uses the coords of each atom to assign it as a new
|
||||
atom to the processor that owns it. Additional properties for the new
|
||||
atoms can be assigned via the lammps_scatter_atoms() or
|
||||
lammps_extract_atom() functions.
|
||||
|
||||
The examples/COUPLE and python directories have example C++ and C and
|
||||
Python codes which show how a driver code can link to LAMMPS as a
|
||||
library, run LAMMPS on a subset of processors, grab data from LAMMPS,
|
||||
change it, and put it back into LAMMPS.
|
||||
|
||||
NOTE: You can write code for additional functions as needed to define
|
||||
how your code talks to LAMMPS and add them to src/library.cpp and
|
||||
src/library.h, as well as to the "Python
|
||||
interface"_Section_python.html. The added functions can access or
|
||||
change any LAMMPS data you wish.
|
||||
|
||||
:line
|
||||
|
||||
@ -2670,7 +2729,7 @@ production runs and is only required during equilibration. This way one
|
||||
is consistent with literature (based on the code packages DL_POLY or
|
||||
GULP for instance).
|
||||
|
||||
The mentioned energy transfer will typically lead to a a small drift
|
||||
The mentioned energy transfer will typically lead to a small drift
|
||||
in total energy over time. This internal energy can be monitored
|
||||
using the "compute chunk/atom"_compute_chunk_atom.html and "compute
|
||||
temp/chunk"_compute_temp_chunk.html commands. The internal kinetic
|
||||
@ -2771,7 +2830,7 @@ temp/drude"_compute_temp_drude.html. This requires also to use the
|
||||
command {comm_modify vel yes}.
|
||||
|
||||
Short-range damping of the induced dipole interactions can be achieved
|
||||
using Thole functions through the the "pair style
|
||||
using Thole functions through the "pair style
|
||||
thole"_pair_thole.html in "pair_style hybrid/overlay"_pair_hybrid.html
|
||||
with a Coulomb pair style. It may be useful to use {coul/long/cs} or
|
||||
similar from the CORESHELL package if the core and Drude particle come
|
||||
|
||||
@ -366,11 +366,11 @@ complementary modeling tasks.
|
||||
"DL_POLY"_dlpoly
|
||||
"Tinker"_tinker :ul
|
||||
|
||||
:link(charmm,http://www.scripps.edu/brooks)
|
||||
:link(amber,http://amber.scripps.edu)
|
||||
:link(charmm,http://www.charmm.org)
|
||||
:link(amber,http://ambermd.org)
|
||||
:link(namd,http://www.ks.uiuc.edu/Research/namd/)
|
||||
:link(nwchem,http://www.emsl.pnl.gov/docs/nwchem/nwchem.html)
|
||||
:link(dlpoly,http://www.cse.clrc.ac.uk/msi/software/DL_POLY)
|
||||
:link(dlpoly,http://www.ccp5.ac.uk/DL_POLY_CLASSIC)
|
||||
:link(tinker,http://dasher.wustl.edu/tinker)
|
||||
|
||||
CHARMM, AMBER, NAMD, NWCHEM, and Tinker are designed primarily for
|
||||
|
||||
@ -1153,6 +1153,7 @@ Package, Description, Author(s), Doc page, Example, Pic/movie, Library
|
||||
"USER-MISC"_#USER-MISC, single-file contributions, USER-MISC/README, USER-MISC/README, -, -, -
|
||||
"USER-MANIFOLD"_#USER-MANIFOLD, motion on 2d surface, Stefan Paquay (Eindhoven U of Technology), "fix manifoldforce"_fix_manifoldforce.html, USER/manifold, "manifold"_manifold, -
|
||||
"USER-MOLFILE"_#USER-MOLFILE, "VMD"_VMD molfile plug-ins, Axel Kohlmeyer (Temple U), "dump molfile"_dump_molfile.html, -, -, VMD-MOLFILE
|
||||
"USER-NC-DUMP"_#USER-NC-DUMP, dump output via NetCDF, Lars Pastewka (Karlsruhe Institute of Technology, KIT), "dump nc, dump nc/mpiio"_dump_nc.html, -, -, lib/netcdf
|
||||
"USER-OMP"_#USER-OMP, OpenMP threaded styles, Axel Kohlmeyer (Temple U), "Section 5.3.4"_accelerate_omp.html, -, -, -
|
||||
"USER-PHONON"_#USER-PHONON, phonon dynamical matrix, Ling-Ti Kong (Shanghai Jiao Tong U), "fix phonon"_fix_phonon.html, USER/phonon, -, -
|
||||
"USER-QMMM"_#USER-QMMM, QM/MM coupling, Axel Kohlmeyer (Temple U), "fix qmmm"_fix_qmmm.html, USER/qmmm, -, lib/qmmm
|
||||
@ -1598,6 +1599,29 @@ The person who created this package is Axel Kohlmeyer at Temple U
|
||||
|
||||
:line
|
||||
|
||||
USER-NC-DUMP package :link(USER-NC-DUMP),h5
|
||||
|
||||
Contents: Dump styles for writing NetCDF format files. NetCDF is a binary,
|
||||
portable, self-describing file format on top of HDF5. The file format
|
||||
contents follow the AMBER NetCDF trajectory conventions
|
||||
(http://ambermd.org/netcdf/nctraj.xhtml), but include extensions to this
|
||||
convention. This package implements a "dump nc"_dump_nc.html command
|
||||
and a "dump nc/mpiio"_dump_nc.html command to output LAMMPS snapshots
|
||||
in this format. See src/USER-NC-DUMP/README for more details.
|
||||
|
||||
NetCDF files can be directly visualized with the following tools:
|
||||
Ovito (http://www.ovito.org/). Ovito supports the AMBER convention
|
||||
and all of the above extensions. :ulb,l
|
||||
VMD (http://www.ks.uiuc.edu/Research/vmd/) :l
|
||||
AtomEye (http://www.libatoms.org/). The libAtoms version of AtomEye contains
|
||||
a NetCDF reader that is not present in the standard distribution of AtomEye :l,ule
|
||||
|
||||
The person who created these files is Lars Pastewka at
|
||||
Karlsruhe Institute of Technology (lars.pastewka at kit.edu).
|
||||
Contact him directly if you have questions.
|
||||
|
||||
:line
|
||||
|
||||
USER-OMP package :link(USER-OMP),h5
|
||||
|
||||
Supporting info:
|
||||
|
||||
@ -534,10 +534,11 @@ from lammps import lammps :pre
|
||||
These are the methods defined by the lammps module. If you look at
|
||||
the files src/library.cpp and src/library.h you will see that they
|
||||
correspond one-to-one with calls you can make to the LAMMPS library
|
||||
from a C++ or C or Fortran program.
|
||||
from a C++ or C or Fortran program, and which are described in
|
||||
"Section 6.19"_Section_howto.html#howto_19 of the manual.
|
||||
|
||||
lmp = lammps() # create a LAMMPS object using the default liblammps.so library
|
||||
4 optional args are allowed: name, cmdargs, ptr, comm
|
||||
# 4 optional args are allowed: name, cmdargs, ptr, comm
|
||||
lmp = lammps(ptr=lmpptr) # use lmpptr as previously created LAMMPS object
|
||||
lmp = lammps(comm=split) # create a LAMMPS object with a custom communicator, requires mpi4py 2.0.0 or later
|
||||
lmp = lammps(name="g++") # create a LAMMPS object using the liblammps_g++.so library
|
||||
@ -549,6 +550,8 @@ version = lmp.version() # return the numerical version id, e.g. LAMMPS 2 Sep 20
|
||||
|
||||
lmp.file(file) # run an entire input script, file = "in.lj"
|
||||
lmp.command(cmd) # invoke a single LAMMPS command, cmd = "run 100" :pre
|
||||
lmp.commands_list(cmdlist) # invoke commands in cmdlist = ["run 10", "run 20"]
|
||||
lmp.commands_string(multicmd) # invoke commands in multicmd = "run 10\nrun 20"
|
||||
|
||||
xlo = lmp.extract_global(name,type) # extract a global quantity
|
||||
# name = "boxxlo", "nlocal", etc
|
||||
@ -580,6 +583,8 @@ var = lmp.extract_variable(name,group,flag) # extract value(s) from a variable
|
||||
# 1 = atom-style variable :pre
|
||||
|
||||
flag = lmp.set_variable(name,value) # set existing named string-style variable to value, flag = 0 if successful
|
||||
value = lmp.get_thermo(name) # return current value of a thermo keyword
|
||||
|
||||
natoms = lmp.get_natoms() # total # of atoms as int
|
||||
data = lmp.gather_atoms(name,type,count) # return atom attribute of all atoms gathered into data, ordered by atom ID
|
||||
# name = "x", "charge", "type", etc
|
||||
@ -599,9 +604,10 @@ create an instance of LAMMPS, wrapped in a Python class by the lammps
|
||||
Python module, and return an instance of the Python class as lmp. It
|
||||
is used to make all subequent calls to the LAMMPS library.
|
||||
|
||||
Additional arguments can be used to tell Python the name of the shared
|
||||
library to load or to pass arguments to the LAMMPS instance, the same
|
||||
as if LAMMPS were launched from a command-line prompt.
|
||||
Additional arguments to lammps() can be used to tell Python the name
|
||||
of the shared library to load or to pass arguments to the LAMMPS
|
||||
instance, the same as if LAMMPS were launched from a command-line
|
||||
prompt.
|
||||
|
||||
If the ptr argument is set like this:
|
||||
|
||||
@ -626,8 +632,9 @@ lmp2 = lammps()
|
||||
lmp1.file("in.file1")
|
||||
lmp2.file("in.file2") :pre
|
||||
|
||||
The file() and command() methods allow an input script or single
|
||||
commands to be invoked.
|
||||
The file(), command(), commands_list(), commands_string() methods
|
||||
allow an input script, a single command, or multiple commands to be
|
||||
invoked.
|
||||
|
||||
The extract_global(), extract_atom(), extract_compute(),
|
||||
extract_fix(), and extract_variable() methods return values or
|
||||
|
||||
@ -706,7 +706,7 @@ future changes to LAMMPS.
|
||||
User packages, such as user-atc or user-omp, have been contributed by
|
||||
users, and always begin with the user prefix. If they are a single
|
||||
command (single file), they are typically in the user-misc package.
|
||||
Otherwise, they are a a set of files grouped together which add a
|
||||
Otherwise, they are a set of files grouped together which add a
|
||||
specific functionality to the code.
|
||||
|
||||
User packages don't necessarily meet the requirements of the standard
|
||||
@ -1601,9 +1601,9 @@ implementations, either by environment variables that specify how to
|
||||
order physical processors, or by config files that specify what
|
||||
physical processors to assign to each MPI rank. The -reorder switch
|
||||
simply gives you a portable way to do this without relying on MPI
|
||||
itself. See the "processors out"_processors command for how to output
|
||||
info on the final assignment of physical processors to the LAMMPS
|
||||
simulation domain.
|
||||
itself. See the "processors out"_processors.html command for how
|
||||
to output info on the final assignment of physical processors to
|
||||
the LAMMPS simulation domain.
|
||||
|
||||
-screen file :pre
|
||||
|
||||
|
||||
@ -151,7 +151,7 @@ can start running so that the CPU pipeline is still being used
|
||||
efficiently. Although benefits can be seen by launching a MPI task
|
||||
for every hardware thread, for multinode simulations, we recommend
|
||||
that OpenMP threads are used for SMT instead, either with the
|
||||
USER-INTEL package, "USER-OMP package"_accelerate_omp.html", or
|
||||
USER-INTEL package, "USER-OMP package"_accelerate_omp.html, or
|
||||
"KOKKOS package"_accelerate_kokkos.html. In the example above, up
|
||||
to 36X speedups can be observed by using all 36 physical cores with
|
||||
LAMMPS. By using all 72 hardware threads, an additional 10-30%
|
||||
@ -343,7 +343,7 @@ when using offload.
|
||||
|
||||
Not all styles are supported in the USER-INTEL package. You can mix
|
||||
the USER-INTEL package with styles from the "OPT"_accelerate_opt.html
|
||||
package or the "USER-OMP package"_accelerate_omp.html". Of course,
|
||||
package or the "USER-OMP package"_accelerate_omp.html. Of course,
|
||||
this requires that these packages were installed at build time. This
|
||||
can performed automatically by using "-sf hybrid intel opt" or
|
||||
"-sf hybrid intel omp" command-line options. Alternatively, the "opt"
|
||||
|
||||
@ -74,7 +74,7 @@ more instructions on how to use the accelerated styles effectively.
|
||||
[Restrictions:]
|
||||
|
||||
This angle style can only be used if LAMMPS was built with the
|
||||
MOLECULE package (which it is by default). See the "Making
|
||||
MOLECULE package. See the "Making
|
||||
LAMMPS"_Section_start.html#start_3 section for more info on packages.
|
||||
|
||||
[Related commands:]
|
||||
|
||||
@ -61,7 +61,7 @@ more instructions on how to use the accelerated styles effectively.
|
||||
[Restrictions:]
|
||||
|
||||
This angle style can only be used if LAMMPS was built with the
|
||||
MOLECULE package (which it is by default). See the "Making
|
||||
MOLECULE package. See the "Making
|
||||
LAMMPS"_Section_start.html#start_3 section for more info on packages.
|
||||
|
||||
[Related commands:]
|
||||
|
||||
@ -66,7 +66,7 @@ more instructions on how to use the accelerated styles effectively.
|
||||
[Restrictions:]
|
||||
|
||||
This angle style can only be used if LAMMPS was built with the
|
||||
MOLECULE package (which it is by default). See the "Making
|
||||
MOLECULE package. See the "Making
|
||||
LAMMPS"_Section_start.html#start_3 section for more info on packages.
|
||||
|
||||
[Related commands:]
|
||||
|
||||
@ -74,7 +74,7 @@ more instructions on how to use the accelerated styles effectively.
|
||||
[Restrictions:]
|
||||
|
||||
This angle style can only be used if LAMMPS was built with the
|
||||
MOLECULE package (which it is by default). See the "Making
|
||||
MOLECULE package. See the "Making
|
||||
LAMMPS"_Section_start.html#start_3 section for more info on packages.
|
||||
|
||||
[Related commands:]
|
||||
|
||||
@ -66,7 +66,7 @@ more instructions on how to use the accelerated styles effectively.
|
||||
[Restrictions:]
|
||||
|
||||
This angle style can only be used if LAMMPS was built with the
|
||||
MOLECULE package (which it is by default). See the "Making
|
||||
MOLECULE package. See the "Making
|
||||
LAMMPS"_Section_start.html#start_3 section for more info on packages.
|
||||
|
||||
[Related commands:]
|
||||
|
||||
@ -65,11 +65,11 @@ more instructions on how to use the accelerated styles effectively.
|
||||
|
||||
:line
|
||||
|
||||
[Restrictions:] none
|
||||
[Restrictions:]
|
||||
|
||||
This angle style can only be used if LAMMPS was built with the
|
||||
MOLECULE package (which it is by default). See the "Making
|
||||
LAMMPS"_Section_start.html#start_3 section for more info on packages.
|
||||
MOLECULE package. See the "Making LAMMPS"_Section_start.html#start_3
|
||||
section for more info on packages.
|
||||
|
||||
[Related commands:]
|
||||
|
||||
|
||||
@ -76,7 +76,7 @@ for specific angle types.
|
||||
[Restrictions:]
|
||||
|
||||
This angle style can only be used if LAMMPS was built with the
|
||||
MOLECULE package (which it is by default). See the "Making
|
||||
MOLECULE package. See the "Making
|
||||
LAMMPS"_Section_start.html#start_3 section for more info on packages.
|
||||
|
||||
Unlike other angle styles, the hybrid angle style does not store angle
|
||||
|
||||
@ -147,7 +147,7 @@ more instructions on how to use the accelerated styles effectively.
|
||||
[Restrictions:]
|
||||
|
||||
This angle style can only be used if LAMMPS was built with the
|
||||
MOLECULE package (which it is by default). See the "Making
|
||||
MOLECULE package. See the "Making
|
||||
LAMMPS"_Section_start.html#start_3 section for more info on packages.
|
||||
|
||||
[Related commands:]
|
||||
|
||||
@ -166,7 +166,7 @@ stores a per-particle mass and size and orientation (i.e. the corner
|
||||
points of the triangle).
|
||||
|
||||
The {template} style allows molecular topolgy (bonds,angles,etc) to be
|
||||
defined via a molecule template using the "molecule"_molecule.txt
|
||||
defined via a molecule template using the "molecule"_molecule.html
|
||||
command. The template stores one or more molecules with a single copy
|
||||
of the topology info (bonds,angles,etc) of each. Individual atoms
|
||||
only store a template index and template atom to identify which
|
||||
|
||||
@ -70,10 +70,10 @@ more instructions on how to use the accelerated styles effectively.
|
||||
[Restrictions:]
|
||||
|
||||
This bond style can only be used if LAMMPS was built with the
|
||||
MOLECULE package (which it is by default). See the "Making
|
||||
MOLECULE package. See the "Making
|
||||
LAMMPS"_Section_start.html#start_3 section for more info on packages.
|
||||
|
||||
You typically should specify "special_bonds fene"_special_bonds.html"
|
||||
You typically should specify "special_bonds fene"_special_bonds.html
|
||||
or "special_bonds lj/coul 0 1 1"_special_bonds.html to use this bond
|
||||
style. LAMMPS will issue a warning it that's not the case.
|
||||
|
||||
|
||||
@ -73,10 +73,10 @@ more instructions on how to use the accelerated styles effectively.
|
||||
[Restrictions:]
|
||||
|
||||
This bond style can only be used if LAMMPS was built with the
|
||||
MOLECULE package (which it is by default). See the "Making
|
||||
MOLECULE package. See the "Making
|
||||
LAMMPS"_Section_start.html#start_3 section for more info on packages.
|
||||
|
||||
You typically should specify "special_bonds fene"_special_bonds.html"
|
||||
You typically should specify "special_bonds fene"_special_bonds.html
|
||||
or "special_bonds lj/coul 0 1 1"_special_bonds.html to use this bond
|
||||
style. LAMMPS will issue a warning it that's not the case.
|
||||
|
||||
|
||||
@ -65,7 +65,7 @@ more instructions on how to use the accelerated styles effectively.
|
||||
[Restrictions:]
|
||||
|
||||
This bond style can only be used if LAMMPS was built with the
|
||||
MOLECULE package (which it is by default). See the "Making
|
||||
MOLECULE package. See the "Making
|
||||
LAMMPS"_Section_start.html#start_3 section for more info on packages.
|
||||
|
||||
[Related commands:]
|
||||
|
||||
@ -59,7 +59,7 @@ bond types.
|
||||
[Restrictions:]
|
||||
|
||||
This bond style can only be used if LAMMPS was built with the
|
||||
MOLECULE package (which it is by default). See the "Making
|
||||
MOLECULE package. See the "Making
|
||||
LAMMPS"_Section_start.html#start_3 section for more info on packages.
|
||||
|
||||
Unlike other bond styles, the hybrid bond style does not store bond
|
||||
|
||||
@ -64,7 +64,7 @@ more instructions on how to use the accelerated styles effectively.
|
||||
[Restrictions:]
|
||||
|
||||
This bond style can only be used if LAMMPS was built with the
|
||||
MOLECULE package (which it is by default). See the "Making
|
||||
MOLECULE package. See the "Making
|
||||
LAMMPS"_Section_start.html#start_3 section for more info on packages.
|
||||
|
||||
[Related commands:]
|
||||
|
||||
@ -64,7 +64,7 @@ more instructions on how to use the accelerated styles effectively.
|
||||
[Restrictions:]
|
||||
|
||||
This bond style can only be used if LAMMPS was built with the
|
||||
MOLECULE package (which it is by default). See the "Making
|
||||
MOLECULE package. See the "Making
|
||||
LAMMPS"_Section_start.html#start_3 section for more info on packages.
|
||||
|
||||
[Related commands:]
|
||||
|
||||
@ -99,7 +99,7 @@ more instructions on how to use the accelerated styles effectively.
|
||||
[Restrictions:]
|
||||
|
||||
This bond style can only be used if LAMMPS was built with the
|
||||
MOLECULE package (which it is by default). See the "Making
|
||||
MOLECULE package. See the "Making
|
||||
LAMMPS"_Section_start.html#start_3 section for more info on packages.
|
||||
|
||||
The {quartic} style requires that "special_bonds"_special_bonds.html
|
||||
|
||||
@ -144,7 +144,7 @@ more instructions on how to use the accelerated styles effectively.
|
||||
[Restrictions:]
|
||||
|
||||
This bond style can only be used if LAMMPS was built with the
|
||||
MOLECULE package (which it is by default). See the "Making
|
||||
MOLECULE package. See the "Making
|
||||
LAMMPS"_Section_start.html#start_3 section for more info on packages.
|
||||
|
||||
[Related commands:]
|
||||
|
||||
@ -37,6 +37,7 @@ Commands :h1
|
||||
dump_image
|
||||
dump_modify
|
||||
dump_molfile
|
||||
dump_nc
|
||||
echo
|
||||
fix
|
||||
fix_modify
|
||||
|
||||
@ -114,7 +114,7 @@ local defects surrounding the central atom, as described above. For
|
||||
the {axes yes} case, the vector components are also unitless, since
|
||||
they represent spatial directions.
|
||||
|
||||
Here are typical centro-symmetry values, from a a nanoindentation
|
||||
Here are typical centro-symmetry values, from a nanoindentation
|
||||
simulation into gold (FCC). These were provided by Jon Zimmerman
|
||||
(Sandia):
|
||||
|
||||
|
||||
@ -536,7 +536,7 @@ For the {bin/cylinder} style the details are as follows. If {discard}
|
||||
is set to {yes}, an out-of-domain atom will have its chunk ID set to
|
||||
0. If {discard} is set to {no}, the atom will have its chunk ID set
|
||||
to the first or last bin in both the radial and axis dimensions. If
|
||||
{discard} is set to {mixed}, which is the default, the the radial
|
||||
{discard} is set to {mixed}, which is the default, the radial
|
||||
dimension is treated the same as for {discard} = no. But for the axis
|
||||
dimensinon, it will only have its chunk ID set to the first or last
|
||||
bin if bins extend to the simulation box boundary in the axis
|
||||
|
||||
@ -236,7 +236,7 @@ LAMMPS"_Section_start.html#start_3 section for more info.
|
||||
[Related commands:]
|
||||
|
||||
"fix adapt/fep"_fix_adapt_fep.html, "fix ave/time"_fix_ave_time.html,
|
||||
"pair_lj_soft_coul_soft"_pair_lj_soft_coul_soft.txt
|
||||
"pair_style lj/soft/coul/soft"_pair_lj_soft.html
|
||||
|
||||
[Default:]
|
||||
|
||||
|
||||
@ -15,7 +15,7 @@ compute ID group-ID orientorder/atom keyword values ... :pre
|
||||
ID, group-ID are documented in "compute"_compute.html command :ulb,l
|
||||
orientorder/atom = style name of this compute command :l
|
||||
one or more keyword/value pairs may be appended :l
|
||||
keyword = {cutoff} or {nnn} or {ql}
|
||||
keyword = {cutoff} or {nnn} or {degrees}
|
||||
{cutoff} value = distance cutoff
|
||||
{nnn} value = number of nearest neighbors
|
||||
{degrees} values = nlvalues, l1, l2,... :pre
|
||||
@ -111,7 +111,7 @@ options.
|
||||
|
||||
[Default:]
|
||||
|
||||
The option defaults are {cutoff} = pair style cutoff, {nnn} = 12, {degrees} = 5 4 6 8 9 10 12 i.e. {Q}4, {Q}6, {Q}8, {Q}10, and {Q}12.
|
||||
The option defaults are {cutoff} = pair style cutoff, {nnn} = 12, {degrees} = 5 4 6 8 10 12 i.e. {Q}4, {Q}6, {Q}8, {Q}10, and {Q}12.
|
||||
|
||||
:line
|
||||
|
||||
|
||||
@ -72,9 +72,10 @@ compute peratom all pe/atom
|
||||
compute pe all reduce sum c_peratom
|
||||
thermo_style custom step temp etotal press pe c_pe :pre
|
||||
|
||||
NOTE: The per-atom energy does not any Lennard-Jones tail corrections
|
||||
invoked by the "pair_modify tail yes"_pair_modify.html command, since
|
||||
those are global contributions to the system energy.
|
||||
NOTE: The per-atom energy does not include any Lennard-Jones tail
|
||||
corrections to the energy added by the "pair_modify tail
|
||||
yes"_pair_modify.html command, since those are contributions to the
|
||||
global system energy.
|
||||
|
||||
[Output info:]
|
||||
|
||||
|
||||
@ -37,12 +37,18 @@ The pressure is computed by the formula
|
||||
|
||||
where N is the number of atoms in the system (see discussion of DOF
|
||||
below), Kb is the Boltzmann constant, T is the temperature, d is the
|
||||
dimensionality of the system (2 or 3 for 2d/3d), V is the system
|
||||
volume (or area in 2d), and the second term is the virial, computed
|
||||
within LAMMPS for all pairwise as well as 2-body, 3-body, and 4-body,
|
||||
and long-range interactions. "Fixes"_fix.html that impose constraints
|
||||
(e.g. the "fix shake"_fix_shake.html command) also contribute to the
|
||||
virial term.
|
||||
dimensionality of the system (2 or 3 for 2d/3d), and V is the system
|
||||
volume (or area in 2d). The second term is the virial, equal to
|
||||
-dU/dV, computed for all pairwise as well as 2-body, 3-body, 4-body,
|
||||
manybody, and long-range interactions, where r_i and f_i are the
|
||||
position and force vector of atom i, and the black dot indicates a dot
|
||||
product. When periodic boundary conditions are used, N' necessarily
|
||||
includes periodic image (ghost) atoms outside the central box, and the
|
||||
position and force vectors of ghost atoms are thus included in the
|
||||
summation. When periodic boundary conditions are not used, N' = N =
|
||||
the number of atoms in the system. "Fixes"_fix.html that impose
|
||||
constraints (e.g. the "fix shake"_fix_shake.html command) also
|
||||
contribute to the virial term.
|
||||
|
||||
A symmetric pressure tensor, stored as a 6-element vector, is also
|
||||
calculated by this compute. The 6 components of the vector are
|
||||
@ -62,8 +68,9 @@ compute temperature or ke and/or the virial. The {virial} keyword
|
||||
means include all terms except the kinetic energy {ke}.
|
||||
|
||||
Details of how LAMMPS computes the virial efficiently for the entire
|
||||
system, including the effects of periodic boundary conditions is
|
||||
discussed in "(Thompson)"_#Thompson.
|
||||
system, including for manybody potentials and accounting for the
|
||||
effects of periodic boundary conditions are discussed in
|
||||
"(Thompson)"_#Thompson.
|
||||
|
||||
The temperature and kinetic energy tensor is not calculated by this
|
||||
compute, but rather by the temperature compute specified with the
|
||||
|
||||
@ -78,7 +78,7 @@ defined by the "pair_style"_pair_style.html command for the types of
|
||||
the two atoms is used. For the {radius} setting, the sum of the radii
|
||||
of the two particles is used as a cutoff. For example, this is
|
||||
appropriate for granular particles which only interact when they are
|
||||
overlapping, as computed by "granular pair styles"_pair_gran.txt.
|
||||
overlapping, as computed by "granular pair styles"_pair_gran.html.
|
||||
|
||||
If the inputs are bond, angle, etc attributes, the local data is
|
||||
generated by looping over all the atoms owned on a processor and
|
||||
|
||||
@ -60,7 +60,7 @@ produced by a small set of atoms (e.g. 4 atoms in a dihedral or 3
|
||||
atoms in a Tersoff 3-body interaction) is assigned in equal portions
|
||||
to each atom in the set. E.g. 1/4 of the dihedral virial to each of
|
||||
the 4 atoms, or 1/3 of the fix virial due to SHAKE constraints applied
|
||||
to atoms in a a water molecule via the "fix shake"_fix_shake.html
|
||||
to atoms in a water molecule via the "fix shake"_fix_shake.html
|
||||
command.
|
||||
|
||||
If no extra keywords are listed, all of the terms in this formula are
|
||||
@ -133,6 +133,11 @@ compute p all reduce sum c_peratom\[1\] c_peratom\[2\] c_peratom\[3\]
|
||||
variable press equal -(c_p\[1\]+c_p\[2\]+c_p\[3\])/(3*vol)
|
||||
thermo_style custom step temp etotal press v_press :pre
|
||||
|
||||
NOTE: The per-atom stress does not include any Lennard-Jones tail
|
||||
corrections to the pressure added by the "pair_modify tail
|
||||
yes"_pair_modify.html command, since those are contributions to the
|
||||
global system pressure.
|
||||
|
||||
[Output info:]
|
||||
|
||||
This compute calculates a per-atom array with 6 columns, which can be
|
||||
|
||||
@ -69,8 +69,8 @@ velocity for each atom. Note that if there is only one atom in the
|
||||
bin, its thermal velocity will thus be 0.0.
|
||||
|
||||
After the spatially-averaged velocity field has been subtracted from
|
||||
each atom, the temperature is calculated by the formula KE = (dim/2 N
|
||||
- dim*Nx*Ny*Nz) k T, where KE = total kinetic energy of the group of
|
||||
each atom, the temperature is calculated by the formula KE = (dim*N
|
||||
- dim*Nx*Ny*Nz) k T/2, where KE = total kinetic energy of the group of
|
||||
atoms (sum of 1/2 m v^2), dim = 2 or 3 = dimensionality of the
|
||||
simulation, N = number of atoms in the group, k = Boltzmann constant,
|
||||
and T = temperature. The dim*Nx*Ny*Nz term are degrees of freedom
|
||||
|
||||
@ -109,7 +109,7 @@ more instructions on how to use the accelerated styles effectively.
|
||||
[Restrictions:]
|
||||
|
||||
This dihedral style can only be used if LAMMPS was built with the
|
||||
MOLECULE package (which it is by default). See the "Making
|
||||
MOLECULE package. See the "Making
|
||||
LAMMPS"_Section_start.html#start_3 section for more info on packages.
|
||||
|
||||
[Related commands:]
|
||||
|
||||
@ -76,7 +76,7 @@ more instructions on how to use the accelerated styles effectively.
|
||||
[Restrictions:]
|
||||
|
||||
This dihedral style can only be used if LAMMPS was built with the
|
||||
MOLECULE package (which it is by default). See the "Making
|
||||
MOLECULE package. See the "Making
|
||||
LAMMPS"_Section_start.html#start_3 section for more info on packages.
|
||||
|
||||
[Related commands:]
|
||||
|
||||
@ -69,7 +69,7 @@ more instructions on how to use the accelerated styles effectively.
|
||||
[Restrictions:]
|
||||
|
||||
This dihedral style can only be used if LAMMPS was built with the
|
||||
MOLECULE package (which it is by default). See the "Making
|
||||
MOLECULE package. See the "Making
|
||||
LAMMPS"_Section_start.html#start_3 section for more info on packages.
|
||||
|
||||
[Related commands:]
|
||||
|
||||
@ -77,7 +77,7 @@ for specific dihedral types.
|
||||
[Restrictions:]
|
||||
|
||||
This dihedral style can only be used if LAMMPS was built with the
|
||||
MOLECULE package (which it is by default). See the "Making
|
||||
MOLECULE package. See the "Making
|
||||
LAMMPS"_Section_start.html#start_3 section for more info on packages.
|
||||
|
||||
Unlike other dihedral styles, the hybrid dihedral style does not store
|
||||
|
||||
@ -63,7 +63,7 @@ more instructions on how to use the accelerated styles effectively.
|
||||
[Restrictions:]
|
||||
|
||||
This dihedral style can only be used if LAMMPS was built with the
|
||||
MOLECULE package (which it is by default). See the "Making
|
||||
MOLECULE package. See the "Making
|
||||
LAMMPS"_Section_start.html#start_3 section for more info on packages.
|
||||
|
||||
[Related commands:]
|
||||
|
||||
@ -71,7 +71,7 @@ more instructions on how to use the accelerated styles effectively.
|
||||
[Restrictions:]
|
||||
|
||||
This dihedral style can only be used if LAMMPS was built with the
|
||||
MOLECULE package (which it is by default). See the "Making
|
||||
MOLECULE package. See the "Making
|
||||
LAMMPS"_Section_start.html#start_3 section for more info on packages.
|
||||
|
||||
[Related commands:]
|
||||
|
||||
@ -154,7 +154,7 @@ radians instead of degrees. (Note: This changes the way the forces
|
||||
are scaled in the 4th column of the data file.)
|
||||
|
||||
The optional "CHECKU" keyword is followed by a filename. This allows
|
||||
the user to save all of the the {Ntable} different entries in the
|
||||
the user to save all of the {Ntable} different entries in the
|
||||
interpolated energy table to a file to make sure that the interpolated
|
||||
function agrees with the user's expectations. (Note: You can
|
||||
temporarily increase the {Ntable} parameter to a high value for this
|
||||
|
||||
@ -12,6 +12,7 @@ dump command :h3
|
||||
"dump image"_dump_image.html command :h3
|
||||
"dump movie"_dump_image.html command :h3
|
||||
"dump molfile"_dump_molfile.html command :h3
|
||||
"dump nc"_dump_nc.html command :h3
|
||||
|
||||
[Syntax:]
|
||||
|
||||
@ -43,7 +44,9 @@ args = list of arguments for a particular style :l
|
||||
|
||||
{movie} args = discussed on "dump image"_dump_image.html doc page :pre
|
||||
|
||||
{molfile} args = discussed on "dump molfile"_dump_molfile.html doc page :pre
|
||||
{molfile} args = discussed on "dump molfile"_dump_molfile.html doc page
|
||||
|
||||
{nc} args = discussed on "dump nc"_dump_nc.html doc page :pre
|
||||
|
||||
{local} args = list of local attributes
|
||||
possible attributes = index, c_ID, c_ID\[I\], f_ID, f_ID\[I\]
|
||||
|
||||
@ -47,9 +47,9 @@ keyword = {append} or {buffer} or {element} or {every} or {fileper} or {first} o
|
||||
id = sort per-atom lines by atom ID
|
||||
N = sort per-atom lines in ascending order by the Nth column
|
||||
-N = sort per-atom lines in descending order by the Nth column
|
||||
{thresh} args = attribute operation value
|
||||
{thresh} args = attribute operator value
|
||||
attribute = same attributes (x,fy,etotal,sxx,etc) used by dump custom style
|
||||
operation = "<" or "<=" or ">" or ">=" or "==" or "!=" or "|^"
|
||||
operator = "<" or "<=" or ">" or ">=" or "==" or "!=" or "|^"
|
||||
value = numeric value to compare to, or LAST
|
||||
these 3 args can be replaced by the word "none" to turn off thresholding
|
||||
{unwrap} arg = {yes} or {no} :pre
|
||||
@ -165,7 +165,7 @@ extra buffering.
|
||||
|
||||
:line
|
||||
|
||||
The {element} keyword applies only to the the dump {cfg}, {xyz}, and
|
||||
The {element} keyword applies only to the dump {cfg}, {xyz}, and
|
||||
{image} styles. It associates element names (e.g. H, C, Fe) with
|
||||
LAMMPS atom types. See the list of element names at the bottom of
|
||||
this page.
|
||||
@ -470,7 +470,7 @@ stress of atoms whose energy is above some threshold.
|
||||
|
||||
If an atom-style variable is used as the attribute, then it can
|
||||
produce continuous numeric values or effective Boolean 0/1 values
|
||||
which may be useful for the comparision operation. Boolean values can
|
||||
which may be useful for the comparision operator. Boolean values can
|
||||
be generated by variable formulas that use comparison or Boolean math
|
||||
operators or special functions like gmask() and rmask() and grmask().
|
||||
See the "variable"_variable.html command doc page for details.
|
||||
@ -503,11 +503,11 @@ less than 1/2 to greater than 1/2 (or vice versa) since the last dump.
|
||||
E.g. due to reactions and subsequent charge equilibration in a
|
||||
reactive force field.
|
||||
|
||||
The choice of operations are the usual comparison operators. The XOR
|
||||
operation (exclusive or) is also included as "|^". In this context,
|
||||
XOR means that if either the attribute or value is 0.0 and the other
|
||||
is non-zero, then the result is "true" and the threshold criterion is
|
||||
met. Otherwise it is not met.
|
||||
The choice of operators listed above are the usual comparison
|
||||
operators. The XOR operation (exclusive or) is also included as "|^".
|
||||
In this context, XOR means that if either the attribute or value is
|
||||
0.0 and the other is non-zero, then the result is "true" and the
|
||||
threshold criterion is met. Otherwise it is not met.
|
||||
|
||||
:line
|
||||
|
||||
@ -574,7 +574,7 @@ e.g. its x-component of velocity if the atom-attribute "vx" was
|
||||
specified.
|
||||
|
||||
The basic idea of a color map is that the atom-attribute will be
|
||||
within a range of values, and that range is associated with a a series
|
||||
within a range of values, and that range is associated with a series
|
||||
of colors (e.g. red, blue, green). An atom's specific value (vx =
|
||||
-3.2) can then mapped to the series of colors (e.g. halfway between
|
||||
red and blue), and a specific color is determined via an interpolation
|
||||
|
||||
66
doc/src/dump_nc.txt
Normal file
@ -0,0 +1,66 @@
|
||||
"LAMMPS WWW Site"_lws - "LAMMPS Documentation"_ld - "LAMMPS Commands"_lc :c
|
||||
|
||||
:link(lws,http://lammps.sandia.gov)
|
||||
:link(ld,Manual.html)
|
||||
:link(lc,Section_commands.html#comm)
|
||||
|
||||
:line
|
||||
|
||||
dump nc command :h3
|
||||
dump nc/mpiio command :h3
|
||||
|
||||
[Syntax:]
|
||||
|
||||
dump ID group-ID nc N file.nc args
|
||||
dump ID group-ID nc/mpiio N file.nc args :pre
|
||||
|
||||
ID = user-assigned name for the dump :ulb,l
|
||||
group-ID = ID of the group of atoms to be imaged :l
|
||||
{nc} or {nc/mpiio} = style of dump command (other styles {atom} or {cfg} or {dcd} or {xtc} or {xyz} or {local} or {custom} are discussed on the "dump"_dump.html doc page) :l
|
||||
N = dump every this many timesteps :l
|
||||
file.nc = name of file to write to :l
|
||||
args = list of per atom data elements to dump, same as for the 'custom' dump style. :l,ule
|
||||
|
||||
[Examples:]
|
||||
|
||||
dump 1 all nc 100 traj.nc type x y z vx vy vz
|
||||
dump_modify 1 append yes at -1 global c_thermo_pe c_thermo_temp c_thermo_press :pre
|
||||
|
||||
dump 1 all nc/mpiio 1000 traj.nc id type x y z :pre
|
||||
|
||||
[Description:]
|
||||
|
||||
Dump a snapshot of atom coordinates every N timesteps in Amber-style
|
||||
NetCDF file format. NetCDF files are binary, portable and
|
||||
self-describing. This dump style will write only one file on the root
|
||||
node. The dump style {nc} uses the "standard NetCDF
|
||||
library"_netcdf-home all data is collected on one processor and then
|
||||
written to the dump file. Dump style {nc/mpiio} used the "parallel
|
||||
NetCDF library"_pnetcdf-home and MPI-IO; it has better performance on
|
||||
a larger number of processors. Note that 'nc' outputs all atoms sorted
|
||||
by atom tag while 'nc/mpiio' outputs in order of the MPI rank.
|
||||
|
||||
In addition to per-atom data, also global (i.e. not per atom, but per
|
||||
frame) quantities can be included in the dump file. This can be
|
||||
variables, output from computes or fixes data prefixed with v_, c_ and
|
||||
f_, respectively. These properties are included via
|
||||
"dump_modify"_dump_modify.html {global}.
|
||||
|
||||
:link(netcdf-home,http://www.unidata.ucar.edu/software/netcdf/)
|
||||
:link(pnetcdf-home,http://trac.mcs.anl.gov/projects/parallel-netcdf/)
|
||||
|
||||
:line
|
||||
|
||||
[Restrictions:]
|
||||
|
||||
The {nc} and {nc/mpiio} dump styles are part of the USER-NC-DUMP
|
||||
package. It is only enabled if LAMMPS was built with that
|
||||
package. See the "Making LAMMPS"_Section_start.html#start_3 section
|
||||
for more info.
|
||||
|
||||
:line
|
||||
|
||||
[Related commands:]
|
||||
|
||||
"dump"_dump.html, "dump_modify"_dump_modify.html, "undump"_undump.html
|
||||
|
||||
@ -190,6 +190,7 @@ of "this page"_Section_commands.html#cmd_5.
|
||||
"gcmc"_fix_gcmc.html - grand canonical insertions/deletions
|
||||
"gld"_fix_gcmc.html - generalized Langevin dynamics integrator
|
||||
"gravity"_fix_gravity.html - add gravity to atoms in a granular simulation
|
||||
"halt"_fix_halt.html - terminate a dynamics run or minimization
|
||||
"heat"_fix_heat.html - add/subtract momentum-conserving heat
|
||||
"indent"_fix_indent.html - impose force due to an indenter
|
||||
"langevin"_fix_langevin.html - Langevin temperature control
|
||||
|
||||
@ -113,7 +113,7 @@ quantity being minimized), you MUST enable the
|
||||
[Restrictions:]
|
||||
|
||||
This fix can only be used if LAMMPS was built with the MOLECULE
|
||||
package (which it is by default). See the "Making
|
||||
package. See the "Making
|
||||
LAMMPS"_Section_start.html#start_3 section for more info on packages.
|
||||
|
||||
[Related commands:]
|
||||
|
||||
@ -150,7 +150,7 @@ initial box length is 100 Angstroms, and V is 10 Angstroms/psec, then
|
||||
after 10 psec, the box length will have doubled. After 20 psec, it
|
||||
will have tripled.
|
||||
|
||||
The {erate} style changes a dimension of the the box at a "constant
|
||||
The {erate} style changes a dimension of the box at a "constant
|
||||
engineering strain rate". The units of the specified strain rate are
|
||||
1/time. See the "units"_units.html command for the time units
|
||||
associated with different choices of simulation units,
|
||||
|
||||
121
doc/src/fix_halt.txt
Normal file
@ -0,0 +1,121 @@
|
||||
"LAMMPS WWW Site"_lws - "LAMMPS Documentation"_ld - "LAMMPS Commands"_lc :c
|
||||
|
||||
:link(lws,http://lammps.sandia.gov)
|
||||
:link(ld,Manual.html)
|
||||
:link(lc,Section_commands.html#comm)
|
||||
|
||||
:line
|
||||
|
||||
fix halt command :h3
|
||||
|
||||
[Syntax:]
|
||||
|
||||
fix ID group-ID halt N attribute operator avalue keyword value ... :pre
|
||||
|
||||
ID, group-ID are documented in "fix"_fix.html command :ulb,l
|
||||
halt = style name of this fix command :l
|
||||
N = check halt condition every N steps :l
|
||||
attribute = hstyle or v_name :l
|
||||
hstyle = {bondmax}
|
||||
v_name = name of "equal-style variable"_variable.html :pre
|
||||
operator = "<" or "<=" or ">" or ">=" or "==" or "!=" or "|^" :l
|
||||
avalue = numeric value to compare attribute to :l
|
||||
string = text string to print with optional variable names :l
|
||||
zero or more keyword/value pairs may be appended :l
|
||||
keyword = {error} :l
|
||||
{error} value = {hard} or {soft} or {continue} :pre
|
||||
:ule
|
||||
|
||||
[Examples:]
|
||||
|
||||
fix 10 all halt 1 bondmax > 1.5
|
||||
fix 10 all print 10 v_myCheck != 0 error soft :pre
|
||||
|
||||
[Description:]
|
||||
|
||||
Check a condition every N steps during a simulation run. N must be >=
|
||||
1. If the condition is met, exit the run immediately. In this
|
||||
context a "run" can be dynamics or minimization iterations, as
|
||||
specified by the "run"_run.html or "minimize"_minimize.html command.
|
||||
|
||||
The specified group-ID is ignored by this fix.
|
||||
|
||||
The specified {attribute} can be one of the {hstyle} options listed
|
||||
above, or an "equal-style variable"_variable.html referenced as
|
||||
{v_name}, where "name" is the name of a variable that has been defined
|
||||
previously in the input script.
|
||||
|
||||
The only {hstyle} option currently implemented is {bondmax}. This
|
||||
will loop over all bonds in the system, compute their current
|
||||
lengths, and set {attribute} to the longest bond distance.
|
||||
|
||||
Equal-style variables evaluate to a numeric value. See the
|
||||
"variable"_variable.html command for a description. They calculate
|
||||
formulas which can involve mathematical operations, atom properties,
|
||||
group properties, thermodynamic properties, global values calculated
|
||||
by a "compute"_compute.html or "fix"_fix.html, or references to other
|
||||
"variables"_variable.html. Thus they are a very general means of
|
||||
computing some attribute of the current system. For example, the
|
||||
following "bondmax" variable will calculate the same quantity as the
|
||||
hstyle = bondmax option.
|
||||
|
||||
compute bdist all bond/local dist
|
||||
compute bmax all reduce max c_bdist
|
||||
variable bondmax equal c_bmax :pre
|
||||
|
||||
Thus these two versions of a fix halt command will do the same thing:
|
||||
|
||||
fix 10 all halt 1 bondmax > 1.5
|
||||
fix 10 all halt 1 v_bondmax > 1.5 :pre
|
||||
|
||||
The version with "bondmax" will just run somewhat faster, due to less
|
||||
overhead in computing bond lengths and not storing them in a separate
|
||||
compute.
|
||||
|
||||
The choice of operators listed above are the usual comparison
|
||||
operators. The XOR operation (exclusive or) is also included as "|^".
|
||||
In this context, XOR means that if either the attribute or avalue is
|
||||
0.0 and the other is non-zero, then the result is "true". Otherwise
|
||||
it is "false".
|
||||
|
||||
The specified {avalue} must be a numeric value.
|
||||
|
||||
:line
|
||||
|
||||
The optional {error} keyword determines how the current run is halted.
|
||||
If its value is {hard}, then LAMMPS will stop with an error message.
|
||||
|
||||
If its value is {soft}, LAMMPS will exit the current run, but continue
|
||||
to execute subsequent commands in the input script. However,
|
||||
additional "run"_run.html or "minimize"_minimize.html commands will be
|
||||
skipped. For example, this allows a script to output the current
|
||||
state of the system, e.g. via a "write_dump"_write_dump.html or
|
||||
"write_restart"_write_restart.html command.
|
||||
|
||||
If its value is {continue}, the behavior is the same as for {soft},
|
||||
except subsequent subsequent "run"_run.html or
|
||||
"minimize"_minimize.html commands are executed. This allows your
|
||||
script to remedy the condition that triggered the halt, if necessary.
|
||||
Note that you may wish use the "unfix"_unfix.html command on the fix
|
||||
halt ID, so that the same condition is not immediately triggered in a
|
||||
subsequent run.
|
||||
|
||||
[Restart, fix_modify, output, run start/stop, minimize info:]
|
||||
|
||||
No information about this fix is written to "binary restart
|
||||
files"_restart.html. None of the "fix_modify"_fix_modify.html options
|
||||
are relevant to this fix. No global or per-atom quantities are stored
|
||||
by this fix for access by various "output
|
||||
commands"_Section_howto.html#howto_15. No parameter of this fix can
|
||||
be used with the {start/stop} keywords of the "run"_run.html command.
|
||||
This fix is not invoked during "energy minimization"_minimize.html.
|
||||
|
||||
[Restrictions:] none
|
||||
|
||||
[Related commands:]
|
||||
|
||||
"variable"_variable.html
|
||||
|
||||
[Default:]
|
||||
|
||||
The option defaults are error = hard.
|
||||
@ -237,7 +237,7 @@ described in the papers cited below, the purpose of this method is to
|
||||
enable longer timesteps to be used (up to the numerical stability
|
||||
limit of the integrator), while still producing the correct Boltzmann
|
||||
distribution of atom positions. It is implemented within LAMMPS, by
|
||||
changing how the the random force is applied so that it is composed of
|
||||
changing how the random force is applied so that it is composed of
|
||||
the average of two random forces representing half-contributions from
|
||||
the previous and current time intervals.
|
||||
|
||||
|
||||
@ -233,7 +233,7 @@ present, the speed of sound squared is set equal to (1/3)*(dx/dt)^2.
|
||||
Setting a0 > (dx/dt)^2 is not allowed, as this may lead to
|
||||
instabilities.
|
||||
|
||||
If the {noise} keyword is used, followed by a a positive temperature
|
||||
If the {noise} keyword is used, followed by a positive temperature
|
||||
value, and a positive integer random number seed, a thermal
|
||||
lattice-Boltzmann algorithm is used. If {LBtype} is set equal to 1
|
||||
(i.e. the standard LB integrator is chosen), the thermal LB algorithm
|
||||
|
||||
@ -184,7 +184,7 @@ This fix requires LAMMPS be built with an FFT library. See the
|
||||
[Default:]
|
||||
|
||||
The option defaults are sysdim = the same dimemsion as specified by
|
||||
the "dimension"_dimension command, and nasr = 20.
|
||||
the "dimension"_dimension.html command, and nasr = 20.
|
||||
|
||||
:line
|
||||
|
||||
|
||||
@ -177,7 +177,7 @@ their values. This means that the values can be output via the "dump
|
||||
custom"_dump.html command, accessed by fixes like "fix
|
||||
ave/atom"_fix_ave_atom.html, accessed by other computes like "compute
|
||||
reduce"_compute_reduce.html, or used in "atom-style
|
||||
variables"_variables.
|
||||
variables"_variable.html.
|
||||
|
||||
For example, these commands will output two new properties to a custom
|
||||
dump file:
|
||||
|
||||
@ -8,6 +8,7 @@
|
||||
|
||||
fix reax/bonds command :h3
|
||||
fix reax/c/bonds command :h3
|
||||
fix reax/c/bonds/kk command :h3
|
||||
|
||||
[Syntax:]
|
||||
|
||||
@ -47,6 +48,31 @@ commands"_Section_howto.html#howto_15. No parameter of this fix can
|
||||
be used with the {start/stop} keywords of the "run"_run.html command.
|
||||
This fix is not invoked during "energy minimization"_minimize.html.
|
||||
|
||||
:line
|
||||
|
||||
Styles with a {gpu}, {intel}, {kk}, {omp}, or {opt} suffix are
|
||||
functionally the same as the corresponding style without the suffix.
|
||||
They have been optimized to run faster, depending on your available
|
||||
hardware, as discussed in "Section_accelerate"_Section_accelerate.html
|
||||
of the manual. The accelerated styles take the same arguments and
|
||||
should produce the same results, except for round-off and precision
|
||||
issues.
|
||||
|
||||
These accelerated styles are part of the GPU, USER-INTEL, KOKKOS,
|
||||
USER-OMP and OPT packages, respectively. They are only enabled if
|
||||
LAMMPS was built with those packages. See the "Making
|
||||
LAMMPS"_Section_start.html#start_3 section for more info.
|
||||
|
||||
You can specify the accelerated styles explicitly in your input script
|
||||
by including their suffix, or you can use the "-suffix command-line
|
||||
switch"_Section_start.html#start_7 when you invoke LAMMPS, or you can
|
||||
use the "suffix"_suffix.html command in your input script.
|
||||
|
||||
See "Section_accelerate"_Section_accelerate.html of the manual for
|
||||
more instructions on how to use the accelerated styles effectively.
|
||||
|
||||
:line
|
||||
|
||||
[Restrictions:]
|
||||
|
||||
The fix reax/bonds command requires that the "pair_style
|
||||
|
||||
@ -7,6 +7,7 @@
|
||||
:line
|
||||
|
||||
fix reax/c/species command :h3
|
||||
fix reax/c/species/kk command :h3
|
||||
|
||||
[Syntax:]
|
||||
|
||||
@ -129,6 +130,31 @@ No parameter of this fix can be used with the {start/stop} keywords of
|
||||
the "run"_run.html command. This fix is not invoked during "energy
|
||||
minimization"_minimize.html.
|
||||
|
||||
:line
|
||||
|
||||
Styles with a {gpu}, {intel}, {kk}, {omp}, or {opt} suffix are
|
||||
functionally the same as the corresponding style without the suffix.
|
||||
They have been optimized to run faster, depending on your available
|
||||
hardware, as discussed in "Section_accelerate"_Section_accelerate.html
|
||||
of the manual. The accelerated styles take the same arguments and
|
||||
should produce the same results, except for round-off and precision
|
||||
issues.
|
||||
|
||||
These accelerated styles are part of the GPU, USER-INTEL, KOKKOS,
|
||||
USER-OMP and OPT packages, respectively. They are only enabled if
|
||||
LAMMPS was built with those packages. See the "Making
|
||||
LAMMPS"_Section_start.html#start_3 section for more info.
|
||||
|
||||
You can specify the accelerated styles explicitly in your input script
|
||||
by including their suffix, or you can use the "-suffix command-line
|
||||
switch"_Section_start.html#start_7 when you invoke LAMMPS, or you can
|
||||
use the "suffix"_suffix.html command in your input script.
|
||||
|
||||
See "Section_accelerate"_Section_accelerate.html of the manual for
|
||||
more instructions on how to use the accelerated styles effectively.
|
||||
|
||||
:line
|
||||
|
||||
[Restrictions:]
|
||||
|
||||
The fix species currently only works with
|
||||
|
||||
@ -620,7 +620,7 @@ rigid styles for the rigid bodies. :l
|
||||
|
||||
Use "fix press/berendsen"_fix_press_berendsen.html to compute the
|
||||
pressure and change the box dimensions. Use one of the 4 NVE or 2 NVT
|
||||
rigid styles for the rigid bodies. Use "fix nvt"_fix_nh.thml (or any
|
||||
rigid styles for the rigid bodies. Use "fix nvt"_fix_nh.html (or any
|
||||
other thermostat) for the non-rigid particles. :l
|
||||
:ule
|
||||
|
||||
|
||||
@ -87,7 +87,7 @@ end of each run. A positive value N means that the diagnostics are reported once
|
||||
per N time-steps.
|
||||
|
||||
The diagnostics report the average # of integrator steps and RHS function evaluations
|
||||
and run-time per ODE as well as the the average/RMS/min/max per process. If the
|
||||
and run-time per ODE as well as the average/RMS/min/max per process. If the
|
||||
reporting frequency is 1, the RMS/min/max per ODE are also reported. The per ODE
|
||||
statistics can be used to adjust the tolerance and min/max step parameters. The
|
||||
statistics per MPI process can be useful to examine any load imbalance caused by the
|
||||
|
||||
@ -28,7 +28,7 @@ fix 1 all smd/adjust_dt 0.1 :pre
|
||||
The fix calculates a new stable time increment for use with the SMD time integrators.
|
||||
|
||||
The stable time increment is based on multiple conditions. For the SPH pair styles, a
|
||||
CFL criterion (Courant, Friedrichs & Lewy, 1928) is evaluated, which determines the the speed of
|
||||
CFL criterion (Courant, Friedrichs & Lewy, 1928) is evaluated, which determines the speed of
|
||||
sound cannot propagate further than a typical spacing between particles within a single time step to ensure
|
||||
no information is lost. For the contact pair styles, a linear analysis of the pair potential determines a
|
||||
stable maximum time step.
|
||||
|
||||
@ -101,7 +101,7 @@ particles move in the normal way via a time integration "fix"_fix.html
|
||||
with a short timestep dt. SRD particles advect with a large timestep
|
||||
dt_SRD >= dt.
|
||||
|
||||
If the {lamda} keyword is not specified, the the SRD temperature
|
||||
If the {lamda} keyword is not specified, the SRD temperature
|
||||
{Tsrd} is used in the above formula to compute lamda. If the {lamda}
|
||||
keyword is specified, then the {Tsrd} setting is ignored and the above
|
||||
equation is used to compute the SRD temperature.
|
||||
|
||||
@ -54,7 +54,7 @@ name. In this case, the variable will be evaluated each timestep, and
|
||||
its value used to determine the target temperature.
|
||||
|
||||
Equal-style variables can specify formulas with various mathematical
|
||||
functions, and include "thermo_style"_thermox_style.html command
|
||||
functions, and include "thermo_style"_thermo_style.html command
|
||||
keywords for the simulation box parameters and timestep and elapsed
|
||||
time. Thus it is easy to specify a time-dependent temperature.
|
||||
|
||||
|
||||
@ -104,7 +104,7 @@ the Nose-Hoover thermostat ("fix nvt"_fix_nh.html) is {NOT}
|
||||
recommended due to its well documented issues with the canonical
|
||||
sampling of harmonic degrees of freedom (notice that the {chain}
|
||||
option will {NOT} solve this problem). The Langevin thermostat ("fix
|
||||
langevin"_fix_langevin.html") correctly thermostats the system and we
|
||||
langevin"_fix_langevin.html) correctly thermostats the system and we
|
||||
advise its usage with ti/spring command.
|
||||
|
||||
[Restart, fix_modify, output, run start/stop, minimize info:]
|
||||
|
||||
@ -107,7 +107,7 @@ specified as parameters to the fix. The other quantities are derived.
|
||||
The form of the heat diffusion equation used here is almost the same
|
||||
as that in equation 6 of "(Duffy)"_#Duffy, with the exception that the
|
||||
electronic density is explicitly reprensented, rather than being part
|
||||
of the the specific heat parameter.
|
||||
of the specific heat parameter.
|
||||
|
||||
Currently, fix ttm assumes that none of the user-supplied parameters
|
||||
will vary with temperature. Note that "(Duffy)"_#Duffy used a tanh()
|
||||
|
||||
@ -163,16 +163,20 @@ info on how to re-specify a fix in an input script that reads a
|
||||
restart file, so that the operation of the fix continues in an
|
||||
uninterrupted fashion.
|
||||
|
||||
Note that info about region definitions is NOT included in restart
|
||||
files. So you must re-define your region and if it is a moving
|
||||
region, define its motion attributes in a way that is consistent with
|
||||
the simulation that wrote the restart file. In particular, if you
|
||||
want to change its motion attributes (e.g. its velocity), then you
|
||||
should insure the postition/orientation of the region at the initial
|
||||
restart timestep is the same as it was on the timestep the restart
|
||||
file was written. If this is not possible, then you may need to
|
||||
ignore info in the restart file by defining a new fix wall/gran/region
|
||||
command in your restart script (e.g. with a different fix ID).
|
||||
NOTE: Information about region definitions is NOT included in restart
|
||||
files, as discussed on the "read_restart"_read_restart.html doc page.
|
||||
So you must re-define your region and if it is a moving region, define
|
||||
its motion attributes in a way that is consistent with the simulation
|
||||
that wrote the restart file. In particular, if you want to change the
|
||||
region motion attributes (e.g. its velocity), then you should ensure
|
||||
the postition/orientation of the region at the initial restart
|
||||
timestep is the same as it was on the timestep the restart file was
|
||||
written. If this is not possible, you may need to ignore info in the
|
||||
restart file by defining a new fix wall/gran/region command in your
|
||||
restart script, e.g. with a different fix ID. Or if you want to keep
|
||||
the shear history info but discard the region motion information, you
|
||||
can use the same fix ID for fix wall/gran/region, but assign it a
|
||||
region with a different region ID.
|
||||
|
||||
None of the "fix_modify"_fix_modify.html options are relevant to this
|
||||
fix. No global or per-atom quantities are stored by this fix for
|
||||
|
||||
@ -48,6 +48,7 @@ Fixes :h1
|
||||
fix_gld
|
||||
fix_gle
|
||||
fix_gravity
|
||||
fix_halt
|
||||
fix_heat
|
||||
fix_imd
|
||||
fix_indent
|
||||
|
||||
@ -77,7 +77,7 @@ more instructions on how to use the accelerated styles effectively.
|
||||
[Restrictions:]
|
||||
|
||||
This improper style can only be used if LAMMPS was built with the
|
||||
MOLECULE package (which it is by default). See the "Making
|
||||
MOLECULE package. See the "Making
|
||||
LAMMPS"_Section_start.html#start_3 section for more info on packages.
|
||||
|
||||
[Related commands:]
|
||||
|
||||
@ -81,7 +81,7 @@ more instructions on how to use the accelerated styles effectively.
|
||||
[Restrictions:]
|
||||
|
||||
This improper style can only be used if LAMMPS was built with the
|
||||
MOLECULE package (which it is by default). See the "Making
|
||||
MOLECULE package. See the "Making
|
||||
LAMMPS"_Section_start.html#start_3 section for more info on packages.
|
||||
|
||||
[Related commands:]
|
||||
|
||||
@ -55,7 +55,7 @@ types.
|
||||
[Restrictions:]
|
||||
|
||||
This improper style can only be used if LAMMPS was built with the
|
||||
MOLECULE package (which it is by default). See the "Making
|
||||
MOLECULE package. See the "Making
|
||||
LAMMPS"_Section_start.html#start_3 section for more info on packages.
|
||||
|
||||
Unlike other improper styles, the hybrid improper style does not store
|
||||
|
||||
@ -27,7 +27,7 @@ between quadruplets of atoms, which remain in force for the duration
|
||||
of the simulation. The list of improper quadruplets is read in by a
|
||||
"read_data"_read_data.html or "read_restart"_read_restart.html command
|
||||
from a data or restart file. Note that the ordering of the 4 atoms in
|
||||
an improper quadruplet determines the the definition of the improper
|
||||
an improper quadruplet determines the definition of the improper
|
||||
angle used in the formula for each style. See the doc pages of
|
||||
individual styles for details.
|
||||
|
||||
|
||||
@ -74,7 +74,7 @@ more instructions on how to use the accelerated styles effectively.
|
||||
[Restrictions:]
|
||||
|
||||
This improper style can only be used if LAMMPS was built with the
|
||||
MOLECULE package (which it is by default). See the "Making
|
||||
MOLECULE package. See the "Making
|
||||
LAMMPS"_Section_start.html#start_3 section for more info on packages.
|
||||
|
||||
[Related commands:]
|
||||
|
||||
@ -14,7 +14,7 @@ info args :pre
|
||||
|
||||
args = one or more of the following keywords: {out}, {all}, {system}, {communication}, {computes}, {dumps}, {fixes}, {groups}, {regions}, {variables}, {styles}, {time}, or {configuration}
|
||||
{out} values = {screen}, {log}, {append} filename, {overwrite} filename
|
||||
{styles} values = {all}, {angle}, {atom}, {bond}, {compute}, {command}, {dump}, {dihedral}, {fix}, {improper}, {integrate}, {kspace}, {minimize}, {region} :ul
|
||||
{styles} values = {all}, {angle}, {atom}, {bond}, {compute}, {command}, {dump}, {dihedral}, {fix}, {improper}, {integrate}, {kspace}, {minimize}, {pair}, {region} :ul
|
||||
|
||||
[Examples:]
|
||||
|
||||
@ -70,8 +70,9 @@ The {variables} category prints a list of all currently defined
|
||||
variables, their names, styles, definition and last computed value, if
|
||||
available.
|
||||
|
||||
The {styles} category prints the list of styles available in LAMMPS. It
|
||||
supports one of the following options to control what is printed out:
|
||||
The {styles} category prints the list of styles available in the
|
||||
current LAMMPS binary. It supports one of the following options
|
||||
to control which category of styles is printed out:
|
||||
|
||||
all
|
||||
angle
|
||||
@ -86,6 +87,7 @@ improper
|
||||
integrate
|
||||
kspace
|
||||
minimize
|
||||
pair
|
||||
region :ul
|
||||
|
||||
The {time} category prints the accumulated CPU and wall time for the
|
||||
|
||||
@ -59,6 +59,7 @@ dump_h5md.html
|
||||
dump_image.html
|
||||
dump_modify.html
|
||||
dump_molfile.html
|
||||
dump_nc.html
|
||||
echo.html
|
||||
fix.html
|
||||
fix_modify.html
|
||||
@ -152,6 +153,7 @@ fix_colvars.html
|
||||
fix_controller.html
|
||||
fix_deform.html
|
||||
fix_deposit.html
|
||||
fix_dpd_energy.html
|
||||
fix_drag.html
|
||||
fix_drude.html
|
||||
fix_drude_transform.html
|
||||
@ -170,6 +172,7 @@ fix_gcmc.html
|
||||
fix_gld.html
|
||||
fix_gle.html
|
||||
fix_gravity.html
|
||||
fix_halt.html
|
||||
fix_heat.html
|
||||
fix_imd.html
|
||||
fix_indent.html
|
||||
@ -271,6 +274,7 @@ fix_viscosity.html
|
||||
fix_viscous.html
|
||||
fix_wall.html
|
||||
fix_wall_gran.html
|
||||
fix_wall_gran_region.html
|
||||
fix_wall_piston.html
|
||||
fix_wall_reflect.html
|
||||
fix_wall_region.html
|
||||
@ -389,6 +393,7 @@ compute_voronoi_atom.html
|
||||
compute_xrd.html
|
||||
|
||||
pair_adp.html
|
||||
pair_agni.html
|
||||
pair_airebo.html
|
||||
pair_awpmd.html
|
||||
pair_beck.html
|
||||
@ -621,3 +626,4 @@ USER/atc/man_unfix_flux.html
|
||||
USER/atc/man_unfix_nodes.html
|
||||
USER/atc/man_write_atom_weights.html
|
||||
USER/atc/man_write_restart.html
|
||||
|
||||
|
||||
@ -103,6 +103,11 @@ the line search fails because the step distance backtracks to 0.0
|
||||
the number of outer iterations or timesteps exceeds {maxiter}
|
||||
the number of total force evaluations exceeds {maxeval} :ul
|
||||
|
||||
NOTE: You can also use the "fix halt"_fix_halt.html command to specify
|
||||
a general criterion for exiting a minimization, that is a calculation
|
||||
performed on the state of the current system, as defined by an
|
||||
"equal-style variable"_variable.html.
|
||||
|
||||
For the first criterion, the specified energy tolerance {etol} is
|
||||
unitless; it is met when the energy change between successive
|
||||
iterations divided by the energy magnitude is less than or equal to
|
||||
|
||||
@ -83,9 +83,9 @@ replica. Conceptually, the non-NEB atoms provide a background force
|
||||
field for the NEB atoms. They can be allowed to move during the NEB
|
||||
minimiation procedure (which will typically induce different
|
||||
coordinates for non-NEB atoms in different replicas), or held fixed
|
||||
using other LAMMPS commands such as "fix setforce"_fix_setforce. Note
|
||||
that the "partition"_partition.html command can be used to invoke a
|
||||
command on a subset of the replicas, e.g. if you wish to hold NEB or
|
||||
using other LAMMPS commands such as "fix setforce"_fix_setforce.html.
|
||||
Note that the "partition"_partition.html command can be used to invoke
|
||||
a command on a subset of the replicas, e.g. if you wish to hold NEB or
|
||||
non-NEB atoms fixed in only the end-point replicas.
|
||||
|
||||
The initial atomic configuration for each of the replicas can be
|
||||
@ -284,7 +284,7 @@ ID2 x2 y2 z2
|
||||
...
|
||||
IDN xN yN zN :pre
|
||||
|
||||
The fields are the the atom ID, followed by the x,y,z coordinates.
|
||||
The fields are the atom ID, followed by the x,y,z coordinates.
|
||||
The lines can be listed in any order. Additional trailing information
|
||||
on the line is OK, such as a comment.
|
||||
|
||||
|
||||
@ -44,7 +44,7 @@ one value from their respective list of values. A {file}-style
|
||||
variable reads the next line from its associated file. An
|
||||
{atomfile}-style variable reads the next set of lines (one per atom)
|
||||
from its associated file. {String-} or {atom}- or {equal}- or
|
||||
{world}-style variables cannot be used with the the next command,
|
||||
{world}-style variables cannot be used with the next command,
|
||||
since they only store a single value.
|
||||
|
||||
When any of the variables in the next command has no more values, a
|
||||
|
||||
@ -168,7 +168,7 @@ This pair style can only be used via the {pair} keyword of the
|
||||
[Restrictions:]
|
||||
|
||||
This pair style is part of the MANYBODY package. It is only enabled
|
||||
if LAMMPS was built with that package (which it is by default).
|
||||
if LAMMPS was built with that package.
|
||||
|
||||
[Related commands:]
|
||||
|
||||
|
||||
128
doc/src/pair_agni.txt
Normal file
@ -0,0 +1,128 @@
|
||||
"LAMMPS WWW Site"_lws - "LAMMPS Documentation"_ld - "LAMMPS Commands"_lc :c
|
||||
|
||||
:link(lws,http://lammps.sandia.gov)
|
||||
:link(ld,Manual.html)
|
||||
:link(lc,Section_commands.html#comm)
|
||||
|
||||
:line
|
||||
|
||||
pair_style agni command :h3
|
||||
pair_style agni/omp command :h3
|
||||
|
||||
[Syntax:]
|
||||
|
||||
pair_style agni :pre
|
||||
|
||||
[Examples:]
|
||||
pair_style agni
|
||||
pair_coeff * * Al.agni Al
|
||||
|
||||
[Description:]
|
||||
|
||||
Style {agni} style computes the manybody vectorial force components for
|
||||
an atom as
|
||||
|
||||
:c,image(Eqs/pair_agni.jpg)
|
||||
|
||||
{u} labels the individual components, i.e. x, y or z, and {V} is the
|
||||
corresponding atomic fingerprint. {d} is the Euclidean distance between
|
||||
any two atomic fingerprints. A total of N_t reference atomic
|
||||
environments are considered to construct the force field file. {alpha_t}
|
||||
and {l} are the weight coefficients and length scale parameter of the
|
||||
non-linear regression model.
|
||||
|
||||
The method implements the recently proposed machine learning access to
|
||||
atomic forces as discussed extensively in the following publications -
|
||||
"(Botu1)"_#Botu2015adaptive and "(Botu2)"_#Botu2015learning. The premise
|
||||
of the method is to map the atomic enviornment numerically into a
|
||||
fingerprint, and use machine learning methods to create a mapping to the
|
||||
vectorial atomic forces.
|
||||
|
||||
Only a single pair_coeff command is used with the {agni} style which
|
||||
specifies an AGNI potential file containing the parameters of the
|
||||
force field for the needed elements. These are mapped to LAMMPS atom
|
||||
types by specifying N additional arguments after the filename in the
|
||||
pair_coeff command, where N is the number of LAMMPS atom types:
|
||||
|
||||
filename
|
||||
N element names = mapping of AGNI elements to atom types :ul
|
||||
|
||||
See the "pair_coeff"_pair_coeff.html doc page for alternate ways
|
||||
to specify the path for the force field file.
|
||||
|
||||
An AGNI force field is fully specified by the filename which contains the
|
||||
parameters of the force field, i.e., the reference training environments
|
||||
used to construct the machine learning force field. Example force field
|
||||
and input files are provided in the examples/USER/misc/agni directory.
|
||||
|
||||
:line
|
||||
|
||||
Styles with {omp} suffix is functionally the same as the corresponding
|
||||
style without the suffix. They have been optimized to run faster, depending
|
||||
on your available hardware, as discussed in "Section 5"_Section_accelerate.html
|
||||
of the manual. The accelerated style takes the same arguments and
|
||||
should produce the same results, except for round-off and precision
|
||||
issues.
|
||||
|
||||
The accelerated style is part of the USER-OMP. They are only enabled if
|
||||
LAMMPS was built with those packages. See the "Making
|
||||
LAMMPS"_Section_start.html#start_3 section for more info.
|
||||
|
||||
You can specify the accelerated style explicitly in your input script
|
||||
by including their suffix, or you can use the "-suffix command-line
|
||||
switch"_Section_start.html#start_7 when you invoke LAMMPS, or you can
|
||||
use the "suffix"_suffix.html command in your input script.
|
||||
|
||||
See "Section 5"_Section_accelerate.html of the manual for
|
||||
more instructions on how to use the accelerated styles effectively.
|
||||
|
||||
:line
|
||||
|
||||
[Mixing, shift, table, tail correction, restart, rRESPA info]:
|
||||
|
||||
This pair style does not support the "pair_modify"_pair_modify.html
|
||||
shift, table, and tail options.
|
||||
|
||||
This pair style does not write its information to "binary restart
|
||||
files"_restart.html, since it is stored in potential files. Thus, you
|
||||
need to re-specify the pair_style and pair_coeff commands in an input
|
||||
script that reads a restart file.
|
||||
|
||||
This pair style can only be used via the {pair} keyword of the
|
||||
"run_style respa"_run_style.html command. It does not support the
|
||||
{inner}, {middle}, {outer} keywords.
|
||||
|
||||
:line
|
||||
|
||||
[Restrictions:]
|
||||
|
||||
Currently, only elemental systems are implemented. Also, the method only
|
||||
provides access to the forces and not energies or stresses. However, one
|
||||
can access the energy via thermodynamic integration of the forces as
|
||||
discussed in "(Botu3)"_#Botu2016construct. This pair style is part
|
||||
of the USER-MISC package. It is only enabled if LAMMPS was built with
|
||||
that package. See the "Making LAMMPS"_Section_start.html#start_3 section
|
||||
for more info.
|
||||
|
||||
The AGNI force field files provided with LAMMPS (see the
|
||||
potentials directory) are parameterized for metal "units"_units.html.
|
||||
You can use the AGNI potential with any LAMMPS units, but you would need
|
||||
to create your own AGNI potential file with coefficients listed in the
|
||||
appropriate units if your simulation doesn't use "metal" units.
|
||||
|
||||
[Related commands:]
|
||||
|
||||
"pair_coeff"_pair_coeff.html
|
||||
|
||||
[Default:] none
|
||||
|
||||
:line
|
||||
|
||||
:link(Botu2015adaptive)
|
||||
[(Botu1)] V. Botu and R. Ramprasad, Int. J. Quant. Chem., 115(16), 1074 (2015).
|
||||
|
||||
:link(Botu2015learning)
|
||||
[(Botu2)] V. Botu and R. Ramprasad, Phys. Rev. B, 92(9), 094306 (2015).
|
||||
|
||||
:link(Botu2016construct)
|
||||
[(Botu3)] V. Botu, R. Batra, J. Chapman and R. Ramprasad, https://arxiv.org/abs/1610.02098 (2016).
|
||||
@ -203,9 +203,8 @@ These pair styles can only be used via the {pair} keyword of the
|
||||
[Restrictions:]
|
||||
|
||||
These pair styles are part of the MANYBODY package. They are only
|
||||
enabled if LAMMPS was built with that package (which it is by
|
||||
default). See the "Making LAMMPS"_Section_start.html#start_3 section
|
||||
for more info.
|
||||
enabled if LAMMPS was built with that package. See the
|
||||
"Making LAMMPS"_Section_start.html#start_3 section for more info.
|
||||
|
||||
These pair potentials require the "newton"_newton.html setting to be
|
||||
"on" for pair interactions.
|
||||
|
||||
@ -382,7 +382,7 @@ This pair style can only be used via the {pair} keyword of the
|
||||
[Restrictions:]
|
||||
|
||||
These pair styles are part of the MANYBODY package. They are only
|
||||
enabled if LAMMPS was built with that package (which it is by default).
|
||||
enabled if LAMMPS was built with that package.
|
||||
See the "Making LAMMPS"_Section_start.html#start_3 section for more
|
||||
info.
|
||||
|
||||
|
||||
@ -19,6 +19,8 @@ pair_style born/coul/msm/omp command :h3
|
||||
pair_style born/coul/wolf command :h3
|
||||
pair_style born/coul/wolf/gpu command :h3
|
||||
pair_style born/coul/wolf/omp command :h3
|
||||
pair_style born/coul/dsf command :h3
|
||||
pair_style born/coul/dsf/cs command :h3
|
||||
|
||||
[Syntax:]
|
||||
|
||||
@ -37,7 +39,11 @@ args = list of arguments for a particular style :ul
|
||||
{born/coul/wolf} args = alpha cutoff (cutoff2)
|
||||
alpha = damping parameter (inverse distance units)
|
||||
cutoff = global cutoff for non-Coulombic (and Coulombic if only 1 arg) (distance units)
|
||||
cutoff2 = global cutoff for Coulombic (optional) (distance units) :pre
|
||||
cutoff2 = global cutoff for Coulombic (optional) (distance units)
|
||||
{born/coul/dsf} or {born/coul/dsf/cs} args = alpha cutoff (cutoff2)
|
||||
alpha = damping parameter (inverse distance units)
|
||||
cutoff = global cutoff for non-Coulombic (and Coulombic if only 1 arg) (distance units)
|
||||
cutoff2 = global cutoff for Coulombic (distance units) :pre
|
||||
|
||||
[Examples:]
|
||||
|
||||
@ -62,6 +68,10 @@ pair_style born/coul/wolf 0.25 10.0 9.0
|
||||
pair_coeff * * 6.08 0.317 2.340 24.18 11.51
|
||||
pair_coeff 1 1 6.08 0.317 2.340 24.18 11.51 :pre
|
||||
|
||||
pair_style born/coul/dsf 0.1 10.0 12.0
|
||||
pair_coeff * * 0.0 1.00 0.00 0.00 0.00
|
||||
pair_coeff 1 1 480.0 0.25 0.00 1.05 0.50 :pre
|
||||
|
||||
[Description:]
|
||||
|
||||
The {born} style computes the Born-Mayer-Huggins or Tosi/Fumi
|
||||
@ -90,10 +100,14 @@ term.
|
||||
The {born/coul/wolf} style adds a Coulombic term as described for the
|
||||
Wolf potential in the "coul/wolf"_pair_coul.html pair style.
|
||||
|
||||
The {born/coul/dsf} style computes the Coulomb contribution with the
|
||||
damped shifted force model as in the "coul/dsf"_pair_coul.html style.
|
||||
|
||||
Style {born/coul/long/cs} is identical to {born/coul/long} except that
|
||||
a term is added for the "core/shell model"_Section_howto.html#howto_25
|
||||
to allow charges on core and shell particles to be separated by r =
|
||||
0.0.
|
||||
0.0. The same correction is introduced for {born/coul/dsf/cs} style
|
||||
which is identical to {born/coul/dsf}.
|
||||
|
||||
Note that these potentials are related to the "Buckingham
|
||||
potential"_pair_buck.html.
|
||||
@ -116,9 +130,10 @@ The second coefficient, rho, must be greater than zero.
|
||||
The last coefficient is optional. If not specified, the global A,C,D
|
||||
cutoff specified in the pair_style command is used.
|
||||
|
||||
For {born/coul/long} and {born/coul/wolf} no Coulombic cutoff can be
|
||||
specified for an individual I,J type pair. All type pairs use the
|
||||
same global Coulombic cutoff specified in the pair_style command.
|
||||
For {born/coul/long}, {born/coul/wolf} and {born/coul/dsf} no
|
||||
Coulombic cutoff can be specified for an individual I,J type pair.
|
||||
All type pairs use the same global Coulombic cutoff specified in the
|
||||
pair_style command.
|
||||
|
||||
:line
|
||||
|
||||
@ -174,9 +189,8 @@ respa"_run_style.html command. They do not support the {inner},
|
||||
[Restrictions:]
|
||||
|
||||
The {born/coul/long} style is part of the KSPACE package. It is only
|
||||
enabled if LAMMPS was built with that package (which it is by
|
||||
default). See the "Making LAMMPS"_Section_start.html#start_3 section
|
||||
for more info.
|
||||
enabled if LAMMPS was built with that package. See the
|
||||
"Making LAMMPS"_Section_start.html#start_3 section for more info.
|
||||
|
||||
[Related commands:]
|
||||
|
||||
|
||||
@ -186,9 +186,8 @@ respa"_run_style.html command. They do not support the {inner},
|
||||
|
||||
The {buck/coul/long} style is part of the KSPACE package. The
|
||||
{buck/coul/long/cs} style is part of the CORESHELL package. They are
|
||||
only enabled if LAMMPS was built with that package (which it is by
|
||||
default). See the "Making LAMMPS"_Section_start.html#start_3 section
|
||||
for more info.
|
||||
only enabled if LAMMPS was built with that package. See the
|
||||
"Making LAMMPS"_Section_start.html#start_3 section for more info.
|
||||
|
||||
[Related commands:]
|
||||
|
||||
|
||||
@ -156,7 +156,7 @@ These pair styles can only be used via the {pair} keyword of the
|
||||
[Restrictions:]
|
||||
|
||||
These pair styles are part of the MANYBODY package. It is only enabled
|
||||
if LAMMPS was built with that package (which it is by default). See
|
||||
if LAMMPS was built with that package. See
|
||||
the "Making LAMMPS"_Section_start.html#start_3 section for more info.
|
||||
|
||||
These pair styles requires the "newton"_newton.html setting to be "on"
|
||||
|
||||
@ -313,9 +313,8 @@ This pair style can only be used via the {pair} keyword of the
|
||||
|
||||
The {coul/long}, {coul/msm} and {tip4p/long} styles are part of the
|
||||
KSPACE package. The {coul/long/cs} style is part of the CORESHELL
|
||||
package. They are only enabled if LAMMPS was built with that package
|
||||
(which it is by default). See the "Making
|
||||
LAMMPS"_Section_start.html#start_3 section for more info.
|
||||
package. They are only enabled if LAMMPS was built with that package.
|
||||
See the "Making LAMMPS"_Section_start.html#start_3 section for more info.
|
||||
|
||||
[Related commands:]
|
||||
|
||||
|
||||
@ -8,19 +8,24 @@
|
||||
|
||||
pair_style born/coul/long/cs command :h3
|
||||
pair_style buck/coul/long/cs command :h3
|
||||
pair_style born/coul/dsf/cs command :h3
|
||||
|
||||
[Syntax:]
|
||||
|
||||
pair_style style args :pre
|
||||
|
||||
style = {born/coul/long/cs} or {buck/coul/long/cs}
|
||||
style = {born/coul/long/cs} or {buck/coul/long/cs} or {born/coul/dsf/cs}
|
||||
args = list of arguments for a particular style :ul
|
||||
{born/coul/long/cs} args = cutoff (cutoff2)
|
||||
cutoff = global cutoff for non-Coulombic (and Coulombic if only 1 arg) (distance units)
|
||||
cutoff2 = global cutoff for Coulombic (optional) (distance units)
|
||||
{buck/coul/long/cs} args = cutoff (cutoff2)
|
||||
cutoff = global cutoff for Buckingham (and Coulombic if only 1 arg) (distance units)
|
||||
cutoff2 = global cutoff for Coulombic (optional) (distance units) :pre
|
||||
cutoff2 = global cutoff for Coulombic (optional) (distance units)
|
||||
{born/coul/dsf/cs} args = alpha cutoff (cutoff2)
|
||||
alpha = damping parameter (inverse distance units)
|
||||
cutoff = global cutoff for non-Coulombic (and Coulombic if only 1 arg) (distance units)
|
||||
cutoff2 = global cutoff for Coulombic (distance units) :pre
|
||||
|
||||
[Examples:]
|
||||
|
||||
@ -32,6 +37,10 @@ pair_style buck/coul/long/cs 10.0 8.0
|
||||
pair_coeff * * 100.0 1.5 200.0
|
||||
pair_coeff 1 1 100.0 1.5 200.0 9.0 :pre
|
||||
|
||||
pair_style born/coul/dsf/cs 0.1 10.0 12.0
|
||||
pair_coeff * * 0.0 1.00 0.00 0.00 0.00
|
||||
pair_coeff 1 1 480.0 0.25 0.00 1.05 0.50 :pre
|
||||
|
||||
[Description:]
|
||||
|
||||
These pair styles are designed to be used with the adiabatic
|
||||
@ -39,7 +48,7 @@ core/shell model of "(Mitchell and Finchham)"_#MitchellFinchham. See
|
||||
"Section 6.25"_Section_howto.html#howto_25 of the manual for an
|
||||
overview of the model as implemented in LAMMPS.
|
||||
|
||||
These pair styles are identical to the "pair_style
|
||||
The styles with a {coul/long} term are identical to the "pair_style
|
||||
born/coul/long"_pair_born.html and "pair_style
|
||||
buck/coul/long"_pair_buck.html styles, except they correctly treat the
|
||||
special case where the distance between two charged core and shell
|
||||
@ -63,6 +72,14 @@ where C is an energy-conversion constant, Qi and Qj are the charges on
|
||||
the core and shell, epsilon is the dielectric constant and r_min is the
|
||||
minimal distance.
|
||||
|
||||
The pair style {born/coul/dsf/cs} is identical to the
|
||||
"pair_style born/coul/dsf"_pair_born.html style, which uses the
|
||||
the damped shifted force model as in "coul/dsf"_pair_coul.html
|
||||
to compute the Coulomb contribution. This approach does not require
|
||||
a long-range solver, thus the only correction is the addition of a
|
||||
minimal distance to avoid the possible r = 0.0 case for a
|
||||
core/shell pair.
|
||||
|
||||
[Restrictions:]
|
||||
|
||||
These pair styles are part of the CORESHELL package. They are only
|
||||
|
||||
@ -412,9 +412,8 @@ The eam pair styles can only be used via the {pair} keyword of the
|
||||
[Restrictions:]
|
||||
|
||||
All of these styles except the {eam/cd} style are part of the MANYBODY
|
||||
package. They are only enabled if LAMMPS was built with that package
|
||||
(which it is by default). See the "Making
|
||||
LAMMPS"_Section_start.html#start_3 section for more info.
|
||||
package. They are only enabled if LAMMPS was built with that package.
|
||||
See the "Making LAMMPS"_Section_start.html#start_3 section for more info.
|
||||
|
||||
The {eam/cd} style is part of the USER-MISC package and also requires
|
||||
the MANYBODY package. It is only enabled if LAMMPS was built with
|
||||
|
||||
@ -159,7 +159,7 @@ more instructions on how to use the accelerated styles effectively.
|
||||
[Restrictions:]
|
||||
|
||||
This style is part of the MANYBODY package. It is only enabled if
|
||||
LAMMPS was built with that package (which it is by default).
|
||||
LAMMPS was built with that package.
|
||||
|
||||
[Related commands:]
|
||||
|
||||
|
||||
@ -106,8 +106,31 @@ more instructions on how to use the accelerated styles effectively.
|
||||
|
||||
[Mixing, shift, table, tail correction, restart, rRESPA info]:
|
||||
|
||||
These pair styles do not support mixing. Thus, coefficients for all
|
||||
I,J pairs must be specified explicitly.
|
||||
For atom type pairs I,J and I != J, the A, B, H, sigma_h, r_mh
|
||||
parameters, and the cutoff distance for these pair styles can be mixed:
|
||||
A (energy units)
|
||||
sqrt(1/B) (distance units, see below)
|
||||
H (energy units)
|
||||
sigma_h (distance units)
|
||||
r_mh (distance units)
|
||||
cutoff (distance units):ul
|
||||
|
||||
The default mix value is {geometric}.
|
||||
Only {arithmetic} and {geometric} mix values are supported.
|
||||
See the "pair_modify" command for details.
|
||||
|
||||
The A and H parameters are mixed using the same rules normally
|
||||
used to mix the "epsilon" parameter in a Lennard Jones interaction.
|
||||
The sigma_h, r_mh, and the cutoff distance are mixed using the same
|
||||
rules used to mix the "sigma" parameter in a Lennard Jones interaction.
|
||||
The B parameter is converted to a distance (sigma), before mixing
|
||||
(using sigma=B^-0.5), and converted back to a coefficient
|
||||
afterwards (using B=sigma^2).
|
||||
Negative A values are converted to positive A values (using abs(A))
|
||||
before mixing, and converted back after mixing
|
||||
(by multiplying by sign(Ai)*sign(Aj)).
|
||||
This way, if either particle is repulsive (if Ai<0 or Aj<0),
|
||||
then the default interaction between both particles will be repulsive.
|
||||
|
||||
The {gauss} style does not support the "pair_modify"_pair_modify.html
|
||||
shift option. There is no effect due to the Gaussian well beyond the
|
||||
|
||||
@ -138,8 +138,8 @@ angle cutoff (degrees) :ul
|
||||
A single hydrogen atom type K can be specified, or a wild-card
|
||||
asterisk can be used in place of or in conjunction with the K
|
||||
arguments to select multiple types as hydrogens. This takes the form
|
||||
"*" or "*n" or "n*" or "m*n". See the "pair_coeff"_pair_coeff command
|
||||
doc page for details.
|
||||
"*" or "*n" or "n*" or "m*n". See the "pair_coeff"_pair_coeff.html
|
||||
command doc page for details.
|
||||
|
||||
If the donor flag is {i}, then the atom of type I in the pair_coeff
|
||||
command is treated as the donor, and J is the acceptor. If the donor
|
||||
|
||||