diff --git a/doc/html/Section_commands.html b/doc/html/Section_commands.html index 3b01d0ede2..ec03d7a33c 100644 --- a/doc/html/Section_commands.html +++ b/doc/html/Section_commands.html @@ -923,35 +923,35 @@ KOKKOS, o = USER-OMP, t = OPT.

rdf reduce reduce/region -slice +rigid/local -sna/atom +slice +sna/atom snad/atom snav/atom stress/atom temp (k) -temp/asphere -temp/body +temp/asphere +temp/body temp/chunk temp/com temp/deform temp/partial -temp/profile -temp/ramp +temp/profile +temp/ramp temp/region temp/sphere ti torque/chunk -vacf -vcm/chunk +vacf +vcm/chunk voronoi/atom       -  diff --git a/doc/html/_sources/Section_commands.txt b/doc/html/_sources/Section_commands.txt index 958b72d815..699fbdc0f1 100644 --- a/doc/html/_sources/Section_commands.txt +++ b/doc/html/_sources/Section_commands.txt @@ -543,15 +543,15 @@ KOKKOS, o = USER-OMP, t = OPT. +------------------------------------------------+------------------------------------------------+--------------------------------------------------+--------------------------------------------------+----------------------------------------------------+----------------------------------------------------------+ | :doc:`pair/local ` | :doc:`pe ` | :doc:`pe/atom ` | :doc:`plasticity/atom ` | :doc:`pressure ` | :doc:`property/atom ` | +------------------------------------------------+------------------------------------------------+--------------------------------------------------+--------------------------------------------------+----------------------------------------------------+----------------------------------------------------------+ -| :doc:`property/local ` | :doc:`property/chunk ` | :doc:`rdf ` | :doc:`reduce ` | :doc:`reduce/region ` | :doc:`slice ` | +| :doc:`property/local ` | :doc:`property/chunk ` | :doc:`rdf ` | :doc:`reduce ` | :doc:`reduce/region ` | :doc:`rigid/local ` | +------------------------------------------------+------------------------------------------------+--------------------------------------------------+--------------------------------------------------+----------------------------------------------------+----------------------------------------------------------+ -| :doc:`sna/atom ` | :doc:`snad/atom ` | :doc:`snav/atom ` | :doc:`stress/atom ` | :doc:`temp (k) ` | :doc:`temp/asphere ` | +| :doc:`slice ` | :doc:`sna/atom ` | :doc:`snad/atom ` | :doc:`snav/atom ` | :doc:`stress/atom ` | :doc:`temp (k) ` | +------------------------------------------------+------------------------------------------------+--------------------------------------------------+--------------------------------------------------+----------------------------------------------------+----------------------------------------------------------+ -| :doc:`temp/body ` | :doc:`temp/chunk ` | :doc:`temp/com ` | :doc:`temp/deform ` | :doc:`temp/partial ` | :doc:`temp/profile ` | +| :doc:`temp/asphere ` | :doc:`temp/body ` | :doc:`temp/chunk ` | :doc:`temp/com ` | :doc:`temp/deform ` | :doc:`temp/partial ` | +------------------------------------------------+------------------------------------------------+--------------------------------------------------+--------------------------------------------------+----------------------------------------------------+----------------------------------------------------------+ -| :doc:`temp/ramp ` | :doc:`temp/region ` | :doc:`temp/sphere ` | :doc:`ti ` | :doc:`torque/chunk ` | :doc:`vacf ` | +| :doc:`temp/profile ` | :doc:`temp/ramp ` | :doc:`temp/region ` | :doc:`temp/sphere ` | :doc:`ti ` | :doc:`torque/chunk ` | +------------------------------------------------+------------------------------------------------+--------------------------------------------------+--------------------------------------------------+----------------------------------------------------+----------------------------------------------------------+ -| :doc:`vcm/chunk ` | :doc:`voronoi/atom ` | | | | | +| :doc:`vacf ` | :doc:`vcm/chunk ` | :doc:`voronoi/atom ` | | | | +------------------------------------------------+------------------------------------------------+--------------------------------------------------+--------------------------------------------------+----------------------------------------------------+----------------------------------------------------------+ These are additional compute styles in USER packages, which can be diff --git a/doc/html/_sources/accelerate_gpu.txt b/doc/html/_sources/accelerate_gpu.txt index 924768ce5f..166262c7c9 100644 --- a/doc/html/_sources/accelerate_gpu.txt +++ b/doc/html/_sources/accelerate_gpu.txt @@ -29,10 +29,10 @@ long-range Coulombics. It has the following general features: NVIDIA support as well as more general OpenCL support, so that the same functionality can eventually be supported on a variety of GPU hardware. -Here is a quick overview of how to use the GPU package: +Here is a quick overview of how to enable and use the GPU package: -* build the library in lib/gpu for your GPU hardware wity desired precision -* include the GPU package and build LAMMPS +* build the library in lib/gpu for your GPU hardware with the desired precision settings +* install the GPU package and build LAMMPS as usual * use the mpirun command to set the number of MPI tasks/node which determines the number of MPI tasks/GPU * specify the # of GPUs per node * use GPU styles in your input script diff --git a/doc/html/_sources/compute.txt b/doc/html/_sources/compute.txt index 89eb05f16a..bac3fbfb12 100644 --- a/doc/html/_sources/compute.txt +++ b/doc/html/_sources/compute.txt @@ -222,6 +222,7 @@ section of :ref:`this page `. * :doc:`rdf ` - radial distribution function g(r) histogram of group of atoms * :doc:`reduce ` - combine per-atom quantities into a single global value * :doc:`reduce/region ` - same as compute reduce, within a region +* :doc:`rigid/local ` - extract rigid body attributes * :doc:`slice ` - extract values from global vector or array * :doc:`sna/atom ` - calculate bispectrum coefficients for each atom * :doc:`snad/atom ` - derivative of bispectrum coefficients for each atom diff --git a/doc/html/_sources/compute_rigid_local.txt b/doc/html/_sources/compute_rigid_local.txt index a420ae9edd..9c1ba55d49 100644 --- a/doc/html/_sources/compute_rigid_local.txt +++ b/doc/html/_sources/compute_rigid_local.txt @@ -159,7 +159,10 @@ corresponding attribute is in: Restrictions """""""""""" - none + + +This compute is part of the RIGID package. It is only enabled if +LAMMPS was built with that package. See the :ref:`Making LAMMPS ` section for more info. Related commands """""""""""""""" diff --git a/doc/html/_sources/fix_addforce.txt b/doc/html/_sources/fix_addforce.txt index dbcb435676..298490e993 100644 --- a/doc/html/_sources/fix_addforce.txt +++ b/doc/html/_sources/fix_addforce.txt @@ -149,6 +149,10 @@ forces added by this fix in a consistent manner. I.e. there is a decrease in potential energy when atoms move in the direction of the added force. +The :doc:`fix_modify ` *respa* option is supported by +this fix. This allows to set at which level of the :doc:`r-RESPA ` +integrator the fix is adding its forces. Default is the outermost level. + This fix computes a global scalar and a global 3-vector of forces, which can be accessed by various :ref:`output commands `. The scalar is the potential energy discussed above. The vector is the total force on the group of diff --git a/doc/html/_sources/fix_addtorque.txt b/doc/html/_sources/fix_addtorque.txt index 706afcaca4..4c7215f00f 100644 --- a/doc/html/_sources/fix_addtorque.txt +++ b/doc/html/_sources/fix_addtorque.txt @@ -65,6 +65,10 @@ forces added by this fix in a consistent manner. I.e. there is a decrease in potential energy when atoms move in the direction of the added forces. +The :doc:`fix_modify ` *respa* option is supported by +this fix. This allows to set at which level of the :doc:`r-RESPA ` +integrator the fix is adding its torque. Default is the outermost level. + This fix computes a global scalar and a global 3-vector, which can be accessed by various :ref:`output commands `. The scalar is the potential energy discussed above. The vector is the diff --git a/doc/html/_sources/fix_aveforce.txt b/doc/html/_sources/fix_aveforce.txt index e9c95870bb..8add47766d 100644 --- a/doc/html/_sources/fix_aveforce.txt +++ b/doc/html/_sources/fix_aveforce.txt @@ -97,8 +97,11 @@ more instructions on how to use the accelerated styles effectively. Restart, fix_modify, output, run start/stop, minimize info """""""""""""""""""""""""""""""""""""""""""""""""""""""""" -No information about this fix is written to :doc:`binary restart files `. None of the :doc:`fix_modify ` options -are relevant to this fix. +No information about this fix is written to :doc:`binary restart files `. + +The :doc:`fix_modify ` *respa* option is supported by this +fix. This allows to set at which level of the :doc:`r-RESPA ` +integrator the fix is adding its forces. Default is the outermost level. This fix computes a global 3-vector of forces, which can be accessed by various :ref:`output commands `. This is the diff --git a/doc/html/_sources/fix_drag.txt b/doc/html/_sources/fix_drag.txt index 1344615d6e..400abf7fcc 100644 --- a/doc/html/_sources/fix_drag.txt +++ b/doc/html/_sources/fix_drag.txt @@ -41,8 +41,11 @@ in the simulation. Restart, fix_modify, output, run start/stop, minimize info """""""""""""""""""""""""""""""""""""""""""""""""""""""""" -No information about this fix is written to :doc:`binary restart files `. None of the :doc:`fix_modify ` options -are relevant to this fix. +No information about this fix is written to :doc:`binary restart files `. + +The :doc:`fix_modify ` *respa* option is supported by this +fix. This allows to set at which level of the :doc:`r-RESPA ` +integrator the fix is adding its forces. Default is the outermost level. This fix computes a global 3-vector of forces, which can be accessed by various :ref:`output commands `. This is the diff --git a/doc/html/_sources/fix_efield.txt b/doc/html/_sources/fix_efield.txt index b3972b3e08..d0bce7043d 100644 --- a/doc/html/_sources/fix_efield.txt +++ b/doc/html/_sources/fix_efield.txt @@ -133,6 +133,10 @@ can include the forces added by this fix in a consistent manner. I.e. there is a decrease in potential energy when atoms move in the direction of the added force due to the electric field. +The :doc:`fix_modify ` *respa* option is supported by this +fix. This allows to set at which level of the :doc:`r-RESPA ` +integrator the fix adding its forces. Default is the outermost level. + This fix computes a global scalar and a global 3-vector of forces, which can be accessed by various :ref:`output commands `. The scalar is the potential energy discussed above. The vector is the total force added to the diff --git a/doc/html/_sources/fix_gravity.txt b/doc/html/_sources/fix_gravity.txt index 6082177e16..f476aa7efe 100644 --- a/doc/html/_sources/fix_gravity.txt +++ b/doc/html/_sources/fix_gravity.txt @@ -128,6 +128,10 @@ The :doc:`fix_modify ` *energy* option is supported by this fix to add the gravitational potential energy of the system to the system's potential energy as part of :doc:`thermodynamic output `. +The :doc:`fix_modify ` *respa* option is supported by this +fix. This allows to set at which level of the :doc:`r-RESPA ` +integrator the fix is adding its forces. Default is the outermost level. + This fix computes a global scalar which can be accessed by various :ref:`output commands `. This scalar is the gravitational potential energy of the particles in the defined field, diff --git a/doc/html/_sources/fix_indent.txt b/doc/html/_sources/fix_indent.txt index 46aed0226f..8c2618865f 100644 --- a/doc/html/_sources/fix_indent.txt +++ b/doc/html/_sources/fix_indent.txt @@ -187,6 +187,10 @@ fix to add the energy of interaction between atoms and the indenter to the system's potential energy as part of :doc:`thermodynamic output `. The energy of each particle interacting with the indenter is K/3 (r - R)^3. +The :doc:`fix_modify ` *respa* option is supported by this +fix. This allows to set at which level of the :doc:`r-RESPA ` +integrator the fix is adding its forces. Default is the outermost level. + This fix computes a global scalar energy and a global 3-vector of forces (on the indenter), which can be accessed by various :ref:`output commands `. The scalar and vector values calculated by this fix are "extensive". diff --git a/doc/html/_sources/fix_modify.txt b/doc/html/_sources/fix_modify.txt index 1842785de4..bc8a640e36 100644 --- a/doc/html/_sources/fix_modify.txt +++ b/doc/html/_sources/fix_modify.txt @@ -12,12 +12,13 @@ Syntax * fix-ID = ID of the fix to modify * one or more keyword/value pairs may be appended -* keyword = *temp* or *press* or *energy* +* keyword = *temp* or *press* or *energy* or *respa* .. parsed-literal:: *temp* value = compute ID that calculates a temperature *press* value = compute ID that calculates a pressure *energy* value = *yes* or *no* + *respa* value = *1* to *max respa level* or *0* (= outmost level) @@ -28,6 +29,7 @@ Examples fix_modify 3 temp myTemp press myPress fix_modify 1 energy yes + fix_modify tether respa 2 Description """"""""""" @@ -63,6 +65,17 @@ fix-ID of the appropriate fix. Note that you must use this setting for a fix if you are using it when performing an :doc:`energy minimization ` and if you want the energy and forces it produces to be part of the optimization criteria. +For fixes that set or modify forces, it may be possible to select at +which :doc:`r-RESPA ` level the fix operates via the *respa* +keyword. The RESPA level at which the fix is active can be selected. +This is a number ranging from 1 to the number of levels. If the RESPA +level is larger than the current maximum, the outermost level will be +used, which is also the default setting. This default can be restored +using a value of *0* for the RESPA level. The affected fix has to be +programmed to support this feature; if not, *fix_modify* will report +an error. Active fixes with a custom RESPA level setting are reported +with their specified level at the beginning of a r-RESPA run. + Restrictions """""""""""" none @@ -76,7 +89,7 @@ Default """"""" The option defaults are temp = ID defined by fix, press = ID defined -by fix, energy = no. +by fix, energy = no, respa = 0. .. _lws: http://lammps.sandia.gov diff --git a/doc/html/_sources/fix_orient.txt b/doc/html/_sources/fix_orient.txt index c7418d470f..461cea9385 100644 --- a/doc/html/_sources/fix_orient.txt +++ b/doc/html/_sources/fix_orient.txt @@ -134,6 +134,10 @@ fix to add the potential energy of atom interactions with the grain boundary driving force to the system's potential energy as part of :doc:`thermodynamic output `. +The :doc:`fix_modify ` *respa* option is supported by these +fixes. This allows to set at which level of the :doc:`r-RESPA ` +integrator a fix is adding its forces. Default is the outermost level. + This fix calculates a global scalar which can be accessed by various :ref:`output commands `. The scalar is the potential energy change due to this fix. The scalar value calculated diff --git a/doc/html/_sources/fix_qeq_comb.txt b/doc/html/_sources/fix_qeq_comb.txt index 05daac9be6..1658bdd80b 100644 --- a/doc/html/_sources/fix_qeq_comb.txt +++ b/doc/html/_sources/fix_qeq_comb.txt @@ -94,8 +94,12 @@ more instructions on how to use the accelerated styles effectively. Restart, fix_modify, output, run start/stop, minimize info """""""""""""""""""""""""""""""""""""""""""""""""""""""""" -No information about this fix is written to :doc:`binary restart files `. None of the :doc:`fix_modify ` options -are relevant to this fix. +No information about this fix is written to :doc:`binary restart files `. + +The :doc:`fix_modify ` *respa* option is supported by this +fix. This allows to set at which level of the :doc:`r-RESPA ` +integrator the fix is performing charge equilibration. Default is +the outermost level. This fix produces a per-atom vector which can be accessed by various :ref:`output commands `. The vector stores the diff --git a/doc/html/_sources/fix_restrain.txt b/doc/html/_sources/fix_restrain.txt index 003cb9786d..a7b2aa99a8 100644 --- a/doc/html/_sources/fix_restrain.txt +++ b/doc/html/_sources/fix_restrain.txt @@ -180,6 +180,10 @@ The :doc:`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 :doc:`thermodynamic output `. +The :doc:`fix_modify ` *respa* option is supported by this +fix. This allows to set at which level of the :doc:`r-RESPA ` +integrator the fix is adding its forces. Default is the outermost level. + .. note:: If you want the fictitious potential energy associated with the diff --git a/doc/html/_sources/fix_setforce.txt b/doc/html/_sources/fix_setforce.txt index 96136aecb4..4042bb5151 100644 --- a/doc/html/_sources/fix_setforce.txt +++ b/doc/html/_sources/fix_setforce.txt @@ -102,8 +102,14 @@ more instructions on how to use the accelerated styles effectively. Restart, fix_modify, output, run start/stop, minimize info """""""""""""""""""""""""""""""""""""""""""""""""""""""""" -No information about this fix is written to :doc:`binary restart files `. None of the :doc:`fix_modify ` options -are relevant to this fix. +No information about this fix is written to :doc:`binary restart files `. + +The :doc:`fix_modify ` *respa* option is supported by +this fix. This allows to set at which level of the :doc:`r-RESPA ` +integrator the fix is setting the forces to the desired values; on all +other levels, the force is set to 0.0 for the atoms in the fix group, +so that setforce values are not counted multiple times. Default is to +to override forces at the outermost level. This fix computes a global 3-vector of forces, which can be accessed by various :ref:`output commands `. This is the diff --git a/doc/html/_sources/fix_shardlow.txt b/doc/html/_sources/fix_shardlow.txt index 623c7621a2..419dadd4ea 100644 --- a/doc/html/_sources/fix_shardlow.txt +++ b/doc/html/_sources/fix_shardlow.txt @@ -70,6 +70,9 @@ lengths to be larger than twice the cutoff+skin. Generally, the domain decomposition is dependent on the number of processors requested. +This fix also requires :doc:`atom_style dpd ` to be used +due to shared data structures. + Related commands """""""""""""""" diff --git a/doc/html/_sources/fix_smd.txt b/doc/html/_sources/fix_smd.txt index 400cea7fbd..baf56a8708 100644 --- a/doc/html/_sources/fix_smd.txt +++ b/doc/html/_sources/fix_smd.txt @@ -108,8 +108,9 @@ See the :doc:`read_restart ` command for info on how to re-specify a fix in an input script that reads a restart file, so that the operation of the fix continues in an uninterrupted fashion. -None of the :doc:`fix_modify ` options are relevant to this -fix. +The :doc:`fix_modify ` *respa* option is supported by +this fix. This allows to set at which level of the :doc:`r-RESPA ` +integrator the fix is adding its forces. Default is the outermost level. This fix computes a vector list of 7 quantities, which can be accessed by various :ref:`output commands `. The diff --git a/doc/html/_sources/fix_spring.txt b/doc/html/_sources/fix_spring.txt index 22515f795b..e2b1b57c11 100644 --- a/doc/html/_sources/fix_spring.txt +++ b/doc/html/_sources/fix_spring.txt @@ -111,6 +111,10 @@ The :doc:`fix_modify ` *energy* option is supported by this fix to add the energy stored in the spring to the system's potential energy as part of :doc:`thermodynamic output `. +The :doc:`fix_modify ` *respa* option is supported by this +fix. This allows to set at which level of the :doc:`r-RESPA ` +integrator the fix is adding its forces. Default is the outermost level. + This fix computes a global scalar which can be accessed by various :ref:`output commands `. The scalar is the spring energy = 0.5 * K * r^2. diff --git a/doc/html/_sources/fix_spring_chunk.txt b/doc/html/_sources/fix_spring_chunk.txt index ecf6b3d1f5..b8a303838b 100644 --- a/doc/html/_sources/fix_spring_chunk.txt +++ b/doc/html/_sources/fix_spring_chunk.txt @@ -57,6 +57,10 @@ The :doc:`fix_modify ` *energy* option is supported by this fix to add the energy stored in all the springs to the system's potential energy as part of :doc:`thermodynamic output `. +The :doc:`fix_modify ` *respa* option is supported by this +fix. This allows to set at which level of the :doc:`r-RESPA ` +integrator the fix is adding its forces. Default is the outermost level. + This fix computes a global scalar which can be accessed by various :ref:`output commands `. The scalar is the energy of all the springs, i.e. 0.5 * K * r^2 per-spring. diff --git a/doc/html/_sources/fix_spring_rg.txt b/doc/html/_sources/fix_spring_rg.txt index 92ffe8aa82..3be20597ad 100644 --- a/doc/html/_sources/fix_spring_rg.txt +++ b/doc/html/_sources/fix_spring_rg.txt @@ -61,6 +61,10 @@ by this fix for access by various :ref:`output commands `. No paramet be used with the *start/stop* keywords of the :doc:`run ` command. This fix is not invoked during :doc:`energy minimization `. +The :doc:`fix_modify ` *respa* option is supported by this +fix. This allows to set at which level of the :doc:`r-RESPA ` +integrator the fix is adding its forces. Default is the outermost level. + Restrictions """""""""""" none diff --git a/doc/html/_sources/fix_spring_self.txt b/doc/html/_sources/fix_spring_self.txt index 6eaebfa6c8..66aa50ff22 100644 --- a/doc/html/_sources/fix_spring_self.txt +++ b/doc/html/_sources/fix_spring_self.txt @@ -54,6 +54,10 @@ The :doc:`fix_modify ` *energy* option is supported by this fix to add the energy stored in the per-atom springs to the system's potential energy as part of :doc:`thermodynamic output `. +The :doc:`fix_modify ` *respa* option is supported by +this fix. This allows to set at which level of the :doc:`r-RESPA ` +integrator the fix is adding its forces. Default is the outermost level. + This fix computes a global scalar which can be accessed by various :ref:`output commands `. The scalar is an energy which is the sum of the spring energy for each atom, where the diff --git a/doc/html/_sources/fix_viscous.txt b/doc/html/_sources/fix_viscous.txt index 58052e922c..39fad9c2d9 100644 --- a/doc/html/_sources/fix_viscous.txt +++ b/doc/html/_sources/fix_viscous.txt @@ -92,6 +92,10 @@ are relevant to this fix. No global or per-atom quantities are stored by this fix for access by various :ref:`output commands `. No parameter of this fix can be used with the *start/stop* keywords of the :doc:`run ` command. +The :doc:`fix_modify ` *respa* option is supported by this +fix. This allows to set at which level of the :doc:`r-RESPA ` +integrator the fix is modifying forces. Default is the outermost level. + The forces due to this fix are imposed during an energy minimization, invoked by the :doc:`minimize ` command. This fix should only be used with damped dynamics minimizers that allow for diff --git a/doc/html/_sources/fix_wall.txt b/doc/html/_sources/fix_wall.txt index a8a379bab9..54cc0ebb8a 100644 --- a/doc/html/_sources/fix_wall.txt +++ b/doc/html/_sources/fix_wall.txt @@ -289,6 +289,10 @@ The :doc:`fix_modify ` *energy* option is supported by this fix to add the energy of interaction between atoms and each wall to the system's potential energy as part of :doc:`thermodynamic output `. +The :doc:`fix_modify ` *respa* option is supported by this +fix. This allows to set at which level of the :doc:`r-RESPA ` +integrator the fix is adding its forces. Default is the outermost level. + This fix computes a global scalar energy and a global vector of forces, which can be accessed by various :ref:`output commands `. Note that the scalar energy is the sum of interactions with all defined walls. If you want the diff --git a/doc/html/_sources/fix_wall_region.txt b/doc/html/_sources/fix_wall_region.txt index 074424ddc5..1b8b774408 100644 --- a/doc/html/_sources/fix_wall_region.txt +++ b/doc/html/_sources/fix_wall_region.txt @@ -190,6 +190,10 @@ The :doc:`fix_modify ` *energy* option is supported by this fix to add the energy of interaction between atoms and the wall to the system's potential energy as part of :doc:`thermodynamic output `. +The :doc:`fix_modify ` *respa* option is supported by this +fix. This allows to set at which level of the :doc:`r-RESPA ` +integrator the fix is adding its forces. Default is the outermost level. + This fix computes a global scalar energy and a global 3-length vector of forces, which can be accessed by various :ref:`output commands `. The scalar energy is the sum of energy interactions for all particles interacting with the wall diff --git a/doc/html/_sources/pair_dpd_fdt.txt b/doc/html/_sources/pair_dpd_fdt.txt index 1c35614fa6..d665d196af 100644 --- a/doc/html/_sources/pair_dpd_fdt.txt +++ b/doc/html/_sources/pair_dpd_fdt.txt @@ -135,6 +135,10 @@ Pair style *dpd/fdt/energy* requires :doc:`atom_style dpd ` to be used in order to properly account for the particle internal energies and temperatures. +Pair style *dpd/fdt* currently also requires +:doc:`atom_style dpd ` to be used in conjunction with +:doc:`fix shardlow ` due to shared data structures. + Related commands """""""""""""""" diff --git a/doc/html/_sources/pair_gran.txt b/doc/html/_sources/pair_gran.txt index f0c9a43e23..71a1497d03 100644 --- a/doc/html/_sources/pair_gran.txt +++ b/doc/html/_sources/pair_gran.txt @@ -246,7 +246,7 @@ These extra quantites can be accessed by the :doc:`compute pair/local ` section for more info. diff --git a/doc/html/_sources/run_style.txt b/doc/html/_sources/run_style.txt index 6f9cf96c9f..380f4536c0 100644 --- a/doc/html/_sources/run_style.txt +++ b/doc/html/_sources/run_style.txt @@ -170,6 +170,9 @@ computed where dihedral forces are, pair forces are computed at the outermost level, and kspace forces are computed where pair forces are. The inner, middle, outer forces have no defaults. +For fixes that support it, the rRESPA level at which a given fix is +active, can be selected through the :doc:`fix_modify ` command. + The *inner* and *middle* keywords take additional arguments for cutoffs that are used by the pairwise force computations. If the 2 cutoffs for *inner* are 5.0 and 6.0, this means that all pairs up to diff --git a/doc/html/_sources/timer.txt b/doc/html/_sources/timer.txt index 789edc1096..ba1dd478c7 100644 --- a/doc/html/_sources/timer.txt +++ b/doc/html/_sources/timer.txt @@ -10,7 +10,7 @@ Syntax timer args -* *args* = one or more of *off* or *loop* or *normal* or *full* or *sync* or *nosync* +* *args* = one or more of *off* or *loop* or *normal* or *full* or *sync* or *nosync* or *timeout* or *every* .. parsed-literal:: *off* = do not collect or print any timing information @@ -19,6 +19,8 @@ Syntax *full* = like *normal* but also include CPU and thread utilzation *sync* = explicitly synchronize MPI tasks between sections *nosync* = do not synchronize MPI tasks between sections (default) + *timeout* elapse = set walltime limit to *elapse* + *every* Ncheck = perform timeout check every *Ncheck* steps Examples """""""" @@ -26,19 +28,19 @@ Examples .. parsed-literal:: timer full sync + timer timeout 2:00:00 every 100 timer loop Description """"""""""" -Select the level of detail LAMMPS performs its CPU timings. +Select the level of detail at which LAMMPS performs its CPU timings. During a simulation run LAMMPS collects information about how much time is spent in different sections of the code and thus can provide -valuable information for determining performance and load imbalance -problems. This can be done at different levels of detail and -accuracy. For more information about the timing output, see this -:ref:`discussion of screen output `. +information for determining performance and load imbalance problems. +This can be done at different levels of detail and accuracy. For more +information about the timing output, see this :ref:`discussion of screen output `. The *off* setting will turn all time measurements off. The *loop* setting will only measure the total time for a run and not collect any @@ -54,8 +56,29 @@ call which meaures load imbalance more accuractly, though it can also 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. +With the *timeout* keyword a walltime limit can be imposed that +affects the :doc:`run ` and :doc:`minimize ` commands. If +the time limit is reached, the run or energy minimization will exit on +the next step or iteration that is a multiple of the *Ncheck* value +specified with the *every* keyword. All subsequent run or minimize +commands in the input script will be skipped until the timeout is +reset or turned off by a new *timer* command. The timeout *elapse* +value can be specified as *off* or *unlimited* to impose no timeout +condition (which is the default). The *elapse* setting can be +specified as a single number for seconds, two numbers separated by a +colon (MM:SS) for minutes and seconds, or as three numbers separated +by colons for hours, minutes, and seconds. + +The *every* keyword sets how frequently during a run or energy +minimization the wall clock will be checked. This check count applies +to the outer iterations or time steps during minimizations or :doc:`r-RESPA runs `, respectively. Checking for timeout too often, +can slow a calculation down. Checking too infrequently can make the +timeout measurement less accurate, with the run being stopped later +than desired. + +Multiple keywords can be specified with the *timer* command. For +keywords that are mutually exclusive, the last one specified takes +effect. .. note:: @@ -80,7 +103,11 @@ Related commands Default """"""" -timer normal nosync +.. parsed-literal:: + + timer normal nosync + timer timeout off + timer every 10 .. _lws: http://lammps.sandia.gov diff --git a/doc/html/accelerate_gpu.html b/doc/html/accelerate_gpu.html index 215a250db8..b4fc73c25e 100644 --- a/doc/html/accelerate_gpu.html +++ b/doc/html/accelerate_gpu.html @@ -154,10 +154,10 @@ NVIDIA support as well as more general OpenCL support, so that the same functionality can eventually be supported on a variety of GPU hardware. -

