tupdated documentation - 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 5e954ce11854447adc821e65b86db5272db6741f
DIR parent d03a9b038b20b6331d20f5f6c62cb4b910ac5d37
HTML Author: Anders Damsgaard <anders.damsgaard@geo.au.dk>
Date: Fri, 9 May 2014 11:01:11 +0200
updated documentation
Diffstat:
A doc/html/_images/math/e170ccb91735… | 0
M doc/html/_sources/cfd.txt | 2 +-
M doc/html/cfd.html | 4 ++--
M doc/html/objects.inv | 0
M doc/html/python_api.html | 15 ++++++++++++++-
M doc/html/searchindex.js | 4 ++--
M doc/pdf/sphere.pdf | 0
M doc/sphinx/cfd.rst | 2 +-
8 files changed, 20 insertions(+), 7 deletions(-)
---
DIR diff --git a/doc/html/_images/math/e170ccb91735f4ecee2e5ad7821bf13f8c888c12.png b/doc/html/_images/math/e170ccb91735f4ecee2e5ad7821bf13f8c888c12.png
Binary files differ.
DIR diff --git a/doc/html/_sources/cfd.txt b/doc/html/_sources/cfd.txt
t@@ -540,7 +540,7 @@ pressures and velocities:
.. math::
\bar{\boldsymbol{v}}^{t+\Delta t} =
- \bar{\boldsymbol{v}}^* - \frac{\Delta t}{\rho} \nabla \epsilon
+ \bar{\boldsymbol{v}}^* - \frac{\Delta t}{\rho\phi} \nabla \epsilon
Boundary conditions
DIR diff --git a/doc/html/cfd.html b/doc/html/cfd.html
t@@ -507,8 +507,8 @@ pressures and velocities:</p>
<div class="math">
<p><img src="_images/math/c15067d0b2458f2c3bfd62743d7309f7e48213f9.png" alt="\bar{p}^{t+\Delta t} = \beta \bar{p}^t + \epsilon"/></p>
</div><div class="math">
-<p><img src="_images/math/b55687e1799df2d682b5ba0c207ca16fa9c014fe.png" alt="\bar{\boldsymbol{v}}^{t+\Delta t} =
-\bar{\boldsymbol{v}}^* - \frac{\Delta t}{\rho} \nabla \epsilon"/></p>
+<p><img src="_images/math/e170ccb91735f4ecee2e5ad7821bf13f8c888c12.png" alt="\bar{\boldsymbol{v}}^{t+\Delta t} =
+\bar{\boldsymbol{v}}^* - \frac{\Delta t}{\rho\phi} \nabla \epsilon"/></p>
</div></div>
<div class="section" id="boundary-conditions">
<h2>Boundary conditions<a class="headerlink" href="#boundary-conditions" title="Permalink to this headline">¶</a></h2>
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@@ -1705,10 +1705,17 @@ image format, or in text (‘txt’).</li>
<dl class="method">
<dt id="sphere.sim.writeFluidVTK">
-<tt class="descname">writeFluidVTK</tt><big>(</big><em>folder='../output/'</em>, <em>verbose=True</em><big>)</big><a class="headerlink" href="#sphere.sim.writeFluidVTK" title="Permalink to this definition">¶</a></dt>
+<tt class="descname">writeFluidVTK</tt><big>(</big><em>folder='../output/'</em>, <em>cell_centered=True</em>, <em>verbose=True</em><big>)</big><a class="headerlink" href="#sphere.sim.writeFluidVTK" title="Permalink to this definition">¶</a></dt>
<dd><p>Writes a VTK file for the fluid grid to the <tt class="docutils literal"><span class="pre">../output/</span></tt> folder by
default. The file name will be in the format <tt class="docutils literal"><span class="pre">fluid-<self.sid>.vti</span></tt>.
The vti files can be used for visualizing the fluid in ParaView.</p>
+<p>The scalars (pressure, porosity, porosity change) and the velocity
+vectors are either placed in a grid where the grid corners correspond to
+the computational grid center (cell_centered = False). This results in a
+grid that doesn’t appears to span the simulation domain, and values are
+smoothly interpolated on the cell faces. Alternatively, the
+visualization grid is equal to the computational grid, and cells face
+colors are not interpolated (cell_centered = True, default behavior).</p>
<p>The fluid grid is visualized by opening the vti files, and pressing
“Apply” to import all fluid field properties. To visualize the scalar
fields, such as the pressure, the porosity, the porosity change or the
t@@ -1727,6 +1734,10 @@ that “Arrow” is selected as the “Glyph type”, and “
“Vectors” value. Adjust the “Maximum Number of Points” to be at least as
big as the number of fluid cells in the grid. Press “Apply” to visualize
the arrows.</p>
+<p>To visualize the cell-centered data with smooth interpolation, and in
+order to visualize fluid vector fields, the cell-centered mesh is
+selected in the “Pipeline Browser”, and is filtered using “Filters” ->
+“Alphabetical” -> “Cell Data to Point Data”.</p>
<p>If several data files are generated for the same simulation (e.g. using
the <a class="reference internal" href="#sphere.sim.writeVTKall" title="sphere.sim.writeVTKall"><tt class="xref py py-func docutils literal"><span class="pre">writeVTKall()</span></tt></a> function), it is able to step the
visualization through time by using the ParaView controls.</p>
t@@ -1737,6 +1748,8 @@ visualization through time by using the ParaView controls.</p>
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>folder</strong> (<em>str</em>) – The folder where to place the output binary file (default
(default = ‘../output/’)</li>
+<li><strong>cell_centered</strong> (<em>bool</em>) – put scalars and vectors at cell centers (True) or
+cell corners (False), (default = True)</li>
<li><strong>verbose</strong> (<em>bool</em>) – Show diagnostic information (default = True)</li>
</ul>
</td>
DIR diff --git a/doc/html/searchindex.js b/doc/html/searchindex.js
t@@ -1 +1 @@
mx1.adamsgaard.dk:70 /src/sphere/commit/5e954ce11854447adc821e65b86db5272db6741f.gph:95: line too long