Compare commits

...

339 Commits

Author SHA1 Message Date
e6321e1020 Merge pull request #1246 from akohlmey/next-patch-release
Patch release 7 December 2018
2018-12-07 14:15:12 -05:00
0165f18d59 Merge pull request #1241 from akohlmey/collected-small-fixes
Collected small changes and updates for stable release
2018-12-07 11:28:26 -05:00
c36f8390d2 Merge pull request #1240 from akohlmey/fix-tune-kspace-limits
Detect fix tune/kspace incompatible configurations
2018-12-07 11:28:02 -05:00
57204a0f66 reformat recently changed paragraphs in the manual 2018-12-07 10:38:01 -05:00
4f00984bbc Merge branch 'master' into collected-small-fixes 2018-12-07 10:32:33 -05:00
f02eab3990 Merge pull request #1248 from junghans/cmake-plumed
cmake: USER-PLUMED does not depend on LAPACK anymore
2018-12-07 10:31:18 -05:00
4792ff1dc2 Merge pull request #1247 from gtribello/master
Changes to manual related to the USER-PLUMED package
2018-12-07 10:30:35 -05:00
998a512143 update log files for USER-UEF 2018-12-07 10:19:34 -05:00
29dcf8348b No longer require LAPACK and BLAS to compile PLUMED+LAMMPS so removed this statement from docs 2018-12-07 15:16:40 +00:00
1bd81db9b3 Fixed spelling mistakes 2018-12-07 15:15:35 +00:00
a30e1b2670 cmake: USER-PLUMED does not LAPACK anymore 2018-12-07 06:10:29 -07:00
4a4dbc7da5 Added further instructions on building of PLUMED+LAMMPS 2018-12-07 12:49:00 +00:00
0244841b27 auto-request a review from @sjplimp when the LAMMPS version is updated 2018-12-07 06:15:03 -05:00
ee98dc0b96 step version number to 7 December 2018 2018-12-07 06:11:30 -05:00
e61b553bb3 update USER-MOFF log files 2018-12-07 05:54:02 -05:00
f8da830c07 fix new[]/delete mismatches and a memory leak in USER-DIFFRACTION package 2018-12-07 05:51:02 -05:00
20eca799b1 update log files for USER-DIFFRACTION package 2018-12-07 05:50:39 -05:00
d802817cca Small changes to the documentation for building and using PLUMED 2018-12-07 10:39:10 +00:00
8ce60d8761 update USER-CGSDK and USER-COLVARS log files 2018-12-07 05:03:26 -05:00
c44620f00e make sure all class pointers in the LAMMPS class are initialized to NULL
some early use of the LAMMPS class may produce segmentation faults,
if member classes are not yet initialized and their pointers are
pointing to random locations. For NULL we can easily test.
2018-12-07 04:34:00 -05:00
a5f75bbabd plug memory leaks in USER-CGDNA package pair styles 2018-12-07 04:33:33 -05:00
685a8bfc62 update or add logs for USER-AWPMD, USER-BOCS, and USER-CGDNA 2018-12-07 04:32:46 -05:00
cd0924ca4c add log files for USER-AWPMD examples 2018-12-07 03:49:46 -05:00
18f7e96e8a update log files for USER-PLUMED examples 2018-12-06 19:07:36 -05:00
984f415196 fix memory leak in fix plumed 2018-12-06 19:05:39 -05:00
e01ba84fd2 update log files for USER-SCAFACOS 2018-12-06 19:01:20 -05:00
e37436d646 plug memory leak and avoid accessing uninitialized memory in virial computation and properly handle PPPM/Ewald cases that don't compute a virial 2018-12-06 18:54:25 -05:00
9ee076e4c7 correct formatting of preformatted text 2018-12-04 10:40:31 -05:00
e1aff27cd4 Merge remote-tracking branch 'devel/whitespace-cleanup' into collected-small-fixes 2018-12-03 15:06:23 -05:00
4af7e706d7 correctly compute hash for temporary directory used by manual building 2018-12-03 14:59:43 -05:00
1c795a6be3 remove trailing blanks 2018-12-01 21:38:22 -05:00
4ec05a3389 remove some more trailing whitespace 2018-12-01 08:14:02 -05:00
c69fc90588 detect more incompatible setups for fix tune/kspace, and document 2018-12-01 02:48:22 -05:00
67041a5446 Merge pull request #1231 from lammps/update-log-files
Update log files for example inputs, part 1
2018-11-30 11:07:44 -05:00
f380a03a07 Merge pull request #1237 from akohlmey/compute-mop-bugfix
Make compute stress/mop and stress/mop/profile compatible with per-atom masses
2018-11-30 11:07:17 -05:00
7b68655c4d remove trailing whitespace 2018-11-30 08:00:08 -05:00
dd84b5c975 make compute stress/mop and stress/mop/profile compatible with per-atom masses 2018-11-30 07:50:57 -05:00
1f210a246e Merge pull request #1234 from lammps/read-dump-keep
bug-fix for miscounting atoms for read_dump add keep
2018-11-29 18:33:45 -05:00
5d2730f055 update log files for rigid, shear, snap, srd, streitz, threebody, vashsista, and voronoi examples 2018-11-29 18:22:18 -05:00
e4ca5b1889 Merge pull request #1232 from akohlmey/collected-small-fixes
First chunk of collected small fixes for the stable release
2018-11-29 18:19:12 -05:00
f92e61c58d bug-fix for miscounting atoms for read_dump add keep 2018-11-29 15:37:58 -07:00
cda3227b05 plug memory leak in poems library 2018-11-29 16:41:11 -05:00
6705777f7b fix memory issue in POEMS library, where auxiliary data was cast to a data structure of different (smaller) size when deleting.
this commit adds support to a callback function that allows to delete aux data in the Tree with its native size.
2018-11-29 16:34:41 -05:00
4b8c6d40e2 update log files for qeq and rdf-adf examples 2018-11-29 15:15:14 -05:00
46bf4b7efb update log files for peptide, peri, pour and python examples 2018-11-29 14:51:25 -05:00
cef4164460 update log files for min, msst, nb3b, nemd, and obstacle examples 2018-11-29 14:13:11 -05:00
074a9663cb update log files for melt and micelle example 2018-11-29 14:05:28 -05:00
d67dad9d67 update log files for meam examples 2018-11-29 12:47:15 -05:00
41e24f6e8b update log files for gcmc example 2018-11-29 12:35:07 -05:00
e3ddefb38b update docs and header for removed error message 2018-11-29 02:03:56 -05:00
ea6d8a5dca replace hard crash with disabling atom sorting, when no suitable binsize is found 2018-11-29 01:38:04 -05:00
09abc0c75a Fix memory leak in Variable::compute_atom 2018-11-29 00:41:40 -05:00
6be4ce7137 found a new false positive word in docs with spellchecker 2018-11-28 23:14:45 -05:00
78f86d5f16 silence compiler warning about singed vs. unsigned 2018-11-28 22:23:09 -05:00
cb2964af4c silence compiler warning about unused parameter 2018-11-28 22:20:42 -05:00
c42776e4e1 ignore valgrind core dumps 2018-11-28 21:22:46 -05:00
c763916f9e update log files for granregion hugoniostat and indent examples 2018-11-28 21:21:54 -05:00
798f098e4a remove USER-OMP version of fix nphug, which had intermittant and difficult to track down memory corruption issues with multiple threads. 2018-11-28 18:57:26 -05:00
3508eca337 make sure all local Tree pointers are initialized, either to a newly allocated Tree() or NULL 2018-11-28 18:49:37 -05:00
9646d4614f plug small memory leak in fix gcmc 2018-11-28 18:45:32 -05:00
48a408bb19 update log files for friction example 2018-11-28 18:42:48 -05:00
a4d21370bf Merge pull request #1229 from invemichele/fix_plumed_memory_leak
fix plumed memory leak
2018-11-28 16:42:16 -05:00
9702899d1c Merge pull request #1228 from invemichele/fix_plumed_install
Fix bug in lib/plumed/Install.py, some small cleanup and support parallel compile of plumed sources
2018-11-28 16:32:04 -05:00
8e07aaf005 update log files for ellipse and flow examples 2018-11-28 16:16:19 -05:00
4a8f1a7a08 update log files for eim example 2018-11-28 16:11:15 -05:00
37289f7476 update log files for dipole and dreiding example inputs. add running some MD steps for dreiding 2018-11-28 16:07:12 -05:00
3ce61c42d6 update log files for crack and deposit examples 2018-11-28 16:01:42 -05:00
98c8f22046 update log files for coreshell examples 2018-11-28 15:56:58 -05:00
296cab0b09 update log files for controller example 2018-11-28 15:40:14 -05:00
ab924e4f1d update log files for comb examples 2018-11-28 15:38:11 -05:00
852916983a update logs for colloid example 2018-11-28 14:53:29 -05:00
d0a83e9e12 update cmap example logfiles 2018-11-28 14:51:19 -05:00
2ed90c1669 update log files for body examples 2018-11-28 14:46:47 -05:00
c428088554 update logfiles for balance examples 2018-11-28 14:40:20 -05:00
77e7362168 update log files for airebo and atm examples 2018-11-28 14:28:20 -05:00
22e774adef Revert "Add --noinstall flag to use the plumed source code directly without issuing make install"
This reverts commit a4684e2629.

Revert --noinstall flag commit
2018-11-28 17:37:24 +01:00
8213287966 detect the number of available CPU for plumed make, as suggested by @akohlmey 2018-11-28 16:09:05 +01:00
a4684e2629 Add --noinstall flag to use the plumed source code directly without issuing make install 2018-11-28 15:43:35 +01:00
3d5423f5da revert back to correct path to Plumed.inc.*. (my fault, I was not doing the 'make install') 2018-11-28 09:18:38 +01:00
55654ca68e fix memory leak due to virial_lmp 2018-11-28 00:35:47 +01:00
32abe35201 added -j8 option for faster plumed make 2018-11-28 00:08:55 +01:00
c87bdda9a8 fixed wrong path to Plumed.inc.* 2018-11-28 00:08:01 +01:00
1b50ad02fb fixed uninitialized var homedir 2018-11-28 00:06:50 +01:00
c0ab126e77 Merge pull request #1223 from akohlmey/next-patch-release
Patch release 27 November 2018
2018-11-27 16:37:10 -05:00
f254b8e3a3 Merge pull request #1226 from akohlmey/cmake-gpu-enhancements
Enhancements for using CMake with the GPU package, improved compatibility with cmake 3.x versions, improved handling of shared library building.
2018-11-27 16:05:47 -05:00
ebacd5ca6b anti-nitpick hack 2018-11-27 14:36:59 -05:00
79fafcb12c passing build type specific compiler flags to building the voro++ library 2018-11-27 09:57:21 -05:00
dbc798e286 correct passing flags to local voro++ build 2018-11-27 05:47:19 -05:00
6e8c537564 Merge pull request #1225 from akohlmey/last-minute-fixes
Last minute fixes
2018-11-26 22:56:44 -05:00
d43f229162 do not warn about deprecated GPU target archs 2018-11-26 22:48:23 -05:00
00b138f542 verbose CUDA assembly processing is more distracting than helping 2018-11-26 22:45:54 -05:00
1fdfc89d25 make $HOME/.local the default LAMMPS installation destination 2018-11-26 22:27:21 -05:00
d6ea31e143 implement changes suggested by @junghans for GPU/CUDA compilation 2018-11-26 22:06:10 -05:00
91b96fa0c9 build MESSAGE package client/server library always as static library 2018-11-26 21:37:23 -05:00
c980dd0a56 remove stray endif() 2018-11-26 20:56:13 -05:00
3ad74985eb replace more inline expansions with explicit code. some general overhaul and better propagation of consistent compiler settings and flags for library builds 2018-11-26 20:53:23 -05:00
aa0b9684dc remove inline expansion from two more cases (of external library builds) 2018-11-26 20:19:28 -05:00
05fb2d7587 more generated files/symlinks to ignore 2018-11-26 18:23:06 -05:00
5df2f92651 minor cleanup in lib/gpu 2018-11-26 18:22:33 -05:00
55359789fb improve docs for building the GPU library with CUDA and CMake/make with fat binaries 2018-11-26 18:13:50 -05:00
e0ff230268 remove comment-in-comment 2018-11-26 17:03:48 -05:00
b3975f4b14 reword a few options for clarity 2018-11-26 17:03:32 -05:00
c61da28f0a allow building "fat" GPU binaries in CUDA mode, resulting in executables compatible with all GPUs supported by the used CUDA toolkit 2018-11-26 17:03:09 -05:00
1ddbd24a4e add missing include file 2018-11-26 15:45:23 -05:00
6745c37741 Merge pull request #1222 from lammps/doc-adjust3
Some adjustments to the documentation for the per style listing pages
2018-11-26 15:20:29 -05:00
4434481c91 remove trailing whitespace in manual source files 2018-11-26 14:48:53 -05:00
c42d07d907 Merge branch 'master' into doc-adjust3 2018-11-26 14:47:29 -05:00
79b3e9e27d some clarifications and corrections on the wildcard command line docs 2018-11-26 14:46:39 -05:00
cce874dfb4 step version number to 27 November 2018 2018-11-26 14:28:57 -05:00
4004b8f161 Merge pull request #1219 from akohlmey/fix-class2-write-coeff
Handle class2 force field parameters correctly in write_coeff
2018-11-26 14:23:26 -05:00
96b971875f Merge pull request #1217 from akohlmey/more-small-changes
More small changes and bug fixes for the next release
2018-11-26 14:22:03 -05:00
bfaa2e9ee1 more adjustments to style pages 2018-11-26 11:24:48 -07:00
a010780808 merged in current master 2018-11-26 11:00:22 -07:00
32b3ff6cd7 remove tabs 2018-11-24 23:59:43 -05:00
179e84f282 replace dos/windows-style CR-LF line endings with unix style LF-only 2018-11-24 16:57:01 -05:00
f50ff9a9e3 use C++ style include files in USER-PTM package consistently 2018-11-24 16:47:59 -05:00
5af7f52370 formatting tweak for labels, add checking item for added pair styles 2018-11-24 16:47:18 -05:00
b76c7ddc84 correct some incorrect writedata and single_enable settings 2018-11-22 09:22:58 -05:00
d1255ab572 we are LAMMPS, not LIGGGHTS 2018-11-22 09:22:09 -05:00
5efd8c06b1 correct formatting for examples when discussing the non-incremental nature of special_bonds 2018-11-22 06:25:39 -05:00
900ecc170a document that rcb balancing depends on comm_style tiled which in turn is not compatible with triclinic cells 2018-11-21 16:08:24 -05:00
b1b6980d32 write_coeff needs to do special processing for class2 angles, dihedrals, and impropers 2018-11-21 15:46:41 -05:00
689334706f Merge branch 'more-small-changes' of github.com:akohlmey/lammps into more-small-changes 2018-11-21 09:24:21 -05:00
a91d89b516 avoid array overflows and silence compiler warnings from unused parameters 2018-11-21 09:24:10 -05:00
385cf2e1fc avoid array overflows and silence compiler warnings 2018-11-20 22:40:46 -05:00
090fc7bc8a remove unused sphinx-images extension from virtualenv setup 2018-11-20 22:14:24 -05:00
d359beb170 Merge pull request #1215 from jrgissing/bond/react-doc-corrections,mostly-formatting
Bond/react doc corrections,mostly formatting
2018-11-20 10:50:55 -05:00
719f719496 Merge pull request #1216 from bondrewd/charmm2lammps
make topology parsing in charmm2lammps.pl more tolerant
2018-11-20 10:35:52 -05:00
421f97e444 Merge pull request #1214 from akohlmey/collected-small-changes
Collected small changes and many spelling fixes for next release candidate
2018-11-20 10:34:58 -05:00
9f960baa4f restore USER-ATM package data files taken from CVS repo 2018-11-20 09:17:02 -05:00
981f56840e update workflow tips for checking new LAMMPS contributions 2018-11-20 00:30:45 -05:00
4c021dad37 port spell fixes to source code 2018-11-20 00:09:11 -05:00
4251c70e93 update list of false positives for spellchecking 2018-11-20 00:08:07 -05:00
0bcb1bd301 more spelling fixes and occational re-edits 2018-11-20 00:06:40 -05:00
c6c00ee7ee more spelling fixes 2018-11-19 20:46:32 -05:00
6f7b052e24 update comments and remove commented code 2018-11-19 16:38:25 -05:00
9b401b6ed0 fix topology parsing 2018-11-20 06:22:32 +09:00
b34dac41c2 port documentation spelling fixes to comments or strings in source code. 2018-11-19 16:15:24 -05:00
13ae678f39 more manual spelling fixes 2018-11-19 16:13:57 -05:00
8a94a32551 avoid duplicate label 2018-11-19 15:19:23 -05:00
b6f0fe4c2d more changes for correct and consistent spelling in the manual 2018-11-19 11:47:33 -05:00
809bd855b6 adjust wording of non-features discussion to be more in-sync with recent developments 2018-11-19 11:24:55 -05:00
4dc2f9c6c4 fix some spelling errors in the manual 2018-11-19 11:24:17 -05:00
c49c35e41d avoid tuncation error through integer division and promote to use "bigint" instead of "int" to avoid overflows for large systems 2018-11-17 06:40:33 -05:00
1597e78d5a guarantee initialization of hyperflag 2018-11-17 06:39:28 -05:00
a7bfb30043 update atc/cauchy_born examples with missing files 2018-11-16 23:03:47 -05:00
1d4e1f1425 bond/react:doc corrections 2018-11-16 20:47:51 -07:00
d7abb8cf4d Revert "bond/react: doc corrections, mostly formatting"
This reverts commit da88305f4d.
2018-11-16 20:42:52 -07:00
da88305f4d bond/react: doc corrections, mostly formatting 2018-11-16 20:41:49 -07:00
177a5ddb7a Merge pull request #34 from lammps/master
rebase
2018-11-16 20:29:46 -07:00
bbcb659158 render fix commands in 6 columns instead of 8 so only narrow screens need to scroll horizontally 2018-11-16 22:09:07 -05:00
dc6054fc2d rename "All commands" headers to "General commands" 2018-11-16 22:04:35 -05:00
0264edfcec provide example for how to set Tdamp correctly to 100 timesteps for all choices of unit 2018-11-16 16:27:47 -05:00
a66384cfea update github tutorial/howto for recent changes in the development workflow 2018-11-16 16:27:05 -05:00
fd4262805d for enabling MPIIO we also need to set -DLMP_MPIIO 2018-11-16 15:48:35 -05:00
0d72c3769d Merge pull request #1212 from stanmoore1/git_doc
Tweak to github-development-workflow.md
2018-11-16 12:44:58 -05:00
177733ecdd Merge pull request #1211 from lammps/doc-hyper
change warning to just a note
2018-11-16 12:11:54 -05:00
0b60bf65d1 Merge pull request #1210 from giacomofiorin/colvars-update
Update Colvars library to version 2018-11-16
2018-11-16 12:00:41 -05:00
c5c26abdd3 change warning to just a note 2018-11-16 09:26:37 -07:00
5974741eea Tweak to github-development-workflow.md 2018-11-16 09:26:12 -07:00
d8f540a433 Merge branch 'master' into colvars-update 2018-11-16 11:24:10 -05:00
0a96b891ef Merge pull request #1209 from pdebuyl/fix_cmake_h5md
fix cmake build for USER-H5MD
2018-11-16 11:22:45 -05:00
11de8dafe3 Update Colvars library to version 2018-11-16
Fixes several issues with running averages and time correlation function
computations.  Details are in:

https://github.com/Colvars/colvars/issues/143
https://github.com/Colvars/colvars/issues/193
https://github.com/Colvars/colvars/pull/194
2018-11-16 09:57:07 -05:00
2c979e878f fix cmake build for USER-H5MD
The hdf5 includes were needed as well for building the dump.
2018-11-16 15:18:58 +01:00
cf79751f4f Merge pull request #1207 from akohlmey/next-patch-release
Patch release 15 November 2018
2018-11-15 19:33:52 -05:00
e4dee3de17 Merge pull request #1206 from akohlmey/collected-small-changes
Collected small changes for next release
2018-11-15 17:29:26 -05:00
6e225d90fc fix some minor bugs write data file writing and remove dead code and silence compiler warnings 2018-11-15 16:50:56 -05:00
1fc3b4618c remove dead code and silence compiler warnings 2018-11-15 16:50:56 -05:00
eae9d27f6d OpenMP support from the compiler is not a requirement for USER-OMP. Without OpenMP, it is like the OPT package but for many more styles, so it is still useful and should be supported. 2018-11-15 16:50:56 -05:00
db29ec7eee complete workflow document 2018-11-15 14:58:02 -05:00
090778c42b Merge pull request #1204 from lammps/doc-plumed
Linkage mode improvements and documentation updates for USER-PLUMED package
2018-11-15 13:48:58 -05:00
db935dba5e Merge pull request #1201 from junghans/cmake_doc
cmake: update internal doc about how cmake finds executables
2018-11-15 13:48:17 -05:00
e160376365 incomplete first draft. committed for checking the markup in github. 2018-11-15 12:45:15 -05:00
d5f222464b Update README.md 2018-11-15 09:48:46 -07:00
4d9e2a014b add detailed build instructions and discussion of linkage modes for PLUMED library and USER-PLUMED package 2018-11-15 11:35:04 -05:00
8a4983e4bc reformatting and simplification of fix plumed docs 2018-11-15 10:53:38 -05:00
82d6aa9add interlink fixes colvars, plumed, and smd 2018-11-15 10:52:41 -05:00
4231ab3d57 correct some links 2018-11-15 10:52:03 -05:00
25914ea3f3 patch 15Nov2018 2018-11-15 10:17:25 -05:00
47bf9f73be Merge pull request #33 from lammps/master
rebase
2018-11-14 22:01:31 -07:00
003bb28471 make @gtribello code owner of the USER-PLUMED package 2018-11-14 22:17:25 -05:00
a557644939 support all three plumed linkage modes with CMake as well. For downloaded and previously installed plumed lib 2018-11-14 22:13:18 -05:00
04520e627d add code and scripts to support all three plumed linkage modes with fix plumed for conventional build 2018-11-14 21:26:36 -05:00
952e52982e add comment to indicate code intended for backward compatibility only 2018-11-14 05:37:59 -05:00
a942d8b3ba use memset() for clearing of arrays 2018-11-14 05:30:23 -05:00
7a22b8aa62 check only in currently added data file atoms for dihedral overflow 2018-11-14 05:29:26 -05:00
4c1fbc359a use tagint when unpacking atom tags from communication buffers 2018-11-14 05:28:19 -05:00
2c644c5f2e Merge pull request #1197 from akohlmey/collected-small-fixes
Collection of small changes and bugfixes for the next release
2018-11-13 15:18:09 -05:00
b1186a971e Merge pull request #1202 from lammps/hyper
Add Hyper-dynamics to REPLICA package
2018-11-13 15:17:30 -05:00
2dbd575a4b Merge pull request #1203 from stanmoore1/kk_update
Update Kokkos library in LAMMPS to v2.7.24
2018-11-13 15:15:09 -05:00
4805e1df22 doc page additions for USER-PLUMED package 2018-11-13 08:29:07 -07:00
380f0e4971 remove some debugging code 2018-11-13 08:06:40 -07:00
a026ce9669 correct broken links detected by make mobi 2018-11-12 21:38:26 -05:00
7e779d16de correct broken links in manual reported by 'make html' 2018-11-12 21:33:37 -05:00
b776f0f29f remove dead code and silence warnings about unused parameters 2018-11-12 21:11:55 -05:00
443644025f silence compiler warnings 2018-11-12 20:50:14 -05:00
c4c90a96ec avoid void return from non-void function 2018-11-12 20:49:01 -05:00
5cb2463204 c++ style include files do not have a .h extension 2018-11-12 20:33:30 -05:00
5a4e44b75a remove accidentally duplicated code 2018-11-12 20:27:21 -05:00
0ca02b6f41 added new commands to doc pages, fixed a few missing entries as well 2018-11-12 17:23:15 -07:00
2b96dfd6cc Remove deprecated Kokkos code 2018-11-12 15:49:31 -07:00
c22c6e4d34 Add LAMMPS changes to Kokkos Makefile 2018-11-12 15:30:14 -07:00
b2d67bcbb5 Remove tpls dir 2018-11-12 15:18:06 -07:00
b3f08b38a2 Update Kokkos library in LAMMPS to v2.7.24 2018-11-12 15:16:26 -07:00
8e9d4f5bce modify bond style hybrid, so it can handle bond style quartic as a sub-style 2018-11-12 16:06:55 -05:00
fe07ad279d added NULL declations to constructor, removed debug code 2018-11-12 12:32:54 -07:00
5062c43aea rename example outputs 2018-11-12 12:32:53 -07:00
90caf0019c fix doc page errors 2018-11-12 12:32:53 -07:00
3b7ebbb8df new hyper examples 2018-11-12 12:32:53 -07:00
d7a479d2f6 hyper example dir 2018-11-12 12:32:52 -07:00
0c8ce199af more updates to hyper docs 2018-11-12 12:32:52 -07:00
4a6f088c0b updates to hyper doc pages 2018-11-12 12:32:52 -07:00
56598fcd0b changes to prd command doc page 2018-11-12 12:32:52 -07:00
265c11dca9 more edits to hyper docs 2018-11-12 12:32:52 -07:00
d6631266ce doc files in wrong dir 2018-11-12 12:32:52 -07:00
fbd610b8a9 global/local hyperdynamics src and doc files 2018-11-12 12:32:52 -07:00
86d1304176 cmake: update doc aobut executables 2018-11-10 18:58:53 -07:00
f68d77c7af correct formatting 2018-11-09 08:03:58 -05:00
7a4f534676 replace non-ASCII character 2018-11-09 08:03:41 -05:00
729201ab93 fix typo reported in #1199 2018-11-09 08:03:19 -05:00
ab8215a669 remove dead code 2018-11-09 01:09:31 -05:00
fe04147ee0 fix typo 2018-11-09 01:09:22 -05:00
62b1159673 update presets for USER-PLUMED package. fix typo. 2018-11-09 01:08:57 -05:00
adeb0c2b54 replace faulty preprocessor logic
fixes #1196
2018-11-09 01:08:57 -05:00
1651a21f92 Merge pull request #1198 from akohlmey/next-patch-release
Patch release 9 November 2018
2018-11-08 20:49:49 -05:00
cbae3b5afa Merge pull request #1184 from DiscreteLogarithm/sdpd
add USER-SDPD package for Smoothed Dissipative Particle Dynamics
2018-11-08 17:21:21 -05:00
f2a29880e2 patch 9Nov2018 2018-11-08 16:48:43 -05:00
e0955f6434 Merge branch 'master' into sdpd to resolve merge conflicts
# Conflicts:
#	cmake/CMakeLists.txt
#	src/Makefile
2018-11-08 16:32:02 -05:00
3681bc853d Merge pull request #1195 from jrgissing/bond/react-custom_edges
Bond/react: charge update for custom edges
2018-11-08 16:19:23 -05:00
a6e9b99295 Merge pull request #1180 from gtribello/master
Add natively supported PLUMED interface to LAMMPS
2018-11-08 16:16:50 -05:00
893a51ce14 Merge pull request #1191 from akohlmey/msi2lmp-avoid-bad-topology
Dihedral generation bugfix for msi2lmp
2018-11-08 16:10:31 -05:00
80ee08482c Merge pull request #1182 from junghans/pkgconfig_doc
liblammps.pc: add some more documentation
2018-11-08 16:10:15 -05:00
bbb371134d include USER-SDPD package in list of user packages in conventional make 2018-11-06 22:38:02 -05:00
a1e8992eac replace non-ASCII characters 2018-11-06 22:21:19 -05:00
baa7b705b8 improve logic and grammar of error messages 2018-11-06 22:13:38 -05:00
2d12260ade remove bogus single function and set single_enable = 0 2018-11-06 22:13:05 -05:00
31277349c6 remove dead code and avoid compiler warnings 2018-11-06 22:10:27 -05:00
df232c1cf6 use c++ style include files for c-library functions 2018-11-06 22:09:05 -05:00
bdf73f7adb ignore USER-SDPD files when installed 2018-11-06 22:07:35 -05:00
84fcf01bed bond/react: allow custom update of charges near template edges
also, fixes a bug introduced in PR #1189, when not using stabilization
2018-11-06 19:59:22 -07:00
cc0d685e8e Merge pull request #32 from lammps/master
rebase
2018-11-06 19:52:08 -07:00
5196fa37e0 Merge pull request #1194 from ohenrich/user-cgdna
Update reference for USER-CGDNA
2018-11-06 15:52:22 -05:00
4e6253254c Merge branch 'master' into user-cgdna 2018-11-06 19:48:06 +00:00
562296bdb7 Updated link to preprint article 2018-11-06 19:44:35 +00:00
91c4ef6f64 Merge pull request #1189 from jrgissing/bond/react-custom_group
Bond/react custom group support
2018-11-06 10:32:06 -05:00
f46d6a4312 Merge pull request #1192 from julient31/master
update reference for SPIN package
2018-11-06 10:26:27 -05:00
cb828e9579 update reference 2018-11-06 07:48:47 +01:00
ed77701e56 Merge pull request #31 from lammps/master
rebase
2018-11-05 20:25:38 -07:00
7ed6cab040 do not generate illegal dihedrals, e.g. from 3-membered rings 2018-11-05 20:35:43 -05:00
ce7f76de1d cmake: switch plumed to full static mode 2018-11-05 07:39:23 -07:00
58d2f0cc57 cmake: fix linking again plumed 2018-11-05 05:55:31 -07:00
ab7aa9dfda correction to fix group property doc 2018-11-05 00:49:33 -07:00
6d1ea2d0b1 broke smooth restarts at some point. fixed 2018-11-05 00:46:53 -07:00
a3ca177d20 various small changes and reformatting
- add memory usage estimator
- test against varying number of atoms
- test against non-consecutive atom tags
- test for 32-bit overflow in number of atoms
- test for 32-bit overflow in timestep
- reduce tail correction error to warning
- more LAMMPS style formatting of the source code
- remove trailing whitespace
- avoid leaking memory from allocated arrays for masses/charges/tags
2018-11-04 19:52:10 -05:00
a3c0fe7726 Added check on fix modify for PLUMED to ensures that virial is calculated for group all 2018-11-04 11:43:07 +00:00
a051d61e1f Added functionality to support fix modify for fix plumed 2018-11-04 11:24:01 +00:00
8cb665f013 Added functionality to throw error when time step changes and PLUMED is being used 2018-11-04 10:21:28 +00:00
cb8c51e353 Got rid of some of the hard-coded units in the plumed interface 2018-11-03 18:13:28 +00:00
a37d718ed1 update bond/react examples 2018-11-03 12:01:00 -06:00
f7aa01d74a bond/react: convert group-ID to group-ID-prefix
enables consistent syntax when using custom groups
2018-11-03 11:57:46 -06:00
badfdd7433 download only the plumed-src package and include further tweaks to be compatible with plumed 2.5b 2018-11-03 00:21:10 -04:00
ac11d66d5a provide reference logfiles and move generated files to reference folder 2018-11-02 23:28:09 -04:00
18216de084 correctly check for fixes that maintain their own pressure compute 2018-11-02 23:21:09 -04:00
3cb2291a5a need to include comm.h now 2018-11-02 22:52:51 -04:00
54c52c3bdf adjust compilation settings to link in plumed library statically and all its dependencies 2018-11-02 22:52:36 -04:00
df3390e224 update formatting to closer match LAMMPS' programming style 2018-11-02 21:33:30 -04:00
d185b34b19 reformat to closer match LAMMPS programming style 2018-11-02 21:19:53 -04:00
30518a993b add LAMMPS header 2018-11-02 21:14:36 -04:00
b7e507a258 fix typo and reformat 2018-11-02 21:08:45 -04:00
ea9746f26d insert fix plumed docs into manual generation 2018-11-02 21:08:32 -04:00
2635f7d160 Merge pull request #1190 from giacomofiorin/colvars-update
Update Colvars library to version 2018-10-16
2018-11-02 20:11:28 -04:00
85a5cab663 Update Colvars library to version 2018-10-16 2018-11-02 17:45:20 -04:00
b1c50e3bbe Added plumed documentation in a txt file 2018-11-02 19:50:49 +00:00
0c7c344e19 additional molecule templates sanity-check
thanks to Sagar Patil for report
2018-11-01 01:26:12 -06:00
b67e54dd7d reciprocal 'related commands' 2018-11-01 01:09:52 -06:00
5821a5ecc8 bond/react: custom group with stabilization option 2018-11-01 01:04:45 -06:00
20b9c7fd79 Merge pull request #30 from lammps/master
rebase
2018-10-31 20:15:45 -06:00
a66d4c7451 Merge pull request #1186 from akohlmey/various-small-fixes
Various small fixes
2018-10-31 12:13:38 -04:00
7514838700 put LAMMPS sources folder first in list of include directories 2018-10-31 04:18:08 -04:00
1fccb391a6 Merge pull request #1185 from jrgissing/bond/react-update_edges-option
Bond/react: update edges option
2018-10-31 00:43:07 -04:00
688945a0ef silence compiler warnings about initialization order and unused args 2018-10-31 00:34:58 -04:00
50b99c8450 silence compiler warnings about unused arguments 2018-10-31 00:19:06 -04:00
446b05ebc1 silence warning about initialization order 2018-10-31 00:17:17 -04:00
2a5cd1d31e remove debug output 2018-10-31 00:16:44 -04:00
3faecc4d28 add option to update all atoms' atomic charges
option to update all atomic charges, even when edge atoms are defined
2018-10-30 22:11:52 -06:00
e992bf935b Merge pull request #29 from lammps/master
rebase
2018-10-30 20:35:47 -06:00
42068944aa Merge branch 'master' of github.com:gtribello/lammps into fix-plumed 2018-10-30 20:43:49 -04:00
e3b89b60dc add checksum support for downloaded tar archives. upgrade to v2.4.3 2018-10-30 20:43:20 -04:00
e70a9b0f26 updated CMakeLists to handle the optional dependency of USER-SDPD 2018-10-30 19:35:22 +03:30
113539b053 Merge pull request #1183 from akohlmey/voro-clean-namespace
Reduce namespace pollution for VORONOI package
2018-10-30 11:53:56 -04:00
ba6f6f73f1 first commit: added SDPD 2018-10-30 17:40:00 +03:30
c838a9fd48 use forward declarations for better namespace hygiene 2018-10-30 00:33:51 -04:00
fb4df86d3d Merge pull request #1170 from akohlmey/fix-merge-sort
Bug fix for merge sort by Jeffrey Frey
2018-10-29 18:47:50 -04:00
1bae30c295 liblammps.pc: add some more documentation 2018-10-29 06:57:46 -06:00
044507640f include Plumed.h with full path 2018-10-29 06:52:19 -06:00
bcc7a4c32f cmake: add PLUMED include dir 2018-10-29 06:36:47 -06:00
283096d1d5 update .gitignore 2018-10-29 03:50:55 -04:00
079134255d make sure class member "list" is initialized to NULL in constructor 2018-10-29 03:49:25 -04:00
25b425dbb0 no need to import the PLMD namespace globally 2018-10-28 22:21:35 -04:00
bee2cb96fa remove references to Plumed.cpp and Plumed.h 2018-10-28 22:18:27 -04:00
360aca581c remove last reference to voro++ 2018-10-28 21:56:49 -04:00
21661f84db Merge pull request #1181 from akohlmey/fixup-github-folder
Updates to contributing guidelines
2018-10-28 21:55:02 -04:00
a662afe970 fully integrate USER-PLUMED package into conventional build 2018-10-28 21:37:33 -04:00
3a082e227e remove obsolete and redundant files 2018-10-28 21:33:51 -04:00
54d728c0c7 reduce need for include files by adding forward declaration 2018-10-28 21:33:06 -04:00
ae499b980d make Plumed.cpp obsolete in USER-PLUMED code by inserting it into fix_plumed.cpp 2018-10-28 21:32:47 -04:00
925d6d37b9 adjust header inclusion to current LAMMPS conventions 2018-10-28 21:32:01 -04:00
bdf3764905 update user-plumed Install.sh file to fit better into LAMMPS, adjust to changes in lib folder 2018-10-28 21:31:40 -04:00
bfbf5695fd adjust path for includelink to find the Plumed.h wrapper properly 2018-10-28 21:30:37 -04:00
e788ffe210 Merge branch 'master' of github.com:gtribello/lammps into fix-plumed 2018-10-28 21:29:53 -04:00
3cc9384488 cmake: add support USER-PLUMED 2018-10-28 16:23:29 -06:00
a60b6d1ab8 add feature to python lib install script to support existing installation and use links 2018-10-28 18:12:32 -04:00
174b180a41 remove file that is not present 2018-10-28 18:12:02 -04:00
7bbd8644c8 rework some of the pull request instructions to be realigned with the recent changes in the workflow. 2018-10-28 08:50:37 -04:00
f36b7e38a8 correct link to github tutorial in CONTRIBUTING doc 2018-10-28 08:42:28 -04:00
f70af61b35 Added new version of Plumed wrapper 2018-10-28 09:27:22 +00:00
4fa78a78de Added instructions on PLUMED to build extras and Package details pages of manual 2018-10-26 22:12:17 +01:00
ff9f836be4 Merge remote-tracking branch 'upstream/master' 2018-10-26 22:01:05 +01:00
2e79d9f340 Merged Pablo's fixes into the plumed interface for lammps 2018-10-25 21:45:35 +01:00
2428c1c1f3 Merge pull request #1177 from lammps/modify-reorder
reorder operations in init() to fix a bug with compute chunk/atom del…
2018-10-25 10:55:14 -04:00
0e213b80e9 reorder operations in init() to fix a bug with compute chunk/atom deleting a fix 2018-10-25 08:23:10 -06:00
2c1f420a48 more tweaks 2018-10-24 13:43:26 -06:00
07f92d225e formatting tweak 2018-10-24 12:03:51 -06:00
7e5ec96bcd more tweaks from style check script 2018-10-24 12:02:36 -06:00
c8870f1b78 change intro to each list of commands 2018-10-24 11:57:34 -06:00
da38ae0370 apply fix for merge sort from issue #1163 by @jtfrey and re-enable it 2018-10-23 08:57:33 -04:00
c442166ded Tidied up example directory for PLUMED 2018-07-12 16:22:40 +01:00
6d9face1ec Added documentation describing PLUMED package installation 2018-07-12 12:26:09 +01:00
4734bc09dc Added descriptions of static linking of PLUMED to README files 2018-07-11 21:56:08 +01:00
492e945b5a Added options to link plumed statically 2018-07-11 16:39:52 +01:00
4d5635a3c4 Fixed virial contribution from PLUMED 2018-07-10 16:01:45 +01:00
c84ae38e34 Fixed installation scripts for PLUMED 2018-07-09 17:27:41 +01:00
43cdca80f2 Fixed passing of charges 2018-07-09 15:06:10 +01:00
7f5a83cb1d Added first go at checks on PLUMED interface to LAMMPS 2018-07-02 17:04:19 +01:00
b299bfa821 Started adding tests on PLUMED interface 2018-07-02 13:58:38 +01:00
2c5f2a6683 Added running example of PLUMED + LAMMPS
Not sure if this has been done correctly.  I add both the input and the output
2018-07-02 10:22:23 +01:00
9b44529591 Added an example 2018-06-29 17:46:51 +01:00
f5642ac292 Removed reference to local version of PLUMED from interface 2018-06-29 16:28:53 +01:00
ef0f9c0451 First attempt at permanent PLUMED interface 2018-06-29 12:26:19 +01:00
1373 changed files with 250762 additions and 49239 deletions

4
.github/CODEOWNERS vendored
View File

@ -29,6 +29,7 @@ src/USER-MEAMC/* @martok
src/USER-MOFFF/* @hheenen src/USER-MOFFF/* @hheenen
src/USER-MOLFILE/* @akohlmey src/USER-MOLFILE/* @akohlmey
src/USER-NETCDF/* @pastewka src/USER-NETCDF/* @pastewka
src/USER-PLUMED/* @gtribello
src/USER-PHONON/* @lingtikong src/USER-PHONON/* @lingtikong
src/USER-PTM/* @pmla src/USER-PTM/* @pmla
src/USER-OMP/* @akohlmey src/USER-OMP/* @akohlmey
@ -125,3 +126,6 @@ python/* @rbberger
doc/utils/*/* @rbberger doc/utils/*/* @rbberger
doc/Makefile @rbberger doc/Makefile @rbberger
doc/README @rbberger doc/README @rbberger
# for releases
src/version.h @sjplimp

View File

@ -6,7 +6,7 @@ The following is a set of guidelines as well as explanations of policies and wor
Thus please also have a look at: Thus please also have a look at:
* [The Section on submitting new features for inclusion in LAMMPS of the Manual](http://lammps.sandia.gov/doc/Section_modify.html#mod-15) * [The Section on submitting new features for inclusion in LAMMPS of the Manual](http://lammps.sandia.gov/doc/Section_modify.html#mod-15)
* [The LAMMPS GitHub Tutorial in the Manual](http://lammps.sandia.gov/doc/tutorial_github.html) * [The LAMMPS GitHub Tutorial in the Manual](http://lammps.sandia.gov/doc/Howto_github.html)
## Table of Contents ## Table of Contents
@ -62,7 +62,7 @@ To be able to submit an issue on GitHub, you have to register for an account (fo
We encourage users to submit new features or modifications for LAMMPS to the core developers so they can be added to the LAMMPS distribution. The preferred way to manage and coordinate this is by submitting a pull request at the LAMMPS project on GitHub. For any larger modifications or programming project, you are encouraged to contact the LAMMPS developers ahead of time, in order to discuss implementation strategies and coding guidelines, that will make it easier to integrate your contribution and result in less work for everybody involved. You are also encouraged to search through the list of open issues on GitHub and submit a new issue for a planned feature, so you would not duplicate the work of others (and possibly get scooped by them) or have your work duplicated by others. We encourage users to submit new features or modifications for LAMMPS to the core developers so they can be added to the LAMMPS distribution. The preferred way to manage and coordinate this is by submitting a pull request at the LAMMPS project on GitHub. For any larger modifications or programming project, you are encouraged to contact the LAMMPS developers ahead of time, in order to discuss implementation strategies and coding guidelines, that will make it easier to integrate your contribution and result in less work for everybody involved. You are also encouraged to search through the list of open issues on GitHub and submit a new issue for a planned feature, so you would not duplicate the work of others (and possibly get scooped by them) or have your work duplicated by others.
How quickly your contribution will be integrated depends largely on how much effort it will cause to integrate and test it, how much it requires changes to the core code base, and of how much interest it is to the larger LAMMPS community. Please see below for a checklist of typical requirements. Once you have prepared everything, see [this tutorial](http://lammps.sandia.gov/doc/tutorial_github.html) How quickly your contribution will be integrated depends largely on how much effort it will cause to integrate and test it, how much it requires changes to the core code base, and of how much interest it is to the larger LAMMPS community. Please see below for a checklist of typical requirements. Once you have prepared everything, see [this tutorial](http://lammps.sandia.gov/doc/Howto_github.html)
for instructions on how to submit your changes or new files through a GitHub pull request for instructions on how to submit your changes or new files through a GitHub pull request
Here is a checklist of steps you need to follow to submit a single file or user package for our consideration. Following these steps will save both you and us time. See existing files in packages in the source directory for examples. If you are uncertain, please ask on the lammps-users mailing list. Here is a checklist of steps you need to follow to submit a single file or user package for our consideration. Following these steps will save both you and us time. See existing files in packages in the source directory for examples. If you are uncertain, please ask on the lammps-users mailing list.
@ -102,11 +102,11 @@ For bug reports, the next step is that one of the core LAMMPS developers will se
### Pull Requests ### Pull Requests
For submitting pull requests, there is a [detailed tutorial](http://lammps.sandia.gov/doc/tutorial_github.html) in the LAMMPS manual. Thus only a brief breakdown of the steps is presented here. For submitting pull requests, there is a [detailed tutorial](http://lammps.sandia.gov/doc/Howto_github.html) in the LAMMPS manual. Thus only a brief breakdown of the steps is presented here. Please note, that the LAMMPS developers are still reviewing and trying to improve the process. If you are unsure about something, do not hesitate to post a question on the lammps-users mailing list or contact one fo the core LAMMPS developers.
Immediately after the submission, the LAMMPS continuing integration server at ci.lammps.org will download your submitted branch and perform a simple compilation test, i.e. will test whether your submitted code can be compiled under various conditions. It will also do a check on whether your included documentation translates cleanly. Whether these tests are successful or fail will be recorded. If a test fails, please inspect the corresponding output on the CI server and take the necessary steps, if needed, so that the code can compile cleanly again. The test will be re-run each the pull request is updated with a push to the remote branch on GitHub. Immediately after the submission, the LAMMPS continuing integration server at ci.lammps.org will download your submitted branch and perform a simple compilation test, i.e. will test whether your submitted code can be compiled under various conditions. It will also do a check on whether your included documentation translates cleanly. Whether these tests are successful or fail will be recorded. If a test fails, please inspect the corresponding output on the CI server and take the necessary steps, if needed, so that the code can compile cleanly again. The test will be re-run each the pull request is updated with a push to the remote branch on GitHub.
Next a LAMMPS core developer will self-assign and do an overall technical assessment of the submission. If you are not yet registered as a LAMMPS collaborator, you will receive an invitation for that. Next a LAMMPS core developer will self-assign and do an overall technical assessment of the submission. If you are not yet registered as a LAMMPS collaborator, you will receive an invitation for that.
You may also receive comments and suggestions on the overall submission or specific details. If permitted, additional changes may be pushed into your pull request branch or a pull request may be filed in your LAMMPS fork on GitHub to include those changes. You may also receive comments and suggestions on the overall submission or specific details. If permitted, additional changes may be pushed into your pull request branch or a pull request may be filed in your LAMMPS fork on GitHub to include those changes.
The LAMMPS developer may then decide to assign the pull request to another developer (e.g. when that developer is more knowledgeable about the submitted feature or enhancement or has written the modified code). It may also happen, that additional developers are requested to provide a review and approve the changes. For submissions, that may change the general behavior of LAMMPS, or where a possibility of unwanted side effects exists, additional tests may be requested by the assigned developer. The LAMMPS developer may then decide to assign the pull request to another developer (e.g. when that developer is more knowledgeable about the submitted feature or enhancement or has written the modified code). It may also happen, that additional developers are requested to provide a review and approve the changes. For submissions, that may change the general behavior of LAMMPS, or where a possibility of unwanted side effects exists, additional tests may be requested by the assigned developer.
If the assigned developer is satisfied and considers the submission ready for inclusion into LAMMPS, the pull request will be assigned to the LAMMPS lead developer, Steve Plimpton (@sjplimp), who will then have the final decision on whether the submission will be included, additional changes are required or it will be ultimately rejected. After the pull request is merged, you may delete the pull request branch in your personal LAMMPS fork. If the assigned developer is satisfied and considers the submission ready for inclusion into LAMMPS, the pull request will receive approvals and be merged into the master branch by one of the core LAMMPS developers. After the pull request is merged, you may delete the feature branch used for the pull request in your personal LAMMPS fork.
Since the learning curve for git is quite steep for efficiently managing remote repositories, local and remote branches, pull requests and more, do not hesitate to ask questions, if you are not sure about how to do certain steps that are asked of you. Even if the changes asked of you do not make sense to you, they may be important for the LAMMPS developers. Please also note, that these all are guidelines and not set in stone. Since the learning curve for git is quite steep for efficiently managing remote repositories, local and remote branches, pull requests and more, do not hesitate to ask questions, if you are not sure about how to do certain steps that are asked of you. Even if the changes asked of you do not make sense to you, they may be important for the LAMMPS developers. Please also note, that these all are guidelines and nothing set in stone. So depending on the nature of the contribution, the workflow may be adjusted.

1
.gitignore vendored
View File

@ -22,6 +22,7 @@ log.cite
.*.swp .*.swp
*.orig *.orig
*.rej *.rej
vgcore.*
.vagrant .vagrant
\#*# \#*#
.#* .#*

View File

@ -11,6 +11,10 @@ get_filename_component(LAMMPS_LIB_SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR}/../lib
get_filename_component(LAMMPS_LIB_BINARY_DIR ${CMAKE_BINARY_DIR}/lib ABSOLUTE) get_filename_component(LAMMPS_LIB_BINARY_DIR ${CMAKE_BINARY_DIR}/lib ABSOLUTE)
get_filename_component(LAMMPS_DOC_DIR ${CMAKE_CURRENT_SOURCE_DIR}/../doc ABSOLUTE) get_filename_component(LAMMPS_DOC_DIR ${CMAKE_CURRENT_SOURCE_DIR}/../doc ABSOLUTE)
# by default, install into $HOME/.local (not /usr/local), so that no root access (and sudo!!) is needed
if (CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT)
set(CMAKE_INSTALL_PREFIX "$ENV{HOME}/.local" CACHE PATH "default install path" FORCE )
endif()
# To avoid conflicts with the conventional Makefile build system, we build everything here # To avoid conflicts with the conventional Makefile build system, we build everything here
file(GLOB LIB_SOURCES ${LAMMPS_SOURCE_DIR}/[^.]*.cpp) file(GLOB LIB_SOURCES ${LAMMPS_SOURCE_DIR}/[^.]*.cpp)
@ -75,6 +79,7 @@ if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CXX_FLAGS)
#release comes with -O3 by default #release comes with -O3 by default
set(CMAKE_BUILD_TYPE Release CACHE STRING "Choose the type of build, options are: None Debug Release RelWithDebInfo MinSizeRel." FORCE) set(CMAKE_BUILD_TYPE Release CACHE STRING "Choose the type of build, options are: None Debug Release RelWithDebInfo MinSizeRel." FORCE)
endif(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CXX_FLAGS) endif(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CXX_FLAGS)
string(TOUPPER "${CMAKE_BUILD_TYPE}" BTYPE)
# check for files auto-generated by make-based buildsystem # check for files auto-generated by make-based buildsystem
# this is fast, so check for it all the time # this is fast, so check for it all the time
@ -171,8 +176,9 @@ set(DEFAULT_PACKAGES ASPHERE BODY CLASS2 COLLOID COMPRESS DIPOLE GRANULAR
USER-BOCS USER-CGDNA USER-MESO USER-CGSDK USER-COLVARS USER-DIFFRACTION USER-BOCS USER-CGDNA USER-MESO USER-CGSDK USER-COLVARS USER-DIFFRACTION
USER-DPD USER-DRUDE USER-EFF USER-FEP USER-H5MD USER-LB USER-MANIFOLD USER-DPD USER-DRUDE USER-EFF USER-FEP USER-H5MD USER-LB USER-MANIFOLD
USER-MEAMC USER-MGPT USER-MISC USER-MOFFF USER-MOLFILE USER-NETCDF USER-MEAMC USER-MGPT USER-MISC USER-MOFFF USER-MOLFILE USER-NETCDF
USER-PHONON USER-PTM USER-QTB USER-REAXC USER-SCAFACOS USER-SMD USER-SMTBQ USER-PHONON USER-PLUMED USER-PTM USER-QTB USER-REAXC USER-SCAFACOS
USER-SPH USER-TALLY USER-UEF USER-VTK USER-QUIP USER-QMMM) USER-SDPD USER-SMD USER-SMTBQ USER-SPH USER-TALLY USER-UEF USER-VTK
USER-QUIP USER-QMMM)
set(ACCEL_PACKAGES USER-OMP KOKKOS OPT USER-INTEL GPU) set(ACCEL_PACKAGES USER-OMP KOKKOS OPT USER-INTEL GPU)
set(OTHER_PACKAGES CORESHELL QEQ) set(OTHER_PACKAGES CORESHELL QEQ)
foreach(PKG ${DEFAULT_PACKAGES}) foreach(PKG ${DEFAULT_PACKAGES})
@ -193,6 +199,8 @@ if(PKG_MEAM OR PKG_USER-H5MD OR PKG_USER-QMMM OR PKG_USER-SCAFACOS)
enable_language(C) enable_language(C)
endif() endif()
include_directories(${LAMMPS_SOURCE_DIR})
# do MPI detection after language activation, if MPI for these language is required # do MPI detection after language activation, if MPI for these language is required
find_package(MPI QUIET) find_package(MPI QUIET)
option(BUILD_MPI "Build MPI version" ${MPI_FOUND}) option(BUILD_MPI "Build MPI version" ${MPI_FOUND})
@ -301,7 +309,7 @@ pkg_depends(USER-SCAFACOS MPI)
find_package(OpenMP QUIET) find_package(OpenMP QUIET)
option(BUILD_OMP "Build with OpenMP support" ${OpenMP_FOUND}) option(BUILD_OMP "Build with OpenMP support" ${OpenMP_FOUND})
if(BUILD_OMP OR PKG_USER-OMP OR PKG_KOKKOS OR PKG_USER-INTEL) if(BUILD_OMP OR PKG_KOKKOS OR PKG_USER-INTEL)
find_package(OpenMP REQUIRED) find_package(OpenMP REQUIRED)
set (CMAKE_C_FLAGS "${CMAKE_C_FLAGS} ${OpenMP_C_FLAGS}") set (CMAKE_C_FLAGS "${CMAKE_C_FLAGS} ${OpenMP_C_FLAGS}")
set (CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${OpenMP_CXX_FLAGS}") set (CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${OpenMP_CXX_FLAGS}")
@ -419,16 +427,30 @@ if(WITH_FFMPEG)
add_definitions(-DLAMMPS_FFMPEG) add_definitions(-DLAMMPS_FFMPEG)
endif() endif()
if(BUILD_SHARED_LIBS)
set(CONFIGURE_REQUEST_PIC "--with-pic")
set(CMAKE_REQUEST_PIC "-DCMAKE_POSITION_INDEPENDENT_CODE=${CMAKE_POSITION_INDEPENDENT_CODE}")
set(CUDA_REQUEST_PIC "-Xcompiler ${CMAKE_SHARED_LIBRARY_CXX_FLAGS}")
else()
set(CONFIGURE_REQUEST_PIC)
set(CMAKE_REQUEST_PIC)
set(CUDA_REQUEST_PIC)
endif()
if(PKG_VORONOI) if(PKG_VORONOI)
option(DOWNLOAD_VORO "Download voro++ (instead of using the system's one)" OFF) option(DOWNLOAD_VORO "Download and compile the Voro++ library instead of using an already installed one" OFF)
if(DOWNLOAD_VORO) if(DOWNLOAD_VORO)
message(STATUS "Voro++ download requested - we will build our own")
include(ExternalProject) include(ExternalProject)
if(BUILD_SHARED_LIBS) if(BUILD_SHARED_LIBS)
set(VORO_BUILD_OPTIONS "CFLAGS=-fPIC") set(VORO_BUILD_CFLAGS "${CMAKE_SHARED_LIBRARY_CXX_FLAGS} ${CMAKE_CXX_FLAGS} ${CMAKE_CXX_FLAGS_${BTYPE}}")
else() else()
set(VORO_BUILD_OPTIONS) set(VORO_BUILD_CFLAGS "${CMAKE_CXX_FLAGS} ${CMAKE_CXX_FLAGS_${BTYPE}}")
endif() endif()
string(APPEND VORO_BUILD_CFLAGS ${CMAKE_CXX_FLAGS})
set(VORO_BUILD_OPTIONS CXX=${CMAKE_CXX_COMPILER} CFLAGS=${VORO_BUILD_CFLAGS})
ExternalProject_Add(voro_build ExternalProject_Add(voro_build
URL http://math.lbl.gov/voro++/download/dir/voro++-0.4.6.tar.gz URL http://math.lbl.gov/voro++/download/dir/voro++-0.4.6.tar.gz
@ -442,7 +464,7 @@ if(PKG_VORONOI)
else() else()
find_package(VORO) find_package(VORO)
if(NOT VORO_FOUND) if(NOT VORO_FOUND)
message(FATAL_ERROR "VORO not found, help CMake to find it by setting VORO_LIBRARY and VORO_INCLUDE_DIR, or set DOWNLOAD_VORO=ON to download it") message(FATAL_ERROR "Voro++ library not found. Help CMake to find it by setting VORO_LIBRARY and VORO_INCLUDE_DIR, or set DOWNLOAD_VORO=ON to download it")
endif() endif()
endif() endif()
include_directories(${VORO_INCLUDE_DIRS}) include_directories(${VORO_INCLUDE_DIRS})
@ -450,26 +472,26 @@ if(PKG_VORONOI)
endif() endif()
if(PKG_LATTE) if(PKG_LATTE)
option(DOWNLOAD_LATTE "Download latte (instead of using the system's one)" OFF) option(DOWNLOAD_LATTE "Download the LATTE library instead of using an already installed one" OFF)
if(DOWNLOAD_LATTE) if(DOWNLOAD_LATTE)
if (CMAKE_VERSION VERSION_LESS "3.7") # due to SOURCE_SUBDIR if (CMAKE_VERSION VERSION_LESS "3.7") # due to SOURCE_SUBDIR
message(FATAL_ERROR "For downlading LATTE you need at least cmake-3.7") message(FATAL_ERROR "For downlading LATTE you need at least cmake-3.7")
endif() endif()
message(STATUS "LATTE not found - we will build our own") message(STATUS "LATTE download requested - we will build our own")
include(ExternalProject) include(ExternalProject)
ExternalProject_Add(latte_build ExternalProject_Add(latte_build
URL https://github.com/lanl/LATTE/archive/v1.2.1.tar.gz URL https://github.com/lanl/LATTE/archive/v1.2.1.tar.gz
URL_MD5 85ac414fdada2d04619c8f936344df14 URL_MD5 85ac414fdada2d04619c8f936344df14
SOURCE_SUBDIR cmake SOURCE_SUBDIR cmake
CMAKE_ARGS -DCMAKE_INSTALL_PREFIX=<INSTALL_DIR> -DCMAKE_POSITION_INDEPENDENT_CODE=${CMAKE_POSITION_INDEPENDENT_CODE} CMAKE_ARGS -DCMAKE_INSTALL_PREFIX=<INSTALL_DIR> ${CMAKE_REQUEST_PIC}
) )
ExternalProject_get_property(latte_build INSTALL_DIR) ExternalProject_get_property(latte_build INSTALL_DIR)
set(LATTE_LIBRARIES ${INSTALL_DIR}/${CMAKE_INSTALL_LIBDIR}/liblatte.a) set(LATTE_LIBRARIES ${INSTALL_DIR}/${CMAKE_INSTALL_LIBDIR}/liblatte.a)
list(APPEND LAMMPS_DEPS latte_build) list(APPEND LAMMPS_DEPS latte_build)
else() else()
find_package(LATTE) find_package(LATTE)
if(NOT LATTE_FOUND) if(NOT LATTE_FOUND)
message(FATAL_ERROR "LATTE not found, help CMake to find it by setting LATTE_LIBRARY, or set DOWNLOAD_LATTE=ON to download it") message(FATAL_ERROR "LATTE library not found, help CMake to find it by setting LATTE_LIBRARY, or set DOWNLOAD_LATTE=ON to download it")
endif() endif()
endif() endif()
list(APPEND LAMMPS_LINK_LIBS ${LATTE_LIBRARIES} ${LAPACK_LIBRARIES}) list(APPEND LAMMPS_LINK_LIBS ${LATTE_LIBRARIES} ${LAPACK_LIBRARIES})
@ -477,24 +499,22 @@ endif()
if(PKG_USER-SCAFACOS) if(PKG_USER-SCAFACOS)
find_package(GSL REQUIRED) find_package(GSL REQUIRED)
option(DOWNLOAD_SCAFACOS "Download ScaFaCoS (instead of using the system's one)" OFF) option(DOWNLOAD_SCAFACOS "Download ScaFaCoS library instead of using an already installed one" OFF)
if(DOWNLOAD_SCAFACOS) if(DOWNLOAD_SCAFACOS)
message(STATUS "ScaFaCoS download requested - we will build our own")
include(ExternalProject) include(ExternalProject)
ExternalProject_Add(scafacos_build ExternalProject_Add(scafacos_build
URL https://github.com/scafacos/scafacos/releases/download/v1.0.1/scafacos-1.0.1.tar.gz URL https://github.com/scafacos/scafacos/releases/download/v1.0.1/scafacos-1.0.1.tar.gz
URL_MD5 bd46d74e3296bd8a444d731bb10c1738 URL_MD5 bd46d74e3296bd8a444d731bb10c1738
CONFIGURE_COMMAND <SOURCE_DIR>/configure --prefix=<INSTALL_DIR> CONFIGURE_COMMAND <SOURCE_DIR>/configure --prefix=<INSTALL_DIR> --disable-doc
--disable-doc
--enable-fcs-solvers=fmm,p2nfft,direct,ewald,p3m --enable-fcs-solvers=fmm,p2nfft,direct,ewald,p3m
--with-internal-fftw --with-internal-fftw --with-internal-pfft
--with-internal-pfft --with-internal-pnfft ${CONFIGURE_REQUEST_PIC}
--with-internal-pnfft FC=${CMAKE_MPI_Fortran_COMPILER}
$<$<BOOL:${BUILD_SHARED_LIBS}>:--with-pic> CXX=${CMAKE_MPI_CXX_COMPILER}
FC=${CMAKE_MPI_Fortran_COMPILER}
CXX=${CMAKE_MPI_CXX_COMPILER}
CC=${CMAKE_MPI_C_COMPILER} CC=${CMAKE_MPI_C_COMPILER}
F77= F77=
) )
ExternalProject_get_property(scafacos_build INSTALL_DIR) ExternalProject_get_property(scafacos_build INSTALL_DIR)
set(SCAFACOS_BUILD_DIR ${INSTALL_DIR}) set(SCAFACOS_BUILD_DIR ${INSTALL_DIR})
set(SCAFACOS_INCLUDE_DIRS ${SCAFACOS_BUILD_DIR}/include) set(SCAFACOS_INCLUDE_DIRS ${SCAFACOS_BUILD_DIR}/include)
@ -526,6 +546,54 @@ if(PKG_USER-SCAFACOS)
include_directories(${SCAFACOS_INCLUDE_DIRS}) include_directories(${SCAFACOS_INCLUDE_DIRS})
endif() endif()
if(PKG_USER-PLUMED)
find_package(GSL REQUIRED)
set(PLUMED_MODE "static" CACHE STRING "Linkage mode for Plumed2 library")
set(PLUMED_MODE_VALUES static shared runtime)
set_property(CACHE PLUMED_MODE PROPERTY STRINGS ${PLUMED_MODE_VALUES})
validate_option(PLUMED_MODE PLUMED_MODE_VALUES)
string(TOUPPER ${PLUMED_MODE} PLUMED_MODE)
option(DOWNLOAD_PLUMED "Download Plumed package instead of using an already installed one" OFF)
if(DOWNLOAD_PLUMED)
message(STATUS "PLUMED download requested - we will build our own")
include(ExternalProject)
ExternalProject_Add(plumed_build
URL https://github.com/plumed/plumed2/releases/download/v2.4.3/plumed-src-2.4.3.tgz
URL_MD5 b1be7c48971627febc11c61b70767fc5
BUILD_IN_SOURCE 1
CONFIGURE_COMMAND <SOURCE_DIR>/configure --prefix=<INSTALL_DIR> ${CONFIGURE_REQUEST_PIC})
ExternalProject_get_property(plumed_build INSTALL_DIR)
set(PLUMED_INSTALL_DIR ${INSTALL_DIR})
list(APPEND LAMMPS_DEPS plumed_build)
if(PLUMED_MODE STREQUAL "STATIC")
add_definitions(-D__PLUMED_WRAPPER_CXX=1)
list(APPEND LAMMPS_LINK_LIBS ${PLUMED_INSTALL_DIR}/lib/plumed/obj/kernel.o
"${PLUMED_INSTALL_DIR}/lib/plumed/obj/PlumedStatic.o" ${GSL_LIBRARIES} ${CMAKE_DL_LIBS})
elseif(PLUMED_MODE STREQUAL "SHARED")
list(APPEND LAMMPS_LINK_LIBS ${PLUMED_INSTALL_DIR}/lib/libplumed.so ${CMAKE_DL_LIBS})
elseif(PLUMED_MODE STREQUAL "RUNTIME")
add_definitions(-D__PLUMED_HAS_DLOPEN=1 -D__PLUMED_DEFAULT_KERNEL=${PLUMED_INSTALL_DIR}/lib/libplumedKernel.so)
list(APPEND LAMMPS_LINK_LIBS ${PLUMED_INSTALL_DIR}/lib/libplumedWrapper.a -rdynamic ${CMAKE_DL_LIBS})
endif()
set(PLUMED_INCLUDE_DIRS "${PLUMED_INSTALL_DIR}/include")
else()
find_package(PkgConfig REQUIRED)
pkg_check_modules(PLUMED plumed REQUIRED)
if(PLUMED_MODE STREQUAL "STATIC")
add_definitions(-D__PLUMED_WRAPPER_CXX=1)
include(${PLUMED_LIBDIR}/plumed/src/lib/Plumed.cmake.static)
elseif(PLUMED_MODE STREQUAL "SHARED")
include(${PLUMED_LIBDIR}/plumed/src/lib/Plumed.cmake.shared)
elseif(PLUMED_MODE STREQUAL "RUNTIME")
add_definitions(-D__PLUMED_HAS_DLOPEN=1 -D__PLUMED_DEFAULT_KERNEL=${PLUMED_LIBDIR}/libplumedKernel.so)
include(${PLUMED_LIBDIR}/plumed/src/lib/Plumed.cmake.runtime)
endif()
list(APPEND LAMMPS_LINK_LIBS ${PLUMED_LOAD})
endif()
include_directories(${PLUMED_INCLUDE_DIRS})
endif()
if(PKG_USER-MOLFILE) if(PKG_USER-MOLFILE)
add_library(molfile INTERFACE) add_library(molfile INTERFACE)
target_include_directories(molfile INTERFACE ${LAMMPS_LIB_SOURCE_DIR}/molfile) target_include_directories(molfile INTERFACE ${LAMMPS_LIB_SOURCE_DIR}/molfile)
@ -541,11 +609,12 @@ if(PKG_USER-NETCDF)
endif() endif()
if(PKG_USER-SMD) if(PKG_USER-SMD)
option(DOWNLOAD_EIGEN3 "Download Eigen3 (instead of using the system's one)" OFF) option(DOWNLOAD_EIGEN3 "Download Eigen3 instead of using an already installed one)" OFF)
if(DOWNLOAD_EIGEN3) if(DOWNLOAD_EIGEN3)
message(STATUS "Eigen3 download requested - we will build our own")
include(ExternalProject) include(ExternalProject)
ExternalProject_Add(Eigen3_build ExternalProject_Add(Eigen3_build
URL http://bitbucket.org/eigen/eigen/get/3.3.4.tar.gz URL http://bitbucket.org/eigen/eigen/get/3.3.4.tar.gz
URL_MD5 1a47e78efe365a97de0c022d127607c3 URL_MD5 1a47e78efe365a97de0c022d127607c3
CONFIGURE_COMMAND "" BUILD_COMMAND "" INSTALL_COMMAND "" CONFIGURE_COMMAND "" BUILD_COMMAND "" INSTALL_COMMAND ""
) )
@ -582,8 +651,9 @@ if(PKG_USER-VTK)
endif() endif()
if(PKG_KIM) if(PKG_KIM)
option(DOWNLOAD_KIM "Download kim-api (instead of using the system's one)" OFF) option(DOWNLOAD_KIM "Download KIM-API v1 from OpenKIM instead of using an already installed one)" OFF)
if(DOWNLOAD_KIM) if(DOWNLOAD_KIM)
message(STATUS "KIM-API v1 download requested - we will build our own")
include(ExternalProject) include(ExternalProject)
ExternalProject_Add(kim_build ExternalProject_Add(kim_build
URL https://github.com/openkim/kim-api/archive/v1.9.5.tar.gz URL https://github.com/openkim/kim-api/archive/v1.9.5.tar.gz
@ -598,7 +668,7 @@ if(PKG_KIM)
else() else()
find_package(KIM) find_package(KIM)
if(NOT KIM_FOUND) if(NOT KIM_FOUND)
message(FATAL_ERROR "KIM not found, help CMake to find it by setting KIM_LIBRARY and KIM_INCLUDE_DIR, or set DOWNLOAD_KIM=ON to download it") message(FATAL_ERROR "KIM-API v1 not found, help CMake to find it by setting KIM_LIBRARY and KIM_INCLUDE_DIR, or set DOWNLOAD_KIM=ON to download it")
endif() endif()
endif() endif()
list(APPEND LAMMPS_LINK_LIBS ${KIM_LIBRARIES}) list(APPEND LAMMPS_LINK_LIBS ${KIM_LIBRARIES})
@ -611,12 +681,7 @@ if(PKG_MESSAGE)
${LAMMPS_LIB_SOURCE_DIR}/message/cslib/[^.]*.c ${LAMMPS_LIB_SOURCE_DIR}/message/cslib/[^.]*.c
${LAMMPS_LIB_SOURCE_DIR}/message/cslib/[^.]*.cpp) ${LAMMPS_LIB_SOURCE_DIR}/message/cslib/[^.]*.cpp)
if(BUILD_SHARED_LIBS) add_library(cslib STATIC ${cslib_SOURCES})
add_library(cslib SHARED ${cslib_SOURCES})
else()
add_library(cslib STATIC ${cslib_SOURCES})
endif()
if(BUILD_MPI) if(BUILD_MPI)
target_compile_definitions(cslib PRIVATE -DMPI_YES) target_compile_definitions(cslib PRIVATE -DMPI_YES)
set_target_properties(cslib PROPERTIES OUTPUT_NAME "csmpi") set_target_properties(cslib PROPERTIES OUTPUT_NAME "csmpi")
@ -641,10 +706,10 @@ endif()
if(PKG_MSCG) if(PKG_MSCG)
find_package(GSL REQUIRED) find_package(GSL REQUIRED)
option(DOWNLOAD_MSCG "Download latte (instead of using the system's one)" OFF) option(DOWNLOAD_MSCG "Download MSCG library instead of using an already installed one)" OFF)
if(DOWNLOAD_MSCG) if(DOWNLOAD_MSCG)
if (CMAKE_VERSION VERSION_LESS "3.7") # due to SOURCE_SUBDIR if (CMAKE_VERSION VERSION_LESS "3.7") # due to SOURCE_SUBDIR
message(FATAL_ERROR "For downlading LATTE you need at least cmake-3.7") message(FATAL_ERROR "For downlading MSCG you need at least cmake-3.7")
endif() endif()
include(ExternalProject) include(ExternalProject)
if(NOT LAPACK_FOUND) if(NOT LAPACK_FOUND)
@ -654,7 +719,7 @@ if(PKG_MSCG)
URL https://github.com/uchicago-voth/MSCG-release/archive/1.7.3.1.tar.gz URL https://github.com/uchicago-voth/MSCG-release/archive/1.7.3.1.tar.gz
URL_MD5 8c45e269ee13f60b303edd7823866a91 URL_MD5 8c45e269ee13f60b303edd7823866a91
SOURCE_SUBDIR src/CMake SOURCE_SUBDIR src/CMake
CMAKE_ARGS -DCMAKE_INSTALL_PREFIX=<INSTALL_DIR> -DCMAKE_POSITION_INDEPENDENT_CODE=${CMAKE_POSITION_INDEPENDENT_CODE} ${EXTRA_MSCG_OPTS} CMAKE_ARGS -DCMAKE_INSTALL_PREFIX=<INSTALL_DIR> ${CMAKE_REQUEST_PIC} ${EXTRA_MSCG_OPTS}
BUILD_COMMAND make mscg INSTALL_COMMAND "" BUILD_COMMAND make mscg INSTALL_COMMAND ""
) )
ExternalProject_get_property(mscg_build BINARY_DIR) ExternalProject_get_property(mscg_build BINARY_DIR)
@ -702,7 +767,7 @@ set(MATH_LIBRARIES "m" CACHE STRING "math library")
mark_as_advanced( MATH_LIBRARIES ) mark_as_advanced( MATH_LIBRARIES )
include(CheckLibraryExists) include(CheckLibraryExists)
if (CMAKE_VERSION VERSION_LESS "3.4") if (CMAKE_VERSION VERSION_LESS "3.4")
enable_language(C) # check_library_exists isn't supported without a c compiler before v3.4 enable_language(C) # check_library_exists isn't supported without a C compiler before v3.4
endif() endif()
# RB: disabled this check because it breaks with KOKKOS CUDA enabled # RB: disabled this check because it breaks with KOKKOS CUDA enabled
#foreach(FUNC sin cos) #foreach(FUNC sin cos)
@ -740,6 +805,13 @@ foreach(PKG ${DEFAULT_PACKAGES})
endif() endif()
endforeach() endforeach()
# packages that need defines set
foreach(PKG MPIIO)
if(PKG_${PKG})
add_definitions(-DLMP_${PKG})
endif()
endforeach()
# dedicated check for entire contents of accelerator packages # dedicated check for entire contents of accelerator packages
foreach(PKG ${ACCEL_PACKAGES}) foreach(PKG ${ACCEL_PACKAGES})
set(${PKG}_SOURCES_DIR ${LAMMPS_SOURCE_DIR}/${PKG}) set(${PKG}_SOURCES_DIR ${LAMMPS_SOURCE_DIR}/${PKG})
@ -768,7 +840,7 @@ foreach(SIMPLE_LIB REAX MEAM POEMS USER-ATC USER-AWPMD USER-COLVARS USER-H5MD
if(PKG_LIB STREQUAL awpmd) if(PKG_LIB STREQUAL awpmd)
target_include_directories(awpmd PUBLIC ${LAMMPS_LIB_SOURCE_DIR}/awpmd/systems/interact ${LAMMPS_LIB_SOURCE_DIR}/awpmd/ivutils/include) target_include_directories(awpmd PUBLIC ${LAMMPS_LIB_SOURCE_DIR}/awpmd/systems/interact ${LAMMPS_LIB_SOURCE_DIR}/awpmd/ivutils/include)
elseif(PKG_LIB STREQUAL h5md) elseif(PKG_LIB STREQUAL h5md)
target_include_directories(h5md PUBLIC ${LAMMPS_LIB_SOURCE_DIR}/h5md/include) target_include_directories(h5md PUBLIC ${LAMMPS_LIB_SOURCE_DIR}/h5md/include ${HDF5_INCLUDE_DIRS})
elseif(PKG_LIB STREQUAL colvars) elseif(PKG_LIB STREQUAL colvars)
target_compile_options(colvars PRIVATE -DLEPTON) target_compile_options(colvars PRIVATE -DLEPTON)
target_include_directories(colvars PRIVATE ${LAMMPS_LIB_SOURCE_DIR}/colvars/lepton/include) target_include_directories(colvars PRIVATE ${LAMMPS_LIB_SOURCE_DIR}/colvars/lepton/include)
@ -791,6 +863,7 @@ if(PKG_USER-H5MD)
find_package(HDF5 REQUIRED) find_package(HDF5 REQUIRED)
target_link_libraries(h5md ${HDF5_LIBRARIES}) target_link_libraries(h5md ${HDF5_LIBRARIES})
target_include_directories(h5md PRIVATE ${HDF5_INCLUDE_DIRS}) target_include_directories(h5md PRIVATE ${HDF5_INCLUDE_DIRS})
include_directories(${HDF5_INCLUDE_DIRS})
endif() endif()
@ -876,6 +949,20 @@ if(PKG_USER-OMP)
include_directories(${USER-OMP_SOURCES_DIR}) include_directories(${USER-OMP_SOURCES_DIR})
endif() endif()
# Fix rigid/meso requires RIGID to be installed
if(PKG_USER-SDPD)
set(USER-SDPD_SOURCES_DIR ${LAMMPS_SOURCE_DIR}/USER-SDPD)
get_property(hlist GLOBAL PROPERTY FIX)
if(NOT PKG_RIGID)
list(REMOVE_ITEM hlist ${USER-SDPD_SOURCES_DIR}/fix_rigid_meso.h)
list(REMOVE_ITEM LIB_SOURCES ${USER-SDPD_SOURCES_DIR}/fix_rigid_meso.cpp)
endif()
set_property(GLOBAL PROPERTY FIX "${hlist}")
include_directories(${USER-SDPD_SOURCES_DIR})
endif()
if(PKG_KOKKOS) if(PKG_KOKKOS)
set(LAMMPS_LIB_KOKKOS_SRC_DIR ${LAMMPS_LIB_SOURCE_DIR}/kokkos) set(LAMMPS_LIB_KOKKOS_SRC_DIR ${LAMMPS_LIB_SOURCE_DIR}/kokkos)
set(LAMMPS_LIB_KOKKOS_BIN_DIR ${LAMMPS_LIB_BINARY_DIR}/kokkos) set(LAMMPS_LIB_KOKKOS_BIN_DIR ${LAMMPS_LIB_BINARY_DIR}/kokkos)
@ -953,7 +1040,7 @@ if(PKG_USER-INTEL)
endif() endif()
if(CMAKE_CXX_COMPILER_VERSION VERSION_LESS 16) if(CMAKE_CXX_COMPILER_VERSION VERSION_LESS 16)
message(FATAL_ERROR "USER-INTEL is needed at least 2016 intel compiler, found ${CMAKE_CXX_COMPILER_VERSION}") message(FATAL_ERROR "USER-INTEL needs at least a 2016 intel compiler, found ${CMAKE_CXX_COMPILER_VERSION}")
endif() endif()
if(NOT BUILD_OMP) if(NOT BUILD_OMP)
@ -1018,7 +1105,7 @@ if(PKG_USER-INTEL)
endif() endif()
if(PKG_GPU) if(PKG_GPU)
if (CMAKE_VERSION VERSION_LESS "3.1") if (CMAKE_VERSION VERSION_LESS "3.1")
message(FATAL_ERROR "For the GPU package you need at least cmake-3.1") message(FATAL_ERROR "For the GPU package you need at least cmake-3.1")
endif() endif()
set(GPU_SOURCES_DIR ${LAMMPS_SOURCE_DIR}/GPU) set(GPU_SOURCES_DIR ${LAMMPS_SOURCE_DIR}/GPU)
@ -1053,11 +1140,11 @@ if(PKG_GPU)
find_package(CUDA REQUIRED) find_package(CUDA REQUIRED)
find_program(BIN2C bin2c) find_program(BIN2C bin2c)
if(NOT BIN2C) if(NOT BIN2C)
message(FATAL_ERROR "Couldn't find bin2c, use -DBIN2C helping cmake to find it.") message(FATAL_ERROR "Could not find bin2c, use -DBIN2C=/path/to/bin2c to help cmake finding it.")
endif() endif()
option(CUDPP_OPT "Enable CUDPP_OPT" ON) option(CUDPP_OPT "Enable CUDPP_OPT" ON)
set(GPU_ARCH "sm_30" CACHE STRING "LAMMPS GPU CUDA SM architecture (e.g. sm_60)") set(GPU_ARCH "sm_30" CACHE STRING "LAMMPS GPU CUDA SM primary architecture (e.g. sm_60)")
file(GLOB GPU_LIB_CU ${LAMMPS_LIB_SOURCE_DIR}/gpu/[^.]*.cu ${CMAKE_CURRENT_SOURCE_DIR}/gpu/[^.]*.cu) file(GLOB GPU_LIB_CU ${LAMMPS_LIB_SOURCE_DIR}/gpu/[^.]*.cu ${CMAKE_CURRENT_SOURCE_DIR}/gpu/[^.]*.cu)
list(REMOVE_ITEM GPU_LIB_CU ${LAMMPS_LIB_SOURCE_DIR}/gpu/lal_pppm.cu) list(REMOVE_ITEM GPU_LIB_CU ${LAMMPS_LIB_SOURCE_DIR}/gpu/lal_pppm.cu)
@ -1070,11 +1157,39 @@ if(PKG_GPU)
file(GLOB GPU_LIB_CUDPP_CU ${LAMMPS_LIB_SOURCE_DIR}/gpu/cudpp_mini/[^.]*.cu) file(GLOB GPU_LIB_CUDPP_CU ${LAMMPS_LIB_SOURCE_DIR}/gpu/cudpp_mini/[^.]*.cu)
endif() endif()
cuda_compile_cubin(GPU_GEN_OBJS ${GPU_LIB_CU} OPTIONS # build arch/gencode commands for nvcc based on CUDA toolkit version and use choice
-DUNIX -O3 -Xptxas -v --use_fast_math -DNV_KERNEL -DUCL_CUDADR -arch=${GPU_ARCH} -D_${GPU_PREC_SETTING}) # --arch translates directly instead of JIT, so this should be for the preferred or most common architecture
set(GPU_CUDA_GENCODE "-arch=${GPU_ARCH} ")
# Fermi (GPU Arch 2.x) is supported by CUDA 3.2 to CUDA 8.0
if((CUDA_VERSION VERSION_GREATER "3.1") AND (CUDA_VERSION VERSION_LESS "9.0"))
string(APPEND GPU_CUDA_GENCODE "-gencode arch=compute_20,code=[sm_20,compute_20] ")
endif()
# Kepler (GPU Arch 3.x) is supported by CUDA 5 and later
if(CUDA_VERSION VERSION_GREATER "4.9")
string(APPEND GPU_CUDA_GENCODE "-gencode arch=compute_30,code=[sm_30,compute_30] -gencode arch=compute_35,code=[sm_35,compute_35] ")
endif()
# Maxwell (GPU Arch 5.x) is supported by CUDA 6 and later
if(CUDA_VERSION VERSION_GREATER "5.9")
string(APPEND GPU_CUDA_GENCODE "-gencode arch=compute_50,code=[sm_50,compute_50] -gencode arch=compute_52,code=[sm_52,compute_52] ")
endif()
# Pascal (GPU Arch 6.x) is supported by CUDA 8 and later
if(CUDA_VERSION VERSION_GREATER "7.9")
string(APPEND GPU_CUDA_GENCODE "-gencode arch=compute_60,code=[sm_60,compute_60] -gencode arch=compute_61,code=[sm_61,compute_61] ")
endif()
# Volta (GPU Arch 7.0) is supported by CUDA 9 and later
if(CUDA_VERSION VERSION_GREATER "8.9")
string(APPEND GPU_CUDA_GENCODE "-gencode arch=compute_70,code=[sm_70,compute_70] ")
endif()
# Turing (GPU Arch 7.5) is supported by CUDA 10 and later
if(CUDA_VERSION VERSION_GREATER "9.9")
string(APPEND GPU_CUDA_GENCODE "-gencode arch=compute_75,code=[sm_75,compute_75] ")
endif()
cuda_compile(GPU_OBJS ${GPU_LIB_CUDPP_CU} OPTIONS $<$<BOOL:${BUILD_SHARED_LIBS}>:-Xcompiler=-fPIC> cuda_compile_fatbin(GPU_GEN_OBJS ${GPU_LIB_CU} OPTIONS
-DUNIX -O3 -Xptxas -v --use_fast_math -DUCL_CUDADR -arch=${GPU_ARCH} -D_${GPU_PREC_SETTING}) -DUNIX -O3 --use_fast_math -Wno-deprecated-gpu-targets -DNV_KERNEL -DUCL_CUDADR ${GPU_CUDA_GENCODE} -D_${GPU_PREC_SETTING})
cuda_compile(GPU_OBJS ${GPU_LIB_CUDPP_CU} OPTIONS ${CUDA_REQUEST_PIC}
-DUNIX -O3 --use_fast_math -Wno-deprecated-gpu-targets -DUCL_CUDADR ${GPU_CUDA_GENCODE} -D_${GPU_PREC_SETTING})
foreach(CU_OBJ ${GPU_GEN_OBJS}) foreach(CU_OBJ ${GPU_GEN_OBJS})
get_filename_component(CU_NAME ${CU_OBJ} NAME_WE) get_filename_component(CU_NAME ${CU_OBJ} NAME_WE)
@ -1166,7 +1281,6 @@ set(LAMMPS_STYLE_HEADERS_DIR ${CMAKE_CURRENT_BINARY_DIR}/styles)
GenerateStyleHeaders(${LAMMPS_STYLE_HEADERS_DIR}) GenerateStyleHeaders(${LAMMPS_STYLE_HEADERS_DIR})
include_directories(${LAMMPS_SOURCE_DIR})
include_directories(${LAMMPS_STYLE_HEADERS_DIR}) include_directories(${LAMMPS_STYLE_HEADERS_DIR})
###################################### ######################################
@ -1223,7 +1337,7 @@ if(BUILD_EXE)
add_dependencies(lmp ${LAMMPS_DEPS}) add_dependencies(lmp ${LAMMPS_DEPS})
endif() endif()
endif() endif()
set_target_properties(lmp PROPERTIES OUTPUT_NAME ${LAMMPS_BINARY}) set_target_properties(lmp PROPERTIES OUTPUT_NAME ${LAMMPS_BINARY})
install(TARGETS lmp DESTINATION ${CMAKE_INSTALL_BINDIR}) install(TARGETS lmp DESTINATION ${CMAKE_INSTALL_BINDIR})
install(FILES ${LAMMPS_DOC_DIR}/lammps.1 DESTINATION ${CMAKE_INSTALL_MANDIR}/man1 RENAME ${LAMMPS_BINARY}.1) install(FILES ${LAMMPS_DOC_DIR}/lammps.1 DESTINATION ${CMAKE_INSTALL_MANDIR}/man1 RENAME ${LAMMPS_BINARY}.1)
@ -1344,7 +1458,6 @@ foreach(PKG ${DEFAULT_PACKAGES} ${ACCEL_PACKAGES} ${OTHER_PACKAGES})
endif() endif()
endforeach() endforeach()
string(TOUPPER "${CMAKE_BUILD_TYPE}" BTYPE)
get_directory_property(CPPFLAGS DIRECTORY ${CMAKE_SOURCE_DIR} COMPILE_DEFINITIONS) get_directory_property(CPPFLAGS DIRECTORY ${CMAKE_SOURCE_DIR} COMPILE_DEFINITIONS)
include(FeatureSummary) include(FeatureSummary)
feature_summary(DESCRIPTION "The following packages have been found:" WHAT PACKAGES_FOUND) feature_summary(DESCRIPTION "The following packages have been found:" WHAT PACKAGES_FOUND)
@ -1360,14 +1473,14 @@ message(STATUS "<<< Build configuration >>>
get_property(LANGUAGES GLOBAL PROPERTY ENABLED_LANGUAGES) get_property(LANGUAGES GLOBAL PROPERTY ENABLED_LANGUAGES)
list (FIND LANGUAGES "Fortran" _index) list (FIND LANGUAGES "Fortran" _index)
if (${_index} GREATER -1) if (${_index} GREATER -1)
message(STATUS "Fortran Compiler ${CMAKE_Fortran_COMPILER} message(STATUS "Fortran Compiler ${CMAKE_Fortran_COMPILER}
Type ${CMAKE_Fortran_COMPILER_ID} Type ${CMAKE_Fortran_COMPILER_ID}
Version ${CMAKE_Fortran_COMPILER_VERSION} Version ${CMAKE_Fortran_COMPILER_VERSION}
Fortran Flags ${CMAKE_Fortran_FLAGS} ${CMAKE_Fortran_FLAGS_${BTYPE}}") Fortran Flags ${CMAKE_Fortran_FLAGS} ${CMAKE_Fortran_FLAGS_${BTYPE}}")
endif() endif()
list (FIND LANGUAGES "C" _index) list (FIND LANGUAGES "C" _index)
if (${_index} GREATER -1) if (${_index} GREATER -1)
message(STATUS "C Compiler ${CMAKE_C_COMPILER} message(STATUS "C Compiler ${CMAKE_C_COMPILER}
Type ${CMAKE_C_COMPILER_ID} Type ${CMAKE_C_COMPILER_ID}
Version ${CMAKE_C_COMPILER_VERSION} Version ${CMAKE_C_COMPILER_VERSION}
C Flags ${CMAKE_C_FLAGS} ${CMAKE_C_FLAGS_${BTYPE}}") C Flags ${CMAKE_C_FLAGS} ${CMAKE_C_FLAGS_${BTYPE}}")
@ -1375,7 +1488,7 @@ endif()
if(CMAKE_EXE_LINKER_FLAGS) if(CMAKE_EXE_LINKER_FLAGS)
message(STATUS "Linker flags: message(STATUS "Linker flags:
Executable ${CMAKE_EXE_LINKER_FLAGS}") Executable ${CMAKE_EXE_LINKER_FLAGS}")
endif() endif()
if(BUILD_SHARED_LIBS) if(BUILD_SHARED_LIBS)
message(STATUS "Shared libraries ${CMAKE_SHARED_LINKER_FLAGS}") message(STATUS "Shared libraries ${CMAKE_SHARED_LINKER_FLAGS}")
else() else()

View File

@ -195,6 +195,7 @@ cmake -C ../cmake/presets/std_nolib.cmake -D PKG_GPU=on ../cmake
<td><code>CMAKE_INSTALL_PREFIX</code></td> <td><code>CMAKE_INSTALL_PREFIX</code></td>
<td>Install location where LAMMPS files will be copied to. In the Unix/Linux case with Makefiles this controls what `make install` will do.</td> <td>Install location where LAMMPS files will be copied to. In the Unix/Linux case with Makefiles this controls what `make install` will do.</td>
<td> <td>
Default setting is <code>$HOME/.local</code>.
</td> </td>
</tr> </tr>
<tr> <tr>
@ -1492,6 +1493,11 @@ target API.
</dl> </dl>
</td> </td>
</tr> </tr>
<tr>
<td><code>BIN2C</code> (CUDA only)</td>
<td>Path to bin2c executable, will automatically pick up the first one in your $PATH.</td>
<td>(automatic)</td>
</tr>
</tbody> </tbody>
</table> </table>
@ -1647,9 +1653,8 @@ requires `gzip` to be in your `PATH`
</tr> </tr>
<tr> <tr>
<td><code>GZIP_EXECUTABLE</code></td> <td><code>GZIP_EXECUTABLE</code></td>
<td></td> <td>Path to gzip executable, will automatically pick up the first one in your $PATH.</td>
<td> <td>(automatic)</td>
</td>
</tr> </tr>
</tbody> </tbody>
</table> </table>
@ -1679,9 +1684,8 @@ requires `ffmpeg` to be in your `PATH`
</tr> </tr>
<tr> <tr>
<td><code>FFMPEG_EXECUTABLE</code></td> <td><code>FFMPEG_EXECUTABLE</code></td>
<td></td> <td>Path to ffmpeg executable, will automatically pick up the first one in your $PATH.</td>
<td> <td>(automatic)</td>
</td>
</tr> </tr>
</tbody> </tbody>
</table> </table>

View File

@ -1,9 +1,29 @@
# pkg-config file for lammps # pkg-config file for lammps
# https://people.freedesktop.org/~dbn/pkg-config-guide.html # https://people.freedesktop.org/~dbn/pkg-config-guide.html
# Usage: cc `pkg-config --cflags --libs liblammps` -o myapp myapp.c
# after you added @CMAKE_INSTALL_FULL_LIBDIR@/pkg-config to PKG_CONFIG_PATH, # Add the directory where lammps.pc got installed to your PKG_CONFIG_PATH
# e.g. export PKG_CONFIG_PATH=@CMAKE_INSTALL_FULL_LIBDIR@/pkgconfig # e.g. export PKG_CONFIG_PATH=@CMAKE_INSTALL_FULL_LIBDIR@/pkgconfig
# Use this on commandline with:
# c++ `pkg-config --cflags --libs lammps` -o myapp myapp.cpp
# Use this in a Makefile:
# myapp: myapp.cpp
# $(CC) `pkg-config --cflags --libs lammps` -o $@ $<
# Use this in autotools:
# configure.ac:
# PKG_CHECK_MODULES([LAMMPS], [lammps])
# Makefile.am:
# myapp_CFLAGS = $(LAMMPS_CFLAGS)
# myapp_LDADD = $(LAMMPS_LIBS)
# Use this in CMake:
# CMakeLists.txt:
# find_package(PkgConfig)
# pkg_check_modules(LAMMPS IMPORTED_TARGET lammps)
# target_link_libraries(<lib> PkgConfig::LAMMPS)
prefix=@CMAKE_INSTALL_PREFIX@ prefix=@CMAKE_INSTALL_PREFIX@
libdir=@CMAKE_INSTALL_FULL_LIBDIR@ libdir=@CMAKE_INSTALL_FULL_LIBDIR@
includedir=@CMAKE_INSTALL_FULL_INCLUDEDIR@ includedir=@CMAKE_INSTALL_FULL_INCLUDEDIR@

View File

@ -8,12 +8,12 @@ set(USER_PACKAGES USER-ATC USER-AWPMD USER-BOCS USER-CGDNA USER-CGSDK USER-COLVA
USER-INTEL USER-LB USER-MANIFOLD USER-MEAMC USER-MESO USER-INTEL USER-LB USER-MANIFOLD USER-MEAMC USER-MESO
USER-MGPT USER-MISC USER-MOFFF USER-MOLFILE USER-MGPT USER-MISC USER-MOFFF USER-MOLFILE
USER-NETCDF USER-OMP USER-PHONON USER-QMMM USER-QTB USER-NETCDF USER-OMP USER-PHONON USER-QMMM USER-QTB
USER-QUIP USER-REAXC USER-SMD USER-SMTBQ USER-SPH USER-TALLY USER-QUIP USER-REAXC USER-SDPD USER-SMD USER-SMTBQ USER-SPH USER-TALLY
USER-UEF USER-VTK) USER-UEF USER-VTK)
set(PACKAGES_WITH_LIB COMPRESS GPU KIM KOKKOS LATTE MEAM MPIIO MSCG POEMS PYTHON REAX VORONOI set(PACKAGES_WITH_LIB COMPRESS GPU KIM KOKKOS LATTE MEAM MPIIO MSCG POEMS PYTHON REAX VORONOI
USER-ATC USER-AWPMD USER-COLVARS USER-H5MD USER-LB USER-MOLFILE USER-ATC USER-AWPMD USER-COLVARS USER-H5MD USER-LB USER-MOLFILE
USER-NETCDF USER-QMMM USER-QUIP USER-SMD USER-VTK) USER-NETCDF USER-PLUMED USER-QMMM USER-QUIP USER-SMD USER-VTK)
set(ALL_PACKAGES ${STANDARD_PACKAGES} ${USER_PACKAGES}) set(ALL_PACKAGES ${STANDARD_PACKAGES} ${USER_PACKAGES})

View File

@ -8,12 +8,12 @@ set(USER_PACKAGES USER-ATC USER-AWPMD USER-BOCS USER-CGDNA USER-CGSDK USER-COLVA
USER-INTEL USER-LB USER-MANIFOLD USER-MEAMC USER-MESO USER-INTEL USER-LB USER-MANIFOLD USER-MEAMC USER-MESO
USER-MGPT USER-MISC USER-MOFFF USER-MOLFILE USER-MGPT USER-MISC USER-MOFFF USER-MOLFILE
USER-NETCDF USER-OMP USER-PHONON USER-QMMM USER-QTB USER-NETCDF USER-OMP USER-PHONON USER-QMMM USER-QTB
USER-QUIP USER-REAXC USER-SMD USER-SMTBQ USER-SPH USER-TALLY USER-QUIP USER-REAXC USER-SDPD USER-SMD USER-SMTBQ USER-SPH USER-TALLY
USER-UEF USER-VTK) USER-UEF USER-VTK)
set(PACKAGES_WITH_LIB COMPRESS GPU KIM KOKKOS LATTE MEAM MPIIO MSCG POEMS PYTHON REAX VORONOI set(PACKAGES_WITH_LIB COMPRESS GPU KIM KOKKOS LATTE MEAM MPIIO MSCG POEMS PYTHON REAX VORONOI
USER-ATC USER-AWPMD USER-COLVARS USER-H5MD USER-LB USER-MOLFILE USER-ATC USER-AWPMD USER-COLVARS USER-H5MD USER-LB USER-MOLFILE
USER-NETCDF USER-QMMM USER-QUIP USER-SMD USER-VTK) USER-NETCDF USER-PLUMED USER-QMMM USER-QUIP USER-SMD USER-VTK)
set(ALL_PACKAGES ${STANDARD_PACKAGES} ${USER_PACKAGES}) set(ALL_PACKAGES ${STANDARD_PACKAGES} ${USER_PACKAGES})

View File

@ -56,11 +56,13 @@ set(PKG_USER-MOFFF OFF CACHE BOOL "" FORCE)
set(PKG_USER-MOLFILE OFF CACHE BOOL "" FORCE) set(PKG_USER-MOLFILE OFF CACHE BOOL "" FORCE)
set(PKG_USER-NETCDF OFF CACHE BOOL "" FORCE) set(PKG_USER-NETCDF OFF CACHE BOOL "" FORCE)
set(PKG_USER-OMP OFF CACHE BOOL "" FORCE) set(PKG_USER-OMP OFF CACHE BOOL "" FORCE)
set(PKG_USER-PHOFFOFF OFF CACHE BOOL "" FORCE) set(PKG_USER-PHONON OFF CACHE BOOL "" FORCE)
set(PKG_USER-PLUMED OFF CACHE BOOL "" FORCE)
set(PKG_USER-QMMM OFF CACHE BOOL "" FORCE) set(PKG_USER-QMMM OFF CACHE BOOL "" FORCE)
set(PKG_USER-QTB OFF CACHE BOOL "" FORCE) set(PKG_USER-QTB OFF CACHE BOOL "" FORCE)
set(PKG_USER-QUIP OFF CACHE BOOL "" FORCE) set(PKG_USER-QUIP OFF CACHE BOOL "" FORCE)
set(PKG_USER-REAXC OFF CACHE BOOL "" FORCE) set(PKG_USER-REAXC OFF CACHE BOOL "" FORCE)
set(PKG_USER-SDPD OFF CACHE BOOL "" FORCE)
set(PKG_USER-SMD OFF CACHE BOOL "" FORCE) set(PKG_USER-SMD OFF CACHE BOOL "" FORCE)
set(PKG_USER-SMTBQ OFF CACHE BOOL "" FORCE) set(PKG_USER-SMTBQ OFF CACHE BOOL "" FORCE)
set(PKG_USER-SPH OFF CACHE BOOL "" FORCE) set(PKG_USER-SPH OFF CACHE BOOL "" FORCE)

View File

@ -8,12 +8,12 @@ set(USER_PACKAGES USER-ATC USER-AWPMD USER-BOCS USER-CGDNA USER-CGSDK USER-COLVA
USER-INTEL USER-LB USER-MANIFOLD USER-MEAMC USER-MESO USER-INTEL USER-LB USER-MANIFOLD USER-MEAMC USER-MESO
USER-MGPT USER-MISC USER-MOFFF USER-MOLFILE USER-MGPT USER-MISC USER-MOFFF USER-MOLFILE
USER-NETCDF USER-OMP USER-PHONON USER-QMMM USER-QTB USER-NETCDF USER-OMP USER-PHONON USER-QMMM USER-QTB
USER-QUIP USER-REAXC USER-SMD USER-SMTBQ USER-SPH USER-TALLY USER-QUIP USER-REAXC USER-SDPD USER-SMD USER-SMTBQ USER-SPH USER-TALLY
USER-UEF USER-VTK) USER-UEF USER-VTK)
set(PACKAGES_WITH_LIB COMPRESS GPU KIM KOKKOS LATTE MEAM MPIIO MSCG POEMS PYTHON REAX VORONOI set(PACKAGES_WITH_LIB COMPRESS GPU KIM KOKKOS LATTE MEAM MPIIO MSCG POEMS PYTHON REAX VORONOI
USER-ATC USER-AWPMD USER-COLVARS USER-H5MD USER-LB USER-MOLFILE USER-ATC USER-AWPMD USER-COLVARS USER-H5MD USER-LB USER-MOLFILE
USER-NETCDF USER-QMMM USER-QUIP USER-SMD USER-VTK) USER-NETCDF USER-PLUMED USER-QMMM USER-QUIP USER-SMD USER-VTK)
set(ALL_PACKAGES ${STANDARD_PACKAGES} ${USER_PACKAGES}) set(ALL_PACKAGES ${STANDARD_PACKAGES} ${USER_PACKAGES})

View File

@ -8,7 +8,7 @@ set(USER_PACKAGES USER-ATC USER-AWPMD USER-BOCS USER-CGDNA USER-CGSDK USER-COLVA
USER-INTEL USER-LB USER-MANIFOLD USER-MEAMC USER-MESO USER-INTEL USER-LB USER-MANIFOLD USER-MEAMC USER-MESO
USER-MGPT USER-MISC USER-MOFFF USER-MOLFILE USER-MGPT USER-MISC USER-MOFFF USER-MOLFILE
USER-NETCDF USER-OMP USER-PHONON USER-QMMM USER-QTB USER-NETCDF USER-OMP USER-PHONON USER-QMMM USER-QTB
USER-QUIP USER-REAXC USER-SMD USER-SMTBQ USER-SPH USER-TALLY USER-QUIP USER-REAXC USER-SDPD USER-SMD USER-SMTBQ USER-SPH USER-TALLY
USER-UEF USER-VTK) USER-UEF USER-VTK)
set(PACKAGES_WITH_LIB COMPRESS GPU KIM KOKKOS LATTE MEAM MPIIO MSCG POEMS PYTHON REAX VORONOI set(PACKAGES_WITH_LIB COMPRESS GPU KIM KOKKOS LATTE MEAM MPIIO MSCG POEMS PYTHON REAX VORONOI

View File

@ -8,7 +8,7 @@ set(USER_PACKAGES USER-ATC USER-AWPMD USER-BOCS USER-CGDNA USER-CGSDK USER-COLVA
USER-INTEL USER-LB USER-MANIFOLD USER-MEAMC USER-MESO USER-INTEL USER-LB USER-MANIFOLD USER-MEAMC USER-MESO
USER-MGPT USER-MISC USER-MOFFF USER-MOLFILE USER-MGPT USER-MISC USER-MOFFF USER-MOLFILE
USER-NETCDF USER-OMP USER-PHONON USER-QMMM USER-QTB USER-NETCDF USER-OMP USER-PHONON USER-QMMM USER-QTB
USER-QUIP USER-REAXC USER-SMD USER-SMTBQ USER-SPH USER-TALLY USER-QUIP USER-REAXC USER-SDPD USER-SMD USER-SMTBQ USER-SPH USER-TALLY
USER-UEF USER-VTK) USER-UEF USER-VTK)
set(PACKAGES_WITH_LIB COMPRESS GPU KIM KOKKOS LATTE MEAM MPIIO MSCG POEMS PYTHON REAX VORONOI set(PACKAGES_WITH_LIB COMPRESS GPU KIM KOKKOS LATTE MEAM MPIIO MSCG POEMS PYTHON REAX VORONOI

View File

@ -8,12 +8,12 @@ set(USER_PACKAGES USER-ATC USER-AWPMD USER-BOCS USER-CGDNA USER-CGSDK USER-COLVA
USER-INTEL USER-LB USER-MANIFOLD USER-MEAMC USER-MESO USER-INTEL USER-LB USER-MANIFOLD USER-MEAMC USER-MESO
USER-MGPT USER-MISC USER-MOFFF USER-MOLFILE USER-MGPT USER-MISC USER-MOFFF USER-MOLFILE
USER-NETCDF USER-OMP USER-PHONON USER-QMMM USER-QTB USER-NETCDF USER-OMP USER-PHONON USER-QMMM USER-QTB
USER-QUIP USER-REAXC USER-SMD USER-SMTBQ USER-SPH USER-TALLY USER-QUIP USER-REAXC USER-SDPD USER-SMD USER-SMTBQ USER-SPH USER-TALLY
USER-UEF USER-VTK) USER-UEF USER-VTK)
set(PACKAGES_WITH_LIB COMPRESS GPU KIM KOKKOS LATTE MEAM MPIIO MSCG POEMS PYTHON REAX VORONOI set(PACKAGES_WITH_LIB COMPRESS GPU KIM KOKKOS LATTE MEAM MPIIO MSCG POEMS PYTHON REAX VORONOI
USER-ATC USER-AWPMD USER-COLVARS USER-H5MD USER-LB USER-MOLFILE USER-ATC USER-AWPMD USER-COLVARS USER-H5MD USER-LB USER-MOLFILE
USER-NETCDF USER-QMMM USER-QUIP USER-SMD USER-VTK) USER-NETCDF USER-PLUMED USER-QMMM USER-QUIP USER-SMD USER-VTK)
set(ALL_PACKAGES ${STANDARD_PACKAGES} ${USER_PACKAGES}) set(ALL_PACKAGES ${STANDARD_PACKAGES} ${USER_PACKAGES})

View File

@ -1,7 +1,7 @@
# Makefile for LAMMPS documentation # Makefile for LAMMPS documentation
SHELL = /bin/bash SHELL = /bin/bash
SHA1 = $(shell echo $USER-$PWD | python utils/sha1sum.py) SHA1 = $(shell echo ${USER}-${PWD} | python utils/sha1sum.py)
BUILDDIR = /tmp/lammps-docs-$(SHA1) BUILDDIR = /tmp/lammps-docs-$(SHA1)
RSTDIR = $(BUILDDIR)/rst RSTDIR = $(BUILDDIR)/rst
VENV = $(BUILDDIR)/docenv VENV = $(BUILDDIR)/docenv
@ -176,7 +176,6 @@ $(VENV):
$(VIRTUALENV) -p $(PYTHON) $(VENV); \ $(VIRTUALENV) -p $(PYTHON) $(VENV); \
. $(VENV)/bin/activate; \ . $(VENV)/bin/activate; \
pip install Sphinx; \ pip install Sphinx; \
pip install sphinxcontrib-images; \
deactivate;\ deactivate;\
) )

View File

@ -0,0 +1,192 @@
# Outline of the GitHub Development Workflow
This purpose of this document is to provide a point of reference for the
core LAMMPS developers and other LAMMPS contributors to understand the
choices the LAMMPS developers have agreed on. Git and GitHub provide the
tools, but do not set policies, so it is up to the developers to come to
an agreement as to how to define and interpret policies. This document
is likely to change as our experiences and needs change and we try to
adapt accordingly. Last change 2018-11-15.
## Table of Contents
* [GitHub Merge Management](#github-merge-management)
* [Pull Requests](#pull-requests)
* [Pull Request Assignments](#pull-request-assignments)
* [Pull Request Reviews](#pull-request-reviews)
* [Pull Request Discussions](#pull-request-discussions)
* [Checklist for Pull Requests](#checklist-for-pull-requests)
* [GitHub Issues](#github-issues)
* [Milestones and Release Planning](#milestones-and-release-planning)
## GitHub Merge Management
In the interest of consistency, ONLY ONE of the core LAMMPS developers
should doing the merging itself. This is currently
[@akohlmey](https://github.com/akohlmey) (Axel Kohlmeyer).
If this assignment needs to be changed, it shall be done right after a
stable release. If the currently assigned developer cannot merge outstanding pull
requests in a timely manner, or in other extenuating circumstances,
other core LAMMPS developers with merge rights can merge pull requests,
when necessary.
## Pull Requests
ALL changes to the LAMMPS code and documentation, however trivial, MUST
be submitted as a pull request to GitHub. All changes to the "master"
branch must be made exclusively through merging pull requests. The
"unstable" and "stable" branches, respectively are only to be updated
upon patch or stable releases with fast-forward merges based on the
associated tags. Pull requests may also be submitted to (long-running)
feature branches created by LAMMPS developers inside the LAMMPS project,
if needed. Those are not subject to the merge and review restrictions
discussed in this document, though, but get managed as needed on a
case-by-case basis.
### Pull Request Assignments
Pull requests can be "chaperoned" by one of the LAMMPS core developers.
This is indicated by who the pull request is assigned to. LAMMPS core
developers can self-assign or they can decide to assign a pull request
to a different LAMMPS developer. Being assigned to a pull request means,
that this pull request may need some work and the assignee is tasked to
determine what this might be needed or not, and may either implement the
required changes or ask the submitter of the pull request to implement
them. Even though, all LAMMPS developers may have write access to pull
requests (if enabled by the submitter, which is the default), only the
submitter or the assignee of a pull request may do so. During this
period the `work_in_progress` label shall be applied to the pull
request. The assignee gets to decide what happens to the pull request
next, e.g. whether it should be assigned to a different developer for
additional checks and changes, or is recommended to be merged. Removing
the `work_in_progress` label and assigning the pull request to the
developer tasked with merging signals that a pull request is ready to be
merged.
### Pull Request Reviews
People can be assigned to review a pull request in two ways:
* They can be assigned manually to review a pull request
by the submitter or a LAMMPS developer
* They can be automatically assigned, because a developers matches
a file pattern in the `.github/CODEOWNERS` file, which associates
developers with the code they contributed and maintain.
Reviewers are requested to state their appraisal of the proposed changes
and either approve or request changes. People may unassign themselves
from review, if they feel not competent about the changes proposed. At
least one review from a LAMMPS developer with write access is required
before merging in addition to the automated compilation tests. The
feature, that reviews from code owners are "hard" reviews (i.e. they
must all be approved before merging is allowed), is currently disabled
and it is in the discretion of the merge maintainer to assess when
a sufficient degree of approval has been reached. Reviews may be
(automatically) dismissed, when the reviewed code has been changed,
and then approval is required a second time.
### Pull Request Discussions
All discussions about a pull request should be kept as much as possible
on the pull request discussion page on GitHub, so that other developers
can later review the entire discussion after the fact and understand the
rationale behind choices made. Exceptions to this policy are technical
discussions, that are centered on tools or policies themselves
(git, github, c++) rather than on the content of the pull request.
### Checklist for Pull Requests
Here are some items to check:
* source and text files should not have CR/LF line endings (use dos2unix to remove)
* every new command or style should have documentation. The names of
source files (c++ and manual) should follow the name of the style.
(example: `src/fix_nve.cpp`, `src/fix_nve.h` for `fix nve` command,
implementing the class `FixNVE`, documented in `doc/src/fix_nve.txt`)
* all new style names should be lower case, the must be no dashes,
blanks, or underscores separating words, only forward slashes.
* new style docs should be added to the "overview" files in
`doc/src/Commands_*.txt`, `doc/src/{fixes,computes,pairs,bonds,...}.txt`
and `doc/src/lammps.book`
* check whether manual cleanly translates with `make html` and `make pdf`
* check spelling of manual with `make spelling` in doc folder
* new source files in packages should be added to `src/.gitignore`
* removed or renamed files in packages should be added to `src/Purge.list`
* C++ source files should use C++ style include files for accessing
C-library APIs, e.g. `#include <cstdlib>` instead of `#include <stdlib.h>`.
And they should use angular brackets instead of double quotes. Full list:
* assert.h -> cassert
* ctype.h -> cctype
* errno.h -> cerrno
* float.h -> cfloat
* limits.h -> climits
* math.h -> cmath
* omplex.h -> complex
* setjmp.h -> csetjmp
* signal.h -> csignal
* stddef.h -> cstddef
* stdint.h -> cstdint
* stdio.h -> cstdio
* stdlib.h -> cstdlib
* string.h -> cstring
* time.h -> ctime
Do not replace (as they are C++-11): `inttypes.h` and `stdint.h`.
* Code should follow the C++-98 standard. C++-11 is only accepted
in individual special purpose packages
* indentation is two spaces per level
* there should be no tabs and no trailing whitespace
* header files, especially of new styles, should not include any
other headers, except the header with the base class or cstdio.
Forward declarations should be used instead when possible.
* iostreams should be avoided. LAMMPS uses stdio from the C-library.
* use of STL in headers and class definitions should be avoided.
* static class members should be avoided at all cost.
* anything storing atom IDs should be using `tagint` and not `int`.
This can be flagged by the compiler only for pointers and only when
compiling LAMMPS with `-DLAMMPS_BIGBIG`.
* when including both `lmptype.h` (and using defines or macros from it)
and `mpi.h`, `lmptype.h` must be included first.
* when pair styles are added, check if settings for flags like
`single_enable`, `writedata`, `reinitflag`, `manybody_flag`
and others are correctly set and supported.
## GitHub Issues
The GitHub issue tracker is the location where the LAMMPS developers
and other contributors or LAMMPS users can report issues or bugs with
the LAMMPS code or request new features to be added. Feature requests
are usually indicated by a `[Feature Request]` marker in the subject.
Issues are assigned to a person, if this person is working on this
feature or working to resolve an issue. Issues that have nobody working
on them at the moment, have the label `volunteer needed` attached.
When an issue, say `#125` is resolved by a specific pull request,
the comment for the pull request shall contain the text `closes #125`
or `fixes #125`, so that the issue is automatically deleted when
the pull request is merged.
## Milestones and Release Planning
LAMMPS uses a continuous release development model with incremental
changes, i.e. significant effort is made - including automated pre-merge
testing - that the code in the branch "master" does not get broken.
More extensive testing (including regression testing) is performed after
code is merged to the "master" branch. There are patch releases of
LAMMPS every 1-3 weeks at a point, when the LAMMPS developers feel, that
a sufficient amount of changes have happened, and the post-merge testing
has been successful. These patch releases are marked with a
`patch_<version date>` tag and the "unstable" branch follows only these
versions (and thus is always supposed to be of production quality,
unlike "master", which may be temporary broken, in the case of larger
change sets or unexpected incompatibilities or side effects.
About 3-4 times each year, there are going to be "stable" releases
of LAMMPS. These have seen additional, manual testing and review of
results from testing with instrumented code and static code analysis.
Also, in the last 2-3 patch releases before a stable release are
"release candidate" versions which only contain bugfixes and
documentation updates. For release planning and the information of
code contributors, issues and pull requests being actively worked on
are assigned a "milestone", which corresponds to the next stable
release or the stable release after that, with a tentative release
date.

View File

@ -49,7 +49,7 @@ make mybox :pre # uses Makefile.mybox to produce lmp_mybox :pre
Serial build (see src/MAKE/Makefile.serial): Serial build (see src/MAKE/Makefile.serial):
MPI_INC = -I../STUBS MPI_INC = -I../STUBS
MPI_PATH = -L../STUBS MPI_PATH = -L../STUBS
MPI_LIB = -lmpi_stubs :pre MPI_LIB = -lmpi_stubs :pre
@ -137,9 +137,9 @@ simply loading the appropriate module before building LAMMPS.
-D CMAKE_C_COMPILER=name # name of C compiler -D CMAKE_C_COMPILER=name # name of C compiler
-D CMAKE_Fortran_COMPILER=name # name of Fortran compiler :pre -D CMAKE_Fortran_COMPILER=name # name of Fortran compiler :pre
-D CMAKE_CXX_FlAGS=string # flags to use with C++ compiler -D CMAKE_CXX_FLAGS=string # flags to use with C++ compiler
-D CMAKE_C_FlAGS=string # flags to use with C compiler -D CMAKE_C_FLAGS=string # flags to use with C compiler
-D CMAKE_Fortran_FlAGS=string # flags to use with Fortran compiler :pre -D CMAKE_Fortran_FLAGS=string # flags to use with Fortran compiler :pre
By default CMake will use a compiler it finds and it will add By default CMake will use a compiler it finds and it will add
optimization flags appropriate to that compiler and any "accelerator optimization flags appropriate to that compiler and any "accelerator
@ -172,7 +172,7 @@ want.
Parallel build (see src/MAKE/Makefile.mpi): Parallel build (see src/MAKE/Makefile.mpi):
CC = mpicxx CC = mpicxx
CCFLAGS = -g -O3 CCFLAGS = -g -O3
LINK = mpicxx LINK = mpicxx
LINKFLAGS = -g -O :pre LINKFLAGS = -g -O :pre
@ -292,7 +292,7 @@ This will create a lammps/doc/html dir with the HTML doc pages so that
you can browse them locally on your system. Type "make" from the you can browse them locally on your system. Type "make" from the
lammps/doc dir to see other options. lammps/doc dir to see other options.
NOTE: You can also download a tarball of the documention for the NOTE: You can also download a tarball of the documentation for the
current LAMMPS version (HTML and PDF files), from the website current LAMMPS version (HTML and PDF files), from the website
"download page"_http://lammps.sandia.gov/download.html. "download page"_http://lammps.sandia.gov/download.html.

View File

@ -27,7 +27,7 @@ make command to build LAMMPS, which uses the created
Makefile(s). Example: Makefile(s). Example:
cd lammps # change to the LAMMPS distribution directory cd lammps # change to the LAMMPS distribution directory
mkdir build; cd build # create a new directory (folder) for build mkdir build; cd build # create a new directory (folder) for build
cmake ../cmake \[options ...\] # configuration with (command-line) cmake cmake ../cmake \[options ...\] # configuration with (command-line) cmake
make # compilation :pre make # compilation :pre
@ -44,7 +44,7 @@ LAMMPS or need to re-compile LAMMPS repeatedly, installation of the
ccache (= Compiler Cache) software may speed up compilation even more. ccache (= Compiler Cache) software may speed up compilation even more.
After compilation, you can optionally copy the LAMMPS executable and After compilation, you can optionally copy the LAMMPS executable and
library into your system folders (by default under /usr/local) with: library into your system folders (by default under $HOME/.local) with:
make install # optional, copy LAMMPS executable & library elsewhere :pre make install # optional, copy LAMMPS executable & library elsewhere :pre

View File

@ -45,6 +45,7 @@ This is the list of packages that may require additional steps.
"USER-INTEL"_#user-intel, "USER-INTEL"_#user-intel,
"USER-MOLFILE"_#user-molfile, "USER-MOLFILE"_#user-molfile,
"USER-NETCDF"_#user-netcdf, "USER-NETCDF"_#user-netcdf,
"USER-PLUMED"_#user-plumed,
"USER-OMP"_#user-omp, "USER-OMP"_#user-omp,
"USER-QMMM"_#user-qmmm, "USER-QMMM"_#user-qmmm,
"USER-QUIP"_#user-quip, "USER-QUIP"_#user-quip,
@ -63,7 +64,7 @@ available on your system.
If CMake cannot find the library, you can set these variables: If CMake cannot find the library, you can set these variables:
-D ZLIB_INCLUDE_DIR=path # path to zlib.h header file -D ZLIB_INCLUDE_DIR=path # path to zlib.h header file
-D ZLIB_LIBRARIES=path # path to libz.a (.so) file :pre -D ZLIB_LIBRARIES=path # path to libz.a (.so) file :pre
[Traditional make]: [Traditional make]:
@ -86,22 +87,30 @@ which GPU hardware to build for.
# value = double or mixed (default) or single # value = double or mixed (default) or single
-D OCL_TUNE=value # hardware choice for GPU_API=opencl -D OCL_TUNE=value # hardware choice for GPU_API=opencl
# generic (default) or intel (Intel CPU) or fermi, kepler, cypress (NVIDIA) # generic (default) or intel (Intel CPU) or fermi, kepler, cypress (NVIDIA)
-D GPU_ARCH=value # hardware choice for GPU_API=cuda -D GPU_ARCH=value # primary GPU hardware choice for GPU_API=cuda
# value = sm_XX, see below # value = sm_XX, see below
# default is Cuda-compiler dependent, but typically sm_20 # default is Cuda-compiler dependent, but typically sm_20
-D CUDPP_OPT=value # optimization setting for GPU_API=cudea -D CUDPP_OPT=value # optimization setting for GPU_API=cuda
# enables CUDA Performance Primitives Optimizations # enables CUDA Performance Primitives Optimizations
# yes (default) or no :pre # yes (default) or no :pre
GPU_ARCH settings for different GPU hardware is as follows: GPU_ARCH settings for different GPU hardware is as follows:
sm_20 for Fermi (C2050/C2070, deprecated as of CUDA 8.0) or GeForce GTX 580 or similar sm_20 or sm_21 for Fermi (supported by CUDA 3.2 until CUDA 7.5)
sm_30 for Kepler (K10) sm_30 or sm_35 or sm_37 for Kepler (supported since CUDA 5)
sm_35 for Kepler (K40) or GeForce GTX Titan or similar sm_50 or sm_52 for Maxwell (supported since CUDA 6)
sm_37 for Kepler (dual K80) sm_60 or sm_61 for Pascal (supported since CUDA 8)
sm_50 for Maxwell sm_70 for Volta (supported since CUDA 9)
sm_60 for Pascal (P100) sm_75 for Turing (supported since CUDA 10) :ul
sm_70 for Volta :ul
A more detailed list can be found, for example,
at "Wikipedia's CUDA article"_https://en.wikipedia.org/wiki/CUDA#GPUs_supported
CMake can detect which version of the CUDA toolkit is used and thus can
include support for [all] major GPU architectures supported by this toolkit.
Thus the GPU_ARCH setting is merely an optimization, to have code for
the preferred GPU architecture directly included rather than having to wait
for the JIT compiler of the CUDA driver to translate it.
[Traditional make]: [Traditional make]:
@ -136,6 +145,11 @@ CUDA_ARCH = sm_XX, what GPU hardware you have, same as CMake GPU_ARCH above
CUDA_PRECISION = precision (double, mixed, single) CUDA_PRECISION = precision (double, mixed, single)
EXTRAMAKE = which Makefile.lammps.* file to copy to Makefile.lammps :ul EXTRAMAKE = which Makefile.lammps.* file to copy to Makefile.lammps :ul
The file Makefile.linux_multi is set up to include support for multiple
GPU architectures as supported by the CUDA toolkit in use. This is done
through using the "--gencode " flag, which can be used multiple times and
thus support all GPU architectures supported by your CUDA compiler.
If the library build is successful, 3 files should be created: If the library build is successful, 3 files should be created:
lib/gpu/libgpu.a, lib/gpu/nvc_get_devices, and lib/gpu/libgpu.a, lib/gpu/nvc_get_devices, and
lib/gpu/Makefile.lammps. The latter has settings that enable LAMMPS lib/gpu/Makefile.lammps. The latter has settings that enable LAMMPS
@ -149,8 +163,9 @@ re-build LAMMPS. This is because the compilation of files in the GPU
package uses the library settings from the lib/gpu/Makefile.machine package uses the library settings from the lib/gpu/Makefile.machine
used to build the GPU library. used to build the GPU library.
:line :line
KIM package :h4,link(kim) KIM package :h4,link(kim)
To build with this package, the KIM library must be downloaded and To build with this package, the KIM library must be downloaded and
@ -177,7 +192,7 @@ package?" page.
[CMake build]: [CMake build]:
-D DOWNLOAD_KIM=value # download OpenKIM API v1 for build, value = no (default) or yes -D DOWNLOAD_KIM=value # download OpenKIM API v1 for build, value = no (default) or yes
-D KIM_LIBRARY=path # KIM library file (only needed if a custom location) -D KIM_LIBRARY=path # KIM library file (only needed if a custom location)
-D KIM_INCLUDE_DIR=path # KIM include directory (only needed if a custom location) :pre -D KIM_INCLUDE_DIR=path # KIM include directory (only needed if a custom location) :pre
If DOWNLOAD_KIM is set, the KIM library will be downloaded and built If DOWNLOAD_KIM is set, the KIM library will be downloaded and built
@ -254,7 +269,7 @@ For NVIDIA GPUs using CUDA, set these 4 variables:
-D KOKKOS_ARCH="archCPU;archGPU" # archCPU = CPU from list above that is hosting the GPU -D KOKKOS_ARCH="archCPU;archGPU" # archCPU = CPU from list above that is hosting the GPU
# archGPU = GPU from list above # archGPU = GPU from list above
-D KOKKOS_ENABLE_CUDA=yes -D KOKKOS_ENABLE_CUDA=yes
-D KOKKOS_ENABLE_OPENMP=yes -D KOKKOS_ENABLE_OPENMP=yes
-D CMAKE_CXX_COMPILER=wrapper # wrapper = full path to Cuda nvcc wrapper :pre -D CMAKE_CXX_COMPILER=wrapper # wrapper = full path to Cuda nvcc wrapper :pre
The wrapper value is the Cuda nvcc compiler wrapper provided in the The wrapper value is the Cuda nvcc compiler wrapper provided in the
@ -296,7 +311,7 @@ export OMPI_CXX = $(KOKKOS_ABSOLUTE_PATH)/config/nvcc_wrapper
CC = mpicxx :pre CC = mpicxx :pre
:line :line
LATTE package :h4,link(latte) LATTE package :h4,link(latte)
To build with this package, you must download and build the LATTE To build with this package, you must download and build the LATTE
@ -324,7 +339,7 @@ args:
make lib-latte # print help message make lib-latte # print help message
make lib-latte args="-b" # download and build in lib/latte/LATTE-master make lib-latte args="-b" # download and build in lib/latte/LATTE-master
make lib-latte args="-p $HOME/latte" # use existing LATTE installation in $HOME/latte make lib-latte args="-p $HOME/latte" # use existing LATTE installation in $HOME/latte
make lib-latte args="-b -m gfortran" # download and build in lib/latte and make lib-latte args="-b -m gfortran" # download and build in lib/latte and
# copy Makefile.lammps.gfortran to Makefile.lammps # copy Makefile.lammps.gfortran to Makefile.lammps
:pre :pre
@ -335,7 +350,7 @@ also check that the Makefile.lammps file you create is appropriate for
the compiler you use on your system to build LATTE. the compiler you use on your system to build LATTE.
:line :line
MEAM package :h4,link(meam) MEAM package :h4,link(meam)
NOTE: the use of the MEAM package is discouraged, as it has been NOTE: the use of the MEAM package is discouraged, as it has been
@ -378,7 +393,7 @@ EXTRAMAKE variable to specify a corresponding Makefile.lammps.machine
file. file.
:line :line
MESSAGE package :h4,link(message) MESSAGE package :h4,link(message)
This package can optionally include support for messaging via sockets, This package can optionally include support for messaging via sockets,
@ -407,7 +422,7 @@ existing Makefile.lammps.* and has settings to link with the ZeroMQ
library if requested in the build. library if requested in the build.
:line :line
MSCG package :h4,link(mscg) MSCG package :h4,link(mscg)
To build with this package, you must download and build the MS-CG To build with this package, you must download and build the MS-CG
@ -419,7 +434,7 @@ lib/mscg/README and MSCG/Install files for more details.
[CMake build]: [CMake build]:
-D DOWNLOAD_MSCG=value # download MSCG for build, value = no (default) or yes -D DOWNLOAD_MSCG=value # download MSCG for build, value = no (default) or yes
-D MSCG_LIBRARY=path # MSCG library file (only needed if a custom location) -D MSCG_LIBRARY=path # MSCG library file (only needed if a custom location)
-D MSCG_INCLUDE_DIR=path # MSCG include directory (only needed if a custom location) :pre -D MSCG_INCLUDE_DIR=path # MSCG include directory (only needed if a custom location) :pre
If DOWNLOAD_MSCG is set, the MSCG library will be downloaded and built If DOWNLOAD_MSCG is set, the MSCG library will be downloaded and built
@ -464,7 +479,7 @@ line of your Makefile.machine. See src/MAKE/OPTIONS/Makefile.opt for
an example. an example.
:line :line
POEMS package :h4,link(poems) POEMS package :h4,link(poems)
[CMake build]: [CMake build]:
@ -493,7 +508,7 @@ for your system, which should define an EXTRAMAKE variable to specify
a corresponding Makefile.lammps.machine file. a corresponding Makefile.lammps.machine file.
:line :line
PYTHON package :h4,link(python) PYTHON package :h4,link(python)
Building with the PYTHON package requires you have a Python shared Building with the PYTHON package requires you have a Python shared
@ -520,7 +535,7 @@ Makefile.lammps.* file (and copy it to Makefile.lammps) if the LAMMPS
build fails. build fails.
:line :line
REAX package :h4,link(reax) REAX package :h4,link(reax)
NOTE: the use of the REAX package and its "pair_style NOTE: the use of the REAX package and its "pair_style
@ -570,7 +585,7 @@ library"_voro-home.
[CMake build]: [CMake build]:
-D DOWNLOAD_VORO=value # download Voro++ for build, value = no (default) or yes -D DOWNLOAD_VORO=value # download Voro++ for build, value = no (default) or yes
-D VORO_LIBRARY=path # Voro++ library file (only needed if at custom location) -D VORO_LIBRARY=path # Voro++ library file (only needed if at custom location)
-D VORO_INCLUDE_DIR=path # Voro++ include directory (only needed if at custom location) :pre -D VORO_INCLUDE_DIR=path # Voro++ include directory (only needed if at custom location) :pre
If DOWNLOAD_VORO is set, the Voro++ library will be downloaded and If DOWNLOAD_VORO is set, the Voro++ library will be downloaded and
@ -712,6 +727,114 @@ a corresponding Makefile.lammps.machine file.
:line :line
USER-PLUMED package :h4,link(user-plumed)
Before building LAMMPS with this package, you must first build PLUMED.
PLUMED can be built as part of the LAMMPS build or installed separately
from LAMMPS using the generic "plumed installation instructions"_plumedinstall.
:link(plumedinstall,http://plumed.github.io/doc-master/user-doc/html/_installation.html)
PLUMED can be linked into MD codes in three different modes: static,
shared, and runtime. With the "static" mode, all the code that PLUMED
requires is linked statically into LAMMPS. LAMMPS is then fully
independent from the PLUMED installation, but you have to rebuild/relink
it in order to update the PLUMED code inside it. With the "shared"
linkage mode, LAMMPS is linked to a shared library that contains the
PLUMED code. This library should preferably be installed in a globally
accessible location. When PLUMED is linked in this way the same library
can be used by multiple MD packages. Furthermore, the PLUMED library
LAMMPS uses can be updated without the need for a recompile of LAMMPS
for as long as the shared PLUMED library is ABI-compatible.
The third linkage mode is "runtime" which allows the user to specify
which PLUMED kernel should be used at runtime by using the PLUMED_KERNEL
environment variable. This variable should point to the location of the
libplumedKernel.so dynamical shared object, which is then loaded at
runtime. This mode of linking is particularly convenient for doing
PLUMED development and comparing multiple PLUMED versions as these sorts
of comparisons can be done without recompiling the hosting MD code. All
three linkage modes are supported by LAMMPS on selected operating
systems (e.g. Linux) and using either CMake or traditional make
build. The "static" mode should be the most portable, while the
"runtime" mode support in LAMMPS makes the most assumptions about
operating system and compiler environment. If one mode does not work,
try a different one, switch to a different build system, consider a
global PLUMED installation or consider downloading PLUMED during the
LAMMPS build.
[CMake build]:
When the "-D PKG_USER-PLUMED" flag is included in the cmake command you
must ensure that GSL is installed in locations that are specified in
your environment. There are then two additional commands that control
the manner in which PLUMED is obtained and linked into LAMMPS.
-D DOWNLOAD_PLUMED=value # download PLUMED for build, value = no (default) or yes
-D PLUMED_MODE=value # Linkage mode for PLUMED, value = static (default), shared, or runtime :pre
If DOWNLOAD_PLUMED is set to "yes", the PLUMED library will be
downloaded (the version of PLUMED that will be downloaded is hard-coded
to a vetted version of PLUMED, usually a recent stable release version)
and built inside the CMake build directory. If DOWNLOAD_PLUMED is set
to "no" (the default), CMake will try to detect and link to an installed
version of PLUMED. For this to work, the PLUMED library has to be
installed into a location where the pkg-config tool can find it or the
PKG_CONFIG_PATH environment variable has to be set up accordingly.
PLUMED should be installed in such a location if you compile it using
the default make; make install commands.
The PLUMED_MODE setting determines the linkage mode for the PLUMED
library. The allowed values for this flag are "static" (default),
"shared", or "runtime". For a discussion of PLUMED linkage modes,
please see above. When DOWNLOAD_PLUMED is enabled the static linkage
mode is recommended.
[Traditional make]:
PLUMED needs to be installed before the USER-PLUMED package is installed
so that LAMMPS can find the right settings when compiling and linking
the LAMMPS executable. You can either download and build PLUMED inside
the LAMMPS plumed library folder or use a previously installed PLUMED
library and point LAMMPS to its location. You also have to choose the
linkage mode: "static" (default), "shared" or "runtime". For a
discussion of PLUMED linkage modes, please see above.
Download/compilation/configuration of the plumed library can be done
from the src folder through the following make args:
make lib-plumed # print help message
make lib-plumed args="-b" # download and build PLUMED in lib/plumed/plumed2
make lib-plumed args="-p $HOME/.local" # use existing PLUMED installation in $HOME/.local
make lib-plumed args="-p /usr/local -m shared" # use existing PLUMED installation in
# /usr/local and use shared linkage mode
:pre
Note that 2 symbolic (soft) links, "includelink" and "liblink" are
created in lib/plumed that point to the location of the PLUMED build to
use. A new file lib/plumed/Makefile.lammps is also created with settings
suitable for LAMMPS to compile and link PLUMED using the desired linkage
mode. After this step is completed, you can install the USER-PLUMED
package and compile LAMMPS in the usual manner:
make yes-user-plumed
make machine :pre
Once this compilation completes you should be able to run LAMMPS in the
usual way. For shared linkage mode, libplumed.so must be found by the
LAMMPS executable, which on many operating systems means, you have to
set the LD_LIBRARY_PATH environment variable accordingly.
Support for the different linkage modes in LAMMPS varies for different
operating systems, using the static linkage is expected to be the most
portable, and thus set to be the default.
If you want to change the linkage mode, you have to re-run "make
lib-plumed" with the desired settings [and] do a re-install if the
USER-PLUMED package with "make yes-user-plumed" to update the required
makefile settings with the changes in the lib/plumed folder.
:line
USER-H5MD package :h4,link(user-h5md) USER-H5MD package :h4,link(user-h5md)
To build with this package you must have the HDF5 software package To build with this package you must have the HDF5 software package
@ -869,7 +992,7 @@ Quantum ESPRESSO known to work with this QM/MM interface was version
[CMake build]: [CMake build]:
The CMake build system currently does not support building the full The CMake build system currently does not support building the full
QM/MM-capable hybrid executable of LAMMPS and QE called pwqmmm.x. QM/MM-capable hybrid executable of LAMMPS and QE called pwqmmm.x.
You must use the traditional make build for this package. You must use the traditional make build for this package.
[Traditional make]: [Traditional make]:
@ -939,7 +1062,7 @@ Coulomb solver library"_scafacos-home
[CMake build]: [CMake build]:
-D DOWNLOAD_SCAFACOS=value # download ScaFaCoS for build, value = no (default) or yes -D DOWNLOAD_SCAFACOS=value # download ScaFaCoS for build, value = no (default) or yes
-D SCAFACOS_LIBRARY=path # ScaFaCos library file (only needed if at custom location) -D SCAFACOS_LIBRARY=path # ScaFaCos library file (only needed if at custom location)
-D SCAFACOS_INCLUDE_DIR=path # ScaFaCoS include directory (only needed if at custom location) :pre -D SCAFACOS_INCLUDE_DIR=path # ScaFaCoS include directory (only needed if at custom location) :pre
If DOWNLOAD_SCAFACOS is set, the ScaFaCoS library will be downloaded If DOWNLOAD_SCAFACOS is set, the ScaFaCoS library will be downloaded

View File

@ -56,6 +56,7 @@ packages:
"USER-INTEL"_Build_extras.html#user-intel, "USER-INTEL"_Build_extras.html#user-intel,
"USER-MOLFILE"_Build_extras.html#user-molfile, "USER-MOLFILE"_Build_extras.html#user-molfile,
"USER-NETCDF"_Build_extras.html#user-netcdf, "USER-NETCDF"_Build_extras.html#user-netcdf,
"USER-PLUMED"_Build_extras.html#user-plumed,
"USER-OMP"_Build_extras.html#user-omp, "USER-OMP"_Build_extras.html#user-omp,
"USER-QMMM"_Build_extras.html#user-qmmm, "USER-QMMM"_Build_extras.html#user-qmmm,
"USER-QUIP"_Build_extras.html#user-quip, "USER-QUIP"_Build_extras.html#user-quip,

View File

@ -22,7 +22,7 @@ explain how to do this for building both with CMake and make.
"Error handling exceptions"_#exceptions when using LAMMPS as a library :all(b) "Error handling exceptions"_#exceptions when using LAMMPS as a library :all(b)
:line :line
FFT library :h4,link(fft) FFT library :h4,link(fft)
When the KSPACE package is included in a LAMMPS build, the When the KSPACE package is included in a LAMMPS build, the
@ -73,7 +73,7 @@ FFT_LIB with the appropriate FFT libraries to include in the link.
The "KISS FFT library"_http://kissfft.sf.net is included in the LAMMPS The "KISS FFT library"_http://kissfft.sf.net is included in the LAMMPS
distribution. It is portable across all platforms. Depending on the distribution. It is portable across all platforms. Depending on the
size of the FFTs and the number of processors used, the other size of the FFTs and the number of processors used, the other
libraries listed here can be faster. libraries listed here can be faster.
However, note that long-range Coulombics are only a portion of the However, note that long-range Coulombics are only a portion of the
per-timestep CPU cost, FFTs are only a portion of long-range per-timestep CPU cost, FFTs are only a portion of long-range
@ -92,7 +92,7 @@ Building FFTW for your box should be as simple as ./configure; make;
make install. The install command typically requires root privileges make install. The install command typically requires root privileges
(e.g. invoke it via sudo), unless you specify a local directory with (e.g. invoke it via sudo), unless you specify a local directory with
the "--prefix" option of configure. Type "./configure --help" to see the "--prefix" option of configure. Type "./configure --help" to see
various options. various options.
The Intel MKL math library is part of the Intel compiler suite. It The Intel MKL math library is part of the Intel compiler suite. It
can be used with the Intel or GNU compiler (see FFT_LIB setting above). can be used with the Intel or GNU compiler (see FFT_LIB setting above).
@ -139,16 +139,16 @@ adequate.
[Makefile.machine setting]: [Makefile.machine setting]:
LMP_INC = -DLAMMPS_SMALLBIG # or -DLAMMPS_BIGBIG or -DLAMMPS_SMALLSMALL :pre LMP_INC = -DLAMMPS_SMALLBIG # or -DLAMMPS_BIGBIG or -DLAMMPS_SMALLSMALL :pre
# default is LAMMMPS_SMALLBIG if not specified # default is LAMMPS_SMALLBIG if not specified
[CMake and make info]: [CMake and make info]:
The default "smallbig" setting allows for simulations with: The default "smallbig" setting allows for simulations with:
total atom count = 2^63 atoms (about 9e18) total atom count = 2^63 atoms (about 9e18)
total timesteps = 2^63 (about 9e18) total timesteps = 2^63 (about 9e18)
atom IDs = 2^31 (about 2 billion) atom IDs = 2^31 (about 2 billion)
image flags = roll over at 512 :ul image flags = roll over at 512 :ul
The "bigbig" setting increases the latter two limits. It allows for: The "bigbig" setting increases the latter two limits. It allows for:
total atom count = 2^63 atoms (about 9e18) total atom count = 2^63 atoms (about 9e18)
@ -209,12 +209,12 @@ Usually these settings are all that is needed. If CMake cannot find
the graphics header, library, executable files, you can set these the graphics header, library, executable files, you can set these
variables: variables:
-D JPEG_INCLUDE_DIR=path # path to jpeglib.h header file -D JPEG_INCLUDE_DIR=path # path to jpeglib.h header file
-D JPEG_LIBRARIES=path # path to libjpeg.a (.so) file -D JPEG_LIBRARIES=path # path to libjpeg.a (.so) file
-D PNG_INCLUDE_DIR=path # path to png.h header file -D PNG_INCLUDE_DIR=path # path to png.h header file
-D PNG_LIBRARIES=path # path to libpng.a (.so) file -D PNG_LIBRARIES=path # path to libpng.a (.so) file
-D ZLIB_INCLUDE_DIR=path # path to zlib.h header file -D ZLIB_INCLUDE_DIR=path # path to zlib.h header file
-D ZLIB_LIBRARIES=path # path to libz.a (.so) file -D ZLIB_LIBRARIES=path # path to libz.a (.so) file
-D FFMPEG_EXECUTABLE=path # path to ffmpeg executable :pre -D FFMPEG_EXECUTABLE=path # path to ffmpeg executable :pre
[Makefile.machine settings]: [Makefile.machine settings]:

View File

@ -53,20 +53,20 @@ are included, but may not always up-to-date for recently added functionality
and the corresponding new code. A machine makefile for using cygwin for and the corresponding new code. A machine makefile for using cygwin for
the old build system is provided. The CMake build system is untested the old build system is provided. The CMake build system is untested
for this; you will have to request that makefiles are generated and for this; you will have to request that makefiles are generated and
manually set the compiler. manually set the compiler.
When compiling for Windows [not] set the -DLAMMPS_MEMALIGN define When compiling for Windows [not] set the -DLAMMPS_MEMALIGN define
in the LMP_INC makefile variable and add -lwsock32 -lpsapi to the linker in the LMP_INC makefile variable and add -lwsock32 -lpsapi to the linker
flags in LIB makefile variable. Try adding -static-libgcc or -static or flags in LIB makefile variable. Try adding -static-libgcc or -static or
both to the linker flags when your resulting LAMMPS Windows executable both to the linker flags when your resulting LAMMPS Windows executable
complains about missing .dll files. The CMake configuration should set complains about missing .dll files. The CMake configuration should set
this up automatically, but is untested. this up automatically, but is untested.
In case of problems, you are recommended to contact somebody with In case of problems, you are recommended to contact somebody with
experience in using cygwin. If you do come across portability problems experience in using cygwin. If you do come across portability problems
requiring changes to the LAMMPS source code, or figure out corrections requiring changes to the LAMMPS source code, or figure out corrections
yourself, please report them on the lammps-users mailing list, or file yourself, please report them on the lammps-users mailing list, or file
them as an issue or pull request on the LAMMPS github project. them as an issue or pull request on the LAMMPS GitHub project.
Using a cross-compiler :h4,link(cross) Using a cross-compiler :h4,link(cross)

View File

@ -42,10 +42,10 @@ END_RST -->
"Input script structure"_Commands_structure.html "Input script structure"_Commands_structure.html
"Commands by category"_Commands_category.html :all(b) "Commands by category"_Commands_category.html :all(b)
"All commands"_Commands_all.html "General commands"_Commands_all.html
"Fix commands"_Commands_fix.html "Fix commands"_Commands_fix.html
"Compute commands"_Commands_compute.html "Compute commands"_Commands_compute.html
"Pair commands"_Commands_pair.html "Pair commands"_Commands_pair.html
"Bond, angle, dihedral, improper commands"_Commands_bond.html "Bond, angle, dihedral, improper commands"_Commands_bond.html
"KSpace solvers"_Commands_kspace.html :all(b) "KSpace solvers"_Commands_kspace.html :all(b)

View File

@ -7,7 +7,7 @@ Documentation"_ld - "LAMMPS Commands"_lc :c
:line :line
"All commands"_Commands_all.html, "General commands"_Commands_all.html,
"Fix styles"_Commands_fix.html, "Fix styles"_Commands_fix.html,
"Compute styles"_Commands_compute.html, "Compute styles"_Commands_compute.html,
"Pair styles"_Commands_pair.html, "Pair styles"_Commands_pair.html,
@ -17,9 +17,9 @@ Documentation"_ld - "LAMMPS Commands"_lc :c
"Improper styles"_Commands_bond.html#improper, "Improper styles"_Commands_bond.html#improper,
"KSpace styles"_Commands_kspace.html :tb(c=3,ea=c) "KSpace styles"_Commands_kspace.html :tb(c=3,ea=c)
All commands :h3 General commands :h3
An alphabetic list of all LAMMPS commands. An alphabetic list of all general LAMMPS commands.
"angle_coeff"_angle_coeff.html, "angle_coeff"_angle_coeff.html,
"angle_style"_angle_style.html, "angle_style"_angle_style.html,
@ -59,6 +59,7 @@ An alphabetic list of all LAMMPS commands.
"fix_modify"_fix_modify.html, "fix_modify"_fix_modify.html,
"group"_group.html, "group"_group.html,
"group2ndx"_group2ndx.html, "group2ndx"_group2ndx.html,
"hyper"_hyper.html,
"if"_if.html, "if"_if.html,
"info"_info.html, "info"_info.html,
"improper_coeff"_improper_coeff.html, "improper_coeff"_improper_coeff.html,

View File

@ -5,7 +5,7 @@ Documentation"_ld - "LAMMPS Commands"_lc :c
:link(ld,Manual.html) :link(ld,Manual.html)
:link(lc,Commands_all.html) :link(lc,Commands_all.html)
"All commands"_Commands_all.html, "General commands"_Commands_all.html,
"Fix styles"_Commands_fix.html, "Fix styles"_Commands_fix.html,
"Compute styles"_Commands_compute.html, "Compute styles"_Commands_compute.html,
"Pair styles"_Commands_pair.html, "Pair styles"_Commands_pair.html,

View File

@ -10,10 +10,9 @@ Documentation"_ld - "LAMMPS Commands"_lc :c
Commands by category :h3 Commands by category :h3
This page lists most of the LAMMPS commands, grouped by category. The This page lists most of the LAMMPS commands, grouped by category. The
"Commands all"_Commands_all.html doc page lists all commands "General commands"_Commands_all.html doc page lists all general commands
alphabetically. It also includes long lists of style options for alphabetically. Style options for entries like fix, compute, pair etc.
entries that appear in the following categories as a single command have their own pages where they are listed alphabetically.
(fix, compute, pair, etc).
Initialization: Initialization:

View File

@ -7,7 +7,7 @@ Documentation"_ld - "LAMMPS Commands"_lc :c
:line :line
"All commands"_Commands_all.html, "General commands"_Commands_all.html,
"Fix styles"_Commands_fix.html, "Fix styles"_Commands_fix.html,
"Compute styles"_Commands_compute.html, "Compute styles"_Commands_compute.html,
"Pair styles"_Commands_pair.html, "Pair styles"_Commands_pair.html,

View File

@ -7,7 +7,7 @@ Documentation"_ld - "LAMMPS Commands"_lc :c
:line :line
"All commands"_Commands_all.html, "General commands"_Commands_all.html,
"Fix styles"_Commands_fix.html, "Fix styles"_Commands_fix.html,
"Compute styles"_Commands_compute.html, "Compute styles"_Commands_compute.html,
"Pair styles"_Commands_pair.html, "Pair styles"_Commands_pair.html,
@ -78,6 +78,8 @@ OPT.
"grem"_fix_grem.html, "grem"_fix_grem.html,
"halt"_fix_halt.html, "halt"_fix_halt.html,
"heat"_fix_heat.html, "heat"_fix_heat.html,
"hyper/global"_fix_hyper_global.html,
"hyper/local"_fix_hyper_local.html,
"imd"_fix_imd.html, "imd"_fix_imd.html,
"indent"_fix_indent.html, "indent"_fix_indent.html,
"ipi"_fix_ipi.html, "ipi"_fix_ipi.html,
@ -94,6 +96,7 @@ OPT.
"lineforce"_fix_lineforce.html, "lineforce"_fix_lineforce.html,
"manifoldforce"_fix_manifoldforce.html, "manifoldforce"_fix_manifoldforce.html,
"meso"_fix_meso.html, "meso"_fix_meso.html,
"meso/move"_fix_meso_move.html,
"meso/stationary"_fix_meso_stationary.html, "meso/stationary"_fix_meso_stationary.html,
"momentum (k)"_fix_momentum.html, "momentum (k)"_fix_momentum.html,
"move"_fix_move.html, "move"_fix_move.html,
@ -107,7 +110,7 @@ OPT.
"nph/asphere (o)"_fix_nph_asphere.html, "nph/asphere (o)"_fix_nph_asphere.html,
"nph/body"_fix_nph_body.html, "nph/body"_fix_nph_body.html,
"nph/eff"_fix_nh_eff.html, "nph/eff"_fix_nh_eff.html,
"nph/sphere (ko)"_fix_nph_sphere.html, "nph/sphere (o)"_fix_nph_sphere.html,
"nphug (o)"_fix_nphug.html, "nphug (o)"_fix_nphug.html,
"npt (iko)"_fix_nh.html, "npt (iko)"_fix_nh.html,
"npt/asphere (o)"_fix_npt_asphere.html, "npt/asphere (o)"_fix_npt_asphere.html,
@ -127,7 +130,7 @@ OPT.
"nve/line"_fix_nve_line.html, "nve/line"_fix_nve_line.html,
"nve/manifold/rattle"_fix_nve_manifold_rattle.html, "nve/manifold/rattle"_fix_nve_manifold_rattle.html,
"nve/noforce"_fix_nve_noforce.html, "nve/noforce"_fix_nve_noforce.html,
"nve/sphere (o)"_fix_nve_sphere.html, "nve/sphere (ko)"_fix_nve_sphere.html,
"nve/spin"_fix_nve_spin.html, "nve/spin"_fix_nve_spin.html,
"nve/tri"_fix_nve_tri.html, "nve/tri"_fix_nve_tri.html,
"nvk"_fix_nvk.html, "nvk"_fix_nvk.html,
@ -146,6 +149,7 @@ OPT.
"phonon"_fix_phonon.html, "phonon"_fix_phonon.html,
"pimd"_fix_pimd.html, "pimd"_fix_pimd.html,
"planeforce"_fix_planeforce.html, "planeforce"_fix_planeforce.html,
"plumed"_fix_plumed.html,
"poems"_fix_poems.html, "poems"_fix_poems.html,
"pour"_fix_pour.html, "pour"_fix_pour.html,
"precession/spin"_fix_precession_spin.html, "precession/spin"_fix_precession_spin.html,
@ -172,6 +176,7 @@ OPT.
"restrain"_fix_restrain.html, "restrain"_fix_restrain.html,
"rhok"_fix_rhok.html, "rhok"_fix_rhok.html,
"rigid (o)"_fix_rigid.html, "rigid (o)"_fix_rigid.html,
"rigid/meso"_fix_rigid_meso.html,
"rigid/nph (o)"_fix_rigid.html, "rigid/nph (o)"_fix_rigid.html,
"rigid/nph/small"_fix_rigid.html, "rigid/nph/small"_fix_rigid.html,
"rigid/npt (o)"_fix_rigid.html, "rigid/npt (o)"_fix_rigid.html,
@ -230,4 +235,4 @@ OPT.
"wall/reflect (k)"_fix_wall_reflect.html, "wall/reflect (k)"_fix_wall_reflect.html,
"wall/region"_fix_wall_region.html, "wall/region"_fix_wall_region.html,
"wall/region/ees"_fix_wall_ees.html, "wall/region/ees"_fix_wall_ees.html,
"wall/srd"_fix_wall_srd.html :tb(c=8,ea=c) "wall/srd"_fix_wall_srd.html :tb(c=6,ea=c)

View File

@ -7,7 +7,7 @@ Documentation"_ld - "LAMMPS Commands"_lc :c
:line :line
"All commands"_Commands_all.html, "General commands"_Commands_all.html,
"Fix styles"_Commands_fix.html, "Fix styles"_Commands_fix.html,
"Compute styles"_Commands_compute.html, "Compute styles"_Commands_compute.html,
"Pair styles"_Commands_pair.html, "Pair styles"_Commands_pair.html,

View File

@ -7,7 +7,7 @@ Documentation"_ld - "LAMMPS Commands"_lc :c
:line :line
"All commands"_Commands_all.html, "General commands"_Commands_all.html,
"Fix styles"_Commands_fix.html, "Fix styles"_Commands_fix.html,
"Compute styles"_Commands_compute.html, "Compute styles"_Commands_compute.html,
"Pair styles"_Commands_pair.html, "Pair styles"_Commands_pair.html,
@ -198,6 +198,7 @@ OPT.
"reax/c (ko)"_pair_reaxc.html, "reax/c (ko)"_pair_reaxc.html,
"rebo (io)"_pair_airebo.html, "rebo (io)"_pair_airebo.html,
"resquared (go)"_pair_resquared.html, "resquared (go)"_pair_resquared.html,
"sdpd/taitwater/isothermal"_pair_sdpd_taitwater_isothermal.html,
"smd/hertz"_pair_smd_hertz.html, "smd/hertz"_pair_smd_hertz.html,
"smd/tlsph"_pair_smd_tlsph.html, "smd/tlsph"_pair_smd_tlsph.html,
"smd/tri_surface"_pair_smd_triangulated_surface.html, "smd/tri_surface"_pair_smd_triangulated_surface.html,

View File

@ -91,7 +91,7 @@ See the "variable"_variable.html command for more details of how
strings are assigned to variables and evaluated, and how they can be strings are assigned to variables and evaluated, and how they can be
used in input script commands. used in input script commands.
(4) The line is broken into "words" separated by whitespace (tabs, (4) The line is broken into "words" separated by white-space (tabs,
spaces). Note that words can thus contain letters, digits, spaces). Note that words can thus contain letters, digits,
underscores, or punctuation characters. underscores, or punctuation characters.

3
doc/src/Developer/.gitignore vendored Normal file
View File

@ -0,0 +1,3 @@
/developer.aux
/developer.log
/developer.toc

View File

@ -32,7 +32,7 @@ END_RST -->
"Common problems"_Errors_common.html "Common problems"_Errors_common.html
"Reporting bugs"_Errors_bugs.html "Reporting bugs"_Errors_bugs.html
"Error messages"_Errors_messages.html "Error messages"_Errors_messages.html
"Warning messages"_Errors_warnings.html :all(b) "Warning messages"_Errors_warnings.html :all(b)
<!-- END_HTML_ONLY --> <!-- END_HTML_ONLY -->

View File

@ -279,12 +279,6 @@ multibody joint). The bodies you have defined exceed this limit. :dd
This is an internal LAMMPS error. Please report it to the This is an internal LAMMPS error. Please report it to the
developers. :dd developers. :dd
{Atom sorting has bin size = 0.0} :dt
The neighbor cutoff is being used as the bin size, but it is zero.
Thus you must explicitly list a bin size in the atom_modify sort
command or turn off sorting. :dd
{Atom style hybrid cannot have hybrid as an argument} :dt {Atom style hybrid cannot have hybrid as an argument} :dt
Self-explanatory. :dd Self-explanatory. :dd
@ -421,9 +415,9 @@ This is an internal error. It should normally not occur. :dd
This is an internal error. It should normally not occur. :dd This is an internal error. It should normally not occur. :dd
{Bad real space Coulomb cutoff in fix tune/kspace} :dt {Bad real space Coulombic cutoff in fix tune/kspace} :dt
Fix tune/kspace tried to find the optimal real space Coulomb cutoff using Fix tune/kspace tried to find the optimal real space Coulombic cutoff using
the Newton-Rhaphson method, but found a non-positive or NaN cutoff :dd the Newton-Rhaphson method, but found a non-positive or NaN cutoff :dd
{Balance command before simulation box is defined} :dt {Balance command before simulation box is defined} :dt
@ -460,7 +454,7 @@ compute. :dd
{Big particle in fix srd cannot be point particle} :dt {Big particle in fix srd cannot be point particle} :dt
Big particles must be extended spheriods or ellipsoids. :dd Big particles must be extended spheroids or ellipsoids. :dd
{Bigint setting in lmptype.h is invalid} :dt {Bigint setting in lmptype.h is invalid} :dt
@ -780,7 +774,7 @@ Cannot use tilt factors unless the simulation box is non-orthogonal. :dd
Self-explanatory. :dd Self-explanatory. :dd
{Cannot change box z boundary to nonperiodic for a 2d simulation} :dt {Cannot change box z boundary to non-periodic for a 2d simulation} :dt
Self-explanatory. :dd Self-explanatory. :dd
@ -1288,7 +1282,7 @@ are defined. :dd
You cannot reset the timestep when a fix that keeps track of elapsed You cannot reset the timestep when a fix that keeps track of elapsed
time is in place. :dd time is in place. :dd
{Cannot run 2d simulation with nonperiodic Z dimension} :dt {Cannot run 2d simulation with non-periodic Z dimension} :dt
Use the boundary command to make the z dimension periodic in order to Use the boundary command to make the z dimension periodic in order to
run a 2d simulation. :dd run a 2d simulation. :dd
@ -2116,29 +2110,29 @@ Self-explanatory. :dd
Fix setforce cannot be used in this manner. Use fix addforce Fix setforce cannot be used in this manner. Use fix addforce
instead. :dd instead. :dd
{Cannot use nonperiodic boundares with fix ttm} :dt {Cannot use non-periodic boundares with fix ttm} :dt
This fix requires a fully periodic simulation box. :dd This fix requires a fully periodic simulation box. :dd
{Cannot use nonperiodic boundaries with Ewald} :dt {Cannot use non-periodic boundaries with Ewald} :dt
For kspace style ewald, all 3 dimensions must have periodic boundaries For kspace style ewald, all 3 dimensions must have periodic boundaries
unless you use the kspace_modify command to define a 2d slab with a unless you use the kspace_modify command to define a 2d slab with a
non-periodic z dimension. :dd non-periodic z dimension. :dd
{Cannot use nonperiodic boundaries with EwaldDisp} :dt {Cannot use non-periodic boundaries with EwaldDisp} :dt
For kspace style ewald/disp, all 3 dimensions must have periodic For kspace style ewald/disp, all 3 dimensions must have periodic
boundaries unless you use the kspace_modify command to define a 2d boundaries unless you use the kspace_modify command to define a 2d
slab with a non-periodic z dimension. :dd slab with a non-periodic z dimension. :dd
{Cannot use nonperiodic boundaries with PPPM} :dt {Cannot use non-periodic boundaries with PPPM} :dt
For kspace style pppm, all 3 dimensions must have periodic boundaries For kspace style pppm, all 3 dimensions must have periodic boundaries
unless you use the kspace_modify command to define a 2d slab with a unless you use the kspace_modify command to define a 2d slab with a
non-periodic z dimension. :dd non-periodic z dimension. :dd
{Cannot use nonperiodic boundaries with PPPMDisp} :dt {Cannot use non-periodic boundaries with PPPMDisp} :dt
For kspace style pppm/disp, all 3 dimensions must have periodic For kspace style pppm/disp, all 3 dimensions must have periodic
boundaries unless you use the kspace_modify command to define a 2d boundaries unless you use the kspace_modify command to define a 2d
@ -3351,21 +3345,21 @@ probably due to errors in the Python code. :dd
The default minimum order is 2. This can be reset by the The default minimum order is 2. This can be reset by the
kspace_modify minorder command. :dd kspace_modify minorder command. :dd
{Coulomb cut not supported in pair_style buck/long/coul/coul} :dt {Coulombic cutoff not supported in pair_style buck/long/coul/coul} :dt
Must use long-range Coulombic interactions. :dd Must use long-range Coulombic interactions. :dd
{Coulomb cut not supported in pair_style lj/long/coul/long} :dt {Coulombic cutoff not supported in pair_style lj/long/coul/long} :dt
Must use long-range Coulombic interactions. :dd Must use long-range Coulombic interactions. :dd
{Coulomb cut not supported in pair_style lj/long/tip4p/long} :dt {Coulombic cutoff not supported in pair_style lj/long/tip4p/long} :dt
Must use long-range Coulombic interactions. :dd Must use long-range Coulombic interactions. :dd
{Coulomb cutoffs of pair hybrid sub-styles do not match} :dt {Coulombic cutoffs of pair hybrid sub-styles do not match} :dt
If using a Kspace solver, all Coulomb cutoffs of long pair styles must If using a Kspace solver, all Coulombic cutoffs of long pair styles must
be the same. :dd be the same. :dd
{Coulombic cut not supported in pair_style lj/long/dipole/long} :dt {Coulombic cut not supported in pair_style lj/long/dipole/long} :dt
@ -5938,9 +5932,9 @@ map command will force an atom map to be created. :dd
Self-explanatory. :dd Self-explanatory. :dd
{Input line quote not followed by whitespace} :dt {Input line quote not followed by white-space} :dt
An end quote must be followed by whitespace. :dd An end quote must be followed by white-space. :dd
{Insertion region extends outside simulation box} :dt {Insertion region extends outside simulation box} :dt
@ -7014,7 +7008,7 @@ The kspace accuracy designated in the input must be greater than zero. :dd
{KSpace accuracy too large to estimate G vector} :dt {KSpace accuracy too large to estimate G vector} :dt
Reduce the accuracy request or specify gwald explicitly Reduce the accuracy request or specify gewald explicitly
via the kspace_modify command. :dd via the kspace_modify command. :dd
{KSpace accuracy too low} :dt {KSpace accuracy too low} :dt
@ -8014,7 +8008,7 @@ Self-explanatory. :dd
{Package command after simulation box is defined} :dt {Package command after simulation box is defined} :dt
The package command cannot be used afer a read_data, read_restart, or The package command cannot be used after a read_data, read_restart, or
create_box command. :dd create_box command. :dd
{Package gpu command without GPU package installed} :dt {Package gpu command without GPU package installed} :dt
@ -9198,7 +9192,7 @@ creates one large file for all processors. :dd
{Restart file byte ordering is not recognized} :dt {Restart file byte ordering is not recognized} :dt
The file does not appear to be a LAMMPS restart file since it doesn't The file does not appear to be a LAMMPS restart file since it doesn't
contain a recognized byte-orderomg flag at the beginning. :dd contain a recognized byte-ordering flag at the beginning. :dd
{Restart file byte ordering is swapped} :dt {Restart file byte ordering is swapped} :dt
@ -9410,7 +9404,7 @@ You may also want to boost the page size. :dd
{Small to big integers are not sized correctly} :dt {Small to big integers are not sized correctly} :dt
This error occurs whenthe sizes of smallint, imageint, tagint, bigint, This error occurs when the sizes of smallint, imageint, tagint, bigint,
as defined in src/lmptype.h are not what is expected. Contact as defined in src/lmptype.h are not what is expected. Contact
the developers if this occurs. :dd the developers if this occurs. :dd

View File

@ -757,7 +757,7 @@ Self-explanatory. :dd
This may indicate the shell command did not operate as expected. :dd This may indicate the shell command did not operate as expected. :dd
{Should not allow rigid bodies to bounce off relecting walls} :dt {Should not allow rigid bodies to bounce off reflecting walls} :dt
LAMMPS allows this, but their dynamics are not computed correctly. :dd LAMMPS allows this, but their dynamics are not computed correctly. :dd
@ -850,10 +850,10 @@ Most FENE models need this setting for the special_bonds command. :dd
Most FENE models need this setting for the special_bonds command. :dd Most FENE models need this setting for the special_bonds command. :dd
{Using a manybody potential with bonds/angles/dihedrals and special_bond exclusions} :dt {Using a many-body potential with bonds/angles/dihedrals and special_bond exclusions} :dt
This is likely not what you want to do. The exclusion settings will This is likely not what you want to do. The exclusion settings will
eliminate neighbors in the neighbor list, which the manybody potential eliminate neighbors in the neighbor list, which the many-body potential
needs to calculated its terms correctly. :dd needs to calculated its terms correctly. :dd
{Using compute temp/deform with inconsistent fix deform remap option} :dt {Using compute temp/deform with inconsistent fix deform remap option} :dt

View File

@ -78,7 +78,7 @@ micelle: self-assembly of small lipid-like molecules into 2d bilayers
min: energy minimization of 2d LJ melt min: energy minimization of 2d LJ melt
mscg: parameterize a multi-scale coarse-graining (MSCG) model mscg: parameterize a multi-scale coarse-graining (MSCG) model
msst: MSST shock dynamics msst: MSST shock dynamics
nb3b: use of nonbonded 3-body harmonic pair style nb3b: use of non-bonded 3-body harmonic pair style
neb: nudged elastic band (NEB) calculation for barrier finding neb: nudged elastic band (NEB) calculation for barrier finding
nemd: non-equilibrium MD of 2d sheared system nemd: non-equilibrium MD of 2d sheared system
obstacle: flow around two voids in a 2d channel obstacle: flow around two voids in a 2d channel

View File

@ -45,7 +45,7 @@ General howto :h3
<!-- RST <!-- RST
.. toctree:: .. toctree::
:name: general :name: general_howto
:maxdepth: 1 :maxdepth: 1
Howto_restart Howto_restart

View File

@ -19,7 +19,7 @@ barostat attempts to equilibrate the system to the requested T and/or
P. P.
Barostatting in LAMMPS is performed by "fixes"_fix.html. Two Barostatting in LAMMPS is performed by "fixes"_fix.html. Two
barosttating methods are currently available: Nose-Hoover (npt and barostatting methods are currently available: Nose-Hoover (npt and
nph) and Berendsen: nph) and Berendsen:
"fix npt"_fix_nh.html "fix npt"_fix_nh.html

View File

@ -40,7 +40,7 @@ Install Windows Subsystem for Linux :h5
Next you must ensure that the Window Subsystem for Linux is installed. Again, Next you must ensure that the Window Subsystem for Linux is installed. Again,
search for "enable windows features" in the Settings dialog. This opens a search for "enable windows features" in the Settings dialog. This opens a
dialog with a list of features you can install. Add a checkmark to Windows dialog with a list of features you can install. Add a checkmark to Windows
Subsystem for Linux (Beta) and press OK. Subsystem for Linux (Beta) and press OK.
:image(JPG/bow_tutorial_04_small.png,JPG/bow_tutorial_04.png) :image(JPG/bow_tutorial_04_small.png,JPG/bow_tutorial_04.png)
:image(JPG/bow_tutorial_05.png,JPG/bow_tutorial_05.png) :image(JPG/bow_tutorial_05.png,JPG/bow_tutorial_05.png)
@ -54,12 +54,12 @@ enter. This will then download Ubuntu for Windows.
:image(JPG/bow_tutorial_06.png) :image(JPG/bow_tutorial_06.png)
:image(JPG/bow_tutorial_07.png) :image(JPG/bow_tutorial_07.png)
During installation, you will be asked for a new password. This will be used During installation, you will be asked for a new password. This will be used
for installing new software and running commands with sudo. for installing new software and running commands with sudo.
:image(JPG/bow_tutorial_08.png) :image(JPG/bow_tutorial_08.png)
Type exit to close the command-line window. Type exit to close the command-line window.
Go to the Start menu and type "bash" again. This time you will see a "Bash on Go to the Start menu and type "bash" again. This time you will see a "Bash on

View File

@ -132,7 +132,7 @@ x1 y1 z1
xN yN zN :pre xN yN zN :pre
where M = 6 + 3*N, and N is the number of sub-particles in the body where M = 6 + 3*N, and N is the number of sub-particles in the body
particle. particle.
The integer line has a single value N. The floating point line(s) The integer line has a single value N. The floating point line(s)
list 6 moments of inertia followed by the coordinates of the N list 6 moments of inertia followed by the coordinates of the N
@ -315,7 +315,7 @@ x1 y1 z1
... ...
xN yN zN xN yN zN
0 1 0 1
1 2 1 2
2 3 2 3
... ...
0 1 2 -1 0 1 2 -1

View File

@ -22,8 +22,8 @@ commands, to calculate various properties of a system:
"fix ave/chunk"_fix_ave_chunk.html "fix ave/chunk"_fix_ave_chunk.html
any of the "compute */chunk"_compute.html commands :ul any of the "compute */chunk"_compute.html commands :ul
Here, each of the 4 kinds of chunk-related commands is briefly Here a brief overview for each of the 4 kinds of chunk-related commands
overviewed. Then some examples are given of how to compute different is provided. Then some examples are given of how to compute different
properties with chunk commands. properties with chunk commands.
Compute chunk/atom command: :h4 Compute chunk/atom command: :h4

View File

@ -64,7 +64,7 @@ client or server.
"server mc"_server_mc.html = LAMMPS is a server for computing a Monte Carlo energy :ul "server mc"_server_mc.html = LAMMPS is a server for computing a Monte Carlo energy :ul
The server doc files give details of the message protocols The server doc files give details of the message protocols
for data that is exchanged bewteen the client and server. for data that is exchanged between the client and server.
These example directories illustrate how to use LAMMPS as either a These example directories illustrate how to use LAMMPS as either a
client or server code: client or server code:
@ -75,7 +75,7 @@ examples/COUPLE/lammps_mc
examples/COUPLE/lammps_vasp :ul examples/COUPLE/lammps_vasp :ul
The examples/message dir couples a client instance of LAMMPS to a The examples/message dir couples a client instance of LAMMPS to a
server instance of LAMMPS. server instance of LAMMPS.
The lammps_mc dir shows how to couple LAMMPS as a server to a simple The lammps_mc dir shows how to couple LAMMPS as a server to a simple
Monte Carlo client code as the driver. Monte Carlo client code as the driver.
@ -87,7 +87,7 @@ DFT forces, thru a Python wrapper script on VASP.
Here is how to launch a client and server code together for any of the Here is how to launch a client and server code together for any of the
4 modes of message exchange that the "message"_message.html command 4 modes of message exchange that the "message"_message.html command
and the CSlib support. Here LAMMPS is used as both the client and and the CSlib support. Here LAMMPS is used as both the client and
server code. Another code could be subsitituted for either. server code. Another code could be substituted for either.
The examples below show launching both codes from the same window (or The examples below show launching both codes from the same window (or
batch script), using the "&" character to launch the first code in the batch script), using the "&" character to launch the first code in the
@ -106,13 +106,13 @@ together to exchange MPI messages between them.
For message exchange in {file}, {zmq}, or {mpi/two} modes: For message exchange in {file}, {zmq}, or {mpi/two} modes:
% mpirun -np 1 lmp_mpi -log log.client < in.client & % mpirun -np 1 lmp_mpi -log log.client < in.client &
% mpirun -np 2 lmp_mpi -log log.server < in.server :pre % mpirun -np 2 lmp_mpi -log log.server < in.server :pre
% mpirun -np 4 lmp_mpi -log log.client < in.client & % mpirun -np 4 lmp_mpi -log log.client < in.client &
% mpirun -np 1 lmp_mpi -log log.server < in.server :pre % mpirun -np 1 lmp_mpi -log log.server < in.server :pre
% mpirun -np 2 lmp_mpi -log log.client < in.client & % mpirun -np 2 lmp_mpi -log log.client < in.client &
% mpirun -np 4 lmp_mpi -log log.server < in.server :pre % mpirun -np 4 lmp_mpi -log log.server < in.server :pre
For message exchange in {mpi/one} mode: For message exchange in {mpi/one} mode:

View File

@ -19,7 +19,7 @@ polarizable"_Howto_polarizable.html doc page for a discussion of all
the polarizable models available in LAMMPS. the polarizable models available in LAMMPS.
Technically, shells are attached to the cores by a spring force f = Technically, shells are attached to the cores by a spring force f =
k*r where k is a parametrized spring constant and r is the distance k*r where k is a parameterized spring constant and r is the distance
between the core and the shell. The charges of the core and the shell between the core and the shell. The charges of the core and the shell
add up to the ion charge, thus q(ion) = q(core) + q(shell). This add up to the ion charge, thus q(ion) = q(core) + q(shell). This
setup introduces the ion polarizability (alpha) given by setup introduces the ion polarizability (alpha) given by
@ -111,7 +111,7 @@ the core and shell particles corresponds to the polarization,
hereby an instantaneous relaxation of the shells is approximated hereby an instantaneous relaxation of the shells is approximated
and a fast core/shell spring frequency ensures a nearly constant and a fast core/shell spring frequency ensures a nearly constant
internal kinetic energy during the simulation. internal kinetic energy during the simulation.
Thermostats can alter this polarization behaviour, by scaling the Thermostats can alter this polarization behavior, by scaling the
internal kinetic energy, meaning the shell will not react freely to internal kinetic energy, meaning the shell will not react freely to
its electrostatic environment. its electrostatic environment.
Therefore it is typically desirable to decouple the relative motion of Therefore it is typically desirable to decouple the relative motion of
@ -165,7 +165,7 @@ fix_modify press_bar temp CSequ press thermo_press_lmp # pressure modification
If "compute temp/cs"_compute_temp_cs.html is used, the decoupled If "compute temp/cs"_compute_temp_cs.html is used, the decoupled
relative motion of the core and the shell should in theory be relative motion of the core and the shell should in theory be
stable. However numerical fluctuation can introduce a small stable. However numerical fluctuation can introduce a small
momentum to the system, which is noticable over long trajectories. momentum to the system, which is noticeable over long trajectories.
Therefore it is recommendable to use the "fix Therefore it is recommendable to use the "fix
momentum"_fix_momentum.html command in combination with "compute momentum"_fix_momentum.html command in combination with "compute
temp/cs"_compute_temp_cs.html when equilibrating the system to temp/cs"_compute_temp_cs.html when equilibrating the system to

View File

@ -74,7 +74,7 @@ command.
A reasonable approach that combines the upsides of both methods is to A reasonable approach that combines the upsides of both methods is to
make the first run using the {kspace_modify force/disp/real} and make the first run using the {kspace_modify force/disp/real} and
{kspace_modify force/disp/kspace} commands, write down the PPPM {kspace_modify force/disp/kspace} commands, write down the PPPM
parameters from the outut, and specify these parameters using the parameters from the output, and specify these parameters using the
second approach in subsequent runs (which have the same composition, second approach in subsequent runs (which have the same composition,
force field, and approximately the same volume). force field, and approximately the same volume).

View File

@ -17,7 +17,7 @@ for a discussion of all the polarizable models available in LAMMPS.
The Drude model has a number of features aimed at its use in The Drude model has a number of features aimed at its use in
molecular systems ("Lamoureux and Roux"_#howto-Lamoureux): molecular systems ("Lamoureux and Roux"_#howto-Lamoureux):
Thermostating of the additional degrees of freedom associated with the Thermostatting of the additional degrees of freedom associated with the
induced dipoles at very low temperature, in terms of the reduced induced dipoles at very low temperature, in terms of the reduced
coordinates of the Drude particles with respect to their cores. This coordinates of the Drude particles with respect to their cores. This
makes the trajectory close to that of relaxed induced dipoles. :ulb,l makes the trajectory close to that of relaxed induced dipoles. :ulb,l

View File

@ -82,7 +82,7 @@ decouple the degrees of freedom associated with the Drude oscillators
from those of the normal atoms. Thermalizing the Drude dipoles at from those of the normal atoms. Thermalizing the Drude dipoles at
temperatures comparable to the rest of the simulation leads to several temperatures comparable to the rest of the simulation leads to several
problems (kinetic energy transfer, very short timestep, etc.), which problems (kinetic energy transfer, very short timestep, etc.), which
can be remediate by the "cold Drude" technique ("Lamoureux and can be remedied by the "cold Drude" technique ("Lamoureux and
Roux"_#Lamoureux2). Roux"_#Lamoureux2).
Two closely related models are used to represent polarization through Two closely related models are used to represent polarization through
@ -213,7 +213,7 @@ of mass of the DC-DP pairs, with relaxation time 100 and with random
seed 12345. This fix applies also a Langevin thermostat at temperature seed 12345. This fix applies also a Langevin thermostat at temperature
1. to the relative motion of the DPs around their DCs, with relaxation 1. to the relative motion of the DPs around their DCs, with relaxation
time 20 and random seed 13977. Only the DCs and non-polarizable time 20 and random seed 13977. Only the DCs and non-polarizable
atoms need to be in this fix's group. LAMMPS will thermostate the DPs atoms need to be in this fix's group. LAMMPS will thermostat the DPs
together with their DC. For this, ghost atoms need to know their together with their DC. For this, ghost atoms need to know their
velocities. Thus you need to add the following command: velocities. Thus you need to add the following command:
@ -360,7 +360,7 @@ fix NPH all nph iso 1. 1. 500 :pre
It is also possible to use a Nose-Hoover instead of a Langevin It is also possible to use a Nose-Hoover instead of a Langevin
thermostat. This requires to use "{fix thermostat. This requires to use "{fix
drude/transform}"_fix_drude_transform.html just before and after the drude/transform}"_fix_drude_transform.html just before and after the
time intergation fixes. The {fix drude/transform/direct} converts the time integration fixes. The {fix drude/transform/direct} converts the
atomic masses, positions, velocities and forces into a reduced atomic masses, positions, velocities and forces into a reduced
representation, where the DCs transform into the centers of mass of representation, where the DCs transform into the centers of mass of
the DC-DP pairs and the DPs transform into their relative position the DC-DP pairs and the DPs transform into their relative position
@ -396,7 +396,7 @@ global pressure and thus a global temperature whatever the fix group.
We do want the pressure to correspond to the whole system, but we want We do want the pressure to correspond to the whole system, but we want
the temperature to correspond to the fix group only. We must then use the temperature to correspond to the fix group only. We must then use
the {fix_modify} command for this. In the end, the block of the {fix_modify} command for this. In the end, the block of
instructions for thermostating and barostating will look like instructions for thermostatting and barostatting will look like
compute TATOMS ATOMS temp compute TATOMS ATOMS temp
fix DIRECT all drude/transform/direct fix DIRECT all drude/transform/direct

View File

@ -30,7 +30,7 @@ examples/elastic directory described on the "Examples"_Examples.html
doc page. doc page.
Calculating elastic constants at finite temperature is more Calculating elastic constants at finite temperature is more
challenging, because it is necessary to run a simulation that perfoms challenging, because it is necessary to run a simulation that performs
time averages of differential properties. One way to do this is to time averages of differential properties. One way to do this is to
measure the change in average stress tensor in an NVT simulations when measure the change in average stress tensor in an NVT simulations when
the cell volume undergoes a finite deformation. In order to balance the cell volume undergoes a finite deformation. In order to balance

View File

@ -96,7 +96,7 @@ machine to a directory with the name you chose. If none is given, it will
default to "lammps". Typical names are "mylammps" or something similar. default to "lammps". Typical names are "mylammps" or something similar.
You can use this local clone to make changes and You can use this local clone to make changes and
test them without interfering with the repository on Github. test them without interfering with the repository on GitHub.
To pull changes from upstream into this copy, you can go to the directory To pull changes from upstream into this copy, you can go to the directory
and use git pull: and use git pull:
@ -150,7 +150,7 @@ After the commit, the changes can be pushed to the same branch on GitHub:
$ git push :pre $ git push :pre
Git will ask you for your user name and password on GitHub if you have Git will ask you for your user name and password on GitHub if you have
not configured anything. If your local branch is not present on Github yet, not configured anything. If your local branch is not present on GitHub yet,
it will ask you to add it by running it will ask you to add it by running
$ git push --set-upstream origin github-tutorial-update :pre $ git push --set-upstream origin github-tutorial-update :pre
@ -254,20 +254,53 @@ them, or if a developer has requested that something needs to be changed
before the feature can be accepted into the official LAMMPS version. before the feature can be accepted into the official LAMMPS version.
After each push, the automated checks are run again. After each push, the automated checks are run again.
[Labels]
LAMMPS developers may add labels to your pull request to assign it to
categories (mostly for bookkeeping purposes), but a few of them are
important: needs_work, work_in_progress, test-for-regression, and
full-regression-test. The first two indicate, that your pull request
is not considered to be complete. With "needs_work" the burden is on
exclusively on you; while "work_in_progress" can also mean, that a
LAMMPS developer may want to add changes. Please watch the comments
to the pull requests. The two "test" labels are used to trigger
extended tests before the code is merged. This is sometimes done by
LAMMPS developers, if they suspect that there may be some subtle
side effects from your changes. It is not done by default, because
those tests are very time consuming.
[Reviews]
As of Summer 2018, a pull request needs at least 1 approving review
from a LAMMPS developer with write access to the repository.
In case your changes touch code that certain developers are associated
with, they are auto-requested by the GitHub software. Those associations
are set in the file
".github/CODEOWNERS"_https://github.com/lammps/lammps/blob/master/.github/CODEOWNERS
Thus if you want to be automatically notified to review when anybody
changes files or packages, that you have contributed to LAMMPS, you can
add suitable patterns to that file, or a LAMMPS developer may add you.
Otherwise, you can also manually request reviews from specific developers,
or LAMMPS developers - in their assessment of your pull request - may
determine who else should be reviewing your contribution and add that person.
Through reviews, LAMMPS developers also may request specific changes from you.
If those are not addressed, your pull requests cannot be merged.
[Assignees] [Assignees]
There is an assignee label for pull requests. If the request has not There is an assignee property for pull requests. If the request has not
been reviewed by any developer yet, it is not assigned to anyone. After been reviewed by any developer yet, it is not assigned to anyone. After
revision, a developer can choose to assign it to either a) you, b) a revision, a developer can choose to assign it to either a) you, b) a
LAMMPS developer (including him/herself) or c) Steve Plimpton (sjplimp). LAMMPS developer (including him/herself) or c) Axel Kohlmeyer (akohlmey).
Case a) happens if changes are required on your part :ulb,l Case a) happens if changes are required on your part :ulb,l
Case b) means that at the moment, it is being tested and reviewed by a Case b) means that at the moment, it is being tested and reviewed by a
LAMMPS developer with the expectation that some changes would be required. LAMMPS developer with the expectation that some changes would be required.
After the review, the developer can choose to implement changes directly After the review, the developer can choose to implement changes directly
or suggest them to you. :l or suggest them to you. :l
Case c) means that the pull request has been assigned to the lead Case c) means that the pull request has been assigned to the developer
developer Steve Plimpton and means it is considered ready for merging. :ule,l overseeing the merging of pull requests into the master branch. :ule,l
In this case, Axel assigned the tutorial to Steve: In this case, Axel assigned the tutorial to Steve:
@ -336,7 +369,7 @@ commit and push again:
$ git commit -m "Merged Axel's suggestions and updated text" $ git commit -m "Merged Axel's suggestions and updated text"
$ git push git@github.com:Pakketeretet2/lammps :pre $ git push git@github.com:Pakketeretet2/lammps :pre
This merge also shows up on the lammps Github page: This merge also shows up on the lammps GitHub page:
:c,image(JPG/tutorial_reverse_pull_request7.png) :c,image(JPG/tutorial_reverse_pull_request7.png)
@ -381,3 +414,6 @@ Furthermore, the naming of the patches now follow the pattern
"patch_<Day><Month><Year>" to simplify comparisons between releases. "patch_<Day><Month><Year>" to simplify comparisons between releases.
Finally, all patches and submissions are subject to automatic testing Finally, all patches and submissions are subject to automatic testing
and code checks to make sure they at the very least compile. and code checks to make sure they at the very least compile.
A discussion of the LAMMPS developer GitHub workflow can be found in the file
"doc/github-development-workflow.md"_https://github.com/lammps/lammps/blob/master/doc/github-development-workflow.md

View File

@ -185,7 +185,7 @@ by the same function if the caller needs to know the ordering. The
lammps_gather_subset() function allows the caller to request values lammps_gather_subset() function allows the caller to request values
for only a subset of atoms (identified by ID). for only a subset of atoms (identified by ID).
For all 3 gather function, per-atom image flags can be retrieved in 2 ways. For all 3 gather function, per-atom image flags can be retrieved in 2 ways.
If the count is specified as 1, they are returned If the count is specified as 1, they are returned
in a packed format with all three image flags stored in a single integer. in a packed format with all three image flags stored in a single integer.
If the count is specified as 3, the values are unpacked into xyz flags If the count is specified as 3, the values are unpacked into xyz flags
by the library before returning them. by the library before returning them.

View File

@ -31,8 +31,8 @@ plane @ a b c x0 y0 z0 @ a*(x-x0) + b*(y-y0) + c*(z-z0) = 0 @ A plane with norma
plane_wiggle @ a w @ z - a*sin(w*x) = 0 @ A plane with a sinusoidal modulation on z along x. plane_wiggle @ a w @ z - a*sin(w*x) = 0 @ A plane with a sinusoidal modulation on z along x.
sphere @ R @ x^2 + y^2 + z^2 - R^2 = 0 @ A sphere of radius R sphere @ R @ x^2 + y^2 + z^2 - R^2 = 0 @ A sphere of radius R
supersphere @ R q @ | x |^q + | y |^q + | z |^q - R^q = 0 @ A supersphere of hyperradius R supersphere @ R q @ | x |^q + | y |^q + | z |^q - R^q = 0 @ A supersphere of hyperradius R
spine @ a, A, B, B2, c @ -(x^2 + y^2) + (a^2 - z^2/f(z)^2)*(1 + (A*sin(g(z)*z^2))^4), f(z) = c if z > 0, 1 otherwise; g(z) = B if z > 0, B2 otherwise @ An approximation to a dendtritic spine spine @ a, A, B, B2, c @ -(x^2 + y^2) + (a^2 - z^2/f(z)^2)*(1 + (A*sin(g(z)*z^2))^4), f(z) = c if z > 0, 1 otherwise; g(z) = B if z > 0, B2 otherwise @ An approximation to a dendritic spine
spine_two @ a, A, B, B2, c @ -(x^2 + y^2) + (a^2 - z^2/f(z)^2)*(1 + (A*sin(g(z)*z^2))^2), f(z) = c if z > 0, 1 otherwise; g(z) = B if z > 0, B2 otherwise @ Another approximation to a dendtritic spine spine_two @ a, A, B, B2, c @ -(x^2 + y^2) + (a^2 - z^2/f(z)^2)*(1 + (A*sin(g(z)*z^2))^2), f(z) = c if z > 0, 1 otherwise; g(z) = B if z > 0, B2 otherwise @ Another approximation to a dendritic spine
thylakoid @ wB LB lB @ Various, see "(Paquay)"_#Paquay1 @ A model grana thylakoid consisting of two block-like compartments connected by a bridge of width wB, length LB and taper length lB thylakoid @ wB LB lB @ Various, see "(Paquay)"_#Paquay1 @ A model grana thylakoid consisting of two block-like compartments connected by a bridge of width wB, length LB and taper length lB
torus @ R r @ (R - sqrt( x^2 + y^2 ) )^2 + z^2 - r^2 @ A torus with large radius R and small radius r, centered on (0,0,0) :tb(s=@) torus @ R r @ (R - sqrt( x^2 + y^2 ) )^2 + z^2 - r^2 @ A torus with large radius R and small radius r, centered on (0,0,0) :tb(s=@)

View File

@ -55,5 +55,5 @@ using the "fix flow/gauss"_fix_flow_gauss.html command.
:line :line
:link(Daivis-nemd) :link(Daivis-nemd)
[(Daivis and Todd)] Daivis and Todd, Nonequilibrium Molecular Dyanmics (book), [(Daivis and Todd)] Daivis and Todd, Nonequilibrium Molecular Dynamics (book),
Cambridge University Press, https://doi.org/10.1017/9781139017848, (2017). Cambridge University Press, https://doi.org/10.1017/9781139017848, (2017).

View File

@ -45,8 +45,8 @@ high symmetry around each site leads to stable trajectories of the
core-shell pairs. However, bonded atoms in molecules can be so close core-shell pairs. However, bonded atoms in molecules can be so close
that a core would interact too strongly or even capture the Drude that a core would interact too strongly or even capture the Drude
particle of a neighbor. The Drude dipole model is relatively more particle of a neighbor. The Drude dipole model is relatively more
complex in order to remediate this and other issues. Specifically, the complex in order to remedy this and other issues. Specifically, the
Drude model includes specific thermostating of the core-Drude pairs Drude model includes specific thermostatting of the core-Drude pairs
and short-range damping of the induced dipoles. and short-range damping of the induced dipoles.
The three polarization methods can be implemented through a The three polarization methods can be implemented through a
@ -77,5 +77,5 @@ motion of the Drude particles with respect to their cores is kept
approaching the self-consistent regime. In both models the approaching the self-consistent regime. In both models the
temperature is regulated using the velocities of the center of mass of temperature is regulated using the velocities of the center of mass of
core+shell (or Drude) pairs, but in the Drude model the actual core+shell (or Drude) pairs, but in the Drude model the actual
relative core-Drude particle motion is thermostated separately as relative core-Drude particle motion is thermostatted separately as
well. well.

View File

@ -141,16 +141,16 @@ Python code if {L} was a lammps instance:
L.command("region box block 0 10 0 5 -0.5 0.5") :pre L.command("region box block 0 10 0 5 -0.5 0.5") :pre
With the PyLammps interface, any command can be split up into arbitrary parts With the PyLammps interface, any command can be split up into arbitrary parts
separated by whitespace, passed as individual arguments to a region method. separated by white-space, passed as individual arguments to a region method.
L.region("box block", 0, 10, 0, 5, -0.5, 0.5) :pre L.region("box block", 0, 10, 0, 5, -0.5, 0.5) :pre
Note that each parameter is set as Python literal floating-point number. In the Note that each parameter is set as Python literal floating-point number. In the
PyLammps interface, each command takes an arbitrary parameter list and transparently PyLammps interface, each command takes an arbitrary parameter list and transparently
merges it to a single command string, separating individual parameters by whitespace. merges it to a single command string, separating individual parameters by white-space.
The benefit of this approach is avoiding redundant command calls and easier The benefit of this approach is avoiding redundant command calls and easier
parameterization. In the original interface parametrization needed to be done parameterization. In the original interface parameterization needed to be done
manually by creating formatted strings. manually by creating formatted strings.
L.command("region box block %f %f %f %f %f %f" % (xlo, xhi, ylo, yhi, zlo, zhi)) :pre L.command("region box block %f %f %f %f %f %f" % (xlo, xhi, ylo, yhi, zlo, zhi)) :pre
@ -328,7 +328,7 @@ jupyter notebook :pre
IPyLammps Examples :h4 IPyLammps Examples :h4
Examples of IPython notebooks can be found in the python/examples/pylammps Examples of IPython notebooks can be found in the python/examples/pylammps
subdirectory. To open these notebooks launch {jupyter notebook} inside this sub-directory. To open these notebooks launch {jupyter notebook} inside this
directory and navigate to one of them. If you compiled and installed directory and navigate to one of them. If you compiled and installed
a LAMMPS shared library with exceptions, PNG, JPEG and FFMPEG support a LAMMPS shared library with exceptions, PNG, JPEG and FFMPEG support
you should be able to rerun all of these notebooks. you should be able to rerun all of these notebooks.

View File

@ -9,7 +9,7 @@ Documentation"_ld - "LAMMPS Commands"_lc :c
Multi-replica simulations :h3 Multi-replica simulations :h3
Several commands in LAMMPS run mutli-replica simulations, meaning Several commands in LAMMPS run multi-replica simulations, meaning
that multiple instances (replicas) of your simulation are run that multiple instances (replicas) of your simulation are run
simultaneously, with small amounts of data exchanged between replicas simultaneously, with small amounts of data exchanged between replicas
periodically. periodically.

View File

@ -30,7 +30,7 @@ r0 of OH bond = 1.0
theta of HOH angle = 109.47 :all(b),p theta of HOH angle = 109.47 :all(b),p
Note that as originally proposed, the SPC model was run with a 9 Note that as originally proposed, the SPC model was run with a 9
Angstrom cutoff for both LJ and Coulommbic terms. It can also be used Angstrom cutoff for both LJ and Coulombic terms. It can also be used
with long-range Coulombics (Ewald or PPPM in LAMMPS), without changing with long-range Coulombics (Ewald or PPPM in LAMMPS), without changing
any of the parameters above, though it becomes a different model in any of the parameters above, though it becomes a different model in
that mode of usage. that mode of usage.

View File

@ -35,7 +35,7 @@ There are several "atom styles"_atom_style.html that allow for
definition of finite-size particles: sphere, dipole, ellipsoid, line, definition of finite-size particles: sphere, dipole, ellipsoid, line,
tri, peri, and body. tri, peri, and body.
The sphere style defines particles that are spheriods and each The sphere style defines particles that are spheroids and each
particle can have a unique diameter and mass (or density). These particle can have a unique diameter and mass (or density). These
particles store an angular velocity (omega) and can be acted upon by particles store an angular velocity (omega) and can be acted upon by
torque. The "set" command can be used to modify the diameter and mass torque. The "set" command can be used to modify the diameter and mass
@ -236,7 +236,7 @@ particles are point masses.
Also note that body particles cannot be modeled with the "fix Also note that body particles cannot be modeled with the "fix
rigid"_fix_rigid.html command. Body particles are treated by LAMMPS rigid"_fix_rigid.html command. Body particles are treated by LAMMPS
as single particles, though they can store internal state, such as a as single particles, though they can store internal state, such as a
list of sub-particles. Individual body partices are typically treated list of sub-particles. Individual body particles are typically treated
as rigid bodies, and their motion integrated with a command like "fix as rigid bodies, and their motion integrated with a command like "fix
nve/body"_fix_nve_body.html. Interactions between pairs of body nve/body"_fix_nve_body.html. Interactions between pairs of body
particles are computed via a command like "pair_style particles are computed via a command like "pair_style

View File

@ -12,48 +12,48 @@ Magnetic spins :h3
The magnetic spin simulations are enabled by the SPIN package, whose The magnetic spin simulations are enabled by the SPIN package, whose
implementation is detailed in "Tranchida"_#Tranchida7. implementation is detailed in "Tranchida"_#Tranchida7.
The model represents the simulation of atomic magnetic spins coupled The model represents the simulation of atomic magnetic spins coupled
to lattice vibrations. The dynamics of those magnetic spins can be used to lattice vibrations. The dynamics of those magnetic spins can be used
to simulate a broad range a phenomena related to magneto-elasticity, or to simulate a broad range a phenomena related to magneto-elasticity, or
or to study the influence of defects on the magnetic properties of or to study the influence of defects on the magnetic properties of
materials. materials.
The magnetic spins are interacting with each others and with the The magnetic spins are interacting with each others and with the
lattice via pair interactions. Typically, the magnetic exchange lattice via pair interactions. Typically, the magnetic exchange
interaction can be defined using the interaction can be defined using the
"pair/spin/exchange"_pair_spin_exchange.html command. This exchange "pair/spin/exchange"_pair_spin_exchange.html command. This exchange
applies a magnetic torque to a given spin, considering the orientation applies a magnetic torque to a given spin, considering the orientation
of its neighboring spins and their relative distances. of its neighboring spins and their relative distances.
It also applies a force on the atoms as a function of the spin It also applies a force on the atoms as a function of the spin
orientations and their associated inter-atomic distances. orientations and their associated inter-atomic distances.
The command "fix precession/spin"_fix_precession_spin.html allows to The command "fix precession/spin"_fix_precession_spin.html allows to
apply a constant magnetic torque on all the spins in the system. This apply a constant magnetic torque on all the spins in the system. This
torque can be an external magnetic field (Zeeman interaction), or an torque can be an external magnetic field (Zeeman interaction), or an
uniaxial magnetic anisotropy. uniaxial magnetic anisotropy.
A Langevin thermostat can be applied to those magnetic spins using A Langevin thermostat can be applied to those magnetic spins using
"fix langevin/spin"_fix_langevin_spin.html. Typically, this thermostat "fix langevin/spin"_fix_langevin_spin.html. Typically, this thermostat
can be coupled to another Langevin thermostat applied to the atoms can be coupled to another Langevin thermostat applied to the atoms
using "fix langevin"_fix_langevin.html in order to simulate using "fix langevin"_fix_langevin.html in order to simulate
thermostated spin-lattice system. thermostatted spin-lattice system.
The magnetic Gilbert damping can also be applied using "fix The magnetic Gilbert damping can also be applied using "fix
langevin/spin"_fix_langevin_spin.html. It allows to either dissipate langevin/spin"_fix_langevin_spin.html. It allows to either dissipate
the thermal energy of the Langevin thermostat, or to perform a the thermal energy of the Langevin thermostat, or to perform a
relaxation of the magnetic configuration toward an equilibrium state. relaxation of the magnetic configuration toward an equilibrium state.
All the computed magnetic properties can be output by two main All the computed magnetic properties can be output by two main
commands. The first one is "compute spin"_compute_spin.html, that commands. The first one is "compute spin"_compute_spin.html, that
enables to evaluate magnetic averaged quantities, such as the total enables to evaluate magnetic averaged quantities, such as the total
magnetization of the system along x, y, or z, the spin temperature, or magnetization of the system along x, y, or z, the spin temperature, or
the magnetic energy. The second command is "compute the magnetic energy. The second command is "compute
property/atom"_compute_property_atom.html. It enables to output all the property/atom"_compute_property_atom.html. It enables to output all the
per atom magnetic quantities. Typically, the orientation of a given per atom magnetic quantities. Typically, the orientation of a given
magnetic spin, or the magnetic force acting on this spin. magnetic spin, or the magnetic force acting on this spin.
:line :line
:link(Tranchida7) :link(Tranchida7)
[(Tranchida)] Tranchida, Plimpton, Thibaudeau and Thompson, [(Tranchida)] Tranchida, Plimpton, Thibaudeau and Thompson,
arXiv preprint arXiv:1801.10233, (2018). arXiv preprint arXiv:1801.10233, (2018).

View File

@ -96,5 +96,5 @@ temperature compute is used for default thermodynamic output.
:line :line
:link(Daivis-thermostat) :link(Daivis-thermostat)
[(Daivis and Todd)] Daivis and Todd, Nonequilibrium Molecular Dyanmics (book), [(Daivis and Todd)] Daivis and Todd, Nonequilibrium Molecular Dynamics (book),
Cambridge University Press, https://doi.org/10.1017/9781139017848, (2017). Cambridge University Press, https://doi.org/10.1017/9781139017848, (2017).

View File

@ -200,7 +200,7 @@ used with non-orthogonal basis vectors to define a lattice that will
tile a triclinic simulation box via the tile a triclinic simulation box via the
"create_atoms"_create_atoms.html command. "create_atoms"_create_atoms.html command.
A second use is to run Parinello-Rahman dynamics via the "fix A second use is to run Parrinello-Rahman dynamics via the "fix
npt"_fix_nh.html command, which will adjust the xy, xz, yz tilt npt"_fix_nh.html command, which will adjust the xy, xz, yz tilt
factors to compensate for off-diagonal components of the pressure factors to compensate for off-diagonal components of the pressure
tensor. The analog for an "energy minimization"_minimize.html is tensor. The analog for an "energy minimization"_minimize.html is

View File

@ -140,5 +140,5 @@ with time at sufficiently long times.
:line :line
:link(Daivis-viscosity) :link(Daivis-viscosity)
[(Daivis and Todd)] Daivis and Todd, Nonequilibrium Molecular Dyanmics (book), [(Daivis and Todd)] Daivis and Todd, Nonequilibrium Molecular Dynamics (book),
Cambridge University Press, https://doi.org/10.1017/9781139017848, (2017). Cambridge University Press, https://doi.org/10.1017/9781139017848, (2017).

View File

@ -45,7 +45,7 @@ git clone -b unstable https://github.com/lammps/lammps.git mylammps :pre
where "mylammps" is the name of the directory you wish to create on where "mylammps" is the name of the directory you wish to create on
your machine and "unstable" is one of the 3 branches listed above. your machine and "unstable" is one of the 3 branches listed above.
(Note that you actually download all 3 branches; you can switch (Note that you actually download all 3 branches; you can switch
between them at any time using "git checkout <branchname>".) between them at any time using "git checkout <branch name>".)
Once the command completes, your directory will contain the same files Once the command completes, your directory will contain the same files
as if you unpacked a current LAMMPS tarball, with two exceptions: as if you unpacked a current LAMMPS tarball, with two exceptions:

View File

@ -89,7 +89,7 @@ the C library interface (lammps-headers), and the LAMMPS python
module for Python 3. All packages can be installed at the same module for Python 3. All packages can be installed at the same
time and the name of the LAMMPS executable is {lmp} in all 3 cases. time and the name of the LAMMPS executable is {lmp} in all 3 cases.
By default, {lmp} will refer to the serial executable, unless By default, {lmp} will refer to the serial executable, unless
one of the MPI environment modules is loaded one of the MPI environment modules is loaded
("module load mpi/mpich-x86_64" or "module load mpi/openmpi-x86_64"). ("module load mpi/mpich-x86_64" or "module load mpi/openmpi-x86_64").
Then the corresponding parallel LAMMPS executable is used. Then the corresponding parallel LAMMPS executable is used.
The same mechanism applies when loading the LAMMPS python module. The same mechanism applies when loading the LAMMPS python module.

View File

@ -17,7 +17,7 @@ how to stay current are on the "Install git"_Install_git.html and
If you prefer to download a tarball, as described on the "Install If you prefer to download a tarball, as described on the "Install
git"_Install_tarball.html doc page, you can stay current by git"_Install_tarball.html doc page, you can stay current by
downloading "patch files" when new patch releases are made. A link to downloading "patch files" when new patch releases are made. A link to
a patch file is posted on the "bug and feature a patch file is posted on the "bug and feature
page"_http://lammps.sandia.gov/bug.html of the LAMMPS website, along page"_http://lammps.sandia.gov/bug.html of the LAMMPS website, along
with a list of changed files and details about what is in the new patch with a list of changed files and details about what is in the new patch
release. This page explains how to apply the patch file to your local release. This page explains how to apply the patch file to your local

View File

@ -48,7 +48,7 @@ Trung Ngyuen (Northwestern U), GPU and RIGID and BODY packages
Mike Parks (Sandia), PERI package for Peridynamics Mike Parks (Sandia), PERI package for Peridynamics
Roy Pollock (LLNL), Ewald and PPPM solvers Roy Pollock (LLNL), Ewald and PPPM solvers
Christian Trott (Sandia), USER-CUDA and KOKKOS packages Christian Trott (Sandia), USER-CUDA and KOKKOS packages
Ilya Valuev (JIHT), USER-AWPMD package for wave-packet MD Ilya Valuev (JIHT), USER-AWPMD package for wave packet MD
Greg Wagner (Northwestern U), MEAM package for MEAM potential :ul Greg Wagner (Northwestern U), MEAM package for MEAM potential :ul
:line :line
@ -58,7 +58,7 @@ page"_http://lammps.sandia.gov/history.html of the website, LAMMPS
originated as a cooperative project between DOE labs and industrial originated as a cooperative project between DOE labs and industrial
partners. Folks involved in the design and testing of the original partners. Folks involved in the design and testing of the original
version of LAMMPS were the following: version of LAMMPS were the following:
John Carpenter (Mayo Clinic, formerly at Cray Research) John Carpenter (Mayo Clinic, formerly at Cray Research)
Terry Stouch (Lexicon Pharmaceuticals, formerly at Bristol Myers Squibb) Terry Stouch (Lexicon Pharmaceuticals, formerly at Bristol Myers Squibb)
Steve Lustig (Dupont) Steve Lustig (Dupont)

View File

@ -68,7 +68,7 @@ commands)
pairwise potentials: Lennard-Jones, Buckingham, Morse, Born-Mayer-Huggins, \ pairwise potentials: Lennard-Jones, Buckingham, Morse, Born-Mayer-Huggins, \
Yukawa, soft, class 2 (COMPASS), hydrogen bond, tabulated Yukawa, soft, class 2 (COMPASS), hydrogen bond, tabulated
charged pairwise potentials: Coulombic, point-dipole charged pairwise potentials: Coulombic, point-dipole
manybody potentials: EAM, Finnis/Sinclair EAM, modified EAM (MEAM), \ many-body potentials: EAM, Finnis/Sinclair EAM, modified EAM (MEAM), \
embedded ion method (EIM), EDIP, ADP, Stillinger-Weber, Tersoff, \ embedded ion method (EIM), EDIP, ADP, Stillinger-Weber, Tersoff, \
REBO, AIREBO, ReaxFF, COMB, SNAP, Streitz-Mintmire, 3-body polymorphic REBO, AIREBO, ReaxFF, COMB, SNAP, Streitz-Mintmire, 3-body polymorphic
long-range interactions for charge, point-dipoles, and LJ dispersion: \ long-range interactions for charge, point-dipoles, and LJ dispersion: \
@ -110,11 +110,11 @@ Atom creation :h4,link(create)
displace atoms :ul displace atoms :ul
Ensembles, constraints, and boundary conditions :h4,link(ensemble) Ensembles, constraints, and boundary conditions :h4,link(ensemble)
("fix"_fix.html command) ("fix"_fix.html command)
2d or 3d systems 2d or 3d systems
orthogonal or non-orthogonal (triclinic symmetry) simulation domains orthogonal or non-orthogonal (triclinic symmetry) simulation domains
constant NVE, NVT, NPT, NPH, Parinello/Rahman integrators constant NVE, NVT, NPT, NPH, Parrinello/Rahman integrators
thermostatting options for groups and geometric regions of atoms thermostatting options for groups and geometric regions of atoms
pressure control via Nose/Hoover or Berendsen barostatting in 1 to 3 dimensions pressure control via Nose/Hoover or Berendsen barostatting in 1 to 3 dimensions
simulation box deformation (tensile and shear) simulation box deformation (tensile and shear)
@ -128,7 +128,7 @@ Ensembles, constraints, and boundary conditions :h4,link(ensemble)
variety of additional boundary conditions and constraints :ul variety of additional boundary conditions and constraints :ul
Integrators :h4,link(integrate) Integrators :h4,link(integrate)
("run"_run.html, "run_style"_run_style.html, "minimize"_minimize.html commands) ("run"_run.html, "run_style"_run_style.html, "minimize"_minimize.html commands)
velocity-Verlet integrator velocity-Verlet integrator
Brownian dynamics Brownian dynamics
@ -142,7 +142,7 @@ Diagnostics :h4,link(diag)
see various flavors of the "fix"_fix.html and "compute"_compute.html commands :ul see various flavors of the "fix"_fix.html and "compute"_compute.html commands :ul
Output :h4,link(output) Output :h4,link(output)
("dump"_dump.html, "restart"_restart.html commands) ("dump"_dump.html, "restart"_restart.html commands)
log file of thermodynamic info log file of thermodynamic info
text dump files of atom coords, velocities, other per-atom quantities text dump files of atom coords, velocities, other per-atom quantities

View File

@ -13,15 +13,19 @@ LAMMPS is designed to be a fast, parallel engine for molecular
dynamics (MD) simulations. It provides only a modest amount of dynamics (MD) simulations. It provides only a modest amount of
functionality for setting up simulations and analyzing their output. functionality for setting up simulations and analyzing their output.
Specifically, LAMMPS does not: Specifically, LAMMPS was not conceived and designed for:
run thru a GUI being run thru a GUI
build molecular systems build molecular systems, or building molecular topologies
assign force-field coefficients automagically assign force-field coefficients automagically
perform sophisticated analyses of your MD simulation perform sophisticated analysis of your MD simulation
visualize your MD simulation interactively visualize your MD simulation interactively
plot your output data :ul plot your output data :ul
Although over the years these limitations have been somewhat
reduced through features added to LAMMPS or external tools
that either interface with LAMMPS or extend LAMMPS.
Here are suggestions on how to perform these tasks: Here are suggestions on how to perform these tasks:
GUI: LAMMPS can be built as a library and a Python wrapper that wraps GUI: LAMMPS can be built as a library and a Python wrapper that wraps
@ -29,7 +33,7 @@ the library interface is provided. Thus, GUI interfaces can be
written in Python (or C or C++ if desired) that run LAMMPS and written in Python (or C or C++ if desired) that run LAMMPS and
visualize or plot its output. Examples of this are provided in the visualize or plot its output. Examples of this are provided in the
python directory and described on the "Python"_Python_head.html doc python directory and described on the "Python"_Python_head.html doc
page. :ulb,l page. Also, there are several external wrappers or GUI front ends.:ulb,l
Builder: Several pre-processing tools are packaged with LAMMPS. Some Builder: Several pre-processing tools are packaged with LAMMPS. Some
of them convert input files in formats produced by other MD codes such of them convert input files in formats produced by other MD codes such
@ -40,28 +44,36 @@ molecular builder that will generate complex molecular models. See
the "Tools"_Tools.html doc page for details on tools packaged with the "Tools"_Tools.html doc page for details on tools packaged with
LAMMPS. The "Pre/post processing LAMMPS. The "Pre/post processing
page"_http:/lammps.sandia.gov/prepost.html of the LAMMPS website page"_http:/lammps.sandia.gov/prepost.html of the LAMMPS website
describes a variety of 3rd party tools for this task. :l describes a variety of 3rd party tools for this task. Furthermore,
some LAMMPS internal commands to reconstruct topology, as well as
the option to insert molecule templates instead of atoms.:l
Force-field assignment: The conversion tools described in the previous Force-field assignment: The conversion tools described in the previous
bullet for CHARMM, AMBER, and Insight will also assign force field bullet for CHARMM, AMBER, and Insight will also assign force field
coefficients in the LAMMPS format, assuming you provide CHARMM, AMBER, coefficients in the LAMMPS format, assuming you provide CHARMM, AMBER,
or Accelerys force field files. :l or BIOVIA (formerly Accelrys) force field files. :l
Simulation analyses: If you want to perform analyses on-the-fly as Simulation analysis: If you want to perform analysis on-the-fly as
your simulation runs, see the "compute"_compute.html and your simulation runs, see the "compute"_compute.html and
"fix"_fix.html doc pages, which list commands that can be used in a "fix"_fix.html doc pages, which list commands that can be used in a
LAMMPS input script. Also see the "Modify"_Modify.html doc page for LAMMPS input script. Also see the "Modify"_Modify.html doc page for
info on how to add your own analysis code or algorithms to LAMMPS. info on how to add your own analysis code or algorithms to LAMMPS.
For post-processing, LAMMPS output such as "dump file For post-processing, LAMMPS output such as "dump file
snapshots"_dump.html can be converted into formats used by other MD or snapshots"_dump.html can be converted into formats used by other MD or
post-processing codes. Some post-processing tools packaged with post-processing codes. To some degree, that conversion can be done
directly inside of LAMMPS by interfacing to the VMD molfile plugins.
The "rerun"_rerun.html command also allows to do some post-processing
of existing trajectories, and through being able to read a variety
of file formats, this can also be used for analyzing trajectories
from other MD codes. Some post-processing tools packaged with
LAMMPS will do these conversions. Scripts provided in the LAMMPS will do these conversions. Scripts provided in the
tools/python directory can extract and massage data in dump files to tools/python directory can extract and massage data in dump files to
make it easier to import into other programs. See the make it easier to import into other programs. See the
"Tools"_Tools.html doc page for details on these various options. :l "Tools"_Tools.html doc page for details on these various options. :l
Visualization: LAMMPS can produce JPG or PNG snapshot images Visualization: LAMMPS can produce JPG or PNG snapshot images
on-the-fly via its "dump image"_dump_image.html command. For on-the-fly via its "dump image"_dump_image.html command and pass
them to an external program FFmpeg to generate movies from them. For
high-quality, interactive visualization there are many excellent and high-quality, interactive visualization there are many excellent and
free tools available. See the "Other Codes free tools available. See the "Other Codes
page"_http://lammps.sandia.gov/viz.html page of the LAMMPS website for page"_http://lammps.sandia.gov/viz.html page of the LAMMPS website for

View File

@ -1,7 +1,7 @@
<!-- HTML_ONLY --> <!-- HTML_ONLY -->
<HEAD> <HEAD>
<TITLE>LAMMPS Users Manual</TITLE> <TITLE>LAMMPS Users Manual</TITLE>
<META NAME="docnumber" CONTENT="24 Oct 2018 version"> <META NAME="docnumber" CONTENT="7 Dec 2018 version">
<META NAME="author" CONTENT="http://lammps.sandia.gov - Sandia National Laboratories"> <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."> <META NAME="copyright" CONTENT="Copyright (2003) Sandia Corporation. This software and manual is distributed under the GNU General Public License.">
</HEAD> </HEAD>
@ -21,7 +21,7 @@
:line :line
LAMMPS Documentation :c,h1 LAMMPS Documentation :c,h1
24 Oct 2018 version :c,h2 7 Dec 2018 version :c,h2
"What is a LAMMPS version?"_Manual_version.html "What is a LAMMPS version?"_Manual_version.html

View File

@ -61,7 +61,7 @@ make pdf # generate 2 PDF files (Manual.pdf,Developer.pdf)
make old # generate old-style HTML pages in old dir via txt2html 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 make fetch # fetch HTML doc pages and 2 PDF files from web site
# as a tarball and unpack into html dir and 2 PDFs # as a tarball and unpack into html dir and 2 PDFs
make epub # generate LAMMPS.epub in ePUB format using Sphinx make epub # generate LAMMPS.epub in ePUB format using Sphinx
make mobi # generate LAMMPS.mobi in MOBI format using ebook-convert make mobi # generate LAMMPS.mobi in MOBI format using ebook-convert
make clean # remove intermediate RST files created by HTML build make clean # remove intermediate RST files created by HTML build
make clean-all # remove entire build folder and any cached data :pre make clean-all # remove entire build folder and any cached data :pre

View File

@ -33,11 +33,11 @@ how much effort it will cause to integrate and test it, how much it
requires changes to the core codebase, and of how much interest it is requires changes to the core codebase, and of how much interest it is
to the larger LAMMPS community. Please see below for a checklist of to the larger LAMMPS community. Please see below for a checklist of
typical requirements. Once you have prepared everything, see the typical requirements. Once you have prepared everything, see the
"Howto github"_Howto_github.html doc page for instructions on how to "Using GitHub with LAMMPS Howto"_Howto_github.html doc page for instructions on how to
submit your changes or new files through a GitHub pull request. If you submit your changes or new files through a GitHub pull request. If you
prefer to submit patches or full files, you should first make certain, prefer to submit patches or full files, you should first make certain,
that your code works correctly with the latest patch-level version of that your code works correctly with the latest patch-level version of
LAMMPS and contains all bugfixes from it. Then create a gzipped tar LAMMPS and contains all bug fixes from it. Then create a gzipped tar
file of all changed or added files or a corresponding patch file using file of all changed or added files or a corresponding patch file using
'diff -u' or 'diff -c' and compress it with gzip. Please only use gzip 'diff -u' or 'diff -c' and compress it with gzip. Please only use gzip
compression, as this works well on all platforms. compression, as this works well on all platforms.

View File

@ -10,7 +10,7 @@ Documentation"_ld - "LAMMPS Commands"_lc :c
Pair styles :h3 Pair styles :h3
Classes that compute pairwise interactions are derived from the Pair Classes that compute pairwise interactions are derived from the Pair
class. In LAMMPS, pairwise calculation include manybody potentials class. In LAMMPS, pairwise calculation include many-body potentials
such as EAM or Tersoff where particles interact without a static bond such as EAM or Tersoff where particles interact without a static bond
topology. New styles can be created to add new pair potentials to topology. New styles can be created to add new pair potentials to
LAMMPS. LAMMPS.

View File

@ -20,6 +20,6 @@ Here is a brief description of methods you define in your new derived
class. See region.h for details. class. See region.h for details.
inside: determine whether a point is in the region inside: determine whether a point is in the region
surface_interior: determine if a point is within a cutoff distance inside of surc surface_interior: determine if a point is within a cutoff distance inside of surface
surface_exterior: determine if a point is within a cutoff distance outside of surf surface_exterior: determine if a point is within a cutoff distance outside of surface
shape_update : change region shape if set by time-dependent variable :tb(s=:) shape_update : change region shape if set by time-dependent variable :tb(s=:)

View File

@ -89,12 +89,14 @@ as contained in the file name.
"USER-NETCDF"_#PKG-USER-NETCDF, "USER-NETCDF"_#PKG-USER-NETCDF,
"USER-OMP"_#PKG-USER-OMP, "USER-OMP"_#PKG-USER-OMP,
"USER-PHONON"_#PKG-USER-PHONON, "USER-PHONON"_#PKG-USER-PHONON,
"USER-PLUMED"_#PKG-USER-PLUMED,
"USER-PTM"_#PKG-USER-PTM, "USER-PTM"_#PKG-USER-PTM,
"USER-QMMM"_#PKG-USER-QMMM, "USER-QMMM"_#PKG-USER-QMMM,
"USER-QTB"_#PKG-USER-QTB, "USER-QTB"_#PKG-USER-QTB,
"USER-QUIP"_#PKG-USER-QUIP, "USER-QUIP"_#PKG-USER-QUIP,
"USER-REAXC"_#PKG-USER-REAXC, "USER-REAXC"_#PKG-USER-REAXC,
"USER-SCAFACOS"_#PKG-USER-SCAFACOS, "USER-SCAFACOS"_#PKG-USER-SCAFACOS,
"USER-SDPD"_#PKG-USER-SDPD,
"USER-SMD"_#PKG-USER-SMD, "USER-SMD"_#PKG-USER-SMD,
"USER-SMTBQ"_#PKG-USER-SMTBQ, "USER-SMTBQ"_#PKG-USER-SMTBQ,
"USER-SPH"_#PKG-USER-SPH, "USER-SPH"_#PKG-USER-SPH,
@ -203,7 +205,7 @@ available on your system.
[Author:] Axel Kohlmeyer (Temple U). [Author:] Axel Kohlmeyer (Temple U).
[Install:] [Install:]
This package has "specific installation This package has "specific installation
instructions"_Build_extras.html#gpu on the "Build instructions"_Build_extras.html#gpu on the "Build
@ -284,7 +286,7 @@ also the "KOKKOS"_#PKG-KOKKOS package, which has GPU-enabled styles.
[Authors:] Mike Brown (Intel) while at Sandia and ORNL and Trung Nguyen [Authors:] Mike Brown (Intel) while at Sandia and ORNL and Trung Nguyen
(Northwestern U) while at ORNL. (Northwestern U) while at ORNL.
[Install:] [Install:]
This package has "specific installation This package has "specific installation
instructions"_Build_extras.html#gpu on the "Build instructions"_Build_extras.html#gpu on the "Build
@ -352,7 +354,7 @@ API which the "pair_style kim"_pair_kim.html command uses. He
developed the pair style in collaboration with Valeriu Smirichinski (U developed the pair style in collaboration with Valeriu Smirichinski (U
Minnesota). Minnesota).
[Install:] [Install:]
This package has "specific installation This package has "specific installation
instructions"_Build_extras.html#gpu on the "Build instructions"_Build_extras.html#gpu on the "Build
@ -398,7 +400,7 @@ which was developed by Carter Edwards, Christian Trott, and others at
Sandia, and which is included in the LAMMPS distribution in Sandia, and which is included in the LAMMPS distribution in
lib/kokkos. lib/kokkos.
[Install:] [Install:]
This package has "specific installation This package has "specific installation
instructions"_Build_extras.html#gpu on the "Build instructions"_Build_extras.html#gpu on the "Build
@ -492,7 +494,7 @@ MANYBODY package :link(PKG-MANYBODY),h4
[Contents:] [Contents:]
A variety of manybody and bond-order potentials. These include A variety of many-body and bond-order potentials. These include
(AI)REBO, BOP, EAM, EIM, Stillinger-Weber, and Tersoff potentials. (AI)REBO, BOP, EAM, EIM, Stillinger-Weber, and Tersoff potentials.
[Supporting info:] [Supporting info:]
@ -516,7 +518,7 @@ MC package :link(PKG-MC),h4
Several fixes and a pair style that have Monte Carlo (MC) or MC-like Several fixes and a pair style that have Monte Carlo (MC) or MC-like
attributes. These include fixes for creating, breaking, and swapping attributes. These include fixes for creating, breaking, and swapping
bonds, for performing atomic swaps, and performing grand-canonical MC bonds, for performing atomic swaps, and performing grand-canonical MC
(GCMC) in conjuction with dynamics. (GCMC) in conjunction with dynamics.
[Supporting info:] [Supporting info:]
@ -546,7 +548,7 @@ and user interface.
[Author:] Greg Wagner (Northwestern U) while at Sandia. [Author:] Greg Wagner (Northwestern U) while at Sandia.
[Install:] [Install:]
This package has "specific installation This package has "specific installation
instructions"_Build_extras.html#gpu on the "Build instructions"_Build_extras.html#gpu on the "Build
@ -679,7 +681,7 @@ system.
library was developed by Jacob Wagner in Greg Voth's group at the library was developed by Jacob Wagner in Greg Voth's group at the
University of Chicago. University of Chicago.
[Install:] [Install:]
This package has "specific installation This package has "specific installation
instructions"_Build_extras.html#gpu on the "Build instructions"_Build_extras.html#gpu on the "Build
@ -711,7 +713,7 @@ have styles optimized for CPU performance.
[Authors:] James Fischer (High Performance Technologies), David Richie, [Authors:] James Fischer (High Performance Technologies), David Richie,
and Vincent Natoli (Stone Ridge Technolgy). and Vincent Natoli (Stone Ridge Technolgy).
[Install:] [Install:]
This package has "specific installation This package has "specific installation
instructions"_Build_extras.html#gpu on the "Build instructions"_Build_extras.html#gpu on the "Build
@ -768,7 +770,7 @@ connections at hinge points.
[Author:] Rudra Mukherjee (JPL) while at RPI. [Author:] Rudra Mukherjee (JPL) while at RPI.
[Install:] [Install:]
This package has "specific installation This package has "specific installation
instructions"_Build_extras.html#gpu on the "Build instructions"_Build_extras.html#gpu on the "Build
@ -800,7 +802,7 @@ shared library available on your system, which needs to be a Python 2
version, 2.6 or later. Python 3 is not yet supported. See the version, 2.6 or later. Python 3 is not yet supported. See the
lib/python/README for more details. lib/python/README for more details.
[Install:] [Install:]
This package has "specific installation This package has "specific installation
instructions"_Build_extras.html#gpu on the "Build instructions"_Build_extras.html#gpu on the "Build
@ -848,7 +850,7 @@ as bonds are created and destroyed.
[Author:] Aidan Thompson (Sandia). [Author:] Aidan Thompson (Sandia).
[Install:] [Install:]
This package has "specific installation This package has "specific installation
instructions"_Build_extras.html#gpu on the "Build instructions"_Build_extras.html#gpu on the "Build
@ -1021,7 +1023,7 @@ system.
library was written by Chris Rycroft (Harvard U) while at UC Berkeley library was written by Chris Rycroft (Harvard U) while at UC Berkeley
and LBNL. and LBNL.
[Install:] [Install:]
This package has "specific installation This package has "specific installation
instructions"_Build_extras.html#gpu on the "Build instructions"_Build_extras.html#gpu on the "Build
@ -1048,7 +1050,7 @@ atomic information to continuum fields.
[Authors:] Reese Jones, Jeremy Templeton, Jon Zimmerman (Sandia). [Authors:] Reese Jones, Jeremy Templeton, Jon Zimmerman (Sandia).
[Install:] [Install:]
This package has "specific installation This package has "specific installation
instructions"_Build_extras.html#gpu on the "Build instructions"_Build_extras.html#gpu on the "Build
@ -1075,7 +1077,7 @@ model.
[Author:] Ilya Valuev (JIHT, Russia). [Author:] Ilya Valuev (JIHT, Russia).
[Install:] [Install:]
This package has "specific installation This package has "specific installation
instructions"_Build_extras.html#gpu on the "Build instructions"_Build_extras.html#gpu on the "Build
@ -1098,7 +1100,7 @@ This package provides "fix bocs"_fix_bocs.html, a modified version
of "fix npt"_fix_nh.html which includes the pressure correction to of "fix npt"_fix_nh.html which includes the pressure correction to
the barostat as outlined in: the barostat as outlined in:
N. J. H. Dunn and W. G. Noid, "Bottom-up coarse-grained models that N. J. H. Dunn and W. G. Noid, "Bottom-up coarse-grained models that
accurately describe the structure, pressure, and compressibility of accurately describe the structure, pressure, and compressibility of
molecular liquids," J. Chem. Phys. 143, 243148 (2015). molecular liquids," J. Chem. Phys. 143, 243148 (2015).
@ -1183,10 +1185,10 @@ and Jerome Henin (LISM, CNRS, Marseille, France), originally for
the NAMD MD code, but with portability in mind. Axel Kohlmeyer the NAMD MD code, but with portability in mind. Axel Kohlmeyer
(Temple U) provided the interface to LAMMPS. (Temple U) provided the interface to LAMMPS.
[Install:] [Install:]
This package has "specific installation This package has "specific installation
instructions"_Build_extras.html#gpu on the "Build instructions"_Build_extras.html#user-colvars on the "Build
extras"_Build_extras.html doc page. extras"_Build_extras.html doc page.
[Supporting info:] [Supporting info:]
@ -1200,6 +1202,36 @@ examples/USER/colvars :ul
:line :line
USER-PLUMED package :link(PKG-USER-PLUMED),h4
[Contents:]
The fix plumed command allows you to use the PLUMED free energy plugin
for molecular dynamics to analyze and bias your LAMMPS trajectory on
the fly. The PLUMED library is called from within the LAMMPS input
script by using the "fix plumed _fix_plumed.html command.
[Authors:] The "PLUMED library"_#PLUMED is written and maintained by
Massimilliano Bonomi, Giovanni Bussi, Carlo Camiloni and Gareth
Tribello.
:link(PLUMED,http://www.plumed.org)
[Install:]
This package has "specific installation
instructions"_Build_extras.html#gpu on the "Build
extras"_Build_extras.html doc page.
[Supporting info:]
src/USER-PLUMED/README
lib/plumed/README
"fix plumed"_fix_plumed.html
examples/USER/plumed :ul
:line
USER-DIFFRACTION package :link(PKG-USER-DIFFRACTION),h4 USER-DIFFRACTION package :link(PKG-USER-DIFFRACTION),h4
[Contents:] [Contents:]
@ -1363,7 +1395,7 @@ system.
[Author:] Pierre de Buyl (KU Leuven) created both the package and the [Author:] Pierre de Buyl (KU Leuven) created both the package and the
H5MD format. H5MD format.
[Install:] [Install:]
This package has "specific installation This package has "specific installation
instructions"_Build_extras.html#gpu on the "Build instructions"_Build_extras.html#gpu on the "Build
@ -1401,7 +1433,7 @@ NOTE: the USER-INTEL package contains styles that require using the
[Author:] Mike Brown (Intel). [Author:] Mike Brown (Intel).
[Install:] [Install:]
This package has "specific installation This package has "specific installation
instructions"_Build_extras.html#gpu on the "Build instructions"_Build_extras.html#gpu on the "Build
@ -1571,17 +1603,17 @@ USER-MOFFF package :link(PKG-USER-MOFFF),h4
[Contents:] [Contents:]
Pair, angle and improper styles needed to employ the MOF-FF Pair, angle and improper styles needed to employ the MOF-FF
force field by Schmid and coworkers with LAMMPS. force field by Schmid and coworkers with LAMMPS.
MOF-FF is a first principles derived force field with the primary aim MOF-FF is a first principles derived force field with the primary aim
to simulate MOFs and related porous framework materials, using spherical to simulate MOFs and related porous framework materials, using spherical
Gaussian charges. It is described in S. Bureekaew et al., Phys. Stat. Sol. B Gaussian charges. It is described in S. Bureekaew et al., Phys. Stat. Sol. B
2013, 250, 1128-1141. 2013, 250, 1128-1141.
For the usage of MOF-FF see the example in the example directory as For the usage of MOF-FF see the example in the example directory as
well as the "MOF+"_MOFplus website. well as the "MOF+"_MOFplus website.
:link(MOFplus,https://www.mofplus.org/content/show/MOF-FF) :link(MOFplus,https://www.mofplus.org/content/show/MOF-FF)
[Author:] Hendrik Heenen (Technical U of Munich), [Author:] Hendrik Heenen (Technical U of Munich),
Rochus Schmid (Ruhr-University Bochum). Rochus Schmid (Ruhr-University Bochum).
[Supporting info:] [Supporting info:]
@ -1622,7 +1654,7 @@ at
[Author:] Axel Kohlmeyer (Temple U). [Author:] Axel Kohlmeyer (Temple U).
[Install:] [Install:]
This package has "specific installation This package has "specific installation
instructions"_Build_extras.html#gpu on the "Build instructions"_Build_extras.html#gpu on the "Build
@ -1662,7 +1694,7 @@ tools:
[Author:] Lars Pastewka (Karlsruhe Institute of Technology). [Author:] Lars Pastewka (Karlsruhe Institute of Technology).
[Install:] [Install:]
This package has "specific installation This package has "specific installation
instructions"_Build_extras.html#gpu on the "Build instructions"_Build_extras.html#gpu on the "Build
@ -1706,7 +1738,7 @@ See src/MAKE/OPTIONS/Makefile.omp for an example.
Once you have an appropriate Makefile.machine, you can Once you have an appropriate Makefile.machine, you can
install/un-install the package and build LAMMPS in the usual manner: install/un-install the package and build LAMMPS in the usual manner:
[Install:] [Install:]
This package has "specific installation This package has "specific installation
instructions"_Build_extras.html#gpu on the "Build instructions"_Build_extras.html#gpu on the "Build
@ -1785,7 +1817,7 @@ without changes to LAMMPS itself.
[Author:] Axel Kohlmeyer (Temple U). [Author:] Axel Kohlmeyer (Temple U).
[Install:] [Install:]
This package has "specific installation This package has "specific installation
instructions"_Build_extras.html#gpu on the "Build instructions"_Build_extras.html#gpu on the "Build
@ -1843,7 +1875,7 @@ on your system.
[Author:] Albert Bartok (Cambridge University) [Author:] Albert Bartok (Cambridge University)
[Install:] [Install:]
This package has "specific installation This package has "specific installation
instructions"_Build_extras.html#gpu on the "Build instructions"_Build_extras.html#gpu on the "Build
@ -1916,6 +1948,31 @@ examples/USER/scafacos :ul
:line :line
USER-SDPD package :link(PKG-USER-SDPD),h4
[Contents:]
A pair style for smoothed dissipative particle dynamics (SDPD), which
is an extension of smoothed particle hydrodynamics (SPH) to mesoscale
where thermal fluctuations are important (see the
"USER-SPH package"_#PKG-USER-SPH).
Also two fixes for moving and rigid body integration of SPH/SDPD particles
(particles of atom_style meso).
[Author:] Morteza Jalalvand (Institute for Advanced Studies in Basic
Sciences, Iran).
[Supporting info:]
src/USER-SDPD: filenames -> commands
src/USER-SDPD/README
"pair_style sdpd/taitwater/isothermal"_pair_sdpd_taitwater_isothermal.html
"fix meso/move"_fix_meso_move.html
"fix rigid/meso"_fix_rigid_meso.html
examples/USER/sdpd :ul
:line
USER-SMD package :link(PKG-USER-SMD),h4 USER-SMD package :link(PKG-USER-SMD),h4
[Contents:] [Contents:]
@ -1937,7 +1994,7 @@ specified as surface geometries from *.STL files.
[Author:] Georg Ganzenmuller (Fraunhofer-Institute for High-Speed [Author:] Georg Ganzenmuller (Fraunhofer-Institute for High-Speed
Dynamics, Ernst Mach Institute, Germany). Dynamics, Ernst Mach Institute, Germany).
[Install:] [Install:]
This package has "specific installation This package has "specific installation
instructions"_Build_extras.html#gpu on the "Build instructions"_Build_extras.html#gpu on the "Build
@ -2063,7 +2120,7 @@ system.
[Authors:] Richard Berger (JKU) and Daniel Queteschiner (DCS Computing). [Authors:] Richard Berger (JKU) and Daniel Queteschiner (DCS Computing).
[Install:] [Install:]
This package has "specific installation This package has "specific installation
instructions"_Build_extras.html#gpu on the "Build instructions"_Build_extras.html#gpu on the "Build

View File

@ -38,8 +38,8 @@ int = internal library: provided with LAMMPS, but you may need to build it
ext = external library: you will need to download and install it on your machine :ul ext = external library: you will need to download and install it on your machine :ul
Package, Description, Doc page, Example, Library Package, Description, Doc page, Example, Library
"USER-ATC"_Packages_details.html#PKG-USER-ATC, atom-to-continuum coupling, "fix atc"_fix_atc.html, USER/atc, int "USER-ATC"_Packages_details.html#PKG-USER-ATC, Atom-to-Continuum coupling, "fix atc"_fix_atc.html, USER/atc, int
"USER-AWPMD"_Packages_details.html#PKG-USER-AWPMD, wave-packet MD, "pair_style awpmd/cut"_pair_awpmd.html, USER/awpmd, int "USER-AWPMD"_Packages_details.html#PKG-USER-AWPMD, wave packet MD, "pair_style awpmd/cut"_pair_awpmd.html, USER/awpmd, int
"USER-BOCS"_Packages_details.html#PKG-USER-BOCS, BOCS bottom up coarse graining, "fix bocs"_fix_bocs.html, USER/bocs, no "USER-BOCS"_Packages_details.html#PKG-USER-BOCS, BOCS bottom up coarse graining, "fix bocs"_fix_bocs.html, USER/bocs, no
"USER-CGDNA"_Packages_details.html#PKG-USER-CGDNA, coarse-grained DNA force fields, src/USER-CGDNA/README, USER/cgdna, no "USER-CGDNA"_Packages_details.html#PKG-USER-CGDNA, coarse-grained DNA force fields, src/USER-CGDNA/README, USER/cgdna, no
"USER-CGSDK"_Packages_details.html#PKG-USER-CGSDK, SDK coarse-graining model, "pair_style lj/sdk"_pair_sdk.html, USER/cgsdk, no "USER-CGSDK"_Packages_details.html#PKG-USER-CGSDK, SDK coarse-graining model, "pair_style lj/sdk"_pair_sdk.html, USER/cgsdk, no
@ -62,16 +62,20 @@ Package, Description, Doc page, Example, Library
"USER-NETCDF"_Packages_details.html#PKG-USER-NETCDF, dump output via NetCDF,"dump netcdf"_dump_netcdf.html, n/a, ext "USER-NETCDF"_Packages_details.html#PKG-USER-NETCDF, dump output via NetCDF,"dump netcdf"_dump_netcdf.html, n/a, ext
"USER-OMP"_Packages_details.html#PKG-USER-OMP, OpenMP-enabled styles,"Speed omp"_Speed_omp.html, "Benchmarks"_http://lammps.sandia.gov/bench.html, no "USER-OMP"_Packages_details.html#PKG-USER-OMP, OpenMP-enabled styles,"Speed omp"_Speed_omp.html, "Benchmarks"_http://lammps.sandia.gov/bench.html, no
"USER-PHONON"_Packages_details.html#PKG-USER-PHONON, phonon dynamical matrix,"fix phonon"_fix_phonon.html, USER/phonon, no "USER-PHONON"_Packages_details.html#PKG-USER-PHONON, phonon dynamical matrix,"fix phonon"_fix_phonon.html, USER/phonon, no
"USER-PLUMED"_Packages_details.html#PKG-USER-PLUMED, "PLUMED"_#PLUMED free energy library,"fix plumed"_fix_plumed.html, USER/plumed, ext
"USER-PTM"_Packages_details.html#PKG-USER-PTM, Polyhedral Template Matching,"compute ptm/atom"_compute_ptm_atom.html, n/a, no "USER-PTM"_Packages_details.html#PKG-USER-PTM, Polyhedral Template Matching,"compute ptm/atom"_compute_ptm_atom.html, n/a, no
"USER-QMMM"_Packages_details.html#PKG-USER-QMMM, QM/MM coupling,"fix qmmm"_fix_qmmm.html, USER/qmmm, ext "USER-QMMM"_Packages_details.html#PKG-USER-QMMM, QM/MM coupling,"fix qmmm"_fix_qmmm.html, USER/qmmm, ext
"USER-QTB"_Packages_details.html#PKG-USER-QTB, quantum nuclear effects,"fix qtb"_fix_qtb.html "fix qbmsst"_fix_qbmsst.html, qtb, no "USER-QTB"_Packages_details.html#PKG-USER-QTB, quantum nuclear effects,"fix qtb"_fix_qtb.html "fix qbmsst"_fix_qbmsst.html, qtb, no
"USER-QUIP"_Packages_details.html#PKG-USER-QUIP, QUIP/libatoms interface,"pair_style quip"_pair_quip.html, USER/quip, ext "USER-QUIP"_Packages_details.html#PKG-USER-QUIP, QUIP/libatoms interface,"pair_style quip"_pair_quip.html, USER/quip, ext
"USER-REAXC"_Packages_details.html#PKG-USER-REAXC, ReaxFF potential (C/C++) ,"pair_style reaxc"_pair_reaxc.html, reax, no "USER-REAXC"_Packages_details.html#PKG-USER-REAXC, ReaxFF potential (C/C++) ,"pair_style reaxc"_pair_reaxc.html, reax, no
"USER-SCAFACOS"_Packages_details.html#PKG-USER-SCAFACOS, wrapper on ScaFaCoS solver,"kspace_style scafacos"_kspace_style.html, USER/scafacos, ext "USER-SCAFACOS"_Packages_details.html#PKG-USER-SCAFACOS, wrapper on ScaFaCoS solver,"kspace_style scafacos"_kspace_style.html, USER/scafacos, ext
"USER-SDPD"_Packages_details.html#PKG-USER-SDPD, smoothed dissipative particle dynamics,"pair_style sdpd/taitwater/isothermal"_pair_sdpd_taitwater_isothermal.html, USER/sdpd, no
"USER-SMD"_Packages_details.html#PKG-USER-SMD, smoothed Mach dynamics,"SMD User Guide"_PDF/SMD_LAMMPS_userguide.pdf, USER/smd, ext "USER-SMD"_Packages_details.html#PKG-USER-SMD, smoothed Mach dynamics,"SMD User Guide"_PDF/SMD_LAMMPS_userguide.pdf, USER/smd, ext
"USER-SMTBQ"_Packages_details.html#PKG-USER-SMTBQ, second moment tight binding QEq potential,"pair_style smtbq"_pair_smtbq.html, USER/smtbq, no "USER-SMTBQ"_Packages_details.html#PKG-USER-SMTBQ, second moment tight binding QEq potential,"pair_style smtbq"_pair_smtbq.html, USER/smtbq, no
"USER-SPH"_Packages_details.html#PKG-USER-SPH, smoothed particle hydrodynamics,"SPH User Guide"_PDF/SPH_LAMMPS_userguide.pdf, USER/sph, no "USER-SPH"_Packages_details.html#PKG-USER-SPH, smoothed particle hydrodynamics,"SPH User Guide"_PDF/SPH_LAMMPS_userguide.pdf, USER/sph, no
"USER-TALLY"_Packages_details.html#PKG-USER-TALLY, pairwise tally computes,"compute XXX/tally"_compute_tally.html, USER/tally, no "USER-TALLY"_Packages_details.html#PKG-USER-TALLY, pairwise tally computes,"compute XXX/tally"_compute_tally.html, USER/tally, no
"USER-UEF"_Packages_details.html#PKG-USER-UEF, extensional flow,"fix nvt/uef"_fix_nh_uef.html, USER/uef, no "USER-UEF"_Packages_details.html#PKG-USER-UEF, extensional flow,"fix nvt/uef"_fix_nh_uef.html, USER/uef, no
"USER-VTK"_Packages_details.html#PKG-USER-VTK, dump output via VTK, "compute vtk"_dump_vtk.html, n/a, ext :tb(ea=c,ca1=l) "USER-VTK"_Packages_details.html#PKG-USER-VTK, dump output via VTK, "compute vtk"_dump_vtk.html, n/a, ext :tb(ea=c,ca1=l)
:link(MOFplus,https://www.mofplus.org/content/show/MOF-FF) :link(MOFplus,https://www.mofplus.org/content/show/MOF-FF)
:link(PLUMED,http://www.plumed.org)

View File

@ -79,7 +79,7 @@ of Python and your machine to successfully build LAMMPS. See the
lib/python/README file for more info. lib/python/README file for more info.
If you want to write Python code with callbacks to LAMMPS, then you If you want to write Python code with callbacks to LAMMPS, then you
must also follow the steps overviewed in the "Python must also follow the steps summarized in the "Python
run"_Python_run.html doc page. I.e. you must build LAMMPS as a shared run"_Python_run.html doc page. I.e. you must build LAMMPS as a shared
library and insure that Python can find the python/lammps.py file and library and insure that Python can find the python/lammps.py file and
the shared library. the shared library.

View File

@ -46,7 +46,7 @@ http://mt.seas.upenn.edu/Archive/Graphics/A3/A3.html :pre
:link(atomeye,http://mt.seas.upenn.edu/Archive/Graphics/A) :link(atomeye,http://mt.seas.upenn.edu/Archive/Graphics/A)
:link(atomeye3,http://mt.seas.upenn.edu/Archive/Graphics/A3/A3.html) :link(atomeye3,http://mt.seas.upenn.edu/Archive/Graphics/A3/A3.html)
The latter link is to AtomEye 3 which has the scriping The latter link is to AtomEye 3 which has the scripting
capability needed by these Python scripts. capability needed by these Python scripts.
Note that for PyMol, you need to have built and installed the Note that for PyMol, you need to have built and installed the

View File

@ -354,29 +354,31 @@ the LAMMPS simulation domain.
:line :line
[-restart2data restartfile (remap) datafile keyword value ...] :link(restart2data) [-restart2data restartfile \[remap\] datafile keyword value ...]
:link(restart2data)
Convert the restart file into a data file and immediately exit. This Convert the restart file into a data file and immediately exit. This
is the same operation as if the following 2-line input script were is the same operation as if the following 2-line input script were
run: run:
read_restart restartfile (remap) read_restart restartfile \[remap\]
write_data datafile keyword value ... :pre write_data datafile keyword value ... :pre
Note that the specified restartfile and/or datafile can have the The specified restartfile and/or datafile name may contain the wild-card
wild-card character "*". The restartfile can also have the wild-card character "*". The restartfile name may also contain the wild-card
character "%". The meaning of these characters is explained on the character "%". The meaning of these characters is explained on the
"read_restart"_read_restart.html and "write_data"_write_data.html doc "read_restart"_read_restart.html and "write_data"_write_data.html doc
pages. The use of "%" means that a parallel restart file can be read. pages. The use of "%" means that a parallel restart file can be read.
Note that a filename such as file.* will need to be enclosed in quotes Note that a filename such as file.* may need to be enclosed in quotes or
to avoid shell expansion of the "*" character. the "*" character prefixed with a backslash ("\") to avoid shell
expansion of the "*" character.
Note that following restartfile, the optional word "remap" can be Following restartfile argument, the optional word "remap" may be used.
used. This has the effect of adding it to the This has the same effect like adding it to a
"read_restart"_read_restart.html command, as explained on its doc "read_restart"_read_restart.html command, and operates as explained on
page. This is useful if reading the restart file triggers an error its doc page. This is useful if reading the restart file triggers an
that atoms have been lost. In that case, use of the remap flag should error that atoms have been lost. In that case, use of the remap flag
allow the data file to still be produced. should allow the data file to still be produced.
The syntax following restartfile (or remap), namely The syntax following restartfile (or remap), namely
@ -388,29 +390,30 @@ optional keyword/value settings.
:line :line
[-restart2dump restartfile {remap} group-ID dumpstyle dumpfile arg1 arg2 ...] :link(restart2dump) [-restart2dump restartfile \[remap\] group-ID dumpstyle dumpfile arg1 arg2 ...] :link(restart2dump)
Convert the restart file into a dump file and immediately exit. This Convert the restart file into a dump file and immediately exit. This
is the same operation as if the following 2-line input script were is the same operation as if the following 2-line input script were
run: run:
read_restart restartfile (remap) read_restart restartfile \[remap\]
write_dump group-ID dumpstyle dumpfile arg1 arg2 ... :pre write_dump group-ID dumpstyle dumpfile arg1 arg2 ... :pre
Note that the specified restartfile and dumpfile can have wild-card Note that the specified restartfile and dumpfile names may contain
characters ("*","%") as explained on the wild-card characters ("*","%") as explained on the
"read_restart"_read_restart.html and "write_dump"_write_dump.html doc "read_restart"_read_restart.html and "write_dump"_write_dump.html doc
pages. The use of "%" means that a parallel restart file and/or pages. The use of "%" means that a parallel restart file and/or
parallel dump file can be read and/or written. Note that a filename parallel dump file can be read and/or written. Note that a filename
such as file.* will need to be enclosed in quotes to avoid shell such as file.* may need to be enclosed in quotes or the "*" character
expansion of the "*" character. prefixed with a backslash ("\") to avoid shell expansion of the "*"
character.
Note that following restartfile, the optional word "remap" can be Note that following the restartfile argument, the optional word "remap"
used. This has the effect as adding it to the can be used. This has the effect as adding it to the
"read_restart"_read_restart.html command, as explained on its doc "read_restart"_read_restart.html command, as explained on its doc page.
page. This is useful if reading the restart file triggers an error This is useful if reading the restart file triggers an error that atoms
that atoms have been lost. In that case, use of the remap flag should have been lost. In that case, use of the remap flag should allow the
allow the dump file to still be produced. dump file to still be produced.
The syntax following restartfile (or remap), namely The syntax following restartfile (or remap), namely
@ -524,7 +527,7 @@ option is equivalent to putting the line "variable name index value1
value2 ..." at the beginning of the input script. Defining an index value2 ..." at the beginning of the input script. Defining an index
variable as a command-line argument overrides any setting for the same variable as a command-line argument overrides any setting for the same
index variable in the input script, since index variables cannot be index variable in the input script, since index variables cannot be
re-defined. re-defined.
See the "variable"_variable.html command for more info on defining See the "variable"_variable.html command for more info on defining
index and other kinds of variables and the "Commands index and other kinds of variables and the "Commands

View File

@ -41,7 +41,7 @@ path for the default location of this MPI package. After the
installation of the MPICH2 software, it needs to be integrated into installation of the MPICH2 software, it needs to be integrated into
the system. For this you need to start a Command Prompt in the system. For this you need to start a Command Prompt in
{Administrator Mode} (right click on the icon and select it). Change {Administrator Mode} (right click on the icon and select it). Change
into the MPICH2 installation directory, then into the subdirectory into the MPICH2 installation directory, then into the sub-directory
[bin] and execute [smpd.exe -install]. Exit the command window. [bin] and execute [smpd.exe -install]. Exit the command window.
Get a new, regular command prompt by going to Start->Run... , Get a new, regular command prompt by going to Start->Run... ,

View File

@ -19,7 +19,7 @@ using code options that implement alternate algorithms that can
speed-up a simulation. The second is to use one of the several speed-up a simulation. The second is to use one of the several
accelerator packages provided with LAMMPS that contain code optimized accelerator packages provided with LAMMPS that contain code optimized
for certain kinds of hardware, including multi-core CPUs, GPUs, and for certain kinds of hardware, including multi-core CPUs, GPUs, and
Intel Xeon Phi coprocessors. Intel Xeon Phi co-processors.
The "Benchmark page"_http://lammps.sandia.gov/bench.html of the LAMMPS The "Benchmark page"_http://lammps.sandia.gov/bench.html of the LAMMPS
web site gives performance results for the various accelerator web site gives performance results for the various accelerator

View File

@ -14,11 +14,11 @@ Corporation. It provides two methods for accelerating simulations,
depending on the hardware you have. The first is acceleration on depending on the hardware you have. The first is acceleration on
Intel CPUs by running in single, mixed, or double precision with Intel CPUs by running in single, mixed, or double precision with
vectorization. The second is acceleration on Intel Xeon Phi vectorization. The second is acceleration on Intel Xeon Phi
coprocessors via offloading neighbor list and non-bonded force co-processors via offloading neighbor list and non-bonded force
calculations to the Phi. The same C++ code is used in both cases. calculations to the Phi. The same C++ code is used in both cases.
When offloading to a coprocessor from a CPU, the same routine is run When offloading to a co-processor from a CPU, the same routine is run
twice, once on the CPU and once with an offload flag. This allows twice, once on the CPU and once with an offload flag. This allows
LAMMPS to run on the CPU cores and coprocessor cores simultaneously. LAMMPS to run on the CPU cores and co-processor cores simultaneously.
[Currently Available USER-INTEL Styles:] [Currently Available USER-INTEL Styles:]
@ -27,9 +27,9 @@ Bond Styles: fene, fourier, harmonic :l
Dihedral Styles: charmm, harmonic, opls :l Dihedral Styles: charmm, harmonic, opls :l
Fixes: nve, npt, nvt, nvt/sllod, nve/asphere :l Fixes: nve, npt, nvt, nvt/sllod, nve/asphere :l
Improper Styles: cvff, harmonic :l Improper Styles: cvff, harmonic :l
Pair Styles: airebo, airebo/morse, buck/coul/cut, buck/coul/long, Pair Styles: airebo, airebo/morse, buck/coul/cut, buck/coul/long,
buck, dpd, eam, eam/alloy, eam/fs, gayberne, lj/charmm/coul/charmm, buck, dpd, eam, eam/alloy, eam/fs, gayberne, lj/charmm/coul/charmm,
lj/charmm/coul/long, lj/cut, lj/cut/coul/long, lj/long/coul/long, lj/charmm/coul/long, lj/cut, lj/cut/coul/long, lj/long/coul/long,
rebo, sw, tersoff :l rebo, sw, tersoff :l
K-Space Styles: pppm, pppm/disp :l K-Space Styles: pppm, pppm/disp :l
:ule :ule
@ -47,7 +47,7 @@ These are scalable in size; the results given are with 512K
particles (524K for Liquid Crystal). Most of the simulations are particles (524K for Liquid Crystal). Most of the simulations are
standard LAMMPS benchmarks (indicated by the filename extension in standard LAMMPS benchmarks (indicated by the filename extension in
parenthesis) with modifications to the run length and to add a parenthesis) with modifications to the run length and to add a
warmup run (for use with offload benchmarks). warm-up run (for use with offload benchmarks).
:c,image(JPG/user_intel.png) :c,image(JPG/user_intel.png)
@ -134,19 +134,19 @@ Do not use thread affinity (set KMP_AFFINITY=none) :l
The "newton off" setting may provide better scalability :l The "newton off" setting may provide better scalability :l
:ule :ule
For Intel Xeon Phi coprocessors (Offload): For Intel Xeon Phi co-processors (Offload):
Edit src/MAKE/OPTIONS/Makefile.intel_coprocessor as necessary :ulb,l Edit src/MAKE/OPTIONS/Makefile.intel_co-processor as necessary :ulb,l
"-pk intel N omp 1" added to command-line where N is the number of "-pk intel N omp 1" added to command-line where N is the number of
coprocessors per node. :l co-processors per node. :l
:ule :ule
:line :line
[Required hardware/software:] [Required hardware/software:]
In order to use offload to coprocessors, an Intel Xeon Phi In order to use offload to co-processors, an Intel Xeon Phi
coprocessor and an Intel compiler are required. For this, the co-processor and an Intel compiler are required. For this, the
recommended version of the Intel compiler is 14.0.1.106 or recommended version of the Intel compiler is 14.0.1.106 or
versions 15.0.2.044 and higher. versions 15.0.2.044 and higher.
@ -214,7 +214,7 @@ Makefile.intel_cpu_intelmpi # Intel Compiler, Intel MPI, No Offload
Makefile.knl # Intel Compiler, Intel MPI, No Offload Makefile.knl # Intel Compiler, Intel MPI, No Offload
Makefile.intel_cpu_mpich # Intel Compiler, MPICH, No Offload Makefile.intel_cpu_mpich # Intel Compiler, MPICH, No Offload
Makefile.intel_cpu_openpmi # Intel Compiler, OpenMPI, No Offload Makefile.intel_cpu_openpmi # Intel Compiler, OpenMPI, No Offload
Makefile.intel_coprocessor # Intel Compiler, Intel MPI, Offload :pre Makefile.intel_co-processor # Intel Compiler, Intel MPI, Offload :pre
Makefile.knl is identical to Makefile.intel_cpu_intelmpi except that Makefile.knl is identical to Makefile.intel_cpu_intelmpi except that
it explicitly specifies that vectorization should be for Intel Xeon it explicitly specifies that vectorization should be for Intel Xeon
@ -227,18 +227,18 @@ source /opt/intel/parallel_studio_xe_2016.3.067/psxevars.sh
# or psxevars.csh for C-shell # or psxevars.csh for C-shell
make intel_cpu_intelmpi :pre make intel_cpu_intelmpi :pre
Note that if you build with support for a Phi coprocessor, the same Note that if you build with support for a Phi co-processor, the same
binary can be used on nodes with or without coprocessors installed. binary can be used on nodes with or without co-processors installed.
However, if you do not have coprocessors on your system, building However, if you do not have co-processors on your system, building
without offload support will produce a smaller binary. without offload support will produce a smaller binary.
The general requirements for Makefiles with the USER-INTEL package The general requirements for Makefiles with the USER-INTEL package
are as follows. When using Intel compilers, "-restrict" is required are as follows. When using Intel compilers, "-restrict" is required
and "-qopenmp" is highly recommended for CCFLAGS and LINKFLAGS. and "-qopenmp" is highly recommended for CCFLAGS and LINKFLAGS.
CCFLAGS should include "-DLMP_INTEL_USELRT" (unless POSIX Threads CCFLAGS should include "-DLMP_INTEL_USELRT" (unless POSIX Threads
are not supported in the build environment) and "-DLMP_USE_MKL_RNG" are not supported in the build environment) and "-DLMP_USE_MKL_RNG"
(unless Intel Math Kernel Library (MKL) is not available in the build (unless Intel Math Kernel Library (MKL) is not available in the build
environment). For Intel compilers, LIB should include "-ltbbmalloc" environment). For Intel compilers, LIB should include "-ltbbmalloc"
or if the library is not available, "-DLMP_INTEL_NO_TBB" can be added or if the library is not available, "-DLMP_INTEL_NO_TBB" can be added
to CCFLAGS. For builds supporting offload, "-DLMP_INTEL_OFFLOAD" is to CCFLAGS. For builds supporting offload, "-DLMP_INTEL_OFFLOAD" is
required for CCFLAGS and "-qoffload" is required for LINKFLAGS. Other required for CCFLAGS and "-qoffload" is required for LINKFLAGS. Other
@ -272,7 +272,7 @@ Advanced performance tuning options are also described below to get
the best performance. the best performance.
When running on a single node (including runs using offload to a When running on a single node (including runs using offload to a
coprocessor), best performance is normally obtained by using 1 MPI co-processor), best performance is normally obtained by using 1 MPI
task per physical core and additional OpenMP threads with SMT. For task per physical core and additional OpenMP threads with SMT. For
Intel Xeon processors, 2 OpenMP threads should be used for SMT. Intel Xeon processors, 2 OpenMP threads should be used for SMT.
For Intel Xeon Phi CPUs, 2 or 4 OpenMP threads should be used For Intel Xeon Phi CPUs, 2 or 4 OpenMP threads should be used
@ -290,7 +290,7 @@ NOTE: Setting core affinity is often used to pin MPI tasks and OpenMP
threads to a core or group of cores so that memory access can be threads to a core or group of cores so that memory access can be
uniform. Unless disabled at build time, affinity for MPI tasks and uniform. Unless disabled at build time, affinity for MPI tasks and
OpenMP threads on the host (CPU) will be set by default on the host OpenMP threads on the host (CPU) will be set by default on the host
{when using offload to a coprocessor}. In this case, it is unnecessary {when using offload to a co-processor}. In this case, it is unnecessary
to use other methods to control affinity (e.g. taskset, numactl, to use other methods to control affinity (e.g. taskset, numactl,
I_MPI_PIN_DOMAIN, etc.). This can be disabled with the {no_affinity} I_MPI_PIN_DOMAIN, etc.). This can be disabled with the {no_affinity}
option to the "package intel"_package.html command or by disabling the option to the "package intel"_package.html command or by disabling the
@ -310,15 +310,15 @@ editing the input script. This switch will automatically append
options for the USER-INTEL package. The default package command will options for the USER-INTEL package. The default package command will
specify that USER-INTEL calculations are performed in mixed precision, specify that USER-INTEL calculations are performed in mixed precision,
that the number of OpenMP threads is specified by the OMP_NUM_THREADS that the number of OpenMP threads is specified by the OMP_NUM_THREADS
environment variable, and that if coprocessors are present and the environment variable, and that if co-processors are present and the
binary was built with offload support, that 1 coprocessor per node binary was built with offload support, that 1 co-processor per node
will be used with automatic balancing of work between the CPU and the will be used with automatic balancing of work between the CPU and the
coprocessor. co-processor.
You can specify different options for the USER-INTEL package by using You can specify different options for the USER-INTEL package by using
the "-pk intel Nphi" "command-line switch"_Run_options.html with the "-pk intel Nphi" "command-line switch"_Run_options.html with
keyword/value pairs as specified in the documentation. Here, Nphi = # keyword/value pairs as specified in the documentation. Here, Nphi = #
of Xeon Phi coprocessors/node (ignored without offload of Xeon Phi co-processors/node (ignored without offload
support). Common options to the USER-INTEL package include {omp} to support). Common options to the USER-INTEL package include {omp} to
override any OMP_NUM_THREADS setting and specify the number of OpenMP override any OMP_NUM_THREADS setting and specify the number of OpenMP
threads, {mode} to set the floating-point precision mode, and {lrt} to threads, {mode} to set the floating-point precision mode, and {lrt} to
@ -332,7 +332,7 @@ Examples (see documentation for your MPI/Machine for differences in
launching MPI applications): launching MPI applications):
mpirun -np 72 -ppn 36 lmp_machine -sf intel -in in.script # 2 nodes, 36 MPI tasks/node, $OMP_NUM_THREADS OpenMP Threads mpirun -np 72 -ppn 36 lmp_machine -sf intel -in in.script # 2 nodes, 36 MPI tasks/node, $OMP_NUM_THREADS OpenMP Threads
mpirun -np 72 -ppn 36 lmp_machine -sf intel -in in.script -pk intel 0 omp 2 mode double # Don't use any coprocessors that might be available, use 2 OpenMP threads for each task, use double precision :pre mpirun -np 72 -ppn 36 lmp_machine -sf intel -in in.script -pk intel 0 omp 2 mode double # Don't use any co-processors that might be available, use 2 OpenMP threads for each task, use double precision :pre
[Or run with the USER-INTEL package by editing an input script:] [Or run with the USER-INTEL package by editing an input script:]
@ -364,7 +364,7 @@ intel"_package.html command that can improve performance when using
"PPPM"_kspace_style.html for long-range electrostatics on processors "PPPM"_kspace_style.html for long-range electrostatics on processors
with SMT. It generates an extra pthread for each MPI task. The thread with SMT. It generates an extra pthread for each MPI task. The thread
is dedicated to performing some of the PPPM calculations and MPI is dedicated to performing some of the PPPM calculations and MPI
communications. This feature requires setting the preprocessor flag communications. This feature requires setting the pre-processor flag
-DLMP_INTEL_USELRT in the makefile when compiling LAMMPS. It is unset -DLMP_INTEL_USELRT in the makefile when compiling LAMMPS. It is unset
in the default makefiles ({Makefile.mpi} and {Makefile.serial}) but in the default makefiles ({Makefile.mpi} and {Makefile.serial}) but
it is set in all makefiles tuned for the USER-INTEL package. On Intel it is set in all makefiles tuned for the USER-INTEL package. On Intel
@ -399,7 +399,7 @@ the "suffix hybrid intel omp"_suffix.html command can also be used
within the input script to automatically append the "omp" suffix to within the input script to automatically append the "omp" suffix to
styles when USER-INTEL styles are not available. styles when USER-INTEL styles are not available.
NOTE: For simulations on higher node counts, add "processors * * * NOTE: For simulations on higher node counts, add "processors * * *
grid numa"_processors.html to the beginning of the input script for grid numa"_processors.html to the beginning of the input script for
better scalability. better scalability.
@ -422,29 +422,29 @@ that MPI runs are performed in MCDRAM.
The default settings for offload should give good performance. The default settings for offload should give good performance.
When using LAMMPS with offload to Intel coprocessors, best performance When using LAMMPS with offload to Intel co-processors, best performance
will typically be achieved with concurrent calculations performed on will typically be achieved with concurrent calculations performed on
both the CPU and the coprocessor. This is achieved by offloading only both the CPU and the co-processor. This is achieved by offloading only
a fraction of the neighbor and pair computations to the coprocessor or a fraction of the neighbor and pair computations to the co-processor or
using "hybrid"_pair_hybrid.html pair styles where only one style uses using "hybrid"_pair_hybrid.html pair styles where only one style uses
the "intel" suffix. For simulations with long-range electrostatics or the "intel" suffix. For simulations with long-range electrostatics or
bond, angle, dihedral, improper calculations, computation and data bond, angle, dihedral, improper calculations, computation and data
transfer to the coprocessor will run concurrently with computations transfer to the co-processor will run concurrently with computations
and MPI communications for these calculations on the host CPU. This and MPI communications for these calculations on the host CPU. This
is illustrated in the figure below for the rhodopsin protein benchmark is illustrated in the figure below for the rhodopsin protein benchmark
running on E5-2697v2 processors with a Intel Xeon Phi 7120p running on E5-2697v2 processors with a Intel Xeon Phi 7120p
coprocessor. In this plot, the vertical access is time and routines co-processor. In this plot, the vertical access is time and routines
running at the same time are running concurrently on both the host and running at the same time are running concurrently on both the host and
the coprocessor. the co-processor.
:c,image(JPG/offload_knc.png) :c,image(JPG/offload_knc.png)
The fraction of the offloaded work is controlled by the {balance} The fraction of the offloaded work is controlled by the {balance}
keyword in the "package intel"_package.html command. A balance of 0 keyword in the "package intel"_package.html command. A balance of 0
runs all calculations on the CPU. A balance of 1 runs all runs all calculations on the CPU. A balance of 1 runs all
supported calculations on the coprocessor. A balance of 0.5 runs half supported calculations on the co-processor. A balance of 0.5 runs half
of the calculations on the coprocessor. Setting the balance to -1 of the calculations on the co-processor. Setting the balance to -1
(the default) will enable dynamic load balancing that continously (the default) will enable dynamic load balancing that continuously
adjusts the fraction of offloaded work throughout the simulation. adjusts the fraction of offloaded work throughout the simulation.
Because data transfer cannot be timed, this option typically produces Because data transfer cannot be timed, this option typically produces
results within 5 to 10 percent of the optimal fixed balance. results within 5 to 10 percent of the optimal fixed balance.
@ -455,23 +455,23 @@ near-optimal setting that will carry over to additional runs.
The default for the "package intel"_package.html command is to have The default for the "package intel"_package.html command is to have
all the MPI tasks on a given compute node use a single Xeon Phi all the MPI tasks on a given compute node use a single Xeon Phi
coprocessor. In general, running with a large number of MPI tasks on co-processor. In general, running with a large number of MPI tasks on
each node will perform best with offload. Each MPI task will each node will perform best with offload. Each MPI task will
automatically get affinity to a subset of the hardware threads automatically get affinity to a subset of the hardware threads
available on the coprocessor. For example, if your card has 61 cores, available on the co-processor. For example, if your card has 61 cores,
with 60 cores available for offload and 4 hardware threads per core with 60 cores available for offload and 4 hardware threads per core
(240 total threads), running with 24 MPI tasks per node will cause (240 total threads), running with 24 MPI tasks per node will cause
each MPI task to use a subset of 10 threads on the coprocessor. Fine each MPI task to use a subset of 10 threads on the co-processor. Fine
tuning of the number of threads to use per MPI task or the number of tuning of the number of threads to use per MPI task or the number of
threads to use per core can be accomplished with keyword settings of threads to use per core can be accomplished with keyword settings of
the "package intel"_package.html command. the "package intel"_package.html command.
The USER-INTEL package has two modes for deciding which atoms will be The USER-INTEL package has two modes for deciding which atoms will be
handled by the coprocessor. This choice is controlled with the {ghost} handled by the co-processor. This choice is controlled with the {ghost}
keyword of the "package intel"_package.html command. When set to 0, keyword of the "package intel"_package.html command. When set to 0,
ghost atoms (atoms at the borders between MPI tasks) are not offloaded ghost atoms (atoms at the borders between MPI tasks) are not offloaded
to the card. This allows for overlap of MPI communication of forces to the card. This allows for overlap of MPI communication of forces
with computation on the coprocessor when the "newton"_newton.html with computation on the co-processor when the "newton"_newton.html
setting is "on". The default is dependent on the style being used, setting is "on". The default is dependent on the style being used,
however, better performance may be achieved by setting this option however, better performance may be achieved by setting this option
explicitly. explicitly.
@ -482,21 +482,21 @@ cores. This is due to the fact that additional threads are generated
internally to handle the asynchronous offload tasks. internally to handle the asynchronous offload tasks.
If pair computations are being offloaded to an Intel Xeon Phi If pair computations are being offloaded to an Intel Xeon Phi
coprocessor, a diagnostic line is printed to the screen (not to the co-processor, a diagnostic line is printed to the screen (not to the
log file), during the setup phase of a run, indicating that offload log file), during the setup phase of a run, indicating that offload
mode is being used and indicating the number of coprocessor threads mode is being used and indicating the number of co-processor threads
per MPI task. Additionally, an offload timing summary is printed at per MPI task. Additionally, an offload timing summary is printed at
the end of each run. When offloading, the frequency for "atom the end of each run. When offloading, the frequency for "atom
sorting"_atom_modify.html is changed to 1 so that the per-atom data is sorting"_atom_modify.html is changed to 1 so that the per-atom data is
effectively sorted at every rebuild of the neighbor lists. All the effectively sorted at every rebuild of the neighbor lists. All the
available coprocessor threads on each Phi will be divided among MPI available co-processor threads on each Phi will be divided among MPI
tasks, unless the {tptask} option of the "-pk intel" "command-line tasks, unless the {tptask} option of the "-pk intel" "command-line
switch"_Run_options.html is used to limit the coprocessor threads per switch"_Run_options.html is used to limit the co-processor threads per
MPI task. MPI task.
[Restrictions:] [Restrictions:]
When offloading to a coprocessor, "hybrid"_pair_hybrid.html styles When offloading to a co-processor, "hybrid"_pair_hybrid.html styles
that require skip lists for neighbor builds cannot be offloaded. that require skip lists for neighbor builds cannot be offloaded.
Using "hybrid/overlay"_pair_hybrid.html is allowed. Only one intel Using "hybrid/overlay"_pair_hybrid.html is allowed. Only one intel
accelerated style may be used with hybrid styles when offloading. accelerated style may be used with hybrid styles when offloading.
@ -510,7 +510,7 @@ supported.
[References:] [References:]
Brown, W.M., Carrillo, J.-M.Y., Mishra, B., Gavhane, N., Thakker, F.M., De Kraker, A.R., Yamada, M., Ang, J.A., Plimpton, S.J., "Optimizing Classical Molecular Dynamics in LAMMPS," in Intel Xeon Phi Processor High Performance Programming: Knights Landing Edition, J. Jeffers, J. Reinders, A. Sodani, Eds. Morgan Kaufmann. :ulb,l Brown, W.M., Carrillo, J.-M.Y., Mishra, B., Gavhane, N., Thakkar, F.M., De Kraker, A.R., Yamada, M., Ang, J.A., Plimpton, S.J., "Optimizing Classical Molecular Dynamics in LAMMPS," in Intel Xeon Phi Processor High Performance Programming: Knights Landing Edition, J. Jeffers, J. Reinders, A. Sodani, Eds. Morgan Kaufmann. :ulb,l
Brown, W. M., Semin, A., Hebenstreit, M., Khvostov, S., Raman, K., Plimpton, S.J. "Increasing Molecular Dynamics Simulation Rates with an 8-Fold Increase in Electrical Power Efficiency."_http://dl.acm.org/citation.cfm?id=3014915 2016 High Performance Computing, Networking, Storage and Analysis, SC16: International Conference (pp. 82-95). :l Brown, W. M., Semin, A., Hebenstreit, M., Khvostov, S., Raman, K., Plimpton, S.J. "Increasing Molecular Dynamics Simulation Rates with an 8-Fold Increase in Electrical Power Efficiency."_http://dl.acm.org/citation.cfm?id=3014915 2016 High Performance Computing, Networking, Storage and Analysis, SC16: International Conference (pp. 82-95). :l

View File

@ -13,11 +13,11 @@ Kokkos is a templated C++ library that provides abstractions to allow
a single implementation of an application kernel (e.g. a pair style) a single implementation of an application kernel (e.g. a pair style)
to run efficiently on different kinds of hardware, such as GPUs, Intel to run efficiently on different kinds of hardware, such as GPUs, Intel
Xeon Phis, or many-core CPUs. Kokkos maps the C++ kernel onto Xeon Phis, or many-core CPUs. Kokkos maps the C++ kernel onto
different backend languages such as CUDA, OpenMP, or Pthreads. The different back end languages such as CUDA, OpenMP, or Pthreads. The
Kokkos library also provides data abstractions to adjust (at compile Kokkos library also provides data abstractions to adjust (at compile
time) the memory layout of data structures like 2d and 3d arrays to time) the memory layout of data structures like 2d and 3d arrays to
optimize performance on different hardware. For more information on optimize performance on different hardware. For more information on
Kokkos, see "Github"_https://github.com/kokkos/kokkos. Kokkos is part Kokkos, see "GitHub"_https://github.com/kokkos/kokkos. Kokkos is part
of "Trilinos"_http://trilinos.sandia.gov/packages/kokkos. The Kokkos of "Trilinos"_http://trilinos.sandia.gov/packages/kokkos. The Kokkos
library was written primarily by Carter Edwards, Christian Trott, and library was written primarily by Carter Edwards, Christian Trott, and
Dan Sunderland (all Sandia). Dan Sunderland (all Sandia).
@ -106,10 +106,10 @@ modification to the input script is needed. Alternatively, one can run
with the KOKKOS package by editing the input script as described with the KOKKOS package by editing the input script as described
below. below.
NOTE: When using a single OpenMP thread, the Kokkos Serial backend (i.e. NOTE: When using a single OpenMP thread, the Kokkos Serial back end (i.e.
Makefile.kokkos_mpi_only) will give better performance than the OpenMP Makefile.kokkos_mpi_only) will give better performance than the OpenMP
backend (i.e. Makefile.kokkos_omp) because some of the overhead to make back end (i.e. Makefile.kokkos_omp) because some of the overhead to make
the code thread-safe is removed. the code thread-safe is removed.
NOTE: The default for the "package kokkos"_package.html command is to NOTE: The default for the "package kokkos"_package.html command is to
use "full" neighbor lists and set the Newton flag to "off" for both use "full" neighbor lists and set the Newton flag to "off" for both
@ -127,21 +127,21 @@ mpirun -np 16 lmp_kokkos_mpi_only -k on -sf kk -pk kokkos newton on neigh half c
If the "newton"_newton.html command is used in the input If the "newton"_newton.html command is used in the input
script, it can also override the Newton flag defaults. script, it can also override the Newton flag defaults.
For half neighbor lists and OpenMP, the KOKKOS package uses data For half neighbor lists and OpenMP, the KOKKOS package uses data
duplication (i.e. thread-private arrays) by default to avoid duplication (i.e. thread-private arrays) by default to avoid
thread-level write conflicts in the force arrays (and other data thread-level write conflicts in the force arrays (and other data
structures as necessary). Data duplication is typically fastest for structures as necessary). Data duplication is typically fastest for
small numbers of threads (i.e. 8 or less) but does increase memory small numbers of threads (i.e. 8 or less) but does increase memory
footprint and is not scalable to large numbers of threads. An footprint and is not scalable to large numbers of threads. An
alternative to data duplication is to use thread-level atomics, which alternative to data duplication is to use thread-level atomic operations
don't require duplication. The use of atomics can be forced by compiling which do not require data duplication. The use of atomic operations can
with the "-DLMP_KOKKOS_USE_ATOMICS" compile switch. Most but not all be enforced by compiling LAMMPS with the "-DLMP_KOKKOS_USE_ATOMICS"
Kokkos-enabled pair_styles support data duplication. Alternatively, full pre-processor flag. Most but not all Kokkos-enabled pair_styles support
neighbor lists avoid the need for duplication or atomics but require data duplication. Alternatively, full neighbor lists avoid the need for
more compute operations per atom. When using the Kokkos Serial backend duplication or atomic operations but require more compute operations per
or the OpenMP backend with a single thread, no duplication or atomics are atom. When using the Kokkos Serial back end or the OpenMP back end with
used. For CUDA and half neighbor lists, the KOKKOS package always uses a single thread, no duplication or atomic operations are used. For CUDA
atomics. and half neighbor lists, the KOKKOS package always uses atomic operations.
[Core and Thread Affinity:] [Core and Thread Affinity:]
@ -193,7 +193,7 @@ threads/task as Nt. The product of these two values should be N, i.e.
NOTE: The default for the "package kokkos"_package.html command is to NOTE: The default for the "package kokkos"_package.html command is to
use "full" neighbor lists and set the Newton flag to "off" for both use "full" neighbor lists and set the Newton flag to "off" for both
pairwise and bonded interactions. When running on KNL, this will pairwise and bonded interactions. When running on KNL, this will
typically be best for pair-wise potentials. For manybody potentials, typically be best for pair-wise potentials. For many-body potentials,
using "half" neighbor lists and setting the Newton flag to "on" may be using "half" neighbor lists and setting the Newton flag to "on" may be
faster. It can also be faster to use non-threaded communication. Use faster. It can also be faster to use non-threaded communication. Use
the "-pk kokkos" "command-line switch"_Run_options.html to change the the "-pk kokkos" "command-line switch"_Run_options.html to change the
@ -207,7 +207,7 @@ mpirun -np 64 lmp_kokkos_phi -k on t 4 -sf kk -pk kokkos newton on neigh half co
NOTE: MPI tasks and threads should be bound to cores as described NOTE: MPI tasks and threads should be bound to cores as described
above for CPUs. above for CPUs.
NOTE: To build with Kokkos support for Intel Xeon Phi coprocessors NOTE: To build with Kokkos support for Intel Xeon Phi co-processors
such as Knight's Corner (KNC), your system must be configured to use such as Knight's Corner (KNC), your system must be configured to use
them in "native" mode, not "offload" mode like the USER-INTEL package them in "native" mode, not "offload" mode like the USER-INTEL package
supports. supports.

View File

@ -131,7 +131,7 @@ effect worsens when using an increasing number of nodes. :l
The system has a spatially inhomogeneous particle density which does The system has a spatially inhomogeneous particle density which does
not map well to the "domain decomposition scheme"_processors.html or not map well to the "domain decomposition scheme"_processors.html or
"load-balancing"_balance.html options that LAMMPS provides. This is "load-balancing"_balance.html options that LAMMPS provides. This is
because multi-threading achives parallelism over the number of because multi-threading achieves parallelism over the number of
particles, not via their distribution in space. :l particles, not via their distribution in space. :l
A machine is being used in "capability mode", i.e. near the point A machine is being used in "capability mode", i.e. near the point
@ -143,7 +143,7 @@ the performance-limiting factor. Using multi-threading allows less
MPI tasks to be invoked and can speed-up the long-range solver, while MPI tasks to be invoked and can speed-up the long-range solver, while
increasing overall performance by parallelizing the pairwise and increasing overall performance by parallelizing the pairwise and
bonded calculations via OpenMP. Likewise additional speedup can be bonded calculations via OpenMP. Likewise additional speedup can be
sometimes be achived by increasing the length of the Coulombic cutoff sometimes be achieved by increasing the length of the Coulombic cutoff
and thus reducing the work done by the long-range solver. Using the and thus reducing the work done by the long-range solver. Using the
"run_style verlet/split"_run_style.html command, which is compatible "run_style verlet/split"_run_style.html command, which is compatible
with the USER-OMP package, is an alternative way to reduce the number with the USER-OMP package, is an alternative way to reduce the number

View File

@ -14,7 +14,7 @@ Accelerated versions of various "pair_style"_pair_style.html,
been added to LAMMPS, which will typically run faster than the been added to LAMMPS, which will typically run faster than the
standard non-accelerated versions. Some require appropriate hardware standard non-accelerated versions. Some require appropriate hardware
to be present on your system, e.g. GPUs or Intel Xeon Phi to be present on your system, e.g. GPUs or Intel Xeon Phi
coprocessors. co-processors.
All of these commands are in packages provided with LAMMPS. An All of these commands are in packages provided with LAMMPS. An
overview of packages is give on the "Packages"_Packages.html doc overview of packages is give on the "Packages"_Packages.html doc
@ -161,7 +161,7 @@ package. These styles support vectorized single and mixed precision
calculations, in addition to full double precision. In extreme cases, calculations, in addition to full double precision. In extreme cases,
this can provide speedups over 3.5x on CPUs. The package also this can provide speedups over 3.5x on CPUs. The package also
supports acceleration in "offload" mode to Intel(R) Xeon Phi(TM) supports acceleration in "offload" mode to Intel(R) Xeon Phi(TM)
coprocessors. This can result in additional speedup over 2x depending co-processors. This can result in additional speedup over 2x depending
on the hardware configuration. :l on the hardware configuration. :l
Styles with a "kk" suffix are part of the KOKKOS package, and can be Styles with a "kk" suffix are part of the KOKKOS package, and can be

View File

@ -163,7 +163,7 @@ for the "chain benchmark"_Speed_bench.html.
colvars tools :h4,link(colvars) colvars tools :h4,link(colvars)
The colvars directory contains a collection of tools for postprocessing The colvars directory contains a collection of tools for post-processing
data produced by the colvars collective variable library. data produced by the colvars collective variable library.
To compile the tools, edit the makefile for your system and run "make". To compile the tools, edit the makefile for your system and run "make".
@ -263,7 +263,7 @@ These tools were provided by Andres Jaramillo-Botero at CalTech
emacs tool :h4,link(emacs) emacs tool :h4,link(emacs)
The tools/emacs directory contains an Emacs Lisp add-on file for GNU Emacs The tools/emacs directory contains an Emacs Lisp add-on file for GNU Emacs
that enables a lammps-mode for editing input scripts when using GNU Emacs, that enables a lammps-mode for editing input scripts when using GNU Emacs,
with various highlighting options set up. with various highlighting options set up.
@ -406,15 +406,15 @@ supports it. It has its own WWW page at
msi2lmp tool :h4,link(msi) msi2lmp tool :h4,link(msi)
The msi2lmp sub-directory contains a tool for creating LAMMPS template The msi2lmp sub-directory contains a tool for creating LAMMPS template
input and data files from BIOVIA's Materias Studio files (formerly Accelrys' input and data files from BIOVIA's Materias Studio files (formerly
Insight MD code, formerly MSI/Biosym and its Discover MD code). Accelrys' Insight MD code, formerly MSI/Biosym and its Discover MD code).
This tool was written by John Carpenter (Cray), Michael Peachey This tool was written by John Carpenter (Cray), Michael Peachey
(Cray), and Steve Lustig (Dupont). Several people contributed changes (Cray), and Steve Lustig (Dupont). Several people contributed changes
to remove bugs and adapt its output to changes in LAMMPS. to remove bugs and adapt its output to changes in LAMMPS.
This tool has several known limitations and is no longer under active This tool has several known limitations and is no longer under active
development, so there are no changes except for the occasional bugfix. development, so there are no changes except for the occasional bug fix.
See the README file in the tools/msi2lmp folder for more information. See the README file in the tools/msi2lmp folder for more information.

View File

@ -60,26 +60,14 @@ doc page for details.
:line :line
Here is an alphabetic list of angle styles defined in LAMMPS. Click on The list of all angle styles defined in LAMMPS is given on the
the style to display the formula it computes and coefficients "angle_style"_angle_style.html doc page. They are also listed in more
specified by the associated "angle_coeff"_angle_coeff.html command. compact form on the "Commands angle"_Commands_bond.html#angle doc
Note that there are also additional angle styles submitted by users
which are included in the LAMMPS distribution. The full list of all
angle styles is on the "Commands bond"_Commands_bond.html#angle doc
page. page.
"angle_style none"_angle_none.html - turn off angle interactions On either of those pages, click on the style to display the formula it
"angle_style hybrid"_angle_hybrid.html - define multiple styles of angle interactions :ul computes and its coefficients as specified by the associated
angle_coeff command.
"angle_style charmm"_angle_charmm.html - CHARMM angle
"angle_style class2"_angle_class2.html - COMPASS (class 2) angle
"angle_style cosine"_angle_cosine.html - cosine angle potential
"angle_style cosine/delta"_angle_cosine_delta.html - difference of cosines angle potential
"angle_style cosine/periodic"_angle_cosine_periodic.html - DREIDING angle
"angle_style cosine/squared"_angle_cosine_squared.html - cosine squared angle potential
"angle_style harmonic"_angle_harmonic.html - harmonic angle
"angle_style table"_angle_table.html - tabulated by angle :ul
:line :line

View File

@ -23,19 +23,19 @@ The {cosine/buck6d} angle style uses the potential
:c,image(Eqs/angle_cosine_buck6d.jpg) :c,image(Eqs/angle_cosine_buck6d.jpg)
where K is the energy constant, n is the periodic multiplicity and where K is the energy constant, n is the periodic multiplicity and
Theta0 is the equilibrium angle. Theta0 is the equilibrium angle.
The coefficients must be defined for each angle type via the The coefficients must be defined for each angle type via the
"angle_coeff"_angle_coeff.html command as in the example above, or in "angle_coeff"_angle_coeff.html command as in the example above, or in
the data file or restart files read by the "read_data"_read_data.html the data file or restart files read by the "read_data"_read_data.html
or "read_restart"_read_restart.html commands in the following order: or "read_restart"_read_restart.html commands in the following order:
K (energy) K (energy)
n n
Theta0 (degrees) :ul Theta0 (degrees) :ul
Theta0 is specified in degrees, but LAMMPS converts it to radians Theta0 is specified in degrees, but LAMMPS converts it to radians
internally. internally.
Additional to the cosine term the {cosine/buck6d} angle style computes Additional to the cosine term the {cosine/buck6d} angle style computes
@ -51,8 +51,8 @@ the "special_bonds"_special_bonds.html 1-3 interactions to be weighted
[Restrictions:] [Restrictions:]
{cosine/buck6d} can only be used in combination with the {cosine/buck6d} can only be used in combination with the
"pair_buck6d"_pair_buck6d_coul_gauss.html style and with a "pair_buck6d"_pair_buck6d_coul_gauss.html style and with a
"special_bonds"_special_bonds.html 0.0 weighting of 1-3 interactions. "special_bonds"_special_bonds.html 0.0 weighting of 1-3 interactions.
This angle style can only be used if LAMMPS was built with the This angle style can only be used if LAMMPS was built with the
USER-MOFFF package. See the "Build package"_Build_package.html doc USER-MOFFF package. See the "Build package"_Build_package.html doc

View File

@ -63,7 +63,7 @@ instructions on how to use the accelerated styles effectively.
[Restrictions:] [Restrictions:]
This angle style can only be used if LAMMPS was built with the This angle style can only be used if LAMMPS was built with the
USER-MISC package. USER-MISC package.
[Related commands:] [Related commands:]

View File

@ -28,7 +28,7 @@ The {sdk} angle style is a combination of the harmonic angle potential,
where theta0 is the equilibrium value of the angle and K a prefactor, where theta0 is the equilibrium value of the angle and K a prefactor,
with the {repulsive} part of the non-bonded {lj/sdk} pair style with the {repulsive} part of the non-bonded {lj/sdk} pair style
between the atoms 1 and 3. This angle potential is intended for between the atoms 1 and 3. This angle potential is intended for
coarse grained MD simulations with the CMM parametrization using the coarse grained MD simulations with the CMM parameterization using the
"pair_style lj/sdk"_pair_sdk.html. Relative to the pair_style "pair_style lj/sdk"_pair_sdk.html. Relative to the pair_style
{lj/sdk}, however, the energy is shifted by {epsilon}, to avoid sudden {lj/sdk}, however, the energy is shifted by {epsilon}, to avoid sudden
jumps. Note that the usual 1/2 factor is included in K. jumps. Note that the usual 1/2 factor is included in K.

View File

@ -57,10 +57,15 @@ Here is an alphabetic list of angle styles defined in LAMMPS. Click on
the style to display the formula it computes and coefficients the style to display the formula it computes and coefficients
specified by the associated "angle_coeff"_angle_coeff.html command. specified by the associated "angle_coeff"_angle_coeff.html command.
Note that there are also additional angle styles submitted by users Click on the style to display the formula it computes, any additional
which are included in the LAMMPS distribution. The full list of all arguments specified in the angle_style command, and coefficients
angle styles are is on the "Commands bond"_Commands_bond.html#angle specified by the associated "angle_coeff"_angle_coeff.html command.
doc page.
There are also additional accelerated pair styles included in the
LAMMPS distribution for faster performance on CPUs, GPUs, and KNLs.
The individual style names on the "Commands
angle"_Commands_bond.html#angle doc page are followed by one or more
of (g,i,k,o,t) to indicate which accelerated styles exist.
"none"_angle_none.html - turn off angle interactions "none"_angle_none.html - turn off angle interactions
"zero"_angle_zero.html - topology but no interactions "zero"_angle_zero.html - topology but no interactions

View File

@ -166,7 +166,8 @@ info), a map is used. The default map style is array if no atom ID is
larger than 1 million, otherwise the default is hash. By default, a larger than 1 million, otherwise the default is hash. By default, a
"first" group is not defined. By default, sorting is enabled with a "first" group is not defined. By default, sorting is enabled with a
frequency of 1000 and a binsize of 0.0, which means the neighbor frequency of 1000 and a binsize of 0.0, which means the neighbor
cutoff will be used to set the bin size. cutoff will be used to set the bin size. If no neighbor cutoff is
defined, sorting will be turned off.
:line :line

View File

@ -39,7 +39,7 @@ atom_style body nparticle 2 10
atom_style hybrid charge bond atom_style hybrid charge bond
atom_style hybrid charge body nparticle 2 5 atom_style hybrid charge body nparticle 2 5
atom_style spin atom_style spin
atom_style template myMols atom_style template myMols
atom_style tdpd 2 :pre atom_style tdpd 2 :pre
[Description:] [Description:]
@ -87,7 +87,7 @@ quantities.
{line} | end points, angular velocity | rigid bodies | {line} | end points, angular velocity | rigid bodies |
{meso} | rho, e, cv | SPH particles | {meso} | rho, e, cv | SPH particles |
{molecular} | bonds, angles, dihedrals, impropers | uncharged molecules | {molecular} | bonds, angles, dihedrals, impropers | uncharged molecules |
{peri} | mass, volume | mesocopic Peridynamic models | {peri} | mass, volume | mesoscopic Peridynamic models |
{smd} | volume, kernel diameter, contact radius, mass | solid and fluid SPH particles | {smd} | volume, kernel diameter, contact radius, mass | solid and fluid SPH particles |
{sphere} | diameter, mass, angular velocity | granular models | {sphere} | diameter, mass, angular velocity | granular models |
{spin} | magnetic moment | system with magnetic particles | {spin} | magnetic moment | system with magnetic particles |
@ -309,9 +309,9 @@ force fields"_pair_eff.html.
The {dpd} style is part of the USER-DPD package for dissipative The {dpd} style is part of the USER-DPD package for dissipative
particle dynamics (DPD). particle dynamics (DPD).
The {edpd}, {mdpd}, and {tdpd} styles are part of the USER-MESO package The {edpd}, {mdpd}, and {tdpd} styles are part of the USER-MESO package
for energy-conserving dissipative particle dynamics (eDPD), many-body for energy-conserving dissipative particle dynamics (eDPD), many-body
dissipative particle dynamics (mDPD), and transport dissipative particle dissipative particle dynamics (mDPD), and transport dissipative particle
dynamics (tDPD), respectively. dynamics (tDPD), respectively.
The {meso} style is part of the USER-SPH package for smoothed particle The {meso} style is part of the USER-SPH package for smoothed particle

View File

@ -247,7 +247,7 @@ to {Niter} times. After each dimension finishes, the imbalance factor
is re-computed, and the balancing operation halts if the {stopthresh} is re-computed, and the balancing operation halts if the {stopthresh}
criterion is met. criterion is met.
A rebalance operation in a single dimension is performed using a A re-balance operation in a single dimension is performed using a
recursive multisectioning algorithm, where the position of each recursive multisectioning algorithm, where the position of each
cutting plane (line in 2d) in the dimension is adjusted independently. cutting plane (line in 2d) in the dimension is adjusted independently.
This is similar to a recursive bisectioning for a single value, except This is similar to a recursive bisectioning for a single value, except
@ -261,11 +261,11 @@ information, so that they become closer together over time. Thus as
the recursion progresses, the count of particles on either side of the the recursion progresses, the count of particles on either side of the
plane gets closer to the target value. plane gets closer to the target value.
Once the rebalancing is complete and final processor sub-domains Once the re-balancing is complete and final processor sub-domains
assigned, particles are migrated to their new owning processor, and assigned, particles are migrated to their new owning processor, and
the balance procedure ends. the balance procedure ends.
NOTE: At each rebalance operation, the bisectioning for each cutting NOTE: At each re-balance operation, the bisectioning for each cutting
plane (line in 2d) typically starts with low and high bounds separated plane (line in 2d) typically starts with low and high bounds separated
by the extent of a processor's sub-domain in one dimension. The size by the extent of a processor's sub-domain in one dimension. The size
of this bracketing region shrinks by 1/2 every iteration. Thus if of this bracketing region shrinks by 1/2 every iteration. Thus if
@ -348,7 +348,7 @@ specified groups, its weight is not changed. If it belongs to
multiple groups, its weight is the product of the weight factors. multiple groups, its weight is the product of the weight factors.
This weight style is useful in combination with pair style This weight style is useful in combination with pair style
"hybrid"_pair_hybrid.html, e.g. when combining a more costly manybody "hybrid"_pair_hybrid.html, e.g. when combining a more costly many-body
potential with a fast pair-wise potential. It is also useful when potential with a fast pair-wise potential. It is also useful when
using "run_style respa"_run_style.html where some portions of the using "run_style respa"_run_style.html where some portions of the
system have many bonded interactions and others none. It assumes that system have many bonded interactions and others none. It assumes that
@ -510,10 +510,13 @@ each processor, instead of 4, and "SQUARES" replaced by "CUBES".
For 2d simulations, the {z} style cannot be used. Nor can a "z" For 2d simulations, the {z} style cannot be used. Nor can a "z"
appear in {dimstr} for the {shift} style. appear in {dimstr} for the {shift} style.
Balancing through recursive bisectioning ({rcb} style) requires
"comm_style tiled"_comm_style.html
[Related commands:] [Related commands:]
"group"_group.html, "processors"_processors.html, "group"_group.html, "processors"_processors.html,
"fix balance"_fix_balance.html "fix balance"_fix_balance.html, "comm_style"_comm_style.html
[Default:] none [Default:] none
:link(pizza,http://pizza.sandia.gov) :link(pizza,http://pizza.sandia.gov)

View File

@ -56,25 +56,13 @@ corresponds to the 1st example above would be listed as
:line :line
Here is an alphabetic list of bond styles defined in LAMMPS. Click on The list of all bond styles defined in LAMMPS is given on the
the style to display the formula it computes and coefficients "bond_style"_bond_style.html doc page. They are also listed in more
specified by the associated "bond_coeff"_bond_coeff.html command. compact form on the "Commands bond"_Commands_bond.html doc page.
Note that here are also additional bond styles submitted by users On either of those pages, click on the style to display the formula it
which are included in the LAMMPS distribution. The full list of all computes and its coefficients as specified by the associated
bond styles is on the "Commands bond"_Commands_bond.html doc page. bond_coeff command.
"bond_style none"_bond_none.html - turn off bonded interactions
"bond_style hybrid"_bond_hybrid.html - define multiple styles of bond interactions :ul
"bond_style class2"_bond_class2.html - COMPASS (class 2) bond
"bond_style fene"_bond_fene.html - FENE (finite-extensible non-linear elastic) bond
"bond_style fene/expand"_bond_fene_expand.html - FENE bonds with variable size particles
"bond_style harmonic"_bond_harmonic.html - harmonic bond
"bond_style morse"_bond_morse.html - Morse bond
"bond_style nonlinear"_bond_nonlinear.html - nonlinear bond
"bond_style quartic"_bond_quartic.html - breakable quartic bond
"bond_style table"_bond_table.html - tabulated by bond length :ul
:line :line

View File

@ -52,7 +52,7 @@ hydrogen-bonding interaction {oxdna/hbond} (see also documentation of
"(Snodin)"_#oxdna2 bond style the analogous pair styles and an "(Snodin)"_#oxdna2 bond style the analogous pair styles and an
additional Debye-Hueckel pair style {oxdna2/dh} have to be defined. additional Debye-Hueckel pair style {oxdna2/dh} have to be defined.
The coefficients in the above example have to be kept fixed and cannot The coefficients in the above example have to be kept fixed and cannot
be changed without reparametrizing the entire model. be changed without reparameterizing the entire model.
Example input and data files for DNA duplexes can be found in Example input and data files for DNA duplexes can be found in
examples/USER/cgdna/examples/oxDNA/ and /oxDNA2/. A simple python examples/USER/cgdna/examples/oxDNA/ and /oxDNA2/. A simple python

View File

@ -65,9 +65,15 @@ Here is an alphabetic list of bond styles defined in LAMMPS. Click on
the style to display the formula it computes and coefficients the style to display the formula it computes and coefficients
specified by the associated "bond_coeff"_bond_coeff.html command. specified by the associated "bond_coeff"_bond_coeff.html command.
Note that there are also additional bond styles submitted by users Click on the style to display the formula it computes, any additional
which are included in the LAMMPS distribution. The full list of all arguments specified in the bond_style command, and coefficients
bond styles is on the "Commands bond"_Commands_bond.html doc page. specified by the associated "bond_coeff"_bond_coeff.html command.
There are also additional accelerated pair styles included in the
LAMMPS distribution for faster performance on CPUs, GPUs, and KNLs.
The individual style names on the "Commands bond"_Commands_bond.html
doc page are followed by one or more of (g,i,k,o,t) to indicate which
accelerated styles exist.
"none"_bond_none.html - turn off bonded interactions "none"_bond_none.html - turn off bonded interactions
"zero"_bond_zero.html - topology but no interactions "zero"_bond_zero.html - topology but no interactions
@ -83,7 +89,7 @@ bond styles is on the "Commands bond"_Commands_bond.html doc page.
"morse"_bond_morse.html - Morse bond "morse"_bond_morse.html - Morse bond
"nonlinear"_bond_nonlinear.html - nonlinear bond "nonlinear"_bond_nonlinear.html - nonlinear bond
"oxdna/fene"_bond_oxdna.html - modified FENE bond suitable for DNA modeling "oxdna/fene"_bond_oxdna.html - modified FENE bond suitable for DNA modeling
"oxdna2/fene"_bond_oxdna.html - same as oxdna but used with different pair styles "oxdna2/fene"_bond_oxdna.html - same as oxdna but used with different pair styles
"quartic"_bond_quartic.html - breakable quartic bond "quartic"_bond_quartic.html - breakable quartic bond
"table"_bond_table.html - tabulated by bond length :ul "table"_bond_table.html - tabulated by bond length :ul

View File

@ -154,6 +154,6 @@ Communication mode {multi} is currently only available for
[Default:] [Default:]
The option defauls are mode = single, group = all, cutoff = 0.0, vel = The option defaults are mode = single, group = all, cutoff = 0.0, vel =
no. The cutoff default of 0.0 means that ghost cutoff = neighbor no. The cutoff default of 0.0 means that ghost cutoff = neighbor
cutoff = pairwise force cutoff + neighbor skin. cutoff = pairwise force cutoff + neighbor skin.

View File

@ -51,7 +51,10 @@ decomposition will be the same, as described by
commands. The decomposition can be changed via the commands. The decomposition can be changed via the
"balance"_balance.html or "fix balance"_fix_balance.html commands. "balance"_balance.html or "fix balance"_fix_balance.html commands.
[Restrictions:] none [Restrictions:]
Communication style {tiled} cannot be used with {triclinic} simulation
cells.
[Related commands:] [Related commands:]

View File

@ -44,6 +44,7 @@ Commands :h1
fix_modify fix_modify
group group
group2ndx group2ndx
hyper
if if
improper_coeff improper_coeff
improper_style improper_style

View File

@ -164,24 +164,20 @@ and what it does. Here is an alphabetic list of compute styles
available in LAMMPS. They are also listed in more compact form on the available in LAMMPS. They are also listed in more compact form on the
"Commands compute"_Commands_compute.html doc page. "Commands compute"_Commands_compute.html doc page.
There are also additional compute styles (not listed here) submitted
by users which are included in the LAMMPS distribution. The full list
of all compute styles is on the "Commands
compute"_Commands_compute.html doc page.
There are also additional accelerated compute styles included in the There are also additional accelerated compute styles included in the
LAMMPS distribution for faster performance on CPUs, GPUs, and KNLs. LAMMPS distribution for faster performance on CPUs, GPUs, and KNLs.
The individual style names on the "Commands The individual style names on the "Commands
compute"_Commands_compute.html doc page are followed by one or more of compute"_Commands_compute.html doc page are followed by one or more of
(g,i,k,o,t) to indicate which accelerated styles exist. (g,i,k,o,t) to indicate which accelerated styles exist.
"ackland/atom"_compute_ackland_atom.html - "ackland/atom"_compute_ackland_atom.html -
"adf"_compute_adf.html - angular distribution function of triples of atoms
"aggregate/atom"_compute_cluster_atom.html - aggregate ID for each atom "aggregate/atom"_compute_cluster_atom.html - aggregate ID for each atom
"angle"_compute_angle.html - "angle"_compute_angle.html -
"angle/local"_compute_angle_local.html - "angle/local"_compute_angle_local.html -
"angle/local"_compute_bond_local.html - theta and energy of each angle "angle/local"_compute_bond_local.html - theta and energy of each angle
"angmom/chunk"_compute_angmom_chunk.html - angular momentum for each chunk "angmom/chunk"_compute_angmom_chunk.html - angular momentum for each chunk
"basal/atom"_compute_basal_atom.html - "basal/atom"_compute_basal_atom.html -
"body/local"_compute_body_local.html - attributes of body sub-particles "body/local"_compute_body_local.html - attributes of body sub-particles
"bond"_compute_bond.html - values computed by a bond style "bond"_compute_bond.html - values computed by a bond style
"bond/local"_compute_bond_local.html - distance and energy of each bond "bond/local"_compute_bond_local.html - distance and energy of each bond
@ -190,48 +186,48 @@ compute"_Commands_compute.html doc page are followed by one or more of
"chunk/spread/atom"_compute_chunk_spread_atom.html - spreads chunk values to each atom in chunk "chunk/spread/atom"_compute_chunk_spread_atom.html - spreads chunk values to each atom in chunk
"cluster/atom"_compute_cluster_atom.html - cluster ID for each atom "cluster/atom"_compute_cluster_atom.html - cluster ID for each atom
"cna/atom"_compute_cna_atom.html - common neighbor analysis (CNA) for each atom "cna/atom"_compute_cna_atom.html - common neighbor analysis (CNA) for each atom
"cnp/atom"_compute_cnp_atom.html - "cnp/atom"_compute_cnp_atom.html -
"com"_compute_com.html - center-of-mass of group of atoms "com"_compute_com.html - center-of-mass of group of atoms
"com/chunk"_compute_com_chunk.html - center-of-mass for each chunk "com/chunk"_compute_com_chunk.html - center-of-mass for each chunk
"contact/atom"_compute_contact_atom.html - contact count for each spherical particle "contact/atom"_compute_contact_atom.html - contact count for each spherical particle
"coord/atom"_compute_coord_atom.html - coordination number for each atom "coord/atom"_compute_coord_atom.html - coordination number for each atom
"damage/atom"_compute_damage_atom.html - Peridynamic damage for each atom "damage/atom"_compute_damage_atom.html - Peridynamic damage for each atom
"dihedral"_compute_dihedral.html - "dihedral"_compute_dihedral.html -
"dihedral/local"_compute_dihedral_local.html - angle of each dihedral "dihedral/local"_compute_dihedral_local.html - angle of each dihedral
"dilatation/atom"_compute_dilatation_atom.html - Peridynamic dilatation for each atom "dilatation/atom"_compute_dilatation_atom.html - Peridynamic dilatation for each atom
"dipole/chunk"_compute_dipole_chunk.html - "dipole/chunk"_compute_dipole_chunk.html -
"displace/atom"_compute_displace_atom.html - displacement of each atom "displace/atom"_compute_displace_atom.html - displacement of each atom
"dpd"_compute_dpd.html - "dpd"_compute_dpd.html -
"dpd/atom"_compute_dpd_atom.html - "dpd/atom"_compute_dpd_atom.html -
"edpd/temp/atom"_compute_edpd_temp_atom.html - "edpd/temp/atom"_compute_edpd_temp_atom.html -
"entropy/atom"_compute_entropy_atom.html - "entropy/atom"_compute_entropy_atom.html -
"erotate/asphere"_compute_erotate_asphere.html - rotational energy of aspherical particles "erotate/asphere"_compute_erotate_asphere.html - rotational energy of aspherical particles
"erotate/rigid"_compute_erotate_rigid.html - rotational energy of rigid bodies "erotate/rigid"_compute_erotate_rigid.html - rotational energy of rigid bodies
"erotate/sphere"_compute_erotate_sphere.html - rotational energy of spherical particles "erotate/sphere"_compute_erotate_sphere.html - rotational energy of spherical particles
"erotate/sphere/atom"_compute_erotate_sphere.html - rotational energy for each spherical particle "erotate/sphere/atom"_compute_erotate_sphere.html - rotational energy for each spherical particle
"erotate/sphere/atom"_compute_erotate_sphere_atom.html - "erotate/sphere/atom"_compute_erotate_sphere_atom.html -
"event/displace"_compute_event_displace.html - detect event on atom displacement "event/displace"_compute_event_displace.html - detect event on atom displacement
"fep"_compute_fep.html - "fep"_compute_fep.html -
"force/tally"_compute_tally.html - "force/tally"_compute_tally.html -
"fragment/atom"_compute_cluster_atom.html - fragment ID for each atom "fragment/atom"_compute_cluster_atom.html - fragment ID for each atom
"global/atom"_compute_global_atom.html - "global/atom"_compute_global_atom.html -
"group/group"_compute_group_group.html - energy/force between two groups of atoms "group/group"_compute_group_group.html - energy/force between two groups of atoms
"gyration"_compute_gyration.html - radius of gyration of group of atoms "gyration"_compute_gyration.html - radius of gyration of group of atoms
"gyration/chunk"_compute_gyration_chunk.html - radius of gyration for each chunk "gyration/chunk"_compute_gyration_chunk.html - radius of gyration for each chunk
"heat/flux"_compute_heat_flux.html - heat flux through a group of atoms "heat/flux"_compute_heat_flux.html - heat flux through a group of atoms
"heat/flux/tally"_compute_tally.html - "heat/flux/tally"_compute_tally.html -
"hexorder/atom"_compute_hexorder_atom.html - bond orientational order parameter q6 "hexorder/atom"_compute_hexorder_atom.html - bond orientational order parameter q6
"improper"_compute_improper.html - "improper"_compute_improper.html -
"improper/local"_compute_improper_local.html - angle of each improper "improper/local"_compute_improper_local.html - angle of each improper
"inertia/chunk"_compute_inertia_chunk.html - inertia tensor for each chunk "inertia/chunk"_compute_inertia_chunk.html - inertia tensor for each chunk
"ke"_compute_ke.html - translational kinetic energy "ke"_compute_ke.html - translational kinetic energy
"ke/atom"_compute_ke_atom.html - kinetic energy for each atom "ke/atom"_compute_ke_atom.html - kinetic energy for each atom
"ke/atom/eff"_compute_ke_atom_eff.html - "ke/atom/eff"_compute_ke_atom_eff.html -
"ke/eff"_compute_ke_eff.html - "ke/eff"_compute_ke_eff.html -
"ke/rigid"_compute_ke_rigid.html - translational kinetic energy of rigid bodies "ke/rigid"_compute_ke_rigid.html - translational kinetic energy of rigid bodies
"meso/e/atom"_compute_meso_e_atom.html - "meso/e/atom"_compute_meso_e_atom.html -
"meso/rho/atom"_compute_meso_rho_atom.html - "meso/rho/atom"_compute_meso_rho_atom.html -
"meso/t/atom"_compute_meso_t_atom.html - "meso/t/atom"_compute_meso_t_atom.html -
"msd"_compute_msd.html - mean-squared displacement of group of atoms "msd"_compute_msd.html - mean-squared displacement of group of atoms
"msd/chunk"_compute_msd_chunk.html - mean-squared displacement for each chunk "msd/chunk"_compute_msd_chunk.html - mean-squared displacement for each chunk
"msd/nongauss"_compute_msd_nongauss.html - MSD and non-Gaussian parameter of group of atoms "msd/nongauss"_compute_msd_nongauss.html - MSD and non-Gaussian parameter of group of atoms
@ -241,74 +237,74 @@ compute"_Commands_compute.html doc page are followed by one or more of
"pair/local"_compute_pair_local.html - distance/energy/force of each pairwise interaction "pair/local"_compute_pair_local.html - distance/energy/force of each pairwise interaction
"pe"_compute_pe.html - potential energy "pe"_compute_pe.html - potential energy
"pe/atom"_compute_pe_atom.html - potential energy for each atom "pe/atom"_compute_pe_atom.html - potential energy for each atom
"pe/mol/tally"_compute_tally.html - "pe/mol/tally"_compute_tally.html -
"pe/tally"_compute_tally.html - "pe/tally"_compute_tally.html -
"plasticity/atom"_compute_plasticity_atom.html - Peridynamic plasticity for each atom "plasticity/atom"_compute_plasticity_atom.html - Peridynamic plasticity for each atom
"pressure"_compute_pressure.html - total pressure and pressure tensor "pressure"_compute_pressure.html - total pressure and pressure tensor
"pressure/cylinder"_compute_pressure_cylinder.html - "pressure/cylinder"_compute_pressure_cylinder.html -
"pressure/uef"_compute_pressure_uef.html - "pressure/uef"_compute_pressure_uef.html -
"property/atom"_compute_property_atom.html - convert atom attributes to per-atom vectors/arrays "property/atom"_compute_property_atom.html - convert atom attributes to per-atom vectors/arrays
"property/chunk"_compute_property_chunk.html - extract various per-chunk attributes "property/chunk"_compute_property_chunk.html - extract various per-chunk attributes
"property/local"_compute_property_local.html - convert local attributes to localvectors/arrays "property/local"_compute_property_local.html - convert local attributes to localvectors/arrays
"ptm/atom"_compute_ptm_atom.html - "ptm/atom"_compute_ptm_atom.html -
"rdf"_compute_rdf.html - radial distribution function g(r) histogram of group of atoms "rdf"_compute_rdf.html - radial distribution function g(r) histogram of group of atoms
"reduce"_compute_reduce.html - combine per-atom quantities into a single global value "reduce"_compute_reduce.html - combine per-atom quantities into a single global value
"reduce/chunk"_compute_reduce_chunk.html - reduce per-atom quantities within each chunk "reduce/chunk"_compute_reduce_chunk.html - reduce per-atom quantities within each chunk
"reduce/region"_compute_reduce.html - same as compute reduce, within a region "reduce/region"_compute_reduce.html - same as compute reduce, within a region
"rigid/local"_compute_rigid_local.html - extract rigid body attributes "rigid/local"_compute_rigid_local.html - extract rigid body attributes
"saed"_compute_saed.html - "saed"_compute_saed.html -
"slice"_compute_slice.html - extract values from global vector or array "slice"_compute_slice.html - extract values from global vector or array
"smd/contact/radius"_compute_smd_contact_radius.html - "smd/contact/radius"_compute_smd_contact_radius.html -
"smd/damage"_compute_smd_damage.html - "smd/damage"_compute_smd_damage.html -
"smd/hourglass/error"_compute_smd_hourglass_error.html - "smd/hourglass/error"_compute_smd_hourglass_error.html -
"smd/internal/energy"_compute_smd_internal_energy.html - "smd/internal/energy"_compute_smd_internal_energy.html -
"smd/plastic/strain"_compute_smd_plastic_strain.html - "smd/plastic/strain"_compute_smd_plastic_strain.html -
"smd/plastic/strain/rate"_compute_smd_plastic_strain_rate.html - "smd/plastic/strain/rate"_compute_smd_plastic_strain_rate.html -
"smd/rho"_compute_smd_rho.html - "smd/rho"_compute_smd_rho.html -
"smd/tlsph/defgrad"_compute_smd_tlsph_defgrad.html - "smd/tlsph/defgrad"_compute_smd_tlsph_defgrad.html -
"smd/tlsph/dt"_compute_smd_tlsph_dt.html - "smd/tlsph/dt"_compute_smd_tlsph_dt.html -
"smd/tlsph/num/neighs"_compute_smd_tlsph_num_neighs.html - "smd/tlsph/num/neighs"_compute_smd_tlsph_num_neighs.html -
"smd/tlsph/shape"_compute_smd_tlsph_shape.html - "smd/tlsph/shape"_compute_smd_tlsph_shape.html -
"smd/tlsph/strain"_compute_smd_tlsph_strain.html - "smd/tlsph/strain"_compute_smd_tlsph_strain.html -
"smd/tlsph/strain/rate"_compute_smd_tlsph_strain_rate.html - "smd/tlsph/strain/rate"_compute_smd_tlsph_strain_rate.html -
"smd/tlsph/stress"_compute_smd_tlsph_stress.html - "smd/tlsph/stress"_compute_smd_tlsph_stress.html -
"smd/triangle/vertices"_compute_smd_triangle_vertices.html - "smd/triangle/vertices"_compute_smd_triangle_vertices.html -
"smd/triangle/vertices"_compute_smd_triangle_vertices.html - "smd/triangle/vertices"_compute_smd_triangle_vertices.html -
"smd/ulsph/num/neighs"_compute_smd_ulsph_num_neighs.html - "smd/ulsph/num/neighs"_compute_smd_ulsph_num_neighs.html -
"smd/ulsph/strain"_compute_smd_ulsph_strain.html - "smd/ulsph/strain"_compute_smd_ulsph_strain.html -
"smd/ulsph/strain/rate"_compute_smd_ulsph_strain_rate.html - "smd/ulsph/strain/rate"_compute_smd_ulsph_strain_rate.html -
"smd/ulsph/stress"_compute_smd_ulsph_stress.html - "smd/ulsph/stress"_compute_smd_ulsph_stress.html -
"smd/vol"_compute_smd_vol.html - "smd/vol"_compute_smd_vol.html -
"sna/atom"_compute_sna_atom.html - calculate bispectrum coefficients for each atom "sna/atom"_compute_sna_atom.html - calculate bispectrum coefficients for each atom
"snad/atom"_compute_sna_atom.html - derivative of bispectrum coefficients for each atom "snad/atom"_compute_sna_atom.html - derivative of bispectrum coefficients for each atom
"snav/atom"_compute_sna_atom.html - virial contribution from bispectrum coefficients for each atom "snav/atom"_compute_sna_atom.html - virial contribution from bispectrum coefficients for each atom
"spin"_compute_spin.html - "spin"_compute_spin.html -
"stress/atom"_compute_stress_atom.html - stress tensor for each atom "stress/atom"_compute_stress_atom.html - stress tensor for each atom
"stress/mop"_compute_stress_mop.html - "stress/mop"_compute_stress_mop.html -
"stress/mop/profile"_compute_stress_mop.html - "stress/mop/profile"_compute_stress_mop.html -
"stress/tally"_compute_tally.html - "stress/tally"_compute_tally.html -
"tdpd/cc/atom"_compute_tdpd_cc_atom.html - "tdpd/cc/atom"_compute_tdpd_cc_atom.html -
"temp"_compute_temp.html - temperature of group of atoms "temp"_compute_temp.html - temperature of group of atoms
"temp/asphere"_compute_temp_asphere.html - temperature of aspherical particles "temp/asphere"_compute_temp_asphere.html - temperature of aspherical particles
"temp/body"_compute_temp_body.html - temperature of body particles "temp/body"_compute_temp_body.html - temperature of body particles
"temp/chunk"_compute_temp_chunk.html - temperature of each chunk "temp/chunk"_compute_temp_chunk.html - temperature of each chunk
"temp/com"_compute_temp_com.html - temperature after subtracting center-of-mass velocity "temp/com"_compute_temp_com.html - temperature after subtracting center-of-mass velocity
"temp/cs"_compute_temp_cs.html - "temp/cs"_compute_temp_cs.html -
"temp/deform"_compute_temp_deform.html - temperature excluding box deformation velocity "temp/deform"_compute_temp_deform.html - temperature excluding box deformation velocity
"temp/deform/eff"_compute_temp_deform_eff.html - "temp/deform/eff"_compute_temp_deform_eff.html -
"temp/drude"_compute_temp_drude.html - "temp/drude"_compute_temp_drude.html -
"temp/eff"_compute_temp_eff.html - "temp/eff"_compute_temp_eff.html -
"temp/partial"_compute_temp_partial.html - temperature excluding one or more dimensions of velocity "temp/partial"_compute_temp_partial.html - temperature excluding one or more dimensions of velocity
"temp/profile"_compute_temp_profile.html - temperature excluding a binned velocity profile "temp/profile"_compute_temp_profile.html - temperature excluding a binned velocity profile
"temp/ramp"_compute_temp_ramp.html - temperature excluding ramped velocity component "temp/ramp"_compute_temp_ramp.html - temperature excluding ramped velocity component
"temp/region"_compute_temp_region.html - temperature of a region of atoms "temp/region"_compute_temp_region.html - temperature of a region of atoms
"temp/region/eff"_compute_temp_region_eff.html - "temp/region/eff"_compute_temp_region_eff.html -
"temp/rotate"_compute_temp_rotate.html - "temp/rotate"_compute_temp_rotate.html -
"temp/sphere"_compute_temp_sphere.html - temperature of spherical particles "temp/sphere"_compute_temp_sphere.html - temperature of spherical particles
"temp/uef"_compute_temp_uef.html - "temp/uef"_compute_temp_uef.html -
"ti"_compute_ti.html - thermodynamic integration free energy values "ti"_compute_ti.html - thermodynamic integration free energy values
"torque/chunk"_compute_torque_chunk.html - torque applied on each chunk "torque/chunk"_compute_torque_chunk.html - torque applied on each chunk
"vacf"_compute_vacf.html - velocity-autocorrelation function of group of atoms "vacf"_compute_vacf.html - velocity auto-correlation function of group of atoms
"vcm/chunk"_compute_vcm_chunk.html - velocity of center-of-mass for each chunk "vcm/chunk"_compute_vcm_chunk.html - velocity of center-of-mass for each chunk
"voronoi/atom"_compute_voronoi_atom.html - Voronoi volume and neighbors for each atom "voronoi/atom"_compute_voronoi_atom.html - Voronoi volume and neighbors for each atom
"xrd"_compute_xrd.html - :ul "xrd"_compute_xrd.html - :ul

View File

@ -33,22 +33,22 @@ keyword = {ordinate} :l
compute 1 fluid adf 32 1 1 1 0.0 1.2 0.0 1.2 & compute 1 fluid adf 32 1 1 1 0.0 1.2 0.0 1.2 &
1 1 2 0.0 1.2 0.0 1.5 & 1 1 2 0.0 1.2 0.0 1.5 &
1 2 2 0.0 1.5 0.0 1.5 & 1 2 2 0.0 1.5 0.0 1.5 &
2 1 1 0.0 1.2 0.0 1.2 & 2 1 1 0.0 1.2 0.0 1.2 &
2 1 2 0.0 1.5 2.0 3.5 & 2 1 2 0.0 1.5 2.0 3.5 &
2 2 2 2.0 3.5 2.0 3.5 2 2 2 2.0 3.5 2.0 3.5
compute 1 fluid adf 32 1*2 1*2 1*2 0.5 3.5 compute 1 fluid adf 32 1*2 1*2 1*2 0.5 3.5
compute 1 fluid adf 32 :pre compute 1 fluid adf 32 :pre
[Description:] [Description:]
Define a computation that calculates one or more angular distribution functions Define a computation that calculates one or more angular distribution functions
(ADF) for a group of particles. Each ADF is calculated in histogram form (ADF) for a group of particles. Each ADF is calculated in histogram form
by measuring the angle formed by a central atom and two neighbor atoms and by measuring the angle formed by a central atom and two neighbor atoms and
binning these angles into {Nbin} bins. binning these angles into {Nbin} bins.
Only neighbors for which {Rinner} < {R} < {Router} are counted, where Only neighbors for which {Rinner} < {R} < {Router} are counted, where
{Rinner} and {Router} are specified separately for the first and second {Rinner} and {Router} are specified separately for the first and second
neighbor atom in each requested ADF. neighbor atom in each requested ADF.
NOTE: If you have a bonded system, then the settings of NOTE: If you have a bonded system, then the settings of
"special_bonds"_special_bonds.html command can remove pairwise "special_bonds"_special_bonds.html command can remove pairwise
@ -66,18 +66,18 @@ the dump file. The rerun script can use a
"special_bonds"_special_bonds.html command that includes all pairs in "special_bonds"_special_bonds.html command that includes all pairs in
the neighbor list. the neighbor list.
NOTE: If you request any outer cutoff {Router} > force cutoff, or if no NOTE: If you request any outer cutoff {Router} > force cutoff, or if no
pair style is defined, e.g. the "rerun"_rerun.html command is being used to pair style is defined, e.g. the "rerun"_rerun.html command is being used to
post-process a dump file of snapshots you must insure ghost atom information post-process a dump file of snapshots you must insure ghost atom information
out to the largest value of {Router} + {skin} is communicated, via the out to the largest value of {Router} + {skin} is communicated, via the
"comm_modify cutoff"_comm_modify.html command, else the ADF computation "comm_modify cutoff"_comm_modify.html command, else the ADF computation
cannot be performed, and LAMMPS will give an error message. The {skin} value cannot be performed, and LAMMPS will give an error message. The {skin} value
is what is specified with the "neighbor"_neighbor.html command. is what is specified with the "neighbor"_neighbor.html command.
The {itypeN},{jtypeN},{ktypeN} settings can be specified in one of two The {itypeN},{jtypeN},{ktypeN} settings can be specified in one of two
ways. An explicit numeric value can be used, as in the 1st example ways. An explicit numeric value can be used, as in the 1st example
above. Or a wild-card asterisk can be used to specify a range of atom above. Or a wild-card asterisk can be used to specify a range of atom
types as in the 2nd example above. types as in the 2nd example above.
This takes the form "*" or "*n" or "n*" or "m*n". If N = the This takes the form "*" or "*n" or "n*" or "m*n". If N = the
number of atom types, then an asterisk with no numeric values means number of atom types, then an asterisk with no numeric values means
all types from 1 to N. A leading asterisk means all types from 1 to n all types from 1 to N. A leading asterisk means all types from 1 to n
@ -88,13 +88,13 @@ all types from 1 to N. A leading asterisk means all types from 1 to n
If {itypeN}, {jtypeN}, and {ktypeN} are single values, as in the 1st example If {itypeN}, {jtypeN}, and {ktypeN} are single values, as in the 1st example
above, this means that the ADF is computed where atoms of type {itypeN} above, this means that the ADF is computed where atoms of type {itypeN}
are the central atom, and neighbor atoms of type {jtypeN} and {ktypeN} are the central atom, and neighbor atoms of type {jtypeN} and {ktypeN}
are forming the angle. If any of {itypeN}, {jtypeN}, or {ktypeN} are forming the angle. If any of {itypeN}, {jtypeN}, or {ktypeN}
represent a range of values via represent a range of values via
the wild-card asterisk, as in the 2nd example above, this means that the the wild-card asterisk, as in the 2nd example above, this means that the
ADF is computed where atoms of any of the range of types represented ADF is computed where atoms of any of the range of types represented
by {itypeN} are the central atom, and the angle is formed by two neighbors, by {itypeN} are the central atom, and the angle is formed by two neighbors,
one neighbor in the range of types represented by {jtypeN} and another neighbor one neighbor in the range of types represented by {jtypeN} and another neighbor
in the range of types represented by {ktypeN}. in the range of types represented by {ktypeN}.
If no {itypeN}, {jtypeN}, {ktypeN} settings are specified, then If no {itypeN}, {jtypeN}, {ktypeN} settings are specified, then
LAMMPS will generate a single ADF for all atoms in the group. LAMMPS will generate a single ADF for all atoms in the group.
@ -106,13 +106,13 @@ Such an ADF is both uninformative and
extremely expensive to compute. For example, with liquid water extremely expensive to compute. For example, with liquid water
with a 10 A force cutoff, there are 80,000 angles per atom. with a 10 A force cutoff, there are 80,000 angles per atom.
In addition, most of the interesting angular structure occurs for In addition, most of the interesting angular structure occurs for
neighbors that are the closest to the central atom, involving neighbors that are the closest to the central atom, involving
just a few dozen angles. just a few dozen angles.
Angles for each ADF are generated by double-looping over the list of Angles for each ADF are generated by double-looping over the list of
neighbors of each central atom I, neighbors of each central atom I,
just as they would be in the force calculation for just as they would be in the force calculation for
a threebody potential such as "Stillinger-Weber"_pair_sw.html. a three-body potential such as "Stillinger-Weber"_pair_sw.html.
The angle formed by central atom I and neighbor atoms J and K is included in an The angle formed by central atom I and neighbor atoms J and K is included in an
ADF if the following criteria are met: ADF if the following criteria are met:
@ -121,12 +121,12 @@ the distance between atoms I,J is between Rjinner and Rjouter
the distance between atoms I,K is between Rkinner and Rkouter the distance between atoms I,K is between Rkinner and Rkouter
the type of the I atom matches itypeN (one or a range of types) the type of the I atom matches itypeN (one or a range of types)
atoms I,J,K are distinct atoms I,J,K are distinct
the type of the J atom matches jtypeN (one or a range of types) the type of the J atom matches jtypeN (one or a range of types)
the type of the K atom matches ktypeN (one or a range of types) :ul the type of the K atom matches ktypeN (one or a range of types) :ul
Each unique angle satisfying the above criteria is counted only once, regardless Each unique angle satisfying the above criteria is counted only once, regardless
of whether either or both of the neighbor atoms making up the of whether either or both of the neighbor atoms making up the
angle appear in both the J and K lists. angle appear in both the J and K lists.
It is OK if a particular angle is included in more than It is OK if a particular angle is included in more than
one individual histogram, due to the way the {itypeN}, {jtypeN}, {ktypeN} one individual histogram, due to the way the {itypeN}, {jtypeN}, {ktypeN}
arguments are specified. arguments are specified.
@ -146,15 +146,15 @@ number radial distribution function.
The {ordinate} optional keyword determines The {ordinate} optional keyword determines
whether the bins are of uniform angular size from zero whether the bins are of uniform angular size from zero
to 180 ({degree}), zero to Pi ({radian}), or the to 180 ({degree}), zero to Pi ({radian}), or the
cosine of the angle uniform in the range \[-1,1\] ({cosine}). cosine of the angle uniform in the range \[-1,1\] ({cosine}).
{cosine} has the advantage of eliminating the {acos()} function {cosine} has the advantage of eliminating the {acos()} function
call, which speeds up the compute by 2-3x, and it is also preferred call, which speeds up the compute by 2-3x, and it is also preferred
on physical grounds, because the for uniformly distributed particles on physical grounds, because the for uniformly distributed particles
in 3D, the angular probability density w.r.t dtheta is in 3D, the angular probability density w.r.t dtheta is
sin(theta)/2, while for d(cos(theta)), it is 1/2, sin(theta)/2, while for d(cos(theta)), it is 1/2,
Regardless of which ordinate is chosen, the first column of ADF Regardless of which ordinate is chosen, the first column of ADF
values is normalized w.r.t. the range of that ordinate, so that values is normalized w.r.t. the range of that ordinate, so that
the integral is 1. the integral is 1.
The simplest way to output the results of the compute adf calculation The simplest way to output the results of the compute adf calculation
@ -170,7 +170,7 @@ This compute calculates a global array with the number of rows =
{Nbins}, and the number of columns = 1 + 2*Ntriples, where Ntriples is the {Nbins}, and the number of columns = 1 + 2*Ntriples, where Ntriples is the
number of I,J,K triples specified. The first column has the bin number of I,J,K triples specified. The first column has the bin
coordinate (angle-related ordinate at midpoint of bin). Each subsequent column has coordinate (angle-related ordinate at midpoint of bin). Each subsequent column has
the two ADF values for a specific set of ({itypeN},{jtypeN},{ktypeN}) the two ADF values for a specific set of ({itypeN},{jtypeN},{ktypeN})
interactions, as described above. These values can be used interactions, as described above. These values can be used
by any command that uses a global values from a compute as input. See by any command that uses a global values from a compute as input. See
the "Howto output"_Howto_output.html doc page for an overview of the "Howto output"_Howto_output.html doc page for an overview of
@ -181,15 +181,15 @@ The array values calculated by this compute are all "intensive".
The first column of array values is the angle-related ordinate, either The first column of array values is the angle-related ordinate, either
the angle in degrees or radians, or the cosine of the angle. Each the angle in degrees or radians, or the cosine of the angle. Each
subsequent pair of columns gives the first and second kinds of ADF subsequent pair of columns gives the first and second kinds of ADF
for a specific set of ({itypeN},{jtypeN},{ktypeN}). The values for a specific set of ({itypeN},{jtypeN},{ktypeN}). The values
in the first ADF column are normalized numbers >= 0.0, in the first ADF column are normalized numbers >= 0.0,
whose integral w.r.t. the ordinate is 1, whose integral w.r.t. the ordinate is 1,
i.e. the first ADF is a normalized probability distribution. i.e. the first ADF is a normalized probability distribution.
The values in the second ADF column are also numbers >= 0.0. The values in the second ADF column are also numbers >= 0.0.
They are the cumulative density distribution of angles per atom. They are the cumulative density distribution of angles per atom.
By definition, this ADF is monotonically increasing from zero to By definition, this ADF is monotonically increasing from zero to
a maximum value equal to the average total number of a maximum value equal to the average total number of
angles per atom satisfying the ADF criteria. angles per atom satisfying the ADF criteria.
[Restrictions:] [Restrictions:]
@ -200,7 +200,7 @@ distances, you can use the "rerun"_rerun.html command to post-process
a dump file and set the cutoff for the potential to be longer in the a dump file and set the cutoff for the potential to be longer in the
rerun script. Note that in the rerun context, the force cutoff is rerun script. Note that in the rerun context, the force cutoff is
arbitrary, since you aren't running dynamics and thus are not changing arbitrary, since you aren't running dynamics and thus are not changing
your model. your model.
[Related commands:] [Related commands:]

View File

@ -29,7 +29,7 @@ keyword = {set} :l
[Examples:] [Examples:]
compute 1 all angle/local theta compute 1 all angle/local theta
compute 1 all angle/local eng theta compute 1 all angle/local eng theta
compute 1 all angle/local theta v_cos set theta t :pre compute 1 all angle/local theta v_cos set theta t :pre
[Description:] [Description:]

Some files were not shown because too many files have changed in this diff Show More