-
Notifications
You must be signed in to change notification settings - Fork 1
/
api.html
197 lines (185 loc) · 10.9 KB
/
api.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
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
<head>
<meta charset="utf-8" />
<title>Description of the Fortran modules — Magic 6.3 documentation</title>
<link rel="stylesheet" href="_static/magic.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>
<script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Magic 6.3 documentation"
href="_static/opensearch.xml"/>
<link rel="shortcut 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="Main program magic.f90" href="apiFortran/magic.html" />
<link rel="prev" title="Spectral tansforms" href="apiPython/libs.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 navigation">
<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="apiFortran/magic.html" title="Main program magic.f90"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="apiPython/libs.html" title="Spectral tansforms"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="contents.html">Magic 6.3 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="description-of-the-fortran-modules">
<span id="secfortranapi"></span><h1>Description of the Fortran modules<a class="headerlink" href="#description-of-the-fortran-modules" title="Permalink to this headline">¶</a></h1>
<p>The following pages contain an exhaustive description of the different
variables, subroutines and modules used in MagIC. This documentation is
automatically generated from the source code docstrings using the <a class="reference external" href="http://www.ifremer.fr/vacumm/user.desc.fdoc.dom.html">Sphinx extention
for the Fortran domain</a>.</p>
<div class="topic">
<p class="topic-title first">Fortran modules</p>
<ol class="arabic simple">
<li><p>For the main program file <code class="docutils literal notranslate"><span class="pre">magic.f90</span></code>, see <a class="reference internal" href="apiFortran/magic.html#secfortranmagic"><span class="std std-ref">here</span></a>.</p></li>
<li><p>For the core modules that contain most of the global variables, see <a class="reference internal" href="apiFortran/baseModules.html#secfortranbase"><span class="std std-ref">here</span></a>.</p></li>
<li><p>For the MPI related modules, see <a class="reference internal" href="apiFortran/parallelModules.html#secfortranmpi"><span class="std std-ref">here</span></a>.</p></li>
<li><p>For the code initialization and the pre-calculations done in the initial stage of the computation (before the time-stepping loop), see <a class="reference internal" href="apiFortran/initModules.html#secfortraninit"><span class="std std-ref">here</span></a> and <a class="reference internal" href="apiFortran/precalcModules.html#secfortranprecalc"><span class="std std-ref">there</span></a>.</p></li>
<li><p>For the time-stepping loop, see <a class="reference internal" href="apiFortran/timeAdvance.html#secfortrantimestep"><span class="std std-ref">here</span></a>.</p></li>
<li><p>For the calculation of the non-linear terms (in the physical space) and their time-advance, see <a class="reference internal" href="apiFortran/timeAdvNonLinear.html#secfortrannl"><span class="std std-ref">here</span></a>.</p></li>
<li><p>For the calculation of the linear terms (in spectral space) and their time-advance, see <a class="reference internal" href="apiFortran/timeAdvLinear.html#secfortranlin"><span class="std std-ref">here</span></a>.</p></li>
<li><p>For the Chebyshev, Fourier and Legendre transforms, see <a class="reference internal" href="apiFortran/legFourierChebAlgebra.html#secfortranlibs"><span class="std std-ref">here</span></a>.</p></li>
<li><p>For the computation of the radial derivatives (Chebyshev) and the integration, see <a class="reference internal" href="apiFortran/derInt.html#secfortranderint"><span class="std std-ref">here</span></a>.</p></li>
<li><p>For the definition of the blocking, see <a class="reference internal" href="apiFortran/blocking.html#secfortranblocking"><span class="std std-ref">here</span></a>.</p></li>
<li><p>For the calculation of the standard outputs (time-series, spectra and radial files), see <a class="reference internal" href="apiFortran/IOGeneral.html#secfortraniogeneral"><span class="std std-ref">here</span></a>.</p></li>
<li><p>For the calculation of binary outputs (graphic files, movie files, potential and coeff files), see <a class="reference internal" href="apiFortran/IOBinaryOutputs.html#secfortraniobinary"><span class="std std-ref">here</span></a>.</p></li>
<li><p>For the additional calculations of specific outputs (torsional oscillations, RMS force balance, etc.), see <a class="reference internal" href="apiFortran/IOAdd.html#secfortranioadd"><span class="std std-ref">here</span></a>.</p></li>
<li><p>For reading and writing the check points (restart files), see <a class="reference internal" href="apiFortran/checkPoints.html#secfortranrestart"><span class="std std-ref">here</span></a>.</p></li>
<li><p>For additional useful functions (string manipulation, etc.), see <a class="reference internal" href="apiFortran/misc.html#secfortranmisc"><span class="std std-ref">here</span></a>.</p></li>
</ol>
</div>
<div class="toctree-wrapper compound">
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="apiPython/libs.html"
title="previous chapter">Spectral tansforms</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="apiFortran/magic.html"
title="next chapter">Main program <code class="docutils literal notranslate"><span class="pre">magic.f90</span></code></a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/api.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div 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" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<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="apiFortran/magic.html" title="Main program magic.f90"
>next</a> |</li>
<li class="right" >
<a href="apiPython/libs.html" title="Spectral tansforms"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="contents.html">Magic 6.3 documentation</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2023, Thomas Gastine, Johannes Wicht, Ankit Barik, Lùcia Duarte.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.3.1.
</div>
</body>
</html>