tindex.html - sphere - GPU-based 3D discrete element method algorithm with optional fluid coupling
(HTM) git clone git://src.adamsgaard.dk/sphere
(DIR) Log
(DIR) Files
(DIR) Refs
(DIR) LICENSE
---
tindex.html (8758B)
---
1
2 <!DOCTYPE html>
3
4 <html xmlns="http://www.w3.org/1999/xhtml">
5 <head>
6 <meta charset="utf-8" />
7 <title>The sphere documentation — sphere 2.15-beta documentation</title>
8 <link rel="stylesheet" href="_static/classic.css" type="text/css" />
9 <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
10
11 <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
12 <script type="text/javascript" src="_static/jquery.js"></script>
13 <script type="text/javascript" src="_static/underscore.js"></script>
14 <script type="text/javascript" src="_static/doctools.js"></script>
15 <script type="text/javascript" src="_static/language_data.js"></script>
16
17 <link rel="index" title="Index" href="genindex.html" />
18 <link rel="search" title="Search" href="search.html" />
19 <link rel="next" title="Introduction and Installation" href="introduction.html" />
20 </head><body>
21 <div class="related" role="navigation" aria-label="related navigation">
22 <h3>Navigation</h3>
23 <ul>
24 <li class="right" style="margin-right: 10px">
25 <a href="genindex.html" title="General Index"
26 accesskey="I">index</a></li>
27 <li class="right" >
28 <a href="py-modindex.html" title="Python Module Index"
29 >modules</a> |</li>
30 <li class="right" >
31 <a href="introduction.html" title="Introduction and Installation"
32 accesskey="N">next</a> |</li>
33 <li class="nav-item nav-item-0"><a href="#">sphere 2.15-beta documentation</a> »</li>
34 </ul>
35 </div>
36
37 <div class="document">
38 <div class="documentwrapper">
39 <div class="bodywrapper">
40 <div class="body" role="main">
41
42 <div class="section" id="the-sphere-documentation">
43 <h1>The sphere documentation<a class="headerlink" href="#the-sphere-documentation" title="Permalink to this headline">¶</a></h1>
44 <p>This is the official documentation for the <code class="docutils literal notranslate"><span class="pre">sphere</span></code> discrete element modelling
45 software. This document aims at guiding the installation process, documenting
46 the usage, and explaining the relevant theory.</p>
47 <p><code class="docutils literal notranslate"><span class="pre">sphere</span></code> is developed by Anders Damsgaard as part as his Ph.D. project, under
48 supervision of David Lundbek Egholm and Jan A. Piotrowski, all of the Department
49 of Geoscience, Aarhus University, Denmark. The author welcomes interested third
50 party developers. This document is a work in progress.</p>
51 <p>Contact: Anders Damsgaard, <a class="reference external" href="https://adamsgaard.dk">https://adamsgaard.dk</a>,
52 <a class="reference external" href="mailto:anders.damsgaard%40geo.au.dk">mailto:anders<span>.</span>damsgaard<span>@</span>geo<span>.</span>au<span>.</span>dk</a></p>
53 <div class="section" id="contents">
54 <h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline">¶</a></h2>
55 <div class="toctree-wrapper compound">
56 <ul>
57 <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction and Installation</a><ul>
58 <li class="toctree-l2"><a class="reference internal" href="introduction.html#requirements">Requirements</a></li>
59 <li class="toctree-l2"><a class="reference internal" href="introduction.html#obtaining-sphere">Obtaining sphere</a></li>
60 <li class="toctree-l2"><a class="reference internal" href="introduction.html#building-sphere">Building <code class="docutils literal notranslate"><span class="pre">sphere</span></code></a></li>
61 <li class="toctree-l2"><a class="reference internal" href="introduction.html#updating-sphere">Updating sphere</a></li>
62 <li class="toctree-l2"><a class="reference internal" href="introduction.html#work-flow">Work flow</a></li>
63 </ul>
64 </li>
65 <li class="toctree-l1"><a class="reference internal" href="dem.html">Discrete element method</a><ul>
66 <li class="toctree-l2"><a class="reference internal" href="dem.html#contact-search">Contact search</a></li>
67 <li class="toctree-l2"><a class="reference internal" href="dem.html#contact-interaction">Contact interaction</a></li>
68 <li class="toctree-l2"><a class="reference internal" href="dem.html#temporal-integration">Temporal integration</a></li>
69 </ul>
70 </li>
71 <li class="toctree-l1"><a class="reference internal" href="cfd.html">Fluid simulation and particle-fluid interaction</a><ul>
72 <li class="toctree-l2"><a class="reference internal" href="cfd.html#derivation-of-the-navier-stokes-equations-with-porosity">Derivation of the Navier Stokes equations with porosity</a></li>
73 <li class="toctree-l2"><a class="reference internal" href="cfd.html#porosity-estimation">Porosity estimation</a></li>
74 <li class="toctree-l2"><a class="reference internal" href="cfd.html#particle-fluid-interaction">Particle-fluid interaction</a></li>
75 <li class="toctree-l2"><a class="reference internal" href="cfd.html#fluid-dynamics-solution-procedure-by-operator-splitting">Fluid dynamics solution procedure by operator splitting</a></li>
76 <li class="toctree-l2"><a class="reference internal" href="cfd.html#boundary-conditions">Boundary conditions</a></li>
77 <li class="toctree-l2"><a class="reference internal" href="cfd.html#numerical-implementation">Numerical implementation</a></li>
78 </ul>
79 </li>
80 <li class="toctree-l1"><a class="reference internal" href="python_api.html">Python API</a><ul>
81 <li class="toctree-l2"><a class="reference internal" href="python_api.html#sample-usage">Sample usage</a></li>
82 <li class="toctree-l2"><a class="reference internal" href="python_api.html#module-sphere">The <code class="docutils literal notranslate"><span class="pre">sphere</span></code> module</a></li>
83 </ul>
84 </li>
85 <li class="toctree-l1"><a class="reference internal" href="sphere_internals.html">sphere internals</a><ul>
86 <li class="toctree-l2"><a class="reference internal" href="sphere_internals.html#numerical-algorithm">Numerical algorithm</a></li>
87 <li class="toctree-l2"><a class="reference internal" href="sphere_internals.html#c-reference">C++ reference</a></li>
88 </ul>
89 </li>
90 </ul>
91 </div>
92 </div>
93 <div class="section" id="indices-and-tables">
94 <h2>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h2>
95 <ul class="simple">
96 <li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
97 <li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
98 </ul>
99 </div>
100 </div>
101
102
103 </div>
104 </div>
105 </div>
106 <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
107 <div class="sphinxsidebarwrapper">
108 <h3><a href="#">Table of Contents</a></h3>
109 <ul>
110 <li><a class="reference internal" href="#">The sphere documentation</a><ul>
111 <li><a class="reference internal" href="#contents">Contents</a></li>
112 <li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
113 </ul>
114 </li>
115 </ul>
116
117 <h4>Next topic</h4>
118 <p class="topless"><a href="introduction.html"
119 title="next chapter">Introduction and Installation</a></p>
120 <div role="note" aria-label="source link">
121 <h3>This Page</h3>
122 <ul class="this-page-menu">
123 <li><a href="_sources/index.rst.txt"
124 rel="nofollow">Show Source</a></li>
125 </ul>
126 </div>
127 <div id="searchbox" style="display: none" role="search">
128 <h3 id="searchlabel">Quick search</h3>
129 <div class="searchformwrapper">
130 <form class="search" action="search.html" method="get">
131 <input type="text" name="q" aria-labelledby="searchlabel" />
132 <input type="submit" value="Go" />
133 </form>
134 </div>
135 </div>
136 <script type="text/javascript">$('#searchbox').show(0);</script>
137 </div>
138 </div>
139 <div class="clearer"></div>
140 </div>
141 <div class="related" role="navigation" aria-label="related navigation">
142 <h3>Navigation</h3>
143 <ul>
144 <li class="right" style="margin-right: 10px">
145 <a href="genindex.html" title="General Index"
146 >index</a></li>
147 <li class="right" >
148 <a href="py-modindex.html" title="Python Module Index"
149 >modules</a> |</li>
150 <li class="right" >
151 <a href="introduction.html" title="Introduction and Installation"
152 >next</a> |</li>
153 <li class="nav-item nav-item-0"><a href="#">sphere 2.15-beta documentation</a> »</li>
154 </ul>
155 </div>
156 <div class="footer" role="contentinfo">
157 © Copyright 2014, Anders Damsgaard.
158 Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.2.0.
159 </div>
160 </body>
161