-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathindex.html
187 lines (169 loc) · 10.5 KB
/
index.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
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>FBPIC documentation — FBPIC 0.26.0 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="_static/documentation_options.js?v=4aa2dafa"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Overview of the code" href="overview/overview.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="#" class="icon icon-home">
FBPIC
</a>
<div class="version">
0.26.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<li class="toctree-l1"><a class="reference internal" href="overview/overview.html">Overview of the code</a></li>
<li class="toctree-l1"><a class="reference internal" href="install/installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="how_to_run.html">How to run the code</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_reference/api_reference.html">API reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="advanced/advanced.html">Advanced use</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="#">FBPIC</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="#" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">FBPIC documentation</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/index.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="fbpic-documentation">
<h1>FBPIC documentation<a class="headerlink" href="#fbpic-documentation" title="Link to this heading">¶</a></h1>
<p>FBPIC (Fourier-Bessel Particle-In-Cell) is a <a class="reference external" href="http://en.wikipedia.org/wiki/Particle-in-cell">Particle-In-Cell (PIC)
code</a> for
relativistic plasma
physics. It is especially well-suited for physical simulations of <strong>laser-wakefield acceleration</strong> and <strong>plasma-wakefield acceleration</strong>.</p>
<p>The distinctive feature of FBPIC, compared to <em>most</em> other PIC codes, is to use
a <strong>spectral cylindrical representation.</strong> This makes the code both <strong>fast</strong>
and <strong>accurate</strong>, for situations with <strong>close-to-cylindrical
symmetry</strong>. For a brief overview of the
algorithm, its advantages and limitations, see the section <a class="reference internal" href="overview/overview.html"><span class="doc">Overview of the code</span></a>.</p>
<p>In addition, FBPIC implements several <strong>useful features for laser-plasma acceleration</strong>, including:</p>
<blockquote>
<div><ul class="simple">
<li><p>Moving window</p></li>
<li><p>Calculation of <strong>space-charge fields</strong> at the beginning of the simulation</p></li>
<li><p>Intrinsic <strong>mitigation of Numerical Cherenkov Radiation</strong> (NCR) from relativistic bunches</p></li>
<li><p><strong>Field ionization</strong> module (ADK model)</p></li>
<li><p>Support for <strong>boosted-frame simulations</strong> (see <a class="reference internal" href="advanced/boosted_frame.html"><span class="doc">Running boosted-frame simulations</span></a>)</p></li>
</ul>
</div></blockquote>
<p>FBPIC can run on <strong>multi-core CPU</strong> (with multi-threading) or <strong>GPU</strong>. For large
simulations, running the code on GPU can be much faster than on CPU.</p>
<section id="contents-of-the-documentation">
<h2>Contents of the documentation<a class="headerlink" href="#contents-of-the-documentation" title="Link to this heading">¶</a></h2>
<p>If you are new to FBPIC, we <strong>strongly recommend</strong> that you read the
section <a class="reference internal" href="overview/overview.html"><span class="doc">Overview of the code</span></a> first, so as to have a basic understanding of
what the code does.</p>
<p>You can then see the section <a class="reference internal" href="install/installation.html"><span class="doc">Installation</span></a> and
<a class="reference internal" href="how_to_run.html"><span class="doc">How to run the code</span></a>, to get started with using FBPIC. For more
information, the section <a class="reference internal" href="api_reference/api_reference.html"><span class="doc">API reference</span></a> lists the main objects
that are accessible through FBPIC.</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="overview/overview.html">Overview of the code</a></li>
<li class="toctree-l1"><a class="reference internal" href="install/installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="how_to_run.html">How to run the code</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_reference/api_reference.html">API reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="advanced/advanced.html">Advanced use</a></li>
</ul>
</div>
</section>
<section id="contributing-to-fbpic">
<h2>Contributing to FBPIC<a class="headerlink" href="#contributing-to-fbpic" title="Link to this heading">¶</a></h2>
<p>FBPIC is open-source, and the source code is hosted <a class="reference external" href="http://github.com/fbpic/fbpic">here</a>, on
Github.</p>
<p>We welcome contributions to the code! If you wish to contribute,
please read <a class="reference external" href="https://github.com/fbpic/fbpic/blob/dev/CONTRIBUTING.md">this page</a> .</p>
</section>
<section id="research-attribution">
<h2>Research & Attribution<a class="headerlink" href="#research-attribution" title="Link to this heading">¶</a></h2>
<p>FBPIC was originally developed by Remi Lehe at <a class="reference external" href="http://www.lbl.gov/">Berkeley Lab</a>,
and Manuel Kirchen at
<a class="reference external" href="http://lux.cfel.de/">CFEL, Hamburg University</a>. The code also
benefitted from the contributions of Soeren Jalas (CFEL), Kevin Peters (CFEL),
Irene Dornmair (CFEL), Laurids Jeppe (CFEL), Igor Andriyash (Laboratoire d’Optique Appliquee),
Omri Seemann (Weizmann Institute), Daniel Seipt (University of Michigan),
Samuel Yoffe (University of Strathclyde), David Grote (LLNL and LBNL)
and Anton Golovanov (Weizmann Institute).</p>
<p>FBPIC’s algorithms are documented in following scientific publications:</p>
<blockquote>
<div><ul class="simple">
<li><p>General description of FBPIC and it’s algorithm (original paper):
<a class="reference external" href="http://www.sciencedirect.com/science/article/pii/S0010465516300224">R. Lehe et al., CPC, 2016</a> (<a class="reference external" href="https://arxiv.org/abs/1507.04790">arXiv</a>)</p></li>
<li><p>Boosted-frame technique with Galilean algorithm:
<a class="reference external" href="https://aip.scitation.org/doi/10.1063/1.4964770">M. Kirchen et al., PoP, 2016</a> (<a class="reference external" href="https://arxiv.org/abs/1608.00215">arXiv</a>) and
<a class="reference external" href="https://journals.aps.org/pre/abstract/10.1103/PhysRevE.94.053305">R. Lehe et al., PRE, 2016</a> (<a class="reference external" href="https://arxiv.org/abs/1608.00227">arXiv</a>)</p></li>
<li><p>Parallel finite-order solver for multi-CPU/GPU simulations:
<a class="reference external" href="https://aip.scitation.org/doi/abs/10.1063/1.4978569">S. Jalas et al., PoP, 2017</a> (<a class="reference external" href="https://arxiv.org/abs/1611.05712">arXiv</a>)</p></li>
<li><p>Parallel finite-order boosted-frame simulations for multi-CPU/GPU simulations:
<a class="reference external" href="https://journals.aps.org/pre/abstract/10.1103/PhysRevE.102.013202">M. Kirchen et al., PRE, 2020</a></p></li>
</ul>
</div></blockquote>
<p>If you use FBPIC for your research project: that’s great! We are
very pleased that the code is useful to you!</p>
<p>If your project even leads to a scientific publication, please consider citing at least FBPIC’s original paper.
If your project uses the more advanced algorithms, please consider citing the respective publications in addition.</p>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="overview/overview.html" class="btn btn-neutral float-right" title="Overview of the code" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2016, FBPIC contributors.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>