-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathcontents.html
More file actions
276 lines (263 loc) · 17.7 KB
/
contents.html
File metadata and controls
276 lines (263 loc) · 17.7 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
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
<!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>Contents — Magic 6.3 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
<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>
<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="Introduction" href="foreword.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</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="foreword.html" title="Introduction"
accesskey="N">next</a> |</li>
<li class="nav-item nav-item-0"><a href="#">Magic 6.3 documentation</a> »</li>
<li class="nav-item nav-item-this"><a href="">Contents</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="contents">
<span id="id1"></span><h1>Contents<a class="headerlink" href="#contents" title="Link to this heading">¶</a></h1>
</section>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="install.html">Get MagIC and run it</a><ul>
<li class="toctree-l2"><a class="reference internal" href="install.html#download-the-code">Download the code</a></li>
<li class="toctree-l2"><a class="reference internal" href="install.html#setting-up-the-environment-variables">Setting up the environment variables</a></li>
<li class="toctree-l2"><a class="reference internal" href="install.html#install-shtns-recommended">Install SHTns (<strong>recommended</strong>)</a></li>
<li class="toctree-l2"><a class="reference internal" href="install.html#setting-up-compiler-options-and-compiling">Setting up compiler options and compiling</a></li>
<li class="toctree-l2"><a class="reference internal" href="install.html#preparing-a-production-run">Preparing a production run</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="equations.html">Formulation of the (magneto)-hydrodynamics problem</a><ul>
<li class="toctree-l2"><a class="reference internal" href="equations.html#the-reference-state">The reference state</a></li>
<li class="toctree-l2"><a class="reference internal" href="equations.html#boussinesq-approximation">Boussinesq approximation</a></li>
<li class="toctree-l2"><a class="reference internal" href="equations.html#anelastic-approximation">Anelastic approximation</a></li>
<li class="toctree-l2"><a class="reference internal" href="equations.html#dimensionless-control-parameters">Dimensionless control parameters</a></li>
<li class="toctree-l2"><a class="reference internal" href="equations.html#boundary-conditions-and-treatment-of-inner-core">Boundary conditions and treatment of inner core</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="numerics.html">Numerical technique</a><ul>
<li class="toctree-l2"><a class="reference internal" href="numerics.html#poloidal-toroidal-decomposition">Poloidal/toroidal decomposition</a></li>
<li class="toctree-l2"><a class="reference internal" href="numerics.html#spherical-harmonic-representation">Spherical harmonic representation</a></li>
<li class="toctree-l2"><a class="reference internal" href="numerics.html#radial-representation">Radial representation</a></li>
<li class="toctree-l2"><a class="reference internal" href="numerics.html#spectral-equations">Spectral equations</a></li>
<li class="toctree-l2"><a class="reference internal" href="numerics.html#time-stepping-schemes">Time-stepping schemes</a></li>
<li class="toctree-l2"><a class="reference internal" href="numerics.html#coriolis-force-and-nonlinear-terms">Coriolis force and nonlinear terms</a></li>
<li class="toctree-l2"><a class="reference internal" href="numerics.html#boundary-conditions-and-inner-core">Boundary conditions and inner core</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="contribute.html">Contributing to the code</a><ul>
<li class="toctree-l2"><a class="reference internal" href="contribute.html#checking-the-consistency-of-the-code">Checking the consistency of the code</a></li>
<li class="toctree-l2"><a class="reference internal" href="contribute.html#advices-when-contributing-to-the-code">Advices when contributing to the code</a></li>
<li class="toctree-l2"><a class="reference internal" href="contribute.html#building-the-documentation-and-contributing-to-it">Building the documentation and contributing to it</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="inputNamelists/namelists.html">Input parameters</a><ul>
<li class="toctree-l2"><a class="reference internal" href="inputNamelists/gridNamelist.html">Grid namelist</a></li>
<li class="toctree-l2"><a class="reference internal" href="inputNamelists/controlNamelist.html">Control namelist</a></li>
<li class="toctree-l2"><a class="reference internal" href="inputNamelists/physNamelist.html">Physical parameters namelist</a></li>
<li class="toctree-l2"><a class="reference internal" href="inputNamelists/BextNamelist.html">External Magnetic Field Namelist</a></li>
<li class="toctree-l2"><a class="reference internal" href="inputNamelists/startNamelist.html">Start field namelist</a></li>
<li class="toctree-l2"><a class="reference internal" href="inputNamelists/outNamelist.html">Output control namelist</a></li>
<li class="toctree-l2"><a class="reference internal" href="inputNamelists/mantle_icNamelist.html">Mantle and Inner Core Namelists</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="signalFile.html">Interactive communication with the code using <code class="docutils literal notranslate"><span class="pre">signal.TAG</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="outputFiles/outFiles.html">Output files</a><ul>
<li class="toctree-l2"><a class="reference internal" href="outputFiles/logFile.html">Log file: <code class="docutils literal notranslate"><span class="pre">log.TAG</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="outputFiles/outTimeSeriesStd.html">Default time-series outputs</a></li>
<li class="toctree-l2"><a class="reference internal" href="outputFiles/outTimeSeriesSupp.html">Additional optional time-series outputs</a></li>
<li class="toctree-l2"><a class="reference internal" href="outputFiles/outRadialFiles.html">Time-averaged radial profiles</a></li>
<li class="toctree-l2"><a class="reference internal" href="outputFiles/outTransportProp.html">Transport properties of the reference state</a></li>
<li class="toctree-l2"><a class="reference internal" href="outputFiles/outTransportProp.html#nonlinear-mapping-of-the-chebyshev-grid">Nonlinear mapping of the Chebyshev grid</a></li>
<li class="toctree-l2"><a class="reference internal" href="outputFiles/outSpecFiles.html">Spectra</a></li>
<li class="toctree-l2"><a class="reference internal" href="outputFiles/outGraph.html">Graphic files <code class="docutils literal notranslate"><span class="pre">G_#.TAG</span></code> and <code class="docutils literal notranslate"><span class="pre">G_ave.TAG</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="outputFiles/outMovie.html">Movie files <code class="docutils literal notranslate"><span class="pre">*_mov.TAG</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="outputFiles/outRst.html">Restart files <code class="docutils literal notranslate"><span class="pre">checkpoint_*.TAG</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="outputFiles/outCoeffFiles.html">Poloidal and toroidal potentials at given depths</a></li>
<li class="toctree-l2"><a class="reference internal" href="outputFiles/outTOFiles.html"><code class="docutils literal notranslate"><span class="pre">TO</span></code> outputs</a></li>
<li class="toctree-l2"><a class="reference internal" href="outputFiles/outRSpecFiles.html">Radial spectra <code class="docutils literal notranslate"><span class="pre">rB[r|p]Spec.TAG</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="outputFiles/outPotFiles.html">Potential files <code class="docutils literal notranslate"><span class="pre">[V|B|T|Xi]_lmr_#.TAG</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="postProc.html">Data visualisation and post-processing</a><ul>
<li class="toctree-l2"><a class="reference internal" href="postProc.html#requirements">Requirements</a></li>
<li class="toctree-l2"><a class="reference internal" href="postProc.html#configuration-magic-cfg-file">Configuration: <code class="docutils literal notranslate"><span class="pre">magic.cfg</span></code> file</a></li>
<li class="toctree-l2"><a class="reference internal" href="postProc.html#python-functions-and-classes">Python functions and classes</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="api.html">Description of the Fortran modules</a><ul>
<li class="toctree-l2"><a class="reference internal" href="apiFortran/magic.html">Main program <code class="docutils literal notranslate"><span class="pre">magic.f90</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="apiFortran/baseModules.html">Base modules</a></li>
<li class="toctree-l2"><a class="reference internal" href="apiFortran/parallelModules.html">MPI related modules</a></li>
<li class="toctree-l2"><a class="reference internal" href="apiFortran/initModules.html">Code initialization</a></li>
<li class="toctree-l2"><a class="reference internal" href="apiFortran/precalcModules.html">Pre-calculations</a></li>
<li class="toctree-l2"><a class="reference internal" href="apiFortran/timeAdvance.html">Time stepping</a></li>
<li class="toctree-l2"><a class="reference internal" href="apiFortran/timeAdvance.html#time-schemes">Time schemes</a></li>
<li class="toctree-l2"><a class="reference internal" href="apiFortran/timeAdvLinear.html">Linear calculation part of the time stepping (LMLoop)</a></li>
<li class="toctree-l2"><a class="reference internal" href="apiFortran/timeAdvNonLinear.html">Non-linear part of the time stepping (radial loop)</a></li>
<li class="toctree-l2"><a class="reference internal" href="apiFortran/legFourierChebAlgebra.html">Radial scheme</a></li>
<li class="toctree-l2"><a class="reference internal" href="apiFortran/legFourierChebAlgebra.html#chebyshev-polynomials-and-cosine-transforms">Chebyshev polynomials and cosine transforms</a></li>
<li class="toctree-l2"><a class="reference internal" href="apiFortran/legFourierChebAlgebra.html#fourier-transforms">Fourier transforms</a></li>
<li class="toctree-l2"><a class="reference internal" href="apiFortran/legFourierChebAlgebra.html#spherical-harmonic-transforms">Spherical harmonic transforms</a></li>
<li class="toctree-l2"><a class="reference internal" href="apiFortran/legFourierChebAlgebra.html#linear-algebra">Linear algebra</a></li>
<li class="toctree-l2"><a class="reference internal" href="apiFortran/derInt.html">Radial derivatives and integration</a></li>
<li class="toctree-l2"><a class="reference internal" href="apiFortran/blocking.html">Blocking and LM mapping</a></li>
<li class="toctree-l2"><a class="reference internal" href="apiFortran/IOGeneral.html">IO: time series, radial profiles and spectra</a></li>
<li class="toctree-l2"><a class="reference internal" href="apiFortran/IOBinaryOutputs.html">IO: graphic files, movie files, coeff files and potential files</a></li>
<li class="toctree-l2"><a class="reference internal" href="apiFortran/IOAdd.html">IO: RMS force balance, torsional oscillations, misc</a></li>
<li class="toctree-l2"><a class="reference internal" href="apiFortran/checkPoints.html">Reading and storing check points (restart files)</a></li>
<li class="toctree-l2"><a class="reference internal" href="apiFortran/misc.html">Useful additional libraries</a></li>
</ul>
</li>
</ul>
</div>
<section id="indices-and-tables">
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Link to this heading">¶</a></h1>
<ul class="simple">
<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>
<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
</ul>
</section>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<div>
<h3><a href="#">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Contents</a><ul class="simple">
</ul>
</li>
<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
</ul>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="foreword.html"
title="next chapter">Introduction</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/contents.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="foreword.html" title="Introduction"
>next</a> |</li>
<li class="nav-item nav-item-0"><a href="#">Magic 6.3 documentation</a> »</li>
<li class="nav-item nav-item-this"><a href="">Contents</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2025, Thomas Gastine, Johannes Wicht, Ankit Barik, Lùcia Duarte.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.
</div>
</body>
</html>