Here is a quick overview of how to use the GPU package:

+

Here is a quick overview of how to enable and use the GPU package:

    -
  • build the library in lib/gpu for your GPU hardware wity desired precision
  • -
  • include the GPU package and build LAMMPS
  • +
  • build the library in lib/gpu for your GPU hardware with the desired precision settings
  • +
  • install the GPU package and build LAMMPS as usual
  • use the mpirun command to set the number of MPI tasks/node which determines the number of MPI tasks/GPU
  • specify the # of GPUs per node
  • use GPU styles in your input script
  • diff --git a/doc/html/compute.html b/doc/html/compute.html index be9b09fc53..b4f0375d18 100644 --- a/doc/html/compute.html +++ b/doc/html/compute.html @@ -323,6 +323,7 @@ section of rdf - radial distribution function g(r) histogram of group of atoms
  • reduce - combine per-atom quantities into a single global value
  • reduce/region - same as compute reduce, within a region
  • +
  • rigid/local - extract rigid body attributes
  • slice - extract values from global vector or array
  • sna/atom - calculate bispectrum coefficients for each atom
  • snad/atom - derivative of bispectrum coefficients for each atom
  • diff --git a/doc/html/compute_rigid_local.html b/doc/html/compute_rigid_local.html index 7039f44656..d2ddebee85 100644 --- a/doc/html/compute_rigid_local.html +++ b/doc/html/compute_rigid_local.html @@ -252,8 +252,8 @@ corresponding attribute is in:

    Restrictions

    -
    -
    none
    +

    This compute is part of the RIGID package. It is only enabled if +LAMMPS was built with that package. See the Making LAMMPS section for more info.

    Restrictions

    @@ -191,7 +203,7 @@ produces to be part of the optimization criteria.

    Default

    The option defaults are temp = ID defined by fix, press = ID defined -by fix, energy = no.

    +by fix, energy = no, respa = 0.

    diff --git a/doc/html/fix_orient.html b/doc/html/fix_orient.html index ee3d207258..a94305b2f5 100644 --- a/doc/html/fix_orient.html +++ b/doc/html/fix_orient.html @@ -240,6 +240,9 @@ writing the orientation files is given in thermodynamic output.

    +

    The fix_modify respa option is supported by these +fixes. This allows to set at which level of the r-RESPA +integrator a fix is adding its forces. Default is the outermost level.

    This fix calculates a global scalar which can be accessed by various output commands. The scalar is the potential energy change due to this fix. The scalar value calculated diff --git a/doc/html/fix_qeq_comb.html b/doc/html/fix_qeq_comb.html index 52302b0950..c7382d021d 100644 --- a/doc/html/fix_qeq_comb.html +++ b/doc/html/fix_qeq_comb.html @@ -199,8 +199,11 @@ more instructions on how to use the accelerated styles effectively.


    Restart, fix_modify, output, run start/stop, minimize info

    -

    No information about this fix is written to binary restart files. None of the fix_modify options -are relevant to this fix.

    +

    No information about this fix is written to binary restart files.

    +

    The fix_modify respa option is supported by this +fix. This allows to set at which level of the r-RESPA +integrator the fix is performing charge equilibration. Default is +the outermost level.

    This fix produces a per-atom vector which can be accessed by various output commands. The vector stores the gradient of the charge on each atom. The per-atom values be accessed diff --git a/doc/html/fix_restrain.html b/doc/html/fix_restrain.html index d48a6fa861..34228509c9 100644 --- a/doc/html/fix_restrain.html +++ b/doc/html/fix_restrain.html @@ -267,6 +267,9 @@ 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.

    +

    The fix_modify respa option is supported by this +fix. This allows to set at which level of the r-RESPA +integrator the fix is adding its forces. Default is the outermost level.

    Note

    If you want the fictitious potential energy associated with the diff --git a/doc/html/fix_setforce.html b/doc/html/fix_setforce.html index 7c92b7dc69..35b7f76194 100644 --- a/doc/html/fix_setforce.html +++ b/doc/html/fix_setforce.html @@ -204,8 +204,13 @@ more instructions on how to use the accelerated styles effectively.


    Restart, fix_modify, output, run start/stop, minimize info

    -

    No information about this fix is written to binary restart files. None of the fix_modify options -are relevant to this fix.

    +

    No information about this fix is written to binary restart files.

    +

    The fix_modify respa option is supported by +this fix. This allows to set at which level of the r-RESPA +integrator the fix is setting the forces to the desired values; on all +other levels, the force is set to 0.0 for the atoms in the fix group, +so that setforce values are not counted multiple times. Default is to +to override forces at the outermost level.

    This fix computes a global 3-vector of forces, which can be accessed by various output commands. This is the total force on the group of atoms before the forces on individual diff --git a/doc/html/fix_shardlow.html b/doc/html/fix_shardlow.html index e54353f7eb..3f9d81d749 100644 --- a/doc/html/fix_shardlow.html +++ b/doc/html/fix_shardlow.html @@ -180,6 +180,8 @@ integration, e.g. +

    This fix also requires atom_style dpd to be used +due to shared data structures.

    Restrictions

    diff --git a/doc/html/fix_spring_self.html b/doc/html/fix_spring_self.html index 99f6efc17a..dbc542e600 100644 --- a/doc/html/fix_spring_self.html +++ b/doc/html/fix_spring_self.html @@ -171,6 +171,9 @@ operation of the fix continues in an uninterrupted fashion.

    The fix_modify energy option is supported by this fix to add the energy stored in the per-atom springs to the system’s potential energy as part of thermodynamic output.

    +

    The fix_modify respa option is supported by +this fix. This allows to set at which level of the r-RESPA +integrator the fix is adding its forces. Default is the outermost level.

    This fix computes a global scalar which can be accessed by various output commands. The scalar is an energy which is the sum of the spring energy for each atom, where the diff --git a/doc/html/fix_viscous.html b/doc/html/fix_viscous.html index b097a4c1e6..5bf3e54e0a 100644 --- a/doc/html/fix_viscous.html +++ b/doc/html/fix_viscous.html @@ -202,6 +202,9 @@ easily be used as a thermostat.

    are relevant to this fix. No global or per-atom quantities are stored by this fix for access by various output commands. No parameter of this fix can be used with the start/stop keywords of the run command.

    +

    The fix_modify respa option is supported by this +fix. This allows to set at which level of the r-RESPA +integrator the fix is modifying forces. Default is the outermost level.

    The forces due to this fix are imposed during an energy minimization, invoked by the minimize command. This fix should only be used with damped dynamics minimizers that allow for diff --git a/doc/html/fix_wall.html b/doc/html/fix_wall.html index 2c601bc4a5..8f3ac46551 100644 --- a/doc/html/fix_wall.html +++ b/doc/html/fix_wall.html @@ -362,6 +362,9 @@ perturbation on the particles:

    The fix_modify energy option is supported by this fix to add the energy of interaction between atoms and each wall to the system’s potential energy as part of thermodynamic output.

    +

    The fix_modify respa option is supported by this +fix. This allows to set at which level of the r-RESPA +integrator the fix is adding its forces. Default is the outermost level.

    This fix computes a global scalar energy and a global vector of forces, which can be accessed by various output commands. Note that the scalar energy is the sum of interactions with all defined walls. If you want the diff --git a/doc/html/fix_wall_region.html b/doc/html/fix_wall_region.html index 2ef30494f3..4f24bee99a 100644 --- a/doc/html/fix_wall_region.html +++ b/doc/html/fix_wall_region.html @@ -287,6 +287,9 @@ region surface (r > 0).

    The fix_modify energy option is supported by this fix to add the energy of interaction between atoms and the wall to the system’s potential energy as part of thermodynamic output.

    +

    The fix_modify respa option is supported by this +fix. This allows to set at which level of the r-RESPA +integrator the fix is adding its forces. Default is the outermost level.

    This fix computes a global scalar energy and a global 3-length vector of forces, which can be accessed by various output commands. The scalar energy is the sum of energy interactions for all particles interacting with the wall diff --git a/doc/html/pair_dpd_fdt.html b/doc/html/pair_dpd_fdt.html index a06112c8fc..120496b3cd 100644 --- a/doc/html/pair_dpd_fdt.html +++ b/doc/html/pair_dpd_fdt.html @@ -235,6 +235,9 @@ stored by ghost atoms.

    Pair style dpd/fdt/energy requires atom_style dpd to be used in order to properly account for the particle internal energies and temperatures.

    +

    Pair style dpd/fdt currently also requires +atom_style dpd to be used in conjunction with +fix shardlow due to shared data structures.

      -
    • args = one or more of off or loop or normal or full or sync or nosync
    • +
    • args = one or more of off or loop or normal or full or sync or nosync or timeout or every
     off = do not collect or print any timing information
    @@ -141,24 +141,26 @@
     full = like normal but also include CPU and thread utilzation
     sync = explicitly synchronize MPI tasks between sections
     nosync = do not synchronize MPI tasks between sections (default)
    +timeout elapse = set walltime limit to elapse
    +every Ncheck = perform timeout check every Ncheck steps
     

    Examples

    timer full sync
    +timer timeout 2:00:00 every 100
     timer loop
     

    Description

    -

    Select the level of detail LAMMPS performs its CPU timings.

    +

    Select the level of detail at which LAMMPS performs its CPU timings.

    During a simulation run LAMMPS collects information about how much time is spent in different sections of the code and thus can provide -valuable information for determining performance and load imbalance -problems. This can be done at different levels of detail and -accuracy. For more information about the timing output, see this -discussion of screen output.

    +information for determining performance and load imbalance problems. +This can be done at different levels of detail and accuracy. For more +information about the timing output, see this discussion of screen output.

    The off setting will turn all time measurements off. The loop setting will only measure the total time for a run and not collect any detailed per section information. With the normal setting, timing @@ -171,8 +173,27 @@ utilization and thread utilization, when multi-threading is enabled.

    call which meaures load imbalance more accuractly, though it can also 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.

    +

    With the timeout keyword a walltime limit can be imposed that +affects the run and minimize commands. If +the time limit is reached, the run or energy minimization will exit on +the next step or iteration that is a multiple of the Ncheck value +specified with the every keyword. All subsequent run or minimize +commands in the input script will be skipped until the timeout is +reset or turned off by a new timer command. The timeout elapse +value can be specified as off or unlimited to impose no timeout +condition (which is the default). The elapse setting can be +specified as a single number for seconds, two numbers separated by a +colon (MM:SS) for minutes and seconds, or as three numbers separated +by colons for hours, minutes, and seconds.

    +

    The every keyword sets how frequently during a run or energy +minimization the wall clock will be checked. This check count applies +to the outer iterations or time steps during minimizations or r-RESPA runs, respectively. Checking for timeout too often, +can slow a calculation down. Checking too infrequently can make the +timeout measurement less accurate, with the run being stopped later +than desired.

    +

    Multiple keywords can be specified with the timer command. For +keywords that are mutually exclusive, the last one specified takes +effect.

    Note

    Using the full and sync options provides the most detailed @@ -196,7 +217,11 @@ can just use the loop or off setting.

    Default

    -

    timer normal nosync

    +
    timer normal nosync
    +timer timeout off
    +timer every 10
    +
    +
    diff --git a/doc/src/timer.txt b/doc/src/timer.txt index e68d982d31..36d8c61940 100644 --- a/doc/src/timer.txt +++ b/doc/src/timer.txt @@ -19,8 +19,8 @@ timer args :pre {full} = like {normal} but also include CPU and thread utilzation {sync} = explicitly synchronize MPI tasks between sections {nosync} = do not synchronize MPI tasks between sections (default) - {timeout} value = set walltime limit to {value} - {every} value = perform timeout check every {value} steps :pre + {timeout} elapse = set walltime limit to {elapse} + {every} Ncheck = perform timeout check every {Ncheck} steps :pre [Examples:] @@ -30,14 +30,14 @@ timer loop :pre [Description:] -Select the level of detail LAMMPS performs its CPU timings. +Select the level of detail at which LAMMPS performs its CPU timings. During a simulation run LAMMPS collects information about how much time is spent in different sections of the code and thus can provide -valuable information for determining performance and load imbalance -problems. This can be done at different levels of detail and -accuracy. For more information about the timing output, see this -"discussion of screen output"_Section_start.html#start_8. +information for determining performance and load imbalance problems. +This can be done at different levels of detail and accuracy. For more +information about the timing output, see this "discussion of screen +output"_Section_start.html#start_8. The {off} setting will turn all time measurements off. The {loop} setting will only measure the total time for a run and not collect any @@ -53,23 +53,26 @@ call which meaures load imbalance more accuractly, though it can also slow down the simulation. Using the {nosync} setting (which is the default) turns off this synchronization. -With the {timeout} keyword a walltime limit can be imposed that affects -"run"_run.html and "minimize"_minimize.html commands. If the time -limit it reached, ongoing calculations will be stopped on the next -step that is a multiple of the value specified with {every}. All -follwing run or minimize commands will be skipped until the timeout -is reset or turned off by a new {timer} command. The timeout value -can be "off" or "unlimited" to turn the timeout off, otherwise a -single number is interpreted as seconds, two numbers separated by -a colon (MM:SS) as minutes and seconds and three numbers separated -by colons as hours, minutes and seconds, respectively. +With the {timeout} keyword a walltime limit can be imposed that +affects the "run"_run.html and "minimize"_minimize.html commands. If +the time limit is reached, the run or energy minimization will exit on +the next step or iteration that is a multiple of the {Ncheck} value +specified with the {every} keyword. All subsequent run or minimize +commands in the input script will be skipped until the timeout is +reset or turned off by a new {timer} command. The timeout {elapse} +value can be specified as {off} or {unlimited} to impose no timeout +condition (which is the default). The {elapse} setting can be +specified as a single number for seconds, two numbers separated by a +colon (MM:SS) for minutes and seconds, or as three numbers separated +by colons for hours, minutes, and seconds. -The {every} keyword sets how frequent during a run or minimization -the wall clock will be checked. This check count applies to the outer -iterations or time steps during minimizations or r-RESPA runs, respectively. -Checking for timeout very often, can slow a calculation down, checking -too infrequent makes the timeout measurement less accurate and the run -will be stopped later than desired. +The {every} keyword sets how frequently during a run or energy +minimization the wall clock will be checked. This check count applies +to the outer iterations or time steps during minimizations or "r-RESPA +runs"_run_style.html, respectively. Checking for timeout too often, +can slow a calculation down. Checking too infrequently can make the +timeout measurement less accurate, with the run being stopped later +than desired. Multiple keywords can be specified with the {timer} command. For keywords that are mutually exclusive, the last one specified takes