git-svn-id: svn://svn.icms.temple.edu/lammps-ro/trunk@14684 f3b2605a-c512-4ea7-a41b-209d697bcdaa

doc/_sources/fix_adapt.txt

@@ -112,29 +112,31 @@ styles and parameters that can be varied by this fix.  See the doc
 pages for individual pair styles and their energy formulas for the
 meaning of these parameters:
 
-+-----------------------------------+---------------------+------------+
-| :doc:`born <pair_born>`           | a,b,c               | type pairs |
-+-----------------------------------+---------------------+------------+
-| :doc:`buck <pair_buck>`           | a,c                 | type pairs |
-+-----------------------------------+---------------------+------------+
-| :doc:`coul/cut <pair_coul>`       | scale               | type pairs |
-+-----------------------------------+---------------------+------------+
-| :doc:`coul/debye <pair_coul>`     | scale               | type pairs |
-+-----------------------------------+---------------------+------------+
-| :doc:`coul/long <pair_coul>`      | scale               | type pairs |
-+-----------------------------------+---------------------+------------+
-| :doc:`lj/cut <pair_lj>`           | epsilon,sigma       | type pairs |
-+-----------------------------------+---------------------+------------+
-| :doc:`lj/expand <pair_lj_expand>` | epsilon,sigma,delta | type pairs |
-+-----------------------------------+---------------------+------------+
-| :doc:`lubricate <pair_lubricate>` | mu                  | global     |
-+-----------------------------------+---------------------+------------+
-| :doc:`gauss <pair_gauss>`         | a                   | type pairs |
-+-----------------------------------+---------------------+------------+
-| :doc:`morse <pair_morse>`         | d0,r0,alpha         | type pairs |
-+-----------------------------------+---------------------+------------+
-| :doc:`soft <pair_soft>`           | a                   | type pairs |
-+-----------------------------------+---------------------+------------+
++-----------------------------------+-------------------------+------------+
+| :doc:`born <pair_born>`           | a,b,c                   | type pairs |
++-----------------------------------+-------------------------+------------+
+| :doc:`buck <pair_buck>`           | a,c                     | type pairs |
++-----------------------------------+-------------------------+------------+
+| :doc:`coul/cut <pair_coul>`       | scale                   | type pairs |
++-----------------------------------+-------------------------+------------+
+| :doc:`coul/debye <pair_coul>`     | scale                   | type pairs |
++-----------------------------------+-------------------------+------------+
+| :doc:`coul/long <pair_coul>`      | scale                   | type pairs |
++-----------------------------------+-------------------------+------------+
+| :doc:`lj/cut <pair_lj>`           | epsilon,sigma           | type pairs |
++-----------------------------------+-------------------------+------------+
+| :doc:`lj/expand <pair_lj_expand>` | epsilon,sigma,delta     | type pairs |
++-----------------------------------+-------------------------+------------+
+| :doc:`lubricate <pair_lubricate>` | mu                      | global     |
++-----------------------------------+-------------------------+------------+
+| :doc:`gauss <pair_gauss>`         | a                       | type pairs |
++-----------------------------------+-------------------------+------------+
+| :doc:`morse <pair_morse>`         | d0,r0,alpha             | type pairs |
++-----------------------------------+-------------------------+------------+
+| :doc:`soft <pair_soft>`           | a                       | type pairs |
++-----------------------------------+-------------------------+------------+
+| :doc:`kim <pair_kim>`             | PARAM_FREE_*&#58i,j,... | global     |
++-----------------------------------+-------------------------+------------+
 
 .. note::
 
@@ -144,6 +146,12 @@ meaning of these parameters:
 
 Some parameters are global settings for the pair style, e.g. the
 viscosity setting "mu" for :doc:`pair_style lubricate <pair_lubricate>`.
+For :doc:`pair_kim <pair_kim>`, all free parameters supported by the
+KIM Model are available (e.g., PARAM_FREE_sigmas provided by the
+LennardJones612_Universal__MO_826355984548_001 Model).  If the free
+parameter corresponds to an array, then the particular array element
+to be adapted must be specified (e.g., "PARAM_FREE_sigmas:10", to
+adapt the tenth entry of the sigmas array).
 Other parameters apply to atom type pairs within the pair style,
 e.g. the prefactor "a" for :doc:`pair_style soft <pair_soft>`.
 

doc/fix_adapt.html

@@ -224,9 +224,9 @@ pages for individual pair styles and their energy formulas for the
 meaning of these parameters:</p>
 <table border="1" class="docutils">
 <colgroup>
-<col width="51%" />
-<col width="31%" />
-<col width="18%" />
+<col width="49%" />
+<col width="35%" />
+<col width="17%" />
 </colgroup>
 <tbody valign="top">
 <tr class="row-odd"><td><a class="reference internal" href="pair_born.html"><em>born</em></a></td>
@@ -273,6 +273,10 @@ meaning of these parameters:</p>
 <td>a</td>
 <td>type pairs</td>
 </tr>
+<tr class="row-even"><td><a class="reference internal" href="pair_kim.html"><em>kim</em></a></td>
+<td>PARAM_FREE_*&amp;#58i,j,...</td>
+<td>global</td>
+</tr>
 </tbody>
 </table>
 <div class="admonition note">
@@ -283,6 +287,12 @@ pair_*.cpp file associated with the potential.</p>
 </div>
 <p>Some parameters are global settings for the pair style, e.g. the
 viscosity setting &#8220;mu&#8221; for <a class="reference internal" href="pair_lubricate.html"><em>pair_style lubricate</em></a>.
+For <a class="reference internal" href="pair_kim.html"><em>pair_kim</em></a>, all free parameters supported by the
+KIM Model are available (e.g., PARAM_FREE_sigmas provided by the
+LennardJones612_Universal__MO_826355984548_001 Model).  If the free
+parameter corresponds to an array, then the particular array element
+to be adapted must be specified (e.g., &#8220;PARAM_FREE_sigmas:10&#8221;, to
+adapt the tenth entry of the sigmas array).
 Other parameters apply to atom type pairs within the pair style,
 e.g. the prefactor &#8220;a&#8221; for <a class="reference internal" href="pair_soft.html"><em>pair_style soft</em></a>.</p>
 <p>Note that for many of the potentials, the parameter that can be varied

doc/fix_adapt.txt

@@ -113,7 +113,8 @@ meaning of these parameters:
 "lubricate"_pair_lubricate.html: mu: global:
 "gauss"_pair_gauss.html: a: type pairs:
 "morse"_pair_morse.html: d0,r0,alpha: type pairs:
-"soft"_pair_soft.html: a: type pairs :tb(c=3,s=:)
+"soft"_pair_soft.html: a: type pairs:
+"kim"_pair_kim.html: PARAM_FREE_*&#58i,j,...: global :tb(c=3,s=:)
 
 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
@@ -121,6 +122,12 @@ 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.
+For "pair_kim"_pair_kim.html, all free parameters supported by the
+KIM Model are available (e.g., PARAM_FREE_sigmas provided by the
+LennardJones612_Universal__MO_826355984548_001 Model).  If the free
+parameter corresponds to an array, then the particular array element
+to be adapted must be specified (e.g., "PARAM_FREE_sigmas:10", to
+adapt the tenth entry of the sigmas array).
 Other parameters apply to atom type pairs within the pair style,
 e.g. the prefactor "a" for "pair_style soft"_pair_soft.html.