tupdated documentation - sphere - GPU-based 3D discrete element method algorith… | |
git clone git://src.adamsgaard.dk/sphere | |
Log | |
Files | |
Refs | |
LICENSE | |
--- | |
commit 45dae0d7df32bf24406dfc860e2c3f806f571413 | |
parent 06df2fb69034c673e2ff6c2fe0411f46ea597d9e | |
Author: Anders Damsgaard <[email protected]> | |
Date: Wed, 2 Apr 2014 09:18:38 +0200 | |
updated documentation | |
Diffstat: | |
M doc/html/genindex.html | 2 +- | |
M doc/html/objects.inv | 10 ++++------ | |
M doc/html/python_api.html | 85 +++++++++++++++++++----------… | |
M doc/html/searchindex.js | 4 ++-- | |
M doc/pdf/sphere.pdf | 0 | |
5 files changed, 59 insertions(+), 42 deletions(-) | |
--- | |
diff --git a/doc/html/genindex.html b/doc/html/genindex.html | |
t@@ -498,7 +498,7 @@ | |
</dl></td> | |
<td style="width: 33%" valign="top"><dl> | |
- <dt><a href="python_api.html#sphere.visualize">visualize() (in module sphere… | |
+ <dt><a href="python_api.html#sphere.sim.visualize">visualize() (sphere.sim m… | |
</dt> | |
diff --git a/doc/html/objects.inv b/doc/html/objects.inv | |
t@@ -2,8 +2,6 @@ | |
# Project: sphere | |
# Version: 1.00 | |
# The remainder of this file is compressed using zlib. | |
-xڭ��N1��<E��TčiU�Uh(\��=�N뵷�8<}gw�JxB/%�ۻ������ �=s0G7� ��a… | |
-�,��2��"�5Rz}e<�a�F��J ��T�B�!�|�uyҸ"����ŠK��] | |
-��ҩ�@V�MA���9�צ�xN�L��p��B�"a���G���Xu��Pנ����xc"5��,.��]���^Q���lν�V… | |
-L��ˎ | |
-����IHX>$���L�Gg���_��'�%�����2ީ��l�C�3�1\�\_�[Mz�}Gōyv?��\�!�]�:… | |
-\ No newline at end of file | |
+xڭXMO1��+"�נ"n�H�"���@C�M� ;�����4��;��Z���z�?̼y�e��-o')�G+v… | |
+-@��V���p)�C���e�^ ��q$�8��i��2�:���G[�X�3J����3!2��0�Iֽf�V�R�����… | |
+ݷ:�ϕ�����T�3*K�,J�Q�RA���Z��M��>�v��8��]%���3�X{��wՃ��Mj��e��?^^… | |
+\ No newline at end of file | |
diff --git a/doc/html/python_api.html b/doc/html/python_api.html | |
t@@ -339,7 +339,9 @@ parameters are the position (x) and the radius (radius).</… | |
<li><strong>x</strong> (<em>numpy.array</em>) – A vector pointing to the… | |
<li><strong>radius</strong> (<em>float</em>) – The particle radius</li> | |
<li><strong>vel</strong> (<em>numpy.array</em>) – The particle linear ve… | |
-<li><strong>fixvel</strong> (<em>float</em>) – Fix horizontal linear vel… | |
+<li><strong>fixvel</strong> (<em>float</em>) – 0: Do not fix particle ve… | |
+horizontal linear velocity, -1: Fix horizontal and vertical linear | |
+velocity</li> | |
<li><strong>angpos</strong> (<em>numpy.array</em>) – The particle angula… | |
<li><strong>angvel</strong> (<em>numpy.array</em>) – The particle angula… | |
<li><strong>torque</strong> (<em>numpy.array</em>) – The particle torque… | |
t@@ -372,8 +374,13 @@ allow for wall movement.</td> | |
<dl class="method"> | |
<dt id="sphere.sim.adjustWall"> | |
-<tt class="descname">adjustWall</tt><big>(</big><em>idx</em>, <em>adjust=1.1</… | |
-<dd><p>Adjust grid and dynamic wall to max. particle position</p> | |
+<tt class="descname">adjustWall</tt><big>(</big><em>idx</em>, <em>adjust=1.1</… | |
+<dd><p>Adjust grid and dynamic wall to max. particle position. The wall | |
+thickness will by standard equal the maximum particle diameter. The | |
+density equals the particle density, and the wall size is equal to the | |
+width and depth of the simulation domain (<cite>self.L[0]</cite> and <cite>sel… | |
+The total wall mass can be linearly scaled by the <cite>wall_mass_factor</cite> | |
+parameter.</p> | |
<table class="docutils field-list" frame="void" rules="none"> | |
<col class="field-name" /> | |
<col class="field-body" /> | |
t@@ -387,6 +394,7 @@ allow for wall movement.</td> | |
</tr> | |
</tbody> | |
</table> | |
+<p>:param</p> | |
</dd></dl> | |
<dl class="method"> | |
t@@ -704,7 +712,7 @@ value is <tt class="docutils literal"><span class="pre">un… | |
<dl class="method"> | |
<dt id="sphere.sim.initFluid"> | |
-<tt class="descname">initFluid</tt><big>(</big><em>mu=0.00089</em><big>)</big>… | |
+<tt class="descname">initFluid</tt><big>(</big><em>mu=0.00089</em>, <em>rho=10… | |
<dd><p>Initialize the fluid arrays and the fluid viscosity. The default value | |
of <tt class="docutils literal"><span class="pre">mu</span></tt> equals the dy… | |
The value for water at 0 degrees Celcius is 17.87e-4 kg/(m*s).</p> | |
t@@ -712,7 +720,18 @@ The value for water at 0 degrees Celcius is 17.87e-4 kg/(… | |
<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 class="field-odd field"><th class="field-name">Parameters:</th><td class="… | |
+<li><strong>mu</strong> (<em>float</em>) – The fluid dynamic viscosity [… | |
+<li><strong>rho</strong> (<em>float</em>) – The fluid density [kg/(m^3)]… | |
+<li><strong>p</strong> – The hydraulic pressure to initialize the cells … | |
+parameter <cite>hydrostatic</cite> is set to <cite>True</cite>, this value wil… | |
+the fluid cells at the top</li> | |
+<li><strong>hydrostatic</strong> (<em>bool</em>) – Initialize the fluid … | |
+pressure distribution. A pressure gradient with depth is only | |
+created if a gravitational acceleration along <img class="math" src="_images/m… | |
+has been specified</li> | |
+</ul> | |
+</td> | |
</tr> | |
</tbody> | |
</table> | |
t@@ -725,14 +744,14 @@ The value for water at 0 degrees Celcius is 17.87e-4 kg/… | |
The margin parameter adjusts the distance (in no. of max. radii) | |
from the particle boundaries. | |
<em>Important</em>: The particle radii have to be set beforehand if the cell | |
-width isn’t specified by <cite>dx</cite>. | |
-:param dx: The cell width in any direction. If the default value is used</p> | |
-<blockquote> | |
-<div>(-1), the cell width is calculated to fit the largest particle.</div></bl… | |
+width isn’t specified by <cite>dx</cite>.</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="… | |
+(-1), the cell width is calculated to fit the largest particle.</td> | |
+</tr> | |
</tbody> | |
</table> | |
</dd></dl> | |
t@@ -1580,6 +1599,30 @@ rendered beforehand using func:<cite>render()</cite>.</… | |
</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 | |
+of interest. The output will be saved in the current folder with a name | |
+combining the simulation id of the simulation, and the visualization | |
+method.</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="… | |
+<li><strong>method</strong> (<em>str</em>) – The type of plot to render.… | |
+‘walls’, ‘triaxial’ and ‘shear’</li> | |
+<li><strong>savefig</strong> (<em>bool</em>) – Save the image instead of… | |
+<li><strong>outformat</strong> – The output format of the plot data. Thi… | |
+image format, or in text (‘txt’).</li> | |
+</ul> | |
+</td> | |
+</tr> | |
+</tbody> | |
+</table> | |
+</dd></dl> | |
+ | |
+<dl class="method"> | |
<dt id="sphere.sim.voidRatio"> | |
<tt class="descname">voidRatio</tt><big>(</big><big>)</big><a class="headerlin… | |
<dd><p>Calculates the current void ratio</p> | |
t@@ -1881,30 +1924,6 @@ rendered beforehand using func:<cite>render()</cite>.</… | |
</table> | |
</dd></dl> | |
-<dl class="function"> | |
-<dt id="sphere.visualize"> | |
-<tt class="descclassname">sphere.</tt><tt class="descname">visualize</tt><big>… | |
-<dd><p>Visualize output from the target project, where the temporal progress i… | |
-interest. The output will be saved in the current folder with a name | |
-combining the simulation id of the project, and the visualization method.</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="… | |
-<li><strong>project</strong> (<em>str</em>) – The simulation id of the p… | |
-<li><strong>method</strong> (<em>str</em>) – The type of plot to render.… | |
-‘walls’, ‘triaxial’ and ‘shear’</li> | |
-<li><strong>savefig</strong> (<em>bool</em>) – Save the image instead of… | |
-<li><strong>outformat</strong> – The output format of the plot data. Thi… | |
-format, or in text (‘txt’).</li> | |
-</ul> | |
-</td> | |
-</tr> | |
-</tbody> | |
-</table> | |
-</dd></dl> | |
- | |
</div> | |
</div> | |
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,2,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. |