Automated documentation rebuild

genindex.html

@@ -6254,6 +6254,8 @@ <h2 id="T">T</h2>
 
       <ul>
         <li><a href="reference/kinetics/lindemann.html#rmgpy.kinetics.Lindemann.to_cantera_kinetics">(rmgpy.kinetics.Lindemann method)</a>
+</li>
+        <li><a href="reference/kinetics/stickingcoefficient.html#rmgpy.kinetics.StickingCoefficient.to_cantera_kinetics">(rmgpy.kinetics.StickingCoefficient method)</a>
 </li>
         <li><a href="reference/kinetics/surfacearrhenius.html#rmgpy.kinetics.SurfaceArrhenius.to_cantera_kinetics">(rmgpy.kinetics.SurfaceArrhenius method)</a>
 </li>

reference/kinetics/stickingcoefficient.html

@@ -77,7 +77,7 @@ <h1>rmgpy.kinetics.StickingCoefficient<a class="headerlink" href="#rmgpy-kinetic
 </thead>
 <tbody>
 <tr class="row-even"><td><p><cite>A</cite></p></td>
-<td><p>The preexponential factor</p></td>
+<td><p>The preexponential factor. Unitless (sticking probability)</p></td>
 </tr>
 <tr class="row-odd"><td><p><cite>T0</cite></p></td>
 <td><p>The reference temperature</p></td>
@@ -269,7 +269,8 @@ <h1>rmgpy.kinetics.StickingCoefficient<a class="headerlink" href="#rmgpy-kinetic
 <dl class="py method">
 <dt class="sig sig-object py" id="rmgpy.kinetics.StickingCoefficient.set_cantera_kinetics">
 <span class="sig-name descname"><span class="pre">set_cantera_kinetics</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ct_reaction</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">species_list</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#rmgpy.kinetics.StickingCoefficient.set_cantera_kinetics" title="Permalink to this definition">¶</a></dt>
-<dd><p>Sets the kinetics for a cantera reaction object.</p>
+<dd><p>Passes in a cantera Reaction() object and sets its
+rate to a Cantera ArrheniusRate object.</p>
 </dd></dl>
 
 <dl class="py attribute">
@@ -283,6 +284,13 @@ <h1>rmgpy.kinetics.StickingCoefficient<a class="headerlink" href="#rmgpy-kinetic
 </dl>
 </dd></dl>
 
+<dl class="py method">
+<dt class="sig sig-object py" id="rmgpy.kinetics.StickingCoefficient.to_cantera_kinetics">
+<span class="sig-name descname"><span class="pre">to_cantera_kinetics</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#rmgpy.kinetics.StickingCoefficient.to_cantera_kinetics" title="Permalink to this definition">¶</a></dt>
+<dd><p>Converts the RMG StickingCoefficient object to a cantera StickingArrheniusRate</p>
+<p>StickingArrheniusRate(A,b,E)  where A is dimensionless, b is dimensionless, and E is in J/kmol</p>
+</dd></dl>
+
 <dl class="py method">
 <dt class="sig sig-object py" id="rmgpy.kinetics.StickingCoefficient.to_html">
 <span class="sig-name descname"><span class="pre">to_html</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#rmgpy.kinetics.StickingCoefficient.to_html" title="Permalink to this definition">¶</a></dt>
@@ -359,6 +367,7 @@ <h3><a href="../../contents.html">Table of Contents</a></h3>
 <li><a class="reference internal" href="#rmgpy.kinetics.StickingCoefficient.n"><code class="docutils literal notranslate"><span class="pre">StickingCoefficient.n</span></code></a></li>
 <li><a class="reference internal" href="#rmgpy.kinetics.StickingCoefficient.set_cantera_kinetics"><code class="docutils literal notranslate"><span class="pre">StickingCoefficient.set_cantera_kinetics()</span></code></a></li>
 <li><a class="reference internal" href="#rmgpy.kinetics.StickingCoefficient.solute"><code class="docutils literal notranslate"><span class="pre">StickingCoefficient.solute</span></code></a></li>
+<li><a class="reference internal" href="#rmgpy.kinetics.StickingCoefficient.to_cantera_kinetics"><code class="docutils literal notranslate"><span class="pre">StickingCoefficient.to_cantera_kinetics()</span></code></a></li>
 <li><a class="reference internal" href="#rmgpy.kinetics.StickingCoefficient.to_html"><code class="docutils literal notranslate"><span class="pre">StickingCoefficient.to_html()</span></code></a></li>
 <li><a class="reference internal" href="#rmgpy.kinetics.StickingCoefficient.uncertainty"><code class="docutils literal notranslate"><span class="pre">StickingCoefficient.uncertainty</span></code></a></li>
 </ul>

reference/kinetics/surfacearrhenius.html

@@ -129,7 +129,7 @@ <h1>rmgpy.kinetics.SurfaceArrhenius<a class="headerlink" href="#rmgpy-kinetics-s
 <dt class="sig sig-object py" id="rmgpy.kinetics.SurfaceArrhenius.A">
 <span class="sig-name descname"><span class="pre">A</span></span><a class="headerlink" href="#rmgpy.kinetics.SurfaceArrhenius.A" title="Permalink to this definition">¶</a></dt>
 <dd><p>The preexponential factor.</p>
-<p>This is the only thing different from a normal Arrhenius class.</p>
+<p>This (and the coverage dependence) is the only thing different from a normal Arrhenius class.</p>
 </dd></dl>
 
 <dl class="py attribute">
@@ -261,8 +261,8 @@ <h1>rmgpy.kinetics.SurfaceArrhenius<a class="headerlink" href="#rmgpy-kinetics-s
 <dl class="py method">
 <dt class="sig sig-object py" id="rmgpy.kinetics.SurfaceArrhenius.set_cantera_kinetics">
 <span class="sig-name descname"><span class="pre">set_cantera_kinetics</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ct_reaction</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">species_list</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#rmgpy.kinetics.SurfaceArrhenius.set_cantera_kinetics" title="Permalink to this definition">¶</a></dt>
-<dd><p>Passes in a cantera Reaction() object and sets its
-rate to a Cantera ArrheniusRate object.</p>
+<dd><p>Takes in a cantera Reaction object and sets its
+rate to a cantera InterfaceArrheniusRate object.</p>
 </dd></dl>
 
 <dl class="py attribute">
@@ -286,12 +286,10 @@ <h1>rmgpy.kinetics.SurfaceArrhenius<a class="headerlink" href="#rmgpy-kinetics-s
 
 <dl class="py method">
 <dt class="sig sig-object py" id="rmgpy.kinetics.SurfaceArrhenius.to_cantera_kinetics">
-<span class="sig-name descname"><span class="pre">to_cantera_kinetics</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">arrhenius_class</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#rmgpy.kinetics.SurfaceArrhenius.to_cantera_kinetics" title="Permalink to this definition">¶</a></dt>
-<dd><p>Converts the RMG Arrhenius object to a cantera ArrheniusRate or
-the auxiliary cantera Arrhenius class (used by falloff reactions).
-Inputs for both are (A,b,E)  where A is in units of m^3/kmol/s, b is dimensionless, and E is in J/kmol</p>
-<p>arrhenius_class: If <code class="docutils literal notranslate"><span class="pre">True</span></code>, uses cantera.Arrhenius (for falloff reactions). If <code class="docutils literal notranslate"><span class="pre">False</span></code>, uses
-Cantera.ArrheniusRate</p>
+<span class="sig-name descname"><span class="pre">to_cantera_kinetics</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#rmgpy.kinetics.SurfaceArrhenius.to_cantera_kinetics" title="Permalink to this definition">¶</a></dt>
+<dd><p>Converts the RMG SurfaceArrhenius object to a cantera InterfaceArrheniusRate</p>
+<p>InterfaceArrheniusRate(A,b,E)  where A is in units like m^2/kmol/s (depending on dimensionality)
+b is dimensionless, and E is in J/kmol</p>
 </dd></dl>
 
 <dl class="py method">