tAdded cross references to solver parameter setting functions - sphere - GPU-ba… | |
git clone git://src.adamsgaard.dk/sphere | |
Log | |
Files | |
Refs | |
LICENSE | |
--- | |
commit cd3c946b61b00ac1b5bd9776f12d8548fe2d9d39 | |
parent df3b3e17580a8a64d4624b7d9bddb40bf6d2e834 | |
Author: Anders Damsgaard <[email protected]> | |
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(-) | |
--- | |
diff --git a/doc/html/objects.inv b/doc/html/objects.inv | |
Binary files differ. | |
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="… | |
<dd><p>Set the x and y boundary conditions to be static walls.</p> | |
+<p>See also <a class="reference internal" href="#sphere.sim.periodicBoundaries… | |
+<a class="reference internal" href="#sphere.sim.periodicBoundariesX" title="sp… | |
</dd></dl> | |
<dl class="method"> | |
<dt id="sphere.sim.periodicBoundariesX"> | |
<tt class="descname">periodicBoundariesX</tt><big>(</big><big>)</big><a class=… | |
<dd><p>Set the x boundary conditions to be periodic.</p> | |
+<p>See also <a class="reference internal" href="#sphere.sim.normalBoundariesXY… | |
+<a class="reference internal" href="#sphere.sim.periodicBoundariesXY" title="s… | |
</dd></dl> | |
<dl class="method"> | |
<dt id="sphere.sim.periodicBoundariesXY"> | |
<tt class="descname">periodicBoundariesXY</tt><big>(</big><big>)</big><a class… | |
<dd><p>Set the x and y boundary conditions to be periodic.</p> | |
+<p>See also <a class="reference internal" href="#sphere.sim.normalBoundariesXY… | |
+<a class="reference internal" href="#sphere.sim.periodicBoundariesX" title="sp… | |
</dd></dl> | |
<dl class="method"> | |
t@@ -1228,6 +1234,9 @@ velocity prediction (Chorin’s original projection … | |
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" hre… | |
+<a class="reference internal" href="#sphere.sim.setTheta" title="sphere.sim.se… | |
+<a class="reference internal" href="#sphere.sim.setMaxIterations" title="spher… | |
</dd></dl> | |
<dl class="method"> | |
t@@ -1268,6 +1277,8 @@ more averaging is introduced. A value of 0.0 disables al… | |
</tr> | |
</tbody> | |
</table> | |
+<p>Other solver parameter setting functions: <a class="reference internal" hre… | |
+<a class="reference internal" href="#sphere.sim.setBeta" title="sphere.sim.set… | |
</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" hre… | |
+<a class="reference internal" href="#sphere.sim.setTheta" title="sphere.sim.se… | |
</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" hre… | |
+<a class="reference internal" href="#sphere.sim.setBeta" title="sphere.sim.set… | |
</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" hre… | |
+<a class="reference internal" href="#sphere.sim.setTheta" title="sphere.sim.se… | |
+<a class="reference internal" href="#sphere.sim.setMaxIterations" title="spher… | |
</dd></dl> | |
<dl class="method"> | |
diff --git a/doc/html/searchindex.js b/doc/html/searchindex.js | |
t@@ -1 +1 @@ | |
-Search.setIndex({objects:{"":{sphere:[5,0,1,""]},sphere:{status:[5,1,1,""],con… | |
-\ No newline at end of file | |
+Search.setIndex({objects:{"":{sphere:[5,0,1,""]},sphere:{status:[5,2,1,""],con… | |
+\ No newline at end of file | |
diff --git a/doc/pdf/sphere.pdf b/doc/pdf/sphere.pdf | |
Binary files differ. | |
diff --git a/python/sphere.py b/python/sphere.py | |
t@@ -1587,18 +1587,27 @@ class sim: | |
def normalBoundariesXY(self): | |
''' | |
Set the x and y boundary conditions to be static walls. | |
+ | |
+ See also :func:`periodicBoundariesXY()` and | |
+ :func:`periodicBoundariesX()` | |
''' | |
self.periodic[0] = 0 | |
def periodicBoundariesXY(self): | |
''' | |
Set the x and y boundary conditions to be periodic. | |
+ | |
+ See also :func:`normalBoundariesXY()` and | |
+ :func:`periodicBoundariesX()` | |
''' | |
self.periodic[0] = 1 | |
def periodicBoundariesX(self): | |
''' | |
Set the x boundary conditions to be periodic. | |
+ | |
+ See also :func:`normalBoundariesXY()` and | |
+ :func:`periodicBoundariesXY()` | |
''' | |
self.periodic[0] = 2 | |
t@@ -3743,6 +3752,9 @@ class sim: | |
:param theta: The smoothing parameter value | |
:type theta: float | |
+ | |
+ Other solver parameter setting functions: :func:`setTheta()`, | |
+ :func:`setBeta()`, :func:`setTolerance()` and :func:`setMaxIterations(… | |
''' | |
self.gamma = numpy.asarray(gamma) | |
t@@ -3759,6 +3771,9 @@ class sim: | |
:param theta: The under-relaxation parameter value | |
:type theta: float | |
+ | |
+ Other solver parameter setting functions: :func:`setGamma()`, | |
+ :func:`setBeta()`, :func:`setTolerance()` and :func:`setMaxIterations(… | |
''' | |
self.theta = numpy.asarray(theta) | |
t@@ -3774,6 +3789,10 @@ class sim: | |
of 0 and a low tolerance criteria value. | |
The default and recommended value is 0.0. | |
+ | |
+ Other solver parameter setting functions: :func:`setGamma()`, | |
+ :func:`setTheta()`, :func:`setTolerance()` and | |
+ :func:`setMaxIterations()` | |
''' | |
self.beta = numpy.asarray(beta) | |
t@@ -3788,6 +3807,10 @@ class sim: | |
:param tolerance: The tolerance criteria for the maximal normalized | |
residual | |
:type tolerance: float | |
+ | |
+ Other solver parameter setting functions: :func:`setGamma()`, | |
+ :func:`setTheta()`, :func:`setBeta()` and | |
+ :func:`setMaxIterations()` | |
''' | |
self.tolerance = numpy.asarray(tolerance) | |
t@@ -3804,6 +3827,9 @@ class sim: | |
:param maxiter: The maximum number of Jacobi iterations in the fluid | |
solver | |
:type maxiter: int | |
+ | |
+ Other solver parameter setting functions: :func:`setGamma()`, | |
+ :func:`setTheta()`, :func:`setBeta()` and :func:`setTolerance()` | |
''' | |
self.maxiter = numpy.asarray(maxiter) | |