tfix function references - sphere - GPU-based 3D discrete element method algori… | |
git clone git://src.adamsgaard.dk/sphere | |
Log | |
Files | |
Refs | |
LICENSE | |
--- | |
commit 79b3ef885a99cc94c4c6a4e9f1c2ab282c974b3d | |
parent 4efc04ca0baeff9dda49ba6d41d47a1934dfb160 | |
Author: Anders Damsgaard <[email protected]> | |
Date: Mon, 1 Sep 2014 16:19:44 +0200 | |
fix function references | |
Diffstat: | |
M doc/html/python_api.html | 14 +++++++------- | |
M doc/html/searchindex.js | 4 ++-- | |
M doc/pdf/sphere.pdf | 0 | |
M python/sphere.py | 14 +++++++------- | |
4 files changed, 16 insertions(+), 16 deletions(-) | |
--- | |
diff --git a/doc/html/python_api.html b/doc/html/python_api.html | |
t@@ -782,7 +782,7 @@ proposed by GDR-MiDi 2004.</p> | |
</tr> | |
</tbody> | |
</table> | |
-<p>:see also:<cite>func:shearStrainRate()</cite>,`func:shearVel()`</p> | |
+<p>See also: <a class="reference internal" href="#sphere.sim.shearStrainRate" … | |
</dd></dl> | |
<dl class="method"> | |
t@@ -1499,7 +1499,7 @@ between the chosen damping and the critical damping valu… | |
</tr> | |
</tbody> | |
</table> | |
-<p>:see also:<cite>func:setDampingTangential(gamma)</cite></p> | |
+<p>See also: <tt class="xref py py-func docutils literal"><span class="pre">se… | |
</dd></dl> | |
<dl class="method"> | |
t@@ -1516,7 +1516,7 @@ between the chosen damping and the critical damping valu… | |
</tr> | |
</tbody> | |
</table> | |
-<p>:see also:<cite>func:setDampingNormal(gamma)</cite></p> | |
+<p>See also: <tt class="xref py py-func docutils literal"><span class="pre">se… | |
</dd></dl> | |
<dl class="method"> | |
t@@ -1716,7 +1716,7 @@ displacement of the upper, fixed particles.</p> | |
</tr> | |
</tbody> | |
</table> | |
-<p>:see also:<cite>func:shearStrainRate()</cite>,`func:shearVel()`</p> | |
+<p>See also: <a class="reference internal" href="#sphere.sim.shearStrainRate" … | |
</dd></dl> | |
<dl class="method"> | |
t@@ -1733,7 +1733,7 @@ displacement of the upper, fixed particles.</p> | |
</tr> | |
</tbody> | |
</table> | |
-<p>:see also:<cite>func:shearStrain()</cite>,`func:shearVel()`</p> | |
+<p>See also: <a class="reference internal" href="#sphere.sim.shearStrain" titl… | |
</dd></dl> | |
<dl class="method"> | |
t@@ -1752,7 +1752,7 @@ upper particles.</p> | |
</tr> | |
</tbody> | |
</table> | |
-<p>:see also:<cite>func:shearStrainRate()</cite>,`func:shearStrain()`</p> | |
+<p>See also: <a class="reference internal" href="#sphere.sim.shearStrainRate" … | |
</dd></dl> | |
<dl class="method"> | |
t@@ -2165,7 +2165,7 @@ resolution”) to increase the quality and the compu… | |
of the rendering. All adjustments by default require the “Apply” b… | |
to be pressed before regenerating the view.</p> | |
<p>If several vtu files are generated for the same simulation (e.g. using | |
-the :func:<tt class="docutils literal"><span class="pre">writeVTKall()</span><… | |
+the <a class="reference internal" href="#sphere.sim.writeVTKall" title="sphere… | |
visualization through time by using the ParaView controls.</p> | |
<table class="docutils field-list" frame="void" rules="none"> | |
<col class="field-name" /> | |
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,1,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@@ -1310,7 +1310,7 @@ class sim: | |
to be pressed before regenerating the view. | |
If several vtu files are generated for the same simulation (e.g. using | |
- the :func:``writeVTKall()`` function), it is able to step the | |
+ the :func:`writeVTKall()` function), it is able to step the | |
visualization through time by using the ParaView controls. | |
:param folder: The folder where to place the output binary file (defau… | |
t@@ -2835,7 +2835,7 @@ class sim: | |
:param gamma: The viscous damping constant [N/(m/s)] | |
:type gamma: float | |
- :see also:`func:setDampingTangential(gamma)` | |
+ See also: :func:`setDampingTangential(gamma)` | |
''' | |
self.gamma_n[0] = gamma | |
damping_ratio = gamma/(2.0*numpy.sqrt(self.smallestMass()*self.k_n[0])) | |
t@@ -2859,7 +2859,7 @@ class sim: | |
:param gamma: The viscous damping constant [N/(m/s)] | |
:type gamma: float | |
- :see also:`func:setDampingNormal(gamma)` | |
+ See also: :func:`setDampingNormal(gamma)` | |
''' | |
self.gamma_t[0] = gamma | |
damping_ratio = gamma/(2.0*numpy.sqrt(self.smallestMass()*self.k_t[0])) | |
t@@ -3469,7 +3469,7 @@ class sim: | |
:returns: The shear velocity applied by the upper, fixed particles [m/… | |
:return type: float | |
- :see also:`func:shearStrainRate()`,`func:shearStrain()` | |
+ See also: :func:`shearStrainRate()` and :func:`shearStrain()` | |
''' | |
# Find the fixed particles | |
t@@ -3487,7 +3487,7 @@ class sim: | |
:returns: The total shear strain [-] | |
:return type: float | |
- :see also:`func:shearStrainRate()`,`func:shearVel()` | |
+ See also: :func:`shearStrainRate()` and :func:`shearVel()` | |
''' | |
# Current height | |
t@@ -3506,7 +3506,7 @@ class sim: | |
:returns: The value of $I$ | |
:return type: float | |
- :see also:`func:shearStrain()`,`func:shearVel()` | |
+ See also: :func:`shearStrain()` and :func:`shearVel()` | |
''' | |
return self.shearStrain()/self.time_current[0] | |
t@@ -3518,7 +3518,7 @@ class sim: | |
:returns: The value of $I$ | |
:return type: float | |
- :see also:`func:shearStrainRate()`,`func:shearVel()` | |
+ See also: :func:`shearStrainRate()` and :func:`shearVel()` | |
''' | |
return self.shearStrainRate() * numpy.mean(self.radius) \ | |
* numpy.sqrt(self.rho[0]/self.w_devs[0]) |