Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove REAX and MEAM packages #1254

Merged
merged 17 commits into from Dec 29, 2018
Merged
Show file tree
Hide file tree
Changes from 13 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 4 additions & 4 deletions cmake/CMakeLists.txt
Expand Up @@ -171,7 +171,7 @@ set(LAMMPS_DEPS)
set(LAMMPS_API_DEFINES)

set(DEFAULT_PACKAGES ASPHERE BODY CLASS2 COLLOID COMPRESS DIPOLE GRANULAR
KSPACE MANYBODY MC MEAM MESSAGE MISC MOLECULE PERI REAX REPLICA RIGID SHOCK
KSPACE MANYBODY MC MESSAGE MISC MOLECULE PERI REPLICA RIGID SHOCK
SPIN SNAP SRD KIM PYTHON MSCG MPIIO VORONOI POEMS LATTE USER-ATC USER-AWPMD
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
Expand All @@ -191,11 +191,11 @@ endforeach()
######################################################
# packages with special compiler needs or external libs
######################################################
if(PKG_REAX OR PKG_MEAM OR PKG_USER-QUIP OR PKG_USER-QMMM OR PKG_LATTE OR PKG_USER-SCAFACOS)
if(PKG_USER-QUIP OR PKG_USER-QMMM OR PKG_LATTE OR PKG_USER-SCAFACOS)
enable_language(Fortran)
endif()

if(PKG_MEAM OR PKG_USER-H5MD OR PKG_USER-QMMM OR PKG_USER-SCAFACOS)
if(PKG_USER-H5MD OR PKG_USER-QMMM OR PKG_USER-SCAFACOS)
enable_language(C)
endif()

Expand Down Expand Up @@ -826,7 +826,7 @@ endforeach()
##############################################
# add lib sources of (simple) enabled packages
############################################
foreach(SIMPLE_LIB REAX MEAM POEMS USER-ATC USER-AWPMD USER-COLVARS USER-H5MD
foreach(SIMPLE_LIB POEMS USER-ATC USER-AWPMD USER-COLVARS USER-H5MD
USER-QMMM)
if(PKG_${SIMPLE_LIB})
string(REGEX REPLACE "^USER-" "" PKG_LIB "${SIMPLE_LIB}")
Expand Down
44 changes: 2 additions & 42 deletions doc/src/Build_extras.txt
Expand Up @@ -36,7 +36,6 @@ This is the list of packages that may require additional steps.
"OPT"_#opt,
"POEMS"_#poems,
"PYTHON"_#python,
"REAX"_#reax,
"VORONOI"_#voronoi,
"USER-ATC"_#user-atc,
"USER-AWPMD"_#user-awpmd,
Expand Down Expand Up @@ -536,45 +535,6 @@ build fails.

:line

REAX package :h4,link(reax)

NOTE: the use of the REAX package and its "pair_style
reax"_pair_reax.html command is discouraged, as it is no longer
maintained. Please use the USER-REAXC package and its "pair_style
reax/c"_pair_reaxc.html command instead, and possibly its KOKKOS
enabled variant (pair_style reax/c/kk), which has a more robust memory
management. See the "pair_style reax/c"_pair_reaxc.html doc page for
details.

[CMake build]:

No additional settings are needed besides "-D PKG_REAX=yes".

[Traditional make]:

Before building LAMMPS, you must build the REAX library in lib/reax.
You can do this manually if you prefer; follow the instructions in
lib/reax/README. You can also do it in one step from the lammps/src
dir, using a command like these, which simply invoke the
lib/reax/Install.py script with the specified args:

make lib-reax # print help message
make lib-reax args="-m serial" # build with GNU Fortran compiler (settings as with "make serial")
make lib-reax args="-m mpi" # build with default MPI Fortran compiler (settings as with "make mpi")
make lib-reax args="-m ifort" # build with Intel ifort compiler :pre

The build should produce two files: lib/reax/libreax.a and
lib/reax/Makefile.lammps. The latter is copied from an existing
Makefile.lammps.* and has settings needed to link C++ (LAMMPS) with
Fortran (REAX library). Typically the two compilers used for LAMMPS
and the REAX library need to be consistent (e.g. both Intel or both
GNU compilers). If necessary, you can edit/create a new
lib/reax/Makefile.machine file for your system, which should define an
EXTRAMAKE variable to specify a corresponding Makefile.lammps.machine
file.

:line

VORONOI package :h4,link(voronoi)

To build with this package, you must download and build the "Voro++
Expand Down Expand Up @@ -621,8 +581,8 @@ The USER-ATC package requires the MANYBODY package also be installed.

[CMake build]:

No additional settings are needed besides "-D PKG_REAX=yes" and "-D
PKG_MANYBODY=yes".
No additional settings are needed besides "-D PKG_USER-ATC=yes"
and "-D PKG_MANYBODY=yes".

[Traditional make]:

Expand Down
1 change: 0 additions & 1 deletion doc/src/Build_package.txt
Expand Up @@ -47,7 +47,6 @@ packages:
"OPT"_Build_extras.html#opt,
"POEMS"_Build_extras.html#poems,
"PYTHON"_Build_extras.html#python,
"REAX"_Build_extras.html#reax,
"VORONOI"_Build_extras.html#voronoi,
"USER-ATC"_Build_extras.html#user-atc,
"USER-AWPMD"_Build_extras.html#user-awpmd,
Expand Down
3 changes: 1 addition & 2 deletions doc/src/Commands_fix.txt
Expand Up @@ -169,8 +169,7 @@ OPT.
"qmmm"_fix_qmmm.html,
"qtb"_fix_qtb.html,
"rattle"_fix_shake.html,
"reax/bonds"_fix_reax_bonds.html,
"reax/c/bonds (k)"_fix_reax_bonds.html,
"reax/c/bonds (k)"_fix_reaxc_bonds.html,
"reax/c/species (k)"_fix_reaxc_species.html,
"recenter"_fix_recenter.html,
"restrain"_fix_restrain.html,
Expand Down
4 changes: 1 addition & 3 deletions doc/src/Commands_pair.txt
Expand Up @@ -160,8 +160,7 @@ OPT.
"lubricateU/poly"_pair_lubricateU.html,
"mdpd"_pair_meso.html,
"mdpd/rhosum"_pair_meso.html,
"meam"_pair_meam.html,
"meam/c"_pair_meam.html,
"meam/c"_pair_meamc.html,
"meam/spline (o)"_pair_meam_spline.html,
"meam/sw/spline"_pair_meam_sw_spline.html,
"mgpt"_pair_mgpt.html,
Expand Down Expand Up @@ -194,7 +193,6 @@ OPT.
"polymorphic"_pair_polymorphic.html,
"python"_pair_python.html,
"quip"_pair_quip.html,
"reax"_pair_reax.html,
"reax/c (ko)"_pair_reaxc.html,
"rebo (io)"_pair_airebo.html,
"resquared (go)"_pair_resquared.html,
Expand Down
4 changes: 2 additions & 2 deletions doc/src/Install_windows.txt
Expand Up @@ -23,8 +23,8 @@ install the Windows MPI package (MPICH2 from Argonne National Labs),
needed to run in parallel.

The LAMMPS binaries contain all optional packages included in the
source distribution except: KIM, REAX, KOKKOS, USER-INTEL,
and USER-QMMM. The serial version also does not include the MPIIO and
source distribution except: KIM, KOKKOS, USER-INTEL, and USER-QMMM.
The serial version also does not include the MPIIO and
USER-LB packages. GPU support is provided for OpenCL.

The installer site also has instructions on how to run LAMMPS under
Expand Down
83 changes: 8 additions & 75 deletions doc/src/Packages_details.txt
Expand Up @@ -45,7 +45,6 @@ as contained in the file name.
"LATTE"_#PKG-LATTE,
"MANYBODY"_#PKG-MANYBODY,
"MC"_#PKG-MC,
"MEAM"_#PKG-MEAM,
"MESSAGE"_#PKG-MESSAGE,
"MISC"_#PKG-MISC,
"MOLECULE"_#PKG-MOLECULE,
Expand All @@ -56,7 +55,6 @@ as contained in the file name.
"POEMS"_#PKG-POEMS,
"PYTHON"_#PKG-PYTHON,
"QEQ"_#PKG-QEQ,
"REAX"_#PKG-REAX,
"REPLICA"_#PKG-REPLICA2,
"RIGID"_#PKG-RIGID,
"SHOCK"_#PKG-SHOCK,
Expand Down Expand Up @@ -533,37 +531,6 @@ http://lammps.sandia.gov/movies.html#gcmc :ul

:line

MEAM package :link(PKG-MEAM),h4

[Contents:]

A pair style for the modified embedded atom (MEAM) potential.

Please note that the use of the MEAM package is discouraged as
it has been superseded by the "USER-MEAMC"_#PKG-USER-MEAMC package,
which is a direct translation of the MEAM package to C++.
USER-MEAMC contains additional optimizations making it run faster
than MEAM on most machines, while providing the identical features
and user interface.

[Author:] Greg Wagner (Northwestern U) while at Sandia.

[Install:]

This package has "specific installation
instructions"_Build_extras.html#gpu on the "Build
extras"_Build_extras.html doc page.

[Supporting info:]

src/MEAM: filenames -> commands
src/meam/README
lib/meam/README
"pair_style meam"_pair_meam.html
examples/meam :ul

:line

MESSAGE package :link(PKG-MESSAGE),h4

[Contents:]
Expand Down Expand Up @@ -834,38 +801,6 @@ examples/streitz :ul

:line

REAX package :link(PKG-REAX),h4

[Contents:]

NOTE: the use of the REAX package is discouraged, as it is no longer
maintained. Please use the "USER-REAXC"_#PKG-USER-REAXC package instead,
and possibly the KOKKOS enabled variant of that, which has a more robust
memory management.

A pair style which wraps a Fortran library which implements the ReaxFF
potential, which is a universal reactive force field. Also included is
a "fix reax/bonds"_fix_reax_bonds.html command for monitoring molecules
as bonds are created and destroyed.

[Author:] Aidan Thompson (Sandia).

[Install:]

This package has "specific installation
instructions"_Build_extras.html#gpu on the "Build
extras"_Build_extras.html doc page.

[Supporting info:]

src/REAX: filenames -> commands
lib/reax/README
"pair_style reax"_pair_reax.html
"fix reax/bonds"_fix_reax_bonds.html
examples/reax :ul

:line

REPLICA package :link(PKG-REPLICA2),h4

[Contents:]
Expand Down Expand Up @@ -1552,10 +1487,9 @@ USER-MEAMC package :link(PKG-USER-MEAMC),h4
[Contents:]

A pair style for the modified embedded atom (MEAM) potential
translated from the Fortran version in the "MEAM"_#PKG-MEAM package
to plain C++. In contrast to the MEAM package, no library
needs to be compiled and the pair style can be instantiated
multiple times.
translated from the Fortran version in the (obsolete) "MEAM" package
to plain C++. The USER-MEAMC fully replaces the MEAM package, which
has been removed from LAMMPS after the 12 December 2018 version.

[Author:] Sebastian Huetter, (Otto-von-Guericke University Magdeburg)
based on the Fortran version of Greg Wagner (Northwestern U) while at
Expand All @@ -1565,8 +1499,8 @@ Sandia.

src/USER-MEAMC: filenames -> commands
src/USER-MEAMC/README
"pair_style meam/c"_pair_meam.html
examples/meam :ul
"pair_style meam/c"_pair_meamc.html
examples/meamc :ul

:line

Expand Down Expand Up @@ -1894,9 +1828,8 @@ USER-REAXC package :link(PKG-USER-REAXC),h4

[Contents:]

A pair style which implements the ReaxFF potential in C/C++ (in
contrast to the "REAX package"_#PKG-REAX and its Fortran library). ReaxFF
is universal reactive force field. See the src/USER-REAXC/README file
A pair style which implements the ReaxFF potential in C/C++. ReaxFF
is a universal reactive force field. See the src/USER-REAXC/README file
for more info on differences between the two packages. Also two fixes
for monitoring molecules as bonds are created and destroyed.

Expand All @@ -1907,7 +1840,7 @@ for monitoring molecules as bonds are created and destroyed.
src/USER-REAXC: filenames -> commands
src/USER-REAXC/README
"pair_style reax/c"_pair_reaxc.html
"fix reax/c/bonds"_fix_reax_bonds.html
"fix reax/c/bonds"_fix_reaxc_bonds.html
"fix reax/c/species"_fix_reaxc_species.html
examples/reax :ul

Expand Down
2 changes: 0 additions & 2 deletions doc/src/Packages_standard.txt
Expand Up @@ -46,7 +46,6 @@ Package, Description, Doc page, Example, Library
"LATTE"_Packages_details.html#PKG-LATTE, quantum DFTB forces via LATTE, "fix latte"_fix_latte.html, latte, ext
"MANYBODY"_Packages_details.html#PKG-MANYBODY, many-body potentials, "pair_style tersoff"_pair_tersoff.html, shear, no
"MC"_Packages_details.html#PKG-MC, Monte Carlo options, "fix gcmc"_fix_gcmc.html, n/a, no
"MEAM"_Packages_details.html#PKG-MEAM, modified EAM potential, "pair_style meam"_pair_meam.html, meam, int
"MESSAGE"_Packages_details.html#PKG-MESSAGE, client/server messaging, "message"_message.html, message, int
"MISC"_Packages_details.html#PKG-MISC, miscellaneous single-file commands, n/a, no, no
"MOLECULE"_Packages_details.html#PKG-MOLECULE, molecular system force fields, "Howto bioFF"_Howto_bioFF.html, peptide, no
Expand All @@ -57,7 +56,6 @@ Package, Description, Doc page, Example, Library
"POEMS"_Packages_details.html#PKG-POEMS, coupled rigid body motion, "fix poems"_fix_poems.html, rigid, int
"PYTHON"_Packages_details.html#PKG-PYTHON, embed Python code in an input script, "python"_python.html, python, sys
"QEQ"_Packages_details.html#PKG-QEQ, QEq charge equilibration, "fix qeq"_fix_qeq.html, qeq, no
"REAX"_Packages_details.html#PKG-REAX, ReaxFF potential (Fortran), "pair_style reax"_pair_reax.html, reax, int
"REPLICA"_Packages_details.html#PKG-REPLICA2, multi-replica methods, "Howto replica"_Howto_replica.html, tad, no
"RIGID"_Packages_details.html#PKG-RIGID, rigid bodies and constraints, "fix rigid"_fix_rigid.html, rigid, no
"SHOCK"_Packages_details.html#PKG-SHOCK, shock loading methods, "fix msst"_fix_msst.html, n/a, no
Expand Down
2 changes: 1 addition & 1 deletion doc/src/Packages_user.txt
Expand Up @@ -53,7 +53,7 @@ Package, Description, Doc page, Example, Library
"USER-INTEL"_Packages_details.html#PKG-USER-INTEL, optimized Intel CPU and KNL styles,"Speed intel"_Speed_intel.html, "Benchmarks"_http://lammps.sandia.gov/bench.html, no
"USER-LB"_Packages_details.html#PKG-USER-LB, Lattice Boltzmann fluid,"fix lb/fluid"_fix_lb_fluid.html, USER/lb, no
"USER-MANIFOLD"_Packages_details.html#PKG-USER-MANIFOLD, motion on 2d surfaces,"fix manifoldforce"_fix_manifoldforce.html, USER/manifold, no
"USER-MEAMC"_Packages_details.html#PKG-USER-MEAMC, modified EAM potential (C++), "pair_style meam/c"_pair_meam.html, meam, no
"USER-MEAMC"_Packages_details.html#PKG-USER-MEAMC, modified EAM potential (C++), "pair_style meam/c"_pair_meamc.html, meamc, no
"USER-MESO"_Packages_details.html#PKG-USER-MESO, mesoscale DPD models, "pair_style edpd"_pair_meso.html, USER/meso, no
"USER-MGPT"_Packages_details.html#PKG-USER-MGPT, fast MGPT multi-ion potentials, "pair_style mgpt"_pair_mgpt.html, USER/mgpt, no
"USER-MISC"_Packages_details.html#PKG-USER-MISC, single-file contributions, USER-MISC/README, USER/misc, no
Expand Down
4 changes: 2 additions & 2 deletions doc/src/Tools.txt
Expand Up @@ -486,8 +486,8 @@ README for more info on Pizza.py and how to use these scripts.
reax tool :h4,link(reax_tool)

The reax sub-directory contains stand-alond codes that can
post-process the output of the "fix reax/bonds"_fix_reax_bonds.html
command from a LAMMPS simulation using "ReaxFF"_pair_reax.html. See
post-process the output of the "fix reax/c/bonds"_fix_reaxc_bonds.html
command from a LAMMPS simulation using "ReaxFF"_pair_reaxc.html. See
the README.txt file for more info.

These tools were written by Aidan Thompson at Sandia.
Expand Down
6 changes: 3 additions & 3 deletions doc/src/compute_pair.txt
Expand Up @@ -24,7 +24,7 @@ nsub = {n}-instance of a sub-style, if a pair style is used multiple times in a
compute 1 all pair gauss
compute 1 all pair lj/cut/coul/cut ecoul
compute 1 all pair tersoff 2 epair
compute 1 all pair reax :pre
compute 1 all pair reax/c :pre

[Description:]

Expand Down Expand Up @@ -60,8 +60,8 @@ corrections, even if they are enabled via the
"pair_modify"_pair_modify.html command.

Some pair styles tally additional quantities, e.g. a breakdown of
potential energy into a dozen or so components is tallied by the
"pair_style reax"_pair_reax.html command. These values (1 or more)
potential energy into 14 components is tallied by the "pair_style
reax/c"_pair_reaxc.html command. These values (1 or more)
are stored as a global vector by this compute. See the doc page for
"individual pair styles"_pair_style.html for info on these values.

Expand Down
5 changes: 2 additions & 3 deletions doc/src/fix.txt
Expand Up @@ -312,9 +312,8 @@ accelerated styles exist.
"qmmm"_fix_qmmm.html -
"qtb"_fix_qtb.html -
"rattle"_fix_shake.html - RATTLE constraints on bonds and/or angles
"reax/bonds"_fix_reax_bonds.html - write out ReaxFF bond information
"reax/c/bonds"_fix_reax_bonds.html -
"reax/c/species"_fix_reaxc_species.html -
"reax/c/bonds"_fix_reaxc_bonds.html - write out ReaxFF bond information
"reax/c/species"_fix_reaxc_species.html - write out ReaxFF molecule information
"recenter"_fix_recenter.html - constrain the center-of-mass position of a group of atoms
"restrain"_fix_restrain.html - constrain a bond, angle, dihedral
"rhok"_fix_rhok.html -
Expand Down