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

replace '\_' with '_' in plain text where possible

Browse Source
This commit is contained in:
Axel Kohlmeyer
2020-03-13 16:34:57 -04:00
parent fa7085be07
commit 0b88950e03
504 changed files with 3426 additions and 3424 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
doc/src/fix_controller.rst
View File

@ -17,7 +17,7 @@ Syntax
* Kp = proportional gain in PID equation (unitless)
* Ki = integral gain in PID equation (unitless)
* Kd = derivative gain in PID equation (unitless)
* pvar = process variable of form c\_ID, c\_ID[I], f\_ID, f\_ID[I], or v\_name
* pvar = process variable of form c_ID, c_ID[I], f_ID, f_ID[I], or v_name
.. parsed-literal::
@ -152,7 +152,7 @@ The process variable *pvar* can be specified as the output of a
:doc:`variable <variable>`. In each case, the compute, fix, or variable
must produce a global quantity, not a per-atom or local quantity.
If *pvar* begins with "c\_", a compute ID must follow which has been
If *pvar* begins with "c_", a compute ID must follow which has been
previously defined in the input script and which generates a global
scalar or vector. See the individual :doc:`compute <compute>` doc page
for details. If no bracketed integer is appended, the scalar
@ -160,7 +160,7 @@ calculated by the compute is used. If a bracketed integer is
appended, the Ith value of the vector calculated by the compute is
used. Users can also write code for their own compute styles and :doc:`add them to LAMMPS <Modify>`.
If *pvar* begins with "f\_", a fix ID must follow which has been
If *pvar* begins with "f_", a fix ID must follow which has been
previously defined in the input script and which generates a global
scalar or vector. See the individual :doc:`fix <fix>` doc page for
details. Note that some fixes only produce their values on certain
@ -170,7 +170,7 @@ is appended, the scalar calculated by the fix is used. If a bracketed
integer is appended, the Ith value of the vector calculated by the fix
is used. Users can also write code for their own fix style and :doc:`add them to LAMMPS <Modify>`.
If *pvar* begins with "v\_", a variable name must follow which has been
If *pvar* begins with "v_", a variable name must follow which has been
previously defined in the input script. Only equal-style variables
can be referenced. See the :doc:`variable <variable>` command for
details. Note that variables of style *equal* define a formula which
@ -183,14 +183,14 @@ The target value *setpoint* for the process variable must be a numeric
value, in whatever units *pvar* is defined for.
The control variable *cvar* must be the name of an :doc:`internal-style variable <variable>` previously defined in the input script. Note
that it is not specified with a "v\_" prefix, just the name of the
that it is not specified with a "v_" prefix, just the name of the
variable. It must be an internal-style variable, because this fix
updates its value directly. Note that other commands can use an
equal-style versus internal-style variable interchangeably.
----------
**Restart, fix\_modify, output, run start/stop, minimize info:**
**Restart, fix_modify, output, run start/stop, minimize info:**
Currently, no information about this fix is written to :doc:`binary restart files <restart>`. None of the :doc:`fix_modify <fix_modify>` options
are relevant to this fix.