index.html - 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
---
index.html (10006B)
---
1 <!DOCTYPE html>
2
3 <html lang="en" data-content_root="./">
4 <head>
5 <meta charset="utf-8" />
6 <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
7
8 <title>The sphere documentation — sphere 2.15 documentation</title>
9 <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
10 <link rel="stylesheet" type="text/css" href="_static/classic.css?v=2bf1fcf8" />
11
12 <script src="_static/documentation_options.js?v=d19175c4"></script>
13 <script src="_static/doctools.js?v=fd6eb6e6"></script>
14 <script src="_static/sphinx_highlight.js?v=6ffebe34"></script>
15
16 <link rel="index" title="Index" href="genindex.html" />
17 <link rel="search" title="Search" href="search.html" />
18 <link rel="next" title="Quick start" href="quickstart.html" />
19 </head><body>
20 <div class="related" role="navigation" aria-label="Related">
21 <h3>Navigation</h3>
22 <ul>
23 <li class="right" style="margin-right: 10px">
24 <a href="genindex.html" title="General Index"
25 accesskey="I">index</a></li>
26 <li class="right" >
27 <a href="py-modindex.html" title="Python Module Index"
28 >modules</a> |</li>
29 <li class="right" >
30 <a href="quickstart.html" title="Quick start"
31 accesskey="N">next</a> |</li>
32 <li class="nav-item nav-item-0"><a href="#">sphere 2.15 documentation</a> »</li>
33 <li class="nav-item nav-item-this"><a href="">The sphere 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 <section id="the-sphere-documentation">
43 <h1>The sphere documentation<a class="headerlink" href="#the-sphere-documentation" title="Link to this heading">¶</a></h1>
44 <p><code class="docutils literal notranslate"><span class="pre">sphere</span></code> is a 3D DEM particle simulator with optional coupled fluid solvers.
45 The same source tree can be built for CUDA GPUs or OpenMP CPUs.</p>
46 <p>Start with <a class="reference internal" href="quickstart.html"><span class="doc">Quick start</span></a> for installation and build commands, then use the
47 model and API chapters for setup, execution, and analysis details.</p>
48 <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
49 supervision of David Lundbek Egholm and Jan A. Piotrowski, all of the Department
50 of Geoscience, Aarhus University, Denmark. The author welcomes interested third
51 party developers. This document is a work in progress.</p>
52 <p>Contact: Anders Damsgaard, <a class="reference external" href="https://adamsgaard.dk">https://adamsgaard.dk</a>,
53 <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>
54 <section id="contents">
55 <h2>Contents<a class="headerlink" href="#contents" title="Link to this heading">¶</a></h2>
56 <div class="toctree-wrapper compound">
57 <ul>
58 <li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quick start</a><ul>
59 <li class="toctree-l2"><a class="reference internal" href="quickstart.html#requirements">Requirements</a></li>
60 <li class="toctree-l2"><a class="reference internal" href="quickstart.html#build">Build</a></li>
61 <li class="toctree-l2"><a class="reference internal" href="quickstart.html#run-checks">Run checks</a></li>
62 <li class="toctree-l2"><a class="reference internal" href="quickstart.html#python-workflow">Python workflow</a></li>
63 <li class="toctree-l2"><a class="reference internal" href="quickstart.html#build-documentation">Build documentation</a></li>
64 </ul>
65 </li>
66 <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction</a><ul>
67 <li class="toctree-l2"><a class="reference internal" href="introduction.html#workflow">Workflow</a></li>
68 <li class="toctree-l2"><a class="reference internal" href="introduction.html#updating-sphere">Updating sphere</a></li>
69 </ul>
70 </li>
71 <li class="toctree-l1"><a class="reference internal" href="dem.html">Discrete element method</a><ul>
72 <li class="toctree-l2"><a class="reference internal" href="dem.html#contact-search">Contact search</a></li>
73 <li class="toctree-l2"><a class="reference internal" href="dem.html#contact-interaction">Contact interaction</a></li>
74 <li class="toctree-l2"><a class="reference internal" href="dem.html#temporal-integration">Temporal integration</a></li>
75 </ul>
76 </li>
77 <li class="toctree-l1"><a class="reference internal" href="cfd.html">Fluid simulation and particle-fluid interaction</a><ul>
78 <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>
79 <li class="toctree-l2"><a class="reference internal" href="cfd.html#porosity-estimation">Porosity estimation</a></li>
80 <li class="toctree-l2"><a class="reference internal" href="cfd.html#particle-fluid-interaction">Particle-fluid interaction</a></li>
81 <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>
82 <li class="toctree-l2"><a class="reference internal" href="cfd.html#boundary-conditions">Boundary conditions</a></li>
83 <li class="toctree-l2"><a class="reference internal" href="cfd.html#numerical-implementation">Numerical implementation</a></li>
84 </ul>
85 </li>
86 <li class="toctree-l1"><a class="reference internal" href="python_api.html">Python API</a><ul>
87 <li class="toctree-l2"><a class="reference internal" href="python_api.html#using-the-module">Using the module</a></li>
88 <li class="toctree-l2"><a class="reference internal" href="python_api.html#sample-usage">Sample usage</a></li>
89 <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>
90 </ul>
91 </li>
92 <li class="toctree-l1"><a class="reference internal" href="sphere_internals.html">Sphere internals</a><ul>
93 <li class="toctree-l2"><a class="reference internal" href="sphere_internals.html#command-line-interface">Command-line interface</a></li>
94 <li class="toctree-l2"><a class="reference internal" href="sphere_internals.html#execution-pipeline">Execution pipeline</a></li>
95 <li class="toctree-l2"><a class="reference internal" href="sphere_internals.html#numerical-algorithm">Numerical algorithm</a></li>
96 <li class="toctree-l2"><a class="reference internal" href="sphere_internals.html#memory-layout">Memory layout</a></li>
97 <li class="toctree-l2"><a class="reference internal" href="sphere_internals.html#performance">Performance</a></li>
98 <li class="toctree-l2"><a class="reference internal" href="sphere_internals.html#compilation">Compilation</a></li>
99 <li class="toctree-l2"><a class="reference internal" href="sphere_internals.html#c-reference">C++ reference</a></li>
100 </ul>
101 </li>
102 </ul>
103 </div>
104 </section>
105 <section id="indices-and-tables">
106 <h2>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Link to this heading">¶</a></h2>
107 <ul class="simple">
108 <li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
109 <li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
110 </ul>
111 </section>
112 </section>
113
114
115 <div class="clearer"></div>
116 </div>
117 </div>
118 </div>
119 <div class="sphinxsidebar" role="navigation" aria-label="Main">
120 <div class="sphinxsidebarwrapper">
121 <div>
122 <h3><a href="#">Table of Contents</a></h3>
123 <ul>
124 <li><a class="reference internal" href="#">The sphere documentation</a><ul>
125 <li><a class="reference internal" href="#contents">Contents</a></li>
126 <li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
127 </ul>
128 </li>
129 </ul>
130
131 </div>
132 <div>
133 <h4>Next topic</h4>
134 <p class="topless"><a href="quickstart.html"
135 title="next chapter">Quick start</a></p>
136 </div>
137 <div role="note" aria-label="source link">
138 <h3>This Page</h3>
139 <ul class="this-page-menu">
140 <li><a href="_sources/index.rst.txt"
141 rel="nofollow">Show Source</a></li>
142 </ul>
143 </div>
144 <search id="searchbox" style="display: none" role="search">
145 <h3 id="searchlabel">Quick search</h3>
146 <div class="searchformwrapper">
147 <form class="search" action="search.html" method="get">
148 <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
149 <input type="submit" value="Go" />
150 </form>
151 </div>
152 </search>
153 <script>document.getElementById('searchbox').style.display = "block"</script>
154 </div>
155 </div>
156 <div class="clearer"></div>
157 </div>
158 <div class="related" role="navigation" aria-label="Related">
159 <h3>Navigation</h3>
160 <ul>
161 <li class="right" style="margin-right: 10px">
162 <a href="genindex.html" title="General Index"
163 >index</a></li>
164 <li class="right" >
165 <a href="py-modindex.html" title="Python Module Index"
166 >modules</a> |</li>
167 <li class="right" >
168 <a href="quickstart.html" title="Quick start"
169 >next</a> |</li>
170 <li class="nav-item nav-item-0"><a href="#">sphere 2.15 documentation</a> »</li>
171 <li class="nav-item nav-item-this"><a href="">The sphere documentation</a></li>
172 </ul>
173 </div>
174 <div class="footer" role="contentinfo">
175 © Copyright 2014, Anders Damsgaard.
176 Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 9.1.0.
177 </div>
178 </body>
179