ICODE-ADC/lammps
4
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update documentation: explain fix_modify pair every N

Browse Source
This commit is contained in:
Yury Lysogorskiy
2022-09-27 17:15:20 +02:00
parent 502fd0eff8
commit 2f231bcd50
2 changed files with 7 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
doc/src/fix_modify.rst
View File

@ -12,7 +12,7 @@ Syntax
* fix-ID = ID of the fix to modify * fix-ID = ID of the fix to modify
* one or more keyword/value pairs may be appended * one or more keyword/value pairs may be appended
* keyword = *bodyforces* or *colname* or *dynamic/dof* or *energy* or *press* or *respa* or *temp* or *virial* * keyword = *bodyforces* or *colname* or *dynamic/dof* or *energy* or *press* or *respa* or *temp* or *virial* or *every*
.. parsed-literal:: .. parsed-literal::
@ -29,6 +29,7 @@ Syntax
*respa* value = *1* to *max respa level* or *0* (for outermost level) *respa* value = *1* to *max respa level* or *0* (for outermost level)
*temp* value = compute ID that calculates a temperature *temp* value = compute ID that calculates a temperature
*virial* value = *yes* or *no* *virial* value = *yes* or *no*
*every* arg = N
Examples Examples
"""""""" """"""""
@ -39,6 +40,7 @@ Examples
fix_modify 1 energy yes fix_modify 1 energy yes
fix_modify tether respa 2 fix_modify tether respa 2
fix_modify ave colname c_thermo_press Pressure colname 1 Temperature fix_modify ave colname c_thermo_press Pressure colname 1 Temperature
fix_modify pair every 10
Description Description
""""""""""" """""""""""

6
doc/src/fix_pair.rst
View File

@ -86,8 +86,9 @@ Restart, fix_modify, output, run start/stop, minimize info
""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" """""""""""""""""""""""""""""""""""""""""""""""""""""""""""
No information about this fix is written to :doc:`binary restart files No information about this fix is written to :doc:`binary restart files
<restart>`. None of the :doc:`fix_modify <fix_modify>` options are <restart>`.
relevant to this fix. The timesteps on which fix pair will extract per-atom quantities from a pair
style can be modified by *every* option of :doc:`fix_modify <fix_modify>`.
As explained above, this fix produces a per-atom vector or array which As explained above, this fix produces a per-atom vector or array which
can be accessed by various :doc:`output commands <Howto_output>`. If can be accessed by various :doc:`output commands <Howto_output>`. If
@ -103,6 +104,7 @@ Related commands
"""""""""""""""" """"""""""""""""
:doc:`compute pair <compute_pair>` :doc:`compute pair <compute_pair>`
:doc:`fix_modify <fix_modify>`
Default Default
""""""" """""""