-
Notifications
You must be signed in to change notification settings - Fork 1
/
f-modindex.html
693 lines (674 loc) · 33.3 KB
/
f-modindex.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
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
<head>
<meta charset="utf-8" />
<title>Fortran Module Index — 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 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>
<script type="text/javascript">
DOCUMENTATION_OPTIONS.COLLAPSE_INDEX = true;
</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="#" 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="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">
<h1>Fortran Module Index</h1>
<div class="modindex-jumpbox">
<a href="#cap-a"><strong>a</strong></a> |
<a href="#cap-b"><strong>b</strong></a> |
<a href="#cap-c"><strong>c</strong></a> |
<a href="#cap-d"><strong>d</strong></a> |
<a href="#cap-f"><strong>f</strong></a> |
<a href="#cap-g"><strong>g</strong></a> |
<a href="#cap-h"><strong>h</strong></a> |
<a href="#cap-i"><strong>i</strong></a> |
<a href="#cap-k"><strong>k</strong></a> |
<a href="#cap-l"><strong>l</strong></a> |
<a href="#cap-m"><strong>m</strong></a> |
<a href="#cap-n"><strong>n</strong></a> |
<a href="#cap-o"><strong>o</strong></a> |
<a href="#cap-p"><strong>p</strong></a> |
<a href="#cap-r"><strong>r</strong></a> |
<a href="#cap-s"><strong>s</strong></a> |
<a href="#cap-t"><strong>t</strong></a> |
<a href="#cap-u"><strong>u</strong></a>
</div>
<table class="indextable modindextable">
<tr class="pcap"><td></td><td> </td><td></td></tr>
<tr class="cap" id="cap-a"><td></td><td>
<strong>a</strong></td><td></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/legFourierChebAlgebra.html#f/algebra"><code class="xref">algebra</code></a></td><td>
<em></em></td></tr>
<tr class="pcap"><td></td><td> </td><td></td></tr>
<tr class="cap" id="cap-b"><td></td><td>
<strong>b</strong></td><td></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/legFourierChebAlgebra.html#f/band_matrices"><code class="xref">band_matrices</code></a></td><td>
<em></em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/blocking.html#f/blocking"><code class="xref">blocking</code></a></td><td>
<em>Module containing blocking information</em></td></tr>
<tr class="pcap"><td></td><td> </td><td></td></tr>
<tr class="cap" id="cap-c"><td></td><td>
<strong>c</strong></td><td></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/misc.html#f/charmanip"><code class="xref">charmanip</code></a></td><td>
<em>This module contains several useful routines to manipule character strings</em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/legFourierChebAlgebra.html#f/chebyshev"><code class="xref">chebyshev</code></a></td><td>
<em></em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/legFourierChebAlgebra.html#f/chebyshev_polynoms_mod"><code class="xref">chebyshev_polynoms_mod</code></a></td><td>
<em></em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/parallelModules.html#f/communications"><code class="xref">communications</code></a></td><td>
<em>This module contains the different MPI communicators used in MagIC.</em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/baseModules.html#f/constants"><code class="xref">constants</code></a></td><td>
<em>module containing constants and parameters used in the code.</em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/legFourierChebAlgebra.html#f/cosine_transform_even"><code class="xref">cosine_transform_even</code></a></td><td>
<em></em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/legFourierChebAlgebra.html#f/cosine_transform_odd"><code class="xref">cosine_transform_odd</code></a></td><td>
<em>This module contains the built-in type I discrete Cosine Transforms. This implementation is based on Numerical Recipes and FFTPACK. This only works for ``n_r_max-1 = 2**a 3**b 5**c``, with a,b,c integers....</em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/timeAdvance.html#f/courant_mod"><code class="xref">courant_mod</code></a></td><td>
<em>This module handles the computation of Courant factors on grid space. It then checks whether the timestep size needs to be modified.</em></td></tr>
<tr class="pcap"><td></td><td> </td><td></td></tr>
<tr class="cap" id="cap-d"><td></td><td>
<strong>d</strong></td><td></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/legFourierChebAlgebra.html#f/dense_matrices"><code class="xref">dense_matrices</code></a></td><td>
<em></em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/timeAdvance.html#f/dirk_schemes"><code class="xref">dirk_schemes</code></a></td><td>
<em>This module defines the type_dirk which inherits from the abstract type_tscheme. It actually implements all the routine required to time-advance an diagonally implicit Runge-Kutta scheme. It makes use</em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/IOAdd.html#f/dtb_arrays_mod"><code class="xref">dtb_arrays_mod</code></a></td><td>
<em></em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/IOAdd.html#f/dtb_mod"><code class="xref">dtb_mod</code></a></td><td>
<em>This module contains magnetic field stretching and advection terms plus a separate omega-effect. It is used for movie output....</em></td></tr>
<tr class="pcap"><td></td><td> </td><td></td></tr>
<tr class="cap" id="cap-f"><td></td><td>
<strong>f</strong></td><td></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/legFourierChebAlgebra.html#f/fft"><code class="xref">fft</code></a></td><td>
<em>This module contains the native subroutines used to compute FFT's. They are based on the FFT99 package from Temperton: http://www.cesm.ucar.edu/models/cesm1.2/cesm/cesmBbrowser/html_code/cam/fft99.F90.html</em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/legFourierChebAlgebra.html#f/fft_fac_mod"><code class="xref">fft_fac_mod</code></a></td><td>
<em></em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/baseModules.html#f/fields"><code class="xref">fields</code></a></td><td>
<em>This module contains all the fields used in MagIC in the hybrid (LM,r) space as well as their radial derivatives. It defines both the LM-distributed arrays and the R-distributed arrays....</em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/IOBinaryOutputs.html#f/fields_average_mod"><code class="xref">fields_average_mod</code></a></td><td>
<em>This module is used when one wants to store time-averaged quantities</em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/baseModules.html#f/fieldslast"><code class="xref">fieldslast</code></a></td><td>
<em>This module contains all the work arrays of the previous time-steps needed to time advance the code. They are needed in the time-stepping scheme....</em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/legFourierChebAlgebra.html#f/finite_differences"><code class="xref">finite_differences</code></a></td><td>
<em>This module is used to calculate the radial grid when finite differences are requested</em></td></tr>
<tr class="pcap"><td></td><td> </td><td></td></tr>
<tr class="cap" id="cap-g"><td></td><td>
<strong>g</strong></td><td></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/timeAdvNonLinear.html#f/general_arrays_mod"><code class="xref">general_arrays_mod</code></a></td><td>
<em></em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/IOAdd.html#f/geos"><code class="xref">geos</code></a></td><td>
<em>This module is used to compute z-integrated diagnostics such as the degree of geostrophy or the separation of energies between inside and outside the tangent cylinder. This makes use of a local Simpson's method. This also</em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/IOGeneral.html#f/getdlm_mod"><code class="xref">getdlm_mod</code></a></td><td>
<em>This module is used to calculate the lengthscales. It computes both the integral lengthscale and the peak of the poloidal energy. It also stores the radial profiles of these lengthscales....</em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/IOBinaryOutputs.html#f/graphout_mod"><code class="xref">graphout_mod</code></a></td><td>
<em>This module contains the subroutines that store the 3-D graphic files.</em></td></tr>
<tr class="pcap"><td></td><td> </td><td></td></tr>
<tr class="cap" id="cap-h"><td></td><td>
<strong>h</strong></td><td></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/precalcModules.html#f/horizontal_data"><code class="xref">horizontal_data</code></a></td><td>
<em>Module containing functions depending on longitude and latitude plus help arrays depending on degree and order</em></td></tr>
<tr class="pcap"><td></td><td> </td><td></td></tr>
<tr class="cap" id="cap-i"><td></td><td>
<strong>i</strong></td><td></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/initModules.html#f/init_fields"><code class="xref">init_fields</code></a></td><td>
<em>This module is used to construct the initial solution.</em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/derInt.html#f/integration"><code class="xref">integration</code></a></td><td>
<em>Radial integration functions</em></td></tr>
<tr class="pcap"><td></td><td> </td><td></td></tr>
<tr class="cap" id="cap-k"><td></td><td>
<strong>k</strong></td><td></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/IOGeneral.html#f/kinetic_energy"><code class="xref">kinetic_energy</code></a></td><td>
<em>This module handles the computation of kinetic energy and the time-averaged radial profiles.</em></td></tr>
<tr class="pcap"><td></td><td> </td><td></td></tr>
<tr class="cap" id="cap-l"><td></td><td>
<strong>l</strong></td><td></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/timeAdvLinear.html#f/lmloop_mod"><code class="xref">lmloop_mod</code></a></td><td>
<em></em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/blocking.html#f/lmmapping"><code class="xref">lmmapping</code></a></td><td>
<em></em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/baseModules.html#f/logic"><code class="xref">logic</code></a></td><td>
<em>Module containing the logicals that control the run</em></td></tr>
<tr class="pcap"><td></td><td> </td><td></td></tr>
<tr class="cap" id="cap-m"><td></td><td>
<strong>m</strong></td><td></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/IOGeneral.html#f/magnetic_energy"><code class="xref">magnetic_energy</code></a></td><td>
<em>This module handles the computation and the writing of the diagnostic files related to magnetic energy: e_mag_oc.TAG, e_mag_ic.TAG, dipole.TAG, eMagR.TAG</em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/misc.html#f/mean_sd"><code class="xref">mean_sd</code></a></td><td>
<em>This module contains a small type that simply handles two arrays (mean and SD) This type is used for time-averaged outputs (and their standard deviations).</em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/misc.html#f/mem_alloc"><code class="xref">mem_alloc</code></a></td><td>
<em>This little module is used to estimate the global memory allocation used in MagIC</em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/IOBinaryOutputs.html#f/movie_data"><code class="xref">movie_data</code></a></td><td>
<em></em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/parallelModules.html#f/mpi_transp_mod"><code class="xref">mpi_transp_mod</code></a></td><td>
<em>This is an abstract class that will be used to define MPI transposers The actual implementation is deferred to either point-to-point (MPI_Isend and MPI_IRecv) communications or all-to-all (MPI_AlltoAll)</em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/timeAdvance.html#f/multistep_schemes"><code class="xref">multistep_schemes</code></a></td><td>
<em>This module defines the type_multistep which inherits from the abstract type_tscheme. It actually implements all the routine required to time-advance an IMEX multistep scheme such as CN/AB2, SBDF(2,3,4),</em></td></tr>
<tr class="pcap"><td></td><td> </td><td></td></tr>
<tr class="cap" id="cap-n"><td></td><td>
<strong>n</strong></td><td></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/initModules.html#f/namelists"><code class="xref">namelists</code></a></td><td>
<em>Read and print the input namelist</em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/timeAdvNonLinear.html#f/nonlinear_bcs"><code class="xref">nonlinear_bcs</code></a></td><td>
<em></em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/timeAdvNonLinear.html#f/nonlinear_lm_mod"><code class="xref">nonlinear_lm_mod</code></a></td><td>
<em>This module is used to finish the assembly of the nonlinear terms in :math:`(\ell,m)` space. Derivatives along :math:`\theta` and :math:`\phi` are handled using recurrence relations....</em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/baseModules.html#f/num_param"><code class="xref">num_param</code></a></td><td>
<em>Module containing numerical and control parameters</em></td></tr>
<tr class="pcap"><td></td><td> </td><td></td></tr>
<tr class="cap" id="cap-o"><td></td><td>
<strong>o</strong></td><td></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/IOBinaryOutputs.html#f/out_coeff"><code class="xref">out_coeff</code></a></td><td>
<em>This module contains the subroutines that calculate the Bcmb files, the [B|V|T]_coeff_r files and the [B|V|T]_lmr files</em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/IOAdd.html#f/out_dtb_frame"><code class="xref">out_dtb_frame</code></a></td><td>
<em></em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/IOBinaryOutputs.html#f/out_movie"><code class="xref">out_movie</code></a></td><td>
<em></em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/IOBinaryOutputs.html#f/out_movie_ic"><code class="xref">out_movie_ic</code></a></td><td>
<em></em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/IOGeneral.html#f/outmisc_mod"><code class="xref">outmisc_mod</code></a></td><td>
<em>This module contains several subroutines that can compute and store various informations: helicity (helicity.TAG), heat transfer (heat.TAG), phase field (phase.TAG) and North/South hemisphericity of energies (hemi.TAG)</em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/IOGeneral.html#f/outpar_mod"><code class="xref">outpar_mod</code></a></td><td>
<em>This module is used to compute several time-averaged radial profiles: fluxes, boundary layers, etc.</em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/baseModules.html#f/output_data"><code class="xref">output_data</code></a></td><td>
<em>This module contains the parameters for output control</em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/IOGeneral.html#f/output_mod"><code class="xref">output_mod</code></a></td><td>
<em>This module handles the calls to the different output routines.</em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/IOGeneral.html#f/outrot"><code class="xref">outrot</code></a></td><td>
<em>This module handles the writing of several diagnostic files related to the rotation: angular momentum (AM.TAG), drift (drift.TAG), inner core and mantle rotations....</em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/IOAdd.html#f/outto_mod"><code class="xref">outto_mod</code></a></td><td>
<em>This module handles the writing of TO-related outputs: zonal force balance and z-integrated terms. This is a re-implementation of the spectral method used up to MagIC 5.10, which formerly relies on calculation of Plm on the cylindrical grid....</em></td></tr>
<tr class="pcap"><td></td><td> </td><td></td></tr>
<tr class="cap" id="cap-p"><td></td><td>
<strong>p</strong></td><td></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/parallelModules.html#f/parallel_mod"><code class="xref">parallel_mod</code></a></td><td>
<em>This module contains the blocking information</em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/parallelModules.html#f/parallel_solvers"><code class="xref">parallel_solvers</code></a></td><td>
<em>This module contains the routines that are used to solve linear banded problems with R-distributed arrays.</em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/baseModules.html#f/physical_parameters"><code class="xref">physical_parameters</code></a></td><td>
<em>Module containing the physical parameters</em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/legFourierChebAlgebra.html#f/plms_theta"><code class="xref">plms_theta</code></a></td><td>
<em></em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/IOGeneral.html#f/power"><code class="xref">power</code></a></td><td>
<em>This module handles the writing of the power budget</em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/precalcModules.html#f/precalculations"><code class="xref">precalculations</code></a></td><td>
<em>This module is used to handle some pre-calculations of constants (moment of inertia, mass, volumes), determine the timesteps for I/O and fix boundary values for temperature/entropy and chemical composition</em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/baseModules.html#f/precision_mod"><code class="xref">precision_mod</code></a></td><td>
<em>This module controls the precision used in MagIC</em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/IOAdd.html#f/probe_mod"><code class="xref">probe_mod</code></a></td><td>
<em>Module for artificial sensors to compare time series of physical data with experiments. Probes are located in a radially symmetrical way</em></td></tr>
<tr class="pcap"><td></td><td> </td><td></td></tr>
<tr class="cap" id="cap-r"><td></td><td>
<strong>r</strong></td><td></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/parallelModules.html#f/radial_data"><code class="xref">radial_data</code></a></td><td>
<em>This module defines the MPI decomposition in the radial direction.</em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/derInt.html#f/radial_der"><code class="xref">radial_der</code></a></td><td>
<em>Radial derivatives functions</em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/derInt.html#f/radial_der_even"><code class="xref">radial_der_even</code></a></td><td>
<em></em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/precalcModules.html#f/radial_functions"><code class="xref">radial_functions</code></a></td><td>
<em>This module initiates all the radial functions (transport properties, density, temperature, cheb transforms, etc.)</em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/legFourierChebAlgebra.html#f/radial_scheme"><code class="xref">radial_scheme</code></a></td><td>
<em>This is an abstract type that defines the radial scheme used in MagIC</em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/IOAdd.html#f/radial_spectra"><code class="xref">radial_spectra</code></a></td><td>
<em></em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/timeAdvNonLinear.html#f/radialloop"><code class="xref">radialloop</code></a></td><td>
<em></em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/checkPoints.html#f/readcheckpoints"><code class="xref">readcheckpoints</code></a></td><td>
<em>This module contains the functions that can help reading and mapping of the restart files</em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/legFourierChebAlgebra.html#f/real_matrices"><code class="xref">real_matrices</code></a></td><td>
<em></em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/timeAdvNonLinear.html#f/riter_mod"><code class="xref">riter_mod</code></a></td><td>
<em>This module actually handles the loop over the radial levels. It contains the spherical harmonic transforms and the operations on the arrays in physical space....</em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/timeAdvNonLinear.html#f/riteration"><code class="xref">riteration</code></a></td><td>
<em>This module is used to define an abstract class for the radial loop</em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/IOAdd.html#f/rms"><code class="xref">rms</code></a></td><td>
<em>This module contains the calculation of the RMS force balance and induction terms.</em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/IOAdd.html#f/rms_helpers"><code class="xref">rms_helpers</code></a></td><td>
<em>This module contains several useful subroutines required to compute RMS diagnostics</em></td></tr>
<tr class="pcap"><td></td><td> </td><td></td></tr>
<tr class="cap" id="cap-s"><td></td><td>
<strong>s</strong></td><td></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/legFourierChebAlgebra.html#f/sht"><code class="xref">sht</code></a></td><td>
<em></em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/legFourierChebAlgebra.html#f/shtransforms"><code class="xref">shtransforms</code></a></td><td>
<em>This module is used when the native built-in SH transforms of MagIC are used. Those are much slower than SHTns, and are not recommanded for production runs!</em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/baseModules.html#f/special"><code class="xref">special</code></a></td><td>
<em>This module contains all variables for the case of an imposed IC dipole, an imposed external magnetic field and a special boundary forcing to excite inertial modes</em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/IOGeneral.html#f/spectra"><code class="xref">spectra</code></a></td><td>
<em>This module handles the computation and the writing of spectra. It handles both 2-D spectra in (r,l) and (r,m) spaces and usual spectra integrated over all radii in (l) or (m) spaces....</em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/initModules.html#f/start_fields"><code class="xref">start_fields</code></a></td><td>
<em>This module is used to set-up the initial starting fields. They can be obtained by reading a starting checkpoint file or by setting some starting conditions.</em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/timeAdvance.html#f/step_time_mod"><code class="xref">step_time_mod</code></a></td><td>
<em></em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/checkPoints.html#f/storecheckpoints"><code class="xref">storecheckpoints</code></a></td><td>
<em>This module contains several subroutines that can be used to store the checkpoint_#.tag files</em></td></tr>
<tr class="pcap"><td></td><td> </td><td></td></tr>
<tr class="cap" id="cap-t"><td></td><td>
<strong>t</strong></td><td></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/timeAdvance.html#f/time_array"><code class="xref">time_array</code></a></td><td>
<em>This module defines two types that are defined to store the implicit/explicit terms at the different sub-stage/step.</em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/timeAdvance.html#f/time_schemes"><code class="xref">time_schemes</code></a></td><td>
<em>This module defines an abstract class type_tscheme which is employed for the time advance of the code.</em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/timeAdvance.html#f/timing"><code class="xref">timing</code></a></td><td>
<em>This module contains functions that are used to measure the time spent.</em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/IOAdd.html#f/torsional_oscillations"><code class="xref">torsional_oscillations</code></a></td><td>
<em>This module contains information for TO calculation and output</em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/baseModules.html#f/truncation"><code class="xref">truncation</code></a></td><td>
<em>This module defines the grid points and the truncation</em></td></tr>
<tr class="pcap"><td></td><td> </td><td></td></tr>
<tr class="cap" id="cap-u"><td></td><td>
<strong>u</strong></td><td></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/timeAdvLinear.html#f/updateb_mod"><code class="xref">updateb_mod</code></a></td><td>
<em>This module handles the time advance of the magnetic field potentials b and aj as well as the inner core counterparts b_ic and aj_ic. It contains the computation of the implicit terms and the linear</em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/timeAdvLinear.html#f/updatephi_mod"><code class="xref">updatephi_mod</code></a></td><td>
<em>This module handles the time advance of the phase field phi. It contains the computation of the implicit terms and the linear solves....</em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/timeAdvLinear.html#f/updates_mod"><code class="xref">updates_mod</code></a></td><td>
<em>This module handles the time advance of the entropy s. It contains the computation of the implicit terms and the linear solves....</em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/timeAdvLinear.html#f/updatewp_mod"><code class="xref">updatewp_mod</code></a></td><td>
<em>This module handles the time advance of the poloidal potential w and the pressure p. It contains the computation of the implicit terms and the linear solves.</em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/timeAdvLinear.html#f/updatewps_mod"><code class="xref">updatewps_mod</code></a></td><td>
<em>This module handles the time advance of the poloidal potential w, the pressure p and the entropy s in one single matrix per degree. It contains the computation of the implicit terms and the linear</em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/timeAdvLinear.html#f/updatexi_mod"><code class="xref">updatexi_mod</code></a></td><td>
<em>This module handles the time advance of the chemical composition xi. It contains the computation of the implicit terms and the linear solves....</em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/timeAdvLinear.html#f/updatez_mod"><code class="xref">updatez_mod</code></a></td><td>
<em>This module handles the time advance of the toroidal potential z It contains the computation of the implicit terms and the linear solves....</em></td></tr>
<tr>
<td></td>
<td>
<a href="apiFortran/misc.html#f/useful"><code class="xref">useful</code></a></td><td>
<em>This module contains several useful routines.</em></td></tr>
</table>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<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="#" 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="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>