diff --git a/doc/Manual.html b/doc/Manual.html index be6dcb19d4..49a0682286 100644 --- a/doc/Manual.html +++ b/doc/Manual.html @@ -8,7 +8,7 @@ - LAMMPS Documentation — LAMMPS 15 May 2015 version documentation + LAMMPS Documentation — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -401,7 +401,7 @@ it gives quick access to documentation for all LAMMPS commands.

- © Copyright . + © Copyright 2013 Sandia Corporation.

Built with Sphinx using a theme provided by Read the Docs. @@ -422,7 +422,7 @@ it gives quick access to documentation for all LAMMPS commands.

@@ -317,7 +317,7 @@ occurs, the faster your simulation will run.

- © Copyright . + © Copyright 2013 Sandia Corporation.

Built with Sphinx using a theme provided by Read the Docs. @@ -338,7 +338,7 @@ occurs, the faster your simulation will run. @@ -346,7 +346,7 @@ storage by a single MPI process.

- © Copyright . + © Copyright 2013 Sandia Corporation.

Built with Sphinx using a theme provided by Read the Docs. @@ -367,7 +367,7 @@ storage by a single MPI process. @@ -313,19 +313,20 @@ single, mixed).

See the Benchmark page of the LAMMPS web site for performance of the USER-INTEL package on different hardware.

-
-

Warning

-

Setting core affinity is often used to pin MPI tasks -and OpenMP threads to a core or group of cores so that memory access -can be uniform. Unless disabled at build time, affinity for MPI tasks -and OpenMP threads on the host (CPU) will be set by default on the -host when using offload to a coprocessor. In this case, it is -unnecessary to use other methods to control affinity (e.g. taskset, -numactl, I_MPI_PIN_DOMAIN, etc.). This can be disabled in an input -script with the no_affinity option to the package intel command or by disabling the option at build time -(by adding -DINTEL_OFFLOAD_NOAFFINITY to the CCFLAGS line of your -Makefile). Disabling this option is not recommended, especially when -running on a machine with hyperthreading disabled.

+
+

Note

+

Setting core affinity is often used to pin MPI tasks and OpenMP +threads to a core or group of cores so that memory access can be +uniform. Unless disabled at build time, affinity for MPI tasks and +OpenMP threads on the host (CPU) will be set by default on the host +when using offload to a coprocessor. In this case, it is unnecessary +to use other methods to control affinity (e.g. taskset, numactl, +I_MPI_PIN_DOMAIN, etc.). This can be disabled in an input script with +the no_affinity option to the package intel command +or by disabling the option at build time (by adding +-DINTEL_OFFLOAD_NOAFFINITY to the CCFLAGS line of your Makefile). +Disabling this option is not recommended, especially when running on a +machine with hyperthreading disabled.

Guidelines for best performance on an Intel(R) Xeon Phi(TM) coprocessor:

@@ -406,7 +407,7 @@ supported.

- © Copyright . + © Copyright 2013 Sandia Corporation.

Built with Sphinx using a theme provided by Read the Docs. @@ -427,7 +428,7 @@ supported.

@@ -226,12 +226,12 @@ version 6.5 or later must be installed on your system. See the discussion for the USER-CUDA and GPU packages for details of how to check and do this.

-
-

Warning

-

For good performance of the KOKKOS package on GPUs, -you must have Kepler generation GPUs (or later). The Kokkos library -exploits texture cache options not supported by Telsa generation GPUs -(or older).

+
+

Note

+

For good performance of the KOKKOS package on GPUs, you must +have Kepler generation GPUs (or later). The Kokkos library exploits +texture cache options not supported by Telsa generation GPUs (or +older).

To build with Kokkos support for Intel Xeon Phi coprocessors, your sysmte must be configured to use them in “native” mode, not “offload” @@ -272,14 +272,13 @@ make cuda KOKKOS_DEVICES=Cuda

These examples set the KOKKOS-specific OMP, MIC, CUDA variables on the make command line which requires a GNU-compatible make command. Try “gmake” if your system’s standard make complains.

-
-

Warning

-

If you build using make line variables and re-build -LAMMPS twice with different KOKKOS options and the same target, -e.g. g++ in the first two examples above, then you must perform a -“make clean-all” or “make clean-machine” before each build. This is -to force all the KOKKOS-dependent files to be re-compiled with the new -options.

+
+

Note

+

If you build using make line variables and re-build LAMMPS twice +with different KOKKOS options and the same target, e.g. g++ in the +first two examples above, then you must perform a “make clean-all” +or “make clean-machine” before each build. This is to force all the +KOKKOS-dependent files to be re-compiled with the new options.

You can also hardwire these make variables in the specified machine makefile, e.g. src/MAKE/Makefile.g++ in the first two examples above, @@ -291,23 +290,22 @@ with a line like:

different KOKKOS options (defined in different machine makefiles), you do not have to worry about doing a “clean” in between. This is because the targets will be different.

-
-

Warning

-

The 3rd example above for a GPU, uses a different -machine makefile, in this case src/MAKE/Makefile.cuda, which is -included in the LAMMPS distribution. To build the KOKKOS package for -a GPU, this makefile must use the NVIDA “nvcc” compiler. And it must -have a KOKKOS_ARCH setting that is appropriate for your NVIDIA -hardware and installed software. Typical values for KOKKOS_ARCH are given -below, as well -as other settings that must be included in the machine makefile, if -you create your own.

+
+

Note

+

The 3rd example above for a GPU, uses a different machine +makefile, in this case src/MAKE/Makefile.cuda, which is included in +the LAMMPS distribution. To build the KOKKOS package for a GPU, this +makefile must use the NVIDA “nvcc” compiler. And it must have a +KOKKOS_ARCH setting that is appropriate for your NVIDIA hardware and +installed software. Typical values for KOKKOS_ARCH are given below, +as well as other settings that must be included in the machine +makefile, if you create your own.

-
-

Warning

-

Currently, there are no precision options with the -KOKKOS package. All compilation and computation is performed in -double precision.

+
+

Note

+

Currently, there are no precision options with the KOKKOS +package. All compilation and computation is performed in double +precision.

There are other allowed options when building with the KOKKOS package. As above, they can be set either as variables on the make command line @@ -508,13 +506,13 @@ threads/task to a smaller value. This is because using all the cores on a dual-socket node will incur extra cost to copy memory from the 2nd socket to the GPU.

Examples of mpirun commands that follow these rules are shown above.

-
-

Warning

-

When using a GPU, you will achieve the best -performance if your input script does not use any fix or compute -styles which are not yet Kokkos-enabled. This allows data to stay on -the GPU for multiple timesteps, without being copied back to the host -CPU. Invoking a non-Kokkos fix or compute, or performing I/O for +

+

Note

+

When using a GPU, you will achieve the best performance if your +input script does not use any fix or compute styles which are not yet +Kokkos-enabled. This allows data to stay on the GPU for multiple +timesteps, without being copied back to the host CPU. Invoking a +non-Kokkos fix or compute, or performing I/O for thermo or dump output will cause data to be copied back to the CPU.

@@ -567,7 +565,7 @@ change in the future.

- © Copyright . + © Copyright 2013 Sandia Corporation.

Built with Sphinx using a theme provided by Read the Docs. @@ -588,7 +586,7 @@ change in the future.

@@ -260,12 +260,11 @@ when there is at least one MPI task per physical CPU chip, i.e. socket or die.
  • It is usually most efficient to restrict threading to a single socket, i.e. use one or more MPI task per socket.
  • -
  • IMPORTANT NOTE: By default, several current MPI implementations use a -processor affinity setting that restricts each MPI task to a single -CPU core. Using multi-threading in this mode will force all threads -to share the one core and thus is likely to be counterproductive. -Instead, binding MPI tasks to a (multi-core) socket, should solve this -issue.
  • +
  • NOTE: By default, several current MPI implementations use a processor +affinity setting that restricts each MPI task to a single CPU core. +Using multi-threading in this mode will force all threads to share the +one core and thus is likely to be counterproductive. Instead, binding +MPI tasks to a (multi-core) socket, should solve this issue.
  • Restrictions

    @@ -283,7 +282,7 @@ issue.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -304,7 +303,7 @@ issue. @@ -184,7 +184,7 @@ of a run. On most machines for reasonable problem sizes, it will be a

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -205,7 +205,7 @@ of a run. On most machines for reasonable problem sizes, it will be a @@ -209,7 +209,7 @@ Fischer, Gao, Guo, Ha, et al, J Phys Chem, 102, 3586 (1998).

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -230,7 +230,7 @@ Fischer, Gao, Guo, Ha, et al, J Phys Chem, 102, 3586 (1998).

    @@ -236,7 +236,7 @@ for more info on packages.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -257,7 +257,7 @@ for more info on packages.

    @@ -224,7 +224,7 @@ set, either in the input script or in a data file.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -245,7 +245,7 @@ set, either in the input script or in a data file.

    @@ -194,7 +194,7 @@ MOLECULE package (which it is by default). See the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -215,7 +215,7 @@ MOLECULE package (which it is by default). See the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/angle_cosine_delta.html b/doc/angle_cosine_delta.html index d0fb41f861..47d62f1adc 100644 --- a/doc/angle_cosine_delta.html +++ b/doc/angle_cosine_delta.html @@ -8,7 +8,7 @@ - angle_style cosine/delta command — LAMMPS 15 May 2015 version documentation + angle_style cosine/delta command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -198,7 +198,7 @@ MOLECULE package (which it is by default). See the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -219,7 +219,7 @@ MOLECULE package (which it is by default). See the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/angle_cosine_periodic.html b/doc/angle_cosine_periodic.html index 68e9112795..b8e4d2958d 100644 --- a/doc/angle_cosine_periodic.html +++ b/doc/angle_cosine_periodic.html @@ -8,7 +8,7 @@ - angle_style cosine/periodic command — LAMMPS 15 May 2015 version documentation + angle_style cosine/periodic command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -208,7 +208,7 @@ MOLECULE package (which it is by default). See the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -229,7 +229,7 @@ MOLECULE package (which it is by default). See the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/angle_cosine_shift.html b/doc/angle_cosine_shift.html index 0f7a9ae047..2baac0c781 100644 --- a/doc/angle_cosine_shift.html +++ b/doc/angle_cosine_shift.html @@ -8,7 +8,7 @@ - angle_style cosine/shift command — LAMMPS 15 May 2015 version documentation + angle_style cosine/shift command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -199,7 +199,7 @@ section for more info on packages.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with
    Sphinx using a theme provided by Read the Docs. @@ -220,7 +220,7 @@ section for more info on packages.

    @@ -210,7 +210,7 @@ section for more info on packages.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -231,7 +231,7 @@ section for more info on packages.

    @@ -198,7 +198,7 @@ MOLECULE package (which it is by default). See the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -219,7 +219,7 @@ MOLECULE package (which it is by default). See the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/angle_dipole.html b/doc/angle_dipole.html index 6c78a4e535..73d9c02cb9 100644 --- a/doc/angle_dipole.html +++ b/doc/angle_dipole.html @@ -8,7 +8,7 @@ - angle_style dipole command — LAMMPS 15 May 2015 version documentation + angle_style dipole command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -159,7 +159,7 @@ and the reference (bond) vector r_ij:

    angle.

    The torque on the dipole can be obtained by differentiating the potential using the ‘chain rule’ as in appendix C.3 of -(Allen):

    +(Allen):

    _images/angle_dipole_torque.jpg

    Example: if gamma0 is set to 0 degrees, the torque generated by the potential will tend to align the dipole along the reference @@ -200,16 +200,16 @@ more instructions on how to use the accelerated styles effectively.

    This angle style can only be used if LAMMPS was built with the USER-MISC package. See the Making LAMMPS section for more info on packages.

    -
    -

    Warning

    -

    In the “Angles” section of the data file, the atom ID -‘j’ corresponding to the dipole to restrain must come before the atom -ID of the reference atom ‘i’. A third atom ID ‘k’ must also be -provided, although ‘k’ is just a ‘dummy’ atom which can be any atom; -it may be useful to choose a convention (e.g., ‘k’=’i’) and adhere to -it. For example, if ID=1 for the dipolar atom to restrain, and ID=2 -for the reference atom, the corresponding line in the “Angles” section -of the data file would read: X X 1 2 2

    +
    +

    Note

    +

    In the “Angles” section of the data file, the atom ID ‘j’ +corresponding to the dipole to restrain must come before the atom ID +of the reference atom ‘i’. A third atom ID ‘k’ must also be provided, +although ‘k’ is just a ‘dummy’ atom which can be any atom; it may be +useful to choose a convention (e.g., ‘k’=’i’) and adhere to it. For +example, if ID=1 for the dipolar atom to restrain, and ID=2 for the +reference atom, the corresponding line in the “Angles” section of the +data file would read: X X 1 2 2

    The “newton” command for intramolecular interactions must be “on” (which is the default).

    @@ -237,7 +237,7 @@ Clarendon Press, Oxford, 1987.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -258,7 +258,7 @@ Clarendon Press, Oxford, 1987.

    @@ -195,7 +195,7 @@ section for more info on packages.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -216,7 +216,7 @@ section for more info on packages.

    @@ -194,7 +194,7 @@ section for more info on packages.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -215,7 +215,7 @@ section for more info on packages.

    @@ -203,7 +203,7 @@ MOLECULE package (which it is by default). See the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -224,7 +224,7 @@ MOLECULE package (which it is by default). See the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/angle_hybrid.html b/doc/angle_hybrid.html index 9be62c9f1a..65941e35fd 100644 --- a/doc/angle_hybrid.html +++ b/doc/angle_hybrid.html @@ -8,7 +8,7 @@ - angle_style hybrid command — LAMMPS 15 May 2015 version documentation + angle_style hybrid command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -219,7 +219,7 @@ file, you need to re-specify angle_coeff commands.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with
    Sphinx using a theme provided by Read the Docs. @@ -240,7 +240,7 @@ file, you need to re-specify angle_coeff commands.

    @@ -163,7 +163,7 @@ if triplets of angle atoms were listed in the data file read by the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -184,7 +184,7 @@ if triplets of angle atoms were listed in the data file read by the @@ -201,7 +201,7 @@ section for more info on packages.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -222,7 +222,7 @@ section for more info on packages.

    @@ -187,7 +187,7 @@ USER-CG-CMM package. See the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -208,7 +208,7 @@ USER-CG-CMM package. See the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/angle_style.html b/doc/angle_style.html index 9f3c84bce2..5229551548 100644 --- a/doc/angle_style.html +++ b/doc/angle_style.html @@ -8,7 +8,7 @@ - angle_style command — LAMMPS 15 May 2015 version documentation + angle_style command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -161,8 +161,8 @@ restarts a simulation. See the -

    Warning

    +
    +

    Note

    When both an angle and pair style is defined, the special_bonds command often needs to be used to turn off (or weight) the pairwise interaction that would otherwise @@ -222,7 +222,7 @@ package.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -243,7 +243,7 @@ package.

    @@ -272,7 +272,7 @@ MOLECULE package (which it is by default). See the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -293,7 +293,7 @@ MOLECULE package (which it is by default). See the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/atom_modify.html b/doc/atom_modify.html index 38d7bec37d..6c9f4fbf40 100644 --- a/doc/atom_modify.html +++ b/doc/atom_modify.html @@ -8,7 +8,7 @@ - atom_modify command — LAMMPS 15 May 2015 version documentation + atom_modify command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -244,10 +244,10 @@ pairwise intereractions and neighbor lists are computed. Note that if bins are too small, there will be few atoms/bin. Likewise if bins are too large, there will be many atoms/bin. In both cases, the goal of cache locality will be undermined.

    -
    -

    Warning

    -

    Running a simulation with sorting on versus off should -not change the simulation results in a statistical sense. However, a +

    +

    Note

    +

    Running a simulation with sorting on versus off should not +change the simulation results in a statistical sense. However, a different ordering will induce round-off differences, which will lead to diverging trajectories over time when comparing two simluations. Various commands, particularly those which use random numbers @@ -288,7 +288,7 @@ cutoff will be used to set the bin size.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with
    Sphinx using a theme provided by Read the Docs. @@ -309,7 +309,7 @@ cutoff will be used to set the bin size.

    @@ -263,10 +263,10 @@ quantities.

    -
    -

    Warning

    -

    It is possible to add some attributes, such as a -molecule ID, to atom styles that do not have them via the fix property/atom command. This command also +

    +

    Note

    +

    It is possible to add some attributes, such as a molecule ID, to +atom styles that do not have them via the fix property/atom command. This command also allows new custom attributes consisting of extra integer or floating-point values to be added to atoms. See the fix property/atom doc page for examples of cases where this is useful and details on how to initialize, access, and @@ -325,8 +325,8 @@ can save memory for systems comprised of a large number of small molecules, all of a single type (or small number of types). See the paper by Grime and Voth, in (Grime), for examples of how this can be advantageous for large-scale coarse-grained systems.

    -
    -

    Warning

    +
    +

    Note

    When using the template style with a molecule template that contains multiple molecules, you should insure the atom types, bond types, angle_types, etc in all the molecules are consistent. E.g. if one molecule represents H2O and @@ -427,7 +427,7 @@ only enabled if LAMMPS was built with that package. See the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -448,7 +448,7 @@ only enabled if LAMMPS was built with that package. See the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/atom_style.txt b/doc/atom_style.txt index 78e8232409..159a72b860 100644 --- a/doc/atom_style.txt +++ b/doc/atom_style.txt @@ -83,8 +83,8 @@ quantities. {tri} | corner points, angular momentum | rigid bodies | {wavepacket} | charge, spin, eradius, etag, cs_re, cs_im | AWPMD :tb(c=3,s=|) -IMPORTANT NOTE: It is possible to add some attributes, such as a -molecule ID, to atom styles that do not have them via the "fix +NOTE: It is possible to add some attributes, such as a molecule ID, to +atom styles that do not have them via the "fix property/atom"_fix_property_atom.html command. This command also allows new custom attributes consisting of extra integer or floating-point values to be added to atoms. See the "fix @@ -158,7 +158,7 @@ molecules, all of a single type (or small number of types). See the paper by Grime and Voth, in "(Grime)"_#Grime, for examples of how this can be advantageous for large-scale coarse-grained systems. -IMPORTANT NOTE: When using the {template} style with a "molecule +NOTE: When using the {template} style with a "molecule template"_molecule.html that contains multiple molecules, you should insure the atom types, bond types, angle_types, etc in all the molecules are consistent. E.g. if one molecule represents H2O and diff --git a/doc/balance.html b/doc/balance.html index 7fcca6c696..5236103bad 100644 --- a/doc/balance.html +++ b/doc/balance.html @@ -8,7 +8,7 @@ - balance command — LAMMPS 15 May 2015 version documentation + balance command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -210,14 +210,15 @@ most heavily loaded processor has 1200 particles, then the factor is 1.2, meaning there is a 20% imbalance. Note that a re-balance can be forced even if the current balance is perfect (1.0) be specifying a thresh < 1.0.

    -
    -

    Warning

    -

    Balancing is performed even if the imbalance factor -does not exceed the thresh parameter if a “grid” style is specified -when the current partitioning is “tiled”. The meaning of “grid” vs -“tiled” is explained below. This is to allow forcing of the -partitioning to “grid” so that the comm_style brick -command can then be used to replace a current comm_style tiled setting.

    +
    +

    Note

    +

    Balancing is performed even if the imbalance factor does not +exceed the thresh parameter if a “grid” style is specified when the +current partitioning is “tiled”. The meaning of “grid” vs “tiled” is +explained below. This is to allow forcing of the partitioning to +“grid” so that the comm_style brick command can then +be used to replace a current comm_style tiled +setting.

    When the balance command completes, it prints statistics about the result, including the change in the imbalance factor and the change in @@ -225,32 +226,30 @@ the maximum number of particles on any processor. For “grid” method (defined below) that create a logical 3d grid of processors, the positions of all cutting planes in each of the 3 dimensions (as fractions of the box length) are also printed.

    -
    -

    Warning

    -

    This command attempts to minimize the imbalance -factor, as defined above. But depending on the method a perfect -balance (1.0) may not be achieved. For example, “grid” methods -(defined below) that create a logical 3d grid cannot achieve perfect -balance for many irregular distributions of particles. Likewise, if a -portion of the system is a perfect lattice, e.g. the intiial system is -generated by the create_atoms command, then “grid” -methods may be unable to achieve exact balance. This is because -entire lattice planes will be owned or not owned by a single -processor.

    +
    +

    Note

    +

    This command attempts to minimize the imbalance factor, as +defined above. But depending on the method a perfect balance (1.0) +may not be achieved. For example, “grid” methods (defined below) that +create a logical 3d grid cannot achieve perfect balance for many +irregular distributions of particles. Likewise, if a portion of the +system is a perfect lattice, e.g. the intiial system is generated by +the create_atoms command, then “grid” methods may +be unable to achieve exact balance. This is because entire lattice +planes will be owned or not owned by a single processor.

    -
    -

    Warning

    -

    The imbalance factor is also an estimate of the -maximum speed-up you can hope to achieve by running a perfectly -balanced simulation versus an imbalanced one. In the example above, -the 10000 particle simulation could run up to 20% faster if it were -perfectly balanced, versus when imbalanced. However, computational -cost is not strictly proportional to particle count, and changing the -relative size and shape of processor sub-domains may lead to -additional computational and communication overheads, e.g. in the PPPM -solver used via the kspace_style command. Thus -you should benchmark the run times of a simulation before and after -balancing.

    +
    +

    Note

    +

    The imbalance factor is also an estimate of the maximum speed-up +you can hope to achieve by running a perfectly balanced simulation +versus an imbalanced one. In the example above, the 10000 particle +simulation could run up to 20% faster if it were perfectly balanced, +versus when imbalanced. However, computational cost is not strictly +proportional to particle count, and changing the relative size and +shape of processor sub-domains may lead to additional computational +and communication overheads, e.g. in the PPPM solver used via the +kspace_style command. Thus you should benchmark +the run times of a simulation before and after balancing.


    The method used to perform a load balance is specified by one of the @@ -374,16 +373,16 @@ plane gets closer to the target value.

    Once the rebalancing is complete and final processor sub-domains assigned, particles are migrated to their new owning processor, and the balance procedure ends.

    -
    -

    Warning

    -

    At each rebalance operation, the bisectioning for each -cutting plane (line in 2d) typcially starts with low and high bounds -separated by the extent of a processor’s sub-domain in one dimension. -The size of this bracketing region shrinks by 1/2 every iteration. -Thus if Niter is specified as 10, the cutting plane will typically -be positioned to 1 part in 1000 accuracy (relative to the perfect -target position). For Niter = 20, it will be accurate to 1 part in -a million. Thus there is no need ot set Niter to a large value. +

    +

    Note

    +

    At each rebalance operation, the bisectioning for each cutting +plane (line in 2d) typcially starts with low and high bounds separated +by the extent of a processor’s sub-domain in one dimension. The size +of this bracketing region shrinks by 1/2 every iteration. Thus if +Niter is specified as 10, the cutting plane will typically be +positioned to 1 part in 1000 accuracy (relative to the perfect target +position). For Niter = 20, it will be accurate to 1 part in a +million. Thus there is no need ot set Niter to a large value. LAMMPS will check if the threshold accuracy is reached (in a dimension) is less iterations than Niter and exit early. However, Niter should also not be set too small, since it will take roughly @@ -488,7 +487,7 @@ appear in dimstr for the shift style.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -509,7 +508,7 @@ appear in dimstr for the shift style.

    @@ -282,7 +282,7 @@ current COM and orientiation of the body particle.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -303,7 +303,7 @@ current COM and orientiation of the body particle.

    @@ -201,7 +201,7 @@ for more info on packages.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -222,7 +222,7 @@ for more info on packages.

    @@ -221,7 +221,7 @@ either in the input script or in a data file.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -242,7 +242,7 @@ either in the input script or in a data file.

    @@ -209,7 +209,7 @@ style. LAMMPS will issue a warning it that’s not the case.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -230,7 +230,7 @@ style. LAMMPS will issue a warning it that’s not the case.

    @@ -210,7 +210,7 @@ style. LAMMPS will issue a warning it that’s not the case.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -231,7 +231,7 @@ style. LAMMPS will issue a warning it that’s not the case.

    @@ -199,7 +199,7 @@ MOLECULE package (which it is by default). See the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -220,7 +220,7 @@ MOLECULE package (which it is by default). See the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/bond_harmonic_shift.html b/doc/bond_harmonic_shift.html index 5630efe1fa..e367ec0f3a 100644 --- a/doc/bond_harmonic_shift.html +++ b/doc/bond_harmonic_shift.html @@ -8,7 +8,7 @@ - bond_style harmonic/shift command — LAMMPS 15 May 2015 version documentation + bond_style harmonic/shift command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -201,7 +201,7 @@ section for more info on packages.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with
    Sphinx using a theme provided by Read the Docs. @@ -222,7 +222,7 @@ section for more info on packages.

    @@ -202,7 +202,7 @@ section for more info on packages.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -223,7 +223,7 @@ section for more info on packages.

    @@ -202,7 +202,7 @@ file, you need to re-specify bond_coeff commands.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -223,7 +223,7 @@ file, you need to re-specify bond_coeff commands.

    @@ -197,7 +197,7 @@ MOLECULE package (which it is by default). See the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -218,7 +218,7 @@ MOLECULE package (which it is by default). See the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/bond_none.html b/doc/bond_none.html index dcfad5e8bd..7d40b13a35 100644 --- a/doc/bond_none.html +++ b/doc/bond_none.html @@ -8,7 +8,7 @@ - bond_style none command — LAMMPS 15 May 2015 version documentation + bond_style none command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -163,7 +163,7 @@ pairs of bonded atoms were listed in the data file read by the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with
    Sphinx using a theme provided by Read the Docs. @@ -184,7 +184,7 @@ pairs of bonded atoms were listed in the data file read by the @@ -199,7 +199,7 @@ MOLECULE package (which it is by default). See the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -220,7 +220,7 @@ MOLECULE package (which it is by default). See the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/bond_quartic.html b/doc/bond_quartic.html index e744669cb6..eb743b48fb 100644 --- a/doc/bond_quartic.html +++ b/doc/bond_quartic.html @@ -8,7 +8,7 @@ - bond_style quartic command — LAMMPS 15 May 2015 version documentation + bond_style quartic command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -231,7 +231,7 @@ dihedral, etc) cannot be used with quartic bonds.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with
    Sphinx using a theme provided by Read the Docs. @@ -252,7 +252,7 @@ dihedral, etc) cannot be used with quartic bonds.

    @@ -171,8 +171,8 @@ simulation. See the details on how to do this. The one exception is that bond_style hybrid only stores the list of sub-styles in the restart file; bond coefficients need to be re-specified.

    -
    -

    Warning

    +
    +

    Note

    When both a bond and pair style is defined, the special_bonds command often needs to be used to turn off (or weight) the pairwise interaction that would otherwise @@ -230,7 +230,7 @@ package.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -251,7 +251,7 @@ package.

    @@ -269,7 +269,7 @@ MOLECULE package (which it is by default). See the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -290,7 +290,7 @@ MOLECULE package (which it is by default). See the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/boundary.html b/doc/boundary.html index e88643e33a..cf77d17d50 100644 --- a/doc/boundary.html +++ b/doc/boundary.html @@ -8,7 +8,7 @@ - boundary command — LAMMPS 15 May 2015 version documentation + boundary command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -227,7 +227,7 @@ of lost atoms.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with
    Sphinx using a theme provided by Read the Docs. @@ -248,7 +248,7 @@ of lost atoms.

    @@ -191,7 +191,7 @@ error.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -212,7 +212,7 @@ error.

    @@ -214,13 +214,16 @@ current one.

    conditions are invoked (see the boundary command) which may change simulation box boundaries, and atoms are migrated to new owning processors.

    -

    IMPORTANT_NOTE: This means that you cannot use the change_box command +

    +

    Note

    +

    This means that you cannot use the change_box command to enlarge a shrink-wrapped box, e.g. to make room to insert more atoms via the create_atoms command, because the simulation box will be re-shrink-wrapped before the change_box command completes. Instead you could do something like this, assuming the simulation box is non-periodic and atoms extend from 0 to 20 in all dimensions:

    +
    change_box all x final -10 20
     create_atoms 1 single -5 5 5   # this will fail to insert an atom
     
    @@ -230,45 +233,45 @@ create_atoms 1 single -5 5 5 change_box boundary s s s # this will work
    -
    -

    Warning

    -

    Unlike the earlier “displace_box” version of this -command, atom remapping is NOT performed by default. This command -allows remapping to be done in a more general way, exactly when you -specify it (zero or more times) in the sequence of transformations. -Thus if you do not use the remap keyword, atom coordinates will not -be changed even if the box size/shape changes. If a uniformly -strained state is desired, the remap keyword should be specified.

    +
    +

    Note

    +

    Unlike the earlier “displace_box” version of this command, atom +remapping is NOT performed by default. This command allows remapping +to be done in a more general way, exactly when you specify it (zero or +more times) in the sequence of transformations. Thus if you do not +use the remap keyword, atom coordinates will not be changed even if +the box size/shape changes. If a uniformly strained state is desired, +the remap keyword should be specified.

    -
    -

    Warning

    -

    It is possible to lose atoms with this command. -E.g. by changing the box without remapping the atoms, and having atoms -end up outside of non-periodic boundaries. It is also possible to -alter bonds between atoms straddling a boundary in bad ways. E.g. by +

    +

    Note

    +

    It is possible to lose atoms with this command. E.g. by +changing the box without remapping the atoms, and having atoms end up +outside of non-periodic boundaries. It is also possible to alter +bonds between atoms straddling a boundary in bad ways. E.g. by converting a boundary from periodic to non-periodic. It is also possible when remapping atoms to put them (nearly) on top of each other. E.g. by converting a boundary from non-periodic to periodic. All of these will typically lead to bad dynamics and/or generate error messages.

    -
    -

    Warning

    -

    The simulation box size/shape can be changed by -arbitrarily large amounts by this command. This is not a problem, -except that the mapping of processors to the simulation box is not -changed from its initial 3d configuration; see the -processors command. Thus, if the box size/shape -changes dramatically, the mapping of processors to the simulation box -may not end up as optimal as the initial mapping attempted to be.

    +
    +

    Note

    +

    The simulation box size/shape can be changed by arbitrarily +large amounts by this command. This is not a problem, except that the +mapping of processors to the simulation box is not changed from its +initial 3d configuration; see the processors +command. Thus, if the box size/shape changes dramatically, the +mapping of processors to the simulation box may not end up as optimal +as the initial mapping attempted to be.

    -
    -

    Warning

    -

    Because the keywords used in this command are applied -one at a time to the simulation box and the atoms in it, care must be -taken with triclinic cells to avoid exceeding the limits on skew after -each transformation in the sequence. If skew is exceeded before the -final transformation this can be avoided by changing the order of the +

    +

    Note

    +

    Because the keywords used in this command are applied one at a +time to the simulation box and the atoms in it, care must be taken +with triclinic cells to avoid exceeding the limits on skew after each +transformation in the sequence. If skew is exceeded before the final +transformation this can be avoided by changing the order of the sequence, or breaking the transformation into two or more smaller transformations. For more information on the allowed limits for box skew see the discussion on triclinic boxes on this page.

    @@ -317,10 +320,10 @@ keep the volume constant:

    change_box all x scale 1.1 z volume y scale 1.1 z volume
     
    -
    -

    Warning

    -

    For solids or liquids, when one dimension of the box -is expanded, it may be physically undesirable to hold the other 2 box +

    +

    Note

    +

    For solids or liquids, when one dimension of the box is +expanded, it may be physically undesirable to hold the other 2 box lengths constant since that implies a density change. For solids, adjusting the other dimensions via the volume style may make physical sense (just as for a liquid), but may not be correct for @@ -443,7 +446,7 @@ change_box command is issued, so long as an

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -464,7 +467,7 @@ change_box command is issued, so long as an var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/change_box.txt b/doc/change_box.txt index 54337fb167..7c37a236f6 100644 --- a/doc/change_box.txt +++ b/doc/change_box.txt @@ -93,7 +93,7 @@ conditions are invoked (see the "boundary"_boundary.html command) which may change simulation box boundaries, and atoms are migrated to new owning processors. -IMPORTANT_NOTE: This means that you cannot use the change_box command +NOTE: This means that you cannot use the change_box command to enlarge a shrink-wrapped box, e.g. to make room to insert more atoms via the "create_atoms"_create_atoms.html command, because the simulation box will be re-shrink-wrapped before the change_box command @@ -108,37 +108,37 @@ change_box all x final -10 20 boundary f s s create_atoms 1 single -5 5 5 change_box boundary s s s # this will work :pre -IMPORTANT NOTE: Unlike the earlier "displace_box" version of this -command, atom remapping is NOT performed by default. This command -allows remapping to be done in a more general way, exactly when you -specify it (zero or more times) in the sequence of transformations. -Thus if you do not use the {remap} keyword, atom coordinates will not -be changed even if the box size/shape changes. If a uniformly -strained state is desired, the {remap} keyword should be specified. +NOTE: Unlike the earlier "displace_box" version of this command, atom +remapping is NOT performed by default. This command allows remapping +to be done in a more general way, exactly when you specify it (zero or +more times) in the sequence of transformations. Thus if you do not +use the {remap} keyword, atom coordinates will not be changed even if +the box size/shape changes. If a uniformly strained state is desired, +the {remap} keyword should be specified. -IMPORTANT NOTE: It is possible to lose atoms with this command. -E.g. by changing the box without remapping the atoms, and having atoms -end up outside of non-periodic boundaries. It is also possible to -alter bonds between atoms straddling a boundary in bad ways. E.g. by +NOTE: It is possible to lose atoms with this command. E.g. by +changing the box without remapping the atoms, and having atoms end up +outside of non-periodic boundaries. It is also possible to alter +bonds between atoms straddling a boundary in bad ways. E.g. by converting a boundary from periodic to non-periodic. It is also possible when remapping atoms to put them (nearly) on top of each other. E.g. by converting a boundary from non-periodic to periodic. All of these will typically lead to bad dynamics and/or generate error messages. -IMPORTANT NOTE: The simulation box size/shape can be changed by -arbitrarily large amounts by this command. This is not a problem, -except that the mapping of processors to the simulation box is not -changed from its initial 3d configuration; see the -"processors"_processors.html command. Thus, if the box size/shape -changes dramatically, the mapping of processors to the simulation box -may not end up as optimal as the initial mapping attempted to be. +NOTE: The simulation box size/shape can be changed by arbitrarily +large amounts by this command. This is not a problem, except that the +mapping of processors to the simulation box is not changed from its +initial 3d configuration; see the "processors"_processors.html +command. Thus, if the box size/shape changes dramatically, the +mapping of processors to the simulation box may not end up as optimal +as the initial mapping attempted to be. -IMPORTANT NOTE: Because the keywords used in this command are applied -one at a time to the simulation box and the atoms in it, care must be -taken with triclinic cells to avoid exceeding the limits on skew after -each transformation in the sequence. If skew is exceeded before the -final transformation this can be avoided by changing the order of the +NOTE: Because the keywords used in this command are applied one at a +time to the simulation box and the atoms in it, care must be taken +with triclinic cells to avoid exceeding the limits on skew after each +transformation in the sequence. If skew is exceeded before the final +transformation this can be avoided by changing the order of the sequence, or breaking the transformation into two or more smaller transformations. For more information on the allowed limits for box skew see the discussion on triclinic boxes on "this @@ -194,8 +194,8 @@ keep the volume constant: change_box all x scale 1.1 z volume y scale 1.1 z volume :pre -IMPORTANT NOTE: For solids or liquids, when one dimension of the box -is expanded, it may be physically undesirable to hold the other 2 box +NOTE: For solids or liquids, when one dimension of the box is +expanded, it may be physically undesirable to hold the other 2 box lengths constant since that implies a density change. For solids, adjusting the other dimensions via the {volume} style may make physical sense (just as for a liquid), but may not be correct for diff --git a/doc/clear.html b/doc/clear.html index dfe9413515..292456800a 100644 --- a/doc/clear.html +++ b/doc/clear.html @@ -8,7 +8,7 @@ - clear command — LAMMPS 15 May 2015 version documentation + clear command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -171,7 +171,7 @@ input script variables (v

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with
    Sphinx using a theme provided by Read the Docs. @@ -192,7 +192,7 @@ input script variables (v @@ -162,14 +162,14 @@ comm_modify cutoff/multi * 0.0 communication of atom information that occurs each timestep as coordinates and other properties are exchanged between neighboring processors and stored as properties of ghost atoms.

    -
    -

    Warning

    -

    These options apply to the currently defined comm -style. When you specify a comm_style command, all -communication settings are restored to their default values, including -those previously reset by a comm_modify command. Thus if your input -script specifies a comm_style command, you should use the comm_modify -command after it.

    +
    +

    Note

    +

    These options apply to the currently defined comm style. When +you specify a comm_style command, all communication +settings are restored to their default values, including those +previously reset by a comm_modify command. Thus if your input script +specifies a comm_style command, you should use the comm_modify command +after it.

    The mode keyword determines whether a single or multiple cutoff distances are used to determine which atoms to communicate.

    @@ -228,14 +228,14 @@ atoms beyond the normal pairwise cutoff for some computation it performs (e.g. locate neighbors of ghost atoms in a multibody pair potential). Setting the ghost cutoff appropriately can insure it will find the needed atoms.

    -
    -

    Warning

    -

    In these scenarios, if you do not set the ghost cutoff -long enough, and if there is only one processor in a periodic -dimension (e.g. you are running in serial), then LAMMPS may “find” the -atom it is looking for (e.g. the partner atom in a bond), that is on -the far side of the simulation box, across a periodic boundary. This -will typically lead to bad dynamics (i.e. the bond length is now the +

    +

    Note

    +

    In these scenarios, if you do not set the ghost cutoff long +enough, and if there is only one processor in a periodic dimension +(e.g. you are running in serial), then LAMMPS may “find” the atom it +is looking for (e.g. the partner atom in a bond), that is on the far +side of the simulation box, across a periodic boundary. This will +typically lead to bad dynamics (i.e. the bond length is now the simulation box length). To detect if this is happening, see the neigh_modify cluster command.

    @@ -286,7 +286,7 @@ cutoff = pairwise force cutoff + neighbor skin.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -307,7 +307,7 @@ cutoff = pairwise force cutoff + neighbor skin.

    @@ -196,7 +196,7 @@ commands. The decomposition can be changed via the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -217,7 +217,7 @@ commands. The decomposition can be changed via the @@ -374,7 +374,7 @@ section of

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -395,7 +395,7 @@ section of var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/compute_ackland_atom.html b/doc/compute_ackland_atom.html index d128227c11..5cf6eb6c9e 100644 --- a/doc/compute_ackland_atom.html +++ b/doc/compute_ackland_atom.html @@ -8,7 +8,7 @@ - compute ackland/atom command — LAMMPS 15 May 2015 version documentation + compute ackland/atom command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -197,7 +197,7 @@ integers defined above.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with
    Sphinx using a theme provided by Read the Docs. @@ -218,7 +218,7 @@ integers defined above.

    @@ -205,7 +205,7 @@ be in energy units.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -226,7 +226,7 @@ be in energy units. @@ -165,14 +165,14 @@ in that group, signifying they are not assigned to a chunk, and will thus also not contribute to this calculation. You can specify the “all” group for this command if you simply want to include atoms with non-zero chunk IDs.

    -
    -

    Warning

    -

    The coordinates of an atom contribute to the chunk’s -angular momentum in “unwrapped” form, by using the image flags -associated with each atom. See the dump custom command -for a discussion of “unwrapped” coordinates. See the Atoms section of -the read_data command for a discussion of image flags -and how they are set for each atom. You can reset the image flags +

    +

    Note

    +

    The coordinates of an atom contribute to the chunk’s angular +momentum in “unwrapped” form, by using the image flags associated with +each atom. See the dump custom command for a discussion +of “unwrapped” coordinates. See the Atoms section of the +read_data command for a discussion of image flags and +how they are set for each atom. You can reset the image flags (e.g. to 0) before invoking this compute by using the set image command.

    The simplest way to output the results of the compute angmom/chunk @@ -215,7 +215,7 @@ mass-velocity-distance units

    Built with Sphinx using a theme provided by Read the Docs. @@ -236,7 +236,7 @@ mass-velocity-distance units @@ -195,7 +195,7 @@ well-defined basal plane.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with
    Sphinx using a theme provided by Read the Docs. @@ -216,7 +216,7 @@ well-defined basal plane.

    @@ -217,7 +217,7 @@ options.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -238,7 +238,7 @@ options.

    @@ -213,7 +213,7 @@ output for eng will be in energy

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -234,7 +234,7 @@ output for eng will be in energy var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/compute_centro_atom.html b/doc/compute_centro_atom.html index e43de7e11d..edf16f03c2 100644 --- a/doc/compute_centro_atom.html +++ b/doc/compute_centro_atom.html @@ -8,7 +8,7 @@ - compute centro/atom command — LAMMPS 15 May 2015 version documentation + compute centro/atom command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -242,7 +242,7 @@ of 12.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with
    Sphinx using a theme provided by Read the Docs. @@ -263,7 +263,7 @@ of 12.

    @@ -438,13 +438,14 @@ the first step of the time window will persist until the end of the time window.

    If the setting is every, which is the default, then chunk IDs are re-calculated on any timestep this compute is invoked.

    -
    -

    Warning

    -

    If you want the persistent chunk-IDs calculated by -this compute to be continuous when running from a restart file, then you should use the same ID for this -compute, as in the original run. This is so that the fix this compute -creates to store per-atom quantities will also have the same ID, and -thus be initialized correctly with chunk IDs from the restart file.

    +
    +

    Note

    +

    If you want the persistent chunk-IDs calculated by this compute +to be continuous when running from a restart file, +then you should use the same ID for this compute, as in the original +run. This is so that the fix this compute creates to store per-atom +quantities will also have the same ID, and thus be initialized +correctly with chunk IDs from the restart file.


    The compress keyword applies to all chunk styles and affects how @@ -480,19 +481,19 @@ renumbered to (1,2,3,4,5). The original values (27,...,1000000) can be output to a file by the fix ave/chunk command, or by using the fix ave/time command in conjunction with the compute property/chunk command.

    -
    -

    Warning

    -

    The compression operation requires global -communication across all processors to share their chunk ID values. -It can require large memory on every processor to store them, even -after they are compressed, if there are are a large number of unique -chunk IDs with atoms assigned to them. It uses a STL map to find -unique chunk IDs and store them in sorted order. Each time an atom is -assigned a compressed chunk ID, it must access the STL map. All of -this means that compression can be expensive, both in memory and CPU -time. The use of the limit keyword in conjunction with the -compress keyword can affect these costs, depending on which keyword -is used first. So use this option with care.

    +
    +

    Note

    +

    The compression operation requires global communication across +all processors to share their chunk ID values. It can require large +memory on every processor to store them, even after they are +compressed, if there are are a large number of unique chunk IDs with +atoms assigned to them. It uses a STL map to find unique chunk IDs +and store them in sorted order. Each time an atom is assigned a +compressed chunk ID, it must access the STL map. All of this means +that compression can be expensive, both in memory and CPU time. The +use of the limit keyword in conjunction with the compress keyword +can affect these costs, depending on which keyword is used first. So +use this option with care.


    The discard keyword applies to all chunk styles. It affects what @@ -613,7 +614,7 @@ the restarted simulation begins.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -634,7 +635,7 @@ the restarted simulation begins.

    @@ -158,8 +158,8 @@ time the calculation is performed (i.e. each time a snapshot of atoms is dumped). Thus it can be inefficient to compute/dump this quantity too frequently or to have multiple compute/dump commands, each of a clsuter/atom style.

    -
    -

    Warning

    +
    +

    Note

    If you have a bonded system, then the settings of special_bonds command can remove pairwise interactions between atoms in the same bond, angle, or dihedral. This @@ -205,7 +205,7 @@ LAMMPS output options.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -226,7 +226,7 @@ LAMMPS output options.

    @@ -217,7 +217,7 @@ above.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -238,7 +238,7 @@ above.

    @@ -149,14 +149,14 @@ of atoms, including all effects due to atoms passing thru periodic boundaries.

    A vector of three quantites is calculated by this compute, which are the x,y,z coordinates of the center of mass.

    -
    -

    Warning

    -

    The coordinates of an atom contribute to the -center-of-mass in “unwrapped” form, by using the image flags -associated with each atom. See the dump custom command -for a discussion of “unwrapped” coordinates. See the Atoms section of -the read_data command for a discussion of image flags -and how they are set for each atom. You can reset the image flags +

    +

    Note

    +

    The coordinates of an atom contribute to the center-of-mass in +“unwrapped” form, by using the image flags associated with each atom. +See the dump custom command for a discussion of +“unwrapped” coordinates. See the Atoms section of the +read_data command for a discussion of image flags and +how they are set for each atom. You can reset the image flags (e.g. to 0) before invoking this compute by using the set image command.

    Output info:

    @@ -189,7 +189,7 @@ distance units.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -210,7 +210,7 @@ distance units.

    @@ -163,8 +163,8 @@ in that group, signifying they are not assigned to a chunk, and will thus also not contribute to this calculation. You can specify the “all” group for this command if you simply want to include atoms with non-zero chunk IDs.

    -
    -

    Warning

    +
    +

    Note

    The coordinates of an atom contribute to the chunk’s center-of-mass in “unwrapped” form, by using the image flags associated with each atom. See the dump custom command @@ -213,7 +213,7 @@ distance units.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -234,7 +234,7 @@ distance units.

    @@ -182,7 +182,7 @@ above.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -203,7 +203,7 @@ above.

    @@ -174,8 +174,8 @@ specified compute group.

    time the calculation is performed (i.e. each time a snapshot of atoms is dumped). Thus it can be inefficient to compute/dump this quantity too frequently.

    -
    -

    Warning

    +
    +

    Note

    If you have a bonded system, then the settings of special_bonds command can remove pairwise interactions between atoms in the same bond, angle, or dihedral. This @@ -221,7 +221,7 @@ explained above.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -242,7 +242,7 @@ explained above.

    @@ -185,7 +185,7 @@ LAMMPS was built with that package. See the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -206,7 +206,7 @@ LAMMPS was built with that package. See the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/compute_dihedral_local.html b/doc/compute_dihedral_local.html index 28d559e7a2..8d4f85f088 100644 --- a/doc/compute_dihedral_local.html +++ b/doc/compute_dihedral_local.html @@ -8,7 +8,7 @@ - compute dihedral/local command — LAMMPS 15 May 2015 version documentation + compute dihedral/local command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -198,7 +198,7 @@ options.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with
    Sphinx using a theme provided by Read the Docs. @@ -219,7 +219,7 @@ options.

    @@ -187,7 +187,7 @@ LAMMPS was built with that package. See the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -208,7 +208,7 @@ LAMMPS was built with that package. See the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/compute_displace_atom.html b/doc/compute_displace_atom.html index b300e5656b..58885b3feb 100644 --- a/doc/compute_displace_atom.html +++ b/doc/compute_displace_atom.html @@ -8,7 +8,7 @@ - compute displace/atom command — LAMMPS 15 May 2015 version documentation + compute displace/atom command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -154,21 +154,21 @@ dz*dz).

    The displacement of an atom is from its original position at the time the compute command was issued. The value of the displacement will be 0.0 for atoms not in the specified compute group.

    -
    -

    Warning

    -

    Initial coordinates are stored in “unwrapped” form, by -using the image flags associated with each atom. See the dump custom command for a discussion of “unwrapped” coordinates. +

    +

    Note

    +

    Initial coordinates are stored in “unwrapped” form, by using the +image flags associated with each atom. See the dump custom command for a discussion of “unwrapped” coordinates. See the Atoms section of the read_data command for a discussion of image flags and how they are set for each atom. You can reset the image flags (e.g. to 0) before invoking this compute by using the set image command.

    -
    -

    Warning

    -

    If you want the quantities calculated by this compute -to be continuous when running from a restart file, -then you should use the same ID for this compute, as in the original -run. This is so that the fix this compute creates to store per-atom +

    +

    Note

    +

    If you want the quantities calculated by this compute to be +continuous when running from a restart file, then +you should use the same ID for this compute, as in the original run. +This is so that the fix this compute creates to store per-atom quantities will also have the same ID, and thus be initialized correctly with time=0 atom coordinates from the restart file.

    @@ -201,7 +201,7 @@ options.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -222,7 +222,7 @@ options.

    @@ -153,11 +153,11 @@ for descriptions of these options.

    computed as 1/2 I w^2, where I is the inertia tensor for the aspherical particle and w is its angular velocity, which is computed from its angular momentum if needed.

    -
    -

    Warning

    -

    For 2d models, ellipsoidal particles -are treated as ellipsoids, not ellipses, meaning their moments of -inertia will be the same as in 3d.

    +
    +

    Note

    +

    For 2d models, ellipsoidal particles are +treated as ellipsoids, not ellipses, meaning their moments of inertia +will be the same as in 3d.

    Output info:

    This compute calculates a global scalar (the KE). This value can be @@ -195,7 +195,7 @@ particles.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -216,7 +216,7 @@ particles.

    @@ -187,7 +187,7 @@ LAMMPS was built with that package. See the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -208,7 +208,7 @@ LAMMPS was built with that package. See the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/compute_erotate_sphere.html b/doc/compute_erotate_sphere.html index 2d41764bca..b2e307646f 100644 --- a/doc/compute_erotate_sphere.html +++ b/doc/compute_erotate_sphere.html @@ -8,7 +8,7 @@ - compute erotate/sphere command — LAMMPS 15 May 2015 version documentation + compute erotate/sphere command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -148,11 +148,11 @@ a group of spherical particles.

    The rotational energy is computed as 1/2 I w^2, where I is the moment of inertia for a sphere and w is the particle’s angular velocity.

    -
    -

    Warning

    -

    For 2d models, particles are treated -as spheres, not disks, meaning their moment of inertia will be the -same as in 3d.

    +
    +

    Note

    +

    For 2d models, particles are treated as +spheres, not disks, meaning their moment of inertia will be the same +as in 3d.

    Output info:

    This compute calculates a global scalar (the KE). This value can be @@ -187,7 +187,7 @@ contribute to the rotational energy.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -208,7 +208,7 @@ contribute to the rotational energy.

    @@ -148,11 +148,11 @@ each particle in a group.

    The rotational energy is computed as 1/2 I w^2, where I is the moment of inertia for a sphere and w is the particle’s angular velocity.

    -
    -

    Warning

    -

    For 2d models, particles are treated -as spheres, not disks, meaning their moment of inertia will be the -same as in 3d.

    +
    +

    Note

    +

    For 2d models, particles are treated as +spheres, not disks, meaning their moment of inertia will be the same +as in 3d.

    The value of the rotational kinetic energy will be 0.0 for atoms not in the specified compute group or for point particles with a radius = @@ -186,7 +186,7 @@ LAMMPS output options.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -207,7 +207,7 @@ LAMMPS output options.

    @@ -193,7 +193,7 @@ for more info on packages.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -214,7 +214,7 @@ for more info on packages.

    @@ -222,11 +222,11 @@ order to setup an alchemical transformation route, several strategies are available, such as single-topology or double-topology strategies (Pearlman). The latter does not require modification of bond lengths, angles or other internal coordinates.

    -

    IMPORTANT NOTES: This compute command does not take kinetic energy -into account, therefore the masses of the particles should not be -modified between the reference and perturbed states, or along the -alchemical transformation route. This compute command does not change -bond lengths or other internal coordinates (Boresch, Karplus).

    +

    NOTES: This compute command does not take kinetic energy into account, +therefore the masses of the particles should not be modified between +the reference and perturbed states, or along the alchemical +transformation route. This compute command does not change bond +lengths or other internal coordinates (Boresch, Karplus).


    The pair attribute enables various parameters of potentials defined by the pair_style and pair_coeff @@ -392,7 +392,7 @@ Liquids, Oxford University Press (1987)

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -413,7 +413,7 @@ Liquids, Oxford University Press (1987)

    @@ -240,7 +240,7 @@ The ewald and pppm styles do.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -261,7 +261,7 @@ The ewald and pppm styles do.

    @@ -160,15 +160,14 @@ components of the vector are ordered xx, yy, zz, xy, xz, yz. Note that unlike the scalar Rg, each of the 6 values of the tensor is effectively a “squared” value, since the cross-terms may be negative and taking a sqrt() would be invalid.

    -
    -

    Warning

    -

    The coordinates of an atom contribute to Rg in -“unwrapped” form, by using the image flags associated with each atom. -See the dump custom command for a discussion of -“unwrapped” coordinates. See the Atoms section of the -read_data command for a discussion of image flags and -how they are set for each atom. You can reset the image flags -(e.g. to 0) before invoking this compute by using the set image command.

    +
    +

    Note

    +

    The coordinates of an atom contribute to Rg in “unwrapped” form, +by using the image flags associated with each atom. See the dump custom command for a discussion of “unwrapped” coordinates. +See the Atoms section of the read_data command for a +discussion of image flags and how they are set for each atom. You can +reset the image flags (e.g. to 0) before invoking this compute by +using the set image command.

    Output info:

    This compute calculates a global scalar (Rg) and a global vector of @@ -202,7 +201,7 @@ distance^2 units re

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -223,7 +222,7 @@ distance^2 units re @@ -181,15 +181,14 @@ The formula for the components of the tensor is the same as the above formula, except that (Ri - Rcm)^2 is replaced by (Rix - Rcmx) * (Riy - Rcmy) for the xy component, etc. The 6 components of the tensor are ordered xx, yy, zz, xy, xz, yz.

    -
    -

    Warning

    -

    The coordinates of an atom contribute to Rg in -“unwrapped” form, by using the image flags associated with each atom. -See the dump custom command for a discussion of -“unwrapped” coordinates. See the Atoms section of the -read_data command for a discussion of image flags and -how they are set for each atom. You can reset the image flags -(e.g. to 0) before invoking this compute by using the set image command.

    +
    +

    Note

    +

    The coordinates of an atom contribute to Rg in “unwrapped” form, +by using the image flags associated with each atom. See the dump custom command for a discussion of “unwrapped” coordinates. +See the Atoms section of the read_data command for a +discussion of image flags and how they are set for each atom. You can +reset the image flags (e.g. to 0) before invoking this compute by +using the set image command.

    The simplest way to output the results of the compute gyration/chunk calculation to a file is to use the fix ave/time @@ -233,7 +232,7 @@ represented by the formula above.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -254,7 +253,7 @@ represented by the formula above.

    @@ -174,14 +174,13 @@ vector. Note that as discussed below, the 1/V scaling factor in the equation for J is NOT included in the calculation performed by this compute; you need to add it for a volume appropriate to the atoms included in the calculation.

    -
    -

    Warning

    -

    The compute pe/atom and -compute stress/atom commands have options -for which terms to include in their calculation (pair, bond, etc). -The heat flux calculation will thus include exactly the same terms. -Normally you should use compute stress/atom virial so as not to include a kinetic energy -term in the heat flux.

    +
    +

    Note

    +

    The compute pe/atom and compute stress/atom commands have options for which +terms to include in their calculation (pair, bond, etc). The heat +flux calculation will thus include exactly the same terms. Normally +you should use compute stress/atom virial +so as not to include a kinetic energy term in the heat flux.

    This compute calculates 6 quantities and stores them in a 6-component vector. The first 3 components are the x, y, z components of the full @@ -316,7 +315,7 @@ print "average conductivity: $k[W/mK] @ $T K, ${ndens} /A^3"

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -337,7 +336,7 @@ print "average conductivity: $k[W/mK] @ $T K, ${ndens} /A^3" @@ -191,18 +191,18 @@ specified compute group, as well as for atoms that have less than time the calculation is performed (i.e. each time a snapshot of atoms is dumped). Thus it can be inefficient to compute/dump this quantity too frequently.

    -
    -

    Warning

    +
    +

    Note

    If you have a bonded system, then the settings of special_bonds command can remove pairwise interactions between atoms in the same bond, angle, or dihedral. This is the default setting for the special_bonds command, and means those pairwise interactions do not appear in the neighbor list. Because this fix uses the neighbor list, it also means -those pairs will not be included in the order parameter. This difficulty -can be circumvented by writing a dump file, and using the -rerun command to compute the order parameter for snapshots -in the dump file. The rerun script can use a +those pairs will not be included in the order parameter. This +difficulty can be circumvented by writing a dump file, and using the +rerun command to compute the order parameter for +snapshots in the dump file. The rerun script can use a special_bonds command that includes all pairs in the neighbor list.

    @@ -241,7 +241,7 @@ options.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -262,7 +262,7 @@ options.

    @@ -198,7 +198,7 @@ options.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -219,7 +219,7 @@ options.

    @@ -164,14 +164,14 @@ in that group, signifying they are not assigned to a chunk, and will thus also not contribute to this calculation. You can specify the “all” group for this command if you simply want to include atoms with non-zero chunk IDs.

    -
    -

    Warning

    -

    The coordinates of an atom contribute to the chunk’s -inertia tensor in “unwrapped” form, by using the image flags -associated with each atom. See the dump custom command -for a discussion of “unwrapped” coordinates. See the Atoms section of -the read_data command for a discussion of image flags -and how they are set for each atom. You can reset the image flags +

    +

    Note

    +

    The coordinates of an atom contribute to the chunk’s inertia +tensor in “unwrapped” form, by using the image flags associated with +each atom. See the dump custom command for a discussion +of “unwrapped” coordinates. See the Atoms section of the +read_data command for a discussion of image flags and +how they are set for each atom. You can reset the image flags (e.g. to 0) before invoking this compute by using the set image command.

    The simplest way to output the results of the compute inertia/chunk @@ -214,7 +214,7 @@ mass*distance^2 units

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -235,7 +235,7 @@ mass*distance^2 units var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/compute_inertia_chunk.txt b/doc/compute_inertia_chunk.txt index b3bed44b43..5666016117 100644 --- a/doc/compute_inertia_chunk.txt +++ b/doc/compute_inertia_chunk.txt @@ -48,12 +48,12 @@ thus also not contribute to this calculation. You can specify the "all" group for this command if you simply want to include atoms with non-zero chunk IDs. -IMPORTANT NOTE: The coordinates of an atom contribute to the chunk's -inertia tensor in "unwrapped" form, by using the image flags -associated with each atom. See the "dump custom"_dump.html command -for a discussion of "unwrapped" coordinates. See the Atoms section of -the "read_data"_read_data.html command for a discussion of image flags -and how they are set for each atom. You can reset the image flags +NOTE: The coordinates of an atom contribute to the chunk's inertia +tensor in "unwrapped" form, by using the image flags associated with +each atom. See the "dump custom"_dump.html command for a discussion +of "unwrapped" coordinates. See the Atoms section of the +"read_data"_read_data.html command for a discussion of image flags and +how they are set for each atom. You can reset the image flags (e.g. to 0) before invoking this compute by using the "set image"_set.html command. diff --git a/doc/compute_ke.html b/doc/compute_ke.html index 2791c98109..3df917c504 100644 --- a/doc/compute_ke.html +++ b/doc/compute_ke.html @@ -8,7 +8,7 @@ - compute ke command — LAMMPS 15 May 2015 version documentation + compute ke command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -190,7 +190,7 @@ scalar value will be in energy <

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with
    Sphinx using a theme provided by Read the Docs. @@ -211,7 +211,7 @@ scalar value will be in energy < @@ -179,7 +179,7 @@ LAMMPS output options.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with
    Sphinx using a theme provided by Read the Docs. @@ -200,7 +200,7 @@ LAMMPS output options.

    @@ -162,13 +162,11 @@ calculated by the simple formula above. For thermodynamic output, the ke keyword infers kinetic energy from the temperature of the system with 1/2 Kb T of energy for each (nuclear-only) degree of freedom in eFF.

    -
    -

    Warning

    -

    The temperature in eFF should be monitored via the -compute temp/eff command, which can be printed -with thermodynamic output by using the -thermo_modify command, as shown in the following -example:

    +
    +

    Note

    +

    The temperature in eFF should be monitored via the compute temp/eff command, which can be printed with +thermodynamic output by using the thermo_modify +command, as shown in the following example:

    compute         effTemp all temp/eff
     thermo_style    custom step etotal pe ke temp press
    @@ -206,7 +204,7 @@ LAMMPS was built with that package.  See the 
         

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -227,7 +225,7 @@ LAMMPS was built with that package. See the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/compute_ke_atom_eff.txt b/doc/compute_ke_atom_eff.txt index 736c386774..8d85043e3a 100644 --- a/doc/compute_ke_atom_eff.txt +++ b/doc/compute_ke_atom_eff.txt @@ -42,11 +42,10 @@ calculated by the simple formula above. For thermodynamic output, the with 1/2 Kb T of energy for each (nuclear-only) degree of freedom in eFF. -IMPORTANT NOTE: The temperature in eFF should be monitored via the -"compute temp/eff"_compute_temp_eff.html command, which can be printed -with thermodynamic output by using the -"thermo_modify"_thermo_modify.html command, as shown in the following -example: +NOTE: The temperature in eFF should be monitored via the "compute +temp/eff"_compute_temp_eff.html command, which can be printed with +thermodynamic output by using the "thermo_modify"_thermo_modify.html +command, as shown in the following example: compute effTemp all temp/eff thermo_style custom step etotal pe ke temp press diff --git a/doc/compute_ke_eff.html b/doc/compute_ke_eff.html index a8f05d59ba..a8f427e7e0 100644 --- a/doc/compute_ke_eff.html +++ b/doc/compute_ke_eff.html @@ -8,7 +8,7 @@ - compute ke/eff command — LAMMPS 15 May 2015 version documentation + compute ke/eff command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -202,7 +202,7 @@ LAMMPS was built with that package. See the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -223,7 +223,7 @@ LAMMPS was built with that package. See the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/compute_ke_rigid.html b/doc/compute_ke_rigid.html index cb45568548..8d6d7022f7 100644 --- a/doc/compute_ke_rigid.html +++ b/doc/compute_ke_rigid.html @@ -8,7 +8,7 @@ - compute ke/rigid command — LAMMPS 15 May 2015 version documentation + compute ke/rigid command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -185,7 +185,7 @@ LAMMPS was built with that package. See the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -206,7 +206,7 @@ LAMMPS was built with that package. See the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/compute_meso_e_atom.html b/doc/compute_meso_e_atom.html index 405fc6b65f..7cd3bec37d 100644 --- a/doc/compute_meso_e_atom.html +++ b/doc/compute_meso_e_atom.html @@ -8,7 +8,7 @@ - compute meso_e/atom command — LAMMPS 15 May 2015 version documentation + compute meso_e/atom command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -182,7 +182,7 @@ LAMMPS was built with that package. See the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -203,7 +203,7 @@ LAMMPS was built with that package. See the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/compute_meso_rho_atom.html b/doc/compute_meso_rho_atom.html index 7afe72af79..52992f6b8e 100644 --- a/doc/compute_meso_rho_atom.html +++ b/doc/compute_meso_rho_atom.html @@ -8,7 +8,7 @@ - compute meso_rho/atom command — LAMMPS 15 May 2015 version documentation + compute meso_rho/atom command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -182,7 +182,7 @@ LAMMPS was built with that package. See the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -203,7 +203,7 @@ LAMMPS was built with that package. See the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/compute_meso_t_atom.html b/doc/compute_meso_t_atom.html index eb4209d5e7..ab0c053b1f 100644 --- a/doc/compute_meso_t_atom.html +++ b/doc/compute_meso_t_atom.html @@ -8,7 +8,7 @@ - compute meso_t/atom command — LAMMPS 15 May 2015 version documentation + compute meso_t/atom command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -183,7 +183,7 @@ LAMMPS was built with that package. See the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -204,7 +204,7 @@ LAMMPS was built with that package. See the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/compute_modify.html b/doc/compute_modify.html index 356a02d1ff..82adf5ccf7 100644 --- a/doc/compute_modify.html +++ b/doc/compute_modify.html @@ -8,7 +8,7 @@ - compute_modify command — LAMMPS 15 May 2015 version documentation + compute_modify command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -203,7 +203,7 @@ defined with no extra keywords; otherwise it is no.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with
    Sphinx using a theme provided by Read the Docs. @@ -224,7 +224,7 @@ defined with no extra keywords; otherwise it is no.

    @@ -188,29 +188,28 @@ sense to use this option if the atoms are not diffusing, so that their average positions relative to the center of mass of the system are stationary. The most common case is crystalline solids undergoing thermal motion.

    -
    -

    Warning

    -

    Initial coordinates are stored in “unwrapped” form, by -using the image flags associated with each atom. See the dump custom command for a discussion of “unwrapped” coordinates. +

    +

    Note

    +

    Initial coordinates are stored in “unwrapped” form, by using the +image flags associated with each atom. See the dump custom command for a discussion of “unwrapped” coordinates. See the Atoms section of the read_data command for a discussion of image flags and how they are set for each atom. You can reset the image flags (e.g. to 0) before invoking this compute by using the set image command.

    -
    -

    Warning

    -

    If you want the quantities calculated by this compute -to be continuous when running from a restart file, -then you should use the same ID for this compute, as in the original -run. This is so that the fix this compute creates to store per-atom +

    +

    Note

    +

    If you want the quantities calculated by this compute to be +continuous when running from a restart file, then +you should use the same ID for this compute, as in the original run. +This is so that the fix this compute creates to store per-atom quantities will also have the same ID, and thus be initialized -correctly with atom reference positions from the restart file. -When average is set to yes, then the atom reference positions -are restored correctly, but not the number of samples used -obtain them. As a result, the reference positions from the restart -file are combined with subsequent positions as if they were from a -single sample, instead of many, which will change the values of msd -somewhat.

    +correctly with atom reference positions from the restart file. When +average is set to yes, then the atom reference positions are +restored correctly, but not the number of samples used obtain them. As +a result, the reference positions from the restart file are combined +with subsequent positions as if they were from a single sample, +instead of many, which will change the values of msd somewhat.

    Output info:

    This compute calculates a global vector of length 4, which can be @@ -245,7 +244,7 @@ distance^2 units.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -266,7 +265,7 @@ distance^2 units. var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/compute_msd.txt b/doc/compute_msd.txt index fc8327de5c..6eb057229f 100644 --- a/doc/compute_msd.txt +++ b/doc/compute_msd.txt @@ -71,26 +71,25 @@ their average positions relative to the center of mass of the system are stationary. The most common case is crystalline solids undergoing thermal motion. -IMPORTANT NOTE: Initial coordinates are stored in "unwrapped" form, by -using the image flags associated with each atom. See the "dump +NOTE: Initial coordinates are stored in "unwrapped" form, by using the +image flags associated with each atom. See the "dump custom"_dump.html command for a discussion of "unwrapped" coordinates. See the Atoms section of the "read_data"_read_data.html command for a discussion of image flags and how they are set for each atom. You can reset the image flags (e.g. to 0) before invoking this compute by using the "set image"_set.html command. -IMPORTANT NOTE: If you want the quantities calculated by this compute -to be continuous when running from a "restart file"_read_restart.html, -then you should use the same ID for this compute, as in the original -run. This is so that the fix this compute creates to store per-atom +NOTE: If you want the quantities calculated by this compute to be +continuous when running from a "restart file"_read_restart.html, then +you should use the same ID for this compute, as in the original run. +This is so that the fix this compute creates to store per-atom quantities will also have the same ID, and thus be initialized -correctly with atom reference positions from the restart file. -When {average} is set to yes, then the atom reference positions -are restored correctly, but not the number of samples used -obtain them. As a result, the reference positions from the restart -file are combined with subsequent positions as if they were from a -single sample, instead of many, which will change the values of msd -somewhat. +correctly with atom reference positions from the restart file. When +{average} is set to yes, then the atom reference positions are +restored correctly, but not the number of samples used obtain them. As +a result, the reference positions from the restart file are combined +with subsequent positions as if they were from a single sample, +instead of many, which will change the values of msd somewhat. [Output info:] diff --git a/doc/compute_msd_chunk.html b/doc/compute_msd_chunk.html index ef8252b80f..a39a07b7a3 100644 --- a/doc/compute_msd_chunk.html +++ b/doc/compute_msd_chunk.html @@ -8,7 +8,7 @@ - compute msd/chunk command — LAMMPS 15 May 2015 version documentation + compute msd/chunk command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -171,18 +171,17 @@ proportional to the diffusion coefficient of the diffusing chunks.

    The displacement of the center-of-mass of the chunk is from its original center-of-mass position, calculated on the timestep this compute command was first invoked.

    -
    -

    Warning

    -

    The number of chunks Nchunk calculated by the -compute chunk/atom command must remain -constant each time this compute is invoked, so that the displacement -for each chunk from its original position can be computed -consistently. If Nchunk does not remain constant, an error will be -generated. If needed, you can enforce a constant Nchunk by using -the nchunk once or ids once options when specifying the compute chunk/atom command.

    +
    +

    Note

    +

    The number of chunks Nchunk calculated by the compute chunk/atom command must remain constant each +time this compute is invoked, so that the displacement for each chunk +from its original position can be computed consistently. If Nchunk +does not remain constant, an error will be generated. If needed, you +can enforce a constant Nchunk by using the nchunk once or ids +once options when specifying the compute chunk/atom command.

    -
    -

    Warning

    +
    +

    Note

    This compute stores the original position (of the center-of-mass) of each chunk. When a displacement is calculated on a later timestep, it is assumed that the same atoms are assigned to the @@ -192,22 +191,22 @@ case, though you can use the ids once option when specifying the this is not the case, the MSD calculation does not have a sensible meaning.

    -
    -

    Warning

    -

    The initial coordinates of the atoms in each chunk are -stored in “unwrapped” form, by using the image flags associated with -each atom. See the dump custom command for a discussion -of “unwrapped” coordinates. See the Atoms section of the +

    +

    Note

    +

    The initial coordinates of the atoms in each chunk are stored in +“unwrapped” form, by using the image flags associated with each atom. +See the dump custom command for a discussion of +“unwrapped” coordinates. See the Atoms section of the read_data command for a discussion of image flags and how they are set for each atom. You can reset the image flags (e.g. to 0) before invoking this compute by using the set image command.

    -
    -

    Warning

    -

    Unlike the compute msd command, -this compute does not store the initial center-of-mass coorindates of -its molecules in a restart file. Thus you cannot continue the MSD per -chunk calculation of this compute when running from a restart file.

    +
    +

    Note

    +

    Unlike the compute msd command, this compute +does not store the initial center-of-mass coorindates of its molecules +in a restart file. Thus you cannot continue the MSD per chunk +calculation of this compute when running from a restart file.

    The simplest way to output the results of the compute com/msd calculation to a file is to use the fix ave/time @@ -249,7 +248,7 @@ distance^2 units.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -270,7 +269,7 @@ distance^2 units. var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/compute_msd_chunk.txt b/doc/compute_msd_chunk.txt index 98dc5ed937..7c4b664020 100644 --- a/doc/compute_msd_chunk.txt +++ b/doc/compute_msd_chunk.txt @@ -57,16 +57,16 @@ The displacement of the center-of-mass of the chunk is from its original center-of-mass position, calculated on the timestep this compute command was first invoked. -IMPORTANT NOTE: The number of chunks {Nchunk} calculated by the -"compute chunk/atom"_compute_chunk_atom.html command must remain -constant each time this compute is invoked, so that the displacement -for each chunk from its original position can be computed -consistently. If {Nchunk} does not remain constant, an error will be -generated. If needed, you can enforce a constant {Nchunk} by using -the {nchunk once} or {ids once} options when specifying the "compute +NOTE: The number of chunks {Nchunk} calculated by the "compute +chunk/atom"_compute_chunk_atom.html command must remain constant each +time this compute is invoked, so that the displacement for each chunk +from its original position can be computed consistently. If {Nchunk} +does not remain constant, an error will be generated. If needed, you +can enforce a constant {Nchunk} by using the {nchunk once} or {ids +once} options when specifying the "compute chunk/atom"_compute_chunk_atom.html command. -IMPORTANT NOTE: This compute stores the original position (of the +NOTE: This compute stores the original position (of the center-of-mass) of each chunk. When a displacement is calculated on a later timestep, it is assumed that the same atoms are assigned to the same chunk ID. However LAMMPS has no simple way to insure this is the @@ -75,19 +75,19 @@ case, though you can use the {ids once} option when specifying the this is not the case, the MSD calculation does not have a sensible meaning. -IMPORTANT NOTE: The initial coordinates of the atoms in each chunk are -stored in "unwrapped" form, by using the image flags associated with -each atom. See the "dump custom"_dump.html command for a discussion -of "unwrapped" coordinates. See the Atoms section of the +NOTE: The initial coordinates of the atoms in each chunk are stored in +"unwrapped" form, by using the image flags associated with each atom. +See the "dump custom"_dump.html command for a discussion of +"unwrapped" coordinates. See the Atoms section of the "read_data"_read_data.html command for a discussion of image flags and how they are set for each atom. You can reset the image flags (e.g. to 0) before invoking this compute by using the "set image"_set.html command. -IMPORTANT NOTE: Unlike the "compute msd"_compute_msd.html command, -this compute does not store the initial center-of-mass coorindates of -its molecules in a restart file. Thus you cannot continue the MSD per -chunk calculation of this compute when running from a "restart +NOTE: Unlike the "compute msd"_compute_msd.html command, this compute +does not store the initial center-of-mass coorindates of its molecules +in a restart file. Thus you cannot continue the MSD per chunk +calculation of this compute when running from a "restart file"_read_restart.html. The simplest way to output the results of the compute com/msd diff --git a/doc/compute_msd_nongauss.html b/doc/compute_msd_nongauss.html index db923d6ddc..1376ba1e7a 100644 --- a/doc/compute_msd_nongauss.html +++ b/doc/compute_msd_nongauss.html @@ -8,7 +8,7 @@ - compute msd/nongauss command — LAMMPS 15 May 2015 version documentation + compute msd/nongauss command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -169,8 +169,8 @@ others.

    If the com option is set to yes then the effect of any drift in the center-of-mass of the group of atoms is subtracted out before the displacment of each atom is calcluated.

    -

    See the compute msd doc page for further IMPORTANT -NOTES, which also apply to this compute.

    +

    See the compute msd doc page for further important +NOTEs, which also apply to this compute.

    Output info:

    This compute calculates a global vector of length 3, which can be accessed by indices 1-3 by any command that uses global vector values @@ -205,7 +205,7 @@ was built with that package. See the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -226,7 +226,7 @@ was built with that package. See the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/compute_msd_nongauss.txt b/doc/compute_msd_nongauss.txt index 53d30a9145..b92ceaacde 100644 --- a/doc/compute_msd_nongauss.txt +++ b/doc/compute_msd_nongauss.txt @@ -50,8 +50,8 @@ If the {com} option is set to {yes} then the effect of any drift in the center-of-mass of the group of atoms is subtracted out before the displacment of each atom is calcluated. -See the "compute msd"_compute_msd.html doc page for further IMPORTANT -NOTES, which also apply to this compute. +See the "compute msd"_compute_msd.html doc page for further important +NOTEs, which also apply to this compute. [Output info:] diff --git a/doc/compute_omega_chunk.html b/doc/compute_omega_chunk.html index b8ceef4788..712f768db5 100644 --- a/doc/compute_omega_chunk.html +++ b/doc/compute_omega_chunk.html @@ -8,7 +8,7 @@ - compute omega/chunk command — LAMMPS 15 May 2015 version documentation + compute omega/chunk command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -165,14 +165,14 @@ in that group, signifying they are not assigned to a chunk, and will thus also not contribute to this calculation. You can specify the “all” group for this command if you simply want to include atoms with non-zero chunk IDs.

    -
    -

    Warning

    -

    The coordinates of an atom contribute to the chunk’s -angular velocity in “unwrapped” form, by using the image flags -associated with each atom. See the dump custom command -for a discussion of “unwrapped” coordinates. See the Atoms section of -the read_data command for a discussion of image flags -and how they are set for each atom. You can reset the image flags +

    +

    Note

    +

    The coordinates of an atom contribute to the chunk’s angular +velocity in “unwrapped” form, by using the image flags associated with +each atom. See the dump custom command for a discussion +of “unwrapped” coordinates. See the Atoms section of the +read_data command for a discussion of image flags and +how they are set for each atom. You can reset the image flags (e.g. to 0) before invoking this compute by using the set image command.

    The simplest way to output the results of the compute omega/chunk @@ -215,7 +215,7 @@ velocity/distance units

    Built with Sphinx using a theme provided by Read the Docs. @@ -236,7 +236,7 @@ velocity/distance units @@ -195,18 +195,18 @@ specified compute group, as well as for atoms that have less than time the calculation is performed (i.e. each time a snapshot of atoms is dumped). Thus it can be inefficient to compute/dump this quantity too frequently.

    -
    -

    Warning

    +
    +

    Note

    If you have a bonded system, then the settings of special_bonds command can remove pairwise interactions between atoms in the same bond, angle, or dihedral. This is the default setting for the special_bonds command, and means those pairwise interactions do not appear in the neighbor list. Because this fix uses the neighbor list, it also means -those pairs will not be included in the order parameter. This difficulty -can be circumvented by writing a dump file, and using the -rerun command to compute the order parameter for snapshots -in the dump file. The rerun script can use a +those pairs will not be included in the order parameter. This +difficulty can be circumvented by writing a dump file, and using the +rerun command to compute the order parameter for +snapshots in the dump file. The rerun script can use a special_bonds command that includes all pairs in the neighbor list.

    @@ -245,7 +245,7 @@ options.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -266,7 +266,7 @@ options.

    @@ -209,7 +209,7 @@ see the doc page for the pair style for details.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -230,7 +230,7 @@ see the doc page for the pair style for details.

    @@ -191,18 +191,18 @@ same for local vectors or arrays generated by other compute commands. For example, pair output from the compute property/local command can be combined with data from this command and output by the dump local command in a consistent way.

    -
    -

    Warning

    -

    For pairs, if two atoms I,J are involved in 1-2, 1-3, -1-4 interactions within the molecular topology, their pairwise -interaction may be turned off, and thus they may not appear in the -neighbor list, and will not be part of the local data created by this -command. More specifically, this will be true of I,J pairs with a -weighting factor of 0.0; pairs with a non-zero weighting factor are -included. The weighting factors for 1-2, 1-3, and 1-4 pairwise -interactions are set by the special_bonds -command. An exception is if long-range Coulombics are being computed -via the kspace_style command, then atom pairs with +

    +

    Note

    +

    For pairs, if two atoms I,J are involved in 1-2, 1-3, 1-4 +interactions within the molecular topology, their pairwise interaction +may be turned off, and thus they may not appear in the neighbor list, +and will not be part of the local data created by this command. More +specifically, this will be true of I,J pairs with a weighting factor +of 0.0; pairs with a non-zero weighting factor are included. The +weighting factors for 1-2, 1-3, and 1-4 pairwise interactions are set +by the special_bonds command. An exception is if +long-range Coulombics are being computed via the +kspace_style command, then atom pairs with weighting factors of zero are still included in the neighbor list, so that a portion of the long-range interaction contribution can be computed in the pair style. Hence in that case, those atom pairs will @@ -243,7 +243,7 @@ output for eng will be in energy

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -264,7 +264,7 @@ output for eng will be in energy var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/compute_pair_local.txt b/doc/compute_pair_local.txt index faf102d532..4f33bc1cf9 100644 --- a/doc/compute_pair_local.txt +++ b/doc/compute_pair_local.txt @@ -76,16 +76,16 @@ property/local"_compute_property_local.html command can be combined with data from this command and output by the "dump local"_dump.html command in a consistent way. -IMPORTANT NOTE: For pairs, if two atoms I,J are involved in 1-2, 1-3, -1-4 interactions within the molecular topology, their pairwise -interaction may be turned off, and thus they may not appear in the -neighbor list, and will not be part of the local data created by this -command. More specifically, this will be true of I,J pairs with a -weighting factor of 0.0; pairs with a non-zero weighting factor are -included. The weighting factors for 1-2, 1-3, and 1-4 pairwise -interactions are set by the "special_bonds"_special_bonds.html -command. An exception is if long-range Coulombics are being computed -via the "kspace_style"_kspace_style.html command, then atom pairs with +NOTE: For pairs, if two atoms I,J are involved in 1-2, 1-3, 1-4 +interactions within the molecular topology, their pairwise interaction +may be turned off, and thus they may not appear in the neighbor list, +and will not be part of the local data created by this command. More +specifically, this will be true of I,J pairs with a weighting factor +of 0.0; pairs with a non-zero weighting factor are included. The +weighting factors for 1-2, 1-3, and 1-4 pairwise interactions are set +by the "special_bonds"_special_bonds.html command. An exception is if +long-range Coulombics are being computed via the +"kspace_style"_kspace_style.html command, then atom pairs with weighting factors of zero are still included in the neighbor list, so that a portion of the long-range interaction contribution can be computed in the pair style. Hence in that case, those atom pairs will diff --git a/doc/compute_pe.html b/doc/compute_pe.html index 7b4bbe1a12..0f4e6b15fe 100644 --- a/doc/compute_pe.html +++ b/doc/compute_pe.html @@ -8,7 +8,7 @@ - compute pe command — LAMMPS 15 May 2015 version documentation + compute pe command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -224,7 +224,7 @@ scalar value will be in energy <

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with
    Sphinx using a theme provided by Read the Docs. @@ -245,7 +245,7 @@ scalar value will be in energy < @@ -180,11 +180,11 @@ compute pe all reduce sum c_peratom thermo_style custom step temp etotal press pe c_pe
    -
    -

    Warning

    -

    The per-atom energy does not any Lennard-Jones tail -corrections invoked by the pair_modify tail yes -command, since those are global contributions to the system energy.

    +
    +

    Note

    +

    The per-atom energy does not any Lennard-Jones tail corrections +invoked by the pair_modify tail yes command, since +those are global contributions to the system energy.

    Output info:

    This compute calculates a per-atom vector, which can be accessed by @@ -215,7 +215,7 @@ LAMMPS output options.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -236,7 +236,7 @@ LAMMPS output options.

    @@ -187,7 +187,7 @@ viscoelasticity model for peridynamics”, Sandia National Lab Report,

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -208,7 +208,7 @@ viscoelasticity model for peridynamics”, Sandia National Lab Report, @@ -181,7 +181,7 @@ compute temperature or ke and/or the virial. The virial keyword means include all terms except the kinetic energy ke.

    Details of how LAMMPS computes the virial efficiently for the entire system, including the effects of periodic boundary conditions is -discussed in (Thompson).

    +discussed in (Thompson).

    The temperature and kinetic energy tensor is not calculated by this compute, but rather by the temperature compute specified with the command. If the kinetic energy is not included in the pressure, than @@ -256,7 +256,7 @@ options.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -277,7 +277,7 @@ options.

    @@ -289,7 +289,7 @@ units for q, etc.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -310,7 +310,7 @@ units for q, etc.

    @@ -236,7 +236,7 @@ unitless or in the units discussed above.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -257,7 +257,7 @@ unitless or in the units discussed above.

    @@ -212,17 +212,16 @@ to the atom IDs of the 2 atoms in each pairwise interaction computed by the pair_style command. The ntype1 and ntype2, or ptype1 and ptype2 attributes refer to the atom types of the 2 atoms in each pairwise interaction.

    -
    -

    Warning

    -

    For pairs, if two atoms I,J are involved in 1-2, 1-3, -1-4 interactions within the molecular topology, their pairwise -interaction may be turned off, and thus they may not appear in the -neighbor list, and will not be part of the local data created by this -command. More specifically, this may be true of I,J pairs with a -weighting factor of 0.0; pairs with a non-zero weighting factor are -included. The weighting factors for 1-2, 1-3, and 1-4 pairwise -interactions are set by the special_bonds -command.

    +
    +

    Note

    +

    For pairs, if two atoms I,J are involved in 1-2, 1-3, 1-4 +interactions within the molecular topology, their pairwise interaction +may be turned off, and thus they may not appear in the neighbor list, +and will not be part of the local data created by this command. More +specifically, this may be true of I,J pairs with a weighting factor of +0.0; pairs with a non-zero weighting factor are included. The +weighting factors for 1-2, 1-3, and 1-4 pairwise interactions are set +by the special_bonds command.

    The batom1 and batom2 attributes refer to the atom IDs of the 2 atoms in each bond. The btype attribute refers to @@ -266,7 +265,7 @@ specified attribute.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -287,7 +286,7 @@ specified attribute.

    @@ -158,8 +158,8 @@ distances into Nbin bins from 0.0 to the maximum force cutoff defined by the pair_style command. The bins are of uniform size in radial distance. Thus a single bin encompasses a thin shell of distances in 3d and a thin ring of distances in 2d.

    -
    -

    Warning

    +
    +

    Note

    If you have a bonded system, then the settings of special_bonds command can remove pairwise interactions between atoms in the same bond, angle, or dihedral. This @@ -167,13 +167,14 @@ is the default setting for the rerun command -to compute the RDF for snapshots in the dump file. The rerun script -can use a special_bonds command that includes all -pairs in the neighbor list.

    +using long-range coulomb (coul/long, coul/msm, coul/wolf or +similar. One way to get around this would be to set special_bond +scaling factors to very tiny numbers that are not exactly zero +(e.g. 1.0e-50). Another workaround is to write a dump file, and use +the rerun command to compute the RDF for snapshots in the +dump file. The rerun script can use a +special_bonds command that includes all pairs in +the neighbor list.

    The itypeN and jtypeN arguments are optional. These arguments must come in pairs. If no pairs are listed, then a single histogram @@ -280,7 +281,7 @@ change from zero to one at the location of the spike in g(r).

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -301,7 +302,7 @@ change from zero to one at the location of the spike in g(r).

    @@ -306,7 +306,7 @@ quantities being reduced are in.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -327,7 +327,7 @@ quantities being reduced are in.

    @@ -309,7 +309,7 @@ Volume C: Mathematical and Chemical Tables, 554-95 (2004).

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -330,7 +330,7 @@ Volume C: Mathematical and Chemical Tables, 554-95 (2004).

    @@ -235,7 +235,7 @@ input quantities are in.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -256,7 +256,7 @@ input quantities are in.

    @@ -180,7 +180,7 @@ LAMMPS was built with that package. See the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -201,7 +201,7 @@ LAMMPS was built with that package. See the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/compute_smd_damage.html b/doc/compute_smd_damage.html index 4442785ed7..2efad62620 100644 --- a/doc/compute_smd_damage.html +++ b/doc/compute_smd_damage.html @@ -8,7 +8,7 @@ - compute smd/damage command — LAMMPS 15 May 2015 version documentation + compute smd/damage command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -177,7 +177,7 @@ section for more info.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with
    Sphinx using a theme provided by Read the Docs. @@ -198,7 +198,7 @@ section for more info.

    @@ -184,7 +184,7 @@ section for more info.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -205,7 +205,7 @@ section for more info.

    @@ -176,7 +176,7 @@ updated Lagrangian or total Lagrangian SPH pair styles.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -197,7 +197,7 @@ updated Lagrangian or total Lagrangian SPH pair styles.

    @@ -179,7 +179,7 @@ updated Lagrangian or total Lagrangian SPH pair styles.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -200,7 +200,7 @@ updated Lagrangian or total Lagrangian SPH pair styles.

    @@ -179,7 +179,7 @@ updated Lagrangian or total Lagrangian SPH pair styles.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -200,7 +200,7 @@ updated Lagrangian or total Lagrangian SPH pair styles.

    @@ -178,7 +178,7 @@ section for more info.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -199,7 +199,7 @@ section for more info.

    @@ -181,7 +181,7 @@ total Lagrangian SPH pair style.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -202,7 +202,7 @@ total Lagrangian SPH pair style.

    @@ -182,7 +182,7 @@ section for more info.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -203,7 +203,7 @@ section for more info.

    @@ -178,7 +178,7 @@ section for more info.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -199,7 +199,7 @@ section for more info.

    @@ -180,7 +180,7 @@ section for more info.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -201,7 +201,7 @@ section for more info.

    @@ -181,7 +181,7 @@ section for more info.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -202,7 +202,7 @@ section for more info.

    @@ -179,7 +179,7 @@ section for more info.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -200,7 +200,7 @@ section for more info.

    @@ -180,7 +180,7 @@ section for more info.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -201,7 +201,7 @@ section for more info.

    @@ -183,7 +183,7 @@ section for more info.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -204,7 +204,7 @@ section for more info.

    @@ -177,7 +177,7 @@ section for more info. This compute can only be used for particles which interac

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -198,7 +198,7 @@ section for more info. This compute can only be used for particles which interac @@ -179,7 +179,7 @@ section for more info. This compute can only be used for particles which interac

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -200,7 +200,7 @@ section for more info. This compute can only be used for particles which interac @@ -179,7 +179,7 @@ section for more info. This compute can only be used for particles which interac

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -200,7 +200,7 @@ section for more info. This compute can only be used for particles which interac @@ -182,7 +182,7 @@ section for more info. This compute can only be used for particles which interac

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -203,7 +203,7 @@ section for more info. This compute can only be used for particles which interac @@ -181,7 +181,7 @@ LAMMPS was built with that package. See the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -202,7 +202,7 @@ LAMMPS was built with that package. See the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/compute_sna_atom.html b/doc/compute_sna_atom.html index 840a929347..2aeb6d683d 100644 --- a/doc/compute_sna_atom.html +++ b/doc/compute_sna_atom.html @@ -8,7 +8,7 @@ - compute sna/atom command — LAMMPS 15 May 2015 version documentation + compute sna/atom command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -255,8 +255,8 @@ detailed explanation of the number of bispectrum components and the ordered in which they are listed

    The keyword switchflag can be used to turn off the switching function.

    -
    -

    Warning

    +
    +

    Note

    If you have a bonded system, then the settings of special_bonds command can remove pairwise interactions between atoms in the same bond, angle, or dihedral. This @@ -341,7 +341,7 @@ of Angular Momentum, World Scientific, Singapore (1987).

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -362,7 +362,7 @@ of Angular Momentum, World Scientific, Singapore (1987).

    @@ -274,7 +274,7 @@ options.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -295,7 +295,7 @@ options.

    @@ -214,7 +214,7 @@ heat/flux*_compute_heat_flux.html

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -235,7 +235,7 @@ heat/flux*_compute_heat_flux.html

    @@ -232,7 +232,7 @@ vector values will be in energy

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with
    Sphinx using a theme provided by Read the Docs. @@ -253,7 +253,7 @@ vector values will be in energy @@ -165,10 +165,10 @@ in the group. For 3d finite-size particles, each has 6 degrees of freedom (3 translational, 3 rotational). For 2d finite-size particles, each has 3 degrees of freedom (2 translational, 1 rotational).

    -
    -

    Warning

    -

    This choice for degrees of freedom (dof) assumes that -all finite-size aspherical or spherical particles in your model will +

    +

    Note

    +

    This choice for degrees of freedom (dof) assumes that all +finite-size aspherical or spherical particles in your model will freely rotate, sampling all their rotational dof. It is possible to use a combination of interaction potentials and fixes that induce no torque or otherwise constrain some of all of your particles so that @@ -191,11 +191,11 @@ by the compute temp -

    -

    Warning

    -

    For 2d models, particles are treated -as ellipsoids, not ellipses, meaning their moments of inertia will be -the same as in 3d.

    +
    +

    Note

    +

    For 2d models, particles are treated as +ellipsoids, not ellipses, meaning their moments of inertia will be the +same as in 3d.

    A kinetic energy tensor, stored as a 6-element vector, is also calculated by this compute. The formula for the components of the @@ -269,7 +269,7 @@ shape attribute.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -290,7 +290,7 @@ shape attribute.

    @@ -242,10 +242,10 @@ atoms in the chunk on different timesteps were collected together as one set of atoms to calculate their temperature. This compute allows the center-of-mass velocity of each chunk to be subtracted before calculating the temperature; fix ave/chunk does not.

    -
    -

    Warning

    -

    Only atoms in the specified group contribute to the -calculations performed by this compute. The compute chunk/atom command defines its own group; +

    +

    Note

    +

    Only atoms in the specified group contribute to the calculations +performed by this compute. The compute chunk/atom command defines its own group; atoms will have a chunk ID = 0 if they are not in that group, signifying they are not assigned to a chunk, and will thus also not contribute to this calculation. You can specify the “all” group for @@ -342,7 +342,7 @@ system (2 or 3), and cdof = 0.0.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -363,7 +363,7 @@ system (2 or 3), and cdof = 0.0.

    @@ -214,7 +214,7 @@ vector values will be in energy

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with
    Sphinx using a theme provided by Read the Docs. @@ -235,7 +235,7 @@ vector values will be in energy @@ -150,7 +150,7 @@ compute core_shells all temp/cs cores shells

    Define a computation that calculates the temperature of a system based on the center-of-mass velocity of atom pairs that are bonded to each other. This compute is designed to be used with the adiabatic -core/shell model of (Mitchell and Finchham). See +core/shell model of (Mitchell and Finchham). See Section_howto 25 of the manual for an overview of the model as implemented in LAMMPS. Specifically, this compute enables correct temperature calculation and thermostatting of @@ -233,7 +233,7 @@ be used which generate new molecules or atoms during a simulation.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -254,7 +254,7 @@ be used which generate new molecules or atoms during a simulation.

    @@ -162,19 +162,18 @@ small x velocity, while atoms at the top of the box (hi y) have a large x velocity. This position-dependent streaming velocity is subtracted from each atom’s actual velocity to yield a thermal velocity which is used to compute the temperature.

    -
    -

    Warning

    -

    Fix deform has an option for -remapping either atom coordinates or velocities to the changing -simulation box. When using this compute in conjunction with a -deforming box, fix deform should NOT remap atom positions, but rather -should let atoms respond to the changing box by adjusting their own -velocities (or let fix deform remap the atom -velocities, see it’s remap option). If fix deform does remap atom -positions, then they appear to move with the box but their velocity is -not changed, and thus they do NOT have the streaming velocity assumed -by this compute. LAMMPS will warn you if fix deform is defined and -its remap setting is not consistent with this compute.

    +
    +

    Note

    +

    Fix deform has an option for remapping either +atom coordinates or velocities to the changing simulation box. When +using this compute in conjunction with a deforming box, fix deform +should NOT remap atom positions, but rather should let atoms respond +to the changing box by adjusting their own velocities (or let fix deform remap the atom velocities, see it’s remap +option). If fix deform does remap atom positions, then they appear to +move with the box but their velocity is not changed, and thus they do +NOT have the streaming velocity assumed by this compute. LAMMPS will +warn you if fix deform is defined and its remap setting is not +consistent with this compute.

    After the streaming velocity has been subtracted from each atom, the temperature is calculated by the formula KE = dim/2 N k T, where KE = @@ -198,12 +197,12 @@ command that performs thermostatting then this bias will be subtracted from each atom, thermostatting of the remaining thermal velocity will be performed, and the bias will be added back in. Thermostatting fixes that work in this way include fix nvt, fix temp/rescale, fix temp/berendsen, and fix langevin.

    -
    -

    Warning

    -

    The temperature calculated by this compute is only -accurate if the atoms are indeed moving with a stream velocity profile -that matches the box deformation. If not, then the compute will -subtract off an incorrect stream velocity, yielding a bogus thermal +

    +

    Note

    +

    The temperature calculated by this compute is only accurate if +the atoms are indeed moving with a stream velocity profile that +matches the box deformation. If not, then the compute will subtract +off an incorrect stream velocity, yielding a bogus thermal temperature. You should NOT assume that your atoms are streaming at the same rate the box is deforming. Rather, you should monitor their velocity profile, e.g. via the fix ave/spatial @@ -256,7 +255,7 @@ vector values will be in energy

    Built with Sphinx using a theme provided by Read the Docs. @@ -277,7 +276,7 @@ vector values will be in energy @@ -195,7 +195,7 @@ LAMMPS was built with that package. See the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -216,7 +216,7 @@ LAMMPS was built with that package. See the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/compute_temp_drude.html b/doc/compute_temp_drude.html index b8b8ab808d..1f6e8eb3f6 100644 --- a/doc/compute_temp_drude.html +++ b/doc/compute_temp_drude.html @@ -8,7 +8,7 @@ - compute temp/drude command — LAMMPS 15 May 2015 version documentation + compute temp/drude command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -203,7 +203,7 @@ assumed to be constant for the duration of the run unless the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with
    Sphinx using a theme provided by Read the Docs. @@ -224,7 +224,7 @@ assumed to be constant for the duration of the run unless the @@ -162,11 +162,11 @@ capacity to 3/2k (where only nuclei contribute). This subtlety is valid for temperatures well below the Fermi temperature, which for densities two to five times the density of liquid H2 ranges from 86,000 to 170,000 K.

    -
    -

    Warning

    -

    For eFF models, in order to override the default -temperature reported by LAMMPS in the thermodynamic quantities -reported via the thermo command, the user should apply a +

    +

    Note

    +

    For eFF models, in order to override the default temperature +reported by LAMMPS in the thermodynamic quantities reported via the +thermo command, the user should apply a thermo_modify command, as shown in the following example:

    @@ -220,7 +220,7 @@ LAMMPS was built with that package. See the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -241,7 +241,7 @@ LAMMPS was built with that package. See the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/compute_temp_eff.txt b/doc/compute_temp_eff.txt index 194aaa3c7b..a3629fef87 100644 --- a/doc/compute_temp_eff.txt +++ b/doc/compute_temp_eff.txt @@ -42,9 +42,9 @@ valid for temperatures well below the Fermi temperature, which for densities two to five times the density of liquid H2 ranges from 86,000 to 170,000 K. -IMPORTANT NOTE: For eFF models, in order to override the default -temperature reported by LAMMPS in the thermodynamic quantities -reported via the "thermo"_thermo.html command, the user should apply a +NOTE: For eFF models, in order to override the default temperature +reported by LAMMPS in the thermodynamic quantities reported via the +"thermo"_thermo.html command, the user should apply a "thermo_modify"_thermo_modify.html command, as shown in the following example: diff --git a/doc/compute_temp_partial.html b/doc/compute_temp_partial.html index 30a36423c3..bac2825c11 100644 --- a/doc/compute_temp_partial.html +++ b/doc/compute_temp_partial.html @@ -8,7 +8,7 @@ - compute temp/partial command — LAMMPS 15 May 2015 version documentation + compute temp/partial command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -234,7 +234,7 @@ vector values will be in energy

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with
    Sphinx using a theme provided by Read the Docs. @@ -255,7 +255,7 @@ vector values will be in energy @@ -230,10 +230,10 @@ constrain molecular motion, such as compute_modify command.

    -
    -

    Warning

    -

    When using the out keyword with a value of bin, -the calculated temperature for each bin does not include the +

    +

    Note

    +

    When using the out keyword with a value of bin, the +calculated temperature for each bin does not include the degrees-of-freedom adjustment described in the preceeding paragraph, for fixes that constrain molecular motion. It does include the adjustment due to the extra option, which is applied to each bin.

    @@ -297,7 +297,7 @@ will be for most thermostats.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -318,7 +318,7 @@ will be for most thermostats.

    @@ -235,7 +235,7 @@ vector values will be in energy

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with
    Sphinx using a theme provided by Read the Docs. @@ -256,7 +256,7 @@ vector values will be in energy @@ -227,7 +227,7 @@ vector values will be in energy

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with
    Sphinx using a theme provided by Read the Docs. @@ -248,7 +248,7 @@ vector values will be in energy @@ -187,7 +187,7 @@ LAMMPS was built with that package. See the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -208,7 +208,7 @@ LAMMPS was built with that package. See the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/compute_temp_rotate.html b/doc/compute_temp_rotate.html index 12a91c06bd..8cb7116e8d 100644 --- a/doc/compute_temp_rotate.html +++ b/doc/compute_temp_rotate.html @@ -8,7 +8,7 @@ - compute temp/rotate command — LAMMPS 15 May 2015 version documentation + compute temp/rotate command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -213,7 +213,7 @@ LAMMPS was built with that package. See the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -234,7 +234,7 @@ LAMMPS was built with that package. See the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/compute_temp_sphere.html b/doc/compute_temp_sphere.html index 9ab8592083..caabd6e85c 100644 --- a/doc/compute_temp_sphere.html +++ b/doc/compute_temp_sphere.html @@ -8,7 +8,7 @@ - compute temp/sphere command — LAMMPS 15 May 2015 version documentation + compute temp/sphere command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -165,10 +165,10 @@ Point particles do not rotate, so they have only 3 translational degrees of freedom. For 3d spherical particles, each has 6 degrees of freedom (3 translational, 3 rotational). For 2d spherical particles, each has 3 degrees of freedom (2 translational, 1 rotational).

    -
    -

    Warning

    -

    This choice for degrees of freedom (dof) assumes that -all finite-size spherical particles in your model will freely rotate, +

    +

    Note

    +

    This choice for degrees of freedom (dof) assumes that all +finite-size spherical particles in your model will freely rotate, sampling all their rotational dof. It is possible to use a combination of interaction potentials and fixes that induce no torque or otherwise constrain some of all of your particles so that this is @@ -180,11 +180,11 @@ accordingly.

    by the
    compute temp command. The rotational kinetic energy is computed as 1/2 I w^2, where I is the moment of inertia for a sphere and w is the particle’s angular velocity.

    -
    -

    Warning

    -

    For 2d models, particles are treated -as spheres, not disks, meaning their moment of inertia will be the -same as in 3d.

    +
    +

    Note

    +

    For 2d models, particles are treated as +spheres, not disks, meaning their moment of inertia will be the same +as in 3d.

    A kinetic energy tensor, stored as a 6-element vector, is also calculated by this compute. The formula for the components of the @@ -257,7 +257,7 @@ particles with radius = 0.0.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -278,7 +278,7 @@ particles with radius = 0.0.

    @@ -252,7 +252,7 @@ LAMMPS was built with that package. See the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -273,7 +273,7 @@ LAMMPS was built with that package. See the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/compute_torque_chunk.html b/doc/compute_torque_chunk.html index 918f60d3ca..03e9585c70 100644 --- a/doc/compute_torque_chunk.html +++ b/doc/compute_torque_chunk.html @@ -8,7 +8,7 @@ - compute torque/chunk command — LAMMPS 15 May 2015 version documentation + compute torque/chunk command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -164,12 +164,12 @@ in that group, signifying they are not assigned to a chunk, and will thus also not contribute to this calculation. You can specify the “all” group for this command if you simply want to include atoms with non-zero chunk IDs.

    -
    -

    Warning

    -

    The coordinates of an atom contribute to the chunk’s -torque in “unwrapped” form, by using the image flags associated with -each atom. See the dump custom command for a discussion -of “unwrapped” coordinates. See the Atoms section of the +

    +

    Note

    +

    The coordinates of an atom contribute to the chunk’s torque in +“unwrapped” form, by using the image flags associated with each atom. +See the dump custom command for a discussion of +“unwrapped” coordinates. See the Atoms section of the read_data command for a discussion of image flags and how they are set for each atom. You can reset the image flags (e.g. to 0) before invoking this compute by using the set image command.

    @@ -214,7 +214,7 @@ force-distance units

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -235,7 +235,7 @@ force-distance units var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/compute_torque_chunk.txt b/doc/compute_torque_chunk.txt index df27c39a9e..012c55813a 100644 --- a/doc/compute_torque_chunk.txt +++ b/doc/compute_torque_chunk.txt @@ -48,10 +48,10 @@ thus also not contribute to this calculation. You can specify the "all" group for this command if you simply want to include atoms with non-zero chunk IDs. -IMPORTANT NOTE: The coordinates of an atom contribute to the chunk's -torque in "unwrapped" form, by using the image flags associated with -each atom. See the "dump custom"_dump.html command for a discussion -of "unwrapped" coordinates. See the Atoms section of the +NOTE: The coordinates of an atom contribute to the chunk's torque in +"unwrapped" form, by using the image flags associated with each atom. +See the "dump custom"_dump.html command for a discussion of +"unwrapped" coordinates. See the Atoms section of the "read_data"_read_data.html command for a discussion of image flags and how they are set for each atom. You can reset the image flags (e.g. to 0) before invoking this compute by using the "set diff --git a/doc/compute_vacf.html b/doc/compute_vacf.html index 07f63e0870..eb37516759 100644 --- a/doc/compute_vacf.html +++ b/doc/compute_vacf.html @@ -8,7 +8,7 @@ - compute vacf command — LAMMPS 15 May 2015 version documentation + compute vacf command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -165,12 +165,12 @@ variable diff equal dt*trap(f_5) thermo_style custom step v_diff
    -
    -

    Warning

    -

    If you want the quantities calculated by this compute -to be continuous when running from a restart file, -then you should use the same ID for this compute, as in the original -run. This is so that the fix this compute creates to store per-atom +

    +

    Note

    +

    If you want the quantities calculated by this compute to be +continuous when running from a restart file, then +you should use the same ID for this compute, as in the original run. +This is so that the fix this compute creates to store per-atom quantities will also have the same ID, and thus be initialized correctly with time=0 atom velocities from the restart file.

    @@ -204,7 +204,7 @@ velocity^2 units.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -225,7 +225,7 @@ velocity^2 units. var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/compute_vacf.txt b/doc/compute_vacf.txt index e8563b77db..29ada25c9c 100644 --- a/doc/compute_vacf.txt +++ b/doc/compute_vacf.txt @@ -44,10 +44,10 @@ fix 5 all vector 1 c_2\[4\] variable diff equal dt*trap(f_5) thermo_style custom step v_diff :pre -IMPORTANT NOTE: If you want the quantities calculated by this compute -to be continuous when running from a "restart file"_read_restart.html, -then you should use the same ID for this compute, as in the original -run. This is so that the fix this compute creates to store per-atom +NOTE: If you want the quantities calculated by this compute to be +continuous when running from a "restart file"_read_restart.html, then +you should use the same ID for this compute, as in the original run. +This is so that the fix this compute creates to store per-atom quantities will also have the same ID, and thus be initialized correctly with time=0 atom velocities from the restart file. diff --git a/doc/compute_vcm_chunk.html b/doc/compute_vcm_chunk.html index 346f67ce6a..61f5deef5f 100644 --- a/doc/compute_vcm_chunk.html +++ b/doc/compute_vcm_chunk.html @@ -8,7 +8,7 @@ - compute vcm/chunk command — LAMMPS 15 May 2015 version documentation + compute vcm/chunk command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -201,7 +201,7 @@ velocity units.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -222,7 +222,7 @@ velocity units.

    @@ -236,10 +236,10 @@ data can be used to identify interstitial atoms.

    which must be installed on your system when building LAMMPS for use with this compute. See instructions on obtaining and installing the Voro++ software in the src/VORONOI/README file.

    -
    -

    Warning

    -

    The calculation of Voronoi volumes is performed by -each processor for the atoms it owns, and includes the effect of ghost +

    +

    Note

    +

    The calculation of Voronoi volumes is performed by each +processor for the atoms it owns, and includes the effect of ghost atoms stored by the processor. This assumes that the Voronoi cells of owned atoms are not affected by atoms beyond the ghost atom cut-off distance. This is usually a good assumption for liquid and solid @@ -249,16 +249,16 @@ processor is determined by the cutoff used for pair_style interactions. The cutoff can be set explicitly via the comm_modify cutoff command.

    -
    -

    Warning

    -

    The Voro++ package performs its calculation in 3d. -This should still work for a 2d LAMMPS simulation, to effectively -compute Voronoi “areas”, so long as the z-dimension of the box is -roughly the same (or smaller) compared to the separation of the atoms. -Typical values for the z box dimensions in a 2d LAMMPS model are -0.5 -to 0.5, which satisfies the criterion for most units -systems. Note that you define the z extent of the simulation box for -2d simulations when using the create_box or +

    +

    Note

    +

    The Voro++ package performs its calculation in 3d. This should +still work for a 2d LAMMPS simulation, to effectively compute Voronoi +“areas”, so long as the z-dimension of the box is roughly the same (or +smaller) compared to the separation of the atoms. Typical values for +the z box dimensions in a 2d LAMMPS model are -0.5 to 0.5, which +satisfies the criterion for most units systems. Note +that you define the z extent of the simulation box for 2d simulations +when using the create_box or read_data commands.

    Output info:

    @@ -293,7 +293,7 @@ LAMMPS was built with that package. See the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -314,7 +314,7 @@ LAMMPS was built with that package. See the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/compute_voronoi_atom.txt b/doc/compute_voronoi_atom.txt index ae1d71fb82..e39b97fe96 100644 --- a/doc/compute_voronoi_atom.txt +++ b/doc/compute_voronoi_atom.txt @@ -125,8 +125,8 @@ Voro++ software in the src/VORONOI/README file. :link(voronoi,http://math.lbl.gov/voro++) -IMPORTANT NOTE: The calculation of Voronoi volumes is performed by -each processor for the atoms it owns, and includes the effect of ghost +NOTE: The calculation of Voronoi volumes is performed by each +processor for the atoms it owns, and includes the effect of ghost atoms stored by the processor. This assumes that the Voronoi cells of owned atoms are not affected by atoms beyond the ghost atom cut-off distance. This is usually a good assumption for liquid and solid @@ -136,14 +136,14 @@ processor is determined by the cutoff used for "pair_style"_pair_style.html interactions. The cutoff can be set explicitly via the "comm_modify cutoff"_comm_modify.html command. -IMPORTANT NOTE: The Voro++ package performs its calculation in 3d. -This should still work for a 2d LAMMPS simulation, to effectively -compute Voronoi "areas", so long as the z-dimension of the box is -roughly the same (or smaller) compared to the separation of the atoms. -Typical values for the z box dimensions in a 2d LAMMPS model are -0.5 -to 0.5, which satisfies the criterion for most "units"_units.html -systems. Note that you define the z extent of the simulation box for -2d simulations when using the "create_box"_create_box.html or +NOTE: The Voro++ package performs its calculation in 3d. This should +still work for a 2d LAMMPS simulation, to effectively compute Voronoi +"areas", so long as the z-dimension of the box is roughly the same (or +smaller) compared to the separation of the atoms. Typical values for +the z box dimensions in a 2d LAMMPS model are -0.5 to 0.5, which +satisfies the criterion for most "units"_units.html systems. Note +that you define the z extent of the simulation box for 2d simulations +when using the "create_box"_create_box.html or "read_data"_read_data.html commands. [Output info:] diff --git a/doc/compute_xrd.html b/doc/compute_xrd.html index ab52cca0c1..853d7d55d5 100644 --- a/doc/compute_xrd.html +++ b/doc/compute_xrd.html @@ -8,7 +8,7 @@ - compute xrd command — LAMMPS 15 May 2015 version documentation + compute xrd command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -167,7 +167,7 @@ fix 2 all ave/histo/weight 1 1 1 10 100 250 c_2[1] c_2[2] mode vector file Deg2T

    Description

    Define a computation that calculates x-ray diffraction intensity as described -in (Coleman) on a mesh of reciprocal lattice nodes defined +in (Coleman) on a mesh of reciprocal lattice nodes defined by the entire simulation domain (or manually) using a simulated radiation of wavelength lambda.

    The x-ray diffraction intensity, I, at each reciprocal lattice point, k, @@ -335,7 +335,7 @@ Volume C: Mathematical and Chemical Tables, 249-429 (2004).

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -356,7 +356,7 @@ Volume C: Mathematical and Chemical Tables, 249-429 (2004).

    @@ -233,14 +233,13 @@ inside the simulation box and is also consistent with the region volume. See the region command for details. Note that a region can be specified so that its “volume” is either inside or outside a geometric boundary.

    -
    -

    Warning

    -

    Particles generated by the random style will -typically be highly overlapped which will cause many interatomic -potentials to compute large energies and forces. Thus you should -either perform an energy minimization or run dynamics -with fix nve/limit to equilibrate such a system, -before running normal dynamics.

    +
    +

    Note

    +

    Particles generated by the random style will typically be +highly overlapped which will cause many interatomic potentials to +compute large energies and forces. Thus you should either perform an +energy minimization or run dynamics with fix nve/limit to equilibrate such a system, before +running normal dynamics.

    Note that this command adds particles to those that already exist. This means it can be used to add particles to a system previously read @@ -281,15 +280,15 @@ created in parallel.

    Also note that because of the random rotations, it may be important to use a lattice with a large enough spacing that adjacent molecules will not overlap, regardless of their relative orientations.

    -
    -

    Warning

    -

    If the create_box command is used to -create the simulation box, followed by the create_atoms command with -its mol option for adding molecules, then you typically need to use -the optional keywords allowed by the create_box -command for extra bonds (angles,etc) or extra special neighbors. This -is because by default, the create_box command sets -up a non-molecular system which doesn’t allow molecules to be added.

    +
    +

    Note

    +

    If the create_box command is used to create +the simulation box, followed by the create_atoms command with its +mol option for adding molecules, then you typically need to use the +optional keywords allowed by the create_box command +for extra bonds (angles,etc) or extra special neighbors. This is +because by default, the create_box command sets up a +non-molecular system which doesn’t allow molecules to be added.


    This is the meaning of the other allowed keywords.

    @@ -440,7 +439,7 @@ random, and units = lattice.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -461,7 +460,7 @@ random, and units = lattice.

    @@ -199,20 +199,19 @@ similar to what a run executes, e.g. if you wish to use long-range Coulombic interactions via the kspace_style command for your subsequent simulation.

    -
    -

    Warning

    -

    If the system has no bonds to begin with, or if more -bonds per atom are being added than currently exist, then you must -insure that the number of bond types and the maximum number of bonds -per atom are set to large enough values. Otherwise an error may occur -when too many bonds are added to an atom. If the -read_data command is used to define the system, these -2 parameters can be set via the “bond types” and “extra bond per atom” -fields in the header section of the data file. If the -create_box command is used to define the system, -these 2 parameters can be set via its optional “bond/types” and -“extra/bond/per/atom” arguments. See the doc pages for the 2 commands -for details.

    +
    +

    Note

    +

    If the system has no bonds to begin with, or if more bonds per +atom are being added than currently exist, then you must insure that +the number of bond types and the maximum number of bonds per atom are +set to large enough values. Otherwise an error may occur when too +many bonds are added to an atom. If the read_data +command is used to define the system, these 2 parameters can be set +via the “bond types” and “extra bond per atom” fields in the header +section of the data file. If the create_box command +is used to define the system, these 2 parameters can be set via its +optional “bond/types” and “extra/bond/per/atom” arguments. See the +doc pages for the 2 commands for details.

    @@ -238,7 +237,7 @@ molecule template files via the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -259,7 +258,7 @@ molecule template files via the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/create_bonds.txt b/doc/create_bonds.txt index dd48a019d4..f5a4c1f505 100644 --- a/doc/create_bonds.txt +++ b/doc/create_bonds.txt @@ -83,18 +83,17 @@ executes, e.g. if you wish to use long-range Coulombic interactions via the "kspace_style"_kspace_style.html command for your subsequent simulation. -IMPORTANT NOTE: If the system has no bonds to begin with, or if more -bonds per atom are being added than currently exist, then you must -insure that the number of bond types and the maximum number of bonds -per atom are set to large enough values. Otherwise an error may occur -when too many bonds are added to an atom. If the -"read_data"_read_data.html command is used to define the system, these -2 parameters can be set via the "bond types" and "extra bond per atom" -fields in the header section of the data file. If the -"create_box"_create_box.html command is used to define the system, -these 2 parameters can be set via its optional "bond/types" and -"extra/bond/per/atom" arguments. See the doc pages for the 2 commands -for details. +NOTE: If the system has no bonds to begin with, or if more bonds per +atom are being added than currently exist, then you must insure that +the number of bond types and the maximum number of bonds per atom are +set to large enough values. Otherwise an error may occur when too +many bonds are added to an atom. If the "read_data"_read_data.html +command is used to define the system, these 2 parameters can be set +via the "bond types" and "extra bond per atom" fields in the header +section of the data file. If the "create_box"_create_box.html command +is used to define the system, these 2 parameters can be set via its +optional "bond/types" and "extra/bond/per/atom" arguments. See the +doc pages for the 2 commands for details. [Restrictions:] diff --git a/doc/create_box.html b/doc/create_box.html index 4cc3efffed..fc7f65bc00 100644 --- a/doc/create_box.html +++ b/doc/create_box.html @@ -8,7 +8,7 @@ - create_box command — LAMMPS 15 May 2015 version documentation + create_box command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -210,10 +210,10 @@ be triclinic, even if the tilt factors are initially 0.0. You can also change an orthogonal box to a triclinic box or vice versa by using the change box command with its ortho and triclinic options.

    -
    -

    Warning

    -

    If the system is non-periodic (in a dimension), then -you should not make the lo/hi box dimensions (as defined in your +

    +

    Note

    +

    If the system is non-periodic (in a dimension), then you should +not make the lo/hi box dimensions (as defined in your region command) radically smaller/larger than the extent of the atoms you eventually plan to create, e.g. via the create_atoms command. For example, if your atoms @@ -272,7 +272,7 @@ been previously defined to use this command.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -293,7 +293,7 @@ been previously defined to use this command.

    @@ -225,12 +225,12 @@ deleted, all other atoms in the same molecule (with the same molecule ID) will also be deleted. This is not done for atoms with molecule ID = 0, since such an ID is assumed to flag isolated atoms that are not part of molecules.

    -
    -

    Warning

    -

    The molecule deletion operation in invoked after all -individual atoms have been deleted using the rules described above for -each style. This means additional atoms may be deleted that are not -in the group or region, that are not required by the overlap cutoff +

    +

    Note

    +

    The molecule deletion operation in invoked after all individual +atoms have been deleted using the rules described above for each +style. This means additional atoms may be deleted that are not in the +group or region, that are not required by the overlap cutoff criterion, or that will create a higher fraction of porosity than was requested.

    @@ -274,7 +274,7 @@ using molecule template files via the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -295,7 +295,7 @@ using molecule template files via the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/delete_atoms.txt b/doc/delete_atoms.txt index 7c29d8b8af..f3dfc7eba9 100644 --- a/doc/delete_atoms.txt +++ b/doc/delete_atoms.txt @@ -107,10 +107,10 @@ ID) will also be deleted. This is not done for atoms with molecule ID = 0, since such an ID is assumed to flag isolated atoms that are not part of molecules. -IMPORTANT NOTE: The molecule deletion operation in invoked after all -individual atoms have been deleted using the rules described above for -each style. This means additional atoms may be deleted that are not -in the group or region, that are not required by the overlap cutoff +NOTE: The molecule deletion operation in invoked after all individual +atoms have been deleted using the rules described above for each +style. This means additional atoms may be deleted that are not in the +group or region, that are not required by the overlap cutoff criterion, or that will create a higher fraction of porosity than was requested. diff --git a/doc/delete_bonds.html b/doc/delete_bonds.html index 551efffd99..2e49d46bef 100644 --- a/doc/delete_bonds.html +++ b/doc/delete_bonds.html @@ -8,7 +8,7 @@ - delete_bonds command — LAMMPS 15 May 2015 version documentation + delete_bonds command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -273,7 +273,7 @@ which case you probably should be recomputing the weighting list.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with
    Sphinx using a theme provided by Read the Docs. @@ -294,7 +294,7 @@ which case you probably should be recomputing the weighting list.

    @@ -178,7 +178,7 @@ details.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -199,7 +199,7 @@ details.

    @@ -231,7 +231,7 @@ Fischer, Gao, Guo, Ha, et al, J Phys Chem B, 102, 3586 (1998).

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -252,7 +252,7 @@ Fischer, Gao, Guo, Ha, et al, J Phys Chem B, 102, 3586 (1998).

    @@ -294,7 +294,7 @@ section for more info on packages.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -315,7 +315,7 @@ section for more info on packages.

    @@ -179,16 +179,16 @@ corresponds to the 1st example above would be listed as

    this rule, in that an additional argument is used in the input script to allow specification of the cross-term coefficients. See its doc page for details.

    -
    -

    Warning

    -

    When comparing the formulas and coefficients for -various LAMMPS dihedral styles with dihedral equations defined by -other force fields, note that some force field implementations -divide/multiply the energy prefactor K by the multiple number of -torsions that contain the J-K bond in an I-J-K-L torsion. LAMMPS does -not do this, i.e. the listed dihedral equation applies to each -individual dihedral. Thus you need to define K appropriately to -account for this difference if necessary.

    +
    +

    Note

    +

    When comparing the formulas and coefficients for various LAMMPS +dihedral styles with dihedral equations defined by other force fields, +note that some force field implementations divide/multiply the energy +prefactor K by the multiple number of torsions that contain the J-K +bond in an I-J-K-L torsion. LAMMPS does not do this, i.e. the listed +dihedral equation applies to each individual dihedral. Thus you need +to define K appropriately to account for this difference if +necessary.


    Here is an alphabetic list of dihedral styles defined in LAMMPS. Click on @@ -235,7 +235,7 @@ set, either in the input script or in a data file.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -256,7 +256,7 @@ set, either in the input script or in a data file.

    @@ -208,7 +208,7 @@ section for more info on packages.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -229,7 +229,7 @@ section for more info on packages.

    @@ -201,7 +201,7 @@ section for more info on packages.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -222,7 +222,7 @@ section for more info on packages.

    @@ -155,12 +155,12 @@ or read_restart<
  • d (+1 or -1)
  • n (integer >= 0)
  • -
    Built with Sphinx using a theme provided by Read the Docs. @@ -230,7 +230,7 @@ MOLECULE package (which it is by default). See the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/dihedral_harmonic.txt b/doc/dihedral_harmonic.txt index bd684f9045..7785db69e0 100644 --- a/doc/dihedral_harmonic.txt +++ b/doc/dihedral_harmonic.txt @@ -33,10 +33,10 @@ K (energy) d (+1 or -1) n (integer >= 0) :ul -IMPORTANT NOTE: Here are important points to take note of when -defining LAMMPS dihedral coefficients for the harmonic style, so that -they are compatible with how harmonic dihedrals are defined by other -force fields: +NOTE: Here are important points to take note of when defining LAMMPS +dihedral coefficients for the harmonic style, so that they are +compatible with how harmonic dihedrals are defined by other force +fields: The LAMMPS convention is that the trans position = 180 degrees, while in some force fields trans = 0 degrees. :ulb,l diff --git a/doc/dihedral_helix.html b/doc/dihedral_helix.html index 1969d84e5a..6a8bb4eb8f 100644 --- a/doc/dihedral_helix.html +++ b/doc/dihedral_helix.html @@ -8,7 +8,7 @@ - dihedral_style helix command — LAMMPS 15 May 2015 version documentation + dihedral_style helix command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -204,7 +204,7 @@ MOLECULE package (which it is by default). See the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -225,7 +225,7 @@ MOLECULE package (which it is by default). See the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/dihedral_hybrid.html b/doc/dihedral_hybrid.html index c1910ad46b..4d86fee59d 100644 --- a/doc/dihedral_hybrid.html +++ b/doc/dihedral_hybrid.html @@ -8,7 +8,7 @@ - dihedral_style hybrid command — LAMMPS 15 May 2015 version documentation + dihedral_style hybrid command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -220,7 +220,7 @@ restart file, you need to re-specify dihedral_coeff commands.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with
    Sphinx using a theme provided by Read the Docs. @@ -241,7 +241,7 @@ restart file, you need to re-specify dihedral_coeff commands.

    @@ -197,7 +197,7 @@ MOLECULE package (which it is by default). See the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -218,7 +218,7 @@ MOLECULE package (which it is by default). See the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/dihedral_nharmonic.html b/doc/dihedral_nharmonic.html index 6450ec8f03..492758c33b 100644 --- a/doc/dihedral_nharmonic.html +++ b/doc/dihedral_nharmonic.html @@ -8,7 +8,7 @@ - dihedral_style nharmonic command — LAMMPS 15 May 2015 version documentation + dihedral_style nharmonic command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -198,7 +198,7 @@ section for more info on packages.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with
    Sphinx using a theme provided by Read the Docs. @@ -219,7 +219,7 @@ section for more info on packages.

    @@ -163,7 +163,7 @@ data file read by the re

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with
    Sphinx using a theme provided by Read the Docs. @@ -184,7 +184,7 @@ data file read by the re @@ -206,7 +206,7 @@ MOLECULE package (which it is by default). See the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -227,7 +227,7 @@ MOLECULE package (which it is by default). See the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/dihedral_quadratic.html b/doc/dihedral_quadratic.html index 6faaab69f4..5d3628e720 100644 --- a/doc/dihedral_quadratic.html +++ b/doc/dihedral_quadratic.html @@ -8,7 +8,7 @@ - dihedral_style quadratic command — LAMMPS 15 May 2015 version documentation + dihedral_style quadratic command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -198,7 +198,7 @@ section for more info on packages.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with
    Sphinx using a theme provided by Read the Docs. @@ -219,7 +219,7 @@ section for more info on packages.

    @@ -163,8 +163,8 @@ re-specified in an input script that restarts a simulation. See the this. The one exception is that dihedral_style hybrid only stores the list of sub-styles in the restart file; dihedral coefficients need to be re-specified.

    -
    -

    Warning

    +
    +

    Note

    When both a dihedral and pair style is defined, the special_bonds command often needs to be used to turn off (or weight) the pairwise interaction that would otherwise @@ -180,16 +180,16 @@ is from left to right.

    below (e.g. charmm, helix) in the sense that the energy formula depends on the sign of phi, which may be reflected in the value of the coefficients you specify.

    -
    -

    Warning

    -

    When comparing the formulas and coefficients for -various LAMMPS dihedral styles with dihedral equations defined by -other force fields, note that some force field implementations -divide/multiply the energy prefactor K by the multiple number of -torsions that contain the J-K bond in an I-J-K-L torsion. LAMMPS does -not do this, i.e. the listed dihedral equation applies to each -individual dihedral. Thus you need to define K appropriately via -the dihedral_coeff command to account for this +

    +

    Note

    +

    When comparing the formulas and coefficients for various LAMMPS +dihedral styles with dihedral equations defined by other force fields, +note that some force field implementations divide/multiply the energy +prefactor K by the multiple number of torsions that contain the J-K +bond in an I-J-K-L torsion. LAMMPS does not do this, i.e. the listed +dihedral equation applies to each individual dihedral. Thus you need +to define K appropriately via the +dihedral_coeff command to account for this difference if necessary.


    @@ -241,7 +241,7 @@ a package.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -262,7 +262,7 @@ a package.

    @@ -321,7 +321,7 @@ section for more info on packages.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -342,7 +342,7 @@ section for more info on packages.

    @@ -150,12 +150,12 @@ prior to setting up a simulation box via the Restart files also store this setting.

    See the discussion in Section_howto for additional instructions on how to run 2d simulations.

    -
    -

    Warning

    -

    Some models in LAMMPS treat particles as finite-size -spheres or ellipsoids, as opposed to point particles. In 2d, the -particles will still be spheres or ellipsoids, not circular disks or -ellipses, meaning their moment of inertia will be the same as in 3d.

    +
    +

    Note

    +

    Some models in LAMMPS treat particles as finite-size spheres or +ellipsoids, as opposed to point particles. In 2d, the particles will +still be spheres or ellipsoids, not circular disks or ellipses, +meaning their moment of inertia will be the same as in 3d.

    @@ -185,7 +185,7 @@ ellipses, meaning their moment of inertia will be the same as in 3d.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -206,7 +206,7 @@ ellipses, meaning their moment of inertia will be the same as in 3d.

    @@ -218,27 +218,27 @@ style are determined by the setting of box or lattice for the lattice command must have been previously used to define the lattice spacing.


    -
    -

    Warning

    -

    Care should be taken not to move atoms on top of other -atoms. After the move, atoms are remapped into the periodic -simulation box if needed, and any shrink-wrap boundary conditions (see -the boundary command) are enforced which may change -the box size. Other than this effect, this command does not change -the size or shape of the simulation box. See the +

    +

    Note

    +

    Care should be taken not to move atoms on top of other atoms. +After the move, atoms are remapped into the periodic simulation box if +needed, and any shrink-wrap boundary conditions (see the +boundary command) are enforced which may change the +box size. Other than this effect, this command does not change the +size or shape of the simulation box. See the change_box command if that effect is desired.

    -
    -

    Warning

    -

    Atoms can be moved arbitrarily long distances by this -command. If the simulation box is non-periodic and shrink-wrapped -(see the boundary command), this can change its size -or shape. This is not a problem, except that the mapping of -processors to the simulation box is not changed by this command from -its initial 3d configuration; see the processors -command. Thus, if the box size/shape changes dramatically, the -mapping of processors to the simulation box may not end up as optimal -as the initial mapping attempted to be.

    +
    +

    Note

    +

    Atoms can be moved arbitrarily long distances by this command. +If the simulation box is non-periodic and shrink-wrapped (see the +boundary command), this can change its size or shape. +This is not a problem, except that the mapping of processors to the +simulation box is not changed by this command from its initial 3d +configuration; see the processors command. Thus, if +the box size/shape changes dramatically, the mapping of processors to +the simulation box may not end up as optimal as the initial mapping +attempted to be.


    @@ -268,7 +268,7 @@ as the initial mapping attempted to be.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -289,7 +289,7 @@ as the initial mapping attempted to be.

    @@ -263,17 +263,16 @@ options; see details below.

    As described below, the filename determines the kind of output (text or binary or gzipped, one big file or one per timestep, one big file or multiple smaller files).

    -
    -

    Warning

    -

    Because periodic boundary conditions are enforced only -on timesteps when neighbor lists are rebuilt, the coordinates of an -atom written to a dump file may be slightly outside the simulation -box.

    +
    +

    Note

    +

    Because periodic boundary conditions are enforced only on +timesteps when neighbor lists are rebuilt, the coordinates of an atom +written to a dump file may be slightly outside the simulation box.

    -
    -

    Warning

    -

    Unless the dump_modify sort option -is invoked, the lines of atom information written to dump files +

    +

    Note

    +

    Unless the dump_modify sort option is +invoked, the lines of atom information written to dump files (typically one line per atom) will be in an indeterminate order for each snapshot. This is even true when running on a single processor, if the atom_modify sort option is on, which it is @@ -716,7 +715,7 @@ machines.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -737,7 +736,7 @@ machines.

    @@ -186,12 +186,11 @@ subinterval is needed as it must be present at the same interval as box information (edges in each dimension) is stored at the same interval than the position element, if present. Else it is stored every N steps.

    -
    -

    Warning

    -

    Because periodic boundary conditions are enforced only -on timesteps when neighbor lists are rebuilt, the coordinates of an -atom written to a dump file may be slightly outside the simulation -box.

    +
    +

    Note

    +

    Because periodic boundary conditions are enforced only on +timesteps when neighbor lists are rebuilt, the coordinates of an atom +written to a dump file may be slightly outside the simulation box.

    Use from write_dump:

    It is possible to use this dump style with the @@ -244,7 +243,7 @@ Comp. Phys. Comm. 185(6), 1546-1553 (2014) -

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -265,7 +264,7 @@ Comp. Phys. Comm. 185(6), 1546-1553 (2014) - @@ -263,11 +263,11 @@ support for the corresponding JPEG or PNG library. To convert images into movies, LAMMPS has to be compiled with the -DLAMMPS_FFMPEG flag. See this section of the manual for instructions on how to do this.

    -
    -

    Warning

    -

    Because periodic boundary conditions are enforced only -on timesteps when neighbor lists are rebuilt, the coordinates of an -atom in the image may be slightly outside the simulation box.

    +
    +

    Note

    +

    Because periodic boundary conditions are enforced only on +timesteps when neighbor lists are rebuilt, the coordinates of an atom +in the image may be slightly outside the simulation box.


    Dumps are performed on timesteps that are a multiple of N (including @@ -450,8 +450,8 @@ which is an orthographic rendering with no persepctive. A pfactor value between 0.0 and 1.0 will introduce more perspective. A pfactor value > 1 will create a highly skewed image with a large amount of perspective.

    -
    -

    Warning

    +
    +

    Note

    The persp keyword is not yet supported as an option.


    @@ -656,7 +656,7 @@ mp4).

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -677,7 +677,7 @@ mp4).

    @@ -327,18 +327,18 @@ dump 1 all atom 100 tmp.dump dump_modify 1 every v_s
    -
    -

    Warning

    -

    When using a file-style variable with the every -keyword, the file of timesteps must list a first timestep that is -beyond the current timestep (e.g. it cannot be 0). And it must list -one or more timesteps beyond the length of the run you perform. This -is because the dump command will generate an error if the next -timestep it reads from the file is not a value greater than the -current timestep. Thus if you wanted output on steps 0,15,100 of a -100-timestep run, the file should contain the values 15,100,101 and -you should also use the dump_modify first command. Any final value > -100 could be used in place of 101.

    +
    +

    Note

    +

    When using a file-style variable with the every keyword, the +file of timesteps must list a first timestep that is beyond the +current timestep (e.g. it cannot be 0). And it must list one or more +timesteps beyond the length of the run you perform. This is because +the dump command will generate an error if the next timestep it reads +from the file is not a value greater than the current timestep. Thus +if you wanted output on steps 0,15,100 of a 100-timestep run, the file +should contain the values 15,100,101 and you should also use the +dump_modify first command. Any final value > 100 could be used in +place of 101.


    The first keyword determines whether a dump snapshot is written on @@ -364,14 +364,14 @@ character in the format string. This option has no effect on the for the cfg style, the first two fields (atom id and type) are not actually written into the CFG file, though you must include formats for them in the format string.

    -
    -

    Warning

    -

    Any value written to a text-based dump file that is a -per-atom quantity calculated by a compute or -fix is stored internally as a floating-point value. If the -value is actually an integer and you wish it to appear in the text -dump file as a (large) integer, then you need to use an appropriate -format. For example, these commands:

    +
    +

    Note

    +

    Any value written to a text-based dump file that is a per-atom +quantity calculated by a compute or fix is +stored internally as a floating-point value. If the value is actually +an integer and you wish it to appear in the text dump file as a +(large) integer, then you need to use an appropriate format. For +example, these commands:

    compute     1 all property/local batom1 batom2
     dump        1 all local 100 tmp.bonds index c_1[1] c_1[2]
    @@ -484,11 +484,11 @@ as dcd and xtc, require sorting by atom ID to format the outpu
     file correctly.  If multiple processors are writing the dump file, via
     the “%” wildcard in the dump filename, then sorting cannot be
     performed.

    -
    -

    Warning

    -

    Unless it is required by the dump style, sorting dump -file output requires extra overhead in terms of CPU and communication -cost, as well as memory, versus unsorted output.

    +
    +

    Note

    +

    Unless it is required by the dump style, sorting dump file +output requires extra overhead in terms of CPU and communication cost, +as well as memory, versus unsorted output.


    The thresh keyword only applies to the dump custom, cfg, @@ -697,10 +697,10 @@ compression and will result in higher quality movies. The quality is also determined by the compression format and encoder. The default setting is 2000 kbit/s, which will result in average quality with older compression formats.

    -
    -

    Warning

    -

    Not all movie file formats supported by dump movie -allow the bitrate to be set. If not, the setting is silently ignored.

    +
    +

    Note

    +

    Not all movie file formats supported by dump movie allow the +bitrate to be set. If not, the setting is silently ignored.


    The boxcolor keyword sets the color of the simulation box drawn @@ -990,7 +990,7 @@ Divide each value by 255 to get the equivalent 0.0 to 1.0 value.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -1011,7 +1011,7 @@ Divide each value by 255 to get the equivalent 0.0 to 1.0 value.

    @@ -164,12 +164,11 @@ files.

    to one single file with the specified format. Otherwise there will be one file per snapshot and the * will be replaced by the time step number when the snapshot is written.

    -
    -

    Warning

    -

    Because periodic boundary conditions are enforced only -on timesteps when neighbor lists are rebuilt, the coordinates of an -atom written to a dump file may be slightly outside the simulation -box.

    +
    +

    Note

    +

    Because periodic boundary conditions are enforced only on +timesteps when neighbor lists are rebuilt, the coordinates of an atom +written to a dump file may be slightly outside the simulation box.

    The molfile plugin API has a few restrictions that have to be honored by this dump style: the number of atoms must not change, the atoms @@ -250,7 +249,7 @@ with a set of header files that are compatible with VMD 1.9 and 1.9.1

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -271,7 +270,7 @@ with a set of header files that are compatible with VMD 1.9 and 1.9.1 @@ -175,7 +175,7 @@ in place of this command.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -196,7 +196,7 @@ in place of this command.

    @@ -161,11 +161,11 @@ invoked in the order they were specified in the input script.

    The ID of a fix can only contain alphanumeric characters and underscores.

    Fixes can be deleted with the unfix command.

    -
    -

    Warning

    -

    The unfix command is the only way to turn -off a fix; simply specifying a new fix with a similar style will not -turn off the first one. This is especially important to realize for +

    +

    Note

    +

    The unfix command is the only way to turn off a +fix; simply specifying a new fix with a similar style will not turn +off the first one. This is especially important to realize for integration fixes. For example, using a fix nve command for a second run after using a fix nvt command for the first run, will not cancel out the NVT time integration @@ -394,7 +394,7 @@ The doc pages for individual fixes tell if it is part of a package.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -415,7 +415,7 @@ The doc pages for individual fixes tell if it is part of a package.

    @@ -275,11 +275,11 @@ meaning of these parameters:

    -
    -

    Warning

    -

    It is easy to add new potentials and their parameters -to this list. All it typically takes is adding an extract() method to -the pair_*.cpp file associated with the potential.

    +
    +

    Note

    +

    It is easy to add new potentials and their parameters to this +list. All it typically takes is adding an extract() method to the +pair_*.cpp file associated with the potential.

    Some parameters are global settings for the pair style, e.g. the viscosity setting “mu” for pair_style lubricate. @@ -357,11 +357,11 @@ specified as v_name, where name is the variable name. See the discussion above describing the formulas associated with equal-style variables. The new value is assigned to the corresponding attribute for all atoms in the fix group.

    -
    -

    Warning

    -

    The atom keyword works this way whether the scale -keyword is set to no or yes. I.e. the use of scale yes is not yet -supported by the atom keyword.

    +
    +

    Note

    +

    The atom keyword works this way whether the scale keyword is +set to no or yes. I.e. the use of scale yes is not yet supported +by the atom keyword.

    If the atom parameter is diameter and per-atom density and per-atom mass are defined for particles (e.g. atom_style granular), then the mass of each particle is also @@ -411,7 +411,7 @@ parameters on the outermost rRESPA level.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -432,7 +432,7 @@ parameters on the outermost rRESPA level.

    @@ -277,11 +277,11 @@ styles and their energy formulas for the meaning of these parameters:

    -
    -

    Warning

    -

    It is easy to add new potentials and their parameters -to this list. All it typically takes is adding an extract() method to -the pair_*.cpp file associated with the potential.

    +
    +

    Note

    +

    It is easy to add new potentials and their parameters to this +list. All it typically takes is adding an extract() method to the +pair_*.cpp file associated with the potential.

    Some parameters are global settings for the pair style, e.g. the viscosity setting “mu” for pair_style lubricate. @@ -410,7 +410,7 @@ This fix is not invoked during

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -431,7 +431,7 @@ This fix is not invoked during var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/fix_adapt_fep.txt b/doc/fix_adapt_fep.txt index 45b364a814..311e1cc4bc 100644 --- a/doc/fix_adapt_fep.txt +++ b/doc/fix_adapt_fep.txt @@ -122,9 +122,9 @@ styles and their energy formulas for the meaning of these parameters: "gauss"_pair_gauss.html: a: type pairs: "soft"_pair_soft.html: a: type pairs :tb(c=3,s=:) -IMPORTANT NOTE: It is easy to add new potentials and their parameters -to this list. All it typically takes is adding an extract() method to -the pair_*.cpp file associated with the potential. +NOTE: It is easy to add new potentials and their parameters to this +list. All it typically takes is adding an extract() method to the +pair_*.cpp file associated with the potential. Some parameters are global settings for the pair style, e.g. the viscosity setting "mu" for "pair_style lubricate"_pair_lubricate.html. diff --git a/doc/fix_addforce.html b/doc/fix_addforce.html index 203531229b..412dcfba43 100644 --- a/doc/fix_addforce.html +++ b/doc/fix_addforce.html @@ -8,7 +8,7 @@ - fix addforce command — LAMMPS 15 May 2015 version documentation + fix addforce command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -258,11 +258,11 @@ invoked by the minimize - @@ -291,7 +291,7 @@ the system (the quantity being minimized), you MUST enable the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -312,7 +312,7 @@ the system (the quantity being minimized), you MUST enable the @@ -214,7 +214,7 @@ LAMMPS was built with that package. See the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -235,7 +235,7 @@ LAMMPS was built with that package. See the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/fix_append_atoms.html b/doc/fix_append_atoms.html index 375d6dc713..9a1303a969 100644 --- a/doc/fix_append_atoms.html +++ b/doc/fix_append_atoms.html @@ -8,7 +8,7 @@ - fix append/atoms command — LAMMPS 15 May 2015 version documentation + fix append/atoms command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -236,7 +236,7 @@ added atoms are of type 1 unless the basis keyword is used.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with
    Sphinx using a theme provided by Read the Docs. @@ -257,7 +257,7 @@ added atoms are of type 1 unless the basis keyword is used.

    @@ -379,7 +379,7 @@ fix_modify AtC output nvtFE 100 text

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -400,7 +400,7 @@ fix_modify AtC output nvtFE 100 text @@ -302,7 +302,7 @@ L Zepeda-Ruiz, Phys. Rev. B, 85, 184203 (2012).

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -323,7 +323,7 @@ L Zepeda-Ruiz, Phys. Rev. B, 85, 184203 (2012).

    @@ -197,14 +197,14 @@ timestep 200, etc.

    self-explanatory. Note that other atom attributes can be used as inputs to this fix by using the compute property/atom command and then specifying an input value from that compute.

    -
    -

    Warning

    -

    The x,y,z attributes are values that are re-wrapped -inside the periodic box whenever an atom crosses a periodic boundary. -Thus if you time average an atom that spends half its time on either -side of the periodic box, you will get a value in the middle of the -box. If this is not what you want, consider averaging unwrapped -coordinates, which can be provided by the compute property/atom command via its xu,yu,zu +

    +

    Note

    +

    The x,y,z attributes are values that are re-wrapped inside the +periodic box whenever an atom crosses a periodic boundary. Thus if +you time average an atom that spends half its time on either side of +the periodic box, you will get a value in the middle of the box. If +this is not what you want, consider averaging unwrapped coordinates, +which can be provided by the compute property/atom command via its xu,yu,zu attributes.

    If a value begins with “c_”, a compute ID must follow which has been @@ -265,7 +265,7 @@ the run command. Thi

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -286,7 +286,7 @@ the run command. Thi @@ -191,7 +191,7 @@ fix 1 flow ave/chunk 100 5 1000 binchunk density/mass ave running fix 1 flow ave/chunk 100 5 1000 binchunk density/mass ave running
    -

    IMPORTANT NOTE:

    +

    NOTE:

    If you are trying to replace an older fix ave/spatial command with the newer, more flexible fix ave/chunk and compute chunk/atom commands, you simply need to split the fix ave/spatial arguments across the two new commands. For @@ -240,17 +240,17 @@ ones that can be used with this fix since all other styles of variable produce global quantities.

    The per-atom values of each input vector are summed and averaged independently of the per-atom values in other input vectors.

    -
    -

    Warning

    -

    This fix works by creating an array of size Nchunk -by Nvalues on each processor. Nchunk is the number of chunks which -is defined by the compute chunk/atom -command. Nvalues is the number of input values specified. Each -processor loops over its atoms, tallying its values to the appropriate -chunk. Then the entire array is summed across all processors. This -means that using a large number of chunks will incur an overhead in -memory and computational cost (summing across processors), so be -careful to define a reasonable number of chunks.

    +
    +

    Note

    +

    This fix works by creating an array of size Nchunk by Nvalues +on each processor. Nchunk is the number of chunks which is defined +by the compute chunk/atom command. +Nvalues is the number of input values specified. Each processor loops +over its atoms, tallying its values to the appropriate chunk. Then +the entire array is summed across all processors. This means that +using a large number of chunks will incur an overhead in memory and +computational cost (summing across processors), so be careful to +define a reasonable number of chunks.


    The Nevery, Nrepeat, and Nfreq arguments specify on what @@ -273,10 +273,10 @@ The way the averaging is done across the Nrepeat timesteps to produce output on the Nfreq timesteps, and across multiple Nfreq outputs, is determined by the norm and ave keyword settings, as discussed below.

    -
    -

    Warning

    -

    To perform per-chunk averaging within a Nfreq time -window, the number of chunks Nchunk defined by the compute chunk/atom command must remain constant. If +

    +

    Note

    +

    To perform per-chunk averaging within a Nfreq time window, the +number of chunks Nchunk defined by the compute chunk/atom command must remain constant. If the ave keyword is set to running or window then Nchunk must remain constant for the duration of the simulation. This fix forces the chunk/atom compute specified by chunkID to hold Nchunk constant @@ -527,7 +527,7 @@ title 1,2,3 = strings as described above.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -548,7 +548,7 @@ title 1,2,3 = strings as described above.

    @@ -428,7 +428,7 @@ output, title 1,2,3 = strings as described above, and prefactor = 1.0.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -449,7 +449,7 @@ output, title 1,2,3 = strings as described above, and prefactor = 1.0.

    @@ -262,7 +262,7 @@ A.E. Likhtman, J. Chem. Phys. 133, 154103 (2010).

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -283,7 +283,7 @@ A.E. Likhtman, J. Chem. Phys. 133, 154103 (2010).

    @@ -431,7 +431,7 @@ output, beyond = ignore, and title 1,2,3 = strings as described above.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -452,7 +452,7 @@ output, beyond = ignore, and title 1,2,3 = strings as described above.

    @@ -198,7 +198,7 @@ fix 1 flow ave/spatial 100 5 1000 z lower 1.0 y 0.0 2.5 density/mass ave running fix 1 flow ave/spatial 100 5 1000 z lower 1.0 y 0.0 2.5 density/mass bound y 5.0 20.0 discard yes ave running
    -

    IMPORTANT NOTE:

    +

    NOTE:

    The fix ave/spatial command has been replaced by the more flexible fix ave/chunk and compute chunk/atom commands. The fix ave/spatial command will be removed from LAMMPS sometime in the summer of 2015.

    @@ -243,16 +243,16 @@ independently of the per-atom values in other input vectors.

    pencils, 3d = boxes) are determined by the dim, origin, and delta settings and how many times they are specified (1, 2, or 3). See details below.

    -
    -

    Warning

    -

    This fix works by creating an array of size Nbins by -Nvalues on each processor. Nbins is the total number of bins; Nvalues -is the number of input values specified. Each processor loops over -its atoms, tallying its values to the appropriate bin. Then the -entire array is summed across all processors. This means that using a -large number of bins (easy to do for 2d or 3d bins) will incur an -overhead in memory and computational cost (summing across processors), -so be careful to use reasonable numbers of bins.

    +
    +

    Note

    +

    This fix works by creating an array of size Nbins by Nvalues on +each processor. Nbins is the total number of bins; Nvalues is the +number of input values specified. Each processor loops over its +atoms, tallying its values to the appropriate bin. Then the entire +array is summed across all processors. This means that using a large +number of bins (easy to do for 2d or 3d bins) will incur an overhead +in memory and computational cost (summing across processors), so be +careful to use reasonable numbers of bins.


    The Nevery, Nrepeat, and Nfreq arguments specify on what @@ -512,7 +512,7 @@ output, and title 1,2,3 = strings as described above.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -533,7 +533,7 @@ output, and title 1,2,3 = strings as described above.

    @@ -211,15 +211,15 @@ produce global quantities.

    independently of the per-atom values in other input vectors.

    Nbins specifies the number of spherical shells which will be created between r_min and r_max centered at (origin_x, origin_y, origin_z).

    -
    -

    Warning

    -

    This fix works by creating an array of size Nbins by -Nvalues on each processor. Nbins is the total number of bins; Nvalues -is the number of input values specified. Each processor loops over -its atoms, tallying its values to the appropriate bin. Then the -entire array is summed across all processors. This means that using a -large number of bins will incur an overhead in memory and computational -cost (summing across processors), so be careful to use reasonable numbers +

    +

    Note

    +

    This fix works by creating an array of size Nbins by Nvalues on +each processor. Nbins is the total number of bins; Nvalues is the +number of input values specified. Each processor loops over its +atoms, tallying its values to the appropriate bin. Then the entire +array is summed across all processors. This means that using a large +number of bins will incur an overhead in memory and computational cost +(summing across processors), so be careful to use reasonable numbers of bins.


    @@ -327,10 +327,10 @@ may be used.

    A lattice value means the distance units are in lattice spacings. The lattice command must have been previously used to define the lattice spacing.

    -
    -

    Warning

    -

    The lattice style may only be used if the lattice -spacing is the same in each direction.

    +
    +

    Note

    +

    The lattice style may only be used if the lattice spacing is +the same in each direction.

    A reduced value means normalized unitless values between 0 and 1, which represent the lower and upper faces of the simulation box @@ -423,7 +423,7 @@ file output, and title 1,2,3 = strings as described above.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -444,7 +444,7 @@ file output, and title 1,2,3 = strings as described above.

    @@ -424,7 +424,7 @@ off settings for any input values.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -445,7 +445,7 @@ off settings for any input values.

    @@ -241,7 +241,7 @@ the iteration count during the minimization.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -262,7 +262,7 @@ the iteration count during the minimization.

    @@ -197,32 +197,30 @@ most heavily loaded processor has 1200 particles, then the factor is 1.2, meaning there is a 20% imbalance. Note that re-balances can be forced even if the current balance is perfect (1.0) be specifying a thresh < 1.0.

    -
    -

    Warning

    -

    This command attempts to minimize the imbalance -factor, as defined above. But depending on the method a perfect -balance (1.0) may not be achieved. For example, “grid” methods -(defined below) that create a logical 3d grid cannot achieve perfect -balance for many irregular distributions of particles. Likewise, if a -portion of the system is a perfect lattice, e.g. the initial system is -generated by the create_atoms command, then “grid” -methods may be unable to achieve exact balance. This is because -entire lattice planes will be owned or not owned by a single -processor.

    +
    +

    Note

    +

    This command attempts to minimize the imbalance factor, as +defined above. But depending on the method a perfect balance (1.0) +may not be achieved. For example, “grid” methods (defined below) that +create a logical 3d grid cannot achieve perfect balance for many +irregular distributions of particles. Likewise, if a portion of the +system is a perfect lattice, e.g. the initial system is generated by +the create_atoms command, then “grid” methods may +be unable to achieve exact balance. This is because entire lattice +planes will be owned or not owned by a single processor.

    -
    -

    Warning

    -

    The imbalance factor is also an estimate of the -maximum speed-up you can hope to achieve by running a perfectly -balanced simulation versus an imbalanced one. In the example above, -the 10000 particle simulation could run up to 20% faster if it were -perfectly balanced, versus when imbalanced. However, computational -cost is not strictly proportional to particle count, and changing the -relative size and shape of processor sub-domains may lead to -additional computational and communication overheads, e.g. in the PPPM -solver used via the kspace_style command. Thus -you should benchmark the run times of a simulation before and after -balancing.

    +
    +

    Note

    +

    The imbalance factor is also an estimate of the maximum speed-up +you can hope to achieve by running a perfectly balanced simulation +versus an imbalanced one. In the example above, the 10000 particle +simulation could run up to 20% faster if it were perfectly balanced, +versus when imbalanced. However, computational cost is not strictly +proportional to particle count, and changing the relative size and +shape of processor sub-domains may lead to additional computational +and communication overheads, e.g. in the PPPM solver used via the +kspace_style command. Thus you should benchmark +the run times of a simulation before and after balancing.


    The method used to perform a load balance is specified by one of the @@ -343,13 +341,13 @@ so that you begin the run with a balanced system.

    Once the rebalancing is complete and final processor sub-domains assigned, particles migrate to their new owning processor as part of the normal reneighboring procedure.

    -
    -

    Warning

    -

    At each rebalance operation, the bisectioning for each -cutting plane (line in 2d) typcially starts with low and high bounds -separated by the extent of a processor’s sub-domain in one dimension. -The size of this bracketing region shrinks based on the local density, -as described above, which should typically be 1/2 or more every +

    +

    Note

    +

    At each rebalance operation, the bisectioning for each cutting +plane (line in 2d) typcially starts with low and high bounds separated +by the extent of a processor’s sub-domain in one dimension. The size +of this bracketing region shrinks based on the local density, as +described above, which should typically be 1/2 or more every iteration. Thus if Niter is specified as 10, the cutting plane will typically be positioned to better than 1 part in 1000 accuracy (relative to the perfect target position). For Niter = 20, it will @@ -480,7 +478,7 @@ style.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -501,7 +499,7 @@ style.

    @@ -194,12 +194,12 @@ is part of a 3-body (angle) or 4-body (dihedral, improper) interaction, that interaction is removed as well. These changes typically affect pairwise interactions between atoms that used to be part of bonds, angles, etc.

    -
    -

    Warning

    -

    One data structure that is not updated when a bond -breaks are the molecule IDs stored by each atom. Even though -one molecule becomes two moleclues due to the broken bond, all atoms -in both new moleclues retain their original molecule IDs.

    +
    +

    Note

    +

    One data structure that is not updated when a bond breaks are +the molecule IDs stored by each atom. Even though one molecule +becomes two moleclues due to the broken bond, all atoms in both new +moleclues retain their original molecule IDs.

    Computationally, each timestep this fix operates, it loops over all the bonds in the system and computes distances between pairs of bonded @@ -213,14 +213,14 @@ presence of the bond and the settings of the recognized. All of these operations increase the cost of a timestep. Thus you should be cautious about invoking this fix too frequently.

    You can dump out snapshots of the current bond topology via the dump local command.

    -
    -

    Warning

    -

    Breaking a bond typically alters the energy of a -system. You should be careful not to choose bond breaking criteria -that induce a dramatic change in energy. For example, if you define a -very stiff harmonic bond and break it when 2 atoms are separated by a -distance far from the equilibribum bond length, then the 2 atoms will -be dramatically released when the bond is broken. More generally, you +

    +

    Note

    +

    Breaking a bond typically alters the energy of a system. You +should be careful not to choose bond breaking criteria that induce a +dramatic change in energy. For example, if you define a very stiff +harmonic bond and break it when 2 atoms are separated by a distance +far from the equilibribum bond length, then the 2 atoms will be +dramatically released when the bond is broken. More generally, you may need to thermostat your system to compensate for energy changes resulting from broken bonds (and angles, dihedrals, impropers).

    @@ -273,7 +273,7 @@ built with that package. See the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -294,7 +294,7 @@ built with that package. See the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/fix_bond_break.txt b/doc/fix_bond_break.txt index f55a870491..e437fce027 100755 --- a/doc/fix_bond_break.txt +++ b/doc/fix_bond_break.txt @@ -77,10 +77,10 @@ interaction, that interaction is removed as well. These changes typically affect pairwise interactions between atoms that used to be part of bonds, angles, etc. -IMPORTANT NOTE: One data structure that is not updated when a bond -breaks are the molecule IDs stored by each atom. Even though -one molecule becomes two moleclues due to the broken bond, all atoms -in both new moleclues retain their original molecule IDs. +NOTE: One data structure that is not updated when a bond breaks are +the molecule IDs stored by each atom. Even though one molecule +becomes two moleclues due to the broken bond, all atoms in both new +moleclues retain their original molecule IDs. Computationally, each timestep this fix operates, it loops over all the bonds in the system and computes distances between pairs of bonded @@ -97,12 +97,12 @@ Thus you should be cautious about invoking this fix too frequently. You can dump out snapshots of the current bond topology via the "dump local"_dump.html command. -IMPORTANT NOTE: Breaking a bond typically alters the energy of a -system. You should be careful not to choose bond breaking criteria -that induce a dramatic change in energy. For example, if you define a -very stiff harmonic bond and break it when 2 atoms are separated by a -distance far from the equilibribum bond length, then the 2 atoms will -be dramatically released when the bond is broken. More generally, you +NOTE: Breaking a bond typically alters the energy of a system. You +should be careful not to choose bond breaking criteria that induce a +dramatic change in energy. For example, if you define a very stiff +harmonic bond and break it when 2 atoms are separated by a distance +far from the equilibribum bond length, then the 2 atoms will be +dramatically released when the bond is broken. More generally, you may need to thermostat your system to compensate for energy changes resulting from broken bonds (and angles, dihedrals, impropers). diff --git a/doc/fix_bond_create.html b/doc/fix_bond_create.html index 74dbc9bc7c..a3ab8f7ae8 100644 --- a/doc/fix_bond_create.html +++ b/doc/fix_bond_create.html @@ -8,7 +8,7 @@ - fix bond/create command — LAMMPS 15 May 2015 version documentation + fix bond/create command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -229,12 +229,12 @@ can choose to create new angles, dihedrals, impropers as well, using the atype, dtype, and itype keywords. All of these changes typically affect pairwise interactions between atoms that are now part of new bonds, angles, etc.

    -
    -

    Warning

    -

    One data structure that is not updated when a bond -breaks are the molecule IDs stored by each atom. Even though two -molecules become one moleclue due to the created bond, all atoms in -the new moleclue retain their original molecule IDs.

    +
    +

    Note

    +

    One data structure that is not updated when a bond breaks are +the molecule IDs stored by each atom. Even though two molecules +become one moleclue due to the created bond, all atoms in the new +moleclue retain their original molecule IDs.

    If the atype keyword is used and if an angle potential is defined via the angle_style command, then any new 3-body @@ -243,13 +243,13 @@ of type angletype, with parameters assigned by the corresponding angle_coeff command. Likewise, the dtype and itype keywords will create new dihedrals and impropers of type dihedraltype and impropertype.

    -
    -

    Warning

    -

    To create a new bond, the internal LAMMPS data -structures that store this information must have space for it. When -LAMMPS is initialized from a data file, the list of bonds is scanned -and the maximum number of bonds per atom is tallied. If some atom -will acquire more bonds than this limit as this fix operates, then the +

    +

    Note

    +

    To create a new bond, the internal LAMMPS data structures that +store this information must have space for it. When LAMMPS is +initialized from a data file, the list of bonds is scanned and the +maximum number of bonds per atom is tallied. If some atom will +acquire more bonds than this limit as this fix operates, then the “extra bond per atom” parameter must be set to allow for it. Ditto for “extra angle per atom”, “extra dihedral per atom”, and “extra improper per atom” if angles, dihedrals, or impropers are being added @@ -259,28 +259,28 @@ data file with no atoms can be used if you wish to add unbonded atoms via the create atoms command, e.g. for a percolation simulation.

    -
    -

    Warning

    -

    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 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 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 3 ways to do this. See the read_data or +

    +

    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 +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 +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 3 +ways to do this. See the read_data or create_box or “special_bonds extra” commands for details.

    -
    -

    Warning

    -

    Even if you do not use the atype, dtype, or -itype keywords, the list of topological neighbors is updated for -atoms affected by the new bond. This in turn affects which neighbors -are considered for pairwise interactions, using the weighting rules -set by the special_bonds command. Consider a new -bond created between atoms I,J. If J has a bonded neighbor K, then K +

    +

    Note

    +

    Even if you do not use the atype, dtype, or itype +keywords, the list of topological neighbors is updated for atoms +affected by the new bond. This in turn affects which neighbors are +considered for pairwise interactions, using the weighting rules set by +the 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 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 @@ -309,16 +309,16 @@ excluded by the presence of the bond and the settings of the recognized. All of these operations increase the cost of a timestep. Thus you should be cautious about invoking this fix too frequently.

    You can dump out snapshots of the current bond topology via the dump local command.

    -
    -

    Warning

    -

    Creating a bond typically alters the energy of a -system. You should be careful not to choose bond creation criteria -that induce a dramatic change in energy. For example, if you define a -very stiff harmonic bond and create it when 2 atoms are separated by a -distance far from the equilibribum bond length, then the 2 atoms will -oscillate dramatically when the bond is formed. More generally, you -may need to thermostat your system to compensate for energy changes -resulting from created bonds (and angles, dihedrals, impropers).

    +
    +

    Note

    +

    Creating a bond typically alters the energy of a system. You +should be careful not to choose bond creation criteria that induce a +dramatic change in energy. For example, if you define a very stiff +harmonic bond and create it when 2 atoms are separated by a distance +far from the equilibribum bond length, then the 2 atoms will oscillate +dramatically when the bond is formed. More generally, you may need to +thermostat your system to compensate for energy changes resulting from +created bonds (and angles, dihedrals, impropers).


    @@ -370,7 +370,7 @@ prob = 1.0.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -391,7 +391,7 @@ prob = 1.0.

    @@ -208,24 +208,22 @@ able to occur at either end of a chain. Thus for a particular monomer there will be 2 possible swap partners on another chain. In this scenario, swaps can also occur within a single chain, i.e. the two ends of a chain swap with each other.

    -
    -

    Warning

    -

    If your simulation uses molecule IDs in the usual way, -where all monomers on a single chain are assigned the same ID -(different for each chain), then swaps will only occur within the same -chain. If you assign the same molecule ID to all monomers in all -chains then inter-chain swaps will occur, but they will not conserve -chain length. Neither of these scenarios is probably what you want -for this fix.

    +
    +

    Note

    +

    If your simulation uses molecule IDs in the usual way, where all +monomers on a single chain are assigned the same ID (different for +each chain), then swaps will only occur within the same chain. If you +assign the same molecule ID to all monomers in all chains then +inter-chain swaps will occur, but they will not conserve chain length. +Neither of these scenarios is probably what you want for this fix.

    -
    -

    Warning

    -

    When a bond swap occurs the image flags of monomers in -the new polymer chains can become inconsistent. See the -dump command for a discussion of image flags. This is not -an issue for running dynamics, but can affect calculation of some -diagnostic quantities or the printing of unwrapped coordinates to a -dump file.

    +
    +

    Note

    +

    When a bond swap occurs the image flags of monomers in the new +polymer chains can become inconsistent. See the dump +command for a discussion of image flags. This is not an issue for +running dynamics, but can affect calculation of some diagnostic +quantities or the printing of unwrapped coordinates to a dump file.


    This fix computes a temperature each time it is invoked for use by the @@ -304,7 +302,7 @@ cannot use a dihedral or improper potential.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -325,7 +323,7 @@ cannot use a dihedral or improper potential.

    @@ -216,33 +216,32 @@ to fixedpoint, then the lower periodic boundaries will remain at far. In all cases, the particle positions at each iteration are unaffected by the chosen value, except that all particles are displaced by the same amount, different on each iteration.

    -
    -

    Warning

    -

    Appling an external pressure to tilt dimensions xy, -xz, yz can sometimes result in arbitrarily large values of the -tilt factors, i.e. a dramatically deformed simulation box. This -typically indicates that there is something badly wrong with how the -simulation was constructed. The two most common sources of this error -are applying a shear stress to a liquid system or specifying an -external shear stress tensor that exceeds the yield stress of the -solid. In either case the minimization may converge to a bogus -conformation or not converge at all. Also note that if the box shape -tilts to an extreme shape, LAMMPS will run less efficiently, due to -the large volume of communication needed to acquire ghost atoms around -a processor’s irregular-shaped sub-domain. For extreme values of -tilt, LAMMPS may also lose atoms and generate an error.

    +
    +

    Note

    +

    Appling an external pressure to tilt dimensions xy, xz, yz +can sometimes result in arbitrarily large values of the tilt factors, +i.e. a dramatically deformed simulation box. This typically indicates +that there is something badly wrong with how the simulation was +constructed. The two most common sources of this error are applying a +shear stress to a liquid system or specifying an external shear stress +tensor that exceeds the yield stress of the solid. In either case the +minimization may converge to a bogus conformation or not converge at +all. Also note that if the box shape tilts to an extreme shape, +LAMMPS will run less efficiently, due to the large volume of +communication needed to acquire ghost atoms around a processor’s +irregular-shaped sub-domain. For extreme values of tilt, LAMMPS may +also lose atoms and generate an error.

    -
    -

    Warning

    -

    Performing a minimization with this fix is not a -mathematically well-defined minimization problem. This is because the -objective function being minimized changes if the box size/shape -changes. In practice this means the minimizer can get “stuck” before -you have reached the desired tolerance. The solution to this is to -restart the minmizer from the new adjusted box size/shape, since that -creates a new objective function valid for the new box size/shape. -Repeat as necessary until the box size/shape has reached its new -equilibrium.

    +
    +

    Note

    +

    Performing a minimization with this fix is not a mathematically +well-defined minimization problem. This is because the objective +function being minimized changes if the box size/shape changes. In +practice this means the minimizer can get “stuck” before you have +reached the desired tolerance. The solution to this is to restart the +minmizer from the new adjusted box size/shape, since that creates a +new objective function valid for the new box size/shape. Repeat as +necessary until the box size/shape has reached its new equilibrium.


    The couple keyword allows two or three of the diagonal components of @@ -337,10 +336,10 @@ dimensions changes the objective function and gradients, which sometimes causes the minimization to fail. This can be resolved by changing the value of nreset, or simply continuing the minimization from a restart file.

    -
    -

    Warning

    -

    As normally computed, pressure includes a kinetic- -energy or temperature-dependent component; see the compute pressure command. However, atom velocities are +

    +

    Note

    +

    As normally computed, pressure includes a kinetic- energy or +temperature-dependent component; see the compute pressure command. However, atom velocities are ignored during a minimization, and the applied pressure(s) specified with this command are assumed to only be the virial component of the pressure (the non-kinetic portion). Thus if atoms have a non-zero @@ -352,19 +351,18 @@ monitoring the pressure without its kinetic component. The latter can be done by outputting the pressure from the fix this command creates (see below) or a pressure fix you define yourself.

    -
    -

    Warning

    -

    Because pressure is often a very sensitive function of -volume, it can be difficult for the minimizer to equilibrate the -system the desired pressure with high precision, particularly for -solids. Some techniques that seem to help are (a) use the -“min_modify line quadratic” option when minimizing with box -relaxations, (b) minimize several times in succession if need be, -to drive the pressure closer to the target pressure, (c) relax -the atom positions before relaxing the box, and (d) relax the box -to the target hydrostatic pressure before relaxing to a target -shear stress state. Also note that -some systems (e.g. liquids) will not sustain a non-hydrostatic applied +

    +

    Note

    +

    Because pressure is often a very sensitive function of volume, +it can be difficult for the minimizer to equilibrate the system the +desired pressure with high precision, particularly for solids. Some +techniques that seem to help are (a) use the “min_modify line +quadratic” option when minimizing with box relaxations, (b) minimize +several times in succession if need be, to drive the pressure closer +to the target pressure, (c) relax the atom positions before relaxing +the box, and (d) relax the box to the target hydrostatic pressure +before relaxing to a target shear stress state. Also note that some +systems (e.g. liquids) will not sustain a non-hydrostatic applied pressure, which means the minimizer will not converge.


    @@ -402,18 +400,17 @@ in its temperature and pressure calculation, as described above. Note that as described above, if you assign a pressure compute to this fix that includes a kinetic energy component it will affect the minimization, most likely in an undesirable way.

    -
    -

    Warning

    -

    If both the temp and press keywords are used in a -single thermo_modify command (or in two separate commands), then the -order in which the keywords are specified is important. Note that a -pressure compute defines its own temperature -compute as an argument when it is specified. The temp keyword will -override this (for the pressure compute being used by fix npt), but -only if the temp keyword comes after the press keyword. If the -temp keyword comes before the press keyword, then the new pressure -compute specified by the press keyword will be unaffected by the -temp setting.

    +
    +

    Note

    +

    If both the temp and press keywords are used in a single +thermo_modify command (or in two separate commands), then the order in +which the keywords are specified is important. Note that a pressure compute defines its own temperature compute as +an argument when it is specified. The temp keyword will override +this (for the pressure compute being used by fix npt), but only if the +temp keyword comes after the press keyword. If the temp keyword +comes before the press keyword, then the new pressure compute +specified by the press keyword will be unaffected by the temp +setting.

    This fix computes a global scalar which can be accessed by various output commands. The scalar is the @@ -463,7 +460,7 @@ and if the tilt factor is not coupled to the barostat via keywords

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -484,7 +481,7 @@ and if the tilt factor is not coupled to the barostat via keywords @@ -249,7 +249,7 @@ and tstat = NULL.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -270,7 +270,7 @@ and tstat = NULL.

    @@ -553,25 +553,25 @@ appropriate for fluids, where you want the atoms to respond to the change in box size/shape on their own and acquire a velocity that matches the box change, so that their motion will naturally track the box without explicit remapping of their coordinates.

    -
    -

    Warning

    -

    When non-equilibrium MD (NEMD) simulations are -performed using this fix, the option “remap v” should normally be -used. This is because fix nvt/sllod adjusts the -atom positions and velocities to induce a velocity profile that -matches the changing box size/shape. Thus atom coordinates should NOT -be remapped by fix deform, but velocities SHOULD be when atoms cross -periodic boundaries, since that is consistent with maintaining the -velocity profile already created by fix nvt/sllod. LAMMPS will warn -you if the remap setting is not consistent with fix nvt/sllod.

    +
    +

    Note

    +

    When non-equilibrium MD (NEMD) simulations are performed using +this fix, the option “remap v” should normally be used. This is +because fix nvt/sllod adjusts the atom positions +and velocities to induce a velocity profile that matches the changing +box size/shape. Thus atom coordinates should NOT be remapped by fix +deform, but velocities SHOULD be when atoms cross periodic boundaries, +since that is consistent with maintaining the velocity profile already +created by fix nvt/sllod. LAMMPS will warn you if the remap setting +is not consistent with fix nvt/sllod.

    -
    -

    Warning

    -

    For non-equilibrium MD (NEMD) simulations using “remap -v” it is usually desirable that the fluid (or flowing material, -e.g. granular particles) stream with a velocity profile consistent -with the deforming box. As mentioned above, using a thermostat such -as fix nvt/sllod or fix lavgevin (with a bias provided by compute temp/deform), will typically accomplish +

    +

    Note

    +

    For non-equilibrium MD (NEMD) simulations using “remap v” it is +usually desirable that the fluid (or flowing material, e.g. granular +particles) stream with a velocity profile consistent with the +deforming box. As mentioned above, using a thermostat such as fix nvt/sllod or fix lavgevin +(with a bias provided by compute temp/deform), will typically accomplish that. If you do not use a thermostat, then there is no driving force pushing the atoms to flow in a manner consistent with the deforming box. E.g. for a shearing system the box deformation velocity may vary @@ -584,14 +584,14 @@ command, that matches the box deformation rate. This also typically helps the system come to equilibrium more quickly, even if a thermostat is used.

    -
    -

    Warning

    -

    If a fix rigid is defined for rigid -bodies, and remap is set to x, then the center-of-mass coordinates -of rigid bodies will be remapped to the changing simulation box. This -will be done regardless of whether atoms in the rigid bodies are in -the fix deform group or not. The velocity of the centers of mass are -not remapped even if remap is set to v, since fix nvt/sllod does not currently do anything special +

    +

    Note

    +

    If a fix rigid is defined for rigid bodies, and +remap is set to x, then the center-of-mass coordinates of rigid +bodies will be remapped to the changing simulation box. This will be +done regardless of whether atoms in the rigid bodies are in the fix +deform group or not. The velocity of the centers of mass are not +remapped even if remap is set to v, since fix nvt/sllod does not currently do anything special for rigid particles. If you wish to perform a NEMD simulation of rigid particles, you can either thermostat them independently or include a background fluid and thermostat the fluid via fix nvt/sllod.

    @@ -671,7 +671,7 @@ xy) that is shrink-wrapped via the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -692,7 +692,7 @@ xy) that is shrink-wrapped via the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/fix_deform.txt b/doc/fix_deform.txt index f8f12420a7..1d786cc322 100644 --- a/doc/fix_deform.txt +++ b/doc/fix_deform.txt @@ -473,22 +473,22 @@ change in box size/shape on their own and acquire a velocity that matches the box change, so that their motion will naturally track the box without explicit remapping of their coordinates. -IMPORTANT NOTE: When non-equilibrium MD (NEMD) simulations are -performed using this fix, the option "remap v" should normally be -used. This is because "fix nvt/sllod"_fix_nvt_sllod.html adjusts the -atom positions and velocities to induce a velocity profile that -matches the changing box size/shape. Thus atom coordinates should NOT -be remapped by fix deform, but velocities SHOULD be when atoms cross -periodic boundaries, since that is consistent with maintaining the -velocity profile already created by fix nvt/sllod. LAMMPS will warn -you if the {remap} setting is not consistent with fix nvt/sllod. +NOTE: When non-equilibrium MD (NEMD) simulations are performed using +this fix, the option "remap v" should normally be used. This is +because "fix nvt/sllod"_fix_nvt_sllod.html adjusts the atom positions +and velocities to induce a velocity profile that matches the changing +box size/shape. Thus atom coordinates should NOT be remapped by fix +deform, but velocities SHOULD be when atoms cross periodic boundaries, +since that is consistent with maintaining the velocity profile already +created by fix nvt/sllod. LAMMPS will warn you if the {remap} setting +is not consistent with fix nvt/sllod. -IMPORTANT NOTE: For non-equilibrium MD (NEMD) simulations using "remap -v" it is usually desirable that the fluid (or flowing material, -e.g. granular particles) stream with a velocity profile consistent -with the deforming box. As mentioned above, using a thermostat such -as "fix nvt/sllod"_fix_nvt_sllod.html or "fix -lavgevin"_doc/fix_langevin.html (with a bias provided by "compute +NOTE: For non-equilibrium MD (NEMD) simulations using "remap v" it is +usually desirable that the fluid (or flowing material, e.g. granular +particles) stream with a velocity profile consistent with the +deforming box. As mentioned above, using a thermostat such as "fix +nvt/sllod"_fix_nvt_sllod.html or "fix lavgevin"_doc/fix_langevin.html +(with a bias provided by "compute temp/deform"_compute_temp_deform.html), will typically accomplish that. If you do not use a thermostat, then there is no driving force pushing the atoms to flow in a manner consistent with the deforming @@ -505,12 +505,12 @@ command, that matches the box deformation rate. This also typically helps the system come to equilibrium more quickly, even if a thermostat is used. -IMPORTANT NOTE: If a "fix rigid"_fix_rigid.html is defined for rigid -bodies, and {remap} is set to {x}, then the center-of-mass coordinates -of rigid bodies will be remapped to the changing simulation box. This -will be done regardless of whether atoms in the rigid bodies are in -the fix deform group or not. The velocity of the centers of mass are -not remapped even if {remap} is set to {v}, since "fix +NOTE: If a "fix rigid"_fix_rigid.html is defined for rigid bodies, and +{remap} is set to {x}, then the center-of-mass coordinates of rigid +bodies will be remapped to the changing simulation box. This will be +done regardless of whether atoms in the rigid bodies are in the fix +deform group or not. The velocity of the centers of mass are not +remapped even if {remap} is set to {v}, since "fix nvt/sllod"_fix_nvt_sllod.html does not currently do anything special for rigid particles. If you wish to perform a NEMD simulation of rigid particles, you can either thermostat them independently or diff --git a/doc/fix_deposit.html b/doc/fix_deposit.html index 1f38c377ea..201cdc2683 100644 --- a/doc/fix_deposit.html +++ b/doc/fix_deposit.html @@ -8,7 +8,7 @@ - fix deposit command — LAMMPS 15 May 2015 version documentation + fix deposit command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -228,16 +228,16 @@ command with the lost ignore option and a fixed insertion volume. The specified region must have been previously defined with a region command. It must be defined with side = in.

    -
    -

    Warning

    -

    LAMMPS checks that the specified region is wholly -inside the simulation box. It can do this correctly for orthonormal -simulation boxes. However for triclinic boxes, it only tests against the larger -orthonormal box that bounds the tilted simulation box. If the -specified region includes volume outside the tilted box, then an -insertion will likely fail, leading to a “lost atoms” error. Thus for -triclinic boxes you should insure the specified region is wholly -inside the simulation box.

    +
    +

    Note

    +

    LAMMPS checks that the specified region is wholly inside the +simulation box. It can do this correctly for orthonormal simulation +boxes. However for triclinic boxes, it +only tests against the larger orthonormal box that bounds the tilted +simulation box. If the specified region includes volume outside the +tilted box, then an insertion will likely fail, leading to a “lost +atoms” error. Thus for triclinic boxes you should insure the +specified region is wholly inside the simulation box.

    Individual atoms are inserted, unless the mol keyword is used. It specifies a template-ID previously defined using the @@ -292,11 +292,11 @@ of the molecule. If this test fails, a new random position within the insertion volume is chosen and another trial is made. Up to Q attempts are made. If the particle is not successfully inserted, LAMMPS prints a warning message.

    -
    -

    Warning

    -

    If you are inserting finite size particles or a -molecule or rigid body consisting of finite-size particles, then you -should typically set R larger than the distance at which any inserted +

    +

    Note

    +

    If you are inserting finite size particles or a molecule or +rigid body consisting of finite-size particles, then you should +typically set R larger than the distance at which any inserted particle may overlap with either a previouly inserted particle or an existing particle. LAMMPS will issue a warning if R is smaller than this value, based on the radii of existing and inserted particles.

    @@ -340,12 +340,12 @@ distance units are in lattice spacings. The -
    -

    Warning

    -

    If you are monitoring the temperature of a system -where the atom count is changing due to adding particles, you -typically should use the compute_modify dynamic yes command for the temperature compute you are -using.

    +
    +

    Note

    +

    If you are monitoring the temperature of a system where the atom +count is changing due to adding particles, you typically should use +the compute_modify dynamic yes command for the +temperature compute you are using.

    @@ -394,7 +394,7 @@ and units = lattice.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -415,7 +415,7 @@ and units = lattice.

    @@ -191,7 +191,7 @@ the run command. Thi

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -212,7 +212,7 @@ the run command. Thi @@ -180,7 +180,7 @@ the Drude oscillator model, such as

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -201,7 +201,7 @@ the Drude oscillator model, such as var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/fix_drude_transform.html b/doc/fix_drude_transform.html index d06d9ad597..25957734b5 100644 --- a/doc/fix_drude_transform.html +++ b/doc/fix_drude_transform.html @@ -8,7 +8,7 @@ - fix drude/transform/direct command — LAMMPS 15 May 2015 version documentation + fix drude/transform/direct command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -166,31 +166,44 @@ defined by the following equations. Note that in these equations upper case denotes atomic or center of mass values and lower case denotes Drude particle or dipole values. Primes denote the transformed (reduced) values, while bare letters denote the original values.

    -

    Masses: begin{equation} M’ = M + m end{equation} -begin{equation} m’ = frac {M, m } {M’} end{equation} -Positions: begin{equation} X’ = frac {M, X + m, x} {M’} -end{equation} begin{equation} x’ = x - X end{equation} -Velocities: begin{equation} V’ = frac {M, V + m, v} {M’} -end{equation} begin{equation} v’ = v - V end{equation} -Forces: begin{equation} F’ = F + f end{equation} -begin{equation} f’ = frac { M, f - m, F} {M’} -end{equation}

    -

    This transform conserves the total kinetic energy -begin{equation} frac 1 2 , (M, V^2+ m, v^2) -= frac 1 2 , (M’, V’^2+ m’, v’^2) end{equation} -and the virial defined with absolute positions -begin{equation} X, F + x, f = X’, F’ + x’, f’ end{equation}

    +

    Masses:

    +
    +\[\begin{equation} M' = M + m \end{equation}\]
    +
    +\[\begin{equation} m' = \frac {M\, m } {M'} \end{equation}\]
    +

    Positions:

    +
    +\[\begin{equation} X' = \frac {M\, X + m\, x} {M'}\end{equation}\]
    +
    +\[\begin{equation} x' = x - X \end{equation}\]
    +

    Velocities:

    +
    +\[\begin{equation} V' = \frac {M\, V + m\, v} {M'}\end{equation}\]
    +
    +\[\begin{equation} v' = v - V \end{equation}\]
    +

    Forces:

    +
    +\[\begin{equation} F' = F + f \end{equation}\]
    +
    +\[\begin{equation} f' = \frac { M\, f - m\, F} {M'}\end{equation}\]
    +

    This transform conserves the total kinetic energy

    +
    +\[\begin{equation} \frac 1 2 \, (M\, V^2\ + m\, v^2) += \frac 1 2 \, (M'\, V'^2\ + m'\, v'^2) \end{equation}\]
    +

    and the virial defined with absolute positions

    +
    +\[\begin{equation} X\, F + x\, f = X'\, F' + x'\, f' \end{equation}\]

    This fix requires each atom know whether it is a Drude particle or not. You must therefore use the fix drude command to specify the Drude status of each atom type.

    -
    -

    Warning

    -

    only the Drude core atoms need to be in the group -specified for this fix. A Drude electron will be transformed together -with its core even if it is not itself in the group. It is safe to -include Drude electrons or non-polarizable atoms in the group. The -non-polarizable atoms will simply not be transformed.

    +
    +

    Note

    +

    only the Drude core atoms need to be in the group specified for +this fix. A Drude electron will be transformed together with its core +even if it is not itself in the group. It is safe to include Drude +electrons or non-polarizable atoms in the group. The non-polarizable +atoms will simply not be transformed.


    This fix does NOT perform time integration. It only transform masses, @@ -199,12 +212,11 @@ integration fixes, like fi atoms. In order to thermalize the reduced degrees of freedom at different temperatures, two Nose-Hoover thermostats must be defined, acting on two distinct groups.

    -
    -

    Warning

    -

    The fix drude/transform/direct command must appear -before any Nose-Hoover thermostating fixes. The fix -drude/transform/inverse command must appear after any Nose-Hoover -thermostating fixes.

    +
    +

    Note

    +

    The fix drude/transform/direct command must appear before any +Nose-Hoover thermostating fixes. The fix drude/transform/inverse +command must appear after any Nose-Hoover thermostating fixes.

    Example:

    fix fDIRECT all drude/transform/direct
    @@ -280,7 +292,7 @@ to add a fix momentum command:

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with
    Sphinx using a theme provided by Read the Docs. @@ -301,7 +313,7 @@ to add a fix momentum command:

    @@ -219,7 +219,7 @@ the run command. Thi

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -240,7 +240,7 @@ the run command. Thi @@ -243,11 +243,11 @@ invoked by the minimize - @@ -273,7 +273,7 @@ was built with that package. See the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -294,7 +294,7 @@ was built with that package. See the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/fix_efield.txt b/doc/fix_efield.txt index 0e0a432df7..dd0857a07a 100644 --- a/doc/fix_efield.txt +++ b/doc/fix_efield.txt @@ -140,9 +140,9 @@ specify force components with a variable that has time-dependence for use with a minimizer, since the minimizer increments the timestep as the iteration count during the minimization. -IMPORTANT NOTE: If you want the fictitious potential energy associated -with the added forces to be included in the total potential energy of -the system (the quantity being minimized), you MUST enable the +NOTE: If you want the fictitious potential energy associated with the +added forces to be included in the total potential energy of the +system (the quantity being minimized), you MUST enable the "fix_modify"_fix_modify.html {energy} option for this fix. [Restrictions:] diff --git a/doc/fix_enforce2d.html b/doc/fix_enforce2d.html index bbbd2809ba..64cae5c912 100644 --- a/doc/fix_enforce2d.html +++ b/doc/fix_enforce2d.html @@ -8,7 +8,7 @@ - fix enforce2d command — LAMMPS 15 May 2015 version documentation + fix enforce2d command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -194,7 +194,7 @@ invoked by the minimize

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -215,7 +215,7 @@ invoked by the minimize var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/fix_evaporate.html b/doc/fix_evaporate.html index 027b461c8e..afc658dd1a 100644 --- a/doc/fix_evaporate.html +++ b/doc/fix_evaporate.html @@ -8,7 +8,7 @@ - fix evaporate command — LAMMPS 15 May 2015 version documentation + fix evaporate command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -180,12 +180,12 @@ inside the evaporation region or not.

    Note that neighbor lists are re-built on timesteps that atoms are removed. Thus you should not remove atoms too frequently or you will incur overhead due to the cost of building neighbor lists.

    -
    -

    Warning

    -

    If you are monitoring the temperature of a system -where the atom count is changing due to evaporation, you typically -should use the compute_modify dynamic yes -command for the temperature compute you are using.

    +
    +

    Note

    +

    If you are monitoring the temperature of a system where the atom +count is changing due to evaporation, you typically should use the +compute_modify dynamic yes command for the +temperature compute you are using.

    @@ -224,7 +224,7 @@ was built with that package. See the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -245,7 +245,7 @@ was built with that package. See the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/fix_evaporate.txt b/doc/fix_evaporate.txt index d50323b0a5..0243cbe977 100644 --- a/doc/fix_evaporate.txt +++ b/doc/fix_evaporate.txt @@ -61,10 +61,10 @@ Note that neighbor lists are re-built on timesteps that atoms are removed. Thus you should not remove atoms too frequently or you will incur overhead due to the cost of building neighbor lists. -IMPORTANT NOTE: If you are monitoring the temperature of a system -where the atom count is changing due to evaporation, you typically -should use the "compute_modify dynamic yes"_compute_modify.html -command for the temperature compute you are using. +NOTE: If you are monitoring the temperature of a system where the atom +count is changing due to evaporation, you typically should use the +"compute_modify dynamic yes"_compute_modify.html command for the +temperature compute you are using. [Restart, fix_modify, output, run start/stop, minimize info:] diff --git a/doc/fix_external.html b/doc/fix_external.html index 447edfacb6..df26466122 100644 --- a/doc/fix_external.html +++ b/doc/fix_external.html @@ -8,7 +8,7 @@ - fix external command — LAMMPS 15 May 2015 version documentation + fix external command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -240,11 +240,11 @@ is “extensive”.

    the
    run command.

    The forces due to this fix are imposed during an energy minimization, invoked by the minimize command.

    -
    -

    Warning

    -

    If you want the fictitious potential energy associated -with the added forces to be included in the total potential energy of -the system (the quantity being minimized), you MUST enable the +

    +

    Note

    +

    If you want the fictitious potential energy associated with the +added forces to be included in the total potential energy of the +system (the quantity being minimized), you MUST enable the fix_modify energy option for this fix.

    @@ -267,7 +267,7 @@ the system (the quantity being minimized), you MUST enable the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -288,7 +288,7 @@ the system (the quantity being minimized), you MUST enable the @@ -208,7 +208,7 @@ this fix is applied.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -229,7 +229,7 @@ this fix is applied.

    @@ -179,7 +179,7 @@ fix 4 my_gas gcmc 1 10 10 1 123456543 300.0 -12.5 1.0 region disk

    This fix performs grand canonical Monte Carlo (GCMC) exchanges of atoms or molecules of the given type with an imaginary ideal gas reservoir at the specified T and chemical potential (mu) as discussed in -(Frenkel). If used with the fix nvt command, +(Frenkel). If used with the fix nvt command, simulations in the grand canonical ensemble (muVT, constant chemical potential, constant volume, and constant temperature) can be performed. Specific uses include computing isotherms in microporous @@ -450,7 +450,7 @@ Academic Press, London, 2002.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -471,7 +471,7 @@ Academic Press, London, 2002.

    @@ -168,8 +168,8 @@ force and a colored Gaussian random force, consistent with the Fluctuation-Dissipation Theorem. The functional form of the memory kernel associated with the temporally non-local force is constrained to be a Prony series.

    -
    -

    Warning

    +
    +

    Note

    While this fix bears many similarities to fix langevin, it has one significant difference. Namely, fix gld performs time integration, whereas fix langevin does NOT. To this end, the @@ -268,7 +268,7 @@ was built with that package. See the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -289,7 +289,7 @@ was built with that package. See the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/fix_gld.txt b/doc/fix_gld.txt index 10aa73e628..fb4f96b474 100644 --- a/doc/fix_gld.txt +++ b/doc/fix_gld.txt @@ -45,7 +45,7 @@ Fluctuation-Dissipation Theorem. The functional form of the memory kernel associated with the temporally non-local force is constrained to be a Prony series. -IMPORTANT NOTE: While this fix bears many similarities to "fix +NOTE: While this fix bears many similarities to "fix langevin"_fix_langevin.html, it has one significant difference. Namely, "fix gld"_fix_gld.html performs time integration, whereas "fix langevin"_fix_langevin.html does NOT. To this end, the diff --git a/doc/fix_gle.html b/doc/fix_gle.html index 3f678ca764..9795cef9f7 100644 --- a/doc/fix_gle.html +++ b/doc/fix_gle.html @@ -8,7 +8,7 @@ - fix gle command — LAMMPS 15 May 2015 version documentation + fix gle command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -266,7 +266,7 @@ was built with that package. See the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -287,7 +287,7 @@ was built with that package. See the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/fix_gravity.html b/doc/fix_gravity.html index bfd26b0dd5..4c7b1f018e 100644 --- a/doc/fix_gravity.html +++ b/doc/fix_gravity.html @@ -8,7 +8,7 @@ - fix gravity command — LAMMPS 15 May 2015 version documentation + fix gravity command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -262,7 +262,7 @@ the run command. Thi

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -283,7 +283,7 @@ the run command. Thi @@ -193,12 +193,12 @@ time. Thus it is easy to specify a time-dependent flux.

    variables but can also include per-atom values, such as atom coordinates. Thus it is easy to specify a spatially-dependent flux with optional time-dependence as well.

    -
    -

    Warning

    -

    If heat is subtracted from the system too aggressively -so that the group’s kinetic energy would go to zero, or any individual -atom’s kinetic energy would go to zero for the case where eflux is -an atom-style variable, then LAMMPS will halt with an error message.

    +
    +

    Note

    +

    If heat is subtracted from the system too aggressively so that +the group’s kinetic energy would go to zero, or any individual atom’s +kinetic energy would go to zero for the case where eflux is an +atom-style variable, then LAMMPS will halt with an error message.

    Fix heat is different from a thermostat such as fix nvt or fix temp/rescale in that energy is @@ -249,7 +249,7 @@ the run command. Thi

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -270,7 +270,7 @@ the run command. Thi @@ -272,7 +272,7 @@ needs to use a different port number.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -293,7 +293,7 @@ needs to use a different port number.

    @@ -293,12 +293,12 @@ formula, LAMMPS uses the iteration count in the minimizer as the timestep. But it is almost certainly a bad idea to have the indenter change its position or size during a minimization. LAMMPS does not check if you have done this.

    -
    -

    Warning

    -

    If you want the atom/indenter interaction energy to be -included in the total potential energy of the system (the quantity -being minimized), you must enable the fix_modify -energy option for this fix.

    +
    +

    Note

    +

    If you want the atom/indenter interaction energy to be included +in the total potential energy of the system (the quantity being +minimized), you must enable the fix_modify energy +option for this fix.

    @@ -323,7 +323,7 @@ being minimized), you must enable the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -344,7 +344,7 @@ being minimized), you must enable the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/fix_indent.txt b/doc/fix_indent.txt index fa5e777416..c2428bdbbb 100644 --- a/doc/fix_indent.txt +++ b/doc/fix_indent.txt @@ -187,10 +187,10 @@ timestep. But it is almost certainly a bad idea to have the indenter change its position or size during a minimization. LAMMPS does not check if you have done this. -IMPORTANT NOTE: If you want the atom/indenter interaction energy to be -included in the total potential energy of the system (the quantity -being minimized), you must enable the "fix_modify"_fix_modify.html -{energy} option for this fix. +NOTE: If you want the atom/indenter interaction energy to be included +in the total potential energy of the system (the quantity being +minimized), you must enable the "fix_modify"_fix_modify.html {energy} +option for this fix. [Restrictions:] none diff --git a/doc/fix_ipi.html b/doc/fix_ipi.html index 91c57815cc..b815a9521f 100644 --- a/doc/fix_ipi.html +++ b/doc/fix_ipi.html @@ -8,7 +8,7 @@ - fix ipi command — LAMMPS 15 May 2015 version documentation + fix ipi command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -212,7 +212,7 @@ environment.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with
    Sphinx using a theme provided by Read the Docs. @@ -233,7 +233,7 @@ environment.

    @@ -212,11 +212,11 @@ consideration for finite-size particles, which have rotational degrees of freedom, are being thermostatted. The translational degrees of freedom can also have a bias velocity removed from them before thermostatting takes place; see the description below.

    -
    -

    Warning

    -

    Unlike the fix nvt command which -performs Nose/Hoover thermostatting AND time integration, this fix -does NOT perform time integration. It only modifies forces to effect +

    +

    Note

    +

    Unlike the fix nvt command which performs +Nose/Hoover thermostatting AND time integration, this fix does NOT +perform time integration. It only modifies forces to effect thermostatting. Thus you must use a separate time integration fix, like fix nve to actually update the velocities and positions of atoms using the modified forces. Likewise, this fix @@ -320,11 +320,11 @@ it is the energy exchanged between the infinite thermal reservoir and the particles. As described below, this energy can then be printed out or added to the potential energy of the system to monitor energy conservation.

    -
    -

    Warning

    -

    this accumulated energy does NOT include kinetic -energy removed by the zero flag. LAMMPS will print a warning when -both options are active.

    +
    +

    Note

    +

    this accumulated energy does NOT include kinetic energy removed +by the zero flag. LAMMPS will print a warning when both options are +active.

    The keyword zero can be used to eliminate drift due to the thermostat. Because the random forces on different atoms are @@ -435,7 +435,7 @@ types, tally = no, zero = no, gjf = no.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -456,7 +456,7 @@ types, tally = no, zero = no, gjf = no.

    @@ -169,33 +169,30 @@ of freedom by these equations. In these equations upper case denotes atomic or center of mass values and lower case denotes Drude particle or dipole values. Primes denote the transformed (reduced) values, while bare letters denote the original values.

    -

    Velocities: -begin{equation} V’ = frac {M, V + m, v} {M’} end{equation} -begin{equation} v’ = v - V end{equation} -Masses: -begin{equation} M’ = M + m end{equation} -begin{equation} m’ = frac {M, m } {M’} end{equation} -The Langevin forces are computed as -begin{equation} F’ = - frac {M’} {mathtt{damp_com}}, V’ + F_r’ end{equation} -begin{equation} f’ = - frac {m’} {mathtt{damp_drude}}, v’ + f_r’ end{equation} -(F_r’) is a random force proportional to -(sqrt { frac {2, k_B mathtt{Tcom}, m’}

    -
    -
    -
    {mathrm dt, mathtt{damp_com} }
    -

    } ).

    -
    -

    (f_r’) is a random force proportional to -(sqrt { frac {2, k_B mathtt{Tdrude}, m’}

    -
    -
    -
    {mathrm dt, mathtt{damp_drude} }
    -

    } ).

    -
    -

    Then the real forces acting on the particles are computed from the inverse -transform: -begin{equation} F = frac M {M’}, F’ - f’ end{equation} -begin{equation} f = frac m {M’}, F’ + f’ end{equation}

    +

    Velocities:

    +
    +\[\begin{equation} V' = \frac {M\, V + m\, v} {M'} \end{equation}\]
    +
    +\[\begin{equation} v' = v - V \end{equation}\]
    +

    Masses:

    +
    +\[\begin{equation} M' = M + m \end{equation}\]
    +
    +\[\begin{equation} m' = \frac {M\, m } {M'} \end{equation}\]
    +

    The Langevin forces are computed as

    +
    +\[\begin{equation} F' = - \frac {M'} {\mathtt{damp\_com}}\, V' + F_r' \end{equation}\]
    +
    +\[\begin{equation} f' = - \frac {m'} {\mathtt{damp\_drude}}\, v' + f_r' \end{equation}\]
    +

    \(F_r'\) is a random force proportional to +\(\sqrt { \frac {2\, k_B \mathtt{Tcom}\, m'} {\mathrm dt\, \mathtt{damp\_com} } }\). :b:math:`f_r’` is a random force proportional to +\(\sqrt { \frac {2\, k_B \mathtt{Tdrude}\, m'} {\mathrm dt\, \mathtt{damp\_drude} } }\). +Then the real forces acting on the particles are computed from the inverse +transform:

    +
    +\[\begin{equation} F = \frac M {M'}\, F' - f' \end{equation}\]
    +
    +\[\begin{equation} f = \frac m {M'}\, F' + f' \end{equation}\]

    This fix also thermostates non-polarizable atoms in the group at temperature Tcom, as if they had a massless Drude partner. The Drude particles themselves need not be in the group. The center of @@ -207,15 +204,15 @@ important consideration if finite-size particles, which have rotational degrees of freedom, are being thermostated. The translational degrees of freedom can also have a bias velocity removed from them before thermostating takes place; see the description below.

    -
    -

    Warning

    -

    Like the fix langevin command, -this fix does NOT perform time integration. It only modifies forces to -effect thermostating. Thus you must use a separate time integration -fix, like fix nve or fix nph to actually -update the velocities and positions of atoms using the modified -forces. Likewise, this fix should not normally be used on atoms that -also have their temperature controlled by another fix - e.g. by fix nvt or fix temp/rescale commands.

    +
    +

    Note

    +

    Like the fix langevin command, this fix does +NOT perform time integration. It only modifies forces to effect +thermostating. Thus you must use a separate time integration fix, like +fix nve or fix nph to actually update the +velocities and positions of atoms using the modified forces. +Likewise, this fix should not normally be used on atoms that also have +their temperature controlled by another fix - e.g. by fix nvt or fix temp/rescale commands.

    See this howto section of the manual for a discussion of different ways to compute temperature and perform @@ -224,20 +221,20 @@ thermostating.

    This fix requires each atom know whether it is a Drude particle or not. You must therefore use the fix drude command to specify the Drude status of each atom type.

    -
    -

    Warning

    -

    only the Drude core atoms need to be in the group -specified for this fix. A Drude electron will be transformed together -with its cores even if it is not itself in the group. It is safe to -include Drude electrons or non-polarizable atoms in the group. The -non-polarizable atoms will simply be thermostatted as if they had -a massless Drude partner (electron).

    +
    +

    Note

    +

    only the Drude core atoms need to be in the group specified for +this fix. A Drude electron will be transformed together with its cores +even if it is not itself in the group. It is safe to include Drude +electrons or non-polarizable atoms in the group. The non-polarizable +atoms will simply be thermostatted as if they had a massless Drude +partner (electron).

    -
    -

    Warning

    -

    Ghost atoms need to know their velocity for this fix -to act correctly. You must use the comm_modify -command to enable this, e.g.

    +
    +

    Note

    +

    Ghost atoms need to know their velocity for this fix to act +correctly. You must use the comm_modify command to +enable this, e.g.

    comm_modify vel yes
     
    @@ -383,7 +380,7 @@ Phys Chem Lett, 2, 87-92 (2011).

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -404,7 +401,7 @@ Phys Chem Lett, 2, 87-92 (2011).

    @@ -235,7 +235,7 @@ LAMMPS was built with that package. See the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -256,7 +256,7 @@ LAMMPS was built with that package. See the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/fix_lb_fluid.html b/doc/fix_lb_fluid.html index c38a839610..b342fa2aa8 100644 --- a/doc/fix_lb_fluid.html +++ b/doc/fix_lb_fluid.html @@ -8,7 +8,7 @@ - fix lb/fluid command — LAMMPS 15 May 2015 version documentation + fix lb/fluid command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -245,37 +245,36 @@ fix, through the use of the setGamma keyword. This may be useful when modelling porous particles. See Mackay et al. for a detailed description of the method by which the user can choose an appropriate gamma value.

    -
    -

    Warning

    -

    while this fix applies the force of the particles on -the fluid, it does not apply the force of the fluid to the particles. -When the force coupling constant is set using the default method, -there is only one option to include this hydrodynamic force on the -particles, and that is through the use of the -lb/viscous fix. This fix adds the hydrodynamic -force to the total force acting on the particles, after which any of -the built-in LAMMPS integrators can be used to integrate the particle -motion. However, if the user specifies their own value for the force -coupling constant, as mentioned in Mackay et al., the -built-in LAMMPS integrators may prove to be unstable. Therefore, we -have included our own integrators fix lb/rigid/pc/sphere, and fix lb/pc, to solve for the particle motion in these +

    +

    Note

    +

    while this fix applies the force of the particles on the fluid, +it does not apply the force of the fluid to the particles. When the +force coupling constant is set using the default method, there is only +one option to include this hydrodynamic force on the particles, and +that is through the use of the lb/viscous fix. +This fix adds the hydrodynamic force to the total force acting on the +particles, after which any of the built-in LAMMPS integrators can be +used to integrate the particle motion. However, if the user specifies +their own value for the force coupling constant, as mentioned in +Mackay et al., the built-in LAMMPS integrators may prove to +be unstable. Therefore, we have included our own integrators fix lb/rigid/pc/sphere, and fix lb/pc, to solve for the particle motion in these cases. These integrators should not be used with the lb/viscous fix, as they add hydrodynamic forces to the particles directly. In addition, they can not be used if the force coupling constant has been set the default way.

    -
    -

    Warning

    -

    if the force coupling constant is set using the -default method, and the lb/viscous fix is NOT -used to add the hydrodynamic force to the total force acting on the -particles, this physically corresponds to a situation in which an -infinitely massive particle is moving through the fluid (since -collisions between the particle and the fluid do not act to change the -particle’s velocity). Therefore, the user should set the mass of the -particle to be significantly larger than the mass of the fluid at the -particle location, in order to approximate an infinitely massive -particle (see the dragforce test run for an example).

    +
    +

    Note

    +

    if the force coupling constant is set using the default method, +and the lb/viscous fix is NOT used to add the +hydrodynamic force to the total force acting on the particles, this +physically corresponds to a situation in which an infinitely massive +particle is moving through the fluid (since collisions between the +particle and the fluid do not act to change the particle’s velocity). +Therefore, the user should set the mass of the particle to be +significantly larger than the mass of the fluid at the particle +location, in order to approximate an infinitely massive particle (see +the dragforce test run for an example).


    Inside the fix, parameters are scaled by the lattice-Boltzmann @@ -285,11 +284,11 @@ equal to 1.0, and dx is chosen so that tau/(dt) = (3*eta*dt)/(rho*dx^2) is approximately equal to 1. However, the user has the option of specifying their own values for dm, and dx, by using the optional keywords dm, and dx respectively.

    -
    -

    Warning

    -

    Care must be taken when choosing both a value for dx, -and a simulation domain size. This fix uses the same subdivision of -the simulation domain among processors as the main LAMMPS program. In +

    +

    Note

    +

    Care must be taken when choosing both a value for dx, and a +simulation domain size. This fix uses the same subdivision of the +simulation domain among processors as the main LAMMPS program. In order to uniformly cover the simulation domain with lattice sites, the lengths of the individual LAMMPS subdomains must all be evenly divisible by dx. If the simulation domain size is cubic, with equal @@ -351,10 +350,10 @@ integer, N, a binary restart file is printed every N LB timesteps. This restart file only contains information about the fluid. Therefore, a LAMMPS restart file should also be written in order to print out full details of the simulation.

    -
    -

    Warning

    -

    When a large number of lattice grid points are used, -the restart files may become quite large.

    +
    +

    Note

    +

    When a large number of lattice grid points are used, the restart +files may become quite large.

    In order to restart the fluid portion of the simulation, the keyword read_restart is specified, followed by the name of the binary @@ -443,7 +442,7 @@ If walls are present, they are assumed to be stationary.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -464,7 +463,7 @@ If walls are present, they are assumed to be stationary.

    @@ -204,7 +204,7 @@ was built with that package. See the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -225,7 +225,7 @@ was built with that package. See the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/fix_lb_pc.html b/doc/fix_lb_pc.html index b2e5a6e72b..a3ea9227f9 100644 --- a/doc/fix_lb_pc.html +++ b/doc/fix_lb_pc.html @@ -8,7 +8,7 @@ - fix lb/pc command — LAMMPS 15 May 2015 version documentation + fix lb/pc command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -185,7 +185,7 @@ command.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with
    Sphinx using a theme provided by Read the Docs. @@ -206,7 +206,7 @@ command.

    @@ -274,7 +274,7 @@ by default.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -295,7 +295,7 @@ by default.

    @@ -149,11 +149,10 @@ one of the built in LAMMPS integrators.

    This fix adds a force, F = - Gamma*(velocity-fluid_velocity), to each atom, where Gamma is the force coupling constant described in the fix lb/fluid command (which applies an equal and opposite force to the fluid).

    -
    -

    Warning

    -

    This fix should only be used in conjunction with one -of the built in LAMMPS integrators; it should not be used with the -fix lb/pc or fix lb/rigid/pc/sphere integrators, which +

    +

    Note

    +

    This fix should only be used in conjunction with one of the +built in LAMMPS integrators; it should not be used with the fix lb/pc or fix lb/rigid/pc/sphere integrators, which already include the hydrodynamic forces. These latter fixes should only be used if the force coupling constant has been set by the user (instead of using the default value); if the default force coupling @@ -210,7 +209,7 @@ used.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -231,7 +230,7 @@ used.

    @@ -183,7 +183,7 @@ invoked by the minimize

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -204,7 +204,7 @@ invoked by the minimize var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/fix_meso.html b/doc/fix_meso.html index 824a40ed8b..4be6b4a680 100644 --- a/doc/fix_meso.html +++ b/doc/fix_meso.html @@ -8,7 +8,7 @@ - fix meso command — LAMMPS 15 May 2015 version documentation + fix meso command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -181,7 +181,7 @@ LAMMPS was built with that package. See the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -202,7 +202,7 @@ LAMMPS was built with that package. See the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/fix_meso_stationary.html b/doc/fix_meso_stationary.html index 478f3dc959..c2e43b8870 100644 --- a/doc/fix_meso_stationary.html +++ b/doc/fix_meso_stationary.html @@ -8,7 +8,7 @@ - fix meso/stationary command — LAMMPS 15 May 2015 version documentation + fix meso/stationary command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -182,7 +182,7 @@ LAMMPS was built with that package. See the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -203,7 +203,7 @@ LAMMPS was built with that package. See the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/fix_modify.html b/doc/fix_modify.html index c312f598d2..afe7e9beaf 100644 --- a/doc/fix_modify.html +++ b/doc/fix_modify.html @@ -8,7 +8,7 @@ - fix_modify command — LAMMPS 15 May 2015 version documentation + fix_modify command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -205,7 +205,7 @@ by fix, energy = no.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with
    Sphinx using a theme provided by Read the Docs. @@ -226,7 +226,7 @@ by fix, energy = no.

    @@ -206,7 +206,7 @@ This fix is not invoked during

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -227,7 +227,7 @@ This fix is not invoked during var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/fix_move.html b/doc/fix_move.html index 980af0410d..ca6759724c 100644 --- a/doc/fix_move.html +++ b/doc/fix_move.html @@ -8,7 +8,7 @@ - fix move command — LAMMPS 15 May 2015 version documentation + fix move command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -172,31 +172,31 @@ fix 2 boundary move variable v_myx v_myy NULL v_VX v_VY NULL timestep using the specified settings or formulas, without regard to forces on the atoms. This can be useful for boundary or other atoms, whose movement can influence nearby atoms.

    -
    -

    Warning

    -

    The atoms affected by this fix should not normally be -time integrated by other fixes (e.g. fix nve, fix nvt), since that will change their positions and +

    +

    Note

    +

    The atoms affected by this fix should not normally be time +integrated by other fixes (e.g. fix nve, fix nvt), since that will change their positions and velocities twice.

    -
    -

    Warning

    -

    As atoms move due to this fix, they will pass thru -periodic boundaries and be remapped to the other side of the -simulation box, just as they would during normal time integration -(e.g. via the fix nve command). It is up to you to -decide whether periodic boundaries are appropriate with the kind of -atom motion you are prescribing with this fix.

    +
    +

    Note

    +

    As atoms move due to this fix, they will pass thru periodic +boundaries and be remapped to the other side of the simulation box, +just as they would during normal time integration (e.g. via the fix nve command). It is up to you to decide whether +periodic boundaries are appropriate with the kind of atom motion you +are prescribing with this fix.

    -
    -

    Warning

    -

    As dicsussed below, atoms are moved relative to their -initial position at the time the fix is specified. These initial -coordinates are stored by the fix in “unwrapped” form, by using the -image flags associated with each atom. See the dump custom command for a discussion of “unwrapped” coordinates. -See the Atoms section of the read_data command for a -discussion of image flags and how they are set for each atom. You can -reset the image flags (e.g. to 0) before invoking this fix by using -the set image command.

    +
    +

    Note

    +

    As dicsussed below, atoms are moved relative to their initial +position at the time the fix is specified. These initial coordinates +are stored by the fix in “unwrapped” form, by using the image flags +associated with each atom. See the dump custom command +for a discussion of “unwrapped” coordinates. See the Atoms section of +the read_data command for a discussion of image flags +and how they are set for each atom. You can reset the image flags +(e.g. to 0) before invoking this fix by using the set image +command.


    The linear style moves atoms at a constant velocity, so that their @@ -349,7 +349,7 @@ position and velocity of atoms on the outermost rRESPA level.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -370,7 +370,7 @@ position and velocity of atoms on the outermost rRESPA level.

    @@ -274,7 +274,7 @@ are calculated on the first step.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -295,7 +295,7 @@ are calculated on the first step.

    @@ -227,7 +227,7 @@ for more info on packages.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -248,7 +248,7 @@ for more info on packages.

    @@ -232,12 +232,12 @@ correctly, the time-averaged temperature and stress tensor of the particles will match the target values specified by Tstart/Tstop and Pstart/Pstop.

    The equations of motion used are those of Shinoda et al in -(Shinoda), which combine the hydrostatic equations of -Martyna, Tobias and Klein in (Martyna) with the strain +(Shinoda), which combine the hydrostatic equations of +Martyna, Tobias and Klein in (Martyna) with the strain energy proposed by Parrinello and Rahman in -(Parrinello). The time integration schemes closely +(Parrinello). The time integration schemes closely follow the time-reversible measure-preserving Verlet and rRESPA -integrators derived by Tuckerman et al in (Tuckerman).

    +integrators derived by Tuckerman et al in (Tuckerman).


    The thermostat parameters for fix styles nvt and npt is specified using the temp keyword. Other thermostat-related keywords are @@ -253,14 +253,14 @@ the temperature in a timespan of (roughly) 10 time units (e.g. tau or fmsec or psec - see the units command). The atoms in the fix group are the only ones whose velocities and positions are updated by the velocity/position update portion of the integration.

    -
    -

    Warning

    -

    A Nose-Hoover thermostat will not work well for -arbitrary values of Tdamp. If Tdamp is too small, the temperature -can fluctuate wildly; if it is too large, the temperature will take a -very long time to equilibrate. A good choice for many models is a -Tdamp of around 100 timesteps. Note that this is NOT the same as -100 time units for most units settings.

    +
    +

    Note

    +

    A Nose-Hoover thermostat will not work well for arbitrary values +of Tdamp. If Tdamp is too small, the temperature can fluctuate +wildly; if it is too large, the temperature will take a very long time +to equilibrate. A good choice for many models is a Tdamp of around +100 timesteps. Note that this is NOT the same as 100 time units for +most units settings.


    The barostat parameters for fix styles npt and nph is specified @@ -296,14 +296,14 @@ simulation box must be triclinic, even if its initial tilt factors are relaxed. For example, a value of 10.0 means to relax the pressure in a timespan of (roughly) 10 time units (e.g. tau or fmsec or psec - see the units command).

    -
    -

    Warning

    -

    A Nose-Hoover barostat will not work well for -arbitrary values of Pdamp. If Pdamp is too small, the pressure -and volume can fluctuate wildly; if it is too large, the pressure will -take a very long time to equilibrate. A good choice for many models -is a Pdamp of around 1000 timesteps. Note that this is NOT the same -as 1000 time units for most units settings.

    +
    +

    Note

    +

    A Nose-Hoover barostat will not work well for arbitrary values +of Pdamp. If Pdamp is too small, the pressure and volume can +fluctuate wildly; if it is too large, the pressure will take a very +long time to equilibrate. A good choice for many models is a Pdamp +of around 1000 timesteps. Note that this is NOT the same as 1000 time +units for most units settings.

    Regardless of what atoms are in the fix group (the only atoms which are time integrated), a global pressure or stress tensor is computed @@ -394,7 +394,7 @@ freedom. A value of 0 corresponds to no thermostatting of the barostat variables.

    The mtk keyword controls whether or not the correction terms due to Martyna, Tuckerman, and Klein are included in the equations of motion -(Martyna). Specifying no reproduces the original +(Martyna). Specifying no reproduces the original Hoover barostat, whose volume probability distribution function differs from the true NPT and NPH ensembles by a factor of 1/V. Hence using yes is more correct, but in many cases the difference is @@ -403,7 +403,7 @@ negligible.

    scheme at little extra cost. The initial and final updates of the thermostat variables are broken up into tloop substeps, each of length dt/tloop. This corresponds to using a first-order -Suzuki-Yoshida scheme (Tuckerman). The keyword ploop +Suzuki-Yoshida scheme (Tuckerman). The keyword ploop does the same thing for the barostat thermostat.

    The keyword nreset controls how often the reference dimensions used to define the strain energy are reset. If this keyword is not used, @@ -445,15 +445,15 @@ far. In all cases, the particle trajectories are unaffected by the chosen value, except for a time-dependent constant translation of positions.


    -
    -

    Warning

    -

    Using a barostat coupled to tilt dimensions xy, -xz, yz can sometimes result in arbitrarily large values of the -tilt dimensions, i.e. a dramatically deformed simulation box. LAMMPS -allows the tilt factors to grow a small amount beyond the normal limit -of half the box length (0.6 times the box length), and then performs a -box “flip” to an equivalent periodic cell. See the discussion of the -flip keyword above, to allow this bound to be exceeded, if desired.

    +
    +

    Note

    +

    Using a barostat coupled to tilt dimensions xy, xz, yz can +sometimes result in arbitrarily large values of the tilt dimensions, +i.e. a dramatically deformed simulation box. LAMMPS allows the tilt +factors to grow a small amount beyond the normal limit of half the box +length (0.6 times the box length), and then performs a box “flip” to +an equivalent periodic cell. See the discussion of the flip keyword +above, to allow this bound to be exceeded, if desired.

    The flip operation is described in more detail in the doc page for fix deform. Both the barostat dynamics and the atom @@ -476,15 +476,15 @@ factor are not enforced, since flipping the box in that dimension does not change the atom positions due to non-periodicity. In this mode, if you tilt the system to extreme angles, the simulation will simply become inefficient due to the highly skewed simulation box.

    -
    -

    Warning

    -

    Unlike the fix temp/berendsen command which performs -thermostatting but NO time integration, these fixes perform -thermostatting/barostatting AND time integration. Thus you should not -use any other time integration fix, such as fix nve on -atoms to which this fix is applied. Likewise, fix nvt and fix npt -should not normally be used on atoms that also have their temperature -controlled by another fix - e.g. by fix langevin or fix temp/rescale commands.

    +
    +

    Note

    +

    Unlike the fix temp/berendsen command +which performs thermostatting but NO time integration, these fixes +perform thermostatting/barostatting AND time integration. Thus you +should not use any other time integration fix, such as fix nve on atoms to which this fix is applied. Likewise, +fix nvt and fix npt should not normally be used on atoms that also +have their temperature controlled by another fix - e.g. by fix langevin or fix temp/rescale +commands.

    See this howto section of the manual for a discussion of different ways to compute temperature and perform @@ -584,18 +584,17 @@ If you do this, note that the kinetic energy derived from the compute temperature should be consistent with the virial term computed using all atoms for the pressure. LAMMPS will warn you if you choose to compute temperature on a subset of atoms.

    -
    -

    Warning

    -

    If both the temp and press keywords are used in a -single thermo_modify command (or in two separate commands), then the -order in which the keywords are specified is important. Note that a -pressure compute defines its own temperature -compute as an argument when it is specified. The temp keyword will -override this (for the pressure compute being used by fix npt), but -only if the temp keyword comes after the press keyword. If the -temp keyword comes before the press keyword, then the new pressure -compute specified by the press keyword will be unaffected by the -temp setting.

    +
    +

    Note

    +

    If both the temp and press keywords are used in a single +thermo_modify command (or in two separate commands), then the order in +which the keywords are specified is important. Note that a pressure compute defines its own temperature compute as +an argument when it is specified. The temp keyword will override +this (for the pressure compute being used by fix npt), but only if the +temp keyword comes after the press keyword. If the temp keyword +comes before the press keyword, then the new pressure compute +specified by the press keyword will be unaffected by the temp +setting.

    The fix_modify energy option is supported by these fixes to add the energy change induced by Nose/Hoover thermostatting @@ -698,7 +697,7 @@ Martyna, J Phys A: Math Gen, 39, 5629 (2006).

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -719,7 +718,7 @@ Martyna, J Phys A: Math Gen, 39, 5629 (2006).

    @@ -200,29 +200,28 @@ temperature and pressure calculated by the fix, using the computes it creates (as discussed in the fix nvt, npt, and nph doc page), are performed with computes that include the eFF contribution to the temperature or kinetic energy from the electron radial velocity.

    -
    -

    Warning

    -

    there are two different pressures that can be reported -for eFF when defining the pair_style (see pair eff/cut to understand these settings), one -(default) that considers electrons do not contribute radial virial -components (i.e. electrons treated as incompressible ‘rigid’ spheres) -and one that does. The radial electronic contributions to the virials -are only tallied if the flexible pressure option is set, and this will -affect both global and per-atom quantities. In principle, the true -pressure of a system is somewhere in between the rigid and the -flexible eFF pressures, but, for most cases, the difference between -these two pressures will not be significant over long-term averaged -runs (i.e. even though the energy partitioning changes, the total -energy remains similar).

    +
    +

    Note

    +

    there are two different pressures that can be reported for eFF +when defining the pair_style (see pair eff/cut to +understand these settings), one (default) that considers electrons do +not contribute radial virial components (i.e. electrons treated as +incompressible ‘rigid’ spheres) and one that does. The radial +electronic contributions to the virials are only tallied if the +flexible pressure option is set, and this will affect both global and +per-atom quantities. In principle, the true pressure of a system is +somewhere in between the rigid and the flexible eFF pressures, but, +for most cases, the difference between these two pressures will not be +significant over long-term averaged runs (i.e. even though the energy +partitioning changes, the total energy remains similar).

    -
    -

    Warning

    -

    currently, there is no available option for the user -to set or create temperature distributions that include the radial -electronic degrees of freedom with the velocity -command, so the the user must allow for these degrees of freedom to -equilibrate (i.e. equi-partitioning of energy) through time -integration.

    +
    +

    Note

    +

    currently, there is no available option for the user to set or +create temperature distributions that include the radial electronic +degrees of freedom with the velocity command, so the +the user must allow for these degrees of freedom to equilibrate +(i.e. equi-partitioning of energy) through time integration.

    @@ -235,10 +234,10 @@ for details.

    This fix is part of the USER-EFF package. It is only enabled if LAMMPS was built with that package. See the Making LAMMPS section for more info.

    Other restriction discussed on the doc page for the fix nvt, npt, and nph commands also apply.

    -
    -

    Warning

    -

    The temperature for systems (regions or groups) with -only electrons and no nuclei is 0.0 (i.e. not defined) in the current +

    +

    Note

    +

    The temperature for systems (regions or groups) with only +electrons and no nuclei is 0.0 (i.e. not defined) in the current temperature calculations, a practical example would be a uniform electron gas or a very hot plasma, where electrons remain delocalized from the nuclei. This is because, even though electron virials are @@ -275,7 +274,7 @@ Martyna, J Phys A: Math Gen, 39, 5629 (2006).

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -296,7 +295,7 @@ Martyna, J Phys A: Math Gen, 39, 5629 (2006).

    @@ -260,7 +260,7 @@ shape attribute.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -281,7 +281,7 @@ shape attribute.

    @@ -258,7 +258,7 @@ be point particles.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -279,7 +279,7 @@ be point particles.

    @@ -216,16 +216,14 @@ fluctuate about zero.

    the simulation. These can be overridden using the fix_modify keywords e0, v0, and p0 described below.


    -
    -

    Warning

    -

    Unlike the fix temp/berendsen command which performs -thermostatting but NO time integration, this fix performs -thermostatting/barostatting AND time integration. Thus you should not -use any other time integration fix, such as fix nve on -atoms to which this fix is applied. Likewise, this fix should not be -used on atoms that have their temperature controlled by another fix -- e.g. by fix langevin or fix temp/rescale -commands.

    +
    +

    Note

    +

    Unlike the fix temp/berendsen command +which performs thermostatting but NO time integration, this fix +performs thermostatting/barostatting AND time integration. Thus you +should not use any other time integration fix, such as fix nve on atoms to which this fix is applied. Likewise, +this fix should not be used on atoms that have their temperature +controlled by another fix - e.g. by fix langevin or fix temp/rescale commands.


    This fix computes a temperature and pressure at each timestep. To do @@ -338,7 +336,7 @@ plus the additional ones mentioned above.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -359,7 +357,7 @@ plus the additional ones mentioned above.

    @@ -283,7 +283,7 @@ shape attribute.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -304,7 +304,7 @@ shape attribute.

    @@ -279,7 +279,7 @@ be point particles.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -300,7 +300,7 @@ be point particles.

    @@ -205,7 +205,7 @@ This fix is not invoked during

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -226,7 +226,7 @@ This fix is not invoked during var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/fix_nve_asphere.html b/doc/fix_nve_asphere.html index 9c0b70dfa1..d26608e781 100644 --- a/doc/fix_nve_asphere.html +++ b/doc/fix_nve_asphere.html @@ -8,7 +8,7 @@ - fix nve/asphere command — LAMMPS 15 May 2015 version documentation + fix nve/asphere command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -187,7 +187,7 @@ shape attribute.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with
    Sphinx using a theme provided by Read the Docs. @@ -208,7 +208,7 @@ shape attribute.

    @@ -188,7 +188,7 @@ shape attribute.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -209,7 +209,7 @@ shape attribute.

    @@ -187,7 +187,7 @@ point particles.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -208,7 +208,7 @@ point particles.

    @@ -180,7 +180,7 @@ LAMMPS was built with that package. See the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -201,7 +201,7 @@ LAMMPS was built with that package. See the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/fix_nve_limit.html b/doc/fix_nve_limit.html index ddd641e83d..3d50992d44 100644 --- a/doc/fix_nve_limit.html +++ b/doc/fix_nve_limit.html @@ -8,7 +8,7 @@ - fix nve/limit command — LAMMPS 15 May 2015 version documentation + fix nve/limit command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -167,16 +167,16 @@ energy. On steps where no velocity resets occur, this integrator is exactly like the fix nve command. Since forces are unaltered, pressures computed by thermodynamic output will still be very large for overlapped configurations.

    -
    -

    Warning

    -

    You should not use fix shake in -conjunction with this fix. That is because fix shake applies -contraint forces based on the predicted postitions of atoms after the -next timestep. It has no way of knowing the timestep may change due -to this fix, which will cause the constraint forces to be invalid. A -better strategy is to turn off fix shake when performing initial -dynamics that need this fix, then turn fix shake on when doing normal -dynamics with a fixed-size timestep.

    +
    +

    Note

    +

    You should not use fix shake in conjunction +with this fix. That is because fix shake applies contraint forces +based on the predicted postitions of atoms after the next timestep. +It has no way of knowing the timestep may change due to this fix, +which will cause the constraint forces to be invalid. A better +strategy is to turn off fix shake when performing initial dynamics +that need this fix, then turn fix shake on when doing normal dynamics +with a fixed-size timestep.

    @@ -218,7 +218,7 @@ the run command. Thi

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -239,7 +239,7 @@ the run command. Thi @@ -185,7 +185,7 @@ was built with that package. See the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -206,7 +206,7 @@ was built with that package. See the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/fix_nve_noforce.html b/doc/fix_nve_noforce.html index b3001f574a..5ee7c8c482 100644 --- a/doc/fix_nve_noforce.html +++ b/doc/fix_nve_noforce.html @@ -8,7 +8,7 @@ - fix nve/noforce command — LAMMPS 15 May 2015 version documentation + fix nve/noforce command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -186,7 +186,7 @@ This fix is not invoked during

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -207,7 +207,7 @@ This fix is not invoked during var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/fix_nve_sphere.html b/doc/fix_nve_sphere.html index ddb58d6d58..b545639579 100644 --- a/doc/fix_nve_sphere.html +++ b/doc/fix_nve_sphere.html @@ -8,7 +8,7 @@ - fix nve/sphere command — LAMMPS 15 May 2015 version documentation + fix nve/sphere command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -218,7 +218,7 @@ be point particles.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with
    Sphinx using a theme provided by Read the Docs. @@ -239,7 +239,7 @@ be point particles.

    @@ -185,7 +185,7 @@ was built with that package. See the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -206,7 +206,7 @@ was built with that package. See the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/fix_nvt_asphere.html b/doc/fix_nvt_asphere.html index b03a169f89..4438cffba6 100644 --- a/doc/fix_nvt_asphere.html +++ b/doc/fix_nvt_asphere.html @@ -8,7 +8,7 @@ - fix nvt/asphere command — LAMMPS 15 May 2015 version documentation + fix nvt/asphere command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -262,7 +262,7 @@ shape attribute.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with
    Sphinx using a theme provided by Read the Docs. @@ -283,7 +283,7 @@ shape attribute.

    @@ -164,17 +164,17 @@ is being sheared in x, relative to y, then points at the bottom of the box (low y) have a small x velocity, while points at the top of the box (hi y) have a large x velocity. These velocities do not contribute to the thermal “temperature” of the atom.

    -
    -

    Warning

    -

    Fix deform has an option for -remapping either atom coordinates or velocities to the changing -simulation box. To use fix nvt/sllod, fix deform should NOT remap -atom positions, because fix nvt/sllod adjusts the atom positions and -velocities to create a velocity profile that matches the changing box -size/shape. Fix deform SHOULD remap atom velocities when atoms cross -periodic boundaries since that is consistent with maintaining the -velocity profile created by fix nvt/sllod. LAMMPS will give an -error if this setting is not consistent.

    +
    +

    Note

    +

    Fix deform has an option for remapping either +atom coordinates or velocities to the changing simulation box. To use +fix nvt/sllod, fix deform should NOT remap atom positions, because fix +nvt/sllod adjusts the atom positions and velocities to create a +velocity profile that matches the changing box size/shape. Fix deform +SHOULD remap atom velocities when atoms cross periodic boundaries +since that is consistent with maintaining the velocity profile created +by fix nvt/sllod. LAMMPS will give an error if this setting is not +consistent.

    The SLLOD equations of motion, originally proposed by Hoover and Ladd (see (Evans and Morriss)), were proven to be equivalent to @@ -286,7 +286,7 @@ equilibration.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -307,7 +307,7 @@ equilibration.

    @@ -209,7 +209,7 @@ equilibration.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -230,7 +230,7 @@ equilibration.

    @@ -259,7 +259,7 @@ be point particles.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -280,7 +280,7 @@ be point particles.

    @@ -189,7 +189,7 @@ This fix is not invoked during

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -210,7 +210,7 @@ This fix is not invoked during var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/fix_orient_fcc.html b/doc/fix_orient_fcc.html index 02e899a6a8..7ce7aacc8c 100644 --- a/doc/fix_orient_fcc.html +++ b/doc/fix_orient_fcc.html @@ -8,7 +8,7 @@ - fix orient/fcc command — LAMMPS 15 May 2015 version documentation + fix orient/fcc command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -290,7 +290,7 @@ Angs.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with
    Sphinx using a theme provided by Read the Docs. @@ -311,7 +311,7 @@ Angs.

    @@ -298,7 +298,7 @@ molecular dynamics simulations,

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -319,7 +319,7 @@ molecular dynamics simulations
    , var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/fix_pimd.html b/doc/fix_pimd.html index 1abbf40098..803b91b6be 100644 --- a/doc/fix_pimd.html +++ b/doc/fix_pimd.html @@ -8,7 +8,7 @@ - fix pimd command — LAMMPS 15 May 2015 version documentation + fix pimd command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -178,11 +178,11 @@ target temperature for the system and the keyword nhc sets the number Nc of thermostats in each chain. For example, for a simulation of N particles with P beads in each ring-polymer, the total number of NH thermostats would be 3 x N x P x Nc.

    -
    -

    Warning

    -

    This fix implements a complete velocity-verlet -integrator combined with NH massive chain thermostat, so no -other time integration fix should be used.

    +
    +

    Note

    +

    This fix implements a complete velocity-verlet integrator +combined with NH massive chain thermostat, so no other time +integration fix should be used.

    The method keyword determines what style of PIMD is performed. A value of pimd is standard PIMD. A value of nmpimd is for @@ -291,7 +291,7 @@ Path Integrals, McGraw-Hill, New York (1965).

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with
    Sphinx using a theme provided by Read the Docs. @@ -312,7 +312,7 @@ Path Integrals, McGraw-Hill, New York (1965).

    @@ -183,7 +183,7 @@ invoked by the minimize

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -204,7 +204,7 @@ invoked by the minimize var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/fix_poems.html b/doc/fix_poems.html index 86e21ba63d..181b249baa 100644 --- a/doc/fix_poems.html +++ b/doc/fix_poems.html @@ -8,7 +8,7 @@ - fix poems — LAMMPS 15 May 2015 version documentation + fix poems — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -245,7 +245,7 @@ Engineering With Computers (2006). (

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -266,7 +266,7 @@ Engineering With Computers (2006). ( var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/fix_pour.html b/doc/fix_pour.html index bd45d82aa2..665630b764 100644 --- a/doc/fix_pour.html +++ b/doc/fix_pour.html @@ -8,7 +8,7 @@ - fix pour command — LAMMPS 15 May 2015 version documentation + fix pour command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -277,12 +277,12 @@ insertions, it prints a warning.

    The rate option moves the insertion volume in the z direction (3d) or y direction (2d). This enables pouring particles from a successively higher height over time.

    -
    -

    Warning

    -

    If you are monitoring the temperature of a system -where the particle count is changing due to adding particles, you -typically should use the compute_modify dynamic yes command for the temperature compute you are -using.

    +
    +

    Note

    +

    If you are monitoring the temperature of a system where the +particle count is changing due to adding particles, you typically +should use the compute_modify dynamic yes +command for the temperature compute you are using.


    @@ -341,7 +341,7 @@ Additional option defaults are diam = one 1.0, dens = 1.0 1.0, vol =

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -362,7 +362,7 @@ Additional option defaults are diam = one 1.0, dens = 1.0 1.0, vol = @@ -169,15 +169,15 @@ keyword dilate is specified with a value of partial, in which only the atoms in the fix group are re-scaled. The latter can be useful for leaving the coordinates of atoms in a solid substrate unchanged and controlling the pressure of a surrounding fluid.

    -
    -

    Warning

    -

    Unlike the fix npt or fix nph commands which perform Nose/Hoover barostatting AND -time integration, this fix does NOT perform time integration. It only -modifies the box size and atom coordinates to effect barostatting. -Thus you must use a separate time integration fix, like fix nve or fix nvt to actually update the -positions and velocities of atoms. This fix can be used in -conjunction with thermostatting fixes to control the temperature, such -as fix nvt or fix langevin or fix temp/berendsen.

    +
    +

    Note

    +

    Unlike the fix npt or fix nph +commands which perform Nose/Hoover barostatting AND time integration, +this fix does NOT perform time integration. It only modifies the box +size and atom coordinates to effect barostatting. Thus you must use a +separate time integration fix, like fix nve or fix nvt to actually update the positions and velocities of +atoms. This fix can be used in conjunction with thermostatting fixes +to control the temperature, such as fix nvt or fix langevin or fix temp/berendsen.

    See this howto section of the manual for a discussion of different ways to compute temperature and perform @@ -206,13 +206,13 @@ although you have the option to change that dimension via the units command).

    -
    -

    Warning

    -

    The relaxation time is actually also a function of the -bulk modulus of the system (inverse of isothermal compressibility). -The bulk modulus has units of pressure and is the amount of pressure -that would need to be applied (isotropically) to reduce the volume of -the system by a factor of 2 (assuming the bulk modulus was a constant, +

    +

    Note

    +

    The relaxation time is actually also a function of the bulk +modulus of the system (inverse of isothermal compressibility). The +bulk modulus has units of pressure and is the amount of pressure that +would need to be applied (isotropically) to reduce the volume of the +system by a factor of 2 (assuming the bulk modulus was a constant, independent of density, which it’s not). The bulk modulus can be set via the keyword modulus. The Pdamp parameter is effectively multiplied by the bulk modulus, so if the pressure is relaxing faster @@ -329,7 +329,7 @@ Phys, 81, 3684 (1984).

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -350,7 +350,7 @@ Phys, 81, 3684 (1984).

    @@ -221,7 +221,7 @@ as described above.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -242,7 +242,7 @@ as described above.

    @@ -202,27 +202,26 @@ properties to also be defined for ghost atoms, then use the ghost keyword with a value of yes. This will invoke extra communication when ghost atoms are created (at every re-neighboring) to insure the new properties are also defined for the ghost atoms.

    -
    -

    Warning

    -

    If you use this command with the mol or charge -vectors than you most likely want to set ghost yes, since these -properties are stored with ghost atoms if you use an -atom_style that defines them, and many LAMMPS -operations that use molecule IDs or charge, such as neighbor lists and -pair styles, will expect ghost atoms to have these valuse. LAMMPS -will issue a warning it you define those vectors but do not set -ghost yes.

    +
    +

    Note

    +

    If you use this command with the mol or charge vectors than +you most likely want to set ghost yes, since these properties are +stored with ghost atoms if you use an atom_style +that defines them, and many LAMMPS operations that use molecule IDs or +charge, such as neighbor lists and pair styles, will expect ghost +atoms to have these valuse. LAMMPS will issue a warning it you define +those vectors but do not set ghost yes.

    -
    -

    Warning

    -

    The properties for ghost atoms are not updated every -timestep, but only once every few steps when neighbor lists are -re-built. Thus the ghost keyword is suitable for static properties, -like molecule IDs, but not for dynamic properties that change every -step. For the latter, the code you add to LAMMPS to change the -properties will also need to communicate their new values to/from -ghost atoms, an operation that can be invoked from within a pair style or fix or compute -that you write.

    +
    +

    Note

    +

    The properties for ghost atoms are not updated every timestep, +but only once every few steps when neighbor lists are re-built. Thus +the ghost keyword is suitable for static properties, like molecule +IDs, but not for dynamic properties that change every step. For the +latter, the code you add to LAMMPS to change the properties will also +need to communicate their new values to/from ghost atoms, an operation +that can be invoked from within a pair style or +fix or compute that you write.


    This fix is one of a small number that can be defined in an input @@ -332,7 +331,7 @@ This fix is not invoked during

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -353,7 +352,7 @@ This fix is not invoked during var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/fix_property_atom.txt b/doc/fix_property_atom.txt index 96c3153cd2..7e29775d08 100644 --- a/doc/fix_property_atom.txt +++ b/doc/fix_property_atom.txt @@ -82,24 +82,22 @@ keyword with a value of {yes}. This will invoke extra communication when ghost atoms are created (at every re-neighboring) to insure the new properties are also defined for the ghost atoms. -IMPORTANT NOTE: If you use this command with the {mol} or {charge} -vectors than you most likely want to set {ghost} yes, since these -properties are stored with ghost atoms if you use an -"atom_style"_atom_style.html that defines them, and many LAMMPS -operations that use molecule IDs or charge, such as neighbor lists and -pair styles, will expect ghost atoms to have these valuse. LAMMPS -will issue a warning it you define those vectors but do not set -{ghost} yes. +NOTE: If you use this command with the {mol} or {charge} vectors than +you most likely want to set {ghost} yes, since these properties are +stored with ghost atoms if you use an "atom_style"_atom_style.html +that defines them, and many LAMMPS operations that use molecule IDs or +charge, such as neighbor lists and pair styles, will expect ghost +atoms to have these valuse. LAMMPS will issue a warning it you define +those vectors but do not set {ghost} yes. -IMPORTANT NOTE: The properties for ghost atoms are not updated every -timestep, but only once every few steps when neighbor lists are -re-built. Thus the {ghost} keyword is suitable for static properties, -like molecule IDs, but not for dynamic properties that change every -step. For the latter, the code you add to LAMMPS to change the -properties will also need to communicate their new values to/from -ghost atoms, an operation that can be invoked from within a "pair -style"_pair_style.html or "fix"_fix.html or "compute"_compute.html -that you write. +NOTE: The properties for ghost atoms are not updated every timestep, +but only once every few steps when neighbor lists are re-built. Thus +the {ghost} keyword is suitable for static properties, like molecule +IDs, but not for dynamic properties that change every step. For the +latter, the code you add to LAMMPS to change the properties will also +need to communicate their new values to/from ghost atoms, an operation +that can be invoked from within a "pair style"_pair_style.html or +"fix"_fix.html or "compute"_compute.html that you write. :line diff --git a/doc/fix_qbmsst.html b/doc/fix_qbmsst.html index 2bdc71194e..57be60b929 100644 --- a/doc/fix_qbmsst.html +++ b/doc/fix_qbmsst.html @@ -8,7 +8,7 @@ - fix qbmsst command — LAMMPS 15 May 2015 version documentation + fix qbmsst command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -324,7 +324,7 @@ T_init=300.0. e0, p0, and v0 are calculated on the first step.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with
    Sphinx using a theme provided by Read the Docs. @@ -345,7 +345,7 @@ T_init=300.0. e0, p0, and v0 are calculated on the first step.

    @@ -162,7 +162,7 @@ fix 1 qeq qeq/dynamic 1 12 1.0e-3 100 my_qeq

    Description

    Perform the charge equilibration (QEq) method as described in (Rappe and Goddard) and formulated in (Nakano) (also known -as the matrix inversion method) and in (Rick and Stuart) (also +as the matrix inversion method) and in (Rick and Stuart) (also known as the extended Lagrangian method) based on the electronegativity equilization principle.

    These fixes can be used with any pair style in @@ -180,20 +180,20 @@ define the QEq fix, perform a zero-timestep run via the unfix command before performing further dynamics.

    -
    -

    Warning

    -

    Computing and using charge values different from -published values defined for a fixed-charge potential like Buckingham -or CHARMM or AMBER, can have a strong effect on energies and forces, -and produces a different model than the published versions.

    +
    +

    Note

    +

    Computing and using charge values different from published +values defined for a fixed-charge potential like Buckingham or CHARMM +or AMBER, can have a strong effect on energies and forces, and +produces a different model than the published versions.

    -
    -

    Warning

    -

    The fix qeq/comb command must -still be used to perform charge equliibration with the COMB potential. The fix qeq/reax +

    +

    Note

    +

    The fix qeq/comb command must still be used +to perform charge equliibration with the COMB potential. The fix qeq/reax command can be used to perform charge equilibration with the ReaxFF force field, although fix qeq/shielded yields the -same results as fix qeq/reax if Nevery, cutoff, and tolerance are -the same. Eventually the fix qeq/reax command will be deprecated.

    +same results as fix qeq/reax if Nevery, cutoff, and tolerance +are the same. Eventually the fix qeq/reax command will be deprecated.

    The QEq method minimizes the electrostatic energy of the system (or equalizes the derivative of energy with respect to charge of all the @@ -260,19 +260,18 @@ solve partial charges on atoms using different solvers. Styles the QEq parameters and Nevery, cutoff, and tolerance are the same. Style qeq/point is typically faster, but qeq/dynamic scales better on larger sizes.

    -
    -

    Warning

    -

    To avoid the evaluation of the derivative of charge -with respect to position, which is typically ill-defined, the system -should have a zero net charge.

    +
    +

    Note

    +

    To avoid the evaluation of the derivative of charge with respect +to position, which is typically ill-defined, the system should have a +zero net charge.

    -
    -

    Warning

    -

    Developing QEq parameters (chi, eta, gamma, zeta, and -qcore) is an “art”. Charges on atoms are not guaranteed to -equilibrate with arbitrary choices of these parameters. We do not -develop these QEq paramters. See the examples/qeq directory for some -examples.

    +
    +

    Note

    +

    Developing QEq parameters (chi, eta, gamma, zeta, and qcore) is +an “art”. Charges on atoms are not guaranteed to equilibrate with +arbitrary choices of these parameters. We do not develop these QEq +paramters. See the examples/qeq directory for some examples.

    @@ -315,7 +314,7 @@ Physical Chemistry, 105, 9396-9049 (2001)

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -336,7 +335,7 @@ Physical Chemistry, 105, 9396-9049 (2001)

    @@ -241,7 +241,7 @@ Phillpot, Phys Rev B, 81, 125328 (2010).

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -262,7 +262,7 @@ Phillpot, Phys Rev B, 81, 125328 (2010).

    @@ -216,7 +216,7 @@ be used for periodic cell dimensions less than 10 angstroms.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -237,7 +237,7 @@ be used for periodic cell dimensions less than 10 angstroms.

    @@ -188,7 +188,7 @@ executable. See the lib/qmmm/README file for details.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -209,7 +209,7 @@ executable. See the lib/qmmm/README file for details.

    @@ -235,14 +235,14 @@ spectrum while consumes more memory. With fixed f_max and temperature <i>T</i><sup>cl</sup> as a function of target quantum bath temperature. Memory usage per processor could be from 10 to 100 Mbytes.

    -
    -

    Warning

    -

    Unlike the fix nvt command which -performs Nose/Hoover thermostatting AND time integration, this fix -does NOT perform time integration. It only modifies forces to a -colored thermostat. Thus you must use a separate time integration fix, -like fix nve or fix nph to actually -update the velocities and positions of atoms (as shown in the +

    +

    Note

    +

    Unlike the fix nvt command which performs +Nose/Hoover thermostatting AND time integration, this fix does NOT +perform time integration. It only modifies forces to a colored +thermostat. Thus you must use a separate time integration fix, like +fix nve or fix nph to actually update the +velocities and positions of atoms (as shown in the examples). Likewise, this fix should not normally be used with other fixes or commands that also specify system temperatures , e.g. fix nvt and fix temp/rescale.

    @@ -287,7 +287,7 @@ Lett, 103, 190601 (2009).

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -308,7 +308,7 @@ Lett, 103, 190601 (2009).

    @@ -194,7 +194,7 @@ for more info.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -215,7 +215,7 @@ for more info.

    @@ -270,7 +270,7 @@ by default.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -291,7 +291,7 @@ by default.

    @@ -184,29 +184,29 @@ means a fractional distance between the lo/hi box boundaries, e.g. 0.5 = middle of the box. The default is to use lattice units.

    Note that the velocity command can be used to create velocities with zero aggregate linear and/or angular momentum.

    -
    -

    Warning

    -

    This fix performs its operations at the same point in -the timestep as other time integration fixes, such as fix nve, fix nvt, or fix npt. +

    +

    Note

    +

    This fix performs its operations at the same point in the +timestep as other time integration fixes, such as fix nve, fix nvt, or fix npt. Thus fix recenter should normally be the last such fix specified in the input script, since the adjustments it makes to atom coordinates should come after the changes made by time integration. LAMMPS will warn you if your fixes are not ordered this way.

    -
    -

    Warning

    -

    If you use this fix on a small group of atoms (e.g. a -molecule in solvent) without using the shift keyword to adjust the -positions of all atoms in the system, then the results can be -unpredictable. For example, if the molecule is pushed in one -direction by the solvent, its velocity will increase. But its -coordinates will be recentered, meaning it is pushed back towards the -force. Thus over time, the velocity and temperature of the molecule -could become very large (though it won’t appear to be moving due to -the recentering). If you are thermostatting the entire system, then -the solvent would be cooled to compensate. A better solution for this -simulation scenario is to use the fix spring command -to tether the molecule in place.

    +
    +

    Note

    +

    If you use this fix on a small group of atoms (e.g. a molecule +in solvent) without using the shift keyword to adjust the positions +of all atoms in the system, then the results can be unpredictable. +For example, if the molecule is pushed in one direction by the +solvent, its velocity will increase. But its coordinates will be +recentered, meaning it is pushed back towards the force. Thus over +time, the velocity and temperature of the molecule could become very +large (though it won’t appear to be moving due to the recentering). +If you are thermostatting the entire system, then the solvent would be +cooled to compensate. A better solution for this simulation scenario +is to use the fix spring command to tether the +molecule in place.

    @@ -253,7 +253,7 @@ move atoms a large distance.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -274,7 +274,7 @@ move atoms a large distance.

    @@ -180,14 +180,14 @@ angle formed by atoms 1, 2, 3, and 4 near 120 degrees using a constant restraint coefficient. The fourth example applies similar restraints to multiple dihedral angles using a restraint coefficient that increases from 0.0 to 2000.0 over the course of the run.

    -
    -

    Warning

    -

    Adding a force to atoms implies a change in their -potential energy as they move due to the applied force field. For -dynamics via the run command, this energy can be added to -the system’s potential energy for thermodynamic output (see below). -For energy minimization via the minimize command, this -energy must be added to the system’s potential energy to formulate a +

    +

    Note

    +

    Adding a force to atoms implies a change in their potential +energy as they move due to the applied force field. For dynamics via +the run command, this energy can be added to the system’s +potential energy for thermodynamic output (see below). For energy +minimization via the minimize command, this energy +must be added to the system’s potential energy to formulate a self-consistent minimization problem (see below).

    In order for a restraint to be effective, the restraint force must @@ -267,11 +267,11 @@ current dihedral angle phi is equal to phi0.

    The fix_modify energy option is supported by this fix to add the potential energy associated with this fix to the system’s potential energy as part of thermodynamic output.

    -
    -

    Warning

    -

    If you want the fictitious potential energy associated -with the added forces to be included in the total potential energy of -the system (the quantity being minimized), you MUST enable the +

    +

    Note

    +

    If you want the fictitious potential energy associated with the +added forces to be included in the total potential energy of the +system (the quantity being minimized), you MUST enable the fix_modify energy option for this fix.

    This fix computes a global scalar, which can be accessed by various @@ -300,7 +300,7 @@ the run command.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -321,7 +321,7 @@ the run command.

    @@ -250,11 +250,11 @@ ensemble, as described below.

    There are two main variants of this fix, fix rigid and fix rigid/small. The NVE/NVT/NPT/NHT versions belong to one of the two variants, as their style names indicate.

    -
    -

    Warning

    -

    Not all of the bodystyle options and keyword/value -options are available for both the rigid and rigid/small variants. -See details below.

    +
    +

    Note

    +

    Not all of the bodystyle options and keyword/value options are +available for both the rigid and rigid/small variants. See +details below.

    The rigid variant is typically the best choice for a system with a small number of large rigid bodies, each of which can extend across @@ -270,56 +270,56 @@ closest to the geometrical center of the body. The fix operates using local lists of rigid bodies owned by each processor and information is exchanged and summed via local communication between neighboring processors when ghost atom info is accumlated.

    -
    -

    Warning

    -

    To use rigid/small the ghost atom cutoff must be -large enough to span the distance between the atom that owns the body -and every other atom in the body. This distance value is printed out -when the rigid bodies are defined. If the -pair_style cutoff plus neighbor skin does not span -this distance, then you should use the comm_modify cutoff command with a setting epsilon larger than -the distance.

    +
    +

    Note

    +

    To use rigid/small the ghost atom cutoff must be large enough +to span the distance between the atom that owns the body and every +other atom in the body. This distance value is printed out when the +rigid bodies are defined. If the pair_style cutoff +plus neighbor skin does not span this distance, then you should use +the comm_modify cutoff command with a setting +epsilon larger than the distance.

    Which of the two variants is faster for a particular problem is hard to predict. The best way to decide is to perform a short test run. Both variants should give identical numerical answers for short runs. Long runs should give statistically similar results, but round-off differences may accumulate to produce divergent trajectories.

    -
    -

    Warning

    -

    You should not update the atoms in rigid bodies via -other time-integration fixes (e.g. fix nve, fix nvt, fix npt), or you will be integrating +

    +

    Note

    +

    You should not update the atoms in rigid bodies via other +time-integration fixes (e.g. fix nve, fix nvt, fix npt), or you will be integrating their motion more than once each timestep. When performing a hybrid simulation with some atoms in rigid bodies, and some not, a separate time integration fix like fix nve or fix nvt should be used for the non-rigid particles.

    -
    -

    Warning

    -

    These fixes are overkill if you simply want to hold a -collection of atoms stationary or have them move with a constant -velocity. A simpler way to hold atoms stationary is to not include -those atoms in your time integration fix. E.g. use “fix 1 mobile nve” -instead of “fix 1 all nve”, where “mobile” is the group of atoms that -you want to move. You can move atoms with a constant velocity by -assigning them an initial velocity (via the velocity -command), setting the force on them to 0.0 (via the fix setforce command), and integrating them as usual +

    +

    Note

    +

    These fixes are overkill if you simply want to hold a collection +of atoms stationary or have them move with a constant velocity. A +simpler way to hold atoms stationary is to not include those atoms in +your time integration fix. E.g. use “fix 1 mobile nve” instead of +“fix 1 all nve”, where “mobile” is the group of atoms that you want to +move. You can move atoms with a constant velocity by assigning them +an initial velocity (via the velocity command), +setting the force on them to 0.0 (via the fix setforce command), and integrating them as usual (e.g. via the fix nve command).

    -
    -

    Warning

    -

    The aggregate properties of each rigid body are -calculated one time at the start of the first simulation run after -this fix is specified. The properties include the position and -velocity of the center-of-mass of the body, its moments of inertia, -and its angular momentum. This is done using the properties of the -constituent atoms of the body at that point in time (or see the -infile keyword option). Thereafter, changing properties of -individual atoms in the body will have no effect on a rigid body’s -dynamics, unless they effect the pair_style -interactions that individual particles are part of. 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 performed, using the set or +

    +

    Note

    +

    The aggregate properties of each rigid body are calculated one +time at the start of the first simulation run after this fix is +specified. The properties include the position and velocity of the +center-of-mass of the body, its moments of inertia, and its angular +momentum. This is done using the properties of the constituent atoms +of the body at that point in time (or see the infile keyword +option). Thereafter, changing properties of individual atoms in the +body will have no effect on a rigid body’s dynamics, unless they +effect the pair_style interactions that individual +particles are part of. 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 +performed, using the set or displace_atoms or velocity command. But these commands will not affect the internal attributes of the body, and the position and velocity or individual atoms in the @@ -329,13 +329,12 @@ body will be reset when time integration starts.

    Each rigid body must have two or more atoms. An atom can belong to at most one rigid body. Which atoms are in which bodies can be defined via several options.

    -
    -

    Warning

    -

    With fix rigid/small, which requires bodystyle -molecule, you can define a system that has no rigid bodies -initially. This is useful when you are using the mol keyword in -conjunction with another fix that is adding rigid bodies on-the-fly, -such as fix deposit or fix pour.

    +
    +

    Note

    +

    With fix rigid/small, which requires bodystyle molecule, you +can define a system that has no rigid bodies initially. This is +useful when you are using the mol keyword in conjunction with +another fix that is adding rigid bodies on-the-fly, such as fix deposit or fix pour.

    For bodystyle single the entire fix group of atoms is treated as one rigid body. This option is only allowed for fix rigid and its @@ -352,13 +351,13 @@ includes atoms you want to be part of rigid bodies.

    separate rigid body. Only atoms that are also in the fix group are included in each rigid body. This option is only allowed for fix rigid and its sub-styles.

    -
    -

    Warning

    -

    To compute the initial center-of-mass position and -other properties of each rigid body, the image flags for each atom in -the body are used to “unwrap” the atom coordinates. Thus you must -insure that these image flags are consistent so that the unwrapping -creates a valid rigid body (one where the atoms are close together), +

    +

    Note

    +

    To compute the initial center-of-mass position and other +properties of each rigid body, the image flags for each atom in the +body are used to “unwrap” the atom coordinates. Thus you must insure +that these image flags are consistent so that the unwrapping creates a +valid rigid body (one where the atoms are close together), particularly if the atoms in a single rigid body straddle a periodic boundary. This means the input data file or restart file must define the image flags for each atom consistently or that you have used the @@ -395,11 +394,11 @@ means all types from m to n (inclusive). Note that you can use the force or torque keywords as many times as you like. If a particular rigid body has its component flags set multiple times, the settings from the final keyword are used.

    -
    -

    Warning

    -

    For computational efficiency, you may wish to turn off -pairwise and bond interactions within each rigid body, as they no -longer contribute to the motion. The neigh_modify exclude and delete_bonds +

    +

    Note

    +

    For computational efficiency, you may wish to turn off pairwise +and bond interactions within each rigid body, as they no longer +contribute to the motion. The neigh_modify exclude and delete_bonds commands are used to do this. If the rigid bodies have strongly overalapping atoms, you may need to turn off these interactions to avoid numerical problems due to large equal/opposite intra-body forces @@ -539,14 +538,14 @@ integer.

    damp the rotational motion without thermostatting, you can set Tstart and Tstop to 0.0, which means only the viscous drag term in the Langevin thermostat will be applied. See the discussion on the -fix viscous doc page for details.

    -
    -

    Warning

    -

    When the langevin keyword is used with fix rigid -versus fix rigid/small, different dynamics will result for parallel -runs. This is because of the way random numbers are used in the two -cases. The dynamics for the two cases should be statistically -similar, but will not be identical, even for a single timestep.

    +fix viscous doc page for details.

    +
    +

    Note

    +

    When the langevin keyword is used with fix rigid versus fix +rigid/small, different dynamics will result for parallel runs. This +is because of the way random numbers are used in the two cases. The +dynamics for the two cases should be statistically similar, but will +not be identical, even for a single timestep.

    The temp and tparam keywords apply a Nose/Hoover thermostat to the NVT time integration performed by the rigid/nvt style. They cannot @@ -566,16 +565,16 @@ of thumb, increasing the chain length should lead to smaller oscillations. The keyword pchain specifies the number of thermostats in the chain thermostatting the barostat degrees of freedom.

    -
    -

    Warning

    -

    There are alternate ways to thermostat a system of -rigid bodies. You can use fix langevin to treat -the individual particles in the rigid bodies as effectively immersed -in an implicit solvent, e.g. a Brownian dynamics model. For hybrid -systems with both rigid bodies and solvent particles, you can -thermostat only the solvent particles that surround one or more rigid -bodies by appropriate choice of groups in the compute and fix commands -for temperature and thermostatting. The solvent interactions with the +

    +

    Note

    +

    There are alternate ways to thermostat a system of rigid bodies. +You can use fix langevin to treat the individual +particles in the rigid bodies as effectively immersed in an implicit +solvent, e.g. a Brownian dynamics model. For hybrid systems with both +rigid bodies and solvent particles, you can thermostat only the +solvent particles that surround one or more rigid bodies by +appropriate choice of groups in the compute and fix commands for +temperature and thermostatting. The solvent interactions with the rigid bodies should then effectively thermostat the rigid body temperature as well without use of the Langevin or Nose/Hoover options associated with the fix rigid commands.

    @@ -597,7 +596,7 @@ molecule command calculates the other quantities itself.

    those defined initially by this fix via the bodystyle setting.

    Also note that when using the mol keyword, extra restart information about all rigid bodies is written out whenever a restart file is -written out. See the IMPORTANT NOTE in the next section for details.

    +written out. See the NOTE in the next section for details.


    The infile keyword allows a file of rigid body attributes to be read in from a file, rather then having LAMMPS compute them. There are 5 @@ -651,11 +650,11 @@ it is inside the box as defined. A value of 2 means add 2 box lengths to get the true value. A value of -1 means subtract 1 box length to get the true value. LAMMPS updates these flags as the rigid bodies cross periodic boundaries during the simulation.

    -
    -

    Warning

    -

    If you use the infile or mol keywords and write -restart files during a simulation, then each time a restart file is -written, the fix also write an auxiliary restart file with the name +

    +

    Note

    +

    If you use the infile or mol keywords and write restart +files during a simulation, then each time a restart file is written, +the fix also write an auxiliary restart file with the name rfile.rigid, where “rfile” is the name of the restart file, e.g. tmp.restart.10000 and tmp.restart.10000.rigid. This auxiliary file is in the same format described above. Thus it can be used in a @@ -674,8 +673,8 @@ particles in a particular rigid body.

    rotational), except for a collection of point particles lying on a straight line, which has only 5, e.g a dimer. A 2d rigid body has 3 degrees of freedom (2 translational, 1 rotational).

    -
    -

    Warning

    +
    +

    Note

    You may wish to explicitly subtract additional degrees-of-freedom if you use the force and torque keywords to eliminate certain motions of one or more rigid bodies. LAMMPS does @@ -862,7 +861,7 @@ J Chem Phys, 116, 8649 (2002).

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -883,7 +882,7 @@ J Chem Phys, 116, 8649 (2002).

    @@ -300,7 +300,7 @@ associated compute_sa

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with
    Sphinx using a theme provided by Read the Docs. @@ -321,7 +321,7 @@ associated compute_sa @@ -244,7 +244,7 @@ non-zero force to atoms during a minimization.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with
    Sphinx using a theme provided by Read the Docs. @@ -265,7 +265,7 @@ non-zero force to atoms during a minimization.

    @@ -237,18 +237,18 @@ atoms in the bond are in the group specified with the SHAKE fix.

    for in temperature and pressure computations. Similarly, the SHAKE contribution to the pressure of the system (virial) is also accounted for.

    -
    -

    Warning

    -

    This command works by using the current forces on -atoms to caculate an additional constraint force which when added will -leave the atoms in positions that satisfy the SHAKE constraints -(e.g. bond length) after the next time integration step. If you -define fixes (e.g. fix efield) that add additional -force to the atoms after fix shake operates, then this fix will not -take them into account and the time integration will typically not -satisfy the SHAKE constraints. The solution for this is to make sure -that fix shake is defined in your input script after any other fixes -which add or change forces (to atoms that fix shake operates on).

    +
    +

    Note

    +

    This command works by using the current forces on atoms to +caculate an additional constraint force which when added will leave +the atoms in positions that satisfy the SHAKE constraints (e.g. bond +length) after the next time integration step. If you define fixes +(e.g. fix efield) that add additional force to the +atoms after fix shake operates, then this fix will not take them into +account and the time integration will typically not satisfy the SHAKE +constraints. The solution for this is to make sure that fix shake is +defined in your input script after any other fixes which add or change +forces (to atoms that fix shake operates on).


    The mol keyword should be used when other commands, such as fix deposit or fix pour, add molecules @@ -280,16 +280,16 @@ more instructions on how to use the accelerated styles effectively.

    The velocity constraints lead to a linear system of equations which can be solved analytically. The implementation of the algorithm in LAMMPS closely follows (Andersen (1983)).

    -
    -

    Warning

    -

    The fix rattle command modifies forces and velocities -and thus should be defined after all other integration fixes in your -input script. If you define other fixes that modify velocities or -forces after fix rattle operates, then fix rattle will not take them -into account and the overall time integration will typically not -satisfy the RATTLE constraints. You can check whether the constraints -work correctly by setting the value of RATTLE_DEBUG in -src/fix_rattle.cpp to 1 and recompiling LAMMPS.

    +
    +

    Note

    +

    The fix rattle command modifies forces and velocities and thus +should be defined after all other integration fixes in your input +script. If you define other fixes that modify velocities or forces +after fix rattle operates, then fix rattle will not take them into +account and the overall time integration will typically not satisfy +the RATTLE constraints. You can check whether the constraints work +correctly by setting the value of RATTLE_DEBUG in src/fix_rattle.cpp +to 1 and recompiling LAMMPS.


    @@ -333,7 +333,7 @@ J of Comp Phys, 23, 327-341 (1977).

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -354,7 +354,7 @@ J of Comp Phys, 23, 327-341 (1977).

    @@ -269,7 +269,7 @@ Jarzynski, Phys. Rev. Lett. 78, 2690 (1997)

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -290,7 +290,7 @@ Jarzynski, Phys. Rev. Lett. 78, 2690 (1997)

    @@ -185,7 +185,7 @@ section for more info.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -206,7 +206,7 @@ section for more info.

    @@ -183,7 +183,7 @@ section for more info.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -204,7 +204,7 @@ section for more info.

    @@ -191,7 +191,7 @@ section for more info.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -212,7 +212,7 @@ section for more info.

    @@ -202,7 +202,7 @@ section for more info.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -223,7 +223,7 @@ section for more info.

    @@ -208,7 +208,7 @@ section for more info.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -229,7 +229,7 @@ section for more info.

    @@ -135,7 +135,7 @@

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -156,7 +156,7 @@ @@ -189,7 +189,7 @@ section for more info. The molecule ID given to the particles created by this fi

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -210,7 +210,7 @@ section for more info. The molecule ID given to the particles created by this fi @@ -202,16 +202,16 @@ within the pore. The fifth example holds the ion a distance of -20 below the z = 0 center plane of the pore (umbrella sampling). The last example holds the ion a distance 5 away from the pore axis (assuming the center-of-mass of the pore in x,y is the pore axis).

    -
    -

    Warning

    -

    The center of mass of a group of atoms is calculated -in “unwrapped” coordinates using atom image flags, which means that -the group can straddle a periodic boundary. See the dump -doc page for a discussion of unwrapped coordinates. It also means -that a spring connecting two groups or a group and the tether point -can cross a periodic boundary and its length be calculated correctly. -One exception is for rigid bodies, which should not be used with the -fix spring command, if the rigid body will cross a periodic boundary. +

    +

    Note

    +

    The center of mass of a group of atoms is calculated in +“unwrapped” coordinates using atom image flags, which means that the +group can straddle a periodic boundary. See the dump doc +page for a discussion of unwrapped coordinates. It also means that a +spring connecting two groups or a group and the tether point can cross +a periodic boundary and its length be calculated correctly. One +exception is for rigid bodies, which should not be used with the fix +spring command, if the rigid body will cross a periodic boundary. This is because image flags for rigid bodies are used in a different way, as explained on the fix rigid doc page.

    @@ -240,12 +240,12 @@ potential of mean force (PMF).

    the run command.

    The forces due to this fix are imposed during an energy minimization, invoked by the minimize command.

    -
    -

    Warning

    -

    If you want the spring energy to be included in the -total potential energy of the system (the quantity being minimized), -you MUST enable the fix_modify energy option for -this fix.

    +
    +

    Note

    +

    If you want the spring energy to be included in the total +potential energy of the system (the quantity being minimized), you +MUST enable the fix_modify energy option for this +fix.

    @@ -271,7 +271,7 @@ this fix.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -292,7 +292,7 @@ this fix.

    @@ -198,7 +198,7 @@ This fix is not invoked during

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -219,7 +219,7 @@ This fix is not invoked during var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/fix_spring_self.html b/doc/fix_spring_self.html index d3ee397f21..ef3b811b8b 100644 --- a/doc/fix_spring_self.html +++ b/doc/fix_spring_self.html @@ -8,7 +8,7 @@ - fix spring/self command — LAMMPS 15 May 2015 version documentation + fix spring/self command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -180,12 +180,12 @@ fix is “extensive”.

    the
    run command.

    The forces due to this fix are imposed during an energy minimization, invoked by the minimize command.

    -
    -

    Warning

    -

    If you want the per-atom spring energy to be included -in the total potential energy of the system (the quantity being -minimized), you MUST enable the fix_modify energy -option for this fix.

    +
    +

    Note

    +

    If you want the per-atom spring energy to be included in the +total potential energy of the system (the quantity being minimized), +you MUST enable the fix_modify energy option for +this fix.

    @@ -211,7 +211,7 @@ option for this fix.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -232,7 +232,7 @@ option for this fix.

    @@ -326,11 +326,11 @@ if the ratio of any 2 bin dimensions exceeds (1 +/- tolerance) then an error or warning is generated. Similarly, if the ratio of any bin dimension with hgrid exceeds (1 +/- tolerance), then an error or warning is generated.

    -
    -

    Warning

    -

    The fix srd command can be used with simluations the -size and/or shape of the simulation box changes. This can be due to -non-periodic boundary conditions or the use of fixes such as the fix deform or fix wall/srd commands +

    +

    Note

    +

    The fix srd command can be used with simluations the size and/or +shape of the simulation box changes. This can be due to non-periodic +boundary conditions or the use of fixes such as the fix deform or fix wall/srd commands to impose a shear on an SRD fluid or an interaction with an external wall. If the box size changes then the size of SRD bins must be recalculated every reneighboring. This is not necessary if only the @@ -399,14 +399,13 @@ rescaling off during collisions and the per-bin velocity rotation operation. The collide and rotate values turn it on for one of the operations and off for the other.


    -
    -

    Warning

    -

    This fix is normally used for simulations with a huge -number of SRD particles relative to the number of big particles, -e.g. 100 to 1. In this scenario, computations that involve only big -particles (neighbor list creation, communication, time integration) -can slow down dramatically due to the large number of background SRD -particles.

    +
    +

    Note

    +

    This fix is normally used for simulations with a huge number of +SRD particles relative to the number of big particles, e.g. 100 to 1. +In this scenario, computations that involve only big particles +(neighbor list creation, communication, time integration) can slow +down dramatically due to the large number of background SRD particles.

    Three other input script commands will largely overcome this effect, speeding up an SRD simulation by a significant amount. These are the @@ -522,7 +521,7 @@ Chem Phys, 132, 174106 (2010).

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -543,7 +542,7 @@ Chem Phys, 132, 174106 (2010).

    @@ -157,17 +157,16 @@ forces have been calculated. It is the point in the timestep when various fixes that compute constraint forces are calculated and potentially modify the force on each atom. Examples of such fixes are fix shake, fix wall, and fix indent.

    -
    -

    Warning

    -

    The order in which various fixes are applied which -operate at the same point during the timestep, is the same as the -order they are specified in the input script. Thus normally, if you -want to store per-atom forces due to force field interactions, before -constraints are applied, you should list this fix first within that -set of fixes, i.e. before other fixes that apply constraints. -However, if you wish to include certain constraints (e.g. fix shake) -in the stored force, then it could be specified after some fixes and -before others.

    +
    +

    Note

    +

    The order in which various fixes are applied which operate at +the same point during the timestep, is the same as the order they are +specified in the input script. Thus normally, if you want to store +per-atom forces due to force field interactions, before constraints +are applied, you should list this fix first within that set of fixes, +i.e. before other fixes that apply constraints. However, if you wish +to include certain constraints (e.g. fix shake) in the stored force, +then it could be specified after some fixes and before others.

    @@ -203,7 +202,7 @@ the run command. Thi

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -224,7 +223,7 @@ the run command. Thi @@ -199,12 +199,12 @@ inputs. And see for example, the atom-style variable commands.

    If N is not zero, then the attributes will be updated every N steps.

    -
    -

    Warning

    -

    Actually, only atom attributes specified by keywords -like xu or vy are initially stored immediately at the point in -your input script when the fix is defined. Attributes specified by a -compute, fix, or variable are not initially stored until the first run +

    +

    Note

    +

    Actually, only atom attributes specified by keywords like xu +or vy are initially stored immediately at the point in your input +script when the fix is defined. Attributes specified by a compute, +fix, or variable are not initially stored until the first run following the fix definition begins. This is because calculating those attributes may require quantities that are not defined in between runs.

    @@ -261,7 +261,7 @@ the run command. Thi

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -282,7 +282,7 @@ the run command. Thi @@ -178,16 +178,16 @@ its value used to determine the target temperature.

    functions, and include thermo_style command keywords for the simulation box parameters and timestep and elapsed time. Thus it is easy to specify a time-dependent temperature.

    -
    -

    Warning

    -

    Unlike the fix nvt command which -performs Nose/Hoover thermostatting AND time integration, this fix -does NOT perform time integration. It only modifies velocities to -effect thermostatting. Thus you must use a separate time integration -fix, like fix nve to actually update the positions of -atoms using the modified velocities. Likewise, this fix should not -normally be used on atoms that also have their temperature controlled -by another fix - e.g. by fix nvt or fix langevin commands.

    +
    +

    Note

    +

    Unlike the fix nvt command which performs +Nose/Hoover thermostatting AND time integration, this fix does NOT +perform time integration. It only modifies velocities to effect +thermostatting. Thus you must use a separate time integration fix, +like fix nve to actually update the positions of atoms +using the modified velocities. Likewise, this fix should not normally +be used on atoms that also have their temperature controlled by +another fix - e.g. by fix nvt or fix langevin commands.

    See this howto section of the manual for a discussion of different ways to compute temperature and perform @@ -290,7 +290,7 @@ Phys, 81, 3684 (1984).

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -311,7 +311,7 @@ Phys, 81, 3684 (1984).

    @@ -193,11 +193,11 @@ its value used to determine the target temperature.

    functions, and include thermo_style command keywords for the simulation box parameters and timestep and elapsed time. Thus it is easy to specify a time-dependent temperature.

    -
    -

    Warning

    -

    Unlike the fix nvt command which -performs Nose/Hoover thermostatting AND time integration, these fixes -do NOT perform time integration. They only modify velocities to effect +

    +

    Note

    +

    Unlike the fix nvt command which performs +Nose/Hoover thermostatting AND time integration, these fixes do NOT +perform time integration. They only modify velocities to effect thermostatting. Thus you must use a separate time integration fix, like fix nve to actually update the positions of atoms using the modified velocities. Likewise, these fixes should not @@ -289,7 +289,7 @@ over time or the atom count becomes very small.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -310,7 +310,7 @@ over time or the atom count becomes very small.

    @@ -187,16 +187,16 @@ of rescaling that is applied is a fraction (from 0.0 to 1.0) of the difference between the actual and desired temperature. E.g. if fraction = 1.0, the temperature is reset to exactly the desired value.

    -
    -

    Warning

    -

    Unlike the fix nvt command which -performs Nose/Hoover thermostatting AND time integration, this fix -does NOT perform time integration. It only modifies velocities to -effect thermostatting. Thus you must use a separate time integration -fix, like fix nve to actually update the positions of -atoms using the modified velocities. Likewise, this fix should not -normally be used on atoms that also have their temperature controlled -by another fix - e.g. by fix nvt or fix langevin commands.

    +
    +

    Note

    +

    Unlike the fix nvt command which performs +Nose/Hoover thermostatting AND time integration, this fix does NOT +perform time integration. It only modifies velocities to effect +thermostatting. Thus you must use a separate time integration fix, +like fix nve to actually update the positions of atoms +using the modified velocities. Likewise, this fix should not normally +be used on atoms that also have their temperature controlled by +another fix - e.g. by fix nvt or fix langevin commands.

    See this howto section of the manual for a discussion of different ways to compute temperature and perform @@ -290,7 +290,7 @@ calculated by this fix is “extensive”.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -311,7 +311,7 @@ calculated by this fix is “extensive”.

    @@ -198,7 +198,7 @@ LAMMPS was built with that package. See the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -219,7 +219,7 @@ LAMMPS was built with that package. See the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/fix_tfmc.html b/doc/fix_tfmc.html index 38d84ba4da..c3c9728c2d 100644 --- a/doc/fix_tfmc.html +++ b/doc/fix_tfmc.html @@ -8,7 +8,7 @@ - fix tfmc command — LAMMPS 15 May 2015 version documentation + fix tfmc command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -217,15 +217,15 @@ be shifted (after every tfMC iteration) in order to fix the position of the center-of-mass along the included directions, by setting the corresponding flag to 1. The rot keyword does the same for the rotational component of the tfMC displacements after every iteration.

    -
    -

    Warning

    -

    the com and rot keywords should not be used if an -external force is acting on the specified fix group, along the -included directions. This can be either a true external force (e.g. -through fix wall) or forces due to the interaction -with atoms not included in the fix group. This is because in such -cases, translations or rotations of the fix group could be induced by -these external forces, and removing them will lead to a violation of +

    +

    Note

    +

    the com and rot keywords should not be used if an external +force is acting on the specified fix group, along the included +directions. This can be either a true external force (e.g. through +fix wall) or forces due to the interaction with atoms +not included in the fix group. This is because in such cases, +translations or rotations of the fix group could be induced by these +external forces, and removing them will lead to a violation of detailed balance.

    @@ -269,7 +269,7 @@ A. Stesmans, Phys. Rev. B 85, 134301 (2012).

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -290,7 +290,7 @@ A. Stesmans, Phys. Rev. B 85, 134301 (2012).

    @@ -203,23 +203,23 @@ quantity by time and the cross-sectional area of the simulation box yields a heat flux. The ratio of heat flux to the slope of the temperature profile is proportional to the thermal conductivity of the fluid, in appropriate units. See the Muller-Plathe paper for details.

    -
    -

    Warning

    -

    If your system is periodic in the direction of the -heat flux, then the flux is going in 2 directions. This means the -effective heat flux in one direction is reduced by a factor of 2. You -will see this in the equations for thermal conductivity (kappa) in the -Muller-Plathe paper. LAMMPS is simply tallying kinetic energy which -does not account for whether or not your system is periodic; you must -use the value appropriately to yield a kappa for your system.

    +
    +

    Note

    +

    If your system is periodic in the direction of the heat flux, +then the flux is going in 2 directions. This means the effective heat +flux in one direction is reduced by a factor of 2. You will see this +in the equations for thermal conductivity (kappa) in the Muller-Plathe +paper. LAMMPS is simply tallying kinetic energy which does not +account for whether or not your system is periodic; you must use the +value appropriately to yield a kappa for your system.

    -
    -

    Warning

    -

    After equilibration, if the temperature gradient you -observe is not linear, then you are likely swapping energy too -frequently and are not in a regime of linear response. In this case -you cannot accurately infer a thermal conductivity and should try -increasing the Nevery parameter.

    +
    +

    Note

    +

    After equilibration, if the temperature gradient you observe is +not linear, then you are likely swapping energy too frequently and are +not in a regime of linear response. In this case you cannot +accurately infer a thermal conductivity and should try increasing the +Nevery parameter.

    @@ -280,7 +280,7 @@ bewteen solvent particles.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -301,7 +301,7 @@ bewteen solvent particles.

    @@ -243,7 +243,7 @@ LAMMPS was built with those packages. See the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -264,7 +264,7 @@ LAMMPS was built with those packages. See the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/fix_ti_spring.html b/doc/fix_ti_spring.html index 327b4b8a74..1e3e5ddee4 100644 --- a/doc/fix_ti_spring.html +++ b/doc/fix_ti_spring.html @@ -8,7 +8,7 @@ - fix ti/spring command — LAMMPS 15 May 2015 version documentation + fix ti/spring command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -192,12 +192,12 @@ switching function

    (0 and 1), according to (
    de Koning96) this results in smaller fluctuations on the integral to be computed on the thermodynamic integration.

    -
    -

    Warning

    -

    It is importante to keep the center of mass fixed -during the thermodynamic integration, a non-zero total velocity will -result in divergencies during the integration due to the fact that the -atoms are ‘attatched’ to its equilibrium positions by the Einstein +

    +

    Note

    +

    It is importante to keep the center of mass fixed during the +thermodynamic integration, a non-zero total velocity will result in +divergencies during the integration due to the fact that the atoms are +‘attatched’ to its equilibrium positions by the Einstein crystal. Check the option zero of fix langevin and velocity. The use of the Nose-Hoover thermostat (fix nvt) is NOT recommended due to its well documented @@ -226,12 +226,12 @@ fix are “extensive”.

    the run command.

    The forces due to this fix are imposed during an energy minimization, invoked by the minimize command.

    -
    -

    Warning

    -

    If you want the per-atom spring energy to be included -in the total potential energy of the system (the quantity being -minimized), you MUST enable the fix modify energy -option for this fix.

    +
    +

    Note

    +

    If you want the per-atom spring energy to be included in the +total potential energy of the system (the quantity being minimized), +you MUST enable the fix modify energy option for +this fix.

    An example script using this command is provided in the examples/USER/misc/ti directory.

    @@ -267,7 +267,7 @@ LAMMPS was built with those packages. See the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -288,7 +288,7 @@ LAMMPS was built with those packages. See the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/fix_ti_spring.txt b/doc/fix_ti_spring.txt index eb8ff0c76c..2061e46bb1 100755 --- a/doc/fix_ti_spring.txt +++ b/doc/fix_ti_spring.txt @@ -82,10 +82,10 @@ This function has zero slope as lambda approaches its extreme values smaller fluctuations on the integral to be computed on the thermodynamic integration. -IMPORTANT NOTE: It is importante to keep the center of mass fixed -during the thermodynamic integration, a non-zero total velocity will -result in divergencies during the integration due to the fact that the -atoms are 'attatched' to its equilibrium positions by the Einstein +NOTE: It is importante to keep the center of mass fixed during the +thermodynamic integration, a non-zero total velocity will result in +divergencies during the integration due to the fact that the atoms are +'attatched' to its equilibrium positions by the Einstein crystal. Check the option {zero} of "fix langevin"_fix_langevin_html and "velocity"_velocity.html. The use of the Nose-Hoover thermostat ("fix nvt"_fix_nvt.html) is NOT recommended due to its well documented @@ -121,10 +121,10 @@ the "run"_run.html command. The forces due to this fix are imposed during an energy minimization, invoked by the "minimize"_minimize.html command. -IMPORTANT NOTE: If you want the per-atom spring energy to be included -in the total potential energy of the system (the quantity being -minimized), you MUST enable the "fix modify"_fix_modify.html {energy} -option for this fix. +NOTE: If you want the per-atom spring energy to be included in the +total potential energy of the system (the quantity being minimized), +you MUST enable the "fix modify"_fix_modify.html {energy} option for +this fix. An example script using this command is provided in the examples/USER/misc/ti directory. diff --git a/doc/fix_tmd.html b/doc/fix_tmd.html index 789a380e93..fd0592a155 100644 --- a/doc/fix_tmd.html +++ b/doc/fix_tmd.html @@ -8,7 +8,7 @@ - fix tmd command — LAMMPS 15 May 2015 version documentation + fix tmd command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -243,7 +243,7 @@ Physics, 101, 3439-3443 (2003).

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with
    Sphinx using a theme provided by Read the Docs. @@ -264,7 +264,7 @@ Physics, 101, 3439-3443 (2003).

    @@ -277,13 +277,13 @@ scales their velocities. Thus a time integration fix (e.g. fix nvt or fix langevin.

    -
    -

    Warning

    -

    The current implementations of these fixes create a -copy of the electron grid that overlays the entire simulation domain, -for each processor. Values on the grid are summed across all -processors. Thus you should insure that this grid is not too large, -else your simulation could incur high memory and communication costs.

    +
    +

    Note

    +

    The current implementations of these fixes create a copy of the +electron grid that overlays the entire simulation domain, for each +processor. Values on the grid are summed across all processors. Thus +you should insure that this grid is not too large, else your +simulation could incur high memory and communication costs.


    Additional details for fix ttm/mod

    @@ -426,7 +426,7 @@ Plasma Phys., 53, 129-139 (2013).

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -447,7 +447,7 @@ Plasma Phys., 53, 129-139 (2013).

    @@ -220,7 +220,7 @@ called. Reneighboring is required.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -241,7 +241,7 @@ called. Reneighboring is required.

    @@ -276,7 +276,7 @@ stored values.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -297,7 +297,7 @@ stored values.

    @@ -202,23 +202,23 @@ quantity by time and the cross-sectional area of the simulation box yields a momentum flux. The ratio of momentum flux to the slope of the shear velocity profile is proportional to the viscosity of the fluid, in appropriate units. See the Muller-Plathe paper for details.

    -
    -

    Warning

    -

    If your system is periodic in the direction of the -momentum flux, then the flux is going in 2 directions. This means the +

    +

    Note

    +

    If your system is periodic in the direction of the momentum +flux, then the flux is going in 2 directions. This means the effective momentum flux in one direction is reduced by a factor of 2. You will see this in the equations for viscosity in the Muller-Plathe paper. LAMMPS is simply tallying momentum which does not account for whether or not your system is periodic; you must use the value appropriately to yield a viscosity for your system.

    -
    -

    Warning

    -

    After equilibration, if the velocity profile you -observe is not linear, then you are likely swapping momentum too -frequently and are not in a regime of linear response. In this case -you cannot accurately infer a viscosity and should try increasing -the Nevery parameter.

    +
    +

    Note

    +

    After equilibration, if the velocity profile you observe is not +linear, then you are likely swapping momentum too frequently and are +not in a regime of linear response. In this case you cannot +accurately infer a viscosity and should try increasing the Nevery +parameter.

    An alternative method for calculating a viscosity is to run a NEMD simulation, as described in Section_howto 13 of the manual. NEMD simulations @@ -284,7 +284,7 @@ solvent particles.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -305,7 +305,7 @@ solvent particles.

    @@ -170,11 +170,11 @@ the coefficient, the faster the kinetic energy is reduced. If the optional keyword scale is used, gamma can scaled up or down by the specified factor for atoms of that type. It can be used multiple times to adjust gamma for several atom types.

    -
    -

    Warning

    -

    You should specify gamma in force/velocity units. -This is not the same as mass/time units, at least for some of the -LAMMPS units options like “real” or “metal” that are not +

    +

    Note

    +

    You should specify gamma in force/velocity units. This is not +the same as mass/time units, at least for some of the LAMMPS +units options like “real” or “metal” that are not self-consistent.

    In a Brownian dynamics context, gamma = Kb T / D, where Kb = @@ -247,7 +247,7 @@ for details.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -268,7 +268,7 @@ for details.

    @@ -272,15 +272,15 @@ Equal-style variables can specify formulas with various mathematical functions, and include thermo_style command keywords for the simulation box parameters and timestep and elapsed time. Thus it is easy to specify a time-dependent wall interaction.

    -
    -

    Warning

    -

    For all of the styles, you must insure that r is -always > 0 for all particles in the group, or LAMMPS will generate an -error. This means you cannot start your simulation with particles at -the wall position coord (r = 0) or with particles on the wrong side -of the wall (r < 0). For the wall/lj93 and wall/lj126 styles, the -energy of the wall/particle interaction (and hence the force on the -particle) blows up as r -> 0. The wall/colloid style is even more +

    +

    Note

    +

    For all of the styles, you must insure that r is always > 0 for +all particles in the group, or LAMMPS will generate an error. This +means you cannot start your simulation with particles at the wall +position coord (r = 0) or with particles on the wrong side of the +wall (r < 0). For the wall/lj93 and wall/lj126 styles, the energy +of the wall/particle interaction (and hence the force on the particle) +blows up as r -> 0. The wall/colloid style is even more restrictive, since the energy blows up as D = r-R -> 0. This means the finite-size particles of radius R must be a distance larger than R from the wall position coord. The harmonic style is a softer @@ -375,12 +375,12 @@ The scalar and vector values calculated by this fix are “extensive”. the run command.

    The forces due to this fix are imposed during an energy minimization, invoked by the minimize command.

    -
    -

    Warning

    -

    If you want the atom/wall interaction energy to be -included in the total potential energy of the system (the quantity -being minimized), you MUST enable the fix_modify -energy option for this fix.

    +
    +

    Note

    +

    If you want the atom/wall interaction energy to be included in +the total potential energy of the system (the quantity being +minimized), you MUST enable the fix_modify energy +option for this fix.

    @@ -413,7 +413,7 @@ erratum in JCP 84, 2901 (1986).

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -434,7 +434,7 @@ erratum in JCP 84, 2901 (1986).

    @@ -197,8 +197,8 @@ that page. Note that you can choose different values for these 6 wall/particle coefficients than for particle/particle interactions, if you wish your wall to interact differently with the particles, e.g. if the wall is a different material.

    -
    -

    Warning

    +
    +

    Note

    As discussed on the doc page for pair_style granular, versions of LAMMPS before 9Jan09 used a different equation for Hertzian interactions. This means Hertizian wall/particle interactions have also changed. They now include a @@ -285,7 +285,7 @@ LAMMPS was built with that package. See the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -306,7 +306,7 @@ LAMMPS was built with that package. See the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/fix_wall_gran.txt b/doc/fix_wall_gran.txt index 78d36fcca0..c39b7e6a79 100644 --- a/doc/fix_wall_gran.txt +++ b/doc/fix_wall_gran.txt @@ -72,7 +72,7 @@ wall/particle coefficients than for particle/particle interactions, if you wish your wall to interact differently with the particles, e.g. if the wall is a different material. -IMPORTANT NOTE: As discussed on the doc page for "pair_style +NOTE: As discussed on the doc page for "pair_style granular"_pair_gran.html, versions of LAMMPS before 9Jan09 used a different equation for Hertzian interactions. This means Hertizian wall/particle interactions have also changed. They now include a diff --git a/doc/fix_wall_piston.html b/doc/fix_wall_piston.html index 463ced750f..bbd233129b 100644 --- a/doc/fix_wall_piston.html +++ b/doc/fix_wall_piston.html @@ -8,7 +8,7 @@ - fix wall/piston command — LAMMPS 15 May 2015 version documentation + fix wall/piston command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -240,7 +240,7 @@ displaces atoms directly rather than exerting a force on them.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with
    Sphinx using a theme provided by Read the Docs. @@ -261,7 +261,7 @@ displaces atoms directly rather than exerting a force on them.

    @@ -303,7 +303,7 @@ error.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -324,7 +324,7 @@ error.

    @@ -171,11 +171,11 @@ construct particle containers with complex shapes. Regions can also change over time via the region command keywords (move) and rotate. If such a region is used with this fix, then the of region surface will move over time in the corresponding manner.

    -
    -

    Warning

    -

    As discussed on the region command doc -page, regions in LAMMPS do not get wrapped across periodic boundaries. -It is up to you to insure that periodic or non-periodic boundaries are +

    +

    Note

    +

    As discussed on the region command doc page, +regions in LAMMPS do not get wrapped across periodic boundaries. It +is up to you to insure that periodic or non-periodic boundaries are specified appropriately via the boundary command when using a region as a wall that bounds particle motion. This also means that if you embed a region in your simulation box and want it to @@ -183,41 +183,41 @@ repulse particles from its surface (using the “side out” option in t region command), that its repulsive force will not be felt across a periodic boundary.

    -
    -

    Warning

    -

    For primitive regions with sharp corners and/or edges -(e.g. a block or cylinder), wall/particle forces are computed -accurately for both interior and exterior regions. For union and -intersect regions, additional sharp corners and edges may be present -due to the intersection of the surfaces of 2 or more primitive -volumes. These corners and edges can be of two types: concave or -convex. Concave points/edges are like the corners of a cube as seen -by particles in the interior of a cube. Wall/particle forces around -these features are computed correctly. Convex points/edges are like -the corners of a cube as seen by particles exterior to the cube, -i.e. the points jut into the volume where particles are present. -LAMMPS does NOT compute the location of these convex points directly, -and hence wall/particle forces in the cutoff volume around these -points suffer from inaccuracies. The basic problem is that the -outward normal of the surface is not continuous at these points. This -can cause particles to feel no force (they don’t “see” the wall) when -in one location, then move a distance epsilon, and suddenly feel a -large force because they now “see” the wall. In a worst-case -scenario, this can blow particles out of the simulation box. Thus, as -a general rule you should not use the fix wall/region command with -union or interesect regions that have convex points or edges.

    +
    +

    Note

    +

    For primitive regions with sharp corners and/or edges (e.g. a +block or cylinder), wall/particle forces are computed accurately for +both interior and exterior regions. For union and intersect +regions, additional sharp corners and edges may be present due to the +intersection of the surfaces of 2 or more primitive volumes. These +corners and edges can be of two types: concave or convex. Concave +points/edges are like the corners of a cube as seen by particles in +the interior of a cube. Wall/particle forces around these features +are computed correctly. Convex points/edges are like the corners of a +cube as seen by particles exterior to the cube, i.e. the points jut +into the volume where particles are present. LAMMPS does NOT compute +the location of these convex points directly, and hence wall/particle +forces in the cutoff volume around these points suffer from +inaccuracies. The basic problem is that the outward normal of the +surface is not continuous at these points. This can cause particles +to feel no force (they don’t “see” the wall) when in one location, +then move a distance epsilon, and suddenly feel a large force because +they now “see” the wall. In a worst-case scenario, this can blow +particles out of the simulation box. Thus, as a general rule you +should not use the fix wall/region command with union or +interesect regions that have convex points or edges.

    -
    -

    Warning

    -

    Similarly, you should not define union or -intersert regions for use with this command that share a common -face, even if the face is smooth. E.g. two regions of style block in -a union region, where the two blocks have the same face. This is -because LAMMPS discards points that are part of multiple sub-regions -when calculating wall/particle interactions, to avoid double-counting -the interaction. Having two coincident faces could cause the face to -become invisible to the particles. The solution is to make the two -faces differ by epsilon in their position.

    +
    +

    Note

    +

    Similarly, you should not define union or intersert regions +for use with this command that share a common face, even if the face +is smooth. E.g. two regions of style block in a union region, where +the two blocks have the same face. This is because LAMMPS discards +points that are part of multiple sub-regions when calculating +wall/particle interactions, to avoid double-counting the interaction. +Having two coincident faces could cause the face to become invisible +to the particles. The solution is to make the two faces differ by +epsilon in their position.

    The energy of wall-particle interactions depends on the specified style.

    @@ -261,21 +261,21 @@ constant K, and has units (energy/distance^2). The input parameter sigma is ignored. The minimum energy position of the harmonic spring is at the cutoff. This is a repulsive-only spring since the interaction is truncated at the cutoff

    -
    -

    Warning

    -

    For all of the styles, you must insure that r is -always > 0 for all particles in the group, or LAMMPS will generate an -error. This means you cannot start your simulation with particles on -the region surface (r = 0) or with particles on the wrong side of the -region surface (r < 0). For the wall/lj93 and wall/lj126 styles, -the energy of the wall/particle interaction (and hence the force on -the particle) blows up as r -> 0. The wall/colloid style is even -more restrictive, since the energy blows up as D = r-R -> 0. This -means the finite-size particles of radius R must be a distance larger -than R from the region surface. The harmonic style is a softer -potential and does not blow up as r -> 0, but you must use a large -enough epsilon that particles always reamin on the correct side of -the region surface (r > 0).

    +
    +

    Note

    +

    For all of the styles, you must insure that r is always > 0 for +all particles in the group, or LAMMPS will generate an error. This +means you cannot start your simulation with particles on the region +surface (r = 0) or with particles on the wrong side of the region +surface (r < 0). For the wall/lj93 and wall/lj126 styles, the +energy of the wall/particle interaction (and hence the force on the +particle) blows up as r -> 0. The wall/colloid style is even more +restrictive, since the energy blows up as D = r-R -> 0. This means +the finite-size particles of radius R must be a distance larger than R +from the region surface. The harmonic style is a softer potential +and does not blow up as r -> 0, but you must use a large enough +epsilon that particles always reamin on the correct side of the +region surface (r > 0).

    @@ -295,12 +295,12 @@ particles. The scalar and vector values calculated by this fix are the run command.

    The forces due to this fix are imposed during an energy minimization, invoked by the minimize command.

    -
    -

    Warning

    -

    If you want the atom/wall interaction energy to be -included in the total potential energy of the system (the quantity -being minimized), you MUST enable the fix_modify -energy option for this fix.

    +
    +

    Note

    +

    If you want the atom/wall interaction energy to be included in +the total potential energy of the system (the quantity being +minimized), you MUST enable the fix_modify energy +option for this fix.

    @@ -328,7 +328,7 @@ being minimized), you MUST enable the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -349,7 +349,7 @@ being minimized), you MUST enable the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/fix_wall_region.txt b/doc/fix_wall_region.txt index cccfbca83c..2d8bec3007 100644 --- a/doc/fix_wall_region.txt +++ b/doc/fix_wall_region.txt @@ -50,9 +50,9 @@ change over time via the "region"_region.html command keywords (move) and {rotate}. If such a region is used with this fix, then the of region surface will move over time in the corresponding manner. -IMPORTANT NOTE: As discussed on the "region"_region.html command doc -page, regions in LAMMPS do not get wrapped across periodic boundaries. -It is up to you to insure that periodic or non-periodic boundaries are +NOTE: As discussed on the "region"_region.html command doc page, +regions in LAMMPS do not get wrapped across periodic boundaries. It +is up to you to insure that periodic or non-periodic boundaries are specified appropriately via the "boundary"_boundary.html command when using a region as a wall that bounds particle motion. This also means that if you embed a region in your simulation box and want it to @@ -60,37 +60,37 @@ repulse particles from its surface (using the "side out" option in the "region"_region.html command), that its repulsive force will not be felt across a periodic boundary. -IMPORTANT NOTE: For primitive regions with sharp corners and/or edges -(e.g. a block or cylinder), wall/particle forces are computed -accurately for both interior and exterior regions. For {union} and -{intersect} regions, additional sharp corners and edges may be present -due to the intersection of the surfaces of 2 or more primitive -volumes. These corners and edges can be of two types: concave or -convex. Concave points/edges are like the corners of a cube as seen -by particles in the interior of a cube. Wall/particle forces around -these features are computed correctly. Convex points/edges are like -the corners of a cube as seen by particles exterior to the cube, -i.e. the points jut into the volume where particles are present. -LAMMPS does NOT compute the location of these convex points directly, -and hence wall/particle forces in the cutoff volume around these -points suffer from inaccuracies. The basic problem is that the -outward normal of the surface is not continuous at these points. This -can cause particles to feel no force (they don't "see" the wall) when -in one location, then move a distance epsilon, and suddenly feel a -large force because they now "see" the wall. In a worst-case -scenario, this can blow particles out of the simulation box. Thus, as -a general rule you should not use the fix wall/region command with -{union} or {interesect} regions that have convex points or edges. +NOTE: For primitive regions with sharp corners and/or edges (e.g. a +block or cylinder), wall/particle forces are computed accurately for +both interior and exterior regions. For {union} and {intersect} +regions, additional sharp corners and edges may be present due to the +intersection of the surfaces of 2 or more primitive volumes. These +corners and edges can be of two types: concave or convex. Concave +points/edges are like the corners of a cube as seen by particles in +the interior of a cube. Wall/particle forces around these features +are computed correctly. Convex points/edges are like the corners of a +cube as seen by particles exterior to the cube, i.e. the points jut +into the volume where particles are present. LAMMPS does NOT compute +the location of these convex points directly, and hence wall/particle +forces in the cutoff volume around these points suffer from +inaccuracies. The basic problem is that the outward normal of the +surface is not continuous at these points. This can cause particles +to feel no force (they don't "see" the wall) when in one location, +then move a distance epsilon, and suddenly feel a large force because +they now "see" the wall. In a worst-case scenario, this can blow +particles out of the simulation box. Thus, as a general rule you +should not use the fix wall/region command with {union} or +{interesect} regions that have convex points or edges. -IMPORTANT NOTE: Similarly, you should not define {union} or -{intersert} regions for use with this command that share a common -face, even if the face is smooth. E.g. two regions of style block in -a {union} region, where the two blocks have the same face. This is -because LAMMPS discards points that are part of multiple sub-regions -when calculating wall/particle interactions, to avoid double-counting -the interaction. Having two coincident faces could cause the face to -become invisible to the particles. The solution is to make the two -faces differ by epsilon in their position. +NOTE: Similarly, you should not define {union} or {intersert} regions +for use with this command that share a common face, even if the face +is smooth. E.g. two regions of style block in a {union} region, where +the two blocks have the same face. This is because LAMMPS discards +points that are part of multiple sub-regions when calculating +wall/particle interactions, to avoid double-counting the interaction. +Having two coincident faces could cause the face to become invisible +to the particles. The solution is to make the two faces differ by +epsilon in their position. The energy of wall-particle interactions depends on the specified style. @@ -149,19 +149,19 @@ constant K, and has units (energy/distance^2). The input parameter spring is at the {cutoff}. This is a repulsive-only spring since the interaction is truncated at the {cutoff} -IMPORTANT NOTE: For all of the styles, you must insure that r is -always > 0 for all particles in the group, or LAMMPS will generate an -error. This means you cannot start your simulation with particles on -the region surface (r = 0) or with particles on the wrong side of the -region surface (r < 0). For the {wall/lj93} and {wall/lj126} styles, -the energy of the wall/particle interaction (and hence the force on -the particle) blows up as r -> 0. The {wall/colloid} style is even -more restrictive, since the energy blows up as D = r-R -> 0. This -means the finite-size particles of radius R must be a distance larger -than R from the region surface. The {harmonic} style is a softer -potential and does not blow up as r -> 0, but you must use a large -enough {epsilon} that particles always reamin on the correct side of -the region surface (r > 0). +NOTE: For all of the styles, you must insure that r is always > 0 for +all particles in the group, or LAMMPS will generate an error. This +means you cannot start your simulation with particles on the region +surface (r = 0) or with particles on the wrong side of the region +surface (r < 0). For the {wall/lj93} and {wall/lj126} styles, the +energy of the wall/particle interaction (and hence the force on the +particle) blows up as r -> 0. The {wall/colloid} style is even more +restrictive, since the energy blows up as D = r-R -> 0. This means +the finite-size particles of radius R must be a distance larger than R +from the region surface. The {harmonic} style is a softer potential +and does not blow up as r -> 0, but you must use a large enough +{epsilon} that particles always reamin on the correct side of the +region surface (r > 0). [Restart, fix_modify, output, run start/stop, minimize info:] @@ -188,10 +188,10 @@ the "run"_run.html command. The forces due to this fix are imposed during an energy minimization, invoked by the "minimize"_minimize.html command. -IMPORTANT NOTE: If you want the atom/wall interaction energy to be -included in the total potential energy of the system (the quantity -being minimized), you MUST enable the "fix_modify"_fix_modify.html -{energy} option for this fix. +NOTE: If you want the atom/wall interaction energy to be included in +the total potential energy of the system (the quantity being +minimized), you MUST enable the "fix_modify"_fix_modify.html {energy} +option for this fix. [Restrictions:] none diff --git a/doc/fix_wall_srd.html b/doc/fix_wall_srd.html index 5e2e9d5092..72bef195dc 100644 --- a/doc/fix_wall_srd.html +++ b/doc/fix_wall_srd.html @@ -8,7 +8,7 @@ - fix wall/srd command — LAMMPS 15 May 2015 version documentation + fix wall/srd command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -207,35 +207,34 @@ can specify formulas with various mathematical functions, and include thermo_style command keywords for the simulation box parameters and timestep and elapsed time. Thus it is easy to specify a time-dependent wall position.

    -
    -

    Warning

    -

    Because the trajectory of the SRD particle is tracked -as it collides with the wall, you must insure that r = distance of the +

    +

    Note

    +

    Because the trajectory of the SRD particle is tracked as it +collides with the wall, you must insure that r = distance of the particle from the wall, is always > 0 for SRD particles, or LAMMPS will generate an error. This means you cannot start your simulation with SRD particles at the wall position coord (r = 0) or with particles on the wrong side of the wall (r < 0).

    -
    -

    Warning

    -

    If you have 2 or more walls that come together at an -edge or corner (e.g. walls in the x and y dimensions), then be sure to -set the overlap keyword to yes in the fix srd -command, since the walls effectively overlap when SRD particles -collide with them. LAMMPS will issue a warning if you do not do this.

    +
    +

    Note

    +

    If you have 2 or more walls that come together at an edge or +corner (e.g. walls in the x and y dimensions), then be sure to set the +overlap keyword to yes in the fix srd command, +since the walls effectively overlap when SRD particles collide with +them. LAMMPS will issue a warning if you do not do this.

    -
    -

    Warning

    -

    The walls of this fix only interact with SRD -particles, as defined by the fix srd command. If you -are simulating a mixture containing other kinds of particles, then you -should typically use another wall command to act on -the other particles. Since SRD particles will be colliding both with -the walls and the other particles, it is important to insure that the -other particle’s finite extent does not overlap an SRD wall. If you -do not do this, you may generate errors when SRD particles end up -“inside” another particle or a wall at the beginning of a collision -step.

    +
    +

    Note

    +

    The walls of this fix only interact with SRD particles, as +defined by the fix srd command. If you are simulating +a mixture containing other kinds of particles, then you should +typically use another wall command to act on the other +particles. Since SRD particles will be colliding both with the walls +and the other particles, it is important to insure that the other +particle’s finite extent does not overlap an SRD wall. If you do not +do this, you may generate errors when SRD particles end up “inside” +another particle or a wall at the beginning of a collision step.

    The units keyword determines the meaning of the distance units used to define a wall position, but only when a numeric constant is used. @@ -321,7 +320,7 @@ the run command. Thi

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -342,7 +341,7 @@ the run command. Thi @@ -2197,7 +2197,7 @@

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -2218,7 +2218,7 @@ @@ -192,13 +192,13 @@ can then be used in other commands such as -

    Warning

    -

    By default groups are static, meaning the atoms are -permanently assigned to the group. For example, if the region style -is used to assign atoms to a group, the atoms will remain in the group -even if they later move out of the region. As explained below, the -dynamic style can be used to make a group dynamic so that a periodic +

    +

    Note

    +

    By default groups are static, meaning the atoms are permanently +assigned to the group. For example, if the region style is used to +assign atoms to a group, the atoms will remain in the group even if +they later move out of the region. As explained below, the dynamic +style can be used to make a group dynamic so that a periodic determination is made as to which atoms are in the group. Since many LAMMPS commands operate on groups of atoms, you should think carefully about whether making a group dynamic makes sense for your model.

    @@ -294,15 +294,15 @@ 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 molecule will add those atoms that are outside the region to the group.

    -
    -

    Warning

    -

    The include molecule operation is relatively -expensive in a parallel sense. This is because it requires -communication of relevant molecule IDs between all the processors and -each processor to loop over its atoms once per processor, to compare -its atoms to the list of molecule IDs from every other processor. -Hence it scales as N, rather than N/P as most of the group operations -do, where N is the number of atoms, and P is the number of processors.

    +
    +

    Note

    +

    The include molecule operation is relatively expensive in a +parallel sense. This is because it requires communication of relevant +molecule IDs between all the processors and each processor to loop +over its atoms once per processor, to compare its atoms to the list of +molecule IDs from every other processor. Hence it scales as N, rather +than N/P as most of the group operations do, where N is the number of +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 @@ -337,15 +337,15 @@ has been performed, and before neighbor lists or forces are computed. This is the point in the timestep where atom positions have just changed due to the time integration, so the region criterion should be accurate, if applied.

    -
    -

    Warning

    -

    If the region keyword is used to determine what -atoms are in the dynamic group, atoms can move outside of the -simulation box between reneighboring events. Thus if you want to -include all atoms on the left side of the simulation box, you probably -want to set the left boundary of the region to be outside the -simulation box by some reasonable amount (e.g. up to the cutoff of the -potential), else they may be excluded from the dynamic region.

    +
    +

    Note

    +

    If the region keyword is used to determine what atoms are in +the dynamic group, atoms can move outside of the simulation box +between reneighboring events. Thus if you want to include all atoms +on the left side of the simulation box, you probably want to set the +left boundary of the region to be outside the simulation box by some +reasonable amount (e.g. up to the cutoff of the potential), else they +may be excluded from the dynamic region.

    Here is an example of using a dynamic group to shrink the set of atoms being integrated by using a spherical region with a variable radius @@ -363,12 +363,12 @@ group mobile static run ${nsteps}

    -
    -

    Warning

    -

    All fixes and computes take a group ID as an argument, -but they do not all allow for use of a dynamic group. If you get an -error message that this is not allowed, but feel that it should be for -the fix or compute in question, then please post your reasoning to the +

    +

    Note

    +

    All fixes and computes take a group ID as an argument, but they +do not all allow for use of a dynamic group. If you get an error +message that this is not allowed, but feel that it should be for the +fix or compute in question, then please post your reasoning to the LAMMPS mail list and we can change it.

    The static style removes the setting for a dynamic group, converting @@ -403,7 +403,7 @@ those currently in the dynamic group.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with
    Sphinx using a theme provided by Read the Docs. @@ -424,7 +424,7 @@ those currently in the dynamic group.

    @@ -179,7 +179,7 @@ LAMMPS was built with that package. See the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -200,7 +200,7 @@ LAMMPS was built with that package. See the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/if.html b/doc/if.html index dc6dc3bd22..9251bd0db1 100644 --- a/doc/if.html +++ b/doc/if.html @@ -8,7 +8,7 @@ - if command — LAMMPS 15 May 2015 version documentation + if command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -181,8 +181,8 @@ command, except an include allowed. If the command is more than one word, it must enclosed in quotes, so it will be treated as a single argument, as in the examples above.

    -
    -

    Warning

    +
    +

    Note

    If a command itself requires a quoted argument (e.g. a print command), then double and single quotes can be used and nested in the usual manner, as in the examples above and below. @@ -312,7 +312,7 @@ non-zero. If the result is zero, the expression result is FALSE.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -333,7 +333,7 @@ non-zero. If the result is zero, the expression result is FALSE.

    @@ -238,7 +238,7 @@ section for more info on packages.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -259,7 +259,7 @@ section for more info on packages.

    @@ -223,7 +223,7 @@ set, either in the input script or in a data file.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -244,7 +244,7 @@ set, either in the input script or in a data file.

    @@ -210,7 +210,7 @@ section for more info on packages.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -231,7 +231,7 @@ section for more info on packages.

    @@ -207,7 +207,7 @@ MOLECULE package (which it is by default). See the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -228,7 +228,7 @@ MOLECULE package (which it is by default). See the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/improper_distance.html b/doc/improper_distance.html index 4d5826f805..34eaead901 100644 --- a/doc/improper_distance.html +++ b/doc/improper_distance.html @@ -8,7 +8,7 @@ - improper_style distance command — LAMMPS 15 May 2015 version documentation + improper_style distance command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -183,7 +183,7 @@ section for more info on packages.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with
    Sphinx using a theme provided by Read the Docs. @@ -204,7 +204,7 @@ section for more info on packages.

    @@ -203,7 +203,7 @@ section for more info on packages.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -224,7 +224,7 @@ section for more info on packages.

    @@ -212,7 +212,7 @@ MOLECULE package (which it is by default). See the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -233,7 +233,7 @@ MOLECULE package (which it is by default). See the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/improper_hybrid.html b/doc/improper_hybrid.html index 8f8211050d..5fa3536636 100644 --- a/doc/improper_hybrid.html +++ b/doc/improper_hybrid.html @@ -8,7 +8,7 @@ - improper_style hybrid command — LAMMPS 15 May 2015 version documentation + improper_style hybrid command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -196,7 +196,7 @@ restart file, you need to re-specify improper_coeff commands.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with
    Sphinx using a theme provided by Read the Docs. @@ -217,7 +217,7 @@ restart file, you need to re-specify improper_coeff commands.

    @@ -163,7 +163,7 @@ data file read by the re

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with
    Sphinx using a theme provided by Read the Docs. @@ -184,7 +184,7 @@ data file read by the re @@ -215,7 +215,7 @@ J Chem Phys, 112, 9632 (2000).

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with
    Sphinx using a theme provided by Read the Docs. @@ -236,7 +236,7 @@ J Chem Phys, 112, 9632 (2000).

    @@ -166,8 +166,8 @@ re-specified in an input script that restarts a simulation. See the this. The one exception is that improper_style hybrid only stores the list of sub-styles in the restart file; improper coefficients need to be re-specified.

    -
    -

    Warning

    +
    +

    Note

    When both an improper and pair style is defined, the special_bonds command often needs to be used to turn off (or weight) the pairwise interaction that would otherwise @@ -223,7 +223,7 @@ a package.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -244,7 +244,7 @@ a package.

    @@ -207,7 +207,7 @@ MOLECULE package (which it is by default). See the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -228,7 +228,7 @@ MOLECULE package (which it is by default). See the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/include.html b/doc/include.html index afbfb798bc..6b1b27415a 100644 --- a/doc/include.html +++ b/doc/include.html @@ -8,7 +8,7 @@ - include command — LAMMPS 15 May 2015 version documentation + include command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -175,7 +175,7 @@ scripts.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with
    Sphinx using a theme provided by Read the Docs. @@ -196,7 +196,7 @@ scripts.

    @@ -211,7 +211,7 @@ reported.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -232,7 +232,7 @@ reported.

    @@ -153,11 +153,10 @@ returned to, although by using multiple jump commands it is possible to chain from file to file or back to the original file.

    If the word “SELF” is used for the filename, then the current input script is re-opened and read again.

    -
    -

    Warning

    -

    The SELF option is not guaranteed to work when the -current input script is being read through stdin (standard input), -e.g.

    +
    +

    Note

    +

    The SELF option is not guaranteed to work when the current input +script is being read through stdin (standard input), e.g.

    lmp_g++ < in.script
     
    @@ -265,7 +264,7 @@ LAMMPS will come to the end of the file and exit.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -286,7 +285,7 @@ LAMMPS will come to the end of the file and exit.

    @@ -348,10 +348,10 @@ requires a somewhat larger PPPM mesh to achieve the same accuracy as the ik method. Currently, only the ik method (default) can be used for a triclinic simulation cell with PPPM. The ad method is always used for MSM.

    -
    -

    Warning

    -

    Currently, not all PPPM styles support the ad -option. Support for those PPPM variants will be added later.

    +
    +

    Note

    +

    Currently, not all PPPM styles support the ad option. Support +for those PPPM variants will be added later.

    The kmax/ewald keyword sets the number of kspace vectors in each dimension for kspace style ewald. The three values must be positive @@ -436,7 +436,7 @@ Chem Theory Comput, 9, 5412 (2013).

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -457,7 +457,7 @@ Chem Theory Comput, 9, 5412 (2013).

    @@ -270,12 +270,12 @@ be essentially the same as for regular PPPM, which means the method will be up to 2x slower in the KSpace time (simply 2x more expensive). For more details and timings, see Section_accelerate.

    -
    -

    Warning

    -

    Using pppm/stagger may not give the same increase in -the accuracy of energy and pressure as it does in forces, so some -caution must be used if energy and/or pressure are quantities of -interest, such as when using a barostat.

    +
    +

    Note

    +

    Using pppm/stagger may not give the same increase in the +accuracy of energy and pressure as it does in forces, so some caution +must be used if energy and/or pressure are quantities of interest, +such as when using a barostat.


    The pppm/disp and pppm/disp/tip4p styles add a mesh-based long-range @@ -293,17 +293,16 @@ and how to choose them is described in (Isele-Holder2) and the How-To discussion.


    -
    -

    Warning

    -

    All of the PPPM styles can be used with -single-precision FFTs by using the compiler switch -DFFT_SINGLE for -the FFT_INC setting in your lo-level Makefile. This setting also -changes some of the PPPM operations (e.g. mapping charge to mesh and -interpolating electric fields to particles) to be performed in single -precision. This option can speed-up long-range calulations, -particularly in parallel or on GPUs. The use of the -DFFT_SINGLE flag -is discussed in this section of the -manual. MSM does not currently support the -DFFT_SINGLE compiler switch.

    +
    +

    Note

    +

    All of the PPPM styles can be used with single-precision FFTs by +using the compiler switch -DFFT_SINGLE for the FFT_INC setting in your +lo-level Makefile. This setting also changes some of the PPPM +operations (e.g. mapping charge to mesh and interpolating electric +fields to particles) to be performed in single precision. This option +can speed-up long-range calulations, particularly in parallel or on +GPUs. The use of the -DFFT_SINGLE flag is discussed in this section of the manual. MSM does not +currently support the -DFFT_SINGLE compiler switch.


    The msm style invokes a multi-level summation method MSM solver, @@ -457,7 +456,7 @@ Illinois at Urbana-Champaign, (2006).

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -478,7 +477,7 @@ Illinois at Urbana-Champaign, (2006).

    @@ -171,7 +171,7 @@ script as discussed in the ju

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with
    Sphinx using a theme provided by Read the Docs. @@ -192,7 +192,7 @@ script as discussed in the ju @@ -284,14 +284,14 @@ direction, and similarly for y and z. The 3 lattice directions you specify do not have to be unit vectors, but they must be mutually orthogonal and obey the right-hand rule, i.e. (X cross Y) points in the Z direction.

    -
    -

    Warning

    -

    The preceding paragraph describing lattice directions -is only valid for orthogonal cubic unit cells (or square in 2d). If -you are using a hcp or hex lattice or the more general lattice -style custom with non-orthogonal a1,a2,a3 vectors, then you should -think of the 3 orient vectors as creating a 3x3 rotation matrix -which is applied to a1,a2,a3 to rotate the original unit cell to a new +

    +

    Note

    +

    The preceding paragraph describing lattice directions is only +valid for orthogonal cubic unit cells (or square in 2d). If you are +using a hcp or hex lattice or the more general lattice style +custom with non-orthogonal a1,a2,a3 vectors, then you should think +of the 3 orient vectors as creating a 3x3 rotation matrix which is +applied to a1,a2,a3 to rotate the original unit cell to a new orientation in the simulation box.


    @@ -299,15 +299,14 @@ orientation in the simulation box.

    inferred from “lattice spacings” in the x,y,z box directions. E.g. the
    region command can create a block of size 10x20x20, where 10 means 10 lattice spacings in the x direction.

    -
    -

    Warning

    -

    Though they are called lattice spacings, all the -commands that have a “units lattice” option, simply use the 3 values -as scale factors on the distance units defined by the -units command. Thus if you do not like the lattice -spacings computed by LAMMPS (e.g. for a non-orthogonal or rotated unit -cell), you can define the 3 values to be whatever you wish, via the -spacing option.

    +
    +

    Note

    +

    Though they are called lattice spacings, all the commands that +have a “units lattice” option, simply use the 3 values as scale +factors on the distance units defined by the units +command. Thus if you do not like the lattice spacings computed by +LAMMPS (e.g. for a non-orthogonal or rotated unit cell), you can +define the 3 values to be whatever you wish, via the spacing option.

    If the spacing option is not specified, the lattice spacings are computed by LAMMPS in the following way. A unit cell of the lattice @@ -323,18 +322,18 @@ dimension are simply the scale factor (described above) multiplied by the length of a1,a2,a3. Thus a hex style lattice with a scale factor of 3.0 Angstroms, would have a lattice spacing of 3.0 in x and 3*sqrt(3.0) in y.

    -
    -

    Warning

    -

    For non-orthogonal unit cells and/or when a rotation -is applied via the orient keyword, then the lattice spacings -computed by LAMMPS are typically less intuitive. In particular, in -these cases, there is no guarantee that a particular lattice spacing -is an integer multiple of the periodicity of the lattice in that -direction. Thus, if you create an orthogonal periodic simulation box -whose size in a dimension is a multiple of the lattice spacing, and -then fill it with atoms via the create_atoms -command, you will NOT necessarily create a periodic system. -I.e. atoms may overlap incorrectly at the faces of the simulation box.

    +
    +

    Note

    +

    For non-orthogonal unit cells and/or when a rotation is applied +via the orient keyword, then the lattice spacings computed by LAMMPS +are typically less intuitive. In particular, in these cases, there is +no guarantee that a particular lattice spacing is an integer multiple +of the periodicity of the lattice in that direction. Thus, if you +create an orthogonal periodic simulation box whose size in a dimension +is a multiple of the lattice spacing, and then fill it with atoms via +the create_atoms command, you will NOT necessarily +create a periodic system. I.e. atoms may overlap incorrectly at the +faces of the simulation box.

    The spacing option sets the 3 lattice spacings directly. All must be non-zero (use 1.0 for dz in a 2d simulation). The specified values @@ -414,7 +413,7 @@ a2 = 0 1 0, and a3 = 0 0 1.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -435,7 +434,7 @@ a2 = 0 1 0, and a3 = 0 0 1.

    @@ -180,7 +180,7 @@ details.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -201,7 +201,7 @@ details.

    @@ -207,7 +207,7 @@ all be defined before a v

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with
    Sphinx using a theme provided by Read the Docs. @@ -228,7 +228,7 @@ all be defined before a v @@ -211,7 +211,7 @@ could move in the gradient direction to reduce forces further.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with
    Sphinx using a theme provided by Read the Docs. @@ -232,7 +232,7 @@ could move in the gradient direction to reduce forces further.

    @@ -181,19 +181,18 @@ of each atom is initialized to 0.0 by this style, at the beginning of a minimization.

    Either the quickmin and fire styles are useful in the context of nudged elastic band (NEB) calculations via the neb command.

    -
    -

    Warning

    -

    The damped dynamic minimizers use whatever timestep -you have defined via the timestep command. Often they -will converge more quickly if you use a timestep about 10x larger than -you would normally use for dynamics simulations.

    +
    +

    Note

    +

    The damped dynamic minimizers use whatever timestep you have +defined via the timestep command. Often they will +converge more quickly if you use a timestep about 10x larger than you +would normally use for dynamics simulations.

    -
    -

    Warning

    -

    The quickmin and fire styles do not yet support -the use of the fix box/relax command or -minimizations involving the electron radius in eFF -models.

    +
    +

    Note

    +

    The quickmin and fire styles do not yet support the use of +the fix box/relax command or minimizations +involving the electron radius in eFF models.

    @@ -229,7 +228,7 @@ Jonsson, Mills, Jacobsen.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -250,7 +249,7 @@ Jonsson, Mills, Jacobsen.

    @@ -182,12 +182,12 @@ Optimization (Procedure 3.1 on p 41).

    The minimization styles quickmin and fire perform damped dynamics using an Euler integration step. Thus they require a timestep be defined.

    -
    -

    Warning

    -

    The damped dynamic minimizers use whatever timestep -you have defined via the timestep command. Often they -will converge more quickly if you use a timestep about 10x larger than -you would normally use for dynamics simulations.

    +
    +

    Note

    +

    The damped dynamic minimizers use whatever timestep you have +defined via the timestep command. Often they will +converge more quickly if you use a timestep about 10x larger than you +would normally use for dynamics simulations.


    In all cases, the objective function being minimized is the total @@ -274,8 +274,8 @@ reduced.

    The iterations and force evaluation values are what is checked by the maxiter and maxeval parameters.


    -
    -

    Warning

    +
    +

    Note

    There are several force fields in LAMMPS which have discontinuities or other approximations which may prevent you from performing an energy minimization to high tolerances. For example, @@ -324,10 +324,10 @@ examples of fixes that can be used include:

  • fix wall
  • fix wall/region
  • -
    -

    Warning

    -

    Some fixes which are invoked during minimization have -an associated potential energy. For that energy to be included in the +

    +

    Note

    +

    Some fixes which are invoked during minimization have an +associated potential energy. For that energy to be included in the total potential energy of the system (the quantity being minimized), you MUST enable the fix_modify energy option for that fix. The doc pages for individual fix commands @@ -375,7 +375,7 @@ system will not fully relax.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -396,7 +396,7 @@ system will not fully relax.

    @@ -212,14 +212,14 @@ individual diameters of each particle (Diameters section), the total mass of the molecule (header keyword = mass), the center-of-mass of the molecule (header keyword = com), and the moments of inertia of the molecule (header keyword = inertia).

    -
    -

    Warning

    -

    The molecule command can be used to define molecules -with bonds, angles, dihedrals, imporopers, or special bond lists of -neighbors within a molecular topology, so that you can later add the -molecules to your simulation, via one or more of the commands listed -above. If such molecules do not already exist when LAMMPS creates the -simulation box, via the create_box or +

    +

    Note

    +

    The molecule command can be used to define molecules with bonds, +angles, dihedrals, imporopers, or special bond lists of neighbors +within a molecular topology, so that you can later add the molecules +to your simulation, via one or more of the commands listed above. If +such molecules do not already exist when LAMMPS creates the simulation +box, via the create_box or read_data command, when you later add them you may overflow the pre-allocated data structures which store molecular topology information with each atom, and an error will be generated. @@ -292,15 +292,14 @@ reason to list the special bond info explicitly is for the thermalized Drude oscillator model which treats the bonds between nuclear cores and Drude electrons in a different manner.

    -
    -

    Warning

    -

    Whether a section is required depends on how the -molecule template is used by other LAMMPS commands. For example, to -add a molecule via the fix deposit command, the -Coords and Types sections are required. To add a rigid body via the -fix pour command, the Bonds (Angles, etc) sections are -not required, since the molecule will be treated as a rigid body. -Some sections are optional. For example, the fix pour +

    +

    Note

    +

    Whether a section is required depends on how the molecule +template is used by other LAMMPS commands. For example, to add a +molecule via the fix deposit command, the Coords +and Types sections are required. To add a rigid body via the fix pour command, the Bonds (Angles, etc) sections are not +required, since the molecule will be treated as a rigid body. Some +sections are optional. For example, the fix pour command can be used to add “molecules” which are clusters of finite-size granular particles. If the Diameters section is not specified, each particle in the molecule will have a default diameter @@ -549,7 +548,7 @@ of SHAKE clusters.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -570,7 +569,7 @@ of SHAKE clusters.

    @@ -178,16 +178,16 @@ one or two processors. You will simply not get the performance speed-up you would see with one or more physical processors per replica. See this section of the manual for further discussion.

    -
    -

    Warning

    -

    The current NEB implementation in LAMMPS only allows -there to be one processor per replica.

    +
    +

    Note

    +

    The current NEB implementation in LAMMPS only allows there to be +one processor per replica.

    -
    -

    Warning

    -

    As explained below, a NEB calculation perfoms a damped -dynamics minimization across all the replicas. The mimimizer uses -whatever timestep you have defined in your input script, via the +

    +

    Note

    +

    As explained below, a NEB calculation perfoms a damped dynamics +minimization across all the replicas. The mimimizer uses whatever +timestep you have defined in your input script, via the timestep command. Often NEB will converge more quickly if you use a timestep about 10x larger than you would normally use for dynamics simulations.

    @@ -296,8 +296,8 @@ commands. The replica-specific names of these files can be specified as in the discussion above for the each file-style. Also see the section below for how a NEB calculation can produce restart files, so that a long calculation can be restarted if needed.

    -
    -

    Warning

    +
    +

    Note

    None of the file-style settings change the initial configuration of any atom in the first replica. The first replica must thus be in the correct initial configuration at the time the neb @@ -356,8 +356,8 @@ MEP, and the configurations of the replicas should be a sequence of configurations along the MEP.


    A few other settings in your input script are required or advised to -perform a NEB calculation. See the IMPORTANT NOTE about the choice of -timestep at the beginning of this doc page.

    +perform a NEB calculation. See the NOTE about the choice of timestep +at the beginning of this doc page.

    An atom map must be defined which it is not by default for atom_style atomic problems. The atom_modify map command can be used to do this.

    The “atom_modify sort 0 0.0” command should be used to turn off atom sorting.

    @@ -529,7 +529,7 @@ for more info on packages.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -550,7 +550,7 @@ for more info on packages.

    @@ -254,10 +254,10 @@ times; they require one check for each time they have been specified.

    Note that the exclude options only affect pairwise interactions; see the delete_bonds command for information on turning off bond interactions.

    -
    -

    Warning

    -

    Excluding pairwise interactions will not work -correctly when also using a long-range solver via the +

    +

    Note

    +

    Excluding pairwise interactions will not work correctly when +also using a long-range solver via the kspace_style command. LAMMPS will give a warning to this effect. This is because the short-range pairwise interaction needs to subtract off a term from the total energy for pairs whose @@ -277,18 +277,18 @@ after another as they fill up. The size of each page is set by the could potentially overflow the list. This threshold is set by the one value which tells LAMMPS the maximum number of neighbor’s one atom can have.

    -
    -

    Warning

    -

    LAMMPS can crash without an error message if the -number of neighbors for a single particle is larger than the page -setting, which means it is much, much larger than the one setting. -This is because LAMMPS doesn’t error check these limits for every -pairwise interaction (too costly), but only after all the particle’s -neighbors have been found. This problem usually means something is -very wrong with the way you’ve setup your problem (particle spacing, -cutoff length, neighbor skin distance, etc). If you really expect -that many neighbors per particle, then boost the one and page -settings accordingly.

    +
    +

    Note

    +

    LAMMPS can crash without an error message if the number of +neighbors for a single particle is larger than the page setting, +which means it is much, much larger than the one setting. This is +because LAMMPS doesn’t error check these limits for every pairwise +interaction (too costly), but only after all the particle’s neighbors +have been found. This problem usually means something is very wrong +with the way you’ve setup your problem (particle spacing, cutoff +length, neighbor skin distance, etc). If you really expect that many +neighbors per particle, then boost the one and page settings +accordingly.

    The binsize option allows you to specify what size of bins will be used in neighbor list construction to sort and find neighboring atoms. @@ -334,7 +334,7 @@ cluster = no, include = all, exclude = none, page = 100000, one =

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -355,7 +355,7 @@ cluster = no, include = all, exclude = none, page = 100000, one = @@ -216,7 +216,7 @@ are printed to the screen and log file. See

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -237,7 +237,7 @@ are printed to the screen and log file. See var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/newton.html b/doc/newton.html index 03feaeb064..466fa4e1a7 100644 --- a/doc/newton.html +++ b/doc/newton.html @@ -8,7 +8,7 @@ - newton command — LAMMPS 15 May 2015 version documentation + newton command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -195,7 +195,7 @@ defined by a read_data

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -216,7 +216,7 @@ defined by a read_data var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/next.html b/doc/next.html index b7e5e3f52e..69d6d4d185 100644 --- a/doc/next.html +++ b/doc/next.html @@ -8,7 +8,7 @@ - next command — LAMMPS 15 May 2015 version documentation + next command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -270,7 +270,7 @@ jump in.script loopa

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with
    Sphinx using a theme provided by Read the Docs. @@ -291,7 +291,7 @@ jump in.script loopa @@ -268,14 +268,15 @@ intel” or “-sf omp” -

    Warning

    -

    A package command for a particular style can be -invoked multiple times when a simulation is setup, e.g. by the “-c -on”, “-k on”, “-sf”, and “-pk” command-line switches, and by using this command in an -input script. Each time it is used all of the style options are set, -either to default values or to specified settings. I.e. settings from -previous invocations do not persist across multiple invocations.

    +
    +

    Note

    +

    A package command for a particular style can be invoked multiple +times when a simulation is setup, e.g. by the “-c on”, “-k on”, “-sf”, +and “-pk” command-line switches, and by +using this command in an input script. Each time it is used all of +the style options are set, either to default values or to specified +settings. I.e. settings from previous invocations do not persist +across multiple invocations.

    See the Section Accelerate section of the manual for more details about using the various accelerator packages @@ -442,11 +443,11 @@ if LAMMPS was built with coprocessor support; see the balance keyword discussion below. If you are running with less MPI tasks/node than there are CPUs, it can be advantageous to use OpenMP threading on the CPUs.

    -
    -

    Warning

    -

    The omp keyword has nothing to do with coprocessor -threads on the Xeon Phi; see the tpc and tptask keywords below for -a discussion of coprocessor threads.

    +
    +

    Note

    +

    The omp keyword has nothing to do with coprocessor threads on +the Xeon Phi; see the tpc and tptask keywords below for a +discussion of coprocessor threads.

    The Nthread value for the omp keyword sets the number of OpenMP threads allocated for each MPI task. Setting Nthread = 0 (the @@ -459,15 +460,15 @@ environment variable, see the discussion of the Nthreads setting on this doc page for the “package omp” command. Nthreads is a required argument for the USER-OMP package. Its meaning is exactly the same for the USER-INTEL pacakge.

    -
    -

    Warning

    -

    If you build LAMMPS with both the USER-INTEL and -USER-OMP packages, be aware that both packages allow setting of the -Nthreads value via their package commands, but there is only a -single global Nthreads value used by OpenMP. Thus if both package -commands are invoked, you should insure the two values are consistent. -If they are not, the last one invoked will take precedence, for both -packages. Also note that if the “-sf hybrid intel omp” command-line switch is used, it invokes a “package +

    +

    Note

    +

    If you build LAMMPS with both the USER-INTEL and USER-OMP +packages, be aware that both packages allow setting of the Nthreads +value via their package commands, but there is only a single global +Nthreads value used by OpenMP. Thus if both package commands are +invoked, you should insure the two values are consistent. If they are +not, the last one invoked will take precedence, for both packages. +Also note that if the “-sf hybrid intel omp” command-line switch is used, it invokes a “package intel” command, followed by a “package omp” command, both with a setting of Nthreads = 0.

    @@ -716,7 +717,7 @@ your input script or via the “-pk omp”

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -737,7 +738,7 @@ your input script or via the “-pk omp” var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/package.txt b/doc/package.txt index 917540b3c8..a4824e748b 100644 --- a/doc/package.txt +++ b/doc/package.txt @@ -151,13 +151,13 @@ is used to auto-append accelerator suffixes to various styles in the input script, then those switches also invoke a "package gpu", "package intel", or "package omp" command with default settings. -IMPORTANT NOTE: A package command for a particular style can be -invoked multiple times when a simulation is setup, e.g. by the "-c -on", "-k on", "-sf", and "-pk" "command-line -switches"_Section_start.html#start_7, and by using this command in an -input script. Each time it is used all of the style options are set, -either to default values or to specified settings. I.e. settings from -previous invocations do not persist across multiple invocations. +NOTE: A package command for a particular style can be invoked multiple +times when a simulation is setup, e.g. by the "-c on", "-k on", "-sf", +and "-pk" "command-line switches"_Section_start.html#start_7, and by +using this command in an input script. Each time it is used all of +the style options are set, either to default values or to specified +settings. I.e. settings from previous invocations do not persist +across multiple invocations. See the "Section Accelerate"_Section_accelerate.html section of the manual for more details about using the various accelerator packages @@ -353,9 +353,9 @@ keyword discussion below. If you are running with less MPI tasks/node than there are CPUs, it can be advantageous to use OpenMP threading on the CPUs. -IMPORTANT NOTE: The {omp} keyword has nothing to do with coprocessor -threads on the Xeon Phi; see the {tpc} and {tptask} keywords below for -a discussion of coprocessor threads. +NOTE: The {omp} keyword has nothing to do with coprocessor threads on +the Xeon Phi; see the {tpc} and {tptask} keywords below for a +discussion of coprocessor threads. The {Nthread} value for the {omp} keyword sets the number of OpenMP threads allocated for each MPI task. Setting {Nthread} = 0 (the @@ -370,13 +370,13 @@ this doc page for the "package omp" command. Nthreads is a required argument for the USER-OMP package. Its meaning is exactly the same for the USER-INTEL pacakge. -IMPORTANT NOTE: If you build LAMMPS with both the USER-INTEL and -USER-OMP packages, be aware that both packages allow setting of the -{Nthreads} value via their package commands, but there is only a -single global {Nthreads} value used by OpenMP. Thus if both package -commands are invoked, you should insure the two values are consistent. -If they are not, the last one invoked will take precedence, for both -packages. Also note that if the "-sf hybrid intel omp" "command-line +NOTE: If you build LAMMPS with both the USER-INTEL and USER-OMP +packages, be aware that both packages allow setting of the {Nthreads} +value via their package commands, but there is only a single global +{Nthreads} value used by OpenMP. Thus if both package commands are +invoked, you should insure the two values are consistent. If they are +not, the last one invoked will take precedence, for both packages. +Also note that if the "-sf hybrid intel omp" "command-line switch"_"_Section_start.html#start_7 is used, it invokes a "package intel" command, followed by a "package omp" command, both with a setting of {Nthreads} = 0. diff --git a/doc/pair_adp.html b/doc/pair_adp.html index 77cdbf81b1..a5428bf652 100644 --- a/doc/pair_adp.html +++ b/doc/pair_adp.html @@ -8,7 +8,7 @@ - pair_style adp command — LAMMPS 15 May 2015 version documentation + pair_style adp command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -288,7 +288,7 @@ if LAMMPS was built with that package (which it is by default).

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with
    Sphinx using a theme provided by Read the Docs. @@ -309,7 +309,7 @@ if LAMMPS was built with that package (which it is by default).

    @@ -302,7 +302,7 @@ Physics: Condensed Matter, 14, 783-802 (2002).

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -323,7 +323,7 @@ Physics: Condensed Matter, 14, 783-802 (2002).

    @@ -242,7 +242,7 @@ initial wavefunction, free for the wavepacket width.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -263,7 +263,7 @@ initial wavefunction, free for the wavepacket width.

    @@ -227,7 +227,7 @@ to be specified in an input script that reads a restart file.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -248,7 +248,7 @@ to be specified in an input script that reads a restart file.

    @@ -160,16 +160,15 @@ pairs of sub-particles in the two body particles are computed. E.g. if the first body particle has 3 sub-particles, and the second has 10, then 30 interactions are computed and summed to yield the total force and torque on each body particle.

    -
    -

    Warning

    -

    In the example just described, all 30 interactions are -computed even if the distance between a particular pair of -sub-particles is greater than the cutoff. Likewise, no interaction -between two body particles is computed if the two COMs are further -apart than the cutoff, even if the distance between some pairs of -their sub-particles is within the cutoff. Thus care should be used in -defining the cutoff distances for body particles, depending on their -shape and size.

    +
    +

    Note

    +

    In the example just described, all 30 interactions are computed +even if the distance between a particular pair of sub-particles is +greater than the cutoff. Likewise, no interaction between two body +particles is computed if the two COMs are further apart than the +cutoff, even if the distance between some pairs of their sub-particles +is within the cutoff. Thus care should be used in defining the cutoff +distances for body particles, depending on their shape and size.

    Similar rules apply for a body particle interacting with a point particle. The distance between the two particles is calculated using @@ -234,7 +233,7 @@ body/particle interactions requires the use of the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -255,7 +254,7 @@ body/particle interactions requires the use of the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/pair_body.txt b/doc/pair_body.txt index 12906306a8..19796a9b88 100644 --- a/doc/pair_body.txt +++ b/doc/pair_body.txt @@ -42,14 +42,13 @@ E.g. if the first body particle has 3 sub-particles, and the second has 10, then 30 interactions are computed and summed to yield the total force and torque on each body particle. -IMPORTANT NOTE: In the example just described, all 30 interactions are -computed even if the distance between a particular pair of -sub-particles is greater than the cutoff. Likewise, no interaction -between two body particles is computed if the two COMs are further -apart than the cutoff, even if the distance between some pairs of -their sub-particles is within the cutoff. Thus care should be used in -defining the cutoff distances for body particles, depending on their -shape and size. +NOTE: In the example just described, all 30 interactions are computed +even if the distance between a particular pair of sub-particles is +greater than the cutoff. Likewise, no interaction between two body +particles is computed if the two COMs are further apart than the +cutoff, even if the distance between some pairs of their sub-particles +is within the cutoff. Thus care should be used in defining the cutoff +distances for body particles, depending on their shape and size. Similar rules apply for a body particle interacting with a point particle. The distance between the two particles is calculated using diff --git a/doc/pair_bop.html b/doc/pair_bop.html index 4e937440b1..e160c7f1e0 100644 --- a/doc/pair_bop.html +++ b/doc/pair_bop.html @@ -8,7 +8,7 @@ - pair_style bop command — LAMMPS 15 May 2015 version documentation + pair_style bop command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -203,8 +203,8 @@ allows implementation of an asymmetric density of states, which helps to either stabilize or destabilize close-packed structures. The pi bond-order includes hopping paths of length 4. This enables the incorporation of dihedral angles effects.

    -
    -

    Warning

    +
    +

    Note

    Note that unlike for other potentials, cutoffs for BOP potentials are not set in the pair_style or pair_coeff command; they are specified in the BOP potential files themselves. Likewise, the @@ -507,7 +507,7 @@ Zimmerman, Phys. Rev. B, 85,115206 (2012).

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with
    Sphinx using a theme provided by Read the Docs. @@ -528,7 +528,7 @@ Zimmerman, Phys. Rev. B, 85,115206 (2012).

    @@ -322,7 +322,7 @@ Fumi and Tosi, J Phys Chem Solids, 25, 45 (1964).

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -343,7 +343,7 @@ Fumi and Tosi, J Phys Chem Solids, 25, 45 (1964).

    @@ -253,7 +253,7 @@ brownian.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -274,7 +274,7 @@ brownian.

    @@ -254,13 +254,13 @@ a term is added for the Born-Mayer-Huggins potential.

    -
    -

    Warning

    -

    For all these pair styles, the terms with A and C are -always cutoff. The additional Coulombic term can be cutoff or -long-range (no cutoff) depending on whether the style name includes -coul/cut or coul/long or coul/msm. If you wish the C/r^6 term to be -long-range (no cutoff), then see the pair_style buck/long/coul/long command.

    +
    +

    Note

    +

    For all these pair styles, the terms with A and C are always +cutoff. The additional Coulombic term can be cutoff or long-range (no +cutoff) depending on whether the style name includes coul/cut or +coul/long or coul/msm. If you wish the C/r^6 term to be long-range +(no cutoff), then see the pair_style buck/long/coul/long command.

    The following coefficients must be defined for each pair of atoms types via the pair_coeff command as in the examples @@ -343,7 +343,7 @@ for more info.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -364,7 +364,7 @@ for more info.

    @@ -283,7 +283,7 @@ the KSPACE package is installed by default.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -304,7 +304,7 @@ the KSPACE package is installed by default.

    @@ -336,7 +336,7 @@ Fischer, Gao, Guo, Ha, et al, J Phys Chem, 102, 3586 (1998).

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -357,7 +357,7 @@ Fischer, Gao, Guo, Ha, et al, J Phys Chem, 102, 3586 (1998).

    @@ -307,7 +307,7 @@ LAMMPS was built with that package. See the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -328,7 +328,7 @@ LAMMPS was built with that package. See the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/pair_coeff.html b/doc/pair_coeff.html index 63f74a0733..4da5a75994 100644 --- a/doc/pair_coeff.html +++ b/doc/pair_coeff.html @@ -8,7 +8,7 @@ - pair_coeff command — LAMMPS 15 May 2015 version documentation + pair_coeff command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -268,7 +268,7 @@ section of

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -289,7 +289,7 @@ section of var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/pair_colloid.html b/doc/pair_colloid.html index 9de64aedad..20354571d3 100644 --- a/doc/pair_colloid.html +++ b/doc/pair_colloid.html @@ -8,7 +8,7 @@ - pair_style colloid command — LAMMPS 15 May 2015 version documentation + pair_style colloid command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -227,10 +227,10 @@ would correspond to a colloid-colloid cutoff of 25. A good rule-of-thumb is to use a colloid-solvent cutoff that is half the big diameter + 4 times the small diameter. I.e. 9 = 5 + 4 for the colloid-solvent cutoff in this case.

    -
    -

    Warning

    -

    When using pair_style colloid for a mixture with 2 (or -more) widely different particles sizes (e.g. sigma=10 colloids in a +

    +

    Note

    +

    When using pair_style colloid for a mixture with 2 (or more) +widely different particles sizes (e.g. sigma=10 colloids in a background sigam=1 LJ fluid), you will likely want to use these commands for efficiency: neighbor multi and comm_modify multi.

    @@ -305,7 +305,7 @@ only per-type polydispersity is enabled via the pair_coeff parameters.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -326,7 +326,7 @@ only per-type polydispersity is enabled via the pair_coeff parameters.

    @@ -175,7 +175,7 @@ atoms i and j, E<sup>corr</sup> are angular correction terms.

    The COMB potentials (styles comb and comb3) are variable charge potentials. The equilibrium charge on each atom is calculated by the -electronegativity equalization (QEq) method. See Rick for +electronegativity equalization (QEq) method. See Rick for further details. This is implemented by the fix qeq/comb command, which should normally be specified in the input script when running a model with the COMB potential. The fix qeq/comb command has options @@ -221,10 +221,10 @@ described on the pair_c

    Keyword polar indicates whether the force field includes the atomic polarization. Since the equilibration of the polarization has not yet been implemented, it can only set polar_off at present.

    -
    -

    Warning

    -

    You can not use potential file ffield.comb with -style comb3, nor file ffield.comb3 with style comb.

    +
    +

    Note

    +

    You can not use potential file ffield.comb with style comb3, +nor file ffield.comb3 with style comb.


    Styles with a cuda, gpu, intel, kk, omp, or opt suffix are @@ -297,7 +297,7 @@ Y. Li, Z. Lu, S. R. Phillpot, and S. B. Sinnott, Mat. Sci. & Eng: R 74,

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with
    Sphinx using a theme provided by Read the Docs. @@ -318,7 +318,7 @@ Y. Li, Z. Lu, S. R. Phillpot, and S. B. Sinnott, Mat. Sci. & Eng: R 74, @@ -293,7 +293,7 @@ Wolf model (described below) to provide consistent forces and energies decay to zero.


    Style coul/wolf computes Coulombic interactions via the Wolf -summation method, described in Wolf, given by:

    +summation method, described in Wolf, given by:

    _images/pair_coul_wolf.jpg

    where alpha is the damping parameter, and erc() and erfc() are error-fuction and complementary error-function terms. This potential @@ -371,13 +371,13 @@ and the distance to the massless charge site are specified as pair_style arguments. Style tip4p/cut uses a global cutoff for Coulomb interactions; style tip4p/long is for use with a long-range Coulombic solver (Ewald or PPPM).

    -
    -

    Warning

    -

    For each TIP4P water molecule in your system, the atom -IDs for the O and 2 H atoms must be consecutive, with the O atom -first. This is to enable LAMMPS to “find” the 2 H atoms associated -with each O atom. For example, if the atom ID of an O atom in a TIP4P -water molecule is 500, then its 2 H atoms must have IDs 501 and 502.

    +
    +

    Note

    +

    For each TIP4P water molecule in your system, the atom IDs for +the O and 2 H atoms must be consecutive, with the O atom first. This +is to enable LAMMPS to “find” the 2 H atoms associated with each O +atom. For example, if the atom ID of an O atom in a TIP4P water +molecule is 500, then its 2 H atoms must have IDs 501 and 502.

    See the howto section for more information on how to use the TIP4P pair styles and lists of @@ -478,7 +478,7 @@ Phys, 110, 8254 (1999).

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -499,7 +499,7 @@ Phys, 110, 8254 (1999).

    @@ -225,7 +225,7 @@ if LAMMPS was built with that package. See the M

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -246,7 +246,7 @@ if LAMMPS was built with that package. See the M @@ -211,7 +211,7 @@ enabled if LAMMPS was built with that package. See the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -232,7 +232,7 @@ enabled if LAMMPS was built with that package. See the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/pair_dipole.html b/doc/pair_dipole.html index 49c8efb8d3..69c50dc5bf 100644 --- a/doc/pair_dipole.html +++ b/doc/pair_dipole.html @@ -8,7 +8,7 @@ - pair_style lj/cut/dipole/cut command — LAMMPS 15 May 2015 version documentation + pair_style lj/cut/dipole/cut command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -370,7 +370,7 @@ Clarendon Press, Oxford, 1987.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with
    Sphinx using a theme provided by Read the Docs. @@ -391,7 +391,7 @@ Clarendon Press, Oxford, 1987.

    @@ -218,18 +218,18 @@ atoms types via the pai except that A is not included.

    The GPU-accelerated versions of these styles are implemented based on the work of (Afshar) and (Phillips).

    -
    -

    Warning

    -

    If you are modeling DPD polymer chains, you may want -to use the pair_style srp command in conjuction with -these pair styles. It is a soft segmental repulsive potential (SRP) -that can prevent DPD polymer chains from crossing each other.

    +
    +

    Note

    +

    If you are modeling DPD polymer chains, you may want to use the +pair_style srp command in conjuction with these pair +styles. It is a soft segmental repulsive potential (SRP) that can +prevent DPD polymer chains from crossing each other.

    -
    -

    Warning

    -

    The virial calculation for pressure when using this -pair style includes all the components of force listed above, -including the random force.

    +
    +

    Note

    +

    The virial calculation for pressure when using this pair style +includes all the components of force listed above, including the +random force.


    Styles with a cuda, gpu, intel, kk, omp, or opt suffix are @@ -317,7 +317,7 @@ Phys Comm, 230, 7191-7201 (2011).

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -338,7 +338,7 @@ Phys Comm, 230, 7191-7201 (2011).

    @@ -261,7 +261,7 @@ of Gas Flows” (1994).

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -282,7 +282,7 @@ of Gas Flows” (1994).

    @@ -232,20 +232,20 @@ original serial EAM MD code, written by the EAM originators. Several DYNAMO potential files for different metals are included in the “potentials” directory of the LAMMPS distribution. All of these files are parameterized in terms of LAMMPS metal units.

    -
    -

    Warning

    -

    The eam style reads single-element EAM potentials in -the DYNAMO funcfl format. Either single element or alloy systems -can be modeled using multiple funcfl files and style eam. For the -alloy case LAMMPS mixes the single-element potentials to produce alloy +

    +

    Note

    +

    The eam style reads single-element EAM potentials in the +DYNAMO funcfl format. Either single element or alloy systems can be +modeled using multiple funcfl files and style eam. For the alloy +case LAMMPS mixes the single-element potentials to produce alloy potentials, the same way that DYNAMO does. Alternatively, a single DYNAMO setfl file or Finnis/Sinclair EAM file can be used by LAMMPS to model alloy systems by invoking the eam/alloy or eam/cd or eam/fs styles as described below. These files require no mixing since they specify alloy interactions explicitly.

    -
    -

    Warning

    +
    +

    Note

    Note that unlike for other potentials, cutoffs for EAM potentials are not set in the pair_style or pair_coeff command; they are specified in the EAM potential files themselves. Likewise, the @@ -566,7 +566,7 @@ Materials Science & Engineering, 7, 075005 (2009).

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -587,7 +587,7 @@ Materials Science & Engineering, 7, 075005 (2009).

    @@ -272,7 +272,7 @@ appropriate units if your simulation doesn’t use “metal” units

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -293,7 +293,7 @@ appropriate units if your simulation doesn’t use “metal” units @@ -275,25 +275,25 @@ particular atom type. The ECP captures the orbital overlap between a core pseudo particle and valence electrons within the Pauli repulsion. A list of type:element-symbol pairs may be provided for all ECP representations, after the “ecp” keyword.

    -
    -

    Warning

    -

    Default ECP parameters are provided for C, N, O, Al, -and Si. Users can modify these using the pair_coeff command as -exemplified above. For this, the User must distinguish between two -different functional forms supported, one that captures the orbital -overlap assuming the s-type core interacts with an s-like valence -electron (s-s) and another that assumes the interaction is s-p. For -systems that exhibit significant p-character (e.g. C, N, O) the s-p -form is recommended. The “s” ECP form requires 3 parameters and the -“p” 5 parameters.

    +
    +

    Note

    +

    Default ECP parameters are provided for C, N, O, Al, and Si. +Users can modify these using the pair_coeff command as exemplified +above. For this, the User must distinguish between two different +functional forms supported, one that captures the orbital overlap +assuming the s-type core interacts with an s-like valence electron +(s-s) and another that assumes the interaction is s-p. For systems +that exhibit significant p-character (e.g. C, N, O) the s-p form is +recommended. The “s” ECP form requires 3 parameters and the “p” 5 +parameters.

    -
    -

    Warning

    -

    there are two different pressures that can be reported -for eFF when defining this pair_style, one (default) that considers -electrons do not contribute radial virial components (i.e. electrons -treated as incompressible ‘rigid’ spheres) and one that does. The -radial electronic contributions to the virials are only tallied if the +

    +

    Note

    +

    there are two different pressures that can be reported for eFF +when defining this pair_style, one (default) that considers electrons +do not contribute radial virial components (i.e. electrons treated as +incompressible ‘rigid’ spheres) and one that does. The radial +electronic contributions to the virials are only tallied if the flexible pressure option is set, and this will affect both global and per-atom quantities. In principle, the true pressure of a system is somewhere in between the rigid and the flexible eFF pressures, but, @@ -302,17 +302,16 @@ significant over long-term averaged runs (i.e. even though the energy partitioning changes, the total energy remains similar).


    -
    -

    Warning

    -

    This implemention of eFF gives a reasonably accurate -description 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 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:

    +
    +

    Note

    +

    This implemention of eFF gives a reasonably accurate description +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 +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:

    _images/eff_ECP1.jpg _images/eff_ECP2.jpg @@ -411,7 +410,7 @@ Chem, 32, 497-512 (2011).

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -432,7 +431,7 @@ Chem, 32, 497-512 (2011).

    @@ -169,14 +169,14 @@ below

    r_(c,psi), A_(eta), r_(s,eta), r_(c,eta), chi, and pair function type p are parameters, with subscripts ij indicating the two species of atoms in the atomic pair.

    -
    -

    Warning

    -

    Even though the EIM potential is treating atoms as -charged ions, you should not use a LAMMPS atom_style -that stores a charge on each atom and thus requires you to assign a -charge to each atom, e.g. the charge or full atom styles. This is -because the EIM potential infers the charge on an atom from the -equation above for q_i; you do not assign charges explicitly.

    +
    +

    Note

    +

    Even though the EIM potential is treating atoms as charged ions, +you should not use a LAMMPS atom_style that stores a +charge on each atom and thus requires you to assign a charge to each +atom, e.g. the charge or full atom styles. This is because the +EIM potential infers the charge on an atom from the equation above for +q_i; you do not assign charges explicitly.


    All the EIM parameters are listed in a potential file which is @@ -283,7 +283,7 @@ Xiaowang Zhou (Sandia) for details via email at xzhou at sandia.gov.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -304,7 +304,7 @@ Xiaowang Zhou (Sandia) for details via email at xzhou at sandia.gov.

    @@ -273,7 +273,7 @@ enabled if LAMMPS is build with that package. See the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -294,7 +294,7 @@ enabled if LAMMPS is build with that package. See the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/pair_gayberne.html b/doc/pair_gayberne.html index 83631f3566..0d4a4b7f99 100644 --- a/doc/pair_gayberne.html +++ b/doc/pair_gayberne.html @@ -8,7 +8,7 @@ - pair_style gayberne command — LAMMPS 15 May 2015 version documentation + pair_style gayberne command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -224,18 +224,18 @@ setting made for Gay-Berne for a particular type I (because I-I interactions are computed by another hybrid pair potential), then you still need to insure the epsilon a,b,c coefficients are assigned to that type. e.g. in a “pair_coeff I J” command.

    -
    -

    Warning

    -

    If the epsilon a = b = c for an atom type, and if the -shape of the particle itself is spherical, meaning its 3 shape -parameters are all the same, then the particle is treated as an LJ -sphere by the Gay-Berne potential. This is significant because if two -LJ spheres interact, then the simple Lennard-Jones formula is used to -compute their interaction energy/force using the specified epsilon and -sigma as the standard LJ parameters. This is much cheaper to compute -than the full Gay-Berne formula. To treat the particle as a LJ sphere -with sigma = D, you should normally set epsilon a = b = c = 1.0, set -the pair_coeff sigma = D, and also set the 3 shape parameters for the +

    +

    Note

    +

    If the epsilon a = b = c for an atom type, and if the shape of +the particle itself is spherical, meaning its 3 shape parameters are +all the same, then the particle is treated as an LJ sphere by the +Gay-Berne potential. This is significant because if two LJ spheres +interact, then the simple Lennard-Jones formula is used to compute +their interaction energy/force using the specified epsilon and sigma +as the standard LJ parameters. This is much cheaper to compute than +the full Gay-Berne formula. To treat the particle as a LJ sphere with +sigma = D, you should normally set epsilon a = b = c = 1.0, set the +pair_coeff sigma = D, and also set the 3 shape parameters for the particle to D. The one exception is that if the 3 shape parameters are set to 0.0, which is a valid way in LAMMPS to specify a point particle, then the Gay-Berne potential will treat that as shape @@ -325,7 +325,7 @@ Berardi, Muccioli, Zannoni, J Chem Phys, 128, 024905 (2008).

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -346,7 +346,7 @@ Berardi, Muccioli, Zannoni, J Chem Phys, 128, 024905 (2008).

    @@ -158,16 +158,16 @@
  • xmu = static yield criterion (unitless value between 0.0 and 1.0e4)
  • dampflag = 0 or 1 if tangential damping force is excluded or included
  • -
    -

    Warning

    -

    Versions of LAMMPS before 9Jan09 had different style -names for granular force fields. This is to emphasize the fact that -the Hertzian equation has changed to model polydispersity more -accurately. A side effect of the change is that the Kn, Kt, gamma_n, -and gamma_t coefficients in the pair_style command must be specified -with different values in order to reproduce calculations made with -earlier versions of LAMMPS, even for monodisperse systems. See the -NOTE below for details.

    +
    +

    Note

    +

    Versions of LAMMPS before 9Jan09 had different style names for +granular force fields. This is to emphasize the fact that the +Hertzian equation has changed to model polydispersity more accurately. +A side effect of the change is that the Kn, Kt, gamma_n, and gamma_t +coefficients in the pair_style command must be specified with +different values in order to reproduce calculations made with earlier +versions of LAMMPS, even for monodisperse systems. See the NOTE below +for details.

    @@ -252,18 +252,18 @@ true in the Hookean case, except that a spring constant must be chosen that is appropriate for the absolute size of particles in the model. Since relative particle sizes are not accounted for, the Hookean styles may not be a suitable model for polydisperse systems.

    -
    -

    Warning

    -

    In versions of LAMMPS before 9Jan09, the equation for -Hertzian interactions did not include the sqrt(RiRj/Ri+Rj) term and -thus was not as accurate for polydisperse systems. For monodisperse -systems, sqrt(RiRj/Ri+Rj) is a constant factor that effectively scales -all 4 coefficients: Kn, Kt, gamma_n, gamma_t. Thus you can set the -values of these 4 coefficients appropriately in the current code to -reproduce the results of a previous Hertzian monodisperse calculation. -For example, for the common case of a monodisperse system with -particles of diameter 1, all 4 of these coefficients should now be set -2x larger than they were previously.

    +
    +

    Note

    +

    In versions of LAMMPS before 9Jan09, the equation for Hertzian +interactions did not include the sqrt(RiRj/Ri+Rj) term and thus was +not as accurate for polydisperse systems. For monodisperse systems, +sqrt(RiRj/Ri+Rj) is a constant factor that effectively scales all 4 +coefficients: Kn, Kt, gamma_n, gamma_t. Thus you can set the values +of these 4 coefficients appropriately in the current code to reproduce +the results of a previous Hertzian monodisperse calculation. For +example, for the common case of a monodisperse system with particles +of diameter 1, all 4 of these coefficients should now be set 2x larger +than they were previously.

    Xmu is also specified in the pair_style command and is the upper limit of the tangential force through the Coulomb criterion Ft = xmu*Fn, @@ -273,12 +273,12 @@ between 2 particles grows according to a tangential spring and dash-pot model until Ft/Fn = xmu and is then held at Ft = Fn*xmu until the particles lose contact. In the Hertzian case, a similar analogy holds, though the spring is no longer linear.

    -
    -

    Warning

    -

    Normally, xmu should be specified as a fractional -value between 0.0 and 1.0, however LAMMPS allows large values (up to -1.0e4) to allow for modeling of systems which can sustain very large -tangential forces.

    +
    +

    Note

    +

    Normally, xmu should be specified as a fractional value between +0.0 and 1.0, however LAMMPS allows large values (up to 1.0e4) to allow +for modeling of systems which can sustain very large tangential +forces.

    For granular styles there are no additional coefficients to set for each pair of atom types via the pair_coeff command. @@ -370,7 +370,7 @@ E, 64, p 051302 (2001).

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -391,7 +391,7 @@ E, 64, p 051302 (2001).

    @@ -282,7 +282,7 @@ support the inner, middle, outer keywords.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -303,7 +303,7 @@ support the inner, middle, outer keywords.

    @@ -189,57 +189,53 @@ that the Morse form gives improved results for Dendrimer simulations, when n = 2.

    See this howto section of the manual for more information on the DREIDING forcefield.

    -
    -

    Warning

    -

    Because the Dreiding hydrogen bond potential is only -one portion of an overall force field which typically includes other -pairwise interactions, it is common to use it as a sub-style in a -pair_style hybrid/overlay command, where another -pair style provides the repulsive core interaction between pairs of -atoms, e.g. a 1/r^12 Lennard-Jones repulsion.

    +
    +

    Note

    +

    Because the Dreiding hydrogen bond potential is only one portion +of an overall force field which typically includes other pairwise +interactions, it is common to use it as a sub-style in a pair_style hybrid/overlay command, where another pair style +provides the repulsive core interaction between pairs of atoms, e.g. a +1/r^12 Lennard-Jones repulsion.

    -
    -

    Warning

    -

    When using the hbond/dreiding pair styles with -pair_style hybrid/overlay, you should explicitly -define pair interactions between the donor atom and acceptor atoms, -(as well as between these atoms and ALL other atoms in your system). -Whenever pair_style hybrid/overlay is used, -ordinary mixing rules are not applied to atoms like the donor and -acceptor atoms because they are typically referenced in multiple pair -styles. Neglecting to do this can cause difficult-to-detect physics -problems.

    +
    +

    Note

    +

    When using the hbond/dreiding pair styles with pair_style hybrid/overlay, you should explicitly define pair +interactions between the donor atom and acceptor atoms, (as well as +between these atoms and ALL other atoms in your system). Whenever +pair_style hybrid/overlay is used, ordinary mixing +rules are not applied to atoms like the donor and acceptor atoms +because they are typically referenced in multiple pair styles. +Neglecting to do this can cause difficult-to-detect physics problems.

    -
    -

    Warning

    -

    In the original Dreiding force field paper 1-4 -non-bonded interactions ARE allowed. If this is desired for your -model, use the special_bonds command (e.g. “special_bonds lj 0.0 0.0 -1.0”) to turn these interactions on.

    +
    +

    Note

    +

    In the original Dreiding force field paper 1-4 non-bonded +interactions ARE allowed. If this is desired for your model, use the +special_bonds command (e.g. “special_bonds lj 0.0 0.0 1.0”) to turn +these interactions on.


    The following coefficients must be defined for pairs of eligible donor/acceptor types via the pair_coeff command as in the examples above.

    -
    -

    Warning

    +
    +

    Note

    Unlike other pair styles and their associated pair_coeff commands, you do not need to specify pair_coeff settings for all possible I,J type pairs. Only I,J type pairs for atoms which act as joint donors/acceptors need to be specified; all other type pairs are assumed to be inactive.

    -
    -

    Warning

    -

    A pair_coeff command can be -speficied multiple times for the same donor/acceptor type pair. This -enables multiple hydrogen types to be assigned to the same -donor/acceptor type pair. For other pair_styles, if the pair_coeff -command is re-used for the same I.J type pair, the settings for that -type pair are overwritten. For the hydrogen bond potentials this is -not the case; the settings are cummulative. This means the only way -to turn off a previous setting, is to re-use the pair_style command -and start over.

    +
    +

    Note

    +

    A pair_coeff command can be speficied multiple +times for the same donor/acceptor type pair. This enables multiple +hydrogen types to be assigned to the same donor/acceptor type pair. +For other pair_styles, if the pair_coeff command is re-used for the +same I.J type pair, the settings for that type pair are overwritten. +For the hydrogen bond potentials this is not the case; the settings +are cummulative. This means the only way to turn off a previous +setting, is to re-use the pair_style command and start over.

    For the hbond/dreiding/lj style the list of coefficients is as follows:

    @@ -360,7 +356,7 @@ thermo_style custom step temp epair v_E_hbond

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -381,7 +377,7 @@ thermo_style custom step temp epair v_E_hbond @@ -196,17 +196,16 @@ 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 pair_coeff command to assign parameters for the different type pairs.

    -
    -

    Warning

    -

    There are two exceptions to this option to list an -individual pair style multiple times. The first is for pair styles -implemented as Fortran libraries: pair_style meam and -pair_style reax (pair_style reax/c -is OK). This is because unlike a C++ class, they can not be -instantiated multiple times, due to the manner in which they were -coded in Fortran. The second is for GPU-enabled pair styles in the -GPU package. This is b/c the GPU package also currently assumes that -only one instance of a pair style is being used.

    +
    +

    Note

    +

    There are two exceptions to this option to list an individual +pair style multiple times. The first is for pair styles implemented +as Fortran libraries: pair_style meam and pair_style reax (pair_style reax/c is OK). +This is because unlike a C++ class, they can not be instantiated +multiple times, due to the manner in which they were coded in Fortran. +The second is for GPU-enabled pair styles in the GPU package. This is +b/c the GPU package also currently assumes that only one instance of a +pair style is being used.

    In the pair_coeff commands, the name of a pair style must be added after the I,J type specification, with the remaining coefficients @@ -351,10 +350,13 @@ the specific syntax, requirements and restrictions.

    The potential energy contribution to the overall system due to an individual sub-style can be accessed and output via the compute pair command.


    -

    IMPORTANT: Several of the potentials defined via the pair_style -command in LAMMPS are really many-body potentials, such as Tersoff, -AIREBO, MEAM, ReaxFF, etc. The way to think about using these -potentials in a hybrid setting is as follows.

    +
    +

    Note

    +

    Several of the potentials defined via the pair_style command in +LAMMPS are really many-body potentials, such as Tersoff, AIREBO, MEAM, +ReaxFF, etc. The way to think about using these potentials in a +hybrid setting is as follows.

    +

    A subset of atom types is assigned to the many-body potential with a single pair_coeff command, using “* *” to include all types and the NULL keywords described above to exclude specific @@ -488,7 +490,7 @@ the same or else LAMMPS will generate an error.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -509,7 +511,7 @@ the same or else LAMMPS will generate an error.

    @@ -234,7 +234,7 @@ kim-api package version 1.6.0 and higher.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -255,7 +255,7 @@ kim-api package version 1.6.0 and higher.

    @@ -214,7 +214,7 @@ appropriate units if your simulation doesn’t use “metal” units

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -235,7 +235,7 @@ appropriate units if your simulation doesn’t use “metal” units @@ -247,7 +247,7 @@ line/line or line/particle interactions requires the use the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -268,7 +268,7 @@ line/line or line/particle interactions requires the use the @@ -260,7 +260,7 @@ LAMMPS is build with that package. See the Making

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -281,7 +281,7 @@ LAMMPS is build with that package. See the Making @@ -377,13 +377,13 @@ and the distance to the massless charge site are specified as pair_style arguments. Style lj/cut/tip4p/cut uses a cutoff for Coulomb interactions; style lj/cut/tip4p/long is for use with a long-range Coulombic solver (Ewald or PPPM).

    -
    -

    Warning

    -

    For each TIP4P water molecule in your system, the atom -IDs for the O and 2 H atoms must be consecutive, with the O atom -first. This is to enable LAMMPS to “find” the 2 H atoms associated -with each O atom. For example, if the atom ID of an O atom in a TIP4P -water molecule is 500, then its 2 H atoms must have IDs 501 and 502.

    +
    +

    Note

    +

    For each TIP4P water molecule in your system, the atom IDs for +the O and 2 H atoms must be consecutive, with the O atom first. This +is to enable LAMMPS to “find” the 2 H atoms associated with each O +atom. For example, if the atom ID of an O atom in a TIP4P water +molecule is 500, then its 2 H atoms must have IDs 501 and 502.

    See the howto section for more information on how to use the TIP4P pair styles and lists of @@ -494,7 +494,7 @@ Phys, 79, 926 (1983).

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -515,7 +515,7 @@ Phys, 79, 926 (1983).

    @@ -230,7 +230,7 @@ details.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -251,7 +251,7 @@ details.

    @@ -243,7 +243,7 @@ support the inner, middle, outer keywords.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -264,7 +264,7 @@ support the inner, middle, outer keywords.

    @@ -234,7 +234,7 @@ to be specified in an input script that reads a restart file.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -255,7 +255,7 @@ to be specified in an input script that reads a restart file.

    @@ -209,13 +209,13 @@ short distance away from the oxygen atom along the bisector of the HOH angle. The atomic types of the oxygen and hydrogen atoms, the bond and angle types for OH and HOH interactions, and the distance to the massless charge site are specified as pair_style arguments.

    -
    -

    Warning

    -

    For each TIP4P water molecule in your system, the atom -IDs for the O and 2 H atoms must be consecutive, with the O atom -first. This is to enable LAMMPS to “find” the 2 H atoms associated -with each O atom. For example, if the atom ID of an O atom in a TIP4P -water molecule is 500, then its 2 H atoms must have IDs 501 and 502.

    +
    +

    Note

    +

    For each TIP4P water molecule in your system, the atom IDs for +the O and 2 H atoms must be consecutive, with the O atom first. This +is to enable LAMMPS to “find” the 2 H atoms associated with each O +atom. For example, if the atom ID of an O atom in a TIP4P water +molecule is 500, then its 2 H atoms must have IDs 501 and 502.

    See the howto section for more information on how to use the TIP4P pair style. Note that the @@ -336,7 +336,7 @@ the KSPACE package is installed by default.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -357,7 +357,7 @@ the KSPACE package is installed by default.

    @@ -226,7 +226,7 @@ if LAMMPS was built with that package. See the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -247,7 +247,7 @@ if LAMMPS was built with that package. See the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/pair_lj_smooth.html b/doc/pair_lj_smooth.html index 0e4d18b6e3..103f8197a0 100644 --- a/doc/pair_lj_smooth.html +++ b/doc/pair_lj_smooth.html @@ -8,7 +8,7 @@ - pair_style lj/smooth command — LAMMPS 15 May 2015 version documentation + pair_style lj/smooth command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -161,12 +161,12 @@ outer cutoff Rc.

    At the inner cutoff the force and its 1st derivative will match the unsmoothed LJ formula. At the outer cutoff the force and its 1st derivative will be 0.0. The inner cutoff cannot be 0.0.

    -
    -

    Warning

    -

    this force smoothing causes the energy to be -discontinuous both in its values and 1st 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 +

    The following coefficients must be defined for each pair of atoms @@ -243,7 +243,7 @@ to be specified in an input script that reads a restart file.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -264,7 +264,7 @@ to be specified in an input script that reads a restart file.

    @@ -223,7 +223,7 @@ to be specified in an input script that reads a restart file.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -244,7 +244,7 @@ to be specified in an input script that reads a restart file.

    @@ -337,18 +337,18 @@ overlapping each other. In this case, if lambda = 1, a singularity may occur. These substyles are suitable to represent charges embedded in the Lennard-Jones radius of another site (for example hydrogen atoms in several water models).

    -

    IMPORTANT NOTES: When using the core-softed Coulomb potentials with -long-range solvers (coul/long/soft, lj/cut/coul/long/soft, etc.) -in a free energy calculation in which sites holding electrostatic -charges are being created or anihilated (using -fix_adapt/fep and compute_fep) -it is important to adapt both the lambda activation parameter (from 0 -to 1, or the reverse) and the value of the charge (from 0 to its final -value, or the reverse). This ensures that long-range electrostatic -terms (kspace) are correct. It is not necessary to use core-softed -Coulomb potentials if the van der Waals site is present during the -free-energy route, thus avoiding overlap of the charges. Examples are -provided in the LAMMPS source directory tree, under examples/USER/fep.

    +

    NOTES: When using the core-softed Coulomb potentials with long-range +solvers (coul/long/soft, lj/cut/coul/long/soft, etc.) in a free +energy calculation in which sites holding electrostatic charges are +being created or anihilated (using fix_adapt/fep +and compute_fep) it is important to adapt both the +lambda activation parameter (from 0 to 1, or the reverse) and the +value of the charge (from 0 to its final value, or the reverse). This +ensures that long-range electrostatic terms (kspace) are correct. It +is not necessary to use core-softed Coulomb potentials if the van der +Waals site is present during the free-energy route, thus avoiding +overlap of the charges. Examples are provided in the LAMMPS source +directory tree, under examples/USER/fep.


    Styles with a cuda, gpu, intel, kk, omp, or opt suffix are functionally the same as the corresponding style without the suffix. @@ -416,7 +416,7 @@ Phys Lett, 222, 529 (1994).

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -437,7 +437,7 @@ Phys Lett, 222, 529 (1994).

    @@ -201,11 +201,11 @@ tensor of the undisturbed fluid with viscosity mu. Again, note that this is dynamic viscosity which has units of mass/distance/time, not kinematic viscosity. Volume fraction corrections to R_FU are included as long as flagVF is set to 1 (default).

    -
    -

    Warning

    -

    When using the FLD terms, these pair styles are -designed to be used with explicit time integration and a -correspondingly small timestep. Thus either fix nve/sphere or fix nve/asphere should be used for time integration. +

    +

    Note

    +

    When using the FLD terms, these pair styles are designed to be +used with explicit time integration and a correspondingly small +timestep. Thus either fix nve/sphere or fix nve/asphere should be used for time integration. To perform implicit FLD, see the pair_style lubricateU command.

    Style lubricate requires monodisperse spherical particles; style @@ -324,7 +324,7 @@ Illinois Urbana-Champaign,

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -345,7 +345,7 @@ Illinois Urbana-Champaign, @@ -204,12 +204,12 @@ computed. For the same reason, it won’t work if additional non-pair styles are defined (such as bond or Kspace forces) as they are calculated in LAMMPS after the pairwise interactions have been computed.

    -
    -

    Warning

    -

    When using these styles, the these pair styles are -designed to be used with implicit time integration and a -correspondingly larger timestep. Thus either fix nve/noforce should be used for spherical -particles defined via atom_style sphere or fix nve/asphere/noforce should be used for +

    +

    Note

    +

    When using these styles, the these pair styles are designed to +be used with implicit time integration and a correspondingly larger +timestep. Thus either fix nve/noforce should +be used for spherical particles defined via atom_style sphere or fix nve/asphere/noforce should be used for spherical particles defined via atom_style ellipsoid. This is because the velocity and angular momentum of each particle is set by the pair style, and should not be reset by the time integration fix.

    @@ -311,7 +311,7 @@ velocity-gradient direction. In this case, one must use

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -332,7 +332,7 @@ velocity-gradient direction. In this case, one must use var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/pair_lubricateU.txt b/doc/pair_lubricateU.txt index f1fd7fb817..446d246ef1 100644 --- a/doc/pair_lubricateU.txt +++ b/doc/pair_lubricateU.txt @@ -93,11 +93,11 @@ styles are defined (such as bond or Kspace forces) as they are calculated in LAMMPS after the pairwise interactions have been computed. -IMPORTANT NOTE: When using these styles, the these pair styles are -designed to be used with implicit time integration and a -correspondingly larger timestep. Thus either "fix -nve/noforce"_fix_nve_noforce.html should be used for spherical -particles defined via "atom_style sphere"_atom_style.html or "fix +NOTE: When using these styles, the these pair styles are designed to +be used with implicit time integration and a correspondingly larger +timestep. Thus either "fix nve/noforce"_fix_nve_noforce.html should +be used for spherical particles defined via "atom_style +sphere"_atom_style.html or "fix nve/asphere/noforce"_fix_nve_asphere_noforce.html should be used for spherical particles defined via "atom_style ellipsoid"_atom_style.html. This is because the velocity and angular diff --git a/doc/pair_mdf.html b/doc/pair_mdf.html index ed6eab6df9..c1f99c46e7 100644 --- a/doc/pair_mdf.html +++ b/doc/pair_mdf.html @@ -8,7 +8,7 @@ - pair_style lj/mdf command — LAMMPS 15 May 2015 version documentation + pair_style lj/mdf command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -275,7 +275,7 @@ section for more info on packages.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with
    Sphinx using a theme provided by Read the Docs. @@ -296,7 +296,7 @@ section for more info on packages.

    @@ -461,7 +461,7 @@ of Ions in Matter”, Vol 1, 1985, Pergamon Press.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -482,7 +482,7 @@ of Ions in Matter”, Vol 1, 1985, Pergamon Press.

    @@ -190,11 +190,10 @@ mapping is not performed. This can be used when a meam/spline potential is used as part of the hybrid pair style. The NULL values are placeholders for atom types that will be used with other potentials.

    -
    -

    Warning

    -

    The meam/spline style currently supports only -single-element MEAM potentials. It may be extended for alloy systems -in the future.

    +
    +

    Note

    +

    The meam/spline style currently supports only single-element +MEAM potentials. It may be extended for alloy systems in the future.


    Styles with a cuda, gpu, intel, kk, omp, or opt suffix are @@ -255,7 +254,7 @@ Kress, Modelling Simulation Materials Science Enginerring, 8, 825

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -276,7 +275,7 @@ Kress, Modelling Simulation Materials Science Enginerring, 8, 825 @@ -192,8 +192,8 @@ mapping is not performed. This can be used when a meam/sw/spline potential is used as part of the hybrid pair style. The NULL values are placeholders for atom types that will be used with other potentials.

    -
    -

    Warning

    +
    +

    Note

    The meam/sw/spline style currently supports only single-element MEAM+SW potentials. It may be extended for alloy systems in the future.

    @@ -248,7 +248,7 @@ and Hyoungki Park at The Ohio State University.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -269,7 +269,7 @@ and Hyoungki Park at The Ohio State University.

    @@ -244,14 +244,14 @@ directory. These scripts show the necessary steps to perform constant-volume calculations and simulations. It is strongly recommended that the user work through and understand these examples before proceeding to more complex simulations.

    -
    -

    Warning

    -

    For good performance, LAMMPS should be built with the -compiler flags “-O3 -msse3 -funroll-loops” when including this pair -style. The src/MAKE/OPTIONS/Makefile.mpi_fastmgpt is an example -machine Makefile with these options included as part of a standard MPI -build. Note that as-is it will build with whatever low-level compiler -(g++, icc, etc) is the default for your MPI installation.

    +
    +

    Note

    +

    For good performance, LAMMPS should be built with the compiler +flags “-O3 -msse3 -funroll-loops” when including this pair style. The +src/MAKE/OPTIONS/Makefile.mpi_fastmgpt is an example machine Makefile +with these options included as part of a standard MPI build. Note +that as-is it will build with whatever low-level compiler (g++, icc, +etc) is the default for your MPI installation.


    Mixing, shift, table tail correction, restart:

    @@ -323,7 +323,7 @@ Oppelstrup and Moriarty, to be published.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -344,7 +344,7 @@ Oppelstrup and Moriarty, to be published.

    @@ -218,7 +218,7 @@ G. Jackson, E. Muller, J Phys Chem B, 115, 11154 (2011).

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -239,7 +239,7 @@ G. Jackson, E. Muller, J Phys Chem B, 115, 11154 (2011).

    @@ -226,7 +226,7 @@ see the doc page for individual styles to see which potentials support these options. If N is non-zero, a table of length 2^N is pre-computed for forces and energies, which can shrink their computational cost by up to a factor of 2. The table is indexed via a -bit-mapping technique (Wolff) and a linear interpolation is +bit-mapping technique (Wolff) and a linear interpolation is performed between adjacent table values. In our experiments with different table styles (lookup, linear, spline), this method typically gave the best performance in terms of speed and accuracy.

    @@ -262,15 +262,14 @@ simulations where the pressure influences the simulation box dimensions (e.g. the fix npt and fix nph commands). The formulas used for the long-range corrections come from equation 5 of (Sun).

    -
    -

    Warning

    -

    The tail correction terms are computed at the -beginning of each run, using the current atom counts of each atom -type. If atoms are deleted (or lost) or created during a simulation, -e.g. via the fix gcmc command, the correction factors -are not re-computed. If you expect the counts to change dramatically, -you can break a run into a series of shorter runs so that the -correction factors are re-computed more frequently.

    +
    +

    Note

    +

    The tail correction terms are computed at the beginning of each +run, using the current atom counts of each atom type. If atoms are +deleted (or lost) or created during a simulation, e.g. via the fix gcmc command, the correction factors are not +re-computed. If you expect the counts to change dramatically, you can +break a run into a series of shorter runs so that the correction +factors are re-computed more frequently.

    Several additional assumptions are inherent in using tail corrections, including the following:

    @@ -328,18 +327,18 @@ values are numeric weights from 0.0 to 1.0 inclusive, for the 1-2, 1-3, and 1-4 bond topology neighbors, respectively. The special keyword can only be used in conjunction with the pair keyword and has to directly follow it.

    -
    -

    Warning

    +
    +

    Note

    The global settings specified by the special_bonds command affect the construction of neighbor lists. Weights of 0.0 (for 1-2, 1-3, or 1-4 neighbors) exclude those pairs from the neighbor list entirely. Weights of 1.0 store the neighbor with no weighting applied. Thus only global values -different from exactly 0.0 or 1.0 can be overridden and an error -is generated if the requested setting is not compatible with the -global setting. Substituting 1.0e-10 for 0.0 and 0.9999999999 for -1.0 is usually a sufficient workaround in this case without causing -a significant error.

    +different from exactly 0.0 or 1.0 can be overridden and an error is +generated if the requested setting is not compatible with the global +setting. Substituting 1.0e-10 for 0.0 and 0.9999999999 for 1.0 is +usually a sufficient workaround in this case without causing a +significant error.

    @@ -378,7 +377,7 @@ mixing. See the doc pages for individual pair styles for details.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -399,7 +398,7 @@ mixing. See the doc pages for individual pair styles for details.

    @@ -229,7 +229,7 @@ to be specified in an input script that reads a restart file.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -250,7 +250,7 @@ to be specified in an input script that reads a restart file.

    @@ -238,7 +238,7 @@ package (which it is by default). See the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -259,7 +259,7 @@ package (which it is by default). See the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/pair_nm.html b/doc/pair_nm.html index b64ce97f0b..c9c079e338 100644 --- a/doc/pair_nm.html +++ b/doc/pair_nm.html @@ -8,7 +8,7 @@ - pair_style nm/cut command — LAMMPS 15 May 2015 version documentation + pair_style nm/cut command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -287,7 +287,7 @@ LAMMPS was built with that package. See the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -308,7 +308,7 @@ LAMMPS was built with that package. See the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/pair_none.html b/doc/pair_none.html index 15541cc35e..873cad4ff3 100644 --- a/doc/pair_none.html +++ b/doc/pair_none.html @@ -8,7 +8,7 @@ - pair_style none command — LAMMPS 15 May 2015 version documentation + pair_style none command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -172,7 +172,7 @@ amount of memory. So you should either set the neighbor style to

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with
    Sphinx using a theme provided by Read the Docs. @@ -193,7 +193,7 @@ amount of memory. So you should either set the neighbor style to @@ -317,7 +317,7 @@ Plasticity Model for Peridynamics. Sandia National Lab Report,

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -338,7 +338,7 @@ Plasticity Model for Peridynamics. Sandia National Lab Report, @@ -325,7 +325,7 @@ F. P. Doty, J. Mater. Sci. Res., 4, 15 (2015).

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -346,7 +346,7 @@ F. P. Doty, J. Mater. Sci. Res., 4, 15 (2015).

    @@ -211,7 +211,7 @@ Review Letters 104, 136403 (2010).

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -232,7 +232,7 @@ Review Letters 104, 136403 (2010).

    @@ -155,7 +155,7 @@ represent the contributions of chemical bonding to the potential energy. There is more than one version of ReaxFF. The version implemented in LAMMPS uses the functional forms documented in the supplemental information of the following paper: -(Chenoweth). The version integrated into LAMMPS matches +(Chenoweth). The version integrated into LAMMPS matches the most up-to-date version of ReaxFF as of summer 2010.

    WARNING: pair style reax is now deprecated and will soon be retired. Users should switch to pair_style reax/c. The reax style @@ -173,13 +173,13 @@ value other than “ffield.reax” will be rejected (see below).

    potentials dir, each called potentials/ffield.reax.label. These are documented in potentials/README.reax. The default ffield.reax contains parameterizations for the following elements: C, H, O, N, S.

    -
    -

    Warning

    -

    We do not distribute a wide variety of ReaxFF force -field files with LAMMPS. Adri van Duin’s group at PSU is the central -repository for this kind of data as they are continuously deriving and -updating parameterizations for different classes of materials. You -can visit their WWW site at +

    +

    Note

    +

    We do not distribute a wide variety of ReaxFF force field files +with LAMMPS. Adri van Duin’s group at PSU is the central repository +for this kind of data as they are continuously deriving and updating +parameterizations for different classes of materials. You can visit +their WWW site at http://www.engr.psu.edu/adri, register as a “new user”, and then submit a request to their group describing material(s) you are interested in modeling with ReaxFF. They can tell @@ -272,11 +272,11 @@ etc. If a mapping value is specified as NULL, the mapping is not performed. This can be used when a ReaxFF potential is used as part of the hybrid pair style. The NULL values are placeholders for atom types that will be used with other potentials.

    -
    -

    Warning

    -

    Currently the reax pair style cannot be used as part -of the hybrid pair style. Some additional changes still need to be -made to enable this.

    +
    +

    Note

    +

    Currently the reax pair style cannot be used as part of the +hybrid pair style. Some additional changes still need to be made to +enable this.

    As an example, say your LAMMPS simulation has 4 atom types and the elements are ordered as C, H, O, N in the ffield file. If you want @@ -329,7 +329,7 @@ Journal of Physical Chemistry A, 112, 1040-1053 (2008).

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -350,7 +350,7 @@ Journal of Physical Chemistry A, 112, 1040-1053 (2008).

    @@ -179,13 +179,13 @@ against the original ReaxFF code for the systems mentioned above. You can use other ffield files for specific chemical systems that may be available elsewhere (but note that their accuracy may not have been tested).

    -
    -

    Warning

    -

    We do not distribute a wide variety of ReaxFF force -field files with LAMMPS. Adri van Duin’s group at PSU is the central -repository for this kind of data as they are continuously deriving and -updating parameterizations for different classes of materials. You -can visit their WWW site at +

    +

    Note

    +

    We do not distribute a wide variety of ReaxFF force field files +with LAMMPS. Adri van Duin’s group at PSU is the central repository +for this kind of data as they are continuously deriving and updating +parameterizations for different classes of materials. You can visit +their WWW site at http://www.engr.psu.edu/adri, register as a “new user”, and then submit a request to their group describing material(s) you are interested in modeling with ReaxFF. They can tell @@ -200,13 +200,12 @@ performance and output settings. Each line in the control file specifies the value for a control variable. The format of the control file is described below.

    -
    -

    Warning

    +
    +

    Note

    The LAMMPS default values for the ReaxFF global parameters -correspond to those used by -Adri van Duin’s stand-alone serial code. If these are changed by -setting control variables in the control file, the results from -LAMMPS and the serial code will not agree.

    +correspond to those used by Adri van Duin’s stand-alone serial +code. If these are changed by setting control variables in the control +file, the results from LAMMPS and the serial code will not agree.

    Two examples using pair_style reax/c are provided in the examples/reax sub-directory, along with corresponding examples for @@ -401,7 +400,7 @@ of Physical Chemistry A, 115, 11016-11022 (2011).

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -422,7 +421,7 @@ of Physical Chemistry A, 115, 11016-11022 (2011).

    @@ -321,7 +321,7 @@ less accurate when high-aspect ratio ellipsoids are used.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -342,7 +342,7 @@ less accurate when high-aspect ratio ellipsoids are used.

    @@ -274,7 +274,7 @@ was built with that package. See the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -295,7 +295,7 @@ was built with that package. See the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/pair_smd_hertz.html b/doc/pair_smd_hertz.html index 481a032699..c3066bda57 100644 --- a/doc/pair_smd_hertz.html +++ b/doc/pair_smd_hertz.html @@ -8,7 +8,7 @@ - pair_style smd/hertz command — LAMMPS 15 May 2015 version documentation + pair_style smd/hertz command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -178,7 +178,7 @@ section for more info.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with
    Sphinx using a theme provided by Read the Docs. @@ -199,7 +199,7 @@ section for more info.

    @@ -188,7 +188,7 @@ section for more info.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -209,7 +209,7 @@ section for more info.

    @@ -179,7 +179,7 @@ section for more info.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -200,7 +200,7 @@ section for more info.

    @@ -193,7 +193,7 @@ section for more info.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -214,7 +214,7 @@ section for more info.

    @@ -320,10 +320,10 @@ quotation marks (‘’).

  • If you want to print or not in file ‘Energy_component.txt’ the three main contributions to the energy of the system according to the description presented above : ‘true’ or ‘false’ and N<sub>Energy</sub>. This option writes in file every N<sub>Energy</sub> time step. If the value is ‘false’ then N<sub>Energy</sub> = 0. The file take into account the possibility to have several QEq group g then it writes: time step, number of atoms in group g, electrostatic part of energy, E<sub>ES</sub>, the interaction between oxygen, E<sub>OO</sub>, and short range metal-oxygen interaction, E<sub>MO</sub>.
  • If you want to print in file ‘Electroneg_component.txt’ the electronegativity component (&#8706E<sub>tot</sub> &#8260&#8706Q<sub>i</sub>) or not: ‘true’ or ‘false’ and N<sub>Electroneg</sub>.This option writes in file every N<sub>Electroneg</sub> time step. If the value is ‘false’ then N<sub>Electroneg</sub> = 0. The file consist in atom number i, atom type (1 for oxygen and # higher than 1 for metal), atom position: x, y and z, atomic charge of atom i, electrostatic part of atom i electronegativity, covalent part of atom i electronegativity, the hopping integral of atom i (Z&#946<sup>2</sup>)<sub>i<sub> and box electronegativity.
  • -
    -

    Warning

    -

    This last option slows down the calculation -dramatically. Use only with a single processor simulation.

    +
    +

    Note

    +

    This last option slows down the calculation dramatically. Use +only with a single processor simulation.


    Mixing, shift, table, tail correction, restart, rRESPA info:

    @@ -373,7 +373,7 @@ Phys, 110, 8254 (1999).

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -394,7 +394,7 @@ Phys, 110, 8254 (1999).

    @@ -298,7 +298,7 @@ available at

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -319,7 +319,7 @@ available at var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/pair_soft.html b/doc/pair_soft.html index 2aa30db7d3..c05b42a28a 100644 --- a/doc/pair_soft.html +++ b/doc/pair_soft.html @@ -8,7 +8,7 @@ - pair_style soft command — LAMMPS 15 May 2015 version documentation + pair_style soft command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -176,16 +176,16 @@ commands, or by mixing as described below:

    The last coefficient is optional. If not specified, the global soft cutoff is used.

    -
    -

    Warning

    -

    The syntax for pair_coeff with a -single A coeff is different in the current version of LAMMPS than in -older versions which took two values, Astart and Astop, to ramp -between them. This functionality is now available in a more general -form through the fix adapt command, as explained -below. Note that if you use an old input script and specify Astart -and Astop without a cutoff, then LAMMPS will interpret that as A and a -cutoff, which is probabably not what you want.

    +
    +

    Note

    +

    The syntax for pair_coeff with a single A +coeff is different in the current version of LAMMPS than in older +versions which took two values, Astart and Astop, to ramp between +them. This functionality is now available in a more general form +through the fix adapt command, as explained below. +Note that if you use an old input script and specify Astart and Astop +without a cutoff, then LAMMPS will interpret that as A and a cutoff, +which is probabably not what you want.

    The fix adapt command can be used to vary A for one or more pair types over the course of a simulation, in which case @@ -257,7 +257,7 @@ to be specified in an input script that reads a restart file.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -278,7 +278,7 @@ to be specified in an input script that reads a restart file.

    @@ -185,7 +185,7 @@ if LAMMPS was built with that package. See the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -206,7 +206,7 @@ if LAMMPS was built with that package. See the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/pair_sph_idealgas.html b/doc/pair_sph_idealgas.html index 6b73170101..94507890ec 100644 --- a/doc/pair_sph_idealgas.html +++ b/doc/pair_sph_idealgas.html @@ -8,7 +8,7 @@ - pair_style sph/idealgas command — LAMMPS 15 May 2015 version documentation + pair_style sph/idealgas command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -193,7 +193,7 @@ if LAMMPS was built with that package. See the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -214,7 +214,7 @@ if LAMMPS was built with that package. See the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/pair_sph_lj.html b/doc/pair_sph_lj.html index 4082a6c592..bd30c9e09b 100644 --- a/doc/pair_sph_lj.html +++ b/doc/pair_sph_lj.html @@ -8,7 +8,7 @@ - pair_style sph/lj command — LAMMPS 15 May 2015 version documentation + pair_style sph/lj command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -195,7 +195,7 @@ if LAMMPS was built with that package. See the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -216,7 +216,7 @@ if LAMMPS was built with that package. See the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/pair_sph_rhosum.html b/doc/pair_sph_rhosum.html index e2900cf870..afa4f7696b 100644 --- a/doc/pair_sph_rhosum.html +++ b/doc/pair_sph_rhosum.html @@ -8,7 +8,7 @@ - pair_style sph/rhosum command — LAMMPS 15 May 2015 version documentation + pair_style sph/rhosum command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -187,7 +187,7 @@ if LAMMPS was built with that package. See the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -208,7 +208,7 @@ if LAMMPS was built with that package. See the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/pair_sph_taitwater.html b/doc/pair_sph_taitwater.html index 63382cf9ab..5abd33ee1d 100644 --- a/doc/pair_sph_taitwater.html +++ b/doc/pair_sph_taitwater.html @@ -8,7 +8,7 @@ - pair_style sph/taitwater command — LAMMPS 15 May 2015 version documentation + pair_style sph/taitwater command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -195,7 +195,7 @@ if LAMMPS was built with that package. See the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -216,7 +216,7 @@ if LAMMPS was built with that package. See the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/pair_sph_taitwater_morris.html b/doc/pair_sph_taitwater_morris.html index 1e1d5cc770..eb74daff95 100644 --- a/doc/pair_sph_taitwater_morris.html +++ b/doc/pair_sph_taitwater_morris.html @@ -8,7 +8,7 @@ - pair_style sph/taitwater/morris command — LAMMPS 15 May 2015 version documentation + pair_style sph/taitwater/morris command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -193,7 +193,7 @@ if LAMMPS was built with that package. See the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -214,7 +214,7 @@ if LAMMPS was built with that package. See the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/pair_srp.html b/doc/pair_srp.html index a59ff37536..7173a3bee9 100644 --- a/doc/pair_srp.html +++ b/doc/pair_srp.html @@ -8,7 +8,7 @@ - pair_style srp command — LAMMPS 15 May 2015 version documentation + pair_style srp command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -195,27 +195,23 @@ or read_restart<

    The last coefficient is optional. If not specified, the global cutoff is used.

    -
    -

    Warning

    -

    Pair style srp considers each bond of type btype to -be a fictitious “particle” of type bptype, where bptype is either -the largest atom type in the system, or the type set by the bptype -flag. Any actual existing particles with this atom type will be deleted -at the beginning of a run. This means you must specify the number of +

    +

    Note

    +

    Pair style srp considers each bond of type btype to be a +fictitious “particle” of type bptype, where bptype is either the +largest atom type in the system, or the type set by the bptype flag. +Any actual existing particles with this atom type will be deleted at +the beginning of a run. This means you must specify the number of types in your system accordingly; usually to be one larger than what would normally be the case, e.g. via the create_box -or by changing the header in your data file. -The ficitious “bond particles” are inserted at the beginning of the -run, and serve as placeholders that define the position of the bonds.

    -
    -
    This allows neighbor lists to be constructed and pairwise interactions
    -
    -
    to be computed in almost the same way as is done for actual particles.
    -
    Because bonds interact only with other bonds,
    -
    -

    pair_style hybrid should be used -to turn off interactions between atom type bptype and all other -types of atoms. An error will be flagged if pair_style hybrid is not used.

    +or by changing the header in your data file. The +ficitious “bond particles” are inserted at the beginning of the run, +and serve as placeholders that define the position of the bonds. This +allows neighbor lists to be constructed and pairwise interactions to +be computed in almost the same way as is done for actual particles. +Because bonds interact only with other bonds, pair_style hybrid should be used to turn off interactions +between atom type bptype and all other types of atoms. An error +will be flagged if pair_style hybrid is not used.

    The optional exclude keyword determines if forces are computed between first neighbor (directly connected) bonds. For a setting of @@ -279,7 +275,7 @@ Chem Phys, 136 (13) 134903, 2012.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -300,7 +296,7 @@ Chem Phys, 136 (13) 134903, 2012.

    @@ -350,7 +350,7 @@ package.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -371,7 +371,7 @@ package.

    @@ -329,7 +329,7 @@ appropriate units if your simulation doesn’t use “metal” units

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -350,7 +350,7 @@ appropriate units if your simulation doesn’t use “metal” units @@ -357,7 +357,7 @@ commands do need to be specified in the restart input script.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -378,7 +378,7 @@ commands do need to be specified in the restart input script.

    @@ -166,7 +166,7 @@ pair_coeff * * SiCGe.tersoff Si(D)

    Description

    The tersoff style computes a 3-body Tersoff potential -(Tersoff_1) for the energy E of a system of atoms as

    +(Tersoff_1) for the energy E of a system of atoms as

    _images/pair_tersoff_1.jpg

    where f_R is a two-body term and f_A includes three-body interactions. The summations in the formula are over all neighbors J and K of atom I @@ -259,15 +259,15 @@ be set to 0.0 if desired.

    Note that the twobody parameters in entries such as SiCC and CSiSi are often the same, due to the common use of symmetric mixing rules, but this is not always the case. For example, the beta and n parameters in -Tersoff_2 (Tersoff_2) are not symmetric.

    +Tersoff_2 (Tersoff_2) are not symmetric.

    We chose the above form so as to enable users to define all commonly used variants of the Tersoff potential. In particular, our form reduces to the original Tersoff form when m = 3 and gamma = 1, while -it reduces to the form of Albe et al. when beta = 1 and m = 1. +it reduces to the form of Albe et al. when beta = 1 and m = 1. Note that in the current Tersoff implementation in LAMMPS, m must be specified as either 3 or 1. Tersoff used a slightly different but equivalent form for alloys, which we will refer to as Tersoff_2 -potential (Tersoff_2). The tersoff/table style implements +potential (Tersoff_2). The tersoff/table style implements Tersoff_2 parameterization only.

    LAMMPS parameter values for Tersoff_2 can be obtained as follows: gamma_ijk = omega_ik, lambda3 = 0 and the value of @@ -356,7 +356,7 @@ Condens. Matter, 15, 5649(2003).

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -377,7 +377,7 @@ Condens. Matter, 15, 5649(2003).

    @@ -293,7 +293,7 @@ Comp. Mat. Science, 39, 457 (2007).

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -314,7 +314,7 @@ Comp. Mat. Science, 39, 457 (2007).

    @@ -359,7 +359,7 @@ Condens. Matter, 15, 5649(2003).

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -380,7 +380,7 @@ Condens. Matter, 15, 5649(2003).

    @@ -163,8 +163,8 @@ short distances by a function

    \frac{s_{ij} r_{ij} }{2} \right) \exp \left( - s_{ij} r_{ij} \right) \end{equation}\]

    This function results from an adaptation to point charges -(Noskov) of the dipole screening scheme originally proposed -by Thole. The scaling coefficient \(s_{ij}\) is determined +(Noskov) of the dipole screening scheme originally proposed +by Thole. The scaling coefficient \(s_{ij}\) is determined by the polarizability of the atoms, \(\alpha_i\), and by a Thole damping parameter \(a\). This Thole damping parameter usually takes a value of 2.6, but in certain force fields the value can depend upon @@ -232,7 +232,7 @@ pairs are 1-4 partners of which dihedrals.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -253,7 +253,7 @@ pairs are 1-4 partners of which dihedrals.

    @@ -250,7 +250,7 @@ tri/particle interactions requires the use the

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -271,7 +271,7 @@ tri/particle interactions requires the use the var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'15 May 2015 version', + VERSION:'10 Dec 2015 version', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true diff --git a/doc/pair_vashishta.html b/doc/pair_vashishta.html index 37a31cf930..84d0c8304e 100644 --- a/doc/pair_vashishta.html +++ b/doc/pair_vashishta.html @@ -8,7 +8,7 @@ - pair_style vashishta command — LAMMPS 15 May 2015 version documentation + pair_style vashishta command — LAMMPS 10 Dec 2015 version documentation @@ -32,7 +32,7 @@ - + @@ -329,7 +329,7 @@ appropriate units if your simulation doesn’t use “metal” units

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with
    Sphinx using a theme provided by Read the Docs. @@ -350,7 +350,7 @@ appropriate units if your simulation doesn’t use “metal” units @@ -204,7 +204,7 @@ pairwise portion of the potential, not the embedding portion.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -225,7 +225,7 @@ pairwise portion of the potential, not the embedding portion.

    @@ -224,7 +224,7 @@ to be specified in an input script that reads a restart file.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -245,7 +245,7 @@ to be specified in an input script that reads a restart file.

    @@ -263,7 +263,7 @@ And Membranes, Westview Press, ISBN: 978-0813340791 (2003).

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -284,7 +284,7 @@ And Membranes, Westview Press, ISBN: 978-0813340791 (2003).

    @@ -180,11 +180,11 @@ with hybrid/overlay -
    -

    Warning

    -

    The numerical values of the exponential decay -constants in the screening function depend on the unit of distance. In -the above equation they are given for units of angstroms. LAMMPS will +

    +

    Note

    +

    The numerical values of the exponential decay constants in the +screening function depend on the unit of distance. In the above +equation they are given for units of angstroms. LAMMPS will automatically convert these values to the distance unit of the specified LAMMPS units setting. The values of Z should always be given as multiples of a proton’s charge, e.g. 29.0 for @@ -258,7 +258,7 @@ Stopping and Range of Ions in Matter,” Volume 1, Pergamon, 1985.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -279,7 +279,7 @@ Stopping and Range of Ions in Matter,” Volume 1, Pergamon, 1985.

    @@ -202,7 +202,7 @@ command lays out a 3d grid of processors in each of 2 partitions.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -223,7 +223,7 @@ command lays out a 3d grid of processors in each of 2 partitions.

    @@ -171,11 +171,11 @@ prd 5000 100 10 10 100 1 54982 min 0.1 0.1 100 200 replicas of a system. One or more replicas can be used. The total number of steps N to run can be interpreted in one of two ways; see discussion of the time keyword below.

    -

    PRD is described in this paper by Art Voter. It is a method +

    PRD is described in this paper by Art Voter. It is a method for performing accelerated dynamics that is suitable for infrequent-event systems that obey first-order kinetics. A good overview of accelerated dynamics methods for such systems in given in -this review paper from the same group. To quote from the +this review paper from the same group. To quote from the paper: “The dynamical evolution is characterized by vibrational excursions within a potential basin, punctuated by occasional transitions between basins.” The transition probability is @@ -410,7 +410,7 @@ Research 32, 321 (2002).

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -431,7 +431,7 @@ Research 32, 321 (2002).

    @@ -211,7 +211,7 @@ thermodynamic properties, global values calculated by a

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -232,7 +232,7 @@ thermodynamic properties, global values calculated by a @@ -210,10 +210,10 @@ different processor grids for different partitions, e.g.

    partition yes 2 processors 2 3 2
    -
    -

    Warning

    -

    This command only affects the initial regular 3d grid -created when the simulation box is first specified via a +

    +

    Note

    +

    This command only affects the initial regular 3d grid created +when the simulation box is first specified via a create_box or read_data or read_restart command. Or if the simulation box is re-created via the replicate command. The same @@ -254,16 +254,15 @@ will choose the number of cores in that dimension of the node’s sub-grid. As with Px,Py,Pz, it will do this based on the size and shape of the global simulation box so as to minimize the surface-to-volume ratio of each processor’s sub-domain.

    -
    -

    Warning

    -

    For the twolevel style to work correctly, it -assumes the MPI ranks of processors LAMMPS is running on are ordered -by core and then by node. E.g. if you are running on 2 quad-core -nodes, for a total of 8 processors, then it assumes processors 0,1,2,3 -are on node 1, and processors 4,5,6,7 are on node 2. This is the -default rank ordering for most MPI implementations, but some MPIs -provide options for this ordering, e.g. via environment variable -settings.

    +
    +

    Note

    +

    For the twolevel style to work correctly, it assumes the MPI +ranks of processors LAMMPS is running on are ordered by core and then +by node. E.g. if you are running on 2 quad-core nodes, for a total of +8 processors, then it assumes processors 0,1,2,3 are on node 1, and +processors 4,5,6,7 are on node 2. This is the default rank ordering +for most MPI implementations, but some MPIs provide options for this +ordering, e.g. via environment variable settings.

    The numa style operates similar to the twolevel keyword except that it auto-detects which cores are running on which nodes. @@ -278,12 +277,11 @@ of the processors than the twolevel options.

    The numa style will give an error if the number of MPI processes is not divisible by the number of cores used per node, or any of the Px or Py of Pz values is greater than 1.

    -
    -

    Warning

    -

    Unlike the twolevel style, the numa style does not -require any particular ordering of MPI ranks i norder to work -correctly. This is because it auto-detects which processes are -running on which nodes.

    +
    +

    Note

    +

    Unlike the twolevel style, the numa style does not require +any particular ordering of MPI ranks i norder to work correctly. This +is because it auto-detects which processes are running on which nodes.

    The custom style uses the file infile to define both the 3d factorization and the mapping of processors to the grid.

    @@ -371,15 +369,15 @@ processor grid. If the receiving partition is running on 80 processors, it could create a 4x2x10 grid, but it will not create a 2x4x10 grid, since in the y-dimension, 6 is not an integer multiple of 4.

    -
    -

    Warning

    -

    If you use the partition command to -invoke different “processsors” commands on different partitions, and -you also use the part keyword, then you must insure that both the -sending and receiving partitions invoke the “processors” command that -connects the 2 partitions via the part keyword. LAMMPS cannot -easily check for this, but your simulation will likely hang in its -setup phase if this error has been made.

    +
    +

    Note

    +

    If you use the partition command to invoke +different “processsors” commands on different partitions, and you also +use the part keyword, then you must insure that both the sending and +receiving partitions invoke the “processors” command that connects the +2 partitions via the part keyword. LAMMPS cannot easily check for +this, but your simulation will likely hang in its setup phase if this +error has been made.


    The file keyword writes the mapping of the factorization of P @@ -445,7 +443,7 @@ cart.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -466,7 +464,7 @@ cart.

    @@ -193,12 +193,12 @@ def loop(lmpptr,N,cut0):

    Description

    -
    -

    Warning

    -

    It is not currently possible to use the -python command described in this section with Python 3, -only with Python 2. The C API changed from Python 2 to 3 and the -LAMMPS code is not compatible with both.

    +
    +

    Note

    +

    It is not currently possible to use the python +command described in this section with Python 3, only with Python 2. +The C API changed from Python 2 to 3 and the LAMMPS code is not +compatible with both.

    Define a Python function or execute a previously defined function. Arguments, including LAMMPS variables, can be passed to the function @@ -465,15 +465,15 @@ substituted (by LAMMPS) in the pair_style command that is executed next. Alternatively, the “LAMMPS command option” line could be used in place of the 2 preceeding lines, to have Python insert the value into the LAMMPS command string.

    -
    -

    Warning

    -

    When using the callback mechanism just described, -recognize that there are some operations you should not attempt -because LAMMPS cannot execute them correctly. If the Python function -is invoked between runs in the LAMMPS input script, then it should be -OK to invoke any LAMMPS input script command via the library interface -command() or file() functions, so long as the command would work if it -were executed in the LAMMPS input script directly at the same point.

    +
    +

    Note

    +

    When using the callback mechanism just described, recognize that +there are some operations you should not attempt because LAMMPS cannot +execute them correctly. If the Python function is invoked between +runs in the LAMMPS input script, then it should be OK to invoke any +LAMMPS input script command via the library interface command() or +file() functions, so long as the command would work if it were +executed in the LAMMPS input script directly at the same point.

    However, a Python function can also be invoked during a run, whenever an associated LAMMPS variable it is assigned to is evaluted. If the @@ -585,7 +585,7 @@ successfully.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -606,7 +606,7 @@ successfully.

    @@ -175,7 +175,7 @@ returned.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -196,7 +196,7 @@ returned.

    @@ -211,18 +211,18 @@ cannot be used; the read_data command is being used for the first time. If a simulation box does exist, due to using the create_box command, or a previous read_data command, then the add keyword must be used.

    -
    -

    Warning

    -

    The simulation box size (xlo to xhi, ylo to yhi, zlo -to zhi) in the new data file will be merged with the existing -simulation box to create a large enough box in each dimension to -contain both the existing and new atoms. Each box dimension never -shrinks due to this merge operation, it only stays the same or -grows. Care must be used if you are growing the existing simulation -box in a periodic dimension. If there are existing atoms with bonds -that straddle that periodic boundary, then the atoms may become far -apart if the box size grows. This will separate the atoms in the -bond, which can lead to “lost” bond atoms or bad dynamics.

    +
    +

    Note

    +

    The simulation box size (xlo to xhi, ylo to yhi, zlo to zhi) in +the new data file will be merged with the existing simulation box to +create a large enough box in each dimension to contain both the +existing and new atoms. Each box dimension never shrinks due to this +merge operation, it only stays the same or grows. Care must be used if +you are growing the existing simulation box in a periodic dimension. +If there are existing atoms with bonds that straddle that periodic +boundary, then the atoms may become far apart if the box size grows. +This will separate the atoms in the bond, which can lead to “lost” +bond atoms or bad dynamics.

    The three choices for the add argument affect how the IDs of atoms in the data file are treated. If append is specified, atoms in the @@ -430,26 +430,25 @@ being used to add atoms to a simulation box that already exists, this periodic remapping will be performed using simulation box bounds that are the union of the existing box and the box boundaries in the new data file.

    -
    -

    Warning

    -

    If the system is non-periodic (in a dimension), then -all atoms in the data file must have coordinates (in that dimension) -that are “greater than or equal to” the lo value and “less than or -equal to” the hi value. If the non-periodic dimension is of style -“fixed” (see the boundary command), then the atom -coords must be strictly “less than” the hi value, due to the way -LAMMPS assign atoms to processors. Note that you should not make the -lo/hi values radically smaller/larger than the extent of the atoms. -For example, if your atoms extend from 0 to 50, you should not specify -the box bounds as -10000 and 10000. This is because LAMMPS uses the -specified box size to layout the 3d grid of processors. A huge -(mostly empty) box will be sub-optimal for performance when using -“fixed” boundary conditions (see the boundary -command). When using “shrink-wrap” boundary conditions (see the -boundary command), a huge (mostly empty) box may cause -a parallel simulation to lose atoms when LAMMPS shrink-wraps the box -around the atoms. The read_data command will generate an error -in this case.

    +
    +

    Note

    +

    If the system is non-periodic (in a dimension), then all atoms +in the data file must have coordinates (in that dimension) that are +“greater than or equal to” the lo value and “less than or equal to” +the hi value. If the non-periodic dimension is of style “fixed” (see +the boundary command), then the atom coords must be +strictly “less than” the hi value, due to the way LAMMPS assign atoms +to processors. Note that you should not make the lo/hi values +radically smaller/larger than the extent of the atoms. For example, +if your atoms extend from 0 to 50, you should not specify the box +bounds as -10000 and 10000. This is because LAMMPS uses the specified +box size to layout the 3d grid of processors. A huge (mostly empty) +box will be sub-optimal for performance when using “fixed” boundary +conditions (see the boundary command). When using +“shrink-wrap” boundary conditions (see the boundary +command), a huge (mostly empty) box may cause a parallel simulation to +lose atoms when LAMMPS shrink-wraps the box around the atoms. The +read_data command will generate an error in this case.

    The “extra bond per atom” setting (angle, dihedral, improper) is only needed if new bonds (angles, dihedrals, impropers) will be added to @@ -464,12 +463,12 @@ defined in the data file. Using this setting will pre-allocate space in the LAMMPS data structures for storing these neighbors. See the special_bonds and molecule doc pages for more discussion of 1-2,1-3,1-4 neighbors.

    -
    -

    Warning

    -

    All of the “extra” settings are only used if they -appear in the first data file read; see the description of the add -keyword above for reading multiple data files. If they appear in -later data files, they are ignored.

    +
    +

    Note

    +

    All of the “extra” settings are only used if they appear in the +first data file read; see the description of the add keyword above +for reading multiple data files. If they appear in later data files, +they are ignored.

    The “ellipsoids” and “lines” and “triangles” and “bodies” settings are only used with atom_style ellipsoid or line or tri or body and specify how many of the atoms are @@ -479,12 +478,12 @@ are point particles. See the discussion of ellipsoidflag and the Lines section below. See the discussion of triangleflag and the Triangles section below. See the discussion of bodyflag and the Bodies section below.

    -
    -

    Warning

    -

    For atom_style template, the -molecular topology (bonds,angles,etc) is contained in the molecule -templates read-in by the molecule command. This means -you cannot set the bonds, angles, etc header keywords in the data +

    +

    Note

    +

    For atom_style template, the molecular +topology (bonds,angles,etc) is contained in the molecule templates +read-in by the molecule command. This means you +cannot set the bonds, angles, etc header keywords in the data file, nor can you define Bonds, Angles, etc sections as discussed below. You can set the bond types, angle types, etc header keywords, though it is not necessary. If specified, they must match @@ -1284,7 +1283,7 @@ fields:

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -1305,7 +1304,7 @@ fields:

    @@ -365,11 +365,11 @@ image flags for read-in atoms are also set to default values. The remapping procedure described in the previous paragraph will then change images flags for all atoms (old and new) if periodic boundary conditions are applied to remap an atom back into the simulation box.

    -
    -

    Warning

    -

    If you get a warning about inconsistent image flags -after reading in a dump snapshot, it means one or more pairs of bonded -atoms now have inconsistent image flags. As discussed in Section errors this may or may not cause problems for +

    +

    Note

    +

    If you get a warning about inconsistent image flags after +reading in a dump snapshot, it means one or more pairs of bonded atoms +now have inconsistent image flags. As discussed in Section errors this may or may not cause problems for subsequent simulations, One way this can happen is if you read image flag fields from the dump file but do not also use the dump file box parameters.

    @@ -422,7 +422,7 @@ no, add = no, scaled = no, wrapped = yes, and format = native.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -443,7 +443,7 @@ no, add = no, scaled = no, wrapped = yes, and format = native.

    @@ -159,8 +159,8 @@ regular 3d grid of rectangular bricks, one per processor, based on the number of processors in the current simulation and the settings of the processors command. The partitioning can later be changed by the balance or fix balance commands.

    -
    -

    Warning

    +
    +

    Note

    Normally, restart files are written by the restart or write_restart commands so that all atoms in the restart file are inside the simulation box. @@ -169,8 +169,9 @@ that atoms were “lost” when the file is read. This error should be reported to the LAMMPS developers so the invalid writing of the restart file can be fixed. If you still wish to use the restart file, the optional remap flag can be appended to the read_restart command. -This should avoid the error, by explicitly remapping each atom back into -the simulation box, updating image flags for the atom appropriately.

    +This should avoid the error, by explicitly remapping each atom back +into the simulation box, updating image flags for the atom +appropriately.

    Restart files are saved in binary format to enable exact restarts, meaning that the trajectories of a restarted run will precisely match @@ -351,7 +352,7 @@ package must be installed.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -372,7 +373,7 @@ package must be installed.

    @@ -244,21 +244,21 @@ parameter cannot be used. For a prism region, a non-zero tilt factor in any pair of dimensions cannot be used if both the lo/hi values in either of those dimensions are INF. E.g. if the xy tilt is non-zero, then xlo and xhi cannot both be INF, nor can ylo and yhi.

    -
    -

    Warning

    -

    Regions in LAMMPS do not get wrapped across periodic -boundaries, as specified by the boundary command. For -example, a spherical region that is defined so that it overlaps a -periodic boundary is not treated as 2 half-spheres, one on either side -of the simulation box.

    +
    +

    Note

    +

    Regions in LAMMPS do not get wrapped across periodic boundaries, +as specified by the boundary command. For example, a +spherical region that is defined so that it overlaps a periodic +boundary is not treated as 2 half-spheres, one on either side of the +simulation box.

    -
    -

    Warning

    -

    Regions in LAMMPS are always 3d geometric objects, -regardless of whether the dimension of a simulation -is 2d or 3d. Thus when using regions in a 2d simulation, you should -be careful to define the region so that its intersection with the 2d -x-y plane of the simulation has the 2d geometric extent you want.

    +
    +

    Note

    +

    Regions in LAMMPS are always 3d geometric objects, regardless of +whether the dimension of a simulation is 2d or 3d. +Thus when using regions in a 2d simulation, you should be careful to +define the region so that its intersection with the 2d x-y plane of +the simulation has the 2d geometric extent you want.

    For style cone, an axis-aligned cone is defined which is like a cylinder except that two different radii (one at each end) can be @@ -308,12 +308,11 @@ triclinic representations.

    The union style creates a region consisting of the volume of all the listed regions combined. The intersect style creates a region consisting of the volume that is common to all the listed regions.

    -
    -

    Warning

    -

    The union and intersect regions operate by -invoking methods from their list of sub-regions. Thus you cannot -delete the sub-regions after defining the union or intersection -region.

    +
    +

    Note

    +

    The union and intersect regions operate by invoking methods +from their list of sub-regions. Thus you cannot delete the +sub-regions after defining the union or intersection region.


    The side keyword determines whether the region is considered to be @@ -451,7 +450,7 @@ rotation.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -472,7 +471,7 @@ rotation.

    @@ -170,18 +170,18 @@ unwrapped appropriately.

    If a simulation is non-periodic in a dimension, care should be used when replicating it in that dimension, as it may put atoms nearly on top of each other.

    -
    -

    Warning

    -

    You cannot use the replicate command on a system which -has a molecule that spans the box and is bonded to itself across a -periodic boundary, so that the molecule is efffectively a loop. A -simple example would be a linear polymer chain that spans the -simulation box and bonds back to itself across the periodic boundary. -More realistic examples would be a CNT (meant to be an infinitely long -CNT) or a graphene sheet or a bulk periodic crystal where there are -explicit bonds specified between near neighbors. (Note that this only -applies to systems that have permanent bonds as specified in the data -file. A CNT that is just atoms modeled with the AIREBO potential has no such permanent bonds, so it can be +

    +

    Note

    +

    You cannot use the replicate command on a system which has a +molecule that spans the box and is bonded to itself across a periodic +boundary, so that the molecule is efffectively a loop. A simple +example would be a linear polymer chain that spans the simulation box +and bonds back to itself across the periodic boundary. More realistic +examples would be a CNT (meant to be an infinitely long CNT) or a +graphene sheet or a bulk periodic crystal where there are explicit +bonds specified between near neighbors. (Note that this only applies +to systems that have permanent bonds as specified in the data file. A +CNT that is just atoms modeled with the AIREBO potential has no such permanent bonds, so it can be replicated.) The reason replication does not work with those systems is that the image flag settings described above cannot be made consistent. I.e. it is not possible to define images flags so that @@ -222,7 +222,7 @@ this scenario.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -243,7 +243,7 @@ this scenario.

    @@ -312,7 +312,7 @@ infinity), start = same as first, stop = same as last, every = 0, skip

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -333,7 +333,7 @@ infinity), start = same as first, stop = same as last, every = 0, skip @@ -192,7 +192,7 @@ more details.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -213,7 +213,7 @@ more details.

    @@ -238,18 +238,17 @@ command to restart a simulation from a particular state. Because the file is binary (to enable exact restarts), it may not be readable on another machine. In this case, you can use the -r command-line switch to convert a restart file to a data file.

    -
    -

    Warning

    -

    Although the purpose of restart files is to enable -restarting a simulation from where it left off, not all information -about a simulation is stored in the file. For example, the list of -fixes that were specified during the initial run is not stored, which -means the new input script must specify any fixes you want to use. -Even when restart information is stored in the file, as it is for some -fixes, commands may need to be re-specified in the new input script, -in order to re-use that information. See the -read_restart command for information about what is -stored in a restart file.

    +
    +

    Note

    +

    Although the purpose of restart files is to enable restarting a +simulation from where it left off, not all information about a +simulation is stored in the file. For example, the list of fixes that +were specified during the initial run is not stored, which means the +new input script must specify any fixes you want to use. Even when +restart information is stored in the file, as it is for some fixes, +commands may need to be re-specified in the new input script, in order +to re-use that information. See the read_restart +command for information about what is stored in a restart file.


    The optional nfile or fileper keywords can be used in conjunction @@ -296,7 +295,7 @@ package must be installed.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -317,7 +316,7 @@ package must be installed.

    @@ -211,16 +211,16 @@ the initial setup is skipped, except for printing thermodynamic info. Note that if pre is set to “no” for the very 1st run LAMMPS performs, then it is overridden, since the initial setup computations must be done.

    -
    -

    Warning

    -

    If your input script changes the system between 2 -runs, then the initial setup must be performed to insure the change is -recognized by all parts of the code that are affected. Examples are -adding a fix or dump or compute, -changing a neighbor list parameter, or writing -restart file which can migrate atoms between processors. LAMMPS has -no easy way to check if this has happened, but it is an error to use -the pre no option in this case.

    +
    +

    Note

    +

    If your input script changes the system between 2 runs, then the +initial setup must be performed to insure the change is recognized by +all parts of the code that are affected. Examples are adding a +fix or dump or compute, changing +a neighbor list parameter, or writing restart file +which can migrate atoms between processors. LAMMPS has no easy way to +check if this has happened, but it is an error to use the pre no +option in this case.

    If post is specified as “no”, the full timing summary is skipped; only a one-line summary timing is printed.

    @@ -280,10 +280,10 @@ command:

    every keyword, then the 1st 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.

    -
    -

    Warning

    -

    You might hope to specify a command that exits the run -by jumping out of the loop, e.g.

    +
    +

    Note

    +

    You might hope to specify a command that exits the run by +jumping out of the loop, e.g.

    variable t equal temp
     run 10000 every 100 "if '$t < 300.0' then 'jump SELF afterrun'"
    @@ -330,7 +330,7 @@ timestep + N, pre = yes, and post = yes.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -351,7 +351,7 @@ timestep + N, pre = yes, and post = yes.

    @@ -400,7 +400,7 @@ conserving energy to adequate precision.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -421,7 +421,7 @@ conserving energy to adequate precision.

    @@ -143,7 +143,7 @@

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -164,7 +164,7 @@ @@ -290,13 +290,12 @@ spatially-dependent set of per-atom values. As explained on the used in place of atom-style variables, and thus as arguments to the set command. Atomfile-style variables read their per-atoms values from a file.

    -
    -

    Warning

    -

    Atom-style and atomfile-style variables return -floating point per-atom values. If the values are assigned to an -integer variable, such as the molecule ID, then the floating point -value is truncated to its integer portion, e.g. a value of 2.6 would -become 2.

    +
    +

    Note

    +

    Atom-style and atomfile-style variables return floating point +per-atom values. If the values are assigned to an integer variable, +such as the molecule ID, then the floating point value is truncated to +its integer portion, e.g. a value of 2.6 would become 2.

    Keyword type sets the atom type for all selected atoms. The specified value must be from 1 to ntypes, where ntypes was set by the @@ -502,7 +501,7 @@ coordinates outside the simulation box if they are ghost atoms.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -523,7 +522,7 @@ coordinates outside the simulation box if they are ghost atoms.

    @@ -231,7 +231,7 @@ executing the cd command will silently do nothing.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -252,7 +252,7 @@ executing the cd command will silently do nothing.

    @@ -176,8 +176,8 @@ the interaction between a pair of bonded atoms is all (or mostly) specified by the bond, angle, dihedral potentials, and thus the non-bonded Lennard-Jones or Coulombic interaction between the pair of atoms should be excluded (or reduced by a weighting factor).

    -
    -

    Warning

    +
    +

    Note

    These weighting factors are NOT used by pair styles that compute many-body interactions, since the “bonds” that result from such interactions are not permanent, but are created and broken dynamically as atom conformations change. Examples @@ -189,15 +189,14 @@ e.g. when using the pa Thus LAMMPS ignores special_bonds settings when manybody potentials are calculated.

    -
    -

    Warning

    -

    Unlike some commands in LAMMPS, you cannot use this -command multiple times in an incremental fashion: e.g. to first set -the LJ settings and then the Coulombic ones. Each time you use this -command it sets all the coefficients to default values and only -overrides the one you specify, so you should set all the options you -need each time you use it. See more details at the bottom of this -page.

    +
    +

    Note

    +

    Unlike some commands in LAMMPS, you cannot use this command +multiple times in an incremental fashion: e.g. to first set the LJ +settings and then the Coulombic ones. Each time you use this command +it sets all the coefficients to default values and only overrides the +one you specify, so you should set all the options you need each time +you use it. See more details at the bottom of this page.

    The Coulomb factors are applied to any Coulomb (charge interaction) term that the potential calculates. The LJ factors are applied to the @@ -216,18 +215,18 @@ 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 that interaction will be at full strength.

    -
    -

    Warning

    -

    For purposes of computing weighted pairwise -interactions, 1-3 and 1-4 interactions are not defined from the list -of angles or dihedrals used by the simulation. Rather, they are -inferred topologically from the set of bonds specified when the -simulation is defined from a data or restart file (see -read_data or read_restart -commands). Thus the set of 1-2,1-3,1-4 interactions that the weights -apply to is the same whether angle and dihedral potentials are -computed or not, and remains the same even if bonds are constrained, -or turned off, or removed during a simulation.

    +
    +

    Note

    +

    For purposes of computing weighted pairwise interactions, 1-3 +and 1-4 interactions are not defined from the list of angles or +dihedrals used by the simulation. Rather, they are inferred +topologically from the set of bonds specified when the simulation is +defined from a data or restart file (see read_data or +read_restart commands). Thus the set of +1-2,1-3,1-4 interactions that the weights apply to is the same whether +angle and dihedral potentials are computed or not, and remains the +same even if bonds are constrained, or turned off, or removed during a +simulation.

    The two exceptions to this rule are (a) if the angle or dihedral keywords are set to yes (see below), or (b) if the @@ -295,26 +294,26 @@ molecules will be added to the system, e.g. via the -

    -

    Warning

    -

    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 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 molecular topology of your system. Using the extra -keyword leaves empty space in the list for this N additional 1st, 2nd, -or 3rd neighbors to be added. If you do not do this, you may get an -error when bonds (or molecules) are added.

    +
    +

    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 +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 +molecular topology of your system. Using the extra keyword leaves +empty space in the list for this N additional 1st, 2nd, or 3rd +neighbors to be added. If you do not do this, you may get an error +when bonds (or molecules) are added.


    -
    -

    Warning

    -

    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 time incrementally, e.g. to add some extra storage -locations via the extra keyword. E.g. these two commands:

    +
    +

    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 +time incrementally, e.g. to add some extra storage locations via the +extra keyword. E.g. these two commands:

    special_bonds lj 0.0 1.0 1.0 special_bonds coul 0.0 0.0 1.0

    @@ -377,7 +376,7 @@ Fischer, Gao, Guo, Ha, et al, J Phys Chem, 102, 3586 (1998).

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with
    Sphinx using a theme provided by Read the Docs. @@ -398,7 +397,7 @@ Fischer, Gao, Guo, Ha, et al, J Phys Chem, 102, 3586 (1998).

    @@ -229,7 +229,7 @@ commands in your input script.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -250,7 +250,7 @@ commands in your input script.

    @@ -408,7 +408,7 @@ Research 32, 321 (2002).

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -429,7 +429,7 @@ Research 32, 321 (2002).

    @@ -256,7 +256,7 @@ for more info on packages.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -277,7 +277,7 @@ for more info on packages.

    @@ -194,7 +194,7 @@ thermo v_s

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -215,7 +215,7 @@ thermo v_s @@ -160,13 +160,13 @@ thermo_modify line multi format float %g

    Description

    Set options for how thermodynamic information is computed and printed by LAMMPS.

    -
    -

    Warning

    -

    These options apply to the currently defined thermo -style. When you specify a thermo_style command, -all thermodynamic settings are restored to their default values, -including those previously reset by a thermo_modify command. Thus if -your input script specifies a thermo_style command, you should use the +

    +

    Note

    +

    These options apply to the currently defined thermo style. When +you specify a thermo_style command, all +thermodynamic settings are restored to their default values, including +those previously reset by a thermo_modify command. Thus if your input +script specifies a thermo_style command, you should use the thermo_modify command after it.

    The lost keyword determines whether LAMMPS checks for lost atoms @@ -226,8 +226,8 @@ numeric value M (e.g. format 5 %10.4g) sets the format of the Mth value printed in each output line, e.g. the 5th column of output in this case. If the format for a specific column has been set, it will take precedent over the int or float setting.

    -
    -

    Warning

    +
    +

    Note

    The thermo output values step and atoms are stored internally as 8-byte signed integers, rather than the usual 4-byte signed integers. When specifying the “format int” keyword you can use @@ -255,18 +255,17 @@ calculates a pressure. As described in the thermo_style command, thermo output uses a default compute for pressure with ID = thermo_press. This option allows the user to override the default.

    -
    -

    Warning

    -

    If both the temp and press keywords are used in a -single thermo_modify command (or in two separate commands), then the -order in which the keywords are specified is important. Note that a -pressure compute defines its own temperature -compute as an argument when it is specified. The temp keyword will -override this (for the pressure compute being used by thermodynamics), -but only if the temp keyword comes after the press keyword. If -the temp keyword comes before the press keyword, then the new -pressure compute specified by the press keyword will be unaffected -by the temp setting.

    +
    +

    Note

    +

    If both the temp and press keywords are used in a single +thermo_modify command (or in two separate commands), then the order in +which the keywords are specified is important. Note that a pressure compute defines its own temperature compute as +an argument when it is specified. The temp keyword will override +this (for the pressure compute being used by thermodynamics), but only +if the temp keyword comes after the press keyword. If the temp +keyword comes before the press keyword, then the new pressure +compute specified by the press keyword will be unaffected by the +temp setting.

    @@ -300,7 +299,7 @@ format defaults are “multi”, “%8d”, and “%14.4f

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -321,7 +320,7 @@ format defaults are “multi”, “%8d”, and “%14.4f @@ -244,13 +244,13 @@ be used to set the one- or multi-line format of the print-out, the normalization of thermodynamic output (total values versus per-atom values for extensive quantities (ones which scale with the number of atoms in the system), and the numeric precision of each printed value.

    -
    -

    Warning

    -

    When you use a “thermo_style” command, all -thermodynamic settings are restored to their default values, including -those previously set by a thermo_modify command. -Thus if your input script specifies a thermo_style command, you should -use the thermo_modify command after it.

    +
    +

    Note

    +

    When you use a “thermo_style” command, all thermodynamic +settings are restored to their default values, including those +previously set by a thermo_modify command. Thus +if your input script specifies a thermo_style command, you should use +the thermo_modify command after it.


    Several of the thermodynamic quantities require a temperature to be @@ -463,7 +463,7 @@ variable formula if this is not the case.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -484,7 +484,7 @@ variable formula if this is not the case.

    @@ -173,10 +173,10 @@ slow down the simulation. Using the nosync setting (which is the default) turns off this synchronization.

    Multiple keywords can be specified. For keywords that are mutually exclusive, the last one specified takes effect.

    -
    -

    Warning

    -

    Using the full and sync options provides the most -detailed and accurate timing information, but can also have a negative +

    +

    Note

    +

    Using the full and sync options provides the most detailed +and accurate timing information, but can also have a negative performance impact due to the overhead of the many required system calls. It is thus recommended to use these settings only when testing tests to identify performance bottlenecks. For calculations with few @@ -210,7 +210,7 @@ can just use the loop or off setting.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -231,7 +231,7 @@ can just use the loop or off setting.

    @@ -222,7 +222,7 @@ the outer loop (largest) timestep.

    - © Copyright . + © Copyright 2013 Sandia Corporation.

    Built with Sphinx using a theme provided by Read the Docs. @@ -243,7 +243,7 @@ the outer loop (largest) timestep.

    @@ -133,15 +133,15 @@ particle (DP) bound by a harmonic potential. The Drude particle can be thought of as the electron cloud whose center can be displaced from the position of the the corresponding nucleus.

    The sum of the masses of a core-Drude pair should be the mass of the -initial (unsplit) atom, (m_C + m_D = m). The sum of their charges -should be the charge of the initial (unsplit) atom, (q_C + q_D = q). +initial (unsplit) atom, \(m_C + m_D = m\). The sum of their charges +should be the charge of the initial (unsplit) atom, \(q_C + q_D = q\). A harmonic potential between the core and Drude partners should be -present, with force constant (k_D) and an equilibrium distance of +present, with force constant \(k_D\) and an equilibrium distance of zero. The (half-)stiffness of the harmonic bond -(K_D = k_D/2) and the Drude charge (q_D) are related to the atom -polarizability (alpha) by

    -

    begin{equation} K_D = frac 1 2, frac {q_D^2} alpha -end{equation}

    +\(K_D = k_D/2\) and the Drude charge \(q_D\) are related to the atom +polarizability \(\alpha\) by

    +
    +\[\begin{equation} K_D = \frac 1 2\, \frac {q_D^2} \alpha\end{equation}\]

    Ideally, the mass of the Drude particle should be small, and the stiffness of the harmonic bond should be large, so that the Drude particle remains close ot the core. The values of Drude mass, Drude @@ -150,15 +150,15 @@ strategies, as in the following examples of polarizable force fields.

    • Lamoureux and Roux suggest adopting a global -half-stiffness, (K_D) = 500 kcal/(mol &Aring;<sup>2</sup>) &mdash; -which corresponds to a force constant (k_D) = 4184 kJ/(mol +half-stiffness, \(K_D\) = 500 kcal/(mol &Aring;<sup>2</sup>) &mdash; +which corresponds to a force constant \(k_D\) = 4184 kJ/(mol &Aring;<sup>2</sup>) &mdash; for all types of core-Drude bond, a -global mass (m_D) = 0.4 g/mol (or u) for all types of Drude +global mass \(m_D\) = 0.4 g/mol (or u) for all types of Drude particle, and to calculate the Drude charges for individual atom types from the atom polarizabilities using equation (1). This choice is followed in the polarizable CHARMM force field.
    • Schroeder and Steinhauser suggest adopting a global -charge (q_D) = -1.0e and a global mass (m_D) = 0.1 g/mol (or u) +charge \(q_D\) = -1.0e and a global mass \(m_D\) = 0.1 g/mol (or u) for all Drude particles, and to calculate the force constant for each type of core-Drude bond from equation (1). The timesteps used by these authors are between 0.5 and 2 fs, with the degrees of freedom of the @@ -311,10 +311,10 @@ invoked after the fix langevin/drude for more accuracy.

      fix SHAKE ATOMS shake 0.0001 20 0 t 4 5
       
      -
      -

      Warning

      -

      The group of the fix shake must not include the DPs. -If the group ATOMS is defined by non-DPs atom types, you could use

      +
      +

      Note

      +

      The group of the fix shake must not include the DPs. If the +group ATOMS is defined by non-DPs atom types, you could use

      Since the fix langevin/drude does not perform time integration (just modification of forces but no position/velocity updates), the fix @@ -540,7 +540,7 @@ Let, 418, 245-249 (2006)

      - © Copyright . + © Copyright 2013 Sandia Corporation.

      Built with Sphinx using a theme provided by Read the Docs. @@ -561,7 +561,7 @@ Let, 418, 245-249 (2006)

      @@ -170,7 +170,7 @@ via the compute_mod

      - © Copyright . + © Copyright 2013 Sandia Corporation.

      Built with
      Sphinx using a theme provided by Read the Docs. @@ -191,7 +191,7 @@ via the compute_mod @@ -169,7 +169,7 @@ This closes the file associated with the dump.

      - © Copyright . + © Copyright 2013 Sandia Corporation.

      Built with
      Sphinx using a theme provided by Read the Docs. @@ -190,7 +190,7 @@ This closes the file associated with the dump.

      @@ -170,7 +170,7 @@ via the fix_modify

      - © Copyright . + © Copyright 2013 Sandia Corporation.

      Built with
      Sphinx using a theme provided by Read the Docs. @@ -191,7 +191,7 @@ via the fix_modify @@ -348,7 +348,7 @@ distance to default values for each style:

      - © Copyright . + © Copyright 2013 Sandia Corporation.

      Built with
      Sphinx using a theme provided by Read the Docs. @@ -369,7 +369,7 @@ distance to default values for each style:

      @@ -237,15 +237,15 @@ input script that atom-style variables are used; they get their per-atom values from a file rather than from a formula. Variables can be hooked to Python functions using code you provide, so that the variable gets its value from the evaluation of the Python code.

      -
      -

      Warning

      -

      As discussed in Section 3.2 -of the manual, an input script can use “immediate” variables, specified -as $(formula) with parenthesis, where the formula has the same syntax -as equal-style variables described on this page. This is a convenient -way to evaluate a formula immediately without using the variable command -to define a named variable and then evaluate that variable. See below -for a more detailed discussion of this feature.

      +
      +

      Note

      +

      As discussed in Section 3.2 of the +manual, an input script can use “immediate” variables, specified as +$(formula) with parenthesis, where the formula has the same syntax as +equal-style variables described on this page. This is a convenient +way to evaluate a formula immediately without using the variable +command to define a named variable and then evaluate that +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. @@ -257,41 +257,41 @@ 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 simulation.

      -
      -

      Warning

      -

      When the input script line is encountered that defines -a variable of style equal or atom or python that contains a -formula or Python code, the formula is NOT immediately evaluated. -It will be evaluated every time when the variable is used instead. -If you simply want to evaluate a formula in place you can use as -so-called. See the section below about “Immediate Evaluation -of Variables” for more details on the topic. This is also true of -a format style variable since it evaluates another variable when -it is invoked.

      +
      +

      Note

      +

      When the input script line is encountered that defines a +variable of style equal or atom or python that contains a +formula or Python code, the formula is NOT immediately evaluated. It +will be evaluated every time when the variable is used instead. If +you simply want to evaluate a formula in place you can use as +so-called. See the section below about “Immediate Evaluation of +Variables” for more details on the topic. This is also true of a +format style variable since it evaluates another variable when it is +invoked.

      -
      -

      Warning

      -

      Variables of style equal and atom can be used as -inputs to various other LAMMPS commands which evaluate their formulas -as needed, e.g. at different timesteps during a run. -Variables of style python can be used in place of an equal-style -variable so long as the associated Python function, as defined by the +

      +

      Note

      +

      Variables of style equal and atom can be used as inputs to +various other LAMMPS commands which evaluate their formulas as needed, +e.g. at different timesteps during a run. Variables of +style python can be used in place of an equal-style variable so long +as the associated Python function, as defined by the python command, returns a numeric value. Thus any command that states it can use an equal-style variable as an argument, can also use such a python-style variable. This means that when the LAMMPS command evaluates the variable, the Python function will be executed.

      -
      -

      Warning

      -

      When a variable command is encountered in the input -script and the variable name has already been specified, the command -is ignored. This means variables can NOT be re-defined in an input -script (with two exceptions, read further). This is to allow an input -script to be processed multiple times without resetting the variables; -see the jump or include commands. It also -means that using the command-line switch --var will override a corresponding index variable setting in the input +

      +

      Note

      +

      When a variable command is encountered in the input script and +the variable name has already been specified, the command is ignored. +This means variables can NOT be re-defined in an input script (with +two exceptions, read further). This is to allow an input script to be +processed multiple times without resetting the variables; see the +jump or include commands. It also means +that using the command-line switch -var +will override a corresponding index variable setting in the input script.

      There are two exceptions to this rule. First, variables of style @@ -451,11 +451,11 @@ lines have the following format

      where ID is an atom ID and value is the per-atom numeric value that will be assigned to that atom. IDs can be listed in any order.

      -
      -

      Warning

      -

      Every time a set of per-atom lines is read, the value -for all atoms is first set to 0.0. Thus values for atoms whose ID -does not appear in the set, will remain 0.0.

      +
      +

      Note

      +

      Every time a set of per-atom lines is read, the value for all +atoms is first set to 0.0. Thus values for atoms whose ID does not +appear in the set, will remain 0.0.

      For the python style a Python function name is provided. This needs to match a function name specified in a python command @@ -571,13 +571,13 @@ are next; then the logical AND operator “&&”; and finally th OR operator “||” has the lowest precedence. Parenthesis can be used to group one or more portions of a formula and/or enforce a different order of evaluation than what would occur with the default precedence.

      -
      -

      Warning

      -

      Because a unary minus is higher precedence than -exponentiation, the formula “-2^2” will evaluate to 4, not -4. This -convention is compatible with some programming languages, but not -others. As mentioned, this behavior can be easily overridden with -parenthesis; the formula “-(2^2)” will evaluate to -4.

      +
      +

      Note

      +

      Because a unary minus is higher precedence than exponentiation, +the formula “-2^2” will evaluate to 4, not -4. This convention is +compatible with some programming languages, but not others. As +mentioned, this behavior can be easily overridden with parenthesis; +the formula “-(2^2)” will evaluate to -4.

      The 6 relational operators return either a 1.0 or 0.0 depending on whether the relationship between x and y is TRUE or FALSE. For @@ -618,15 +618,14 @@ each generate the same sequence of random numbers. For atom-style variables, a unique seed is created for each processor, based on the specified seed. This effectively generates a different random number for each atom being looped over in the atom-style variable.

      -
      -

      Warning

      -

      Internally, there is just one random number generator -for all equal-style variables and one for all atom-style variables. -If you define multiple variables (of each style) which use the -random() or normal() math functions, then the internal random number -generators will only be initialized once, which means only one of the -specified seeds will determine the sequence of generated random -numbers.

      +
      +

      Note

      +

      Internally, there is just one random number generator for all +equal-style variables and one for all atom-style variables. If you +define multiple variables (of each style) which use the random() or +normal() math functions, then the internal random number generators +will only be initialized once, which means only one of the specified +seeds will determine the sequence of generated random numbers.

      The ceil(), floor(), and round() functions are those in the C math library. Ceil() is the smallest integer not less than its argument. @@ -1246,7 +1245,7 @@ must have the same number of values.

      - © Copyright . + © Copyright 2013 Sandia Corporation.

      Built with Sphinx using a theme provided by Read the Docs. @@ -1267,7 +1266,7 @@ must have the same number of values.

      @@ -364,7 +364,7 @@ keywords are not defined by default.

      - © Copyright . + © Copyright 2013 Sandia Corporation.

      Built with Sphinx using a theme provided by Read the Docs. @@ -385,7 +385,7 @@ keywords are not defined by default.

      @@ -159,17 +159,16 @@ also describes their format.

      Similar to dump files, the data filename can contain a “*” wild-card character. The “*” is replaced with the current timestep value.

      -
      -

      Warning

      -

      The write-data command is not yet fully implemented in -two respects. First, most pair styles do not yet write their -coefficient information into the data file. This means you will need -to specify that information in your input script that reads the data -file, via the pair_coeff command. Second, a few of -the atom styles (body, ellipsoid, line, tri) that -store auxiliary “bonus” information about aspherical particles, do not -yet write the bonus info into the data file. Both these -functionalities will be added to the write_data command later.

      +
      +

      Note

      +

      The write-data command is not yet fully implemented in two +respects. First, most pair styles do not yet write their coefficient +information into the data file. This means you will need to specify +that information in your input script that reads the data file, via +the pair_coeff command. Second, a few of the atom styles (body, ellipsoid, line, tri) that store +auxiliary “bonus” information about aspherical particles, do not yet +write the bonus info into the data file. Both these functionalities +will be added to the write_data command later.

      Because a data file is in text format, if you use a data file written out by this command to restart a simulation, the initial state of the @@ -183,11 +182,12 @@ original input script.

      read_restart commands. You can also convert binary restart files to text data files, after a simulation has run, using the -r command-line switch.

      -
      -

      Warning

      -

      Only limited information about a simulation is stored -in a data file. For example, no information about atom -groups and fixes are stored. Binary restart files store more information.

      +
      +

      Note

      +

      Only limited information about a simulation is stored in a data +file. For example, no information about atom groups and +fixes are stored. Binary restart files +store more information.

      Bond interactions (angle, etc) that have been turned off by the fix shake or delete_bonds command will be written to a data file as if they are turned on. This means they @@ -249,7 +249,7 @@ setup, atom masses initialized, etc).

      - © Copyright . + © Copyright 2013 Sandia Corporation.

      Built with Sphinx using a theme provided by Read the Docs. @@ -270,7 +270,7 @@ setup, atom masses initialized, etc).

      @@ -218,7 +218,7 @@ commands.

      - © Copyright . + © Copyright 2013 Sandia Corporation.

      Built with Sphinx using a theme provided by Read the Docs. @@ -239,7 +239,7 @@ commands.

      @@ -187,19 +187,19 @@ command to restart a simulation from a particular state. Because the file is binary (to enable exact restarts), it may not be readable on another machine. In this case, you can use the -r command-line switch to convert a restart file to a data file.

      -
      -

      Warning

      -

      Although the purpose of restart files is to enable -restarting a simulation from where it left off, not all information -about a simulation is stored in the file. For example, the list of -fixes that were specified during the initial run is not stored, which -means the new input script must specify any fixes you want to use. -Even when restart information is stored in the file, as it is for some -fixes, commands may need to be re-specified in the new input script, -in order to re-use that information. Details are usually given in -the documentation of the respective command. Also, see the -read_restart command for general information -about what is stored in a restart file.

      +
      +

      Note

      +

      Although the purpose of restart files is to enable restarting a +simulation from where it left off, not all information about a +simulation is stored in the file. For example, the list of fixes that +were specified during the initial run is not stored, which means the +new input script must specify any fixes you want to use. Even when +restart information is stored in the file, as it is for some fixes, +commands may need to be re-specified in the new input script, in order +to re-use that information. Details are usually given in the +documentation of the respective command. Also, see the +read_restart command for general information about +what is stored in a restart file.


      The optional nfile or fileper keywords can be used in conjunction @@ -246,7 +246,7 @@ package must be installed.

      - © Copyright . + © Copyright 2013 Sandia Corporation.

      Built with Sphinx using a theme provided by Read the Docs. @@ -267,7 +267,7 @@ package must be installed.