-
Notifications
You must be signed in to change notification settings - Fork 0
/
documentation.html
373 lines (261 loc) · 13 KB
/
documentation.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
<!-- THEME DEBUG -->
<!-- THEME HOOK: 'html' -->
<!-- FILE NAME SUGGESTIONS:
* html--node--7.html.twig
* html--node--%.html.twig
* html--node.html.twig
x html.html.twig
-->
<!-- BEGIN OUTPUT from 'core/themes/stable/templates/layout/html.html.twig' -->
<!DOCTYPE html>
<html lang="en" dir="ltr" prefix="content: http://purl.org/rss/1.0/modules/content/ dc: http://purl.org/dc/terms/ foaf: http://xmlns.com/foaf/0.1/ og: http://ogp.me/ns# rdfs: http://www.w3.org/2000/01/rdf-schema# schema: http://schema.org/ sioc: http://rdfs.org/sioc/ns# sioct: http://rdfs.org/sioc/types# skos: http://www.w3.org/2004/02/skos/core# xsd: http://www.w3.org/2001/XMLSchema# ">
<head>
<meta charset="utf-8" />
<meta name="Generator" content="Drupal 8 (https://www.drupal.org)" />
<meta name="MobileOptimized" content="width" />
<meta name="HandheldFriendly" content="true" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<link rel="shortcut icon" href="/core/misc/favicon.ico" type="image/vnd.microsoft.icon" />
<link rel="canonical" href="/documentation" />
<link rel="shortlink" href="/node/7" />
<link rel="revision" href="/documentation" />
<title>documentation | OpenFPM</title>
<link rel="stylesheet" href="core/themes/stable/css/system/components/ajax-progress.module.css" media="all" />
<link rel="stylesheet" href="core/themes/stable/css/system/components/align.module.css" media="all" />
<link rel="stylesheet" href="core/themes/stable/css/system/components/autocomplete-loading.module.css" media="all" />
<link rel="stylesheet" href="core/themes/stable/css/system/components/fieldgroup.module.css" media="all" />
<link rel="stylesheet" href="core/themes/stable/css/system/components/container-inline.module.css" media="all" />
<link rel="stylesheet" href="core/themes/stable/css/system/components/clearfix.module.css" media="all" />
<link rel="stylesheet" href="core/themes/stable/css/system/components/details.module.css" media="all" />
<link rel="stylesheet" href="core/themes/stable/css/system/components/hidden.module.css" media="all" />
<link rel="stylesheet" href="core/themes/stable/css/system/components/item-list.module.css" media="all" />
<link rel="stylesheet" href="core/themes/stable/css/system/components/js.module.css" media="all" />
<link rel="stylesheet" href="core/themes/stable/css/system/components/nowrap.module.css" media="all" />
<link rel="stylesheet" href="core/themes/stable/css/system/components/position-container.module.css" media="all" />
<link rel="stylesheet" href="core/themes/stable/css/system/components/progress.module.css" media="all" />
<link rel="stylesheet" href="core/themes/stable/css/system/components/reset-appearance.module.css" media="all" />
<link rel="stylesheet" href="core/themes/stable/css/system/components/resize.module.css" media="all" />
<link rel="stylesheet" href="core/themes/stable/css/system/components/sticky-header.module.css" media="all" />
<link rel="stylesheet" href="core/themes/stable/css/system/components/system-status-counter.css" media="all" />
<link rel="stylesheet" href="core/themes/stable/css/system/components/system-status-report-counters.css" media="all" />
<link rel="stylesheet" href="core/themes/stable/css/system/components/system-status-report-general-info.css" media="all" />
<link rel="stylesheet" href="core/themes/stable/css/system/components/tabledrag.module.css" media="all" />
<link rel="stylesheet" href="core/themes/stable/css/system/components/tablesort.module.css" media="all" />
<link rel="stylesheet" href="core/themes/stable/css/system/components/tree-child.module.css" media="all" />
<link rel="stylesheet" href="themes/custom/openfpm/assets/css/main.css" media="all" />
<!--[if lte IE 8]>
<script src="core/assets/vendor/html5shiv/html5shiv.min.js"></script>
<![endif]-->
</head>
<body>
<a href="#main-content" class="visually-hidden focusable">
Skip to main content
</a>
<!-- THEME DEBUG -->
<!-- THEME HOOK: 'off_canvas_page_wrapper' -->
<!-- BEGIN OUTPUT from 'core/themes/stable/templates/content/off-canvas-page-wrapper.html.twig' -->
<div class="dialog-off-canvas-main-canvas" data-off-canvas-main-canvas>
<!-- THEME DEBUG -->
<!-- THEME HOOK: 'page' -->
<!-- FILE NAME SUGGESTIONS:
* page--node--7.html.twig
* page--node--%.html.twig
* page--node.html.twig
x page.html.twig
-->
<!-- BEGIN OUTPUT from 'themes/custom/openfpm/page.html.twig' -->
<div class="layout-container">
<header role="banner" class="header-class">
<!-- THEME DEBUG -->
<!-- THEME HOOK: 'region' -->
<!-- FILE NAME SUGGESTIONS:
* region--header.html.twig
x region.html.twig
-->
<!-- BEGIN OUTPUT from 'core/themes/stable/templates/layout/region.html.twig' -->
<div>
<!-- THEME DEBUG -->
<!-- THEME HOOK: 'block' -->
<!-- FILE NAME SUGGESTIONS:
* block--openfpm-header-2.html.twig
* block--block-content--0b411ed8-50e6-4ed8-9b6d-2bc182b3d61e.html.twig
* block--block-content.html.twig
* block--block-content.html.twig
x block.html.twig
-->
<!-- BEGIN OUTPUT from 'core/themes/stable/templates/block/block.html.twig' -->
<div id="block-openfpm-header-2">
<!-- THEME DEBUG -->
<!-- THEME HOOK: 'field' -->
<!-- FILE NAME SUGGESTIONS:
* field--block-content--body--basic.html.twig
* field--block-content--body.html.twig
* field--block-content--basic.html.twig
* field--body.html.twig
* field--text-with-summary.html.twig
x field.html.twig
-->
<!-- BEGIN OUTPUT from 'core/themes/stable/templates/field/field.html.twig' -->
<div><div class="wrapper" id="header-wrapper">
<div id="header"><!-- Logo -->
<div id="logo">
<h1><a href="/" tabindex="-1">OpenFPM Simulations</a></h1>
<p>Open framework for particles and mesh simulations</p>
</div>
<!-- Nav -->
<nav id="nav"><ul><li class="current" style="white-space: nowrap;"><a href="/openfpm_website" tabindex="-1">Home</a></li>
<li style="white-space: nowrap;"><a href="install#intro-wrapper" tabindex="-1">Download/Install</a></li>
<li style="white-space: nowrap;"><a href="documentation#intro-wrapper" tabindex="-1">Documentation</a></li>
</ul></nav></div>
</div>
</div>
<!-- END OUTPUT from 'core/themes/stable/templates/field/field.html.twig' -->
</div>
<!-- END OUTPUT from 'core/themes/stable/templates/block/block.html.twig' -->
</div>
<!-- END OUTPUT from 'core/themes/stable/templates/layout/region.html.twig' -->
</header>
<main role="main">
<a id="main-content" tabindex="-1"></a>
<div class="layout-content">
<!-- THEME DEBUG -->
<!-- THEME HOOK: 'region' -->
<!-- FILE NAME SUGGESTIONS:
* region--content.html.twig
x region.html.twig
-->
<!-- BEGIN OUTPUT from 'core/themes/stable/templates/layout/region.html.twig' -->
<div>
<!-- THEME DEBUG -->
<!-- THEME HOOK: 'node' -->
<!-- FILE NAME SUGGESTIONS:
* node--7--full.html.twig
* node--7.html.twig
* node--page--full.html.twig
* node--page.html.twig
* node--full.html.twig
x node.html.twig
-->
<!-- BEGIN OUTPUT from 'core/themes/stable/templates/content/node.html.twig' -->
<article data-history-node-id="7" role="article" about="/documentation" typeof="schema:WebPage">
<!-- THEME DEBUG -->
<!-- THEME HOOK: 'rdf_metadata' -->
<!-- BEGIN OUTPUT from 'core/themes/stable/templates/misc/rdf-metadata.html.twig' -->
<span property="schema:name" content="documentation" class="hidden"></span>
<!-- END OUTPUT from 'core/themes/stable/templates/misc/rdf-metadata.html.twig' -->
<div>
<!-- THEME DEBUG -->
<!-- THEME HOOK: 'field' -->
<!-- FILE NAME SUGGESTIONS:
* field--node--body--page.html.twig
* field--node--body.html.twig
* field--node--page.html.twig
* field--body.html.twig
* field--text-with-summary.html.twig
x field.html.twig
-->
<!-- BEGIN OUTPUT from 'core/themes/stable/templates/field/field.html.twig' -->
<div property="schema:text"><!-- Intro -->
<div class="wrapper style2" id="intro-wrapper" style="background-color:Khaki; color=:#484d55">
<div class="title" style="background-color:Khaki;">Documentation</div>
<section class="container" id="intro"><p class="style2">Documentation</p>
<div style="text-align: left;">
<p class="style3">The best and fastest way to become productive with OpenFPM depend from your knowledge. When you have a C++ base knowledge we suggest to follow the examples. Starting from the simplest one, and using the API reference to know more or search for methods. If you do not have any knowledge of C++ and programming, we suggest to follow the video lessons before the examples</p>
<h2 class="h2_style3">Examples</h2>
<p class="style3">The examples can be downloaded <a href="http://ppmcore.mpi-cbg.de/upload/examples.tar.bz2">here</a>.<br />
In order to compile the examples, go into your OpenFPM installation directory ("/usr/local" is the default) and copy the file. Consider that the red part must be substituted with where you installed openfpm</p>
<pre>
tar -xf examples.tar.bz2
cp <font style="color: red;">/usr/local/</font>openfpm_pdata/include/example.mk .
source $HOME/openfpm_vars
make
</pre>
<p class="style3">The examples are grouped by data structure, each folder has a set of examples, the number is progressive based on level of complexity. The Makefile inside each example is simple to follow and can be used as a starting point to create your own makefile</p>
<h2 class="h2_style3">API Reference</h2>
<p class="style3">The API reference can be generated with</p>
<pre>
doxygen openfpm_pdata.doc
firefox doxygen/html/index.html
</pre>
<p class="style3">An online version can be founded <a href="http://ppmcore.mpi-cbg.de/doxygen/openfpm/index.html">here</a></p>
<h2 class="h2_style3">Video Lessons</h2>
<p class="style3">Our video lessons can be followed <a href="video_lessons">here</a></p>
<h2 class="h2_style3">Source search</h2>
<p class="style3">To do a fast text/C++ symbol/C++ definition search, use <a href="http://openfpm.mpi-cbg.de:8081/source/">this</a></p>
<h2 class="h2_style3">Source browser</h2>
<p class="style3">OpenFPM source code browser, <a href="http://openfpm.mpi-cbg.de/woboq/">this</a></p>
</div>
</section></div>
</div>
<!-- END OUTPUT from 'core/themes/stable/templates/field/field.html.twig' -->
<!-- THEME DEBUG -->
<!-- THEME HOOK: 'links__node' -->
<!-- FILE NAME SUGGESTIONS:
* links--node.html.twig
x links.html.twig
-->
<!-- BEGIN OUTPUT from 'core/themes/stable/templates/navigation/links.html.twig' -->
<!-- END OUTPUT from 'core/themes/stable/templates/navigation/links.html.twig' -->
</div>
</article>
<!-- END OUTPUT from 'core/themes/stable/templates/content/node.html.twig' -->
</div>
<!-- END OUTPUT from 'core/themes/stable/templates/layout/region.html.twig' -->
</div>
<div class="layout-content">
<!-- THEME DEBUG -->
<!-- THEME HOOK: 'region' -->
<!-- FILE NAME SUGGESTIONS:
* region--content2.html.twig
x region.html.twig
-->
<!-- BEGIN OUTPUT from 'core/themes/stable/templates/layout/region.html.twig' -->
<div>
<!-- THEME DEBUG -->
<!-- THEME HOOK: 'block' -->
<!-- FILE NAME SUGGESTIONS:
* block--openfpm-install.html.twig
* block--block-content--dae26765-5172-4b72-be6c-8a9ef4e47f93.html.twig
* block--block-content.html.twig
* block--block-content.html.twig
x block.html.twig
-->
<!-- BEGIN OUTPUT from 'core/themes/stable/templates/block/block.html.twig' -->
<div id="block-openfpm-install">
<!-- THEME DEBUG -->
<!-- THEME HOOK: 'field' -->
<!-- FILE NAME SUGGESTIONS:
* field--block-content--body--basic.html.twig
* field--block-content--body.html.twig
* field--block-content--basic.html.twig
* field--body.html.twig
* field--text-with-summary.html.twig
x field.html.twig
-->
<!-- BEGIN OUTPUT from 'core/themes/stable/templates/field/field.html.twig' -->
<div><script type="text/javascript" src="//ra.revolvermaps.com/0/0/3.js?i=0zooxjlfox9&b=0&s=21&m=2&cl=ffffff&co=010020&cd=aa0000&v0=60&v1=60&r=1" async="async"></script></div>
<!-- END OUTPUT from 'core/themes/stable/templates/field/field.html.twig' -->
</div>
<!-- END OUTPUT from 'core/themes/stable/templates/block/block.html.twig' -->
</div>
<!-- END OUTPUT from 'core/themes/stable/templates/layout/region.html.twig' -->
</div>
<div class="layout-content">
</div>
<div class="layout-content">
</div>
</main>
</div>
<!-- END OUTPUT from 'themes/custom/openfpm/page.html.twig' -->
</div>
<!-- END OUTPUT from 'core/themes/stable/templates/content/off-canvas-page-wrapper.html.twig' -->
<script src="core/assets/vendor/jquery/jquery.min.js"></script>
<script src="themes/custom/openfpm/assets/js/jquery.dropotron.min.js"></script>
<script src="themes/custom/openfpm/assets/js/skel.min.js"></script>
<script src="themes/custom/openfpm/assets/js/skel-viewport.min.js"></script>
<script src="themes/custom/openfpm/assets/js/util.js"></script>
<script src="themes/custom/openfpm/assets/js/main.js"></script>
<script src="themes/custom/openfpm/assets/js/jquery.vticker-min.js"></script>
</body>
</html>
<!-- END OUTPUT from 'core/themes/stable/templates/layout/html.html.twig' -->