tAdded cross references to solver parameter setting functions - sphere - GPU-based 3D discrete element method algorithm with optional fluid coupling
HTML git clone git://src.adamsgaard.dk/sphere
DIR Log
DIR Files
DIR Refs
DIR LICENSE
---
DIR commit cd3c946b61b00ac1b5bd9776f12d8548fe2d9d39
DIR parent df3b3e17580a8a64d4624b7d9bddb40bf6d2e834
HTML Author: Anders Damsgaard <anders.damsgaard@geo.au.dk>
Date: Wed, 26 Mar 2014 11:28:13 +0100
Added cross references to solver parameter setting functions
Diffstat:
M doc/html/objects.inv | 0
M doc/html/python_api.html | 18 ++++++++++++++++++
M doc/html/searchindex.js | 4 ++--
M doc/pdf/sphere.pdf | 0
M python/sphere.py | 26 ++++++++++++++++++++++++++
5 files changed, 46 insertions(+), 2 deletions(-)
---
DIR diff --git a/doc/html/objects.inv b/doc/html/objects.inv
Binary files differ.
DIR diff --git a/doc/html/python_api.html b/doc/html/python_api.html
t@@ -847,18 +847,24 @@ included.</p>
<dt id="sphere.sim.normalBoundariesXY">
<tt class="descname">normalBoundariesXY</tt><big>(</big><big>)</big><a class="headerlink" href="#sphere.sim.normalBoundariesXY" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the x and y boundary conditions to be static walls.</p>
+<p>See also <a class="reference internal" href="#sphere.sim.periodicBoundariesXY" title="sphere.sim.periodicBoundariesXY"><tt class="xref py py-func docutils literal"><span class="pre">periodicBoundariesXY()</span></tt></a> and
+<a class="reference internal" href="#sphere.sim.periodicBoundariesX" title="sphere.sim.periodicBoundariesX"><tt class="xref py py-func docutils literal"><span class="pre">periodicBoundariesX()</span></tt></a></p>
</dd></dl>
<dl class="method">
<dt id="sphere.sim.periodicBoundariesX">
<tt class="descname">periodicBoundariesX</tt><big>(</big><big>)</big><a class="headerlink" href="#sphere.sim.periodicBoundariesX" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the x boundary conditions to be periodic.</p>
+<p>See also <a class="reference internal" href="#sphere.sim.normalBoundariesXY" title="sphere.sim.normalBoundariesXY"><tt class="xref py py-func docutils literal"><span class="pre">normalBoundariesXY()</span></tt></a> and
+<a class="reference internal" href="#sphere.sim.periodicBoundariesXY" title="sphere.sim.periodicBoundariesXY"><tt class="xref py py-func docutils literal"><span class="pre">periodicBoundariesXY()</span></tt></a></p>
</dd></dl>
<dl class="method">
<dt id="sphere.sim.periodicBoundariesXY">
<tt class="descname">periodicBoundariesXY</tt><big>(</big><big>)</big><a class="headerlink" href="#sphere.sim.periodicBoundariesXY" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the x and y boundary conditions to be periodic.</p>
+<p>See also <a class="reference internal" href="#sphere.sim.normalBoundariesXY" title="sphere.sim.normalBoundariesXY"><tt class="xref py py-func docutils literal"><span class="pre">normalBoundariesXY()</span></tt></a> and
+<a class="reference internal" href="#sphere.sim.periodicBoundariesX" title="sphere.sim.periodicBoundariesX"><tt class="xref py py-func docutils literal"><span class="pre">periodicBoundariesX()</span></tt></a></p>
</dd></dl>
<dl class="method">
t@@ -1228,6 +1234,9 @@ velocity prediction (Chorin’s original projection method, see Chorin
best results precision and performance-wise are obtained by using a beta
of 0 and a low tolerance criteria value.</p>
<p>The default and recommended value is 0.0.</p>
+<p>Other solver parameter setting functions: <a class="reference internal" href="#sphere.sim.setGamma" title="sphere.sim.setGamma"><tt class="xref py py-func docutils literal"><span class="pre">setGamma()</span></tt></a>,
+<a class="reference internal" href="#sphere.sim.setTheta" title="sphere.sim.setTheta"><tt class="xref py py-func docutils literal"><span class="pre">setTheta()</span></tt></a>, <a class="reference internal" href="#sphere.sim.setTolerance" title="sphere.sim.setTolerance"><tt class="xref py py-func docutils literal"><span class="pre">setTolerance()</span></tt></a> and
+<a class="reference internal" href="#sphere.sim.setMaxIterations" title="sphere.sim.setMaxIterations"><tt class="xref py py-func docutils literal"><span class="pre">setMaxIterations()</span></tt></a></p>
</dd></dl>
<dl class="method">
t@@ -1268,6 +1277,8 @@ more averaging is introduced. A value of 0.0 disables all averaging.</p>
</tr>
</tbody>
</table>
+<p>Other solver parameter setting functions: <a class="reference internal" href="#sphere.sim.setTheta" title="sphere.sim.setTheta"><tt class="xref py py-func docutils literal"><span class="pre">setTheta()</span></tt></a>,
+<a class="reference internal" href="#sphere.sim.setBeta" title="sphere.sim.setBeta"><tt class="xref py py-func docutils literal"><span class="pre">setBeta()</span></tt></a>, <a class="reference internal" href="#sphere.sim.setTolerance" title="sphere.sim.setTolerance"><tt class="xref py py-func docutils literal"><span class="pre">setTolerance()</span></tt></a> and <a class="reference internal" href="#sphere.sim.setMaxIterations" title="sphere.sim.setMaxIterations"><tt class="xref py py-func docutils literal"><span class="pre">setMaxIterations()</span></tt></a></p>
</dd></dl>
<dl class="method">
t@@ -1288,6 +1299,8 @@ solver</td>
</tr>
</tbody>
</table>
+<p>Other solver parameter setting functions: <a class="reference internal" href="#sphere.sim.setGamma" title="sphere.sim.setGamma"><tt class="xref py py-func docutils literal"><span class="pre">setGamma()</span></tt></a>,
+<a class="reference internal" href="#sphere.sim.setTheta" title="sphere.sim.setTheta"><tt class="xref py py-func docutils literal"><span class="pre">setTheta()</span></tt></a>, <a class="reference internal" href="#sphere.sim.setBeta" title="sphere.sim.setBeta"><tt class="xref py py-func docutils literal"><span class="pre">setBeta()</span></tt></a> and <a class="reference internal" href="#sphere.sim.setTolerance" title="sphere.sim.setTolerance"><tt class="xref py py-func docutils literal"><span class="pre">setTolerance()</span></tt></a></p>
</dd></dl>
<dl class="method">
t@@ -1308,6 +1321,8 @@ instabilities may be avoided with lower values.</p>
</tr>
</tbody>
</table>
+<p>Other solver parameter setting functions: <a class="reference internal" href="#sphere.sim.setGamma" title="sphere.sim.setGamma"><tt class="xref py py-func docutils literal"><span class="pre">setGamma()</span></tt></a>,
+<a class="reference internal" href="#sphere.sim.setBeta" title="sphere.sim.setBeta"><tt class="xref py py-func docutils literal"><span class="pre">setBeta()</span></tt></a>, <a class="reference internal" href="#sphere.sim.setTolerance" title="sphere.sim.setTolerance"><tt class="xref py py-func docutils literal"><span class="pre">setTolerance()</span></tt></a> and <a class="reference internal" href="#sphere.sim.setMaxIterations" title="sphere.sim.setMaxIterations"><tt class="xref py py-func docutils literal"><span class="pre">setMaxIterations()</span></tt></a></p>
</dd></dl>
<dl class="method">
t@@ -1326,6 +1341,9 @@ residual</td>
</tr>
</tbody>
</table>
+<p>Other solver parameter setting functions: <a class="reference internal" href="#sphere.sim.setGamma" title="sphere.sim.setGamma"><tt class="xref py py-func docutils literal"><span class="pre">setGamma()</span></tt></a>,
+<a class="reference internal" href="#sphere.sim.setTheta" title="sphere.sim.setTheta"><tt class="xref py py-func docutils literal"><span class="pre">setTheta()</span></tt></a>, <a class="reference internal" href="#sphere.sim.setBeta" title="sphere.sim.setBeta"><tt class="xref py py-func docutils literal"><span class="pre">setBeta()</span></tt></a> and
+<a class="reference internal" href="#sphere.sim.setMaxIterations" title="sphere.sim.setMaxIterations"><tt class="xref py py-func docutils literal"><span class="pre">setMaxIterations()</span></tt></a></p>
</dd></dl>
<dl class="method">
DIR diff --git a/doc/html/searchindex.js b/doc/html/searchindex.js
t@@ -1 +1 @@
mx1.adamsgaard.dk:70 /src/sphere/commit/cd3c946b61b00ac1b5bd9776f12d8548fe2d9d39.gph:101: line too long