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

Doc tweaks to make it easier to parse for a non-human

Browse Source
This commit is contained in:
Karl Hammond
2022-08-30 00:09:18 -05:00
parent 2f8c370645
commit e3c0b04c39
3 changed files with 13 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
doc/src/fix_adapt.rst
View File

@ -36,7 +36,7 @@ Syntax
*kspace* arg = v_name
v_name = variable with name that calculates scale factor on K-space terms
*atom* args = atomparam v_name
atomparam = parameter to adapt over time
atomparam = *charge* or *diameter* or *diameter/disc* = parameter to adapt over time
v_name = variable with name that calculates value of atomparam
* zero or more keyword/value pairs may be appended
@ -44,15 +44,15 @@ Syntax
.. parsed-literal::
*scale* value = *no* or *yes*
*no* = the variable value is the new setting
*yes* = the variable value multiplies the original setting
*reset* value = *no* or *yes*
*no* = values will remain altered at the end of a run
*yes* = reset altered values to their original values at the end of a run
*mass* value = *no* or *yes*
*no* = mass is not altered by changes in diameter
*yes* = mass is altered by changes in diameter
*scale* value = *no* or *yes*
*no* = the variable value is the new setting
*yes* = the variable value multiplies the original setting
*reset* value = *no* or *yes*
*no* = values will remain altered at the end of a run
*yes* = reset altered values to their original values at the end of a run
*mass* value = *no* or *yes*
*no* = mass is not altered by changes in diameter
*yes* = mass is altered by changes in diameter
Examples
""""""""

4
doc/src/fix_ave_atom.rst
View File

@ -15,8 +15,8 @@ Syntax
* Nevery = use input values every this many timesteps
* Nrepeat = # of times to use input values for calculating averages
* Nfreq = calculate averages every this many timesteps
one or more input values can be listed
* value = x, y, z, vx, vy, vz, fx, fy, fz, c_ID, c_ID[i], f_ID, f_ID[i], v_name
* one or more input values can be listed
* value = *x*, *y*, *z*, *vx*, *vy*, *vz*, *fx*, *fy*, *fz*, c_ID, c_ID[i], f_ID, f_ID[i], v_name
.. parsed-literal::

2
doc/src/fix_ave_chunk.rst
View File

@ -17,7 +17,7 @@ Syntax
* Nfreq = calculate averages every this many timesteps
* chunkID = ID of :doc:`compute chunk/atom <compute_chunk_atom>` command
* one or more input values can be listed
* value = vx, vy, vz, fx, fy, fz, density/mass, density/number, mass, temp, c_ID, c_ID[I], f_ID, f_ID[I], v_name
* value = *vx*, *vy*, *vz*, *fx*, *fy*, *fz*, *density/mass*, *density/number*, *mass*, *temp*, c_ID, c_ID[I], f_ID, f_ID[I], v_name
.. parsed-literal::