diff --git a/doc/src/Build_basics.rst b/doc/src/Build_basics.rst index 335c1a5189..e6d9fff373 100644 --- a/doc/src/Build_basics.rst +++ b/doc/src/Build_basics.rst @@ -225,7 +225,7 @@ A few example command lines are: For compiling with the Clang/LLVM compilers a CMake preset is provided that can be loaded with `-C ../cmake/presets/clang.cmake`. Similarly, -`-C ../cmake/presets/intel.cmake` should switch the +`-C ../cmake/presets/intel.cmake` should switch the In addition you can set ``CMAKE_TUNE_FLAGS`` to specifically add compiler flags to tune for optimal performance on given hosts. By diff --git a/doc/src/Build_development.rst b/doc/src/Build_development.rst index 94b78a4a9c..be86037f61 100644 --- a/doc/src/Build_development.rst +++ b/doc/src/Build_development.rst @@ -126,7 +126,7 @@ in the next section. .. note:: - This unit test framework is new and still under development. + The unit test framework is new and still under development. The coverage is only minimal and will be expanded over time. Tests styles of the same kind of style (e.g. pair styles or bond styles) are performed with the same executable using @@ -237,12 +237,12 @@ and working. performed with automatically rescaled epsilon to account for additional loss of precision from code optimizations and different summation orders. - - When compiling with aggressive compiler optimization, some tests + - When compiling with (aggressive) compiler optimization, some tests are likely to fail. It is recommended to inspect the individual - tests in detail to decide whether the specific error for a specific + tests in detail to decide, whether the specific error for a specific property is acceptable (it often is), or this may be an indication - of mis-compiled code (or undesired large of precision due to - reordering of operations). + of mis-compiled code (or an undesired large loss of precision due + to significant reordering of operations and thus less error cancellation). Collect and visualize code coverage metrics ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/doc/src/Build_link.rst b/doc/src/Build_link.rst index 39fc4fe40a..914142b3ce 100644 --- a/doc/src/Build_link.rst +++ b/doc/src/Build_link.rst @@ -1,12 +1,12 @@ Link LAMMPS as a library to another code ======================================== -LAMMPS is designed as a library of C++ objects and can thus be +LAMMPS is designed as a library of C++ objects that can be integrated into other applications including Python scripts. The files ``src/library.cpp`` and ``src/library.h`` define a C-style API for using LAMMPS as a library. See the :doc:`Howto -library ` doc page for a description of the interface -and how to extend it for your needs. +library ` page for a description of the interface +and how to use it for your needs. The :doc:`Build basics ` doc page explains how to build LAMMPS as either a shared or static library. This results in a file @@ -31,18 +31,18 @@ the suffix ``.so.0`` (or some other number). communicator with a subset of MPI ranks to the function creating the LAMMPS instance. ----------- - -**Link with LAMMPS as a static library**\ : +Link with LAMMPS as a static library +------------------------------------ The calling application can link to LAMMPS as a static library with compilation and link commands as in the examples shown below. These -are examples for a code written in C in the file *caller.c*. +are examples for a code written in C in the file ``caller.c``. The benefit of linking to a static library is, that the resulting executable is independent of that library since all required executable code from the library is copied into the calling executable. -*CMake build*\ : +CMake build +^^^^^^^^^^^ This assumes that LAMMPS has been configured without setting a ``LAMMPS_MACHINE`` name, installed with "make install", and the @@ -55,7 +55,8 @@ The commands to compile and link a coupled executable are then: mpicc -c -O $(pkgconf liblammps --cflags) caller.c mpicxx -o caller caller.o -$(pkgconf liblammps --libs) -*Traditional make*\ : +Traditional make +^^^^^^^^^^^^^^^^ This assumes that LAMMPS has been compiled in the folder ``${HOME}/lammps/src`` with "make mpi". The commands to compile and link @@ -83,20 +84,20 @@ LAMMPS library without any optional packages that depend on libraries need to include all flags, libraries, and paths for the coupled executable, that are also required to link the LAMMPS executable. -*CMake build*\ : +CMake build +^^^^^^^^^^^ When using CMake, additional libraries with sources in the lib folder are built, but not included in ``liblammps.a`` and (currently) not -installed with "make install" and not included in the *pkgconfig* +installed with ``make install`` and not included in the ``pkgconfig`` configuration file. They can be found in the top level build folder, but you have to determine the necessary link flags manually. It is therefore recommended to either use the traditional make procedure to build and link with a static library or build and link with a shared library instead. -.. TODO: this needs to be updated to reflect that latest CMake changes after they are complete. - -*Traditional make*\ : +Traditional make +^^^^^^^^^^^^^^^^ After you have compiled a static LAMMPS library using the conventional build system for example with "make mode=static serial". And you also @@ -110,10 +111,10 @@ change to: g++ -o caller caller.o -L${HOME}/lammps/lib/poems \ -L${HOME}/lammps/src/STUBS -L${HOME}/lammps/src -llammps_serial -lpoems -lmpi_stubs -Note, that you need to link with "g++" instead of "gcc", since the -LAMMPS library is C++ code. You can display the currently applied -settings for building LAMMPS for the "serial" machine target by using -the command: +Note, that you need to link with ``g++`` instead of ``gcc`` even if you have +written your code in C, since LAMMPS itself is C++ code. You can display the +currently applied settings for building LAMMPS for the "serial" machine target +by using the command: .. code-block:: bash @@ -123,25 +124,24 @@ Which should output something like: .. code-block:: bash - # Compiler: + # Compiler: CXX=g++ - # Linker: + # Linker: LD=g++ - # Compilation: + # Compilation: CXXFLAGS=-g -O3 -DLAMMPS_GZIP -DLAMMPS_MEMALIGN=64 -I${HOME}/compile/lammps/lib/poems -I${HOME}/compile/lammps/src/STUBS - # Linking: + # Linking: LDFLAGS=-g -O - # Libraries: + # Libraries: LDLIBS=-L${HOME}/compile/lammps/src -llammps_serial -L${HOME}/compile/lammps/lib/poems -L${HOME}/compile/lammps/src/STUBS -lpoems -lmpi_stubs From this you can gather the necessary paths and flags. With makefiles for other *machine* configurations you need to do the -equivalent and replace "serial" with the corresponding *machine* name +equivalent and replace "serial" with the corresponding "machine" name of the makefile. ----------- - -**Link with LAMMPS as a shared library**\ : +Link with LAMMPS as a shared library +------------------------------------ When linking to LAMMPS built as a shared library, the situation becomes much simpler, as all dependent libraries and objects are either included @@ -151,7 +151,8 @@ linking the calling executable. Only the *-I* flags are needed. So the example case from above of the serial version static LAMMPS library with the POEMS package installed becomes: -*CMake build*\ : +CMake build +^^^^^^^^^^^ The commands with a shared LAMMPS library compiled with the CMake build process are the same as for the static library. @@ -161,10 +162,11 @@ build process are the same as for the static library. mpicc -c -O $(pkgconf liblammps --cflags) caller.c mpicxx -o caller caller.o -$(pkgconf --libs) -*Traditional make*\ : +Traditional make +^^^^^^^^^^^^^^^^ The commands with a shared LAMMPS library compiled with the -traditional make build using "make mode=shared serial" becomes: +traditional make build using ``make mode=shared serial`` becomes: .. code-block:: bash @@ -231,29 +233,3 @@ If a required library is missing, you would get a 'not found' entry: libc.so.6 => /usr/lib64/libc.so.6 (0x00007fb7c7b5d000) /lib64/ld-linux-x86-64.so.2 (0x00007fb7c80a2000) ----------- - -**Calling the LAMMPS library**\ : - -Either flavor of library (static or shared) allows one or more LAMMPS -objects to be instantiated from the calling program. When used from a -C++ program, most of the symbols and functions in LAMMPS are wrapped -in a ``LAMMPS_NS`` namespace; you can safely use any of its classes and -methods from within the calling code, as needed, and you will not incur -conflicts with functions and variables in your code that share the name. -This, however, does not extend to all additional libraries bundled with -LAMMPS in the lib folder and some of the low-level code of some packages. - -To be compatible with C, Fortran, Python programs, the library has a simple -C-style interface, provided in ``src/library.cpp`` and ``src/library.h``. - -See the :doc:`Python library ` doc page for a -description of the Python interface to LAMMPS, which wraps the C-style -interface from a shared library through the `ctypes python module `_. - -See the sample codes in ``examples/COUPLE/simple`` for examples of C++ and -C and Fortran codes that invoke LAMMPS through its library interface. -Other examples in the COUPLE directory use coupling ideas discussed on -the :doc:`Howto couple ` doc page. - -.. _ctypes: https://docs.python.org/3/library/ctypes.html diff --git a/doc/src/Build_settings.rst b/doc/src/Build_settings.rst index 01792507e7..58b61c993c 100644 --- a/doc/src/Build_settings.rst +++ b/doc/src/Build_settings.rst @@ -169,12 +169,12 @@ ARRAY mode. .. _size: -Size of LAMMPS data types +Size of LAMMPS integer types ------------------------------------ -LAMMPS has a few integer data types which can be defined as 4-byte or -8-byte integers. The default setting of "smallbig" is almost always -adequate. +LAMMPS has a few integer data types which can be defined as either +4-byte (= 32-bit) or 8-byte (= 64-bit) integers at compile time. +The default setting of "smallbig" is almost always adequate. **CMake variable**\ : @@ -420,8 +420,8 @@ Exception handling when using LAMMPS as a library This setting is useful when external codes drive LAMMPS as a library. With this option enabled, LAMMPS errors do not kill the calling code. Instead, the call stack is unwound and control returns to the caller, -e.g. to Python. Of course the calling code has to be set up to -*catch* exceptions from within LAMMPS. +e.g. to Python. Of course, the calling code has to be set up to +*catch* exceptions thrown from within LAMMPS. **CMake variable**\ : @@ -434,3 +434,10 @@ e.g. to Python. Of course the calling code has to be set up to .. code-block:: make LMP_INC = -DLAMMPS_EXCEPTIONS + +.. note:: + + When LAMMPS is running in parallel, it is not always possible to + cleanly recover from an exception since not all parallel ranks may + throw an exception and thus other MPI ranks may get stuck waiting for + messages from the ones with errors. diff --git a/doc/src/Commands_input.rst b/doc/src/Commands_input.rst index f8de98c1a2..8fc658a215 100644 --- a/doc/src/Commands_input.rst +++ b/doc/src/Commands_input.rst @@ -31,9 +31,9 @@ does something different than this sequence: run 100 In the first case, the specified timestep (0.5 fs) is used for two -simulations of 100 timesteps each. In the 2nd case, the default -timestep (1.0 fs) is used for the 1st 100 step simulation and a 0.5 fs -timestep is used for the 2nd one. +simulations of 100 timesteps each. In the second case, the default +timestep (1.0 fs) is used for the first 100 step simulation and a 0.5 fs +timestep is used for the second one. (2) Some commands are only valid when they follow other commands. For example you cannot set the temperature of a group of atoms until atoms diff --git a/doc/src/Commands_pair.rst b/doc/src/Commands_pair.rst index eac38af668..d91624e17a 100644 --- a/doc/src/Commands_pair.rst +++ b/doc/src/Commands_pair.rst @@ -78,7 +78,7 @@ OPT. * :doc:`coul/long/soft (o) ` * :doc:`coul/msm (o) ` * :doc:`coul/slater/cut ` - * :doc:`coul/slater/long ` + * :doc:`coul/slater/long ` * :doc:`coul/shield ` * :doc:`coul/streitz ` * :doc:`coul/wolf (ko) ` diff --git a/doc/src/Developer/developer.tex b/doc/src/Developer/developer.tex index 15fd3a4ce5..c7f619c84f 100644 --- a/doc/src/Developer/developer.tex +++ b/doc/src/Developer/developer.tex @@ -142,7 +142,7 @@ follows: minimize. \item The Special class walks the bond topology of a molecular system - to find 1st, 2nd, 3rd neighbors of each atom. It is invoked by + to find first, second, third neighbors of each atom. It is invoked by several commands, like read\_data, read\_restart, and replicate. \item The Atom class stores all per-atom arrays. More precisely, they diff --git a/doc/src/Errors_debug.rst b/doc/src/Errors_debug.rst index 1e7e678602..9b11974cf4 100644 --- a/doc/src/Errors_debug.rst +++ b/doc/src/Errors_debug.rst @@ -23,7 +23,7 @@ We use it to show how to identify the origin of a segmentation fault. double *special_lj = force->special_lj; int newton_pair = force->newton_pair; + double comx = 0.0; - + inum = list->inum; ilist = list->ilist; @@ -134,8 +135,10 @@ void PairLJCut::compute(int eflag, int vflag) @@ -31,7 +31,7 @@ We use it to show how to identify the origin of a segmentation fault. } } - } - + + comx += atom->rmass[i]*x[i][0]; /* BUG */ + } + printf("comx = %g\n",comx); @@ -42,7 +42,7 @@ After recompiling LAMMPS and running the input you should get something like thi .. code-block: - $ ./lmp -in in.melt + $ ./lmp -in in.melt LAMMPS (19 Mar 2020) OMP_NUM_THREADS environment is not set. Defaulting to 1 thread. (src/comm.cpp:94) using 1 OpenMP thread(s) per MPI task @@ -98,11 +98,11 @@ drop back to the GDB prompt. Unit style : lj Current step : 0 Time step : 0.005 - + Program received signal SIGSEGV, Segmentation fault. 0x00000000006653ab in LAMMPS_NS::PairLJCut::compute (this=0x829740, eflag=1, vflag=) at /home/akohlmey/compile/lammps/src/pair_lj_cut.cpp:139 139 comx += atom->rmass[i]*x[i][0]; /* BUG */ - (gdb) + (gdb) Now typing the command "where" will show the stack of functions starting from the current function back to "main()". @@ -119,7 +119,7 @@ the current function back to "main()". #4 0x0000000000410ad3 in LAMMPS_NS::Input::execute_command (this=0x7d1410) at /home/akohlmey/compile/lammps/src/input.cpp:864 #5 0x00000000004111fb in LAMMPS_NS::Input::file (this=0x7d1410) at /home/akohlmey/compile/lammps/src/input.cpp:229 #6 0x000000000040933a in main (argc=, argv=) at /home/akohlmey/compile/lammps/src/main.cpp:65 - (gdb) + (gdb) You can also print the value of variables and see if there is anything unexpected. Segmentation faults, for example, commonly happen when a @@ -189,12 +189,12 @@ the console are not mixed. .. code-block:: - $ valgrind ./lmp -in in.melt + $ valgrind ./lmp -in in.melt ==1933642== Memcheck, a memory error detector ==1933642== Copyright (C) 2002-2017, and GNU GPL'd, by Julian Seward et al. ==1933642== Using Valgrind-3.15.0 and LibVEX; rerun with -h for copyright info ==1933642== Command: ./lmp -in in.melt - ==1933642== + ==1933642== LAMMPS (19 Mar 2020) OMP_NUM_THREADS environment is not set. Defaulting to 1 thread. (src/comm.cpp:94) using 1 OpenMP thread(s) per MPI task @@ -228,7 +228,7 @@ the console are not mixed. ==1933642== by 0x4111FA: LAMMPS_NS::Input::file() (input.cpp:229) ==1933642== by 0x409339: main (main.cpp:65) ==1933642== Address 0x0 is not stack'd, malloc'd or (recently) free'd - ==1933642== + ==1933642== As you can see, the stack trace information is similar to that obtained from GDB. In addition you get a more specific hint about what cause the diff --git a/doc/src/Errors_messages.rst b/doc/src/Errors_messages.rst index 2140719253..f3be94a239 100644 --- a/doc/src/Errors_messages.rst +++ b/doc/src/Errors_messages.rst @@ -381,7 +381,7 @@ Doc page with :doc:`WARNING messages ` are defined. *Bond atom missing in box size check* - The 2nd atoms needed to compute a particular bond is missing on this + The second atom needed to compute a particular bond is missing on this processor. Typically this is because the pairwise cutoff is set too short or the bond has blown apart and an atom is too far away. @@ -391,7 +391,7 @@ Doc page with :doc:`WARNING messages ` the atoms are too far apart to make a valid bond. *Bond atom missing in image check* - The 2nd atom in a particular bond is missing on this processor. + The second atom in a particular bond is missing on this processor. Typically this is because the pairwise cutoff is set too short or the bond has blown apart and an atom is too far away. @@ -401,12 +401,12 @@ Doc page with :doc:`WARNING messages ` are too far apart to make a valid bond. *Bond atoms %d %d missing on proc %d at step %ld* - The 2nd atom needed to compute a particular bond is missing on this + The second atom needed to compute a particular bond is missing on this processor. Typically this is because the pairwise cutoff is set too short or the bond has blown apart and an atom is too far away. *Bond atoms missing on proc %d at step %ld* - The 2nd atom needed to compute a particular bond is missing on this + The second atom needed to compute a particular bond is missing on this processor. Typically this is because the pairwise cutoff is set too short or the bond has blown apart and an atom is too far away. @@ -1374,7 +1374,7 @@ Doc page with :doc:`WARNING messages ` template does not qualify. *Cannot use fix box/relax on a 2nd non-periodic dimension* - When specifying an off-diagonal pressure component, the 2nd of the two + When specifying an off-diagonal pressure component, the second of the two dimensions must be periodic. E.g. if the xy component is specified, then the y dimension must be periodic. @@ -1388,7 +1388,7 @@ Doc page with :doc:`WARNING messages ` also keyword tri or xy, this is wrong. *Cannot use fix box/relax with tilt factor scaling on a 2nd non-periodic dimension* - When specifying scaling on a tilt factor component, the 2nd of the two + When specifying scaling on a tilt factor component, the second of the two dimensions must be periodic. E.g. if the xy component is specified, then the y dimension must be periodic. @@ -1429,7 +1429,7 @@ Doc page with :doc:`WARNING messages ` This would be changing the same box dimension twice. *Cannot use fix nvt/npt/nph on a 2nd non-periodic dimension* - When specifying an off-diagonal pressure component, the 2nd of the two + When specifying an off-diagonal pressure component, the second of the two dimensions must be periodic. E.g. if the xy component is specified, then the y dimension must be periodic. @@ -1447,13 +1447,13 @@ Doc page with :doc:`WARNING messages ` Self-explanatory. *Cannot use fix nvt/npt/nph with xy scaling when y is non-periodic dimension* - The 2nd dimension in the barostatted tilt factor must be periodic. + The second dimension in the barostatted tilt factor must be periodic. *Cannot use fix nvt/npt/nph with xz scaling when z is non-periodic dimension* - The 2nd dimension in the barostatted tilt factor must be periodic. + The second dimension in the barostatted tilt factor must be periodic. *Cannot use fix nvt/npt/nph with yz scaling when z is non-periodic dimension* - The 2nd dimension in the barostatted tilt factor must be periodic. + The second dimension in the barostatted tilt factor must be periodic. *Cannot use fix pour rigid and not molecule* Self-explanatory. @@ -7192,7 +7192,7 @@ keyword to allow for additional bonds to be formed does not exist. *Replacing a fix, but new style != old style* - A fix ID can be used a 2nd time, but only if the style matches the + A fix ID can be used a second time, but only if the style matches the previous fix. In this case it is assumed you with to reset a fix's parameters. This error may mean you are mistakenly re-using a fix ID when you do not intend to. diff --git a/doc/src/Errors_warnings.rst b/doc/src/Errors_warnings.rst index dbe830c8bf..ceccc0b74c 100644 --- a/doc/src/Errors_warnings.rst +++ b/doc/src/Errors_warnings.rst @@ -43,17 +43,17 @@ Doc page with :doc:`ERROR messages ` Self-explanatory. *Bond atom missing in box size check* - The 2nd atoms needed to compute a particular bond is missing on this + The second atom needed to compute a particular bond is missing on this processor. Typically this is because the pairwise cutoff is set too short or the bond has blown apart and an atom is too far away. *Bond atom missing in image check* - The 2nd atom in a particular bond is missing on this processor. + The second atom in a particular bond is missing on this processor. Typically this is because the pairwise cutoff is set too short or the bond has blown apart and an atom is too far away. *Bond atoms missing at step %ld* - The 2nd atom needed to compute a particular bond is missing on this + The second atom needed to compute a particular bond is missing on this processor. Typically this is because the pairwise cutoff is set too short or the bond has blown apart and an atom is too far away. @@ -486,7 +486,7 @@ This will most likely cause errors in kinetic fluctuations. a new style. *No Kspace calculation with verlet/split* - The 2nd partition performs a kspace calculation so the kspace_style + The second partition performs a kspace calculation so the kspace_style command must be used. *No automatic unit conversion to XTC file format conventions possible for units lj* diff --git a/doc/src/Examples.rst b/doc/src/Examples.rst index b94db208d9..dc122f2c78 100644 --- a/doc/src/Examples.rst +++ b/doc/src/Examples.rst @@ -163,7 +163,7 @@ Here is how you can run and visualize one of the sample problems: Running the simulation produces the files *dump.indent* and *log.lammps*\ . You can visualize the dump file of snapshots with a -variety of 3rd-party tools highlighted on the +variety of third-party tools highlighted on the `Visualization `_ page of the LAMMPS web site. diff --git a/doc/src/Howto_chunk.rst b/doc/src/Howto_chunk.rst index cdc0c30d9b..75fb30815b 100644 --- a/doc/src/Howto_chunk.rst +++ b/doc/src/Howto_chunk.rst @@ -197,7 +197,7 @@ compress individual polymer chains (molecules) in a mixture, is explained on the :doc:`compute chunk/spread/atom ` command doc page. (7) An example for using one set of per-chunk values for molecule -chunks, to create a 2nd set of micelle-scale chunks (clustered +chunks, to create a second set of micelle-scale chunks (clustered molecules, due to hydrophobicity), is explained on the :doc:`compute chunk/reduce ` command doc page. (8) An example for using one set of per-chunk values (dipole moment diff --git a/doc/src/Howto_cmake.rst b/doc/src/Howto_cmake.rst index 9028893ddb..490de635b5 100644 --- a/doc/src/Howto_cmake.rst +++ b/doc/src/Howto_cmake.rst @@ -114,19 +114,19 @@ summary screen will look like this: -- Detecting CXX compiler ABI info - done -- Detecting CXX compile features -- Detecting CXX compile features - done - -- Found Git: /usr/bin/git (found version "2.25.2") + -- Found Git: /usr/bin/git (found version "2.25.2") -- Running check for auto-generated files from make-based build system - -- Found MPI_CXX: /usr/lib64/mpich/lib/libmpicxx.so (found version "3.1") - -- Found MPI: TRUE (found version "3.1") + -- Found MPI_CXX: /usr/lib64/mpich/lib/libmpicxx.so (found version "3.1") + -- Found MPI: TRUE (found version "3.1") -- Looking for C++ include omp.h -- Looking for C++ include omp.h - found - -- Found OpenMP_CXX: -fopenmp (found version "4.5") - -- Found OpenMP: TRUE (found version "4.5") - -- Found JPEG: /usr/lib64/libjpeg.so (found version "62") - -- Found PNG: /usr/lib64/libpng.so (found version "1.6.37") - -- Found ZLIB: /usr/lib64/libz.so (found version "1.2.11") - -- Found GZIP: /usr/bin/gzip - -- Found FFMPEG: /usr/bin/ffmpeg + -- Found OpenMP_CXX: -fopenmp (found version "4.5") + -- Found OpenMP: TRUE (found version "4.5") + -- Found JPEG: /usr/lib64/libjpeg.so (found version "62") + -- Found PNG: /usr/lib64/libpng.so (found version "1.6.37") + -- Found ZLIB: /usr/lib64/libz.so (found version "1.2.11") + -- Found GZIP: /usr/bin/gzip + -- Found FFMPEG: /usr/bin/ffmpeg -- Performing Test COMPILER_SUPPORTS-ffast-math -- Performing Test COMPILER_SUPPORTS-ffast-math - Success -- Performing Test COMPILER_SUPPORTS-march=native @@ -143,7 +143,7 @@ summary screen will look like this: * JPEG * PNG * ZLIB - + -- <<< Build configuration >>> Build type: RelWithDebInfo Install path: /home/akohlmey/.local @@ -157,7 +157,7 @@ summary screen will look like this: Options: -ffast-math;-march=native -- <<< Linker flags: >>> -- Executable name: lmp - -- Static library flags: + -- Static library flags: -- <<< MPI flags >>> -- MPI includes: /usr/include/mpich-x86_64 -- MPI libraries: /usr/lib64/mpich/lib/libmpicxx.so;/usr/lib64/mpich/lib/libmpi.so; @@ -291,7 +291,7 @@ Some common CMake variables .. list-table:: :header-rows: 1 - + * - Variable - Description * - ``CMAKE_INSTALL_PREFIX`` @@ -313,13 +313,13 @@ Some common CMake variables - Fortran compiler to be used for compilation (default: system specific, ``gfortran`` on Linux) * - ``CXX_COMPILER_LAUNCHER`` - tool to launch the C++ compiler, e.g. ``ccache`` or ``distcc`` for faster compilation (default: empty) - + Some common LAMMPS specific variables ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. list-table:: :header-rows: 1 - + * - Variable - Description * - ``BUILD_MPI`` @@ -438,7 +438,7 @@ the target name to the command. Example: ``cmake --build . --target all`` or * - ``clean`` - remove all generated files - + Choosing generators ------------------- diff --git a/doc/src/Howto_coreshell.rst b/doc/src/Howto_coreshell.rst index 94fb5b7b42..0c1fc924ac 100644 --- a/doc/src/Howto_coreshell.rst +++ b/doc/src/Howto_coreshell.rst @@ -119,7 +119,7 @@ non-polarized ions (ions without an attached satellite particle). The groups, one for the core atoms, another for the shell atoms. Non-polarized ions which might also be included in the treated system should not be included into either of these groups, they are taken -into account by the *group-ID* (2nd argument) of the compute. The +into account by the *group-ID* (second argument) of the compute. The groups can be defined using the :doc:`group *type*\ ` command. Note that to perform thermostatting using this definition of temperature, the :doc:`fix modify temp ` command should be diff --git a/doc/src/Howto_multiple.rst b/doc/src/Howto_multiple.rst index ec2729acf0..f86bcccca4 100644 --- a/doc/src/Howto_multiple.rst +++ b/doc/src/Howto_multiple.rst @@ -91,4 +91,4 @@ With these modifications, the 8 simulations of each script would run on the 3 partitions one after the other until all were finished. Initially, 3 simulations would be started simultaneously, one on each partition. When one finished, that partition would then start -the 4th simulation, and so forth, until all 8 were completed. +the fourth simulation, and so forth, until all 8 were completed. diff --git a/doc/src/Howto_restart.rst b/doc/src/Howto_restart.rst index 6323ba4158..25f311f5a7 100644 --- a/doc/src/Howto_restart.rst +++ b/doc/src/Howto_restart.rst @@ -28,7 +28,7 @@ scripts are based on. If that script had the line added to it, it would produce 2 binary restart files (tmp.restart.50 and tmp.restart.100) as it ran. -This script could be used to read the 1st restart file and re-run the +This script could be used to read the first restart file and re-run the last 50 timesteps: .. code-block:: LAMMPS diff --git a/doc/src/Howto_triclinic.rst b/doc/src/Howto_triclinic.rst index 632d0364d5..13383f44df 100644 --- a/doc/src/Howto_triclinic.rst +++ b/doc/src/Howto_triclinic.rst @@ -85,7 +85,7 @@ where *V* is the volume of the box, **X** is the original vector quantity and **x** is the vector in the LAMMPS basis. There is no requirement that a triclinic box be periodic in any -dimension, though it typically should be in at least the 2nd dimension +dimension, though it typically should be in at least the second dimension of the tilt (y in xy) if you want to enforce a shift in periodic boundary conditions across that boundary. Some commands that work with triclinic boxes, e.g. the :doc:`fix deform ` and :doc:`fix npt ` commands, require periodicity or non-shrink-wrap @@ -120,7 +120,7 @@ The 9 parameters, as well as lx,ly,lz, can be output via the To avoid extremely tilted boxes (which would be computationally inefficient), LAMMPS normally requires that no tilt factor can skew the box more than half the distance of the parallel box length, which -is the 1st dimension in the tilt factor (x for xz). This is required +is the first dimension in the tilt factor (x for xz). This is required both when the simulation box is created, e.g. via the :doc:`create_box ` or :doc:`read_data ` commands, as well as when the box shape changes dynamically during a simulation, @@ -137,7 +137,7 @@ limit during a dynamics run (e.g. via the :doc:`fix deform ` command), then the box is "flipped" to an equivalent shape with a tilt factor within the bounds, so the run can continue. See the :doc:`fix deform ` doc page for further details. -One exception to this rule is if the 1st dimension in the tilt +One exception to this rule is if the first dimension in the tilt factor (x for xy) is non-periodic. In that case, the limits on the tilt factor are not enforced, since flipping the box in that dimension does not change the atom positions due to non-periodicity. In this diff --git a/doc/src/Intro_nonfeatures.rst b/doc/src/Intro_nonfeatures.rst index feb35c7198..fb41b9a054 100644 --- a/doc/src/Intro_nonfeatures.rst +++ b/doc/src/Intro_nonfeatures.rst @@ -34,7 +34,7 @@ Here are suggestions on how to perform these tasks: molecular builder that will generate complex molecular models. See the :doc:`Tools ` doc page for details on tools packaged with LAMMPS. The `Pre/post processing page `_ of the LAMMPS website - describes a variety of 3rd party tools for this task. Furthermore, + describes a variety of third party tools for this task. Furthermore, some LAMMPS internal commands allow to reconstruct, or selectively add topology information, as well as provide the option to insert molecule templates instead of atoms for building bulk molecular systems. diff --git a/doc/src/Manual.rst b/doc/src/Manual.rst index a9afb122ad..773a5fbd75 100644 --- a/doc/src/Manual.rst +++ b/doc/src/Manual.rst @@ -32,11 +32,12 @@ a brief description of the basic code structure of LAMMPS. ---------- -Once you are familiar with LAMMPS, you may want to bookmark :doc:`this page ` since it gives quick access to a doc page for +Once you are familiar with LAMMPS, you may want to bookmark :doc:`this page ` since it gives quick access to a doc page for every LAMMPS command. .. _lws: https://lammps.sandia.gov +.. _user_documentation: .. toctree:: :maxdepth: 2 :numbered: 3 diff --git a/doc/src/Manual_build.rst b/doc/src/Manual_build.rst index 5d5b749678..972f38bf2e 100644 --- a/doc/src/Manual_build.rst +++ b/doc/src/Manual_build.rst @@ -1,60 +1,62 @@ Building the LAMMPS manual ************************** -Depending on how you obtained LAMMPS, the doc directory has up -to 6 sub-directories, 2 Nroff files, and optionally 2 PDF files -plus 2 e-book format files: +Depending on how you obtained LAMMPS and whether you have built the +manual yourself, this directory has a number of sub-directories and +files. Here is a list with descriptions: .. code-block:: bash - src # content files for LAMMPS documentation - html # HTML version of the LAMMPS manual (see html/Manual.html) - utils # tools and settings for building the documentation - docenv # virtualenv for processing the manual sources - doctrees # temporary data from processing the manual - mathjax # code and fonts for rendering math in html - Manual.pdf # large PDF version of entire manual - Developer.pdf # small PDF with info about how LAMMPS is structured - LAMMPS.epub # Manual in ePUB e-book format - LAMMPS.mobi # Manual in MOBI e-book format - lammps.1 # man page for the lammps command - msi2lmp.1 # man page for the msi2lmp command + README # brief info about the documentation + src # content files for LAMMPS documentation + html # HTML version of the LAMMPS manual (see html/Manual.html) + utils # tools and settings for building the documentation + lammps.1 # man page for the lammps command + msi2lmp.1 # man page for the msi2lmp command + Manual.pdf # large PDF version of entire manual + Developer.pdf # small PDF with info about how LAMMPS is structured + LAMMPS.epub # Manual in ePUB e-book format + LAMMPS.mobi # Manual in MOBI e-book format + docenv # virtualenv folder for processing the manual sources + doctrees # temporary data from processing the manual + mathjax # code and fonts for rendering math in html + doxygen # doxygen configuration and output + .gitignore # list of files and folders to be ignored by git + doxygen-warn.log # logfile with warnings from running doxygen + github-development-workflow.md # notes on the LAMMPS development workflow + include-file-conventions.md # notes on LAMMPS' include file conventions -If you downloaded LAMMPS as a tarball from the web site, the html folder -and the PDF files should be included. +If you downloaded LAMMPS as a tarball from `the LAMMPS website `_, +the html folder and the PDF files should be included. If you downloaded LAMMPS from the public git repository, then the HTML and PDF files are not included. Instead you need to create them, in one of two ways: a. You can "fetch" the current HTML and PDF files from the LAMMPS web - site. Just type "make fetch". This should download a html_www + site. Just type ``make fetch``. This should download a html_www directory and Manual_www.pdf/Developer_www.pdf files. Note that if new LAMMPS features have been added more recently than the date of your LAMMPS version, the fetched documentation will include those changes (but your source code will not, unless you update your local repository). -b. You can build the HTML or PDF files yourself, by typing "make html" - or "make pdf". This requires various tools including Sphinx, git, - and the MathJax javascript library, which the build process will attempt - to download automatically into a virtual environment in the folder - doc/docenv and the folder mathjax, respectively, if not already available. - This download is required only once, unless you type "make clean-all". - After that, viewing and processing of the documentation can be done - without internet access. To generate the PDF version of the manual, - the PDFLaTeX software and several LaTeX packages are required as well. - However, those cannot be installed automatically at the moment. +b. You can build the HTML or PDF files yourself, by typing ``make html`` + or ``make pdf``. This requires various tools and files. Some of them + have to be installed (more on that below). For the rest the build + process will attempt to download and install them into a python + virtual environment and local folders. This download is required + only once, unless you type ``make clean-all``. After that, viewing and + processing of the documentation can be done without internet access. ---------- -The generation of all documentation is managed by the Makefile in -the doc directory. +The generation of all documentation is managed by the Makefile in the +doc directory. The following documentation related make commands are +available: .. code-block:: bash - Documentation Build Options: - make html # generate HTML in html dir using Sphinx make pdf # generate 2 PDF files (Manual.pdf,Developer.pdf) # in doc dir via htmldoc and pdflatex @@ -62,8 +64,10 @@ the doc directory. # as a tarball and unpack into html dir and 2 PDFs make epub # generate LAMMPS.epub in ePUB format using Sphinx make mobi # generate LAMMPS.mobi in MOBI format using ebook-convert + make clean # remove intermediate RST files created by HTML build make clean-all # remove entire build folder and any cached data + make anchor_check # check for duplicate anchor labels make style_check # check for complete and consistent style lists make package_check # check for complete and consistent package lists @@ -74,29 +78,30 @@ the doc directory. Installing prerequisites for HTML build ======================================= -To run the HTML documentation build toolchain, Python 3 and virtualenv -have to be installed. Here are instructions for common setups: +To run the HTML documentation build toolchain, python 3, git, doxygen, +and virtualenv have to be installed locally. Here are instructions for +common setups: Ubuntu ------ .. code-block:: bash - sudo apt-get install python-virtualenv + sudo apt-get install python-virtualenv git doxygen Fedora (up to version 21) and Red Hat Enterprise Linux or CentOS (up to version 7.x) ------------------------------------------------------------------------------------ .. code-block:: bash - sudo yum install python3-virtualenv + sudo yum install python3-virtualenv git doxygen Fedora (since version 22) ------------------------- .. code-block:: bash - sudo dnf install python3-virtualenv + sudo dnf install python3-virtualenv git doxygen MacOS X ------- @@ -120,22 +125,92 @@ Once Python 3 is installed, open a Terminal and type This will install virtualenv from the Python Package Index. ----------- +Installing prerequisites for PDF build +====================================== -Installing prerequisites for epub build -======================================= +In addition to the tools needed for building the HTML format manual, +a working LaTeX installation with support for PDFLaTeX and a selection +of LaTeX styles/packages are required. -ePUB ----- +Installing prerequisites for e-book reader builds +================================================= -Same as for HTML. This uses mostly the same tools and configuration -files as the HTML tree. In addition it uses LaTeX to convert embedded +In addition to the tools needed for building the HTML format manual, +a working LaTeX installation with a few add-on LaTeX packages +as well as the ``dvipng`` tool are required to convert embedded math expressions transparently into embedded images. -For converting the generated ePUB file to a MOBI format file -(for e-book readers, like Kindle, that cannot read ePUB), you -also need to have the 'ebook-convert' tool from the "calibre" -software installed. `http://calibre-ebook.com/ `_ -You first create the ePUB file and then convert it with 'make mobi' -On the Kindle readers in particular, you also have support for -PDF files, so you could download and view the PDF version as an alternative. +For converting the generated ePUB file to a MOBI format file (for e-book +readers, like Kindle, that cannot read ePUB), you also need to have the +``ebook-convert`` tool from the "calibre" software +installed. `http://calibre-ebook.com/ `_ +Typing ``make mobi`` will first create the ePUB file and then convert +it. On the Kindle readers in particular, you also have support for PDF +files, so you could download and view the PDF version as an alternative. + + +Instructions for Developers +=========================== + +When adding new styles or options to the LAMMPS code, corresponding +documentation is required and either existing files in the ``src`` +folder need to be updated or new files added. These files are written +in `reStructuredText `_ markup for translation with the Sphinx tool. + +Before contributing any documentation, please check that both the HTML +and the PDF format documentation can translate without errors. Please also +check the output to the console for any warnings or problems. There will +be multiple tests run automatically: + +- A test for correctness of all anchor labels and their references + +- A test that all LAMMPS packages (= folders with sources in + ``lammps/src``) are documented and listed. A typical warning shows + the name of the folder with the suspected new package code and the + documentation files where they need to be listed: + + .. parsed-literal:: + + Found 33 standard and 41 user packages + Standard package NEWPACKAGE missing in Packages_standard.rst + Standard package NEWPACKAGE missing in Packages_details.rst + +- A test that only standard, printable ASCII text characters are used. + This runs the command ``env LC_ALL=C grep -n '[^ -~]' src/*.rst`` and + thus prints all offending lines with filename and line number + prepended to the screen. Special characters like the Angstrom + :math:`\mathrm{\mathring{A}}` should be typeset with embedded math + (like this ``:math:`\mathrm{\mathring{A}}```\ ). + +- A test whether all styles are documented and listed in their + respective overview pages. A typical output with warnings looks like this: + + .. parsed-literal:: + + Parsed style names w/o suffixes from C++ tree in ../src: + Angle styles: 21 Atom styles: 24 + Body styles: 3 Bond styles: 17 + Command styles: 41 Compute styles: 143 + Dihedral styles: 16 Dump styles: 26 + Fix styles: 223 Improper styles: 13 + Integrate styles: 4 Kspace styles: 15 + Minimize styles: 9 Pair styles: 234 + Reader styles: 4 Region styles: 8 + Compute style entry newcomp is missing or incomplete in Commands_compute.rst + Compute style entry newcomp is missing or incomplete in compute.rst + Fix style entry newfix is missing or incomplete in Commands_fix.rst + Fix style entry newfix is missing or incomplete in fix.rst + Pair style entry new is missing or incomplete in Commands_pair.rst + Pair style entry new is missing or incomplete in pair_style.rst + Found 6 issue(s) with style lists + + +In addition, there is the option to run a spellcheck on the entire +manual with ``make spelling``. This requires `a library called enchant +`_. To avoid printing out *false +positives* (e.g. keywords, names, abbreviations) those can be added to +the file ``lammps/doc/utils/sphinx-config/false_positives.txt``. + +.. _rst: https://docutils.readthedocs.io/en/sphinx-docs/user/rst/quickstart.html + +.. _lws: https://lammps.sandia.gov diff --git a/doc/src/Modify_fix.rst b/doc/src/Modify_fix.rst index 9a97e30fbe..556c858735 100644 --- a/doc/src/Modify_fix.rst +++ b/doc/src/Modify_fix.rst @@ -27,7 +27,7 @@ derived class. See fix.h for details. +---------------------------+--------------------------------------------------------------------------------------------+ | setup_pre_force | called before force computation in setup (optional) | +---------------------------+--------------------------------------------------------------------------------------------+ -| setup | called immediately before the 1st timestep and after forces are computed (optional) | +| setup | called immediately before the first timestep and after forces are computed (optional) | +---------------------------+--------------------------------------------------------------------------------------------+ | min_setup_pre_force | like setup_pre_force, but for minimizations instead of MD runs (optional) | +---------------------------+--------------------------------------------------------------------------------------------+ diff --git a/doc/src/Modify_kspace.rst b/doc/src/Modify_kspace.rst index e1b10eac8d..b4f92e4116 100644 --- a/doc/src/Modify_kspace.rst +++ b/doc/src/Modify_kspace.rst @@ -10,12 +10,12 @@ Ewald.cpp is an example of computing K-space interactions. Here is a brief description of methods you define in your new derived class. See kspace.h for details. -+---------------+----------------------------------------------+ -| init | initialize the calculation before a run | -+---------------+----------------------------------------------+ -| setup | computation before the 1st timestep of a run | -+---------------+----------------------------------------------+ -| compute | every-timestep computation | -+---------------+----------------------------------------------+ -| memory_usage | tally of memory usage | -+---------------+----------------------------------------------+ ++---------------+------------------------------------------------+ +| init | initialize the calculation before a run | ++---------------+------------------------------------------------+ +| setup | computation before the first timestep of a run | ++---------------+------------------------------------------------+ +| compute | every-timestep computation | ++---------------+------------------------------------------------+ +| memory_usage | tally of memory usage | ++---------------+------------------------------------------------+ diff --git a/doc/src/Packages_details.rst b/doc/src/Packages_details.rst index 2353df777f..cc9f675e26 100644 --- a/doc/src/Packages_details.rst +++ b/doc/src/Packages_details.rst @@ -489,7 +489,7 @@ interactions. These include Ewald, particle-particle particle-mesh Building with this package requires a 1d FFT library be present on your system for use by the PPPM solvers. This can be the KISS FFT -library provided with LAMMPS, 3rd party libraries like FFTW, or a +library provided with LAMMPS, third party libraries like FFTW, or a vendor-supplied FFT library. See the :doc:`Build settings ` doc page for details on how to select different FFT options for your LAMPMS build. diff --git a/doc/src/Python_library.rst b/doc/src/Python_library.rst index 2100074c4e..370c67b3f8 100644 --- a/doc/src/Python_library.rst +++ b/doc/src/Python_library.rst @@ -254,12 +254,3 @@ following steps: * You should now be able to invoke the new interface function from a Python script. ----------- - -.. autoclass:: lammps.lammps - :members: - :no-undoc-members: - -.. autoclass:: lammps.NeighList - :members: - :no-undoc-members: diff --git a/doc/src/Python_test.rst b/doc/src/Python_test.rst index 55a1c0a2d3..1f7f9d46e8 100644 --- a/doc/src/Python_test.rst +++ b/doc/src/Python_test.rst @@ -10,7 +10,7 @@ and type: >>> lmp = lammps() If you get no errors, you're ready to use LAMMPS from Python. If the -2nd command fails, the most common error to see is +second command fails, the most common error to see is .. parsed-literal:: diff --git a/doc/src/Run_options.rst b/doc/src/Run_options.rst index afdae20376..054ed66d57 100644 --- a/doc/src/Run_options.rst +++ b/doc/src/Run_options.rst @@ -324,17 +324,17 @@ physical processors is done by MPI before LAMMPS begins. It may be useful in some cases to alter the rank order. E.g. to insure that cores within each node are ranked in a desired order. Or when using the :doc:`run_style verlet/split ` command with 2 partitions -to insure that a specific Kspace processor (in the 2nd partition) is -matched up with a specific set of processors in the 1st partition. +to insure that a specific Kspace processor (in the second partition) is +matched up with a specific set of processors in the first partition. See the :doc:`Speed tips ` doc page for more details. If the keyword *nth* is used with a setting *N*\ , then it means every Nth processor will be moved to the end of the ranking. This is useful when using the :doc:`run_style verlet/split ` command with 2 partitions via the -partition command-line switch. The first set of -processors will be in the first partition, the 2nd set in the 2nd +processors will be in the first partition, the second set in the second partition. The -reorder command-line switch can alter this so that -the 1st N procs in the 1st partition and one proc in the 2nd partition +the first N procs in the first partition and one proc in the second partition will be ordered consecutively, e.g. as the cores on one physical node. This can boost performance. For example, if you use "-reorder nth 4" and "-partition 9 3" and you are running on 12 processors, the diff --git a/doc/src/angle_charmm.rst b/doc/src/angle_charmm.rst index a8c227c765..98b2f468a8 100644 --- a/doc/src/angle_charmm.rst +++ b/doc/src/angle_charmm.rst @@ -37,7 +37,7 @@ The *charmm* angle style uses the potential E = K (\theta - \theta_0)^2 + K_{ub} (r - r_{ub})^2 with an additional Urey_Bradley term based on the distance :math:`r` between -the 1st and 3rd atoms in the angle. :math:`K`, :math:`\theta_0`, +the first and third atoms in the angle. :math:`K`, :math:`\theta_0`, :math:`K_{ub}`, and :math:`R_{ub}` are coefficients defined for each angle type. diff --git a/doc/src/angle_coeff.rst b/doc/src/angle_coeff.rst index 9066b45462..565d094d4d 100644 --- a/doc/src/angle_coeff.rst +++ b/doc/src/angle_coeff.rst @@ -31,7 +31,7 @@ Angle coefficients can also be set in the data file read by the :doc:`read_data ` command or in a restart file. N can be specified in one of two ways. An explicit numeric value can -be used, as in the 1st example above. Or a wild-card asterisk can be +be used, as in the first example above. Or a wild-card asterisk can be used to set the coefficients for multiple angle types. This takes the form "\*" or "\*n" or "n\*" or "m\*n". If N = the number of angle types, then an asterisk with no numeric values means all types from 1 to N. A @@ -53,7 +53,7 @@ same format as the arguments of the :doc:`angle_coeff ` command in script, except that wild-card asterisks should not be used since coefficients for all N types must be listed in the file. For example, under the "Angle Coeffs" section of a data file, the line that -corresponds to the 1st example above would be listed as +corresponds to the first example above would be listed as .. parsed-literal:: diff --git a/doc/src/angle_table.rst b/doc/src/angle_table.rst index 729d890d67..77fbf73047 100644 --- a/doc/src/angle_table.rst +++ b/doc/src/angle_table.rst @@ -75,7 +75,7 @@ parenthesized comments): ... 181 180.0 0.0 0.0 -A section begins with a non-blank line whose 1st character is not a +A section begins with a non-blank line whose first character is not a "#"; blank lines or lines starting with "#" can be used as comments between sections. The first line begins with a keyword which identifies the section. The line can contain additional text, but the @@ -99,7 +99,7 @@ is in the tabulated file (with effectively no preliminary interpolation), you should set Ntable = Nfile. The "FP" parameter is optional. If used, it is followed by two values -fplo and fphi, which are the 2nd derivatives at the innermost and +fplo and fphi, which are the second derivatives at the innermost and outermost angle settings. These values are needed by the spline construction routines. If not specified by the "FP" parameter, they are estimated (less accurately) by the first two and last two @@ -110,9 +110,9 @@ equilibrium angle value, which is used, for example, by the :doc:`fix shake ` instance * control = name of the AtC sub-command * physics_type = *thermal* or *momentum* @@ -52,7 +52,7 @@ the finite element temperature. *flux* is a similar mode, but rather adds energy to the atoms based on conservation of energy. *correction_max_iterations* sets the maximum number of iterations to -compute the 2nd order in time correction term for lambda with the +compute the second order in time correction term for lambda with the fractional step method. The method uses the same tolerance as the controller's matrix solver. diff --git a/doc/src/atc_control_thermal.rst b/doc/src/atc_control_thermal.rst index dc3f28f8eb..d6d6c25405 100644 --- a/doc/src/atc_control_thermal.rst +++ b/doc/src/atc_control_thermal.rst @@ -56,7 +56,7 @@ adds energy to the atoms based on conservation of energy. *hoover* and atoms. *correction_max_iterations* sets the maximum number of iterations to -compute the 2nd order in time correction term for lambda with the +compute the second order in time correction term for lambda with the fractional step method. The method uses the same tolerance as the controller's matrix solver. diff --git a/doc/src/atc_hardy_fields.rst b/doc/src/atc_hardy_fields.rst index 70f3360af8..bef051bbe8 100644 --- a/doc/src/atc_hardy_fields.rst +++ b/doc/src/atc_hardy_fields.rst @@ -25,8 +25,8 @@ Syntax - temperature : temperature derived from the relative atomic kinetic energy - kinetic_temperature : temperature derived from the full kinetic energy - number_density : simple kernel estimation of number of atoms per unit volume - - stress : Cauchy stress tensor for eulerian analysis (atom_element_map), or 1st Piola-Kirchhoff stress tensor for lagrangian analysis - - transformed_stress : 1st Piola-Kirchhoff stress tensor for eulerian analysis (atom_element_map), or Cauchy stress tensor for lagrangian analysis + - stress : Cauchy stress tensor for eulerian analysis (atom_element_map), or first Piola-Kirchhoff stress tensor for lagrangian analysis + - transformed_stress : first Piola-Kirchhoff stress tensor for eulerian analysis (atom_element_map), or Cauchy stress tensor for lagrangian analysis - heat_flux : spatial heat flux vector for eulerian, or referential heat flux vector for lagrangian - potential_energy : potential energy per unit volume - kinetic_energy : kinetic energy per unit volume @@ -37,7 +37,7 @@ Syntax - eshelby_stress : configurational stress (energy-momentum) tensor defined by [Eshelby]_ - vacancy_concentration : volume fraction of vacancy content - type_concentration : volume fraction of a specific atom type - + Examples """""""" diff --git a/doc/src/atc_hardy_gradients.rst b/doc/src/atc_hardy_gradients.rst index 36fad76afe..2e7649d73c 100644 --- a/doc/src/atc_hardy_gradients.rst +++ b/doc/src/atc_hardy_gradients.rst @@ -23,8 +23,8 @@ Syntax - temperature : temperature derived from the relative atomic kinetic energy - kinetic_temperature : temperature derived from the full kinetic energy - number_density : simple kernel estimation of number of atoms per unit volume - - stress : Cauchy stress tensor for eulerian analysis (atom_element_map), or 1st Piola-Kirchhoff stress tensor for lagrangian analysis - - transformed_stress : 1st Piola-Kirchhoff stress tensor for eulerian analysis (atom_element_map), or Cauchy stress tensor for lagrangian analysis + - stress : Cauchy stress tensor for eulerian analysis (atom_element_map), or first Piola-Kirchhoff stress tensor for lagrangian analysis + - transformed_stress : first Piola-Kirchhoff stress tensor for eulerian analysis (atom_element_map), or Cauchy stress tensor for lagrangian analysis - heat_flux : spatial heat flux vector for eulerian, or referential heat flux vector for lagrangian - potential_energy : potential energy per unit volume - kinetic_energy : kinetic energy per unit volume diff --git a/doc/src/atc_hardy_kernel.rst b/doc/src/atc_hardy_kernel.rst index a52f2a9968..74316ec8b2 100644 --- a/doc/src/atc_hardy_kernel.rst +++ b/doc/src/atc_hardy_kernel.rst @@ -25,7 +25,7 @@ Syntax - *quartic_bar* : - *quartic_cylinder* : - *quartic_sphere* : - + Examples diff --git a/doc/src/atc_hardy_rates.rst b/doc/src/atc_hardy_rates.rst index 890ada0c47..56166087d7 100644 --- a/doc/src/atc_hardy_rates.rst +++ b/doc/src/atc_hardy_rates.rst @@ -23,8 +23,8 @@ Syntax - temperature : temperature derived from the relative atomic kinetic energy - kinetic_temperature : temperature derived from the full kinetic energy - number_density : simple kernel estimation of number of atoms per unit volume - - stress : Cauchy stress tensor for eulerian analysis (atom_element_map), or 1st Piola-Kirchhoff stress tensor for lagrangian analysis - - transformed_stress : 1st Piola-Kirchhoff stress tensor for eulerian analysis (atom_element_map), or Cauchy stress tensor for lagrangian analysis + - stress : Cauchy stress tensor for eulerian analysis (atom_element_map), or first Piola-Kirchhoff stress tensor for lagrangian analysis + - transformed_stress : first Piola-Kirchhoff stress tensor for eulerian analysis (atom_element_map), or Cauchy stress tensor for lagrangian analysis - heat_flux : spatial heat flux vector for eulerian, or referential heat flux vector for lagrangian - potential_energy : potential energy per unit volume - kinetic_energy : kinetic energy per unit volume diff --git a/doc/src/atc_remove_species.rst b/doc/src/atc_remove_species.rst index 20e1f6a742..5c4fd771ba 100644 --- a/doc/src/atc_remove_species.rst +++ b/doc/src/atc_remove_species.rst @@ -38,7 +38,7 @@ Related AtC commands - :doc:`fix_modify AtC add_species ` - :doc:`fix_modify AtC add_molecule ` - :doc:`fix_modify AtC remove_molecule ` - + Default """"""" diff --git a/doc/src/atc_set_reference_pe.rst b/doc/src/atc_set_reference_pe.rst index ff4d95526f..8053a1df98 100644 --- a/doc/src/atc_set_reference_pe.rst +++ b/doc/src/atc_set_reference_pe.rst @@ -22,7 +22,7 @@ Examples fix_modify AtC set reference_potential_energy fix_modify AtC set reference_potential_energy -0.05 - fix_modify AtC set reference_potential_energy myPEvalues + fix_modify AtC set reference_potential_energy myPEvalues Description """"""""""" diff --git a/doc/src/atc_time_integration.rst b/doc/src/atc_time_integration.rst index 580be0430c..cf746dde0d 100644 --- a/doc/src/atc_time_integration.rst +++ b/doc/src/atc_time_integration.rst @@ -33,11 +33,11 @@ Command to select the thermal or momentum time integration. Options for thermal time integration: *gear* - atomic velocity update with 2nd order Verlet, nodal temperature update - with 3rd or 4th order Gear, thermostats based on controlling power + atomic velocity update with second order Verlet, nodal temperature update + with third or fourth order Gear, thermostats based on controlling power *fractional_step* - atomic velocity update with 2nd order Verlet, mixed nodal temperature + atomic velocity update with second order Verlet, mixed nodal temperature update, 3/4 Gear for continuum and 2 Verlet for atomic contributions, thermostats based on controlling discrete energy changes @@ -46,18 +46,18 @@ Options for thermal time integration: Options for momentum time integration: *verlet* - atomic velocity update with 2nd order Verlet, nodal temperature update - with 2nd order Verlet, kinetostats based on controlling force + atomic velocity update with second order Verlet, nodal temperature update + with second order Verlet, kinetostats based on controlling force *fractional_step* - atomic velocity update with 2nd order Verlet, mixed nodal momentum - update, 2nd order Verlet for continuum and exact 2nd order Verlet for + atomic velocity update with second order Verlet, mixed nodal momentum + update, second order Verlet for continuum and exact second order Verlet for atomic contributions, kinetostats based on controlling discrete momentum changes *gear* - atomic velocity update with 2nd order Verlet, nodal temperature update - with 3rd or 4th order Gear, kinetostats based on controlling power. + atomic velocity update with second order Verlet, nodal temperature update + with third or fourth order Gear, kinetostats based on controlling power. --------- diff --git a/doc/src/bond_coeff.rst b/doc/src/bond_coeff.rst index 416190a367..39d1bbcd17 100644 --- a/doc/src/bond_coeff.rst +++ b/doc/src/bond_coeff.rst @@ -32,7 +32,7 @@ Bond coefficients can also be set in the data file read by the :doc:`read_data ` command or in a restart file. N can be specified in one of two ways. An explicit numeric value can -be used, as in the 1st example above. Or a wild-card asterisk can be +be used, as in the first example above. Or a wild-card asterisk can be used to set the coefficients for multiple bond types. This takes the form "\*" or "\*n" or "n\*" or "m\*n". If N = the number of bond types, then an asterisk with no numeric values means all types from 1 to N. A @@ -54,7 +54,7 @@ same format as the arguments of the bond_coeff command in an input script, except that wild-card asterisks should not be used since coefficients for all N types must be listed in the file. For example, under the "Bond Coeffs" section of a data file, the line that -corresponds to the 1st example above would be listed as +corresponds to the first example above would be listed as .. parsed-literal:: diff --git a/doc/src/bond_fene.rst b/doc/src/bond_fene.rst index 3ba9672294..3929665b4f 100644 --- a/doc/src/bond_fene.rst +++ b/doc/src/bond_fene.rst @@ -38,8 +38,8 @@ The *fene* bond style uses the potential to define a finite extensible nonlinear elastic (FENE) potential :ref:`(Kremer) `, used for bead-spring polymer models. The first -term is attractive, the 2nd Lennard-Jones term is repulsive. The -first term extends to :math:`R_0`, the maximum extent of the bond. The 2nd +term is attractive, the second Lennard-Jones term is repulsive. The +first term extends to :math:`R_0`, the maximum extent of the bond. The second term is cutoff at :math:`2^\frac{1}{6} \sigma`, the minimum of the LJ potential. The following coefficients must be defined for each bond type via the diff --git a/doc/src/bond_fene_expand.rst b/doc/src/bond_fene_expand.rst index 032b726121..0eef1711d5 100644 --- a/doc/src/bond_fene_expand.rst +++ b/doc/src/bond_fene_expand.rst @@ -32,12 +32,12 @@ The *fene/expand* bond style uses the potential to define a finite extensible nonlinear elastic (FENE) potential :ref:`(Kremer) `, used for bead-spring polymer models. The first -term is attractive, the 2nd Lennard-Jones term is repulsive. +term is attractive, the second Lennard-Jones term is repulsive. The *fene/expand* bond style is similar to *fene* except that an extra shift factor of :math:`\Delta` (positive or negative) is added to :math:`r` to effectively change the bead size of the bonded atoms. The first term -now extends to :math:`R_0 + \Delta` and the 2nd term is cutoff at :math:`2^\frac{1}{6} \sigma + \Delta`. +now extends to :math:`R_0 + \Delta` and the second term is cutoff at :math:`2^\frac{1}{6} \sigma + \Delta`. The following coefficients must be defined for each bond type via the :doc:`bond_coeff ` command as in the example above, or in diff --git a/doc/src/bond_table.rst b/doc/src/bond_table.rst index 445face231..d5bbeb7790 100644 --- a/doc/src/bond_table.rst +++ b/doc/src/bond_table.rst @@ -74,7 +74,7 @@ parenthesized comments): ... 101 1.00 338.0000 -1352.0000 -A section begins with a non-blank line whose 1st character is not a +A section begins with a non-blank line whose first character is not a "#"; blank lines or lines starting with "#" can be used as comments between sections. The first line begins with a keyword which identifies the section. The line can contain additional text, but the @@ -109,9 +109,9 @@ equilibrium bond length, which is used, for example, by the :doc:`fix shake ` do boxes in LAMMPS. LAMMPS normally requires that no tilt factor can skew the box more -than half the distance of the parallel box length, which is the 1st +than half the distance of the parallel box length, which is the first dimension in the tilt factor (x for xz). If *tilt* is set to *small*\ , which is the default, then an error will be generated if a box is created which exceeds this limit. If *tilt* diff --git a/doc/src/compute_adf.rst b/doc/src/compute_adf.rst index a9375fa038..08e7dcfd35 100644 --- a/doc/src/compute_adf.rst +++ b/doc/src/compute_adf.rst @@ -82,9 +82,9 @@ neighbor atom in each requested ADF. is what is specified with the :doc:`neighbor ` command. 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 first example 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 second example above. 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 all types from 1 to N. A leading asterisk means all types from 1 to n @@ -92,12 +92,12 @@ all types from 1 to N. A leading asterisk means all types from 1 to n (inclusive). A middle asterisk means all types from m to n (inclusive). -If *itypeN*\ , *jtypeN*\ , and *ktypeN* are single values, as in the 1st example +If *itypeN*\ , *jtypeN*\ , and *ktypeN* are single values, as in the first example 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 forming the angle. If any of *itypeN*\ , *jtypeN*\ , or *ktypeN* 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 second example above, this means that the 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, one neighbor in the range of types represented by *jtypeN* and another neighbor diff --git a/doc/src/compute_chunk_atom.rst b/doc/src/compute_chunk_atom.rst index ead17e3f7c..2ea12fb90c 100644 --- a/doc/src/compute_chunk_atom.rst +++ b/doc/src/compute_chunk_atom.rst @@ -218,8 +218,8 @@ into ellipses. The created bins (and hence the chunk IDs) are numbered consecutively from 1 to the number of bins = *Nchunk*\ . For *bin2d* and *bin3d*\ , the numbering varies most rapidly in the first dimension (which could be -x, y, or z), next rapidly in the 2nd dimension, and most slowly in the -3rd dimension. For *bin/sphere*\ , the bin with smallest radii is chunk +x, y, or z), next rapidly in the second dimension, and most slowly in the +third dimension. For *bin/sphere*\ , the bin with smallest radii is chunk 1 and the bni with largest radii is chunk Nchunk = *ncbin*\ . For *bin/cylinder*\ , the numbering varies most rapidly in the dimension along the cylinder axis and most slowly in the radial direction. @@ -614,7 +614,7 @@ Note that for the *bin/sphere* style, the radii *srmin* and *srmax* are scaled by the lattice spacing or reduced value of the *x* dimension. Note that for the *bin/cylinder* style, the radii *crmin* and *crmax* -are scaled by the lattice spacing or reduced value of the 1st +are scaled by the lattice spacing or reduced value of the first dimension perpendicular to the cylinder axis. E.g. y for an x-axis cylinder, x for a y-axis cylinder, and x for a z-axis cylinder. diff --git a/doc/src/compute_coord_atom.rst b/doc/src/compute_coord_atom.rst index b8f2b9e8ee..6a7cf7cb4a 100644 --- a/doc/src/compute_coord_atom.rst +++ b/doc/src/compute_coord_atom.rst @@ -63,7 +63,7 @@ keywords are listed, a single coordination number is calculated, which includes atoms of all types (same as the "\*" format, see below). The *typeN* keywords can be specified in one of two ways. An explicit -numeric value can be used, as in the 2nd example above. Or a +numeric value can be used, as in the second example above. Or a wild-card asterisk can be used to specify a range of atom types. 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 all types diff --git a/doc/src/compute_displace_atom.rst b/doc/src/compute_displace_atom.rst index 9e1488cdf1..cb44d153ac 100644 --- a/doc/src/compute_displace_atom.rst +++ b/doc/src/compute_displace_atom.rst @@ -36,7 +36,7 @@ all effects due to atoms passing through periodic boundaries. A vector of four quantities per atom is calculated by this compute. The first 3 elements of the vector are the dx,dy,dz displacements. -The 4th component is the total displacement, i.e. sqrt(dx\*dx + dy\*dy + +The fourth component is the total displacement, i.e. sqrt(dx\*dx + dy\*dy + dz\*dz). The displacement of an atom is from its original position at the time diff --git a/doc/src/compute_fep.rst b/doc/src/compute_fep.rst index 4700817609..c2e0271ee8 100644 --- a/doc/src/compute_fep.rst +++ b/doc/src/compute_fep.rst @@ -224,7 +224,7 @@ the pair\_\*.cpp file associated with the potential. Similar to the :doc:`pair_coeff ` command, I and J can be specified in one of two ways. Explicit numeric values can be used for -each, as in the 1st example above. I <= J is required. LAMMPS sets +each, as in the first example above. I <= J is required. LAMMPS sets the coefficients for the symmetric J,I interaction to the same values. A wild-card asterisk can be used in place of or in conjunction with the I,J arguments to set the coefficients for multiple pairs of diff --git a/doc/src/compute_group_group.rst b/doc/src/compute_group_group.rst index ba29090d5e..03ae693b56 100644 --- a/doc/src/compute_group_group.rst +++ b/doc/src/compute_group_group.rst @@ -64,7 +64,7 @@ If the *kspace* keyword is set to *yes*\ , which is not the default, and if a :doc:`kspace_style ` is defined, then the interaction energy will include a Kspace component which is the long-range Coulombic energy between all the atoms in the first group and all the -atoms in the 2nd group. Likewise, the interaction force calculated by +atoms in the second group. Likewise, the interaction force calculated by this compute will include the force on the compute group atoms due to long-range Coulombic interactions with atoms in the specified group2. diff --git a/doc/src/compute_msd.rst b/doc/src/compute_msd.rst index 94ab6a1579..f88e960802 100644 --- a/doc/src/compute_msd.rst +++ b/doc/src/compute_msd.rst @@ -38,7 +38,7 @@ parameter of mean-squared displacement, see the :doc:`compute msd/nongauss `, the second is in distance\^4 units, and -the 3rd is dimensionless. +the third is dimensionless. Restrictions """""""""""" diff --git a/doc/src/compute_property_chunk.rst b/doc/src/compute_property_chunk.rst index ed49833a48..e567c96a80 100644 --- a/doc/src/compute_property_chunk.rst +++ b/doc/src/compute_property_chunk.rst @@ -63,7 +63,7 @@ chunkID. This means that the original chunk IDs (e.g. molecule IDs) will have been compressed to remove chunk IDs with no atoms assigned to them. Thus a compressed chunk ID of 3 may correspond to an original chunk ID (molecule ID in this case) of 415. The *id* attribute will -then be 415 for the 3rd chunk. +then be 415 for the third chunk. The *coordN* attributes can only be used if a *binning* style was used in the :doc:`compute chunk/atom ` command referenced diff --git a/doc/src/compute_rdf.rst b/doc/src/compute_rdf.rst index 0aedfe09aa..9f292accd1 100644 --- a/doc/src/compute_rdf.rst +++ b/doc/src/compute_rdf.rst @@ -97,7 +97,7 @@ listed, then a separate histogram is generated for each *itype*\ ,\ *jtype* pair. The *itypeN* and *jtypeN* settings can be specified in one of two -ways. An explicit numeric value can be used, as in the 4th example +ways. An explicit numeric value can be used, as in the fourth example above. Or a wild-card asterisk can be used to specify a range of atom types. 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 @@ -106,11 +106,11 @@ all types from 1 to N. A leading asterisk means all types from 1 to n (inclusive). A middle asterisk means all types from m to n (inclusive). -If both *itypeN* and *jtypeN* are single values, as in the 4th example +If both *itypeN* and *jtypeN* are single values, as in the fourth example above, this means that a g(r) is computed where atoms of type *itypeN* are the central atom, and atoms of type *jtypeN* are the distribution atom. If either *itypeN* and *jtypeN* represent a range of values via -the wild-card asterisk, as in the 5th example above, this means that a +the wild-card asterisk, as in the fifth example above, this means that a g(r) is computed where atoms of any of the range of types represented by *itypeN* are the central atom, and atoms of any of the range of types represented by *jtypeN* are the distribution atom. diff --git a/doc/src/compute_temp_cs.rst b/doc/src/compute_temp_cs.rst index f3c82c2b1a..edd1d0b139 100644 --- a/doc/src/compute_temp_cs.rst +++ b/doc/src/compute_temp_cs.rst @@ -49,7 +49,7 @@ respective group IDs, which can be defined using the must be the same and there should be one bond defined between a pair of atoms in the two groups. Non-polarized ions which might also be included in the treated system should not be included into either of -these groups, they are taken into account by the *group-ID* (2nd +these groups, they are taken into account by the *group-ID* (second argument) of the compute. The temperature is calculated by the formula KE = dim/2 N k T, where diff --git a/doc/src/compute_ti.rst b/doc/src/compute_ti.rst index 79fc56178c..30ea9f7057 100644 --- a/doc/src/compute_ti.rst +++ b/doc/src/compute_ti.rst @@ -76,7 +76,7 @@ with respect to *lambda*\ . To perform this calculation, you provide one or more atom types as *atype*\ . *Atype* can be specified in one of two ways. An explicit -numeric values can be used, as in the 1st example above. Or a +numeric values can be used, as in the first example above. Or a wildcard asterisk can be used in place of or in conjunction with the *atype* argument to select multiple atom types. This takes the form "\*" or "\*n" or "n\*" or "m\*n". If N = the number of atom types, then diff --git a/doc/src/compute_vacf.rst b/doc/src/compute_vacf.rst index ce2757c115..1ca69e104a 100644 --- a/doc/src/compute_vacf.rst +++ b/doc/src/compute_vacf.rst @@ -33,7 +33,7 @@ A vector of four quantities is calculated by this compute. The first 3 elements of the vector are vx \* vx0 (and similarly for the y and z components), summed and averaged over atoms in the group. Vx is the current x-component of velocity for the atom, vx0 is the initial -x-component of velocity for the atom. The 4th element of the vector +x-component of velocity for the atom. The fourth element of the vector is the total VACF, i.e. (vx\*vx0 + vy\*vy0 + vz\*vz0), summed and averaged over atoms in the group. diff --git a/doc/src/dihedral_charmm.rst b/doc/src/dihedral_charmm.rst index 38cb18d172..d3f164e369 100644 --- a/doc/src/dihedral_charmm.rst +++ b/doc/src/dihedral_charmm.rst @@ -73,7 +73,7 @@ or :doc:`read_restart ` commands: The weighting factor is required to correct for double counting pairwise non-bonded Lennard-Jones interactions in cyclic systems or when using the CHARMM dihedral style with non-CHARMM force fields. -With the CHARMM dihedral style, interactions between the 1st and 4th +With the CHARMM dihedral style, interactions between the first and fourth atoms in a dihedral are skipped during the normal non-bonded force computation and instead evaluated as part of the dihedral using special epsilon and sigma values specified with the @@ -93,7 +93,7 @@ which applies to all 1-4 interactions in the system. For CHARMM force fields, the special_bonds 1-4 interaction scaling factor should be set to 0.0. Since the corresponding 1-4 non-bonded interactions are computed with the dihedral. This means that if any of the weighting -factors defined as dihedral coefficients (4th coeff above) are +factors defined as dihedral coefficients (fourth coeff above) are non-zero, then you must use a pair style with "lj/charmm" and set the special_bonds 1-4 scaling factor to 0.0 (which is the default). Otherwise 1-4 non-bonded interactions in dihedrals will be @@ -115,7 +115,7 @@ details. Note that for AMBER force fields, which use pair styles with "lj/cut", the special_bonds 1-4 scaling factor should be set to the AMBER -defaults (1/2 and 5/6) and all the dihedral weighting factors (4th +defaults (1/2 and 5/6) and all the dihedral weighting factors (fourth coeff above) must be set to 0.0. In this case, you can use any pair style you wish, since the dihedral does not need any Lennard-Jones parameter information and will not compute any 1-4 non-bonded diff --git a/doc/src/dihedral_coeff.rst b/doc/src/dihedral_coeff.rst index d72a299416..71bd931c5f 100644 --- a/doc/src/dihedral_coeff.rst +++ b/doc/src/dihedral_coeff.rst @@ -31,7 +31,7 @@ Dihedral coefficients can also be set in the data file read by the :doc:`read_data ` command or in a restart file. N can be specified in one of two ways. An explicit numeric value can -be used, as in the 1st example above. Or a wild-card asterisk can be +be used, as in the first example above. Or a wild-card asterisk can be used to set the coefficients for multiple dihedral types. This takes the form "\*" or "\*n" or "n\*" or "m\*n". If N = the number of dihedral types, then an asterisk with no numeric values means all types from 1 to N. A @@ -53,7 +53,7 @@ same format as the arguments of the dihedral_coeff command in an input script, except that wild-card asterisks should not be used since coefficients for all N types must be listed in the file. For example, under the "Dihedral Coeffs" section of a data file, the line that -corresponds to the 1st example above would be listed as +corresponds to the first example above would be listed as .. parsed-literal:: diff --git a/doc/src/dihedral_table.rst b/doc/src/dihedral_table.rst index 112716a240..748aadbdbe 100644 --- a/doc/src/dihedral_table.rst +++ b/doc/src/dihedral_table.rst @@ -92,7 +92,7 @@ or blank lines. ... 30 180.0 -0.707106781187 -A section begins with a non-blank line whose 1st character is not a +A section begins with a non-blank line whose first character is not a "#"; blank lines or lines starting with "#" can be used as comments between sections. The first line begins with a keyword which identifies the section. The line can contain additional text, but the @@ -102,10 +102,10 @@ any order) one or more parameters for the table. Each parameter is a keyword followed by one or more numeric values. Following a blank line, the next N lines list the tabulated values. On -each line, the 1st value is the index from 1 to N, the 2nd value is -the angle value, the 3rd value is the energy (in energy units), and -the 4th is -dE/d(phi) also in energy units). The 3rd term is the -energy of the 4-atom configuration for the specified angle. The 4th +each line, the first value is the index from 1 to N, the second value is +the angle value, the third value is the energy (in energy units), and +the fourth is -dE/d(phi) also in energy units). The third term is the +energy of the 4-atom configuration for the specified angle. The fourth term (when present) is the negative derivative of the energy with respect to the angle (in degrees, or radians depending on whether the user selected DEGREES or RADIANS). Thus the units of the last term @@ -147,9 +147,9 @@ choice of angle units). The optional "NOF" keyword allows the user to omit the forces (negative energy derivatives) from the table file (normally located in -the 4th column). In their place, forces will be calculated +the fourth column). In their place, forces will be calculated automatically by differentiating the potential energy function -indicated by the 3rd column of the table (using either linear or +indicated by the third column of the table (using either linear or spline interpolation). The optional "DEGREES" keyword allows the user to specify angles in @@ -157,7 +157,7 @@ degrees instead of radians (default). The optional "RADIANS" keyword allows the user to specify angles in radians instead of degrees. (Note: This changes the way the forces -are scaled in the 4th column of the data file.) +are scaled in the fourth column of the data file.) The optional "CHECKU" keyword is followed by a filename. This allows the user to save all of the *Ntable* different entries in the diff --git a/doc/src/dihedral_table_cut.rst b/doc/src/dihedral_table_cut.rst index ae2fcd1f77..34e604088b 100644 --- a/doc/src/dihedral_table_cut.rst +++ b/doc/src/dihedral_table_cut.rst @@ -113,7 +113,7 @@ or blank lines. ... 30 180.0 -0.707106781187 -A section begins with a non-blank line whose 1st character is not a +A section begins with a non-blank line whose first character is not a "#"; blank lines or lines starting with "#" can be used as comments between sections. The first line begins with a keyword which identifies the section. The line can contain additional text, but the @@ -123,10 +123,10 @@ any order) one or more parameters for the table. Each parameter is a keyword followed by one or more numeric values. Following a blank line, the next N lines list the tabulated values. On -each line, the 1st value is the index from 1 to N, the 2nd value is -the angle value, the 3rd value is the energy (in energy units), and -the 4th is -dE/d(phi) also in energy units). The 3rd term is the -energy of the 4-atom configuration for the specified angle. The 4th +each line, the first value is the index from 1 to N, the second value is +the angle value, the third value is the energy (in energy units), and +the fourth is -dE/d(phi) also in energy units). The third term is the +energy of the 4-atom configuration for the specified angle. The fourth term (when present) is the negative derivative of the energy with respect to the angle (in degrees, or radians depending on whether the user selected DEGREES or RADIANS). Thus the units of the last term @@ -168,9 +168,9 @@ choice of angle units). The optional "NOF" keyword allows the user to omit the forces (negative energy derivatives) from the table file (normally located in -the 4th column). In their place, forces will be calculated +the fourth column). In their place, forces will be calculated automatically by differentiating the potential energy function -indicated by the 3rd column of the table (using either linear or +indicated by the third column of the table (using either linear or spline interpolation). The optional "DEGREES" keyword allows the user to specify angles in @@ -178,7 +178,7 @@ degrees instead of radians (default). The optional "RADIANS" keyword allows the user to specify angles in radians instead of degrees. (Note: This changes the way the forces -are scaled in the 4th column of the data file.) +are scaled in the fourth column of the data file.) The optional "CHECKU" keyword is followed by a filename. This allows the user to save all of the *Ntable* different entries in the diff --git a/doc/src/dump_image.rst b/doc/src/dump_image.rst index 0477e5d718..d222c208ac 100644 --- a/doc/src/dump_image.rst +++ b/doc/src/dump_image.rst @@ -134,17 +134,23 @@ Only atoms in the specified group are rendered in the image. The alter what atoms are included in the image. The filename suffix determines whether a JPEG, PNG, or PPM file is created with the *image* dump style. If the suffix is ".jpg" or -".jpeg", then a JPEG format file is created, if the suffix is ".png", -then a PNG format is created, else a PPM (aka NETPBM) format file is -created. The JPEG and PNG files are binary; PPM has a text mode -header followed by binary data. JPEG images have lossy compression; -PNG has lossless compression; and PPM files are uncompressed but can -be compressed with gzip, if LAMMPS has been compiled with --DLAMMPS_GZIP and a ".gz" suffix is used. +".jpeg", then a `JPEG format `_ file is created, if the +suffix is ".png", then a `PNG format `_ is created, else +a `PPM (aka NETPBM) format `_ file is created. +The JPEG and PNG files are binary; PPM has a text mode header followed +by binary data. JPEG images have lossy compression, PNG has lossless +compression, and PPM files are uncompressed but can be compressed with +gzip, if LAMMPS has been compiled with -DLAMMPS_GZIP and a ".gz" suffix +is used. + +.. _jpeg_format: https://jpeg.org/jpeg/ +.. _png_format: https://en.wikipedia.org/wiki/Portable_Network_Graphics +.. _ppm_format: https://en.wikipedia.org/wiki/Netpbm Similarly, the format of the resulting movie is chosen with the *movie* dump style. This is handled by the underlying FFmpeg converter -and thus details have to be looked up in the FFmpeg documentation. +and thus details have to be looked up in the `FFmpeg documentation +`_. Typical examples are: .avi, .mpg, .m4v, .mp4, .mkv, .flv, .mov, .gif Additional settings of the movie compression like bitrate and framerate can be set using the :doc:`dump_modify ` command. diff --git a/doc/src/dump_modify.rst b/doc/src/dump_modify.rst index ce0ade4789..6c7d4eb0f5 100644 --- a/doc/src/dump_modify.rst +++ b/doc/src/dump_modify.rst @@ -306,7 +306,7 @@ must enclose in quotes if it is more than one field. The *int* and *float* keywords take a single format argument and are applied to all integer or floating-point quantities output. The setting for *M string* also takes a single format argument which is used for the Mth -value output in each line, e.g. the 5th column is output in high +value output in each line, e.g. the fifth column is output in high precision for "format 5 %20.15g". .. note:: @@ -419,7 +419,7 @@ be written, by processors 0,25,50,75. Each will collect information from itself and the next 24 processors and write it to a dump file. For the *fileper* keyword, the specified value of Np means write one -file for every Np processors. For example, if Np = 4, every 4th +file for every Np processors. For example, if Np = 4, every fourth processor (0,4,8,12,etc) will collect information from itself and the next 3 processors and write it to a dump file. @@ -790,7 +790,7 @@ for the sequential style; otherwise the value is ignored. It specifies the bin size to use within the range for assigning consecutive colors to. For example, if the range is from -10.0 to 10.0 and a *delta* of 1.0 is used, then 20 colors will be assigned to -the range. The first will be from -10.0 <= color1 < -9.0, then 2nd +the range. The first will be from -10.0 <= color1 < -9.0, then second from -9.0 <= color2 < -8.0, etc. The *N* setting is how many entries follow. The format of the entries diff --git a/doc/src/dynamical_matrix.rst b/doc/src/dynamical_matrix.rst index 01981732da..9c4530eade 100644 --- a/doc/src/dynamical_matrix.rst +++ b/doc/src/dynamical_matrix.rst @@ -70,7 +70,7 @@ See the :doc:`Build package ` doc page for more info. Related commands """""""""""""""" -:doc:`fix phonon `, :doc:`fix numdiff `, +:doc:`fix phonon `, :doc:`fix numdiff `, :doc:`compute hma ` uses an analytic formulation of the Hessian provided by a pair_style's Pair::single_hessian() function, diff --git a/doc/src/fix_adapt.rst b/doc/src/fix_adapt.rst index fbc4aa4661..78677a0e2d 100644 --- a/doc/src/fix_adapt.rst +++ b/doc/src/fix_adapt.rst @@ -229,7 +229,7 @@ specified, but are ignored. Similar to the :doc:`pair_coeff command `, I and J can be specified in one of two ways. Explicit numeric values can be used for -each, as in the 1st example above. I <= J is required. LAMMPS sets +each, as in the first example above. I <= J is required. LAMMPS sets the coefficients for the symmetric J,I interaction to the same values. A wild-card asterisk can be used in place of or in conjunction with diff --git a/doc/src/fix_adapt_fep.rst b/doc/src/fix_adapt_fep.rst index ee44d8904f..3e5d419353 100644 --- a/doc/src/fix_adapt_fep.rst +++ b/doc/src/fix_adapt_fep.rst @@ -199,7 +199,7 @@ specified, but are ignored. Similar to the :doc:`pair_coeff command `, I and J can be specified in one of two ways. Explicit numeric values can be used for -each, as in the 1st example above. I <= J is required. LAMMPS sets +each, as in the first example above. I <= J is required. LAMMPS sets the coefficients for the symmetric J,I interaction to the same values. A wild-card asterisk can be used in place of or in conjunction with diff --git a/doc/src/fix_ave_chunk.rst b/doc/src/fix_ave_chunk.rst index b19cce417c..91331502c3 100644 --- a/doc/src/fix_ave_chunk.rst +++ b/doc/src/fix_ave_chunk.rst @@ -435,7 +435,7 @@ column is only used if the *compress* keyword was set to *yes* for the the original chunk IDs (e.g. molecule IDs) will have been compressed to remove chunk IDs with no atoms assigned to them. Thus a compressed chunk ID of 3 may correspond to an original chunk ID or molecule ID of -415. The OrigID column will list 415 for the 3rd chunk. +415. The OrigID column will list 415 for the third chunk. The CoordN columns only appear if a *binning* style was used in the :doc:`compute chunk/atom ` command. For *bin/1d*\ , diff --git a/doc/src/fix_ave_correlate.rst b/doc/src/fix_ave_correlate.rst index c42159e89b..d6a74e8a32 100644 --- a/doc/src/fix_ave_correlate.rst +++ b/doc/src/fix_ave_correlate.rst @@ -321,7 +321,7 @@ accessed on timesteps that are multiples of *Nfreq* since that is when averaging is performed. The global array has # of rows = *Nrepeat* and # of columns = Npair+2. The first column has the time delta (in timesteps) between the pairs of input values used to calculate the -correlation, as described above. The 2nd column has the number of +correlation, as described above. The second column has the number of samples contributing to the correlation average, as described above. The remaining Npair columns are for I,J pairs of the N input values, as determined by the *type* keyword, as described above. diff --git a/doc/src/fix_ave_histo.rst b/doc/src/fix_ave_histo.rst index 158f259695..353077d667 100644 --- a/doc/src/fix_ave_histo.rst +++ b/doc/src/fix_ave_histo.rst @@ -346,10 +346,10 @@ values: * 4 = max value of all input values, including ones not histogrammed The global array has # of rows = Nbins and # of columns = 3. The -first column has the bin coordinate, the 2nd column has the count of -values in that histogram bin, and the 3rd column has the bin count +first column has the bin coordinate, the second column has the count of +values in that histogram bin, and the third column has the bin count divided by the total count (not including missing counts), so that the -values in the 3rd column sum to 1.0. +values in the third column sum to 1.0. The vector and array values calculated by this fix are all treated as intensive. If this is not the case, e.g. due to histogramming diff --git a/doc/src/fix_bond_create.rst b/doc/src/fix_bond_create.rst index 0c48a800c9..bbe3120f29 100644 --- a/doc/src/fix_bond_create.rst +++ b/doc/src/fix_bond_create.rst @@ -154,13 +154,13 @@ of type *angletype*\ , with parameters assigned by the corresponding .. note:: LAMMPS stores and maintains a data structure with a list of the - 1st, 2nd, and 3rd neighbors of each atom (within the bond topology of + first, second, and third neighbors of each atom (within the bond topology of the system) for use in weighting pairwise interactions for bonded - atoms. Note that adding a single bond always adds a new 1st neighbor - but may also induce \*many\* new 2nd and 3rd neighbors, depending on the + atoms. Note that adding a single bond always adds a new first neighbor + but may also induce \*many\* new second and third neighbors, depending on the molecular topology of your system. The "extra special per atom" parameter must typically be set to allow for the new maximum total - size (1st + 2nd + 3rd neighbors) of this per-atom list. There are 2 + size (first + second + third neighbors) of this per-atom list. There are 2 ways to do this. See the :doc:`read_data ` or :doc:`create_box ` commands for details. @@ -172,12 +172,12 @@ of type *angletype*\ , with parameters assigned by the corresponding considered for pairwise interactions, using the weighting rules set by the :doc:`special_bonds ` command. Consider a new bond created between atoms I,J. If J has a bonded neighbor K, then K - becomes a 2nd neighbor of I. Even if the *atype* keyword is not used + becomes a second neighbor of I. Even if the *atype* keyword is not used to create angle I-J-K, the pairwise interaction between I and K will be potentially turned off or weighted by the 1-3 weighting specified by the :doc:`special_bonds ` command. This is the case even if the "angle yes" option was used with that command. The same - is true for 3rd neighbors (1-4 interactions), the *dtype* keyword, and + is true for third neighbors (1-4 interactions), the *dtype* keyword, and the "dihedral yes" option used with the :doc:`special_bonds ` command. diff --git a/doc/src/fix_box_relax.rst b/doc/src/fix_box_relax.rst index 7786a8faef..71708165dd 100644 --- a/doc/src/fix_box_relax.rst +++ b/doc/src/fix_box_relax.rst @@ -371,7 +371,7 @@ the meaning of the xy,xz,yz tilt factors. The *scaleyz yes* and *scalexz yes* keyword/value pairs can not be used for 2D simulations. *scaleyz yes*\ , *scalexz yes*\ , and *scalexy yes* options -can only be used if the 2nd dimension in the keyword is periodic, +can only be used if the second dimension in the keyword is periodic, and if the tilt factor is not coupled to the barostat via keywords *tri*\ , *yz*\ , *xz*\ , and *xy*\ . diff --git a/doc/src/fix_cmap.rst b/doc/src/fix_cmap.rst index 6f68d97c59..a968eb910e 100644 --- a/doc/src/fix_cmap.rst +++ b/doc/src/fix_cmap.rst @@ -66,7 +66,7 @@ in the body of the data file like this with N lines: N 3 314 315 317 318 330 The first column is an index from 1 to N to enumerate the CMAP terms; -it is ignored by LAMMPS. The 2nd column is the "type" of the +it is ignored by LAMMPS. The second column is the "type" of the interaction; it is an index into the CMAP force field file. The remaining 5 columns are the atom IDs of the atoms in the two 4-atom dihedrals that overlap to create the CMAP 5-body interaction. Note diff --git a/doc/src/fix_deform.rst b/doc/src/fix_deform.rst index f5511be692..ab07c32560 100644 --- a/doc/src/fix_deform.rst +++ b/doc/src/fix_deform.rst @@ -104,7 +104,7 @@ can be modeled using the :ref:`USER-UEF package ` and its :doc:`fi For the *x*\ , *y*\ , *z* parameters, the associated dimension cannot be shrink-wrapped. For the *xy*\ , *yz*\ , *xz* parameters, the associated -2nd dimension cannot be shrink-wrapped. Dimensions not varied by this +second dimension cannot be shrink-wrapped. Dimensions not varied by this command can be periodic or non-periodic. Dimensions corresponding to unspecified parameters can also be controlled by a :doc:`fix npt ` or :doc:`fix nph ` command. @@ -463,7 +463,7 @@ and the final tilt factor at the end of the simulation would be 0.0. During each flip event, atoms are remapped into the new box in the appropriate manner. -The one exception to this rule is if the 1st dimension in the tilt +The one exception to this rule is if the first dimension in the tilt factor (x for xy) is non-periodic. In that case, the limits on the tilt factor are not enforced, since flipping the box in that dimension does not change the atom positions due to non-periodicity. In this @@ -601,7 +601,7 @@ Restrictions You cannot apply x, y, or z deformations to a dimension that is shrink-wrapped via the :doc:`boundary ` command. -You cannot apply xy, yz, or xz deformations to a 2nd dimension (y in +You cannot apply xy, yz, or xz deformations to a second dimension (y in xy) that is shrink-wrapped via the :doc:`boundary ` command. Related commands diff --git a/doc/src/fix_eos_table.rst b/doc/src/fix_eos_table.rst index 3800aa0c53..57cacc0da5 100644 --- a/doc/src/fix_eos_table.rst +++ b/doc/src/fix_eos_table.rst @@ -66,7 +66,7 @@ parenthesized comments): ... 500 10.0 0.500 -A section begins with a non-blank line whose 1st character is not a +A section begins with a non-blank line whose first character is not a "#"; blank lines or lines starting with "#" can be used as comments between sections. The first line begins with a keyword which identifies the section. The line can contain additional text, but the @@ -86,8 +86,8 @@ to match exactly what is in the tabulated file (with effectively no preliminary interpolation), you should set Ntable = Nfile. Following a blank line, the next N lines list the tabulated values. -On each line, the 1st value is the index from 1 to N, the 2nd value is -the internal temperature (in temperature units), the 3rd value is the +On each line, the first value is the index from 1 to N, the second value is +the internal temperature (in temperature units), the third value is the internal energy (in energy units). Note that the internal temperature and internal energy values must diff --git a/doc/src/fix_eos_table_rx.rst b/doc/src/fix_eos_table_rx.rst index e3cd4e8ce8..1db81a4a2b 100644 --- a/doc/src/fix_eos_table_rx.rst +++ b/doc/src/fix_eos_table_rx.rst @@ -106,7 +106,7 @@ parenthesized comments): ... 500 10.0 0.500 ... 1.0000 -A section begins with a non-blank line whose 1st character is not a +A section begins with a non-blank line whose first character is not a "#"; blank lines or lines starting with "#" can be used as comments between sections. The first line begins with a keyword which identifies the section. The line can contain additional text, but the @@ -121,8 +121,8 @@ What LAMMPS does is a preliminary interpolation by creating splines using the Nfile tabulated values as nodal points. Following a blank line, the next N lines list the tabulated values. -On each line, the 1st value is the index from 1 to N, the 2nd value is -the internal temperature (in temperature units), the 3rd value until +On each line, the first value is the index from 1 to N, the second value is +the internal temperature (in temperature units), the third value until the *m+3* value are the internal energies of the m species (in energy units). Note that all internal temperature and internal energy values must diff --git a/doc/src/fix_external.rst b/doc/src/fix_external.rst index a77545d294..58f40406da 100644 --- a/doc/src/fix_external.rst +++ b/doc/src/fix_external.rst @@ -109,20 +109,42 @@ etc. To use this fix during energy minimization, the energy corresponding to the added forces must also be set so as to be consistent with the added forces. Otherwise the minimization will not converge correctly. +Correspondingly, the global virial needs to be updated to be use this +fix with variable cell calculations (e.g. :doc:`fix box/relax ` +or :doc:`fix npt `). -This can be done from the external driver by calling this public -method of the FixExternal class: +This can be done from the external driver by calling these public +methods of the FixExternal class: .. code-block:: c++ - void set_energy(double eng); + void set_energy_global(double eng); + void set_virial_global(double *virial); -where eng is the potential energy. Eng is an extensive quantity, +where *eng* is the potential energy, and *virial* an array of the 6 +stress tensor components. Eng is an extensive quantity, meaning it should be the sum over per-atom energies of all affected atoms. It should also be provided in :doc:`energy units ` consistent with the simulation. See the details below for how to insure this energy setting is used appropriately in a minimization. +Additional public methods that the caller can use to update system +properties are: + +.. code-block:: c++ + + void set_energy_peratom(double *eng); + void set_virial_peratom(double **virial); + void set_vector_length(int n); + void set_vector(int idx, double val); + +These allow to set per-atom energy contributions, per-atom stress +contributions, the length and individual values of a global vector +of properties that the caller code may want to communicate to LAMMPS +(e.g. for use in :doc:`fix ave/time ` or in +:doc:`equal-style variables ` or for +:doc:`custom thermo output `. + ---------- **Restart, fix_modify, output, run start/stop, minimize info:** diff --git a/doc/src/fix_nh.rst b/doc/src/fix_nh.rst index 9b73a8b4ed..83c2b5a728 100644 --- a/doc/src/fix_nh.rst +++ b/doc/src/fix_nh.rst @@ -432,7 +432,7 @@ equilibrium liquids can not support a shear stress and that equilibrium solids can not support shear stresses that exceed the yield stress. -One exception to this rule is if the 1st dimension in the tilt factor +One exception to this rule is if the first dimension in the tilt factor (x for xy) is non-periodic. In that case, the limits on the tilt factor are not enforced, since flipping the box in that dimension does not change the atom positions due to non-periodicity. In this mode, @@ -673,7 +673,7 @@ Restrictions *X*\ , *y*\ , *z* cannot be barostatted if the associated dimension is not periodic. *Xy*\ , *xz*\ , and *yz* can only be barostatted if the -simulation domain is triclinic and the 2nd dimension in the keyword +simulation domain is triclinic and the second dimension in the keyword (\ *y* dimension in *xy*\ ) is periodic. *Z*\ , *xz*\ , and *yz*\ , cannot be barostatted for 2D simulations. The :doc:`create_box `, :doc:`read data `, and :doc:`read_restart ` @@ -687,7 +687,7 @@ is not allowed in the Nose/Hoover formulation. The *scaleyz yes* and *scalexz yes* keyword/value pairs can not be used for 2D simulations. *scaleyz yes*\ , *scalexz yes*\ , and *scalexy yes* options -can only be used if the 2nd dimension in the keyword is periodic, +can only be used if the second dimension in the keyword is periodic, and if the tilt factor is not coupled to the barostat via keywords *tri*\ , *yz*\ , *xz*\ , and *xy*\ . @@ -710,7 +710,7 @@ Default The keyword defaults are tchain = 3, pchain = 3, mtk = yes, tloop = 1, ploop = 1, nreset = 0, drag = 0.0, dilate = all, couple = none, -flip = yes, scaleyz = scalexz = scalexy = yes if periodic in 2nd +flip = yes, scaleyz = scalexz = scalexy = yes if periodic in second dimension and not coupled to barostat, otherwise no. ---------- diff --git a/doc/src/fix_npt_cauchy.rst b/doc/src/fix_npt_cauchy.rst index 14ad1e7715..480e2e5314 100644 --- a/doc/src/fix_npt_cauchy.rst +++ b/doc/src/fix_npt_cauchy.rst @@ -354,7 +354,7 @@ equilibrium liquids can not support a shear stress and that equilibrium solids can not support shear stresses that exceed the yield stress. -One exception to this rule is if the 1st dimension in the tilt factor +One exception to this rule is if the first dimension in the tilt factor (x for xy) is non-periodic. In that case, the limits on the tilt factor are not enforced, since flipping the box in that dimension does not change the atom positions due to non-periodicity. In this mode, @@ -555,7 +555,7 @@ LAMMPS was built with that package. See the :doc:`Build package *X*\ , *y*\ , *z* cannot be barostatted if the associated dimension is not periodic. *Xy*\ , *xz*\ , and *yz* can only be barostatted if the -simulation domain is triclinic and the 2nd dimension in the keyword +simulation domain is triclinic and the second dimension in the keyword (\ *y* dimension in *xy*\ ) is periodic. *Z*\ , *xz*\ , and *yz*\ , cannot be barostatted for 2D simulations. The :doc:`create_box `, :doc:`read data `, and :doc:`read_restart ` @@ -569,7 +569,7 @@ is not allowed in the Nose/Hoover formulation. The *scaleyz yes* and *scalexz yes* keyword/value pairs can not be used for 2D simulations. *scaleyz yes*\ , *scalexz yes*\ , and *scalexy yes* options -can only be used if the 2nd dimension in the keyword is periodic, +can only be used if the second dimension in the keyword is periodic, and if the tilt factor is not coupled to the barostat via keywords *tri*\ , *yz*\ , *xz*\ , and *xy*\ . @@ -626,7 +626,7 @@ Default The keyword defaults are tchain = 3, pchain = 3, mtk = yes, tloop = ploop = 1, nreset = 0, drag = 0.0, dilate = all, couple = none, cauchystat = no, -scaleyz = scalexz = scalexy = yes if periodic in 2nd dimension and +scaleyz = scalexz = scalexy = yes if periodic in second dimension and not coupled to barostat, otherwise no. ---------- diff --git a/doc/src/fix_poems.rst b/doc/src/fix_poems.rst index f9a0e72b3d..5e84188154 100644 --- a/doc/src/fix_poems.rst +++ b/doc/src/fix_poems.rst @@ -39,7 +39,7 @@ useful for treating a large biomolecule as a collection of connected, coarse-grained particles. The coupling, associated motion constraints, and time integration is -performed by the software package `Parallelizable Open source Efficient Multibody Software (POEMS) `_ which computes the +performed by the software package `Parallelizable Open source Efficient Multibody Software (POEMS)` which computes the constrained rigid-body motion of articulated (jointed) multibody systems :ref:`(Anderson) `. POEMS was written and is distributed by Prof Kurt Anderson, his graduate student Rudranarayan Mukherjee, @@ -48,8 +48,6 @@ and other members of his group at Rensselaer Polytechnic Institute copyright information on POEMS and other details, please refer to the documents in the poems directory distributed with LAMMPS. -.. _poems: http://www.rpi.edu/~anderk5/lab - This fix updates the positions and velocities of the rigid atoms with a constant-energy time integration, so you should not update the same atoms via other fixes (e.g. nve, nvt, npt, temp/rescale, langevin). @@ -123,7 +121,7 @@ command. This fix is not invoked during :doc:`energy minimization `. Restrictions """""""""""" -This fix is part of the POEMS package. It is only enabled if LAMMPS +This fix is part of the :ref:`POEMS ` package. It is only enabled if LAMMPS was built with that package, which also requires the POEMS library be built and linked with LAMMPS. See the :doc:`Build package ` doc page for more info. diff --git a/doc/src/fix_precession_spin.rst b/doc/src/fix_precession_spin.rst index 783963af72..99dffc61dd 100644 --- a/doc/src/fix_precession_spin.rst +++ b/doc/src/fix_precession_spin.rst @@ -158,7 +158,7 @@ atom_style "spin" was declared. See the :doc:`Build package ` do The *precession/spin* style can only be declared once. If more than one precession type (for example combining an anisotropy and a Zeeman interactions) has to be declared, they have to be chained in the same command -line (as shown in the examples above). +line (as shown in the examples above). Related commands """""""""""""""" diff --git a/doc/src/fix_recenter.rst b/doc/src/fix_recenter.rst index eec224c67d..a1c215e9a7 100644 --- a/doc/src/fix_recenter.rst +++ b/doc/src/fix_recenter.rst @@ -116,7 +116,7 @@ Restrictions """""""""""" This fix should not be used with an x,y,z setting that causes a large -shift in the system on the 1st timestep, due to the requested COM +shift in the system on the first timestep, due to the requested COM being very different from the initial COM. This could cause atoms to be lost, especially in parallel. Instead, use the :doc:`displace_atoms ` command, which can be used to diff --git a/doc/src/fix_restrain.rst b/doc/src/fix_restrain.rst index 692336bec6..d3cdecd46a 100644 --- a/doc/src/fix_restrain.rst +++ b/doc/src/fix_restrain.rst @@ -162,7 +162,7 @@ the restraint is .. math:: E = 0 \qquad\quad\quad ,if\;r \ge r_0 - + with the following coefficients: * :math:`K` (energy/distance\^2) diff --git a/doc/src/fix_rigid.rst b/doc/src/fix_rigid.rst index 6fbd692f6a..0af009316c 100644 --- a/doc/src/fix_rigid.rst +++ b/doc/src/fix_rigid.rst @@ -248,7 +248,7 @@ differences may accumulate to produce divergent trajectories. will be built only at the very first *run* command and maintained for as long as the rigid fix is defined. For example, you might think you could displace the atoms in a body or add a large velocity to each atom - in a body to make it move in a desired direction before a 2nd run is + in a body to make it move in a desired direction before a second run is performed, using the :doc:`set ` or :doc:`displace_atoms ` or :doc:`velocity ` commands. But these commands will not affect the internal attributes @@ -727,7 +727,7 @@ In all case, the rigid bodies and non-rigid particles both contribute to the global pressure and the box is scaled the same by any of the barostatting fixes. -You could even use the 2nd and 3rd options for a non-hybrid simulation +You could even use the second and third options for a non-hybrid simulation consisting of only rigid bodies, assuming you give :doc:`fix npt ` an empty group, though it's an odd thing to do. The barostatting fixes (:doc:`fix npt ` and :doc:`fix press/berensen `) will monitor the pressure and change the box dimensions, but not time integrate any particles. diff --git a/doc/src/fix_rigid_meso.rst b/doc/src/fix_rigid_meso.rst index 9961a871dc..ec05fd170a 100644 --- a/doc/src/fix_rigid_meso.rst +++ b/doc/src/fix_rigid_meso.rst @@ -108,7 +108,7 @@ internal energy and extrapolated velocity are also updated. will be built only at the very first *run* command and maintained for as long as the rigid fix is defined. For example, you might think you could displace the particles in a body or add a large velocity to each particle - in a body to make it move in a desired direction before a 2nd run is + in a body to make it move in a desired direction before a second run is performed, using the :doc:`set ` or :doc:`displace_atoms ` or :doc:`velocity ` commands. But these commands will not affect the internal attributes diff --git a/doc/src/fix_rx.rst b/doc/src/fix_rx.rst index 0d8af574c1..8281c744d4 100644 --- a/doc/src/fix_rx.rst +++ b/doc/src/fix_rx.rst @@ -18,7 +18,7 @@ Syntax * file = filename containing the reaction kinetic equations and Arrhenius parameters * localTemp = *none,lucy* = no local temperature averaging or local temperature defined through Lucy weighting function * matrix = *sparse, dense* format for the stoichiometric matrix -* solver = *lammps_rk4,rkf45* = rk4 is an explicit 4th order Runge-Kutta method; rkf45 is an adaptive 4th-order Runge-Kutta-Fehlberg method +* solver = *lammps_rk4,rkf45* = rk4 is an explicit fourth order Runge-Kutta method; rkf45 is an adaptive fourth-order Runge-Kutta-Fehlberg method * minSteps = # of steps for rk4 solver or minimum # of steps for rkf45 (rk4 or rkf45) * maxSteps = maximum number of steps for the rkf45 solver (rkf45 only) * relTol = relative tolerance for the rkf45 solver (rkf45 only) @@ -61,9 +61,9 @@ of *m* ordinary differential equations (ODEs) that describe the change in concentration of a given species as a function of time are then constructed based on the *n* reaction rate equations. -The ODE systems are solved over the full DPD timestep *dt* using either a 4th +The ODE systems are solved over the full DPD timestep *dt* using either a fourth order Runge-Kutta *rk4* method with a fixed step-size *h*\ , specified -by the *lammps_rk4* keyword, or a 4th order Runge-Kutta-Fehlberg (rkf45) method +by the *lammps_rk4* keyword, or a fourth order Runge-Kutta-Fehlberg (rkf45) method with an adaptive step-size for *h*\ . The number of ODE steps per DPD timestep for the rk4 method is optionally specified immediately after the rk4 keyword. The ODE step-size is set as *dt/num_steps*. Smaller @@ -76,7 +76,7 @@ can be specified by the user or estimated internally. It is recommended that the specify *h0* since this will generally reduced the number of ODE integration steps required. *h0* is defined as *dt / min_steps* if min_steps >= 1. If min_steps == 0, *h0* is estimated such that an explicit Euler method would likely produce -an acceptable solution. This is generally overly conservative for the 4th-order +an acceptable solution. This is generally overly conservative for the fourth-order method and users are advised to specify *h0* as some fraction of the DPD timestep. For small DPD timesteps, only one step may be necessary depending upon the tolerances. Note that more than min_steps ODE steps may be taken depending upon the ODE stiffness @@ -172,7 +172,7 @@ parenthesized comments): ... 1.0 no + 1.0 co = 0.5 n2 + 1.0 co2 1.66E+06 0.0 0.69 -A section begins with a non-blank line whose 1st character is not a +A section begins with a non-blank line whose first character is not a "#"; blank lines or lines starting with "#" can be used as comments between sections. diff --git a/doc/src/fix_saed_vtk.rst b/doc/src/fix_saed_vtk.rst index 818d14cc60..145a10c93a 100644 --- a/doc/src/fix_saed_vtk.rst +++ b/doc/src/fix_saed_vtk.rst @@ -45,7 +45,7 @@ Description """"""""""" Time average computed intensities from :doc:`compute saed ` and -write output to a file in the 3rd generation vtk image data format for +write output to a file in the third generation vtk image data format for visualization directly in parallelized visualization software packages like ParaView and VisIt. Note that if no time averaging is done, this command can be used as a convenient way to simply output diffraction @@ -92,7 +92,7 @@ averaging is done; values are simply generated on timesteps ---------- -The output for fix ave/time/saed is a file written with the 3rd generation +The output for fix ave/time/saed is a file written with the third generation vtk image data formatting. The filename assigned by the *file* keyword is appended with _N.vtk where N is an index (0,1,2...) to account for multiple diffraction intensity outputs. @@ -156,7 +156,7 @@ running or windowed average. The *file* keyword allows a filename to be specified. Every *Nfreq* steps, the vector of saed intensity data is written to a new file using -the 3rd generation vtk format. The base of each file is assigned by +the third generation vtk format. The base of each file is assigned by the *file* keyword and this string is appended with _N.vtk where N is an index (0,1,2...) to account for situations with multiple diffraction intensity outputs. diff --git a/doc/src/fix_smd.rst b/doc/src/fix_smd.rst index b303114887..1a24154b49 100644 --- a/doc/src/fix_smd.rst +++ b/doc/src/fix_smd.rst @@ -126,7 +126,7 @@ displacement). The force is the total force on the group of atoms by the spring. In the case of the *couple* style, it is the force on the fix group -(group-ID) or the negative of the force on the 2nd group (group-ID2). +(group-ID) or the negative of the force on the second group (group-ID2). The vector values calculated by this fix are "extensive". No parameter of this fix can be used with the *start/stop* keywords of diff --git a/doc/src/fix_spring.rst b/doc/src/fix_spring.rst index 518b4d2302..527e6325f4 100644 --- a/doc/src/fix_spring.rst +++ b/doc/src/fix_spring.rst @@ -118,7 +118,7 @@ various :doc:`output commands `. The first 3 quantities in the vector are xyz components of the total force added to the group of atoms by the spring. In the case of the *couple* style, it is the force on the fix group (group-ID) or the negative of the force on the -2nd group (group-ID2). The 4th quantity in the vector is the +second group (group-ID2). The fourth quantity in the vector is the magnitude of the force added by the spring, as a positive value if (r-R0) > 0 and a negative value if (r-R0) < 0. This sign convention can be useful when using the spring force to compute a potential of diff --git a/doc/src/fix_tmd.rst b/doc/src/fix_tmd.rst index bbc99d3ba2..521da5ecb2 100644 --- a/doc/src/fix_tmd.rst +++ b/doc/src/fix_tmd.rst @@ -55,8 +55,8 @@ a .gz suffix). The format of the target file1 is as follows: The first 3 lines may or may not be needed, depending on the format of the atoms to follow. If image flags are included with the atoms, the -1st 3 lo/hi lines must appear in the file. If image flags are not -included, the 1st 3 lines should not appear. The 3 lines contain the +first 3 lo/hi lines must appear in the file. If image flags are not +included, the first 3 lines should not appear. The 3 lines contain the simulation box dimensions for the atom coordinates, in the same format as in a LAMMPS data file (see the :doc:`read_data ` command). diff --git a/doc/src/group.rst b/doc/src/group.rst index 42e1d29a85..6371a030ee 100644 --- a/doc/src/group.rst +++ b/doc/src/group.rst @@ -118,7 +118,7 @@ specified atom types, atom IDs, or molecule IDs into the group. These 3 styles can use arguments specified in one of two formats. The first format is a list of values (types or IDs). For example, the -2nd command in the examples above puts all atoms of type 3 or 4 into +second command in the examples above puts all atoms of type 3 or 4 into the group named *water*\ . Each entry in the list can be a colon-separated sequence A:B or A:B:C, as in two of the examples above. A "sequence" generates a sequence of values (types or IDs), @@ -131,9 +131,9 @@ uses an increment of 10 and would thus would add atoms IDs The second format is a *logical* followed by one or two values (type or ID). The 7 valid logicals are listed above. All the logicals -except <> take a single argument. The 3rd example above adds all +except <> take a single argument. The third example above adds all atoms with IDs from 1 to 150 to the group named *sub*\ . The logical <> -means "between" and takes 2 arguments. The 4th example above adds all +means "between" and takes 2 arguments. The fourth example above adds all atoms belonging to molecules with IDs from 50 to 250 (inclusive) to the group named polyA. @@ -192,7 +192,7 @@ this operation is useful is if the *region* style has been used previously to add atoms to a group that are within a geometric region. If molecules straddle the region boundary, then atoms outside the region that are part of molecules with atoms inside the region will -not be in the group. Using the group command a 2nd time with *include +not be in the group. Using the group command a second time with *include molecule* will add those atoms that are outside the region to the group. @@ -207,7 +207,7 @@ group. atoms, and P is the number of processors. The *subtract* style takes a list of two or more existing group names -as arguments. All atoms that belong to the 1st group, but not to any +as arguments. All atoms that belong to the first group, but not to any of the other groups are added to the specified group. The *union* style takes a list of one or more existing group names as diff --git a/doc/src/improper_class2.rst b/doc/src/improper_class2.rst index 5affc0d4bb..be50a18299 100644 --- a/doc/src/improper_class2.rst +++ b/doc/src/improper_class2.rst @@ -48,7 +48,7 @@ the :doc:`read_data ` command) are ordered I,J,K,L. the plane of J,K,L, and the bond JK lies in both planes. Similarly for :math:`\chi_{kjli}` and :math:`\chi_{ljik}`. Note that atom J appears in the common bonds (JI, JK, JL) of all 3 X -terms. Thus J (the 2nd atom in the quadruplet) is the atom of +terms. Thus J (the second atom in the quadruplet) is the atom of symmetry in the 3 :math:`\chi` angles. The subscripts on the various :math:`\theta`\ s refer to different @@ -56,7 +56,7 @@ combinations of 3 atoms (I,J,K,L) used to form a particular angle. E.g. :math:`\theta_{ijl}` is the angle formed by atoms I,J,L with J in the middle. :math:`\theta_1`, :math:`\theta_2`, :math:`\theta_3` are the equilibrium positions of those angles. Again, -atom J (the 2nd atom in the quadruplet) is the atom of symmetry in the +atom J (the second atom in the quadruplet) is the atom of symmetry in the theta angles, since it is always the center atom. Since atom J is the atom of symmetry, normally the bonds J-I, J-K, J-L diff --git a/doc/src/improper_coeff.rst b/doc/src/improper_coeff.rst index 3d2878c517..8fd8269fd5 100644 --- a/doc/src/improper_coeff.rst +++ b/doc/src/improper_coeff.rst @@ -32,7 +32,7 @@ file read by the :doc:`read_data ` command or in a restart file. N can be specified in one of two ways. An explicit numeric value can -be used, as in the 1st example above. Or a wild-card asterisk can be +be used, as in the first example above. Or a wild-card asterisk can be used to set the coefficients for multiple improper types. This takes the form "\*" or "\*n" or "n\*" or "m\*n". If N = the number of improper types, then an asterisk with no numeric values means all types from 1 @@ -55,7 +55,7 @@ exact same format as the arguments of the improper_coeff command in an input script, except that wild-card asterisks should not be used since coefficients for all N types must be listed in the file. For example, under the "Improper Coeffs" section of a data file, the line that -corresponds to the 1st example above would be listed as +corresponds to the first example above would be listed as .. parsed-literal:: diff --git a/doc/src/improper_hybrid.rst b/doc/src/improper_hybrid.rst index 9d5c4c696d..a36d05e719 100644 --- a/doc/src/improper_hybrid.rst +++ b/doc/src/improper_hybrid.rst @@ -48,7 +48,7 @@ to other hybrid styles, use the style name (e.g. "harmonic") appropriate to that style. The AngleAngle coeffs for that improper type will then be ignored. -An improper style of *none* can be specified as the 2nd argument to +An improper style of *none* can be specified as the second argument to the improper_coeff command, if you desire to turn off certain improper types. diff --git a/doc/src/jump.rst b/doc/src/jump.rst index d597b336d3..bad13630ab 100644 --- a/doc/src/jump.rst +++ b/doc/src/jump.rst @@ -60,7 +60,7 @@ of SELF, e.g. lmp_g++ -var fname in.script < in.script -The 2nd argument to the jump command is optional. If specified, it is +The second argument to the jump command is optional. If specified, it is treated as a label and the new file is scanned (without executing commands) until the label is found, and commands are executed from that point forward. This can be used to loop over a portion of the diff --git a/doc/src/kspace_style.rst b/doc/src/kspace_style.rst index 57cd51d549..4b28c0a3c3 100644 --- a/doc/src/kspace_style.rst +++ b/doc/src/kspace_style.rst @@ -163,7 +163,7 @@ The *pppm/dipole/spin* style invokes a particle-particle particle-mesh solver for magnetic dipole-dipole interactions between magnetic spins. The *pppm/tip4p* style is identical to the *pppm* style except that it -adds a charge at the massless 4th site in each TIP4P water molecule. +adds a charge at the massless fourth site in each TIP4P water molecule. It should be used with :doc:`pair styles ` with a *tip4p/long* in their style name. diff --git a/doc/src/mass.rst b/doc/src/mass.rst index 55ba9c61bf..d43f239112 100644 --- a/doc/src/mass.rst +++ b/doc/src/mass.rst @@ -31,7 +31,7 @@ using the "Masses" keyword. See the :doc:`units ` command for what mass units to use. The I index can be specified in one of two ways. An explicit numeric -value can be used, as in the 1st example above. Or a wild-card +value can be used, as in the first example above. Or a wild-card asterisk can be used to set the mass for multiple atom types. 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 all types @@ -44,7 +44,7 @@ A line in a :doc:`data file ` that follows the "Masses" keyword specifies mass using the same format as the arguments of the mass command in an input script, except that no wild-card asterisk can be used. For example, under the "Masses" section of a data file, the -line that corresponds to the 1st example above would be listed as +line that corresponds to the first example above would be listed as .. parsed-literal:: diff --git a/doc/src/message.rst b/doc/src/message.rst index f4ca5735e0..a727064ded 100644 --- a/doc/src/message.rst +++ b/doc/src/message.rst @@ -178,7 +178,7 @@ processing the rest of its input script after client/server communication terminates. If both codes cooperate in this manner, a new round of client/server -messaging can be initiated after termination by re-using a 2nd message +messaging can be initiated after termination by re-using a second message command in your LAMMPS input script, followed by a new fix client or server command, followed by another message quit command (if LAMMPS is the client). As an example, this can be performed in a loop to use a diff --git a/doc/src/minimize.rst b/doc/src/minimize.rst index 81234ae80e..d14d988555 100644 --- a/doc/src/minimize.rst +++ b/doc/src/minimize.rst @@ -95,7 +95,7 @@ coordinates: where the first term is the sum of all non-bonded :doc:`pairwise interactions ` including :doc:`long-range Coulombic -interactions `, the 2nd through 5th terms are :doc:`bond +interactions `, the second through fifth terms are :doc:`bond `, :doc:`angle `, :doc:`dihedral `, and :doc:`improper ` interactions respectively, and the last term is energy due to :doc:`fixes ` diff --git a/doc/src/molecule.rst b/doc/src/molecule.rst index aa00949990..7b316b9d24 100644 --- a/doc/src/molecule.rst +++ b/doc/src/molecule.rst @@ -458,7 +458,7 @@ If flag = 0, no a,b,c values are listed on the line, just the If flag = 1, a,b,c are listed, where a = bondtype of the bond between the central atom and the first non-central atom (value b in the Shake Atoms section), b = bondtype of the bond between the central atom and -the 2nd non-central atom (value c in the Shake Atoms section), and c = +the second non-central atom (value c in the Shake Atoms section), and c = the angle type (1 to Nangletypes) of the angle between the 3 atoms. If flag = 2, only a is listed, where a = bondtype of the bond between @@ -467,13 +467,13 @@ the 2 atoms in the cluster. If flag = 3, a,b are listed, where a = bondtype of the bond between the central atom and the first non-central atom (value b in the Shake Atoms section), and b = bondtype of the bond between the central atom -and the 2nd non-central atom (value c in the Shake Atoms section). +and the second non-central atom (value c in the Shake Atoms section). If flag = 4, a,b,c are listed, where a = bondtype of the bond between the central atom and the first non-central atom (value b in the Shake Atoms section), b = bondtype of the bond between the central atom and -the 2nd non-central atom (value c in the Shake Atoms section), and c = -bondtype of the bond between the central atom and the 3rd non-central +the second non-central atom (value c in the Shake Atoms section), and c = +bondtype of the bond between the central atom and the third non-central atom (value d in the Shake Atoms section). See the :doc:`fix shake ` doc page for a further description diff --git a/doc/src/neb.rst b/doc/src/neb.rst index acb157e2ec..e2c7fac51b 100644 --- a/doc/src/neb.rst +++ b/doc/src/neb.rst @@ -123,7 +123,7 @@ interpolated manner. This is done by using the current position of the atom as the starting point and the read-in position as the final point. The distance between them is calculated, and the new position is assigned to be a fraction of the distance. E.g. if there are 10 -replicas, the 2nd replica will assign a position that is 10% of the +replicas, the second replica will assign a position that is 10% of the distance along a line between the starting and final point, and the 9th replica will assign a position that is 90% of the distance along the line. Note that for this procedure to produce consistent diff --git a/doc/src/newton.rst b/doc/src/newton.rst index df1298a9e4..c1a015c3e6 100644 --- a/doc/src/newton.rst +++ b/doc/src/newton.rst @@ -26,8 +26,8 @@ Examples Description """"""""""" -This command turns Newton's 3rd law *on* or *off* for pairwise and -bonded interactions. For most problems, setting Newton's 3rd law to +This command turns Newton's third law *on* or *off* for pairwise and +bonded interactions. For most problems, setting Newton's third law to *on* means a modest savings in computation at the cost of two times more communication. Whether this is faster depends on problem size, force cutoff lengths, a machine's compute/communication ratio, and how diff --git a/doc/src/next.rst b/doc/src/next.rst index fd62e29ffe..3032a36921 100644 --- a/doc/src/next.rst +++ b/doc/src/next.rst @@ -96,7 +96,7 @@ directories run1 through run8. If the variable "d" were of style *universe*\ , and the same in.polymer input script were run on 3 partitions of processors, then the first 3 simulations would begin, one on each set of processors. Whichever -partition finished first, it would assign variable "d" the 4th value +partition finished first, it would assign variable "d" the fourth value and run another simulation, and so forth until all 8 simulations were finished. diff --git a/doc/src/package.rst b/doc/src/package.rst index a6a2353087..0761c2b573 100644 --- a/doc/src/package.rst +++ b/doc/src/package.rst @@ -577,7 +577,7 @@ All three of these examples use a total of 4 CPU cores. Note that different MPI implementations have different ways of passing the OMP_NUM_THREADS environment variable to all MPI processes. The -2nd example line above is for MPICH; the 3rd example line with -x is +second example line above is for MPICH; the third example line with -x is for OpenMPI. Check your MPI documentation for additional details. What combination of threads and MPI tasks gives the best performance diff --git a/doc/src/pair_adp.rst b/doc/src/pair_adp.rst index bbfd98f677..ddde4cc344 100644 --- a/doc/src/pair_adp.rst +++ b/doc/src/pair_adp.rst @@ -79,14 +79,14 @@ As an example, the potentials/AlCu.adp file, included in the potentials directory of the LAMMPS distribution, is an extended *setfl* file which has tabulated ADP values for w elements and their alloy interactions: Cu and Al. If your LAMMPS simulation has 4 atoms types -and you want the 1st 3 to be Al, and the 4th to be Cu, you would use +and you want the first 3 to be Al, and the fourth to be Cu, you would use the following pair_coeff command: .. code-block:: LAMMPS pair_coeff * * AlCu.adp Al Al Al Cu -The 1st 2 arguments must be \* \* so as to span all LAMMPS atom types. +The first 2 arguments must be \* \* so as to span all LAMMPS atom types. The first three Al arguments map LAMMPS atom types 1,2,3 to the Al element in the extended *setfl* file. The final Cu argument maps LAMMPS atom type 4 to the Al element in the extended *setfl* file. diff --git a/doc/src/pair_airebo.rst b/doc/src/pair_airebo.rst index b6d1af2a79..8aad39f877 100644 --- a/doc/src/pair_airebo.rst +++ b/doc/src/pair_airebo.rst @@ -73,8 +73,8 @@ and its parameterization are given in :ref:`(O'Conner) `. The *rebo* pair style computes the Reactive Empirical Bond Order (REBO) Potential of :ref:`(Brenner) `. Note that this is the so-called -2nd generation REBO from 2002, not the original REBO from 1990. -As discussed below, 2nd generation REBO is closely related to the +second generation REBO from 2002, not the original REBO from 1990. +As discussed below, second generation REBO is closely related to the initial AIREBO; it is just a subset of the potential energy terms with a few slightly different parameters @@ -90,7 +90,7 @@ By default, all three terms are included. For the *airebo* style, if the first two optional flag arguments to the pair_style command are included, the LJ and torsional terms can be turned off. Note that both or neither of the flags must be included. If both of the LJ an -torsional terms are turned off, it becomes the 2nd-generation REBO +torsional terms are turned off, it becomes the second-generation REBO potential, with a small caveat on the spline fitting procedure mentioned below. This can be specified directly as pair_style *rebo* with no additional arguments. @@ -150,14 +150,14 @@ See the :doc:`pair_coeff ` doc page for alternate ways to specify the path for the potential file. As an example, if your LAMMPS simulation has 4 atom types and you want -the 1st 3 to be C, and the 4th to be H, you would use the following +the first 3 to be C, and the fourth to be H, you would use the following pair_coeff command: .. code-block:: LAMMPS pair_coeff * * CH.airebo C C C H -The 1st 2 arguments must be \* \* so as to span all LAMMPS atom types. +The first 2 arguments must be \* \* so as to span all LAMMPS atom types. The first three C arguments map LAMMPS atom types 1,2,3 to the C element in the AIREBO file. The final H argument maps LAMMPS atom type 4 to the H element in the SW file. If a mapping value is diff --git a/doc/src/pair_atm.rst b/doc/src/pair_atm.rst index 902e07a80d..5017f101cd 100644 --- a/doc/src/pair_atm.rst +++ b/doc/src/pair_atm.rst @@ -71,7 +71,7 @@ above, or in the restart files read by the * :math:`\nu` = prefactor (energy/distance\^9 units) :math:`K` can be specified in one of two ways. An explicit numeric value can -be used, as in the 2nd example above. :math:`J \leq K` is required. LAMMPS +be used, as in the second example above. :math:`J \leq K` is required. LAMMPS sets the coefficients for the other 5 symmetric interactions to the same values. E.g. if :math:`I = 1`, :math:`J = 2`, :math:`K = 3`, then these 6 values are set to the specified :math:`\nu`: :math:`\nu_{123}`, diff --git a/doc/src/pair_bop.rst b/doc/src/pair_bop.rst index 5cd045931a..5194387e41 100644 --- a/doc/src/pair_bop.rst +++ b/doc/src/pair_bop.rst @@ -129,14 +129,14 @@ where N is the number of LAMMPS atom types: As an example, imagine the CdTe.bop file has BOP values for Cd and Te. If your LAMMPS simulation has 4 atoms types and you want the -1st 3 to be Cd, and the 4th to be Te, you would use the following +first 3 to be Cd, and the fourth to be Te, you would use the following pair_coeff command: .. code-block:: LAMMPS pair_coeff * * CdTe Cd Cd Cd Te -The 1st 2 arguments must be \* \* so as to span all LAMMPS atom types. +The first 2 arguments must be \* \* so as to span all LAMMPS atom types. The first three Cd arguments map LAMMPS atom types 1,2,3 to the Cd element in the BOP file. The final Te argument maps LAMMPS atom type 4 to the Te element in the BOP file. diff --git a/doc/src/pair_charmm.rst b/doc/src/pair_charmm.rst index 031e6e6717..1c8bb2a665 100644 --- a/doc/src/pair_charmm.rst +++ b/doc/src/pair_charmm.rst @@ -127,7 +127,7 @@ name are the older, original LAMMPS implementations. They compute the LJ and Coulombic interactions with an energy switching function (esw, shown in the formula below as S(r)), which ramps the energy smoothly to zero between the inner and outer cutoff. This can cause -irregularities in pair-wise forces (due to the discontinuous 2nd +irregularities in pair-wise forces (due to the discontinuous second derivative of energy at the boundaries of the switching region), which in some cases can result in detectable artifacts in an MD simulation. diff --git a/doc/src/pair_coeff.rst b/doc/src/pair_coeff.rst index 1886ce1118..17669a238b 100644 --- a/doc/src/pair_coeff.rst +++ b/doc/src/pair_coeff.rst @@ -35,7 +35,7 @@ pair style. Pair coefficients can also be set in the data file read by the :doc:`read_data ` command or in a restart file. I and J can be specified in one of two ways. Explicit numeric values -can be used for each, as in the 1st example above. I <= J is +can be used for each, as in the first example above. I <= J is required. LAMMPS sets the coefficients for the symmetric J,I interaction to the same values. @@ -66,7 +66,7 @@ specified, which sets the coefficients for type I interacting with type I. This is because the section has exactly N lines, where N = the number of atom types. For this reason, the wild-card asterisk should also not be used as part of the I argument. Thus in a data -file, the line corresponding to the 1st example above would be listed +file, the line corresponding to the first example above would be listed as .. parsed-literal:: diff --git a/doc/src/pair_comb.rst b/doc/src/pair_comb.rst index 247f539ab5..6d65ff7753 100644 --- a/doc/src/pair_comb.rst +++ b/doc/src/pair_comb.rst @@ -37,7 +37,7 @@ Examples Description """"""""""" -Style *comb* computes the second-generation variable charge COMB +Style *comb* computes the second generation variable charge COMB (Charge-Optimized Many-Body) potential. Style *comb3* computes the third-generation COMB potential. These COMB potentials are described in :ref:`(COMB) ` and :ref:`(COMB3) `. Briefly, the @@ -74,8 +74,8 @@ N additional arguments after the potential file in the pair_coeff command, where N is the number of LAMMPS atom types. For example, if your LAMMPS simulation of a Si/SiO2/ -HfO2 interface has 4 atom types, and you want the 1st and -last to be Si, the 2nd to be Hf, and the 3rd to be O, and you would +HfO2 interface has 4 atom types, and you want the first and +last to be Si, the second to be Hf, and the third to be O, and you would use the following pair_coeff command: .. code-block:: LAMMPS @@ -93,10 +93,10 @@ This can be used when a *comb* potential is used as part of the that will be used with other potentials. For style *comb*\ , the provided potential file *ffield.comb* contains -all currently-available 2nd generation COMB parameterizations: for Si, +all currently-available second generation COMB parameterizations: for Si, Cu, Hf, Ti, O, their oxides and Zr, Zn and U metals. For style *comb3*\ , the potential file *ffield.comb3* contains all -currently-available 3rd generation COMB parameterizations: O, Cu, N, C, +currently-available third generation COMB parameterizations: O, Cu, N, C, H, Ti, Zn and Zr. The status of the optimization of the compounds, for example Cu2O, TiN and hydrocarbons, are given in the following table: diff --git a/doc/src/pair_e3b.rst b/doc/src/pair_e3b.rst index 68f8708b27..cb9a7c1358 100644 --- a/doc/src/pair_e3b.rst +++ b/doc/src/pair_e3b.rst @@ -80,7 +80,7 @@ The two-body interactions are cut off sharply at Rc2, because K3 is typically si See :ref:`(Kumar 2008) ` for more details. Only a single *pair_coeff* command is used with the *e3b* style. -The 1st two arguments must be \* \*. +The first two arguments must be \* \*. The oxygen atom type for the pair style is passed as the only argument to the *pair_style* command, not in the *pair_coeff* command. The hydrogen atom type is inferred by the ordering of the atoms. diff --git a/doc/src/pair_eam.rst b/doc/src/pair_eam.rst index c93c694833..50b55084c2 100644 --- a/doc/src/pair_eam.rst +++ b/doc/src/pair_eam.rst @@ -262,15 +262,15 @@ As an example, the potentials/NiAlH_jea.eam.alloy file is a *setfl* file which has tabulated EAM values for 3 elements and their alloy interactions: Ni, Al, and H. See the :doc:`pair_coeff ` doc page for alternate ways to specify the path for the potential file. -If your LAMMPS simulation has 4 atoms types and you want the 1st 3 to -be Ni, and the 4th to be Al, you would use the following pair_coeff +If your LAMMPS simulation has 4 atoms types and you want the first 3 to +be Ni, and the fourth to be Al, you would use the following pair_coeff command: .. code-block:: LAMMPS pair_coeff * * NiAlH_jea.eam.alloy Ni Ni Ni Al -The 1st 2 arguments must be \* \* so as to span all LAMMPS atom types. +The first 2 arguments must be \* \* so as to span all LAMMPS atom types. The first three Ni arguments map LAMMPS atom types 1,2,3 to the Ni element in the *setfl* file. The final Al argument maps LAMMPS atom type 4 to the Al element in the *setfl* file. Note that there is no @@ -309,7 +309,7 @@ element, each with the following format: As with the *funcfl* files, only the mass (in mass :doc:`units `, e.g. mass number or grams/mole for metal units) is used by LAMMPS from -the 1st line. The cubic lattice constant is in Angstroms. The F and +the first line. The cubic lattice constant is in Angstroms. The F and rho arrays are unique to a single element and have the same format and units as in a *funcfl* file. diff --git a/doc/src/pair_eff.rst b/doc/src/pair_eff.rst index f163e5afaa..0dc2aba510 100644 --- a/doc/src/pair_eff.rst +++ b/doc/src/pair_eff.rst @@ -44,7 +44,7 @@ Field (eFF) potential currently under development at Caltech, as described in :ref:`(Jaramillo-Botero) `. The eFF for Z<6 was first introduced by :ref:`(Su) ` in 2007. It has been extended to higher Zs by using effective core potentials (ECPs) that now cover up -to 2nd and 3rd row p-block elements of the periodic table. +to second and third row p-block elements of the periodic table. eFF can be viewed as an approximation to QM wave packet dynamics and Fermionic molecular dynamics, combining the ability of electronic @@ -210,7 +210,7 @@ representations, after the "ecp" keyword. for systems containing nuclei from Z = 1-6 in "all electron" representations. For systems with increasingly non-spherical electrons, Users should use the ECP representations. ECPs are now - supported and validated for most of the 2nd and 3rd row elements of + supported and validated for most of the second and third row elements of the p-block. Predefined parameters are provided for C, N, O, Al, and Si. The ECP captures the orbital overlap between the core and valence electrons (i.e. Pauli repulsion) with one of the functional forms: @@ -220,8 +220,8 @@ representations, after the "ecp" keyword. E_{Pauli(ECP_s)} = & p_1\exp\left(-\frac{p_2r^2}{p_3+s^2} \right) \\ E_{Pauli(ECP_p)} = & p_1\left( \frac{2}{p_2/s+s/p_2} \right)\left( r-p_3s\right)^2\exp \left[ -\frac{p_4\left( r-p_3s \right)^2}{p_5+s^2} \right] -Where the 1st form correspond to core interactions with s-type valence -electrons and the 2nd to core interactions with p-type valence +Where the first form correspond to core interactions with s-type valence +electrons and the second to core interactions with p-type valence electrons. The current version adds full support for models with fixed-core and diff --git a/doc/src/pair_eim.rst b/doc/src/pair_eim.rst index bb09e10ed2..1cea2f0993 100644 --- a/doc/src/pair_eim.rst +++ b/doc/src/pair_eim.rst @@ -110,14 +110,14 @@ to specify the path for the potential file. As an example like one of those above, suppose you want to model a system with Na and Cl atoms. If your LAMMPS simulation has 4 atoms -types and you want the 1st 3 to be Na, and the 4th to be Cl, you would +types and you want the first 3 to be Na, and the fourth to be Cl, you would use the following pair_coeff command: .. code-block:: LAMMPS pair_coeff * * Na Cl ffield.eim Na Na Na Cl -The 1st 2 arguments must be \* \* so as to span all LAMMPS atom types. +The first 2 arguments must be \* \* so as to span all LAMMPS atom types. The filename is the EIM potential file. The Na and Cl arguments (before the file name) are the two elements for which info will be extracted from the potential file. The first three trailing Na diff --git a/doc/src/pair_exp6_rx.rst b/doc/src/pair_exp6_rx.rst index 7f2be1817a..cff706d26b 100644 --- a/doc/src/pair_exp6_rx.rst +++ b/doc/src/pair_exp6_rx.rst @@ -123,15 +123,15 @@ parenthesized comments): epsilon 0.0000 0.00478 -0.06283 0.24486 -0.33737 2.60097 rm 0.0001 -0.00118 -0.00253 0.05812 -0.00509 1.50106 -A section begins with a non-blank line whose 1st character is not a +A section begins with a non-blank line whose first character is not a "#"; blank lines or lines starting with "#" can be used as comments between sections. Following a blank line, the next N lines list the species and their corresponding parameters. The first argument is the species tag, the -second argument is the exp6 tag, the 3rd argument is the :math:`\alpha` -parameter (energy units), the 4th argument is the :math:`\epsilon` parameter -(energy-distance\^6 units), and the 5th argument is the :math:`R_m` parameter +second argument is the exp6 tag, the third argument is the :math:`\alpha` +parameter (energy units), the fourth argument is the :math:`\epsilon` parameter +(energy-distance\^6 units), and the fifth argument is the :math:`R_m` parameter (distance units). If a species tag of "1fluid" is listed as a pair coefficient, a one-fluid approximation is specified where a concentration-dependent combination of the parameters is computed diff --git a/doc/src/pair_gran.rst b/doc/src/pair_gran.rst index 3cfe946e41..49ae84d673 100644 --- a/doc/src/pair_gran.rst +++ b/doc/src/pair_gran.rst @@ -248,7 +248,7 @@ dissipative potentials. It also returns only the normal component of the pairwise interaction force. However, the single() function also calculates 10 extra pairwise quantities. The first 3 are the components of the tangential force between particles I and J, acting -on particle I. The 4th is the magnitude of this tangential force. +on particle I. The fourth is the magnitude of this tangential force. The next 3 (5-7) are the components of the relative velocity in the normal direction (along the line joining the 2 sphere centers). The last 3 (8-10) the components of the relative velocity in the diff --git a/doc/src/pair_granular.rst b/doc/src/pair_granular.rst index f581c502f3..ee90d1537a 100644 --- a/doc/src/pair_granular.rst +++ b/doc/src/pair_granular.rst @@ -655,7 +655,7 @@ dissipative potentials. It also returns only the normal component of the pairwise interaction force. However, the single() function also calculates 12 extra pairwise quantities. The first 3 are the components of the tangential force between particles I and J, acting -on particle I. The 4th is the magnitude of this tangential force. +on particle I. The fourth is the magnitude of this tangential force. The next 3 (5-7) are the components of the rolling torque acting on particle I. The next entry (8) is the magnitude of the rolling torque. The next entry (9) is the magnitude of the twisting torque acting diff --git a/doc/src/pair_gw.rst b/doc/src/pair_gw.rst index 7564252459..82d99f8785 100644 --- a/doc/src/pair_gw.rst +++ b/doc/src/pair_gw.rst @@ -55,7 +55,7 @@ to specify the path for the potential file. As an example, imagine a file SiC.gw has Gao-Weber values for Si and C. If your LAMMPS simulation has 4 atoms types and you want the first 3 to -be Si, and the 4th to be C, you would use the following pair_coeff command: +be Si, and the fourth to be C, you would use the following pair_coeff command: .. code-block:: LAMMPS diff --git a/doc/src/pair_hbond_dreiding.rst b/doc/src/pair_hbond_dreiding.rst index 0f5470d5f9..ec705a649b 100644 --- a/doc/src/pair_hbond_dreiding.rst +++ b/doc/src/pair_hbond_dreiding.rst @@ -72,7 +72,7 @@ hydrogen (H) and the donor atoms: These 3-body interactions can be defined for pairs of acceptor and donor atoms, based on atom types. For each donor/acceptor atom pair, -the 3rd atom in the interaction is a hydrogen permanently bonded to +the third atom in the interaction is a hydrogen permanently bonded to the donor atom, e.g. in a bond list read in from a data file via the :doc:`read_data ` command. The atom types of possible hydrogen atoms for each donor/acceptor type pair are specified by the @@ -188,7 +188,7 @@ hydrogen bond potential based on a Morse functional form. The last 3 coefficients for both styles are optional. If not specified, the global n, distance cutoff, and angle cutoff specified in the pair_style command are used. If you wish to only override the -2nd or 3rd optional parameter, you must also specify the preceding +second or third optional parameter, you must also specify the preceding optional parameters. ---------- diff --git a/doc/src/pair_hybrid.rst b/doc/src/pair_hybrid.rst index 8e40466faf..da32a0ee45 100644 --- a/doc/src/pair_hybrid.rst +++ b/doc/src/pair_hybrid.rst @@ -51,7 +51,7 @@ be used for a simulation of a metal droplet on a LJ surface. The metal atoms interact with each other via an *eam* potential, the surface atoms interact with each other via a *lj/cut* potential, and the metal/surface interaction is also computed via a *lj/cut* -potential. The *hybrid/overlay* style could be used as in the 2nd +potential. The *hybrid/overlay* style could be used as in the second example above, where multiple potentials are superposed in an additive fashion to compute the interaction between atoms. In this example, using *lj/cut* and *coul/long* together gives the same result as if @@ -72,7 +72,7 @@ sub-style. For efficiency this should only be done if your model requires it. E.g. if you have different regions of Si and C atoms and wish to use a Tersoff potential for pure Si for one set of atoms, and a Tersoff potential for pure C for the other set (presumably with some -3rd potential for Si-C interactions), then the sub-style *tersoff* +third potential for Si-C interactions), then the sub-style *tersoff* could be listed twice. But if you just want to use a Lennard-Jones or other pairwise potential for several different atom type pairs in your model, then you should just list the sub-style once and use the diff --git a/doc/src/pair_lcbop.rst b/doc/src/pair_lcbop.rst index ef26556c69..24445ee485 100644 --- a/doc/src/pair_lcbop.rst +++ b/doc/src/pair_lcbop.rst @@ -38,13 +38,13 @@ See the :doc:`pair_coeff ` doc page for alternate ways to specify the path for the potential file. As an example, if your LAMMPS simulation has 4 atom types and you want -the 1st 3 to be C you would use the following pair_coeff command: +the first 3 to be C you would use the following pair_coeff command: .. code-block:: LAMMPS pair_coeff * * C.lcbop C C C NULL -The 1st 2 arguments must be \* \* so as to span all LAMMPS atom types. +The first 2 arguments must be \* \* so as to span all LAMMPS atom types. The first C argument maps LAMMPS atom type 1 to the C element in the LCBOP file. If a mapping value is specified as NULL, the mapping is not performed. This can be used when a *lcbop* potential is used as diff --git a/doc/src/pair_lj_smooth.rst b/doc/src/pair_lj_smooth.rst index b2cf6f7493..16c1973883 100644 --- a/doc/src/pair_lj_smooth.rst +++ b/doc/src/pair_lj_smooth.rst @@ -43,14 +43,14 @@ The polynomial coefficients C1, C2, C3, C4 are computed by LAMMPS to cause the force to vary smoothly from the inner cutoff :math:`r_{in}` to the outer cutoff :math:`r_c`. -At the inner cutoff the force and its 1st derivative +At the inner cutoff the force and its first derivative will match the non-smoothed LJ formula. At the outer cutoff the force -and its 1st derivative will be 0.0. The inner cutoff cannot be 0.0. +and its first derivative will be 0.0. The inner cutoff cannot be 0.0. .. note:: this force smoothing causes the energy to be discontinuous both - in its values and 1st derivative. This can lead to poor energy + in its values and first derivative. This can lead to poor energy conservation and may require the use of a thermostat. Plot the energy and force resulting from this formula via the :doc:`pair_write ` command to see the effect. diff --git a/doc/src/pair_meam_spline.rst b/doc/src/pair_meam_spline.rst index 6c4da24625..a1b6709867 100644 --- a/doc/src/pair_meam_spline.rst +++ b/doc/src/pair_meam_spline.rst @@ -93,7 +93,7 @@ command: pair_coeff * * Ti.meam.spline Ti Ti Ti -The 1st 2 arguments must be \* \* so as to span all LAMMPS atom types. +The first 2 arguments must be \* \* so as to span all LAMMPS atom types. The three Ti arguments map LAMMPS atom types 1,2,3 to the Ti element in the potential file. If a mapping value is specified as NULL, the mapping is not performed. This can be used when a *meam/spline* @@ -109,7 +109,7 @@ the command pair_coeff * * TiO.meam.spline Ti O -will map the 1st atom type to Ti and the second atom type to O. Note +will map the first atom type to Ti and the second atom type to O. Note in this case that the species names need to match exactly with the names of the elements in the TiO.meam.spline file; otherwise an error will be raised. This behavior is different than the old style diff --git a/doc/src/pair_meam_sw_spline.rst b/doc/src/pair_meam_sw_spline.rst index 0cf4c57975..6400f7eadd 100644 --- a/doc/src/pair_meam_sw_spline.rst +++ b/doc/src/pair_meam_sw_spline.rst @@ -79,7 +79,7 @@ command: pair_coeff * * Ti.meam.sw.spline Ti Ti Ti -The 1st 2 arguments must be \* \* so as to span all LAMMPS atom types. +The first 2 arguments must be \* \* so as to span all LAMMPS atom types. The three Ti arguments map LAMMPS atom types 1,2,3 to the Ti element in the potential file. If a mapping value is specified as NULL, the mapping is not performed. This can be used when a *meam/sw/spline* diff --git a/doc/src/pair_meamc.rst b/doc/src/pair_meamc.rst index f227af8b45..7a0b0ca12b 100644 --- a/doc/src/pair_meamc.rst +++ b/doc/src/pair_meamc.rst @@ -71,7 +71,7 @@ the MEAM potential files themselves. Only a single pair_coeff command is used with the *meam* style which specifies two MEAM files and the element(s) to extract information for. The MEAM elements are mapped to LAMMPS atom types by specifying -N additional arguments after the 2nd filename in the pair_coeff +N additional arguments after the second filename in the pair_coeff command, where N is the number of LAMMPS atom types: * MEAM library file @@ -85,14 +85,14 @@ to specify the path for the potential files. As an example, the potentials/library.meam file has generic MEAM settings for a variety of elements. The potentials/SiC.meam file has specific parameter settings for a Si and C alloy system. If your -LAMMPS simulation has 4 atoms types and you want the 1st 3 to be Si, -and the 4th to be C, you would use the following pair_coeff command: +LAMMPS simulation has 4 atoms types and you want the first 3 to be Si, +and the fourth to be C, you would use the following pair_coeff command: .. code-block:: LAMMPS pair_coeff * * library.meam Si C sic.meam Si Si Si C -The 1st 2 arguments must be \* \* so as to span all LAMMPS atom types. +The first 2 arguments must be \* \* so as to span all LAMMPS atom types. The first filename is the element library file. The list of elements following it extracts lines from the library file and assigns numeric indices to these elements. The second filename is the alloy parameter file, which refers to @@ -101,7 +101,7 @@ The arguments after the parameter file map LAMMPS atom types to elements, i.e. LAMMPS atom types 1,2,3 to the MEAM Si element. The final C argument maps LAMMPS atom type 4 to the MEAM C element. -If the 2nd filename is specified as NULL, no parameter file is read, +If the second filename is specified as NULL, no parameter file is read, which simply means the generic parameters in the library file are used. Use of the NULL specification for the parameter file is discouraged for systems with more than a single element type @@ -116,14 +116,14 @@ that will be used with other potentials. .. note:: - If the 2nd filename is NULL, the element names between the two + If the second filename is NULL, the element names between the two filenames can appear in any order, e.g. "Si C" or "C Si" in the - example above. However, if the 2nd filename is not NULL (as in the + example above. However, if the second filename is not NULL (as in the example above), it contains settings that are Fortran-indexed for the elements that precede it. Thus you need to insure you list the elements between the filenames in an order consistent with how the - values in the 2nd filename are indexed. See details below on the - syntax for settings in the 2nd file. + values in the second filename are indexed. See details below on the + syntax for settings in the second file. The MEAM library file provided with LAMMPS has the name potentials/library.meam. It is the "meamf" file used by other MD @@ -299,7 +299,7 @@ Thus these lines rho0(2) = 2.25 alpha(1,2) = 4.37 -set rho0 for the 2nd element to the value 2.25 and set alpha for the +set rho0 for the second element to the value 2.25 and set alpha for the alloy interaction between elements 1 and 2 to 4.37. The augt1 parameter is related to modifications in the MEAM diff --git a/doc/src/pair_multi_lucy.rst b/doc/src/pair_multi_lucy.rst index 37da1ab965..a8d40cfe08 100644 --- a/doc/src/pair_multi_lucy.rst +++ b/doc/src/pair_multi_lucy.rst @@ -106,7 +106,7 @@ defined as follows (without the parenthesized comments): ... 500 10.0 0.001 0.003 -A section begins with a non-blank line whose 1st character is not a +A section begins with a non-blank line whose first character is not a "#"; blank lines or lines starting with "#" can be used as comments between sections. The first line begins with a keyword which identifies the section. The line can contain additional text, but the @@ -157,9 +157,9 @@ between *rlo\*rlo* and *rhi\*rhi* are computed. warn if this is occurring. Following a blank line, the next N lines list the tabulated values. -On each line, the 1st value is the index from 1 to N, the 2nd value is -r (in density units), the 3rd value is the density-dependent function value -(in energy units / length\^4), and the 4th is the force (in force units). The +On each line, the first value is the index from 1 to N, the second value is +r (in density units), the third value is the density-dependent function value +(in energy units / length\^4), and the fourth is the force (in force units). The density values must increase from one line to the next. Note that one file can contain many sections, each with a tabulated diff --git a/doc/src/pair_multi_lucy_rx.rst b/doc/src/pair_multi_lucy_rx.rst index 3824ca96cf..4397f25894 100644 --- a/doc/src/pair_multi_lucy_rx.rst +++ b/doc/src/pair_multi_lucy_rx.rst @@ -134,7 +134,7 @@ defined as follows (without the parenthesized comments): ... 500 10.0 0.001 0.003 -A section begins with a non-blank line whose 1st character is not a +A section begins with a non-blank line whose first character is not a "#"; blank lines or lines starting with "#" can be used as comments between sections. The first line begins with a keyword which identifies the section. The line can contain additional text, but the @@ -185,9 +185,9 @@ uniformly spaced between *rlo\*rlo* and *rhi\*rhi* are computed. this is occurring. Following a blank line, the next N lines list the tabulated values. -On each line, the 1st value is the index from 1 to N, the 2nd value is -r (in density units), the 3rd value is the density-dependent function -value (in energy units / length\^4), and the 4th is the force (in force +On each line, the first value is the index from 1 to N, the second value is +r (in density units), the third value is the density-dependent function +value (in energy units / length\^4), and the fourth is the force (in force units). The density values must increase from one line to the next. Note that one file can contain many sections, each with a tabulated diff --git a/doc/src/pair_nb3b_harmonic.rst b/doc/src/pair_nb3b_harmonic.rst index 9d63df65d5..95de93ba2e 100644 --- a/doc/src/pair_nb3b_harmonic.rst +++ b/doc/src/pair_nb3b_harmonic.rst @@ -47,14 +47,14 @@ to specify the path for the potential file. As an example, imagine a file SiC.nb3b.harmonic has potential values for Si and C. If your LAMMPS simulation has 4 atoms types and you -want the 1st 3 to be Si, and the 4th to be C, you would use the +want the first 3 to be Si, and the fourth to be C, you would use the following pair_coeff command: .. code-block:: LAMMPS pair_coeff * * SiC.nb3b.harmonic Si Si Si C -The 1st 2 arguments must be \* \* so as to span all LAMMPS atom types. +The first 2 arguments must be \* \* so as to span all LAMMPS atom types. The first three Si arguments map LAMMPS atom types 1,2,3 to the Si element in the potential file. The final C argument maps LAMMPS atom type 4 to the C element in the potential file. If a mapping value is diff --git a/doc/src/pair_polymorphic.rst b/doc/src/pair_polymorphic.rst index a23a9f12f9..d2ce98b7d5 100644 --- a/doc/src/pair_polymorphic.rst +++ b/doc/src/pair_polymorphic.rst @@ -201,8 +201,8 @@ included in the potentials directory of the LAMMPS distribution. They have a "poly" suffix. As an example, imagine the GaN_tersoff.poly file has tabulated functions -for Ga-N tersoff potential. If your LAMMPS simulation has 4 atoms types -and you want the 1st 3 to be Ga, and the 4th to be N, you would use the +for Ga-N tersoff potential. If your LAMMPS simulation has 4 atom types and +you want the first 3 to be Ga, and the fourth to be N, you would use the following pair_coeff command: .. code-block:: LAMMPS diff --git a/doc/src/pair_snap.rst b/doc/src/pair_snap.rst index 06ed748a07..0770b5a675 100644 --- a/doc/src/pair_snap.rst +++ b/doc/src/pair_snap.rst @@ -64,14 +64,14 @@ LAMMPS atom types: * N element names = mapping of SNAP elements to atom types As an example, if a LAMMPS indium phosphide simulation has 4 atoms -types, with the first two being indium and the 3rd and 4th being +types, with the first two being indium and the third and fourth being phophorous, the pair_coeff command would look like this: .. code-block:: LAMMPS pair_coeff * * snap InP.snapcoeff InP.snapparam In In P P -The 1st 2 arguments must be \* \* so as to span all LAMMPS atom types. +The first 2 arguments must be \* \* so as to span all LAMMPS atom types. The two filenames are for the coefficient and parameter files, respectively. The two trailing 'In' arguments map LAMMPS atom types 1 and 2 to the SNAP 'In' element. The two trailing 'P' arguments map LAMMPS atom types diff --git a/doc/src/pair_style.rst b/doc/src/pair_style.rst index 48dd2dde0f..f45c759b17 100644 --- a/doc/src/pair_style.rst +++ b/doc/src/pair_style.rst @@ -282,7 +282,7 @@ accelerated styles exist. * :doc:`python ` - * :doc:`quip ` - * :doc:`reax/c ` - ReaxFF potential in C -* :doc:`rebo ` - 2nd generation REBO potential of Brenner +* :doc:`rebo ` - second generation REBO potential of Brenner * :doc:`resquared ` - Everaers RE-Squared ellipsoidal potential * :doc:`sdpd/taitwater/isothermal ` - smoothed dissipative particle dynamics for water at isothermal conditions * :doc:`smd/hertz ` - diff --git a/doc/src/pair_sw.rst b/doc/src/pair_sw.rst index b4fddc6867..e38629f95b 100644 --- a/doc/src/pair_sw.rst +++ b/doc/src/pair_sw.rst @@ -68,14 +68,14 @@ to specify the path for the potential file. As an example, imagine a file SiC.sw has Stillinger-Weber values for Si and C. If your LAMMPS simulation has 4 atoms types and you want -the 1st 3 to be Si, and the 4th to be C, you would use the following +the first 3 to be Si, and the fourth to be C, you would use the following pair_coeff command: .. code-block:: LAMMPS pair_coeff * * SiC.sw Si Si Si C -The 1st 2 arguments must be \* \* so as to span all LAMMPS atom types. +The first 2 arguments must be \* \* so as to span all LAMMPS atom types. The first three Si arguments map LAMMPS atom types 1,2,3 to the Si element in the SW file. The final C argument maps LAMMPS atom type 4 to the C element in the SW file. If a mapping value is specified as @@ -140,7 +140,7 @@ entries would be required, etc. As annotated above, the first element in the entry is the center atom in a three-body interaction. Thus an entry for SiCC means a Si atom with 2 C atoms as neighbors. The parameter values used for the -two-body interaction come from the entry where the 2nd and 3rd +two-body interaction come from the entry where the second and third elements are the same. Thus the two-body parameters for Si interacting with C, comes from the SiCC entry. The three-body parameters can in principle be specific to the three elements of the @@ -158,7 +158,7 @@ order of the two neighbors is arbitrary, the three-body parameters for entries CSiC and CCSi should be the same. Similarly, the two-body parameters for entries SiCC and CSiSi should also be the same. The parameters used only for two-body interactions (A, B, p, and q) in -entries whose 2nd and 3rd element are different (e.g. SiCSi) are not +entries whose second and third element are different (e.g. SiCSi) are not used for anything and can be set to 0.0 if desired. This is also true for the parameters in :math:`\phi_3` that are taken from the ij and ik pairs (:math:`\sigma`, *a*\ , :math:`\gamma`) diff --git a/doc/src/pair_table.rst b/doc/src/pair_table.rst index 9d1a21f1dc..5638664518 100644 --- a/doc/src/pair_table.rst +++ b/doc/src/pair_table.rst @@ -139,7 +139,7 @@ defined as follows (without the parenthesized comments): ... 500 10.0 0.001 0.003 -A section begins with a non-blank line whose 1st character is not a +A section begins with a non-blank line whose first character is not a "#"; blank lines or lines starting with "#" can be used as comments between sections. The first line begins with a keyword which identifies the section. The line can contain additional text, but the @@ -196,7 +196,7 @@ file is typically produced by the :doc:`pair_write ` command with its *bitmap* option. When the table is in BITMAP format, the "N" parameter in the file must be equal to 2\^M where M is the value specified in the pair_style command. Also, a cutoff parameter cannot -be used as an optional 3rd argument in the pair_coeff command; the +be used as an optional third argument in the pair_coeff command; the entire table extent as specified in the file must be used. If used, the parameter "FPRIME" is followed by 2 values *fplo* and @@ -208,9 +208,9 @@ last 2 force values in the table. This parameter is not used by BITMAP tables. Following a blank line, the next N lines list the tabulated values. -On each line, the 1st value is the index from 1 to N, the 2nd value is -r (in distance units), the 3rd value is the energy (in energy units), -and the 4th is the force (in force units). The r values must increase +On each line, the first value is the index from 1 to N, the second value is +r (in distance units), the third value is the energy (in energy units), +and the fourth is the force (in force units). The r values must increase from one line to the next (unless the BITMAP parameter is specified). Note that one file can contain many sections, each with a tabulated diff --git a/doc/src/pair_table_rx.rst b/doc/src/pair_table_rx.rst index 32863cbd29..cc9e66f906 100644 --- a/doc/src/pair_table_rx.rst +++ b/doc/src/pair_table_rx.rst @@ -133,7 +133,7 @@ defined as follows (without the parenthesized comments): ... 500 10.0 0.001 0.003 -A section begins with a non-blank line whose 1st character is not a +A section begins with a non-blank line whose first character is not a "#"; blank lines or lines starting with "#" can be used as comments between sections. The first line begins with a keyword which identifies the section. The line can contain additional text, but the @@ -180,7 +180,7 @@ file is typically produced by the :doc:`pair_write ` command with its *bitmap* option. When the table is in BITMAP format, the "N" parameter in the file must be equal to 2\^M where M is the value specified in the pair_style command. Also, a cutoff parameter cannot -be used as an optional 3rd argument in the pair_coeff command; the +be used as an optional third argument in the pair_coeff command; the entire table extent as specified in the file must be used. If used, the parameter "FPRIME" is followed by 2 values *fplo* and @@ -192,9 +192,9 @@ last 2 force values in the table. This parameter is not used by BITMAP tables. Following a blank line, the next N lines list the tabulated values. -On each line, the 1st value is the index from 1 to N, the 2nd value is -r (in distance units), the 3rd value is the energy (in energy units), -and the 4th is the force (in force units). The r values must increase +On each line, the first value is the index from 1 to N, the second value is +r (in distance units), the third value is the energy (in energy units), +and the fourth is the force (in force units). The r values must increase from one line to the next (unless the BITMAP parameter is specified). Note that one file can contain many sections, each with a tabulated diff --git a/doc/src/pair_tersoff.rst b/doc/src/pair_tersoff.rst index 050b1367f3..dfa35bf4bd 100644 --- a/doc/src/pair_tersoff.rst +++ b/doc/src/pair_tersoff.rst @@ -90,14 +90,14 @@ to specify the path for the potential file. As an example, imagine the SiC.tersoff file has Tersoff values for Si and C. If your LAMMPS simulation has 4 atoms types and you want the -1st 3 to be Si, and the 4th to be C, you would use the following +first 3 to be Si, and the fourth to be C, you would use the following pair_coeff command: .. code-block:: LAMMPS pair_coeff * * SiC.tersoff Si Si Si C -The 1st 2 arguments must be \* \* so as to span all LAMMPS atom types. +The first 2 arguments must be \* \* so as to span all LAMMPS atom types. The first three Si arguments map LAMMPS atom types 1,2,3 to the Si element in the Tersoff file. The final C argument maps LAMMPS atom type 4 to the C element in the Tersoff file. If a mapping value is @@ -151,12 +151,12 @@ interacting in three-body configurations. Thus for 3 elements, 27 entries would be required, etc. As annotated above, the first element in the entry is the center atom -in a three-body interaction and it is bonded to the 2nd atom and the -bond is influenced by the 3rd atom. Thus an entry for SiCC means Si +in a three-body interaction and it is bonded to the second atom and the +bond is influenced by the third atom. Thus an entry for SiCC means Si bonded to a C with another C atom influencing the bond. Thus three-body parameters for SiCSi and SiSiC entries will not, in general, be the same. The parameters used for the two-body -interaction come from the entry where the 2nd element is repeated. +interaction come from the entry where the second element is repeated. Thus the two-body parameters for Si interacting with C, comes from the SiCC entry. @@ -164,7 +164,7 @@ The parameters used for a particular three-body interaction come from the entry with the corresponding three elements. The parameters used only for two-body interactions (n, :math:`\beta`, :math:`\lambda_2`, B, :math:`\lambda_1`, and A) -in entries whose 2nd and 3rd +in entries whose second and third element are different (e.g. SiCSi) are not used for anything and can be set to 0.0 if desired. diff --git a/doc/src/pair_tersoff_mod.rst b/doc/src/pair_tersoff_mod.rst index 1761a0b9fb..7c969ad490 100644 --- a/doc/src/pair_tersoff_mod.rst +++ b/doc/src/pair_tersoff_mod.rst @@ -104,7 +104,7 @@ pair_coeff command: pair_coeff * * Si.tersoff_mod Si Si Si -The 1st 2 arguments must be \* \* so as to span all LAMMPS atom types. +The first 2 arguments must be \* \* so as to span all LAMMPS atom types. The three Si arguments map LAMMPS atom types 1,2,3 to the Si element in the Tersoff/MOD file. If a mapping value is specified as NULL, the mapping is not performed. This can be used when a *tersoff/mod* @@ -156,7 +156,7 @@ ignores those entries. For a single-element simulation, only a single entry is required (e.g. SiSiSi). As annotated above, the first element in the entry is the center atom in a three-body interaction and it is bonded to the -2nd atom and the bond is influenced by the 3rd atom. Thus an entry +second atom and the bond is influenced by the third atom. Thus an entry for SiSiSi means Si bonded to a Si with another Si atom influencing the bond. ---------- diff --git a/doc/src/pair_tersoff_zbl.rst b/doc/src/pair_tersoff_zbl.rst index 57dc3db51e..ee6c9ab508 100644 --- a/doc/src/pair_tersoff_zbl.rst +++ b/doc/src/pair_tersoff_zbl.rst @@ -99,14 +99,14 @@ to specify the path for the potential file. As an example, imagine the SiC.tersoff.zbl file has Tersoff/ZBL values for Si and C. If your LAMMPS simulation has 4 atoms types and you -want the 1st 3 to be Si, and the 4th to be C, you would use the +want the first 3 to be Si, and the fourth to be C, you would use the following pair_coeff command: .. code-block:: LAMMPS pair_coeff * * SiC.tersoff Si Si Si C -The 1st 2 arguments must be \* \* so as to span all LAMMPS atom types. +The first 2 arguments must be \* \* so as to span all LAMMPS atom types. The first three Si arguments map LAMMPS atom types 1,2,3 to the Si element in the Tersoff/ZBL file. The final C argument maps LAMMPS atom type 4 to the C element in the Tersoff/ZBL file. If a mapping @@ -167,12 +167,12 @@ interacting in three-body configurations. Thus for 3 elements, 27 entries would be required, etc. As annotated above, the first element in the entry is the center atom -in a three-body interaction and it is bonded to the 2nd atom and the -bond is influenced by the 3rd atom. Thus an entry for SiCC means Si +in a three-body interaction and it is bonded to the second atom and the +bond is influenced by the third atom. Thus an entry for SiCC means Si bonded to a C with another C atom influencing the bond. Thus three-body parameters for SiCSi and SiSiC entries will not, in general, be the same. The parameters used for the two-body -interaction come from the entry where the 2nd element is repeated. +interaction come from the entry where the second element is repeated. Thus the two-body parameters for Si interacting with C, comes from the SiCC entry. @@ -180,7 +180,7 @@ The parameters used for a particular three-body interaction come from the entry with the corresponding three elements. The parameters used only for two-body interactions (n, :math:`\beta`, :math:`\lambda_2`, B, :math:`\lambda_1`, and A) -in entries whose 2nd and 3rd +in entries whose second and third element are different (e.g. SiCSi) are not used for anything and can be set to 0.0 if desired. diff --git a/doc/src/pair_vashishta.rst b/doc/src/pair_vashishta.rst index 6fc5cfe015..19ac02872e 100644 --- a/doc/src/pair_vashishta.rst +++ b/doc/src/pair_vashishta.rst @@ -101,14 +101,14 @@ to specify the path for the potential file. As an example, imagine a file SiC.vashishta has parameters for Si and C. If your LAMMPS simulation has 4 atoms types and you want -the 1st 3 to be Si, and the 4th to be C, you would use the following +the first 3 to be Si, and the fourth to be C, you would use the following pair_coeff command: .. code-block:: LAMMPS pair_coeff * * SiC.vashishta Si Si Si C -The 1st 2 arguments must be \* \* so as to span all LAMMPS atom types. +The first 2 arguments must be \* \* so as to span all LAMMPS atom types. The first three Si arguments map LAMMPS atom types 1,2,3 to the Si element in the file. The final C argument maps LAMMPS atom type 4 to the C element in the file. If a mapping value is specified as @@ -176,14 +176,14 @@ and K are taken from the IJK entry. Note that even though three-body parameters do not depend on the order of J and K, LAMMPS stores three-body parameters for both IJK and IKJ. The user must ensure that these values are equal. Two-body parameters for an atom I interacting -with atom J are taken from the IJJ entry, where the 2nd and 3rd +with atom J are taken from the IJJ entry, where the second and third elements are the same. Thus the two-body parameters for Si interacting with C come from the SiCC entry. Note that even though two-body parameters (except possibly gamma and r0 in U3) do not depend on the order of the two elements, LAMMPS will get the Si-C value from the SiCC entry and the C-Si value from the CSiSi entry. The user must ensure that these values are equal. Two-body parameters appearing in -entries where the 2nd and 3rd elements are different are stored but +entries where the second and third elements are different are stored but never used. It is good practice to enter zero for these values. Note that the three-body function U3 above contains the two-body parameters :math:`\gamma` and :math:`r_0`. So U3 for a central C atom bonded to diff --git a/doc/src/partition.rst b/doc/src/partition.rst index be0e1152f5..418d75af86 100644 --- a/doc/src/partition.rst +++ b/doc/src/partition.rst @@ -51,7 +51,7 @@ Partitions are numbered from 1 to Np, where Np is the number of partitions specified by the :doc:`-partition command-line switch `. *N* can be specified in one of two ways. An explicit numeric value -can be used, as in the 1st example above. Or a wild-card asterisk can +can be used, as in the first example above. Or a wild-card asterisk can be used to span a range of partition numbers. This takes the form "\*" or "\*n" or "n\*" or "m\*n". An asterisk with no numeric values means all partitions from 1 to Np. A leading asterisk means all partitions diff --git a/doc/src/read_data.rst b/doc/src/read_data.rst index 79f0e08fcb..74333abecb 100644 --- a/doc/src/read_data.rst +++ b/doc/src/read_data.rst @@ -530,7 +530,7 @@ input script. ID = number of angle (1-Nangles) type = angle type (1-Nangletype) - atom1,atom2,atom3 = IDs of 1st,2nd,3rd atoms in angle + atom1,atom2,atom3 = IDs of 1st,2nd,3rd atom in angle example: @@ -673,7 +673,7 @@ not used (e.g. an atomic system with no bonds), and you don't care if unique atom IDs appear in dump files, then the atom-IDs can all be set to 0. -The molecule ID is a 2nd identifier attached to an atom. Normally, it +The molecule ID is a second identifier attached to an atom. Normally, it is a number from 1 to N, identifying which molecule the atom belongs to. It can be 0 if it is a non-bonded atom or if you don't care to keep track of molecule assignments. @@ -928,7 +928,7 @@ script. ID = bond number (1-Nbonds) type = bond type (1-Nbondtype) - atom1,atom2 = IDs of 1st,2nd atoms in bond + atom1,atom2 = IDs of 1st,2nd atom in bond * example: @@ -974,7 +974,7 @@ Coefficients can also be set via the ID = number of dihedral (1-Ndihedrals) type = dihedral type (1-Ndihedraltype) - atom1,atom2,atom3,atom4 = IDs of 1st,2nd,3rd,4th atoms in dihedral + atom1,atom2,atom3,atom4 = IDs of 1st,2nd,3rd,4th atom in dihedral * example: @@ -1075,7 +1075,7 @@ Coefficients can also be set via the ID = number of improper (1-Nimpropers) type = improper type (1-Nimpropertype) - atom1,atom2,atom3,atom4 = IDs of 1st,2nd,3rd,4th atoms in improper + atom1,atom2,atom3,atom4 = IDs of 1st,2nd,3rd,4th atom in improper * example: diff --git a/doc/src/restart.rst b/doc/src/restart.rst index fd4c1e9e24..e0958d4bb1 100644 --- a/doc/src/restart.rst +++ b/doc/src/restart.rst @@ -62,10 +62,10 @@ two wild-card characters. If a "\*" appears in the single filename, it is replaced with the current timestep value. This is only recognized when a single -filename is used (not when toggling back and forth). Thus, the 3rd +filename is used (not when toggling back and forth). Thus, the third example above creates restart files as follows: restart.1000.equil, restart.2000.equil, etc. If a single filename is used with no "\*", -then the timestep value is appended. E.g. the 2nd example above +then the timestep value is appended. E.g. the second example above creates restart files as follows: poly.restart.1000, poly.restart.2000, etc. @@ -160,7 +160,7 @@ be written, by processors 0,25,50,75. Each will collect information from itself and the next 24 processors and write it to a restart file. For the *fileper* keyword, the specified value of Np means write one -file for every Np processors. For example, if Np = 4, every 4th +file for every Np processors. For example, if Np = 4, every fourth processor (0,4,8,12,etc) will collect information from itself and the next 3 processors and write it to a restart file. diff --git a/doc/src/run.rst b/doc/src/run.rst index f36fb73187..6c47721e91 100644 --- a/doc/src/run.rst +++ b/doc/src/run.rst @@ -97,7 +97,7 @@ just a continuation of a previous run (i.e. no settings are changed), the initial computation is not necessary; the old neighbor list is still valid as are the forces. So if *pre* is specified as "no" then the initial setup is skipped, except for printing thermodynamic info. -Note that if *pre* is set to "no" for the very 1st run LAMMPS +Note that if *pre* is set to "no" for the very first run LAMMPS performs, then it is overridden, since the initial setup computations must be done. @@ -178,7 +178,7 @@ command: "print 'Press = $d'" If the *pre* and *post* options are set to "no" when used with the -*every* keyword, then the 1st run will do the full setup and the last +*every* keyword, then the first run will do the full setup and the last run will print the full timing summary, but these operations will be skipped for intermediate runs. diff --git a/doc/src/run_style.rst b/doc/src/run_style.rst index 7bddb0efcd..713fedae70 100644 --- a/doc/src/run_style.rst +++ b/doc/src/run_style.rst @@ -77,17 +77,17 @@ processors. See the :doc:`-partition command-line switch ` for info on how to run LAMMPS with multiple partitions. Specifically, this style performs all computation except the -:doc:`kspace_style ` portion of the force field on the 1st +:doc:`kspace_style ` portion of the force field on the first partition. This include the :doc:`pair style `, :doc:`bond style `, :doc:`neighbor list building `, :doc:`fixes ` including time integration, and output. The :doc:`kspace_style ` portion of the calculation is -performed on the 2nd partition. +performed on the second partition. This is most useful for the PPPM kspace_style when its performance on a large number of processors degrades due to the cost of communication in its 3d FFTs. In this scenario, splitting your P total processors -into 2 subsets of processors, P1 in the 1st partition and P2 in the -2nd partition, can enable your simulation to run faster. This is +into 2 subsets of processors, P1 in the first partition and P2 in the +second partition, can enable your simulation to run faster. This is because the long-range forces in PPPM can be calculated at the same time as pair-wise and bonded forces are being calculated, and the FFTs can actually speed up when running on fewer processors. @@ -99,8 +99,8 @@ following sense. If P1 is a Px1 by Py1 by Pz1 grid, and P2 = Px2 by Py2 by Pz2, then Px1 must be an integer multiple of Px2, and similarly for Py1 a multiple of Py2, and Pz1 a multiple of Pz2. -Typically the best way to do this is to let the 1st partition choose -its onn optimal layout, then require the 2nd partition's layout to +Typically the best way to do this is to let the first partition choose +its onn optimal layout, then require the second partition's layout to match the integer multiple constraint. See the :doc:`processors ` command with its *part* keyword for a way to control this, e.g. @@ -120,10 +120,10 @@ of 60 and 15 processors each: When you run in 2-partition mode with the *verlet/split* style, the thermodynamic data for the entire simulation will be output to the log -and screen file of the 1st partition, which are log.lammps.0 and +and screen file of the first partition, which are log.lammps.0 and screen.0 by default; see the :doc:`-plog and -pscreen command-line switches ` to change this. The log and screen file -for the 2nd partition will not contain thermodynamic output beyond the -1st timestep of the run. +for the second partition will not contain thermodynamic output beyond the +first timestep of the run. See the :doc:`Speed packages ` doc page for performance details of the speed-up offered by the *verlet/split* style. One diff --git a/doc/src/special_bonds.rst b/doc/src/special_bonds.rst index 35b870442b..779056f87a 100644 --- a/doc/src/special_bonds.rst +++ b/doc/src/special_bonds.rst @@ -92,12 +92,12 @@ pre-factor on the energy and force between the pair of atoms. A value of 1.0 means include the full interaction; a value of 0.0 means exclude it completely. -The 1st of the 3 coefficients (LJ or Coulombic) is the weighting +The first of the 3 coefficients (LJ or Coulombic) is the weighting factor on 1-2 atom pairs, which are pairs of atoms directly bonded to -each other. The 2nd coefficient is the weighting factor on 1-3 atom +each other. The second coefficient is the weighting factor on 1-3 atom pairs which are those separated by 2 bonds (e.g. the two H atoms in a -water molecule). The 3rd coefficient is the weighting factor on 1-4 -atom pairs which are those separated by 3 bonds (e.g. the 1st and 4th +water molecule). The third coefficient is the weighting factor on 1-4 +atom pairs which are those separated by 3 bonds (e.g. the first and fourth atoms in a dihedral interaction). Thus if the 1-2 coefficient is set to 0.0, then the pairwise interaction is effectively turned off for all pairs of atoms bonded to each other. If it is set to 1.0, then @@ -189,14 +189,14 @@ default, then the 2,5 interaction will also be weighted by 0.5. .. note:: LAMMPS stores and maintains a data structure with a list of the - 1st, 2nd, and 3rd neighbors of each atom (within the bond topology of + first, second, and third neighbors of each atom (within the bond topology of the system). If new bonds are created (or molecules added containing atoms with more special neighbors), the size of this list needs to - grow. Note that adding a single bond always adds a new 1st neighbor - but may also induce \*many\* new 2nd and 3rd neighbors, depending on the + grow. Note that adding a single bond always adds a new first neighbor + but may also induce \*many\* new second and third neighbors, depending on the molecular topology of your system. Using the *extra/special/per/atom* keyword to either :doc:`read_data ` or :doc:`create_box ` - reserves empty space in the list for this N additional 1st, 2nd, or 3rd + reserves empty space in the list for this N additional first, second, or third neighbors to be added. If you do not do this, you may get an error when bonds (or molecules) are added. @@ -205,7 +205,7 @@ default, then the 2,5 interaction will also be weighted by 0.5. .. note:: If you reuse this command in an input script, you should set all - the options you need each time. This command cannot be used a 2nd + the options you need each time. This command cannot be used a second time incrementally. E.g. these two commands: .. code-block:: LAMMPS @@ -219,7 +219,7 @@ are not the same as special_bonds lj 0.0 1.0 1.0 coul 0.0 0.0 1.0 -In the first case you end up with (after the 2nd command): +In the first case you end up with (after the second command): .. parsed-literal:: diff --git a/doc/src/temper.rst b/doc/src/temper.rst index bb470f0cc0..9f09a864a2 100644 --- a/doc/src/temper.rst +++ b/doc/src/temper.rst @@ -92,8 +92,8 @@ output timestep. E.g. for a simulation with 16 replicas: The column headings T0 to TN-1 mean which temperature is currently assigned to the replica 0 to N-1. Thus the columns represent replicas and the value in each column is its temperature (also numbered 0 to -N-1). For example, a 0 in the 4th column (column T3, step 2500) means -that the 4th replica is assigned temperature 0, i.e. the lowest +N-1). For example, a 0 in the fourth column (column T3, step 2500) means +that the fourth replica is assigned temperature 0, i.e. the lowest temperature. You can verify this time sequence of temperature assignments for the Nth replica by comparing the Nth column of screen output to the thermodynamic data in the corresponding log.lammps.N or diff --git a/doc/src/thermo_modify.rst b/doc/src/thermo_modify.rst index 3cec230189..fc8f66b90b 100644 --- a/doc/src/thermo_modify.rst +++ b/doc/src/thermo_modify.rst @@ -116,7 +116,7 @@ is more than one field. The *int* and *float* keywords take a single format argument and are applied to all integer or floating-point quantities output. The setting for *M string* also takes a single format argument which is used for the Mth value output in each line, -e.g. the 5th column is output in high precision for "format 5 +e.g. the fifth column is output in high precision for "format 5 %20.15g". The *format* keyword can be used multiple times. The precedence is diff --git a/doc/src/variable.rst b/doc/src/variable.rst index 0e30efc0ab..322276c93c 100644 --- a/doc/src/variable.rst +++ b/doc/src/variable.rst @@ -136,11 +136,11 @@ commands which set their value directly. variable. See below for a more detailed discussion of this feature. In the discussion that follows, the "name" of the variable is the -arbitrary string that is the 1st argument in the variable command. +arbitrary string that is the first argument in the variable command. This name can only contain alphanumeric characters and underscores. The "string" is one or more of the subsequent arguments. The "string" -can be simple text as in the 1st example above, it can contain other -variables as in the 2nd example, or it can be a formula as in the 3rd +can be simple text as in the first example above, it can contain other +variables as in the second example, or it can be a formula as in the third example. The "value" is the numeric quantity resulting from evaluation of the string. Note that the same string can generate different values when it is evaluated at different times during a @@ -249,7 +249,7 @@ in another input script command, its returned string will then be interpreted as multiple arguments in the expanded command. For the *index* style, one or more strings are specified. Initially, -the 1st string is assigned to the variable. Each time a +the first string is assigned to the variable. Each time a :doc:`next ` command is used with the variable name, the next string is assigned. All processors assign the same string to the variable. diff --git a/doc/src/write_restart.rst b/doc/src/write_restart.rst index bdb77dd4b4..46b6046a15 100644 --- a/doc/src/write_restart.rst +++ b/doc/src/write_restart.rst @@ -103,7 +103,7 @@ be written, by processors 0,25,50,75. Each will collect information from itself and the next 24 processors and write it to a restart file. For the *fileper* keyword, the specified value of Np means write one -file for every Np processors. For example, if Np = 4, every 4th +file for every Np processors. For example, if Np = 4, every fourth processor (0,4,8,12,etc) will collect information from itself and the next 3 processors and write it to a restart file.