trebuilt documentation - sphere - GPU-based 3D discrete element method algorith… | |
git clone git://src.adamsgaard.dk/sphere | |
Log | |
Files | |
Refs | |
LICENSE | |
--- | |
commit 85cb16e537cf83c60149c96f1b0f4a565382ef1c | |
parent f9bbc90bd68dfd3516e9e50bb9fd7333caf5f85c | |
Author: Anders Damsgaard <[email protected]> | |
Date: Fri, 20 Jun 2014 22:48:44 +0200 | |
rebuilt documentation | |
Diffstat: | |
M doc/html/genindex.html | 105 ++++++++++++++++++++++++++++-… | |
M doc/html/objects.inv | 0 | |
M doc/html/python_api.html | 314 ++++++++++++++++++++++++++++-… | |
M doc/html/searchindex.js | 4 ++-- | |
M doc/pdf/sphere.pdf | 0 | |
5 files changed, 391 insertions(+), 32 deletions(-) | |
--- | |
diff --git a/doc/html/genindex.html b/doc/html/genindex.html | |
t@@ -61,6 +61,9 @@ | |
| <a href="#F"><strong>F</strong></a> | |
| <a href="#G"><strong>G</strong></a> | |
| <a href="#I"><strong>I</strong></a> | |
+ | <a href="#K"><strong>K</strong></a> | |
+ | <a href="#L"><strong>L</strong></a> | |
+ | <a href="#M"><strong>M</strong></a> | |
| <a href="#N"><strong>N</strong></a> | |
| <a href="#P"><strong>P</strong></a> | |
| <a href="#R"><strong>R</strong></a> | |
t@@ -165,10 +168,14 @@ | |
<dt><a href="python_api.html#sphere.sim.defineWorldBoundaries">defineWorldBo… | |
</dt> | |
+ | |
+ <dt><a href="python_api.html#sphere.sim.deleteAllParticles">deleteAllParticl… | |
+ </dt> | |
+ | |
</dl></td> | |
<td style="width: 33%" valign="top"><dl> | |
- <dt><a href="python_api.html#sphere.sim.deleteAllParticles">deleteAllParticl… | |
+ <dt><a href="python_api.html#sphere.sim.deleteParticle">deleteParticle() (sp… | |
</dt> | |
t@@ -195,10 +202,14 @@ | |
<dt><a href="python_api.html#sphere.sim.forcechains">forcechains() (sphere.s… | |
</dt> | |
+ | |
+ <dt><a href="python_api.html#sphere.sim.forcechainsRose">forcechainsRose() (… | |
+ </dt> | |
+ | |
</dl></td> | |
<td style="width: 33%" valign="top"><dl> | |
- <dt><a href="python_api.html#sphere.sim.forcechainsRose">forcechainsRose() (… | |
+ <dt><a href="python_api.html#sphere.sim.frictionalEnergy">frictionalEnergy()… | |
</dt> | |
</dl></td> | |
t@@ -256,6 +267,46 @@ | |
</dl></td> | |
</tr></table> | |
+<h2 id="K">K</h2> | |
+<table style="width: 100%" class="indextable genindextable"><tr> | |
+ <td style="width: 33%" valign="top"><dl> | |
+ | |
+ <dt><a href="python_api.html#sphere.sim.kineticEnergy">kineticEnergy() (sphe… | |
+ </dt> | |
+ | |
+ </dl></td> | |
+</tr></table> | |
+ | |
+<h2 id="L">L</h2> | |
+<table style="width: 100%" class="indextable genindextable"><tr> | |
+ <td style="width: 33%" valign="top"><dl> | |
+ | |
+ <dt><a href="python_api.html#sphere.sim.largestMass">largestMass() (sphere.s… | |
+ </dt> | |
+ | |
+ </dl></td> | |
+</tr></table> | |
+ | |
+<h2 id="M">M</h2> | |
+<table style="width: 100%" class="indextable genindextable"><tr> | |
+ <td style="width: 33%" valign="top"><dl> | |
+ | |
+ <dt><a href="python_api.html#sphere.sim.mass">mass() (sphere.sim method)</a> | |
+ </dt> | |
+ | |
+ | |
+ <dt><a href="python_api.html#sphere.sim.momentOfInertia">momentOfInertia() (… | |
+ </dt> | |
+ | |
+ </dl></td> | |
+ <td style="width: 33%" valign="top"><dl> | |
+ | |
+ <dt><a href="python_api.html#sphere.sim.momentum">momentum() (sphere.sim met… | |
+ </dt> | |
+ | |
+ </dl></td> | |
+</tr></table> | |
+ | |
<h2 id="N">N</h2> | |
<table style="width: 100%" class="indextable genindextable"><tr> | |
<td style="width: 33%" valign="top"><dl> | |
t@@ -337,12 +388,12 @@ | |
<dt><a href="python_api.html#sphere.sim.readlast">readlast() (sphere.sim met… | |
</dt> | |
- </dl></td> | |
- <td style="width: 33%" valign="top"><dl> | |
<dt><a href="python_api.html#sphere.sim.readsecond">readsecond() (sphere.sim… | |
</dt> | |
+ </dl></td> | |
+ <td style="width: 33%" valign="top"><dl> | |
<dt><a href="python_api.html#sphere.sim.readstep">readstep() (sphere.sim met… | |
</dt> | |
t@@ -358,6 +409,10 @@ | |
</dl></dd> | |
+ <dt><a href="python_api.html#sphere.sim.rotationalEnergy">rotationalEnergy()… | |
+ </dt> | |
+ | |
+ | |
<dt><a href="python_api.html#sphere.run">run() (in module sphere)</a> | |
</dt> | |
t@@ -378,6 +433,14 @@ | |
</dt> | |
+ <dt><a href="python_api.html#sphere.sim.setDampingNormal">setDampingNormal()… | |
+ </dt> | |
+ | |
+ | |
+ <dt><a href="python_api.html#sphere.sim.setDampingTangential">setDampingTang… | |
+ </dt> | |
+ | |
+ | |
<dt><a href="python_api.html#sphere.sim.setDEMstepsPerCFDstep">setDEMstepsPe… | |
</dt> | |
t@@ -440,6 +503,10 @@ | |
</dt> | |
+ <dt><a href="python_api.html#sphere.sim.smallestMass">smallestMass() (sphere… | |
+ </dt> | |
+ | |
+ | |
<dt><a href="python_api.html#module-sphere">sphere (module)</a> | |
</dt> | |
t@@ -471,10 +538,18 @@ | |
<dt><a href="python_api.html#sphere.sim.torqueScript">torqueScript() (sphere… | |
</dt> | |
+ | |
+ <dt><a href="python_api.html#sphere.torqueScriptParallel3">torqueScriptParal… | |
+ </dt> | |
+ | |
+ | |
+ <dt><a href="python_api.html#sphere.sim.totalFrictionalEnergy">totalFriction… | |
+ </dt> | |
+ | |
</dl></td> | |
<td style="width: 33%" valign="top"><dl> | |
- <dt><a href="python_api.html#sphere.torqueScriptParallel3">torqueScriptParal… | |
+ <dt><a href="python_api.html#sphere.sim.totalKineticEnergy">totalKineticEner… | |
</dt> | |
t@@ -482,6 +557,14 @@ | |
</dt> | |
+ <dt><a href="python_api.html#sphere.sim.totalRotationalEnergy">totalRotation… | |
+ </dt> | |
+ | |
+ | |
+ <dt><a href="python_api.html#sphere.sim.totalViscousEnergy">totalViscousEner… | |
+ </dt> | |
+ | |
+ | |
<dt><a href="python_api.html#sphere.sim.triaxial">triaxial() (sphere.sim met… | |
</dt> | |
t@@ -506,10 +589,6 @@ | |
</dt> | |
- <dt><a href="python_api.html#sphere.vector_norm">vector_norm() (in module sp… | |
- </dt> | |
- | |
- | |
<dt><a href="python_api.html#sphere.video">video() (in module sphere)</a> | |
</dt> | |
t@@ -519,6 +598,10 @@ | |
</dt> | |
</dl></dd> | |
+ | |
+ <dt><a href="python_api.html#sphere.sim.viscousEnergy">viscousEnergy() (sphe… | |
+ </dt> | |
+ | |
</dl></td> | |
<td style="width: 33%" valign="top"><dl> | |
t@@ -529,6 +612,10 @@ | |
<dt><a href="python_api.html#sphere.sim.voidRatio">voidRatio() (sphere.sim m… | |
</dt> | |
+ | |
+ <dt><a href="python_api.html#sphere.sim.volume">volume() (sphere.sim method)… | |
+ </dt> | |
+ | |
</dl></td> | |
</tr></table> | |
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@@ -328,7 +328,7 @@ are returned.</p> | |
<dl class="method"> | |
<dt id="sphere.sim.addParticle"> | |
-<tt class="descname">addParticle</tt><big>(</big><em>x</em>, <em>radius</em>, … | |
+<tt class="descname">addParticle</tt><big>(</big><em>x</em>, <em>radius</em>, … | |
<dd><p>Add a single particle to the simulation object. The only required | |
parameters are the position (x) and the radius (radius).</p> | |
<table class="docutils field-list" frame="void" rules="none"> | |
t@@ -587,6 +587,20 @@ won’t work. Default = [0.0, 0.0, 0.0].</li> | |
</dd></dl> | |
<dl class="method"> | |
+<dt id="sphere.sim.deleteParticle"> | |
+<tt class="descname">deleteParticle</tt><big>(</big><em>i</em><big>)</big><a c… | |
+<dd><p>Delete particle with index <tt class="docutils literal"><span class="pr… | |
+<table class="docutils field-list" frame="void" rules="none"> | |
+<col class="field-name" /> | |
+<col class="field-body" /> | |
+<tbody valign="top"> | |
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="… | |
+</tr> | |
+</tbody> | |
+</table> | |
+</dd></dl> | |
+ | |
+<dl class="method"> | |
<dt id="sphere.sim.disableFluidPressureModulation"> | |
<tt class="descname">disableFluidPressureModulation</tt><big>(</big><big>)</bi… | |
<dd><p>Set the parameters for the sine wave modulating the fluid pressures | |
t@@ -665,6 +679,24 @@ contact force magnitude, in ]0;1[</li> | |
</dd></dl> | |
<dl class="method"> | |
+<dt id="sphere.sim.frictionalEnergy"> | |
+<tt class="descname">frictionalEnergy</tt><big>(</big><em>idx</em><big>)</big>… | |
+<dd><p>Returns the frictional dissipated energy for a particle.</p> | |
+<table class="docutils field-list" frame="void" rules="none"> | |
+<col class="field-name" /> | |
+<col class="field-body" /> | |
+<tbody valign="top"> | |
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="… | |
+</tr> | |
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="fi… | |
+</tr> | |
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class=… | |
+</tr> | |
+</tbody> | |
+</table> | |
+</dd></dl> | |
+ | |
+<dl class="method"> | |
<dt id="sphere.sim.generateBimodalRadii"> | |
<tt class="descname">generateBimodalRadii</tt><big>(</big><em>r_small=0.005</e… | |
<dd><p>Draw random radii from two distinct sizes.</p> | |
t@@ -841,7 +873,7 @@ make space for their radii within the bounding box.</p> | |
<dl class="method"> | |
<dt id="sphere.sim.initTemporal"> | |
-<tt class="descname">initTemporal</tt><big>(</big><em>total</em>, <em>current=… | |
+<tt class="descname">initTemporal</tt><big>(</big><em>total</em>, <em>current=… | |
<dd><p>Set temporal parameters for the simulation. <em>Important</em>: Particl… | |
physical parameters, and the optional fluid grid need to be set prior to | |
these if the computational time step (dt) isn’t set explicitly. If the | |
t@@ -858,6 +890,7 @@ included.</p> | |
<li><strong>current</strong> – The current time [s] (default = 0.0 s)</l… | |
<li><strong>file_dt</strong> – The interval between output files [s] (de… | |
<li><strong>dt</strong> – The computational time step length [s]</li> | |
+<li><strong>epsilon</strong> (<em>float</em>) – Time step multiplier (de… | |
</ul> | |
</td> | |
</tr> | |
t@@ -869,6 +902,96 @@ included.</p> | |
</dd></dl> | |
<dl class="method"> | |
+<dt id="sphere.sim.kineticEnergy"> | |
+<tt class="descname">kineticEnergy</tt><big>(</big><em>idx</em><big>)</big><a … | |
+<dd><p>Returns the (linear) kinetic energy for a particle.</p> | |
+<table class="docutils field-list" frame="void" rules="none"> | |
+<col class="field-name" /> | |
+<col class="field-body" /> | |
+<tbody valign="top"> | |
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="… | |
+</tr> | |
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="fi… | |
+</tr> | |
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class=… | |
+</tr> | |
+</tbody> | |
+</table> | |
+</dd></dl> | |
+ | |
+<dl class="method"> | |
+<dt id="sphere.sim.largestMass"> | |
+<tt class="descname">largestMass</tt><big>(</big><big>)</big><a class="headerl… | |
+<dd><p>Returns the mass of the heaviest particle.</p> | |
+<table class="docutils field-list" frame="void" rules="none"> | |
+<col class="field-name" /> | |
+<col class="field-body" /> | |
+<tbody valign="top"> | |
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="… | |
+</tr> | |
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="fi… | |
+</tr> | |
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class=… | |
+</tr> | |
+</tbody> | |
+</table> | |
+</dd></dl> | |
+ | |
+<dl class="method"> | |
+<dt id="sphere.sim.mass"> | |
+<tt class="descname">mass</tt><big>(</big><em>idx</em><big>)</big><a class="he… | |
+<dd><p>Returns the mass of a particle.</p> | |
+<table class="docutils field-list" frame="void" rules="none"> | |
+<col class="field-name" /> | |
+<col class="field-body" /> | |
+<tbody valign="top"> | |
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="… | |
+</tr> | |
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="fi… | |
+</tr> | |
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class=… | |
+</tr> | |
+</tbody> | |
+</table> | |
+</dd></dl> | |
+ | |
+<dl class="method"> | |
+<dt id="sphere.sim.momentOfInertia"> | |
+<tt class="descname">momentOfInertia</tt><big>(</big><em>idx</em><big>)</big><… | |
+<dd><p>Returns the moment of inertia of a particle.</p> | |
+<table class="docutils field-list" frame="void" rules="none"> | |
+<col class="field-name" /> | |
+<col class="field-body" /> | |
+<tbody valign="top"> | |
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="… | |
+</tr> | |
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="fi… | |
+</tr> | |
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class=… | |
+</tr> | |
+</tbody> | |
+</table> | |
+</dd></dl> | |
+ | |
+<dl class="method"> | |
+<dt id="sphere.sim.momentum"> | |
+<tt class="descname">momentum</tt><big>(</big><em>idx</em><big>)</big><a class… | |
+<dd><p>Returns the momentum (m*v) of a particle.</p> | |
+<table class="docutils field-list" frame="void" rules="none"> | |
+<col class="field-name" /> | |
+<col class="field-body" /> | |
+<tbody valign="top"> | |
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="… | |
+</tr> | |
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="fi… | |
+</tr> | |
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class=… | |
+</tr> | |
+</tbody> | |
+</table> | |
+</dd></dl> | |
+ | |
+<dl class="method"> | |
<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> | |
t@@ -1223,6 +1346,24 @@ tracer to this image format using Imagemagick</li> | |
</dd></dl> | |
<dl class="method"> | |
+<dt id="sphere.sim.rotationalEnergy"> | |
+<tt class="descname">rotationalEnergy</tt><big>(</big><em>idx</em><big>)</big>… | |
+<dd><p>Returns the rotational energy for a particle.</p> | |
+<table class="docutils field-list" frame="void" rules="none"> | |
+<col class="field-name" /> | |
+<col class="field-body" /> | |
+<tbody valign="top"> | |
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="… | |
+</tr> | |
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="fi… | |
+</tr> | |
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class=… | |
+</tr> | |
+</tbody> | |
+</table> | |
+</dd></dl> | |
+ | |
+<dl class="method"> | |
<dt id="sphere.sim.run"> | |
<tt class="descname">run</tt><big>(</big><em>verbose=True</em>, <em>hideinputf… | |
<dd><p>Start <tt class="docutils literal"><span class="pre">sphere</span></tt>… | |
t@@ -1285,6 +1426,40 @@ number of DEM time steps to be performed per CFD time s… | |
</dd></dl> | |
<dl class="method"> | |
+<dt id="sphere.sim.setDampingNormal"> | |
+<tt class="descname">setDampingNormal</tt><big>(</big><em>gamma</em><big>)</bi… | |
+<dd><p>Set the dampening coefficient (gamma) in the normal direction of the | |
+particle-particle contact model. The function will print the fraction | |
+between the chosen damping and the critical damping value.</p> | |
+<table class="docutils field-list" frame="void" rules="none"> | |
+<col class="field-name" /> | |
+<col class="field-body" /> | |
+<tbody valign="top"> | |
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="… | |
+</tr> | |
+</tbody> | |
+</table> | |
+<p>:see also:<cite>func:setDampingTangential(gamma)</cite></p> | |
+</dd></dl> | |
+ | |
+<dl class="method"> | |
+<dt id="sphere.sim.setDampingTangential"> | |
+<tt class="descname">setDampingTangential</tt><big>(</big><em>gamma</em><big>)… | |
+<dd><p>Set the dampening coefficient (gamma) in the tangential direction of the | |
+particle-particle contact model. The function will print the fraction | |
+between the chosen damping and the critical damping value.</p> | |
+<table class="docutils field-list" frame="void" rules="none"> | |
+<col class="field-name" /> | |
+<col class="field-body" /> | |
+<tbody valign="top"> | |
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="… | |
+</tr> | |
+</tbody> | |
+</table> | |
+<p>:see also:<cite>func:setDampingNormal(gamma)</cite></p> | |
+</dd></dl> | |
+ | |
+<dl class="method"> | |
<dt id="sphere.sim.setFluidBottomFixedPressure"> | |
<tt class="descname">setFluidBottomFixedPressure</tt><big>(</big><big>)</big><… | |
<dd><p>Set the lower boundary of the fluid domain to follow the fixed pressure | |
t@@ -1349,7 +1524,7 @@ values. The epsilon (pressure) values are smoothed by in… | |
average epsilon value of the six closest (face) neighbor cells. This | |
parameter should be in the range [0.0;1.0[. The higher the value, the | |
more averaging is introduced. A value of 0.0 disables all averaging.</p> | |
-<p>The default and recommended value is 0.5.</p> | |
+<p>The default and recommended value is 0.0.</p> | |
<table class="docutils field-list" frame="void" rules="none"> | |
<col class="field-name" /> | |
<col class="field-body" /> | |
t@@ -1500,6 +1675,24 @@ file name ‘<simulation id>-sheardisp.<gr… | |
</dd></dl> | |
<dl class="method"> | |
+<dt id="sphere.sim.smallestMass"> | |
+<tt class="descname">smallestMass</tt><big>(</big><big>)</big><a class="header… | |
+<dd><p>Returns the mass of the leightest particle.</p> | |
+<table class="docutils field-list" frame="void" rules="none"> | |
+<col class="field-name" /> | |
+<col class="field-body" /> | |
+<tbody valign="top"> | |
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="… | |
+</tr> | |
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="fi… | |
+</tr> | |
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class=… | |
+</tr> | |
+</tbody> | |
+</table> | |
+</dd></dl> | |
+ | |
+<dl class="method"> | |
<dt id="sphere.sim.status"> | |
<tt class="descname">status</tt><big>(</big><big>)</big><a class="headerlink" … | |
<dd><p>Returns the current simulation status by using the simulation id | |
t@@ -1586,6 +1779,36 @@ folder</li> | |
</dd></dl> | |
<dl class="method"> | |
+<dt id="sphere.sim.totalFrictionalEnergy"> | |
+<tt class="descname">totalFrictionalEnergy</tt><big>(</big><big>)</big><a clas… | |
+<dd><p>Returns the total frictional dissipated energy for all particles.</p> | |
+<table class="docutils field-list" frame="void" rules="none"> | |
+<col class="field-name" /> | |
+<col class="field-body" /> | |
+<tbody valign="top"> | |
+<tr class="field-odd field"><th class="field-name">Returns:</th><td class="fie… | |
+</tr> | |
+<tr class="field-even field"><th class="field-name">Return type:</th><td class… | |
+</tr> | |
+</tbody> | |
+</table> | |
+</dd></dl> | |
+ | |
+<dl class="method"> | |
+<dt id="sphere.sim.totalKineticEnergy"> | |
+<tt class="descname">totalKineticEnergy</tt><big>(</big><big>)</big><a class="… | |
+<dd><p>Returns the total linear kinetic energy for all particles.</p> | |
+<table class="docutils field-list" frame="void" rules="none"> | |
+<col class="field-name" /> | |
+<col class="field-body" /> | |
+<tbody valign="top"> | |
+<tr class="field-odd field"><th class="field-name">Returns:</th><td class="fie… | |
+</tr> | |
+</tbody> | |
+</table> | |
+</dd></dl> | |
+ | |
+<dl class="method"> | |
<dt id="sphere.sim.totalMomentum"> | |
<tt class="descname">totalMomentum</tt><big>(</big><big>)</big><a class="heade… | |
<dd><p>Returns the sum of particle momentums.</p> | |
t@@ -1595,6 +1818,36 @@ folder</li> | |
<tbody valign="top"> | |
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="fie… | |
</tr> | |
+<tr class="field-even field"><th class="field-name">Return type:</th><td class… | |
+</tr> | |
+</tbody> | |
+</table> | |
+</dd></dl> | |
+ | |
+<dl class="method"> | |
+<dt id="sphere.sim.totalRotationalEnergy"> | |
+<tt class="descname">totalRotationalEnergy</tt><big>(</big><big>)</big><a clas… | |
+<dd><p>Returns the total rotational kinetic energy for all particles.</p> | |
+<table class="docutils field-list" frame="void" rules="none"> | |
+<col class="field-name" /> | |
+<col class="field-body" /> | |
+<tbody valign="top"> | |
+<tr class="field-odd field"><th class="field-name">Returns:</th><td class="fie… | |
+</tr> | |
+</tbody> | |
+</table> | |
+</dd></dl> | |
+ | |
+<dl class="method"> | |
+<dt id="sphere.sim.totalViscousEnergy"> | |
+<tt class="descname">totalViscousEnergy</tt><big>(</big><big>)</big><a class="… | |
+<dd><p>Returns the total viscous dissipated energy for all particles.</p> | |
+<table class="docutils field-list" frame="void" rules="none"> | |
+<col class="field-name" /> | |
+<col class="field-body" /> | |
+<tbody valign="top"> | |
+<tr class="field-odd field"><th class="field-name">Returns:</th><td class="fie… | |
+</tr> | |
<tr class="field-even field"><th class="field-name">Return type:</th><td class… | |
</tr> | |
</tbody> | |
t@@ -1664,6 +1917,24 @@ rendered beforehand using func:<cite>render()</cite>.</… | |
</dd></dl> | |
<dl class="method"> | |
+<dt id="sphere.sim.viscousEnergy"> | |
+<tt class="descname">viscousEnergy</tt><big>(</big><em>idx</em><big>)</big><a … | |
+<dd><p>Returns the viscous dissipated energy for a particle.</p> | |
+<table class="docutils field-list" frame="void" rules="none"> | |
+<col class="field-name" /> | |
+<col class="field-body" /> | |
+<tbody valign="top"> | |
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="… | |
+</tr> | |
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="fi… | |
+</tr> | |
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class=… | |
+</tr> | |
+</tbody> | |
+</table> | |
+</dd></dl> | |
+ | |
+<dl class="method"> | |
<dt id="sphere.sim.visualize"> | |
<tt class="descname">visualize</tt><big>(</big><em>method='energy'</em>, <em>s… | |
<dd><p>Visualize output from the simulation, where the temporal progress is | |
t@@ -1704,6 +1975,24 @@ image format, or in text (‘txt’).</li> | |
</dd></dl> | |
<dl class="method"> | |
+<dt id="sphere.sim.volume"> | |
+<tt class="descname">volume</tt><big>(</big><em>idx</em><big>)</big><a class="… | |
+<dd><p>Returns the volume of a particle.</p> | |
+<table class="docutils field-list" frame="void" rules="none"> | |
+<col class="field-name" /> | |
+<col class="field-body" /> | |
+<tbody valign="top"> | |
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="… | |
+</tr> | |
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="fi… | |
+</tr> | |
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class=… | |
+</tr> | |
+</tbody> | |
+</table> | |
+</dd></dl> | |
+ | |
+<dl class="method"> | |
<dt id="sphere.sim.writeFluidVTK"> | |
<tt class="descname">writeFluidVTK</tt><big>(</big><em>folder='../output/'</em… | |
<dd><p>Writes a VTK file for the fluid grid to the <tt class="docutils literal… | |
t@@ -1798,7 +2087,7 @@ visualization through time by using the ParaView control… | |
<dl class="method"> | |
<dt id="sphere.sim.writeVTKall"> | |
-<tt class="descname">writeVTKall</tt><big>(</big><em>verbose=True</em><big>)</… | |
+<tt class="descname">writeVTKall</tt><big>(</big><em>cell_centered=True</em>, … | |
<dd><p>Writes a VTK file for each simulation output file with particle | |
information and the fluid grid to the <tt class="docutils literal"><span class… | |
The file name will be in the format <tt class="docutils literal"><span class="… | |
t@@ -1960,23 +2249,6 @@ in any order.</li> | |
</dd></dl> | |
<dl class="function"> | |
-<dt id="sphere.vector_norm"> | |
-<tt class="descclassname">sphere.</tt><tt class="descname">vector_norm</tt><bi… | |
-<dd><p>Returns a 1D vector of normalized values. The input array should have | |
-one row per particle, and three rows; one per Euclidean axis.</p> | |
-<table class="docutils field-list" frame="void" rules="none"> | |
-<col class="field-name" /> | |
-<col class="field-body" /> | |
-<tbody valign="top"> | |
-<tr class="field-odd field"><th class="field-name">Returns:</th><td class="fie… | |
-</tr> | |
-<tr class="field-even field"><th class="field-name">Return type:</th><td class… | |
-</tr> | |
-</tbody> | |
-</table> | |
-</dd></dl> | |
- | |
-<dl class="function"> | |
<dt id="sphere.video"> | |
<tt class="descclassname">sphere.</tt><tt class="descname">video</tt><big>(</b… | |
<dd><p>Uses ffmpeg to combine images to animation. All images should be | |
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. |