-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathforeword.html
More file actions
253 lines (240 loc) · 13.2 KB
/
foreword.html
File metadata and controls
253 lines (240 loc) · 13.2 KB
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
<!DOCTYPE html>
<html lang="en" data-content_root="./">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Introduction — Magic 6.3 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/magic.css?v=a97dc138" />
<script src="_static/documentation_options.js?v=4b074805"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script async="async" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Magic 6.3 documentation"
href="_static/opensearch.xml"/>
<link rel="icon" href="_static/favicon.ico"/>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Get MagIC and run it" href="install.html" />
<link rel="prev" title="Contents" href="contents.html" />
<link href='http://fonts.googleapis.com/css?family=Open+Sans:300,400,700'
rel='stylesheet' type='text/css' />
<script src="https://ajax.googleapis.com/ajax/libs/jquery/1/jquery.js"></script>
<script src="galleria/galleria-1.4.2.min.js"></script>
<style type="text/css">
table.right { float: right; margin-left: 20px; }
table.right td { border: 1px solid #ccc; }
</style>
<script type="text/javascript">
// intelligent scrolling of the sidebar content
$(window).scroll(function() {
var sb = $('.sphinxsidebarwrapper');
var win = $(window);
var sbh = sb.height();
var offset = $('.sphinxsidebar').position()['top'];
var wintop = win.scrollTop();
var winbot = wintop + win.innerHeight();
var curtop = sb.position()['top'];
var curbot = curtop + sbh;
// does sidebar fit in window?
if (sbh < win.innerHeight()) {
// yes: easy case -- always keep at the top
sb.css('top', $u.min([$u.max([0, wintop - offset - 10]),
$(document).height() - sbh - 200]));
} else {
// no: only scroll if top/bottom edge of sidebar is at
// top/bottom edge of window
if (curtop > wintop && curbot > winbot) {
sb.css('top', $u.max([wintop - offset - 10, 0]));
} else if (curtop < wintop && curbot < winbot) {
sb.css('top', $u.min([winbot - sbh - offset - 20,
$(document).height() - sbh - 200]));
}
}
});
</script>
</head><body>
<div class="pageheader">
<ul>
<li><a href="index.html">Home</a></li>
<li><a href="install.html">Get it/Run it</a></li>
<li><a href="contribute.html">Contribute!</a></li>
<li><a href="numerics.html">Numerical methods</a></li>
<li><a href="contents.html">Contents</a></li>
</ul>
<div>
<a href="index.html">
<img src="_static/logo.png" alt="magic" height="120px" width="192px"/>
</a>
</div>
</div>
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="f-modindex.html" title="Fortran Module Index"
>fortran modules</a> |</li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="install.html" title="Get MagIC and run it"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="contents.html" title="Contents"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="contents.html">Magic 6.3 documentation</a> »</li>
<li class="nav-item nav-item-this"><a href="">Introduction</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="introduction">
<h1>Introduction<a class="headerlink" href="#introduction" title="Link to this heading">¶</a></h1>
<section id="foreword">
<h2>Foreword<a class="headerlink" href="#foreword" title="Link to this heading">¶</a></h2>
<p><strong>MagIC</strong> is a numerical code that can simulate fluid dynamics in a spherical
shell. MagIC solves for the Navier-Stokes equation including Coriolis force,
optionally coupled with an induction equation for Magneto-Hydro Dynamics (MHD),
a temperature (or entropy) equation and an equation for chemical composition
under both the anelastic and the Boussinesq approximations.</p>
<p><strong>MagIC</strong> uses Chebyshev polynomials or finite difference in the radial direction and spherical
harmonic decomposition in the azimuthal and latitudinal directions. MagIC supports
several Implicit-Explicit time schemes where the nonlinear terms and the Coriolis force are treated explicitly, while the remaining linear terms are treated implicitly.</p>
<p><strong>MagIC</strong> is written in Fortran and designed to be used on supercomputing
clusters. It thus relies on a hybrid parallelisation scheme using both <a class="reference external" href="http://openmp.org/wp/">OpenMP</a> and <a class="reference external" href="http://www.open-mpi.org/">MPI</a>. Postprocessing
functions written in python (requiring <a class="reference external" href="http://matplotlib.org/">matplotlib</a>
and <a class="reference external" href="http://www.scipy.org/">scipy</a>) are also provided to allow a useful data
analysis.</p>
<figure class="align-center" id="id1">
<a class="reference internal image-reference" href="_images/magic_occigen.png"><img alt="caption" src="_images/magic_occigen.png" style="width: 630.0px; height: 540.0px;" />
</a>
<figcaption>
<p><span class="caption-text">Mean walltime of the MagIC code on the supercomputer <a class="reference external" href="https://www.cines.fr/en/supercomputing-2/hardwares/the-supercomputer-occigen/">Occigen</a>
versus number of cores for a Boussinesq dynamo model computed at three
different numerical resolutions <span class="math notranslate nohighlight">\((N_r,\ell_{\text{max}})\)</span>. The dashed
grey lines show the ideal scalings.</span><a class="headerlink" href="#id1" title="Link to this image">¶</a></p>
</figcaption>
</figure>
<p><strong>MagIC</strong> is a free software. It can be used, modified and redistributed under the
terms of the <a class="reference external" href="http://www.gnu.org/licenses/gpl-3.0.en.html">GNU GPL v3 licence</a>.</p>
</section>
<section id="giving-credit">
<h2>Giving credit<a class="headerlink" href="#giving-credit" title="Link to this heading">¶</a></h2>
<p>In case you intend to publish scientific results obtained with the MagIC code
or present them in a conference, we (the developers of MagIC) kindly
ask to be acknowledged with a reference to the website
<a class="reference external" href="https://magic-sph.github.io/">https://magic-sph.github.io/</a> or <a class="reference external" href="https://github.com/magic-sph/magic">https://github.com/magic-sph/magic</a>.</p>
<p>We also suggest to give appropriate reference to one or several of the following
papers:</p>
<ul class="simple">
<li><p>Boussinesq equations: <a class="reference external" href="http://dx.doi.org/10.1016/S0031-9201(02)00078-X">Wicht (2002, PEPI, 132, 281-302)</a></p></li>
<li><p>Anelastic equations: <a class="reference external" href="http://dx.doi.org/10.1016/j.icarus.2012.03.018">Gastine & Wicht (2012, Icarus, 219, 28-442)</a></p></li>
<li><p>Boussinesq benchmark: <a class="reference external" href="http://dx.doi.org/10.1016/S0031-9201(01)00275-8">Christensen et al. (2001, PEPI, 128, 25-34)</a></p></li>
<li><p>Benchmark for double diffusive convection: <a class="reference external" href="http://dx.doi.org/11.1111/j.1365-246X.2010.04722.x">Breuer et al. (2010, GJI, 183, 150-162)</a></p></li>
<li><p>Anelastic benchmark: <a class="reference external" href="http://dx.doi.org/10.1016/j.icarus.2011.08.014">Jones et al. (2011, Icarus, 216, 120-135)</a></p></li>
<li><p>In case you use the <a class="reference external" href="https://bitbucket.org/bputigny/shtns-magic">SHTns</a> library for the spherical harmonics transforms (MagIC 5.3 or later), please also cite: <a class="reference external" href="http://dx.doi.org/10.1002/ggge.20071">Schaeffer (2013, GGG, 14, 751-758)</a></p></li>
</ul>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p>A (tentative) comprehensive list of the publications that have
been produced to date (October 2024) using <strong>MagIC</strong>
is accessible <a class="reference external" href="https://ui.adsabs.harvard.edu/public-libraries/LVt1vdaKQsC5P09In2iloA">here</a>.
To date, more than <strong>150 publications</strong> have been-accepted in
more than 20 different peer-reviewed journals: <a class="reference external" href="http://www.journals.elsevier.com/physics-of-the-earth-and-planetary-interiors/">PEPI</a>
(25), <a class="reference external" href="http://www.journals.elsevier.com/icarus/">Icarus</a> (15), <a class="reference external" href="http://www.journals.elsevier.com/earth-and-planetary-science-letters/">E&PSL</a> (7), <a class="reference external" href="http://gji.oxfordjournals.org/">GJI</a> (17), <a class="reference external" href="http://www.aanda.org/">A&A</a> (16),
<a class="reference external" href="http://agupubs.onlinelibrary.wiley.com/agu/journal/10.1002/(ISSN)1944-8007/">GRL</a> (7),
<a class="reference external" href="http://journals.cambridge.org/action/displayJournal?jid=FLM">JFM</a> (7),
<a class="reference external" href="http://www.tandfonline.com/toc/ggaf20/current">GAFD</a> (3),
<a class="reference external" href="http://www.nature.com/nature">Nature</a> (2), etc.</p>
</div>
<figure class="align-center" id="id2">
<a class="reference internal image-reference" href="_images/magic_pubs.png"><img alt="caption" src="_images/magic_pubs.png" style="width: 404.0px; height: 213.5px;" />
</a>
<figcaption>
<p><span class="caption-text">Number of peer-reviewed publications produced using <strong>MagIC</strong></span><a class="headerlink" href="#id2" title="Link to this image">¶</a></p>
</figcaption>
</figure>
</section>
</section>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<div>
<h3><a href="contents.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Introduction</a><ul>
<li><a class="reference internal" href="#foreword">Foreword</a></li>
<li><a class="reference internal" href="#giving-credit">Giving credit</a></li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="contents.html"
title="previous chapter">Contents</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="install.html"
title="next chapter">Get MagIC and run it</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/foreword.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<search id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="f-modindex.html" title="Fortran Module Index"
>fortran modules</a> |</li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="install.html" title="Get MagIC and run it"
>next</a> |</li>
<li class="right" >
<a href="contents.html" title="Contents"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="contents.html">Magic 6.3 documentation</a> »</li>
<li class="nav-item nav-item-this"><a href="">Introduction</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2023, Thomas Gastine, Johannes Wicht, Ankit Barik, Lùcia Duarte.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
</div>
</body>
</html>