-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathsignalFile.html
More file actions
225 lines (213 loc) · 12.7 KB
/
signalFile.html
File metadata and controls
225 lines (213 loc) · 12.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
<!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>Interactive communication with the code using signal.TAG — 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>
<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="Output files" href="outputFiles/outFiles.html" />
<link rel="prev" title="Mantle and Inner Core Namelists" href="inputNamelists/mantle_icNamelist.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="outputFiles/outFiles.html" title="Output files"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="inputNamelists/mantle_icNamelist.html" title="Mantle and Inner Core Namelists"
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="">Interactive communication with the code using <code class="docutils literal notranslate"><span class="pre">signal.TAG</span></code></a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="interactive-communication-with-the-code-using-signal-tag">
<h1>Interactive communication with the code using <code class="docutils literal notranslate"><span class="pre">signal.TAG</span></code><a class="headerlink" href="#interactive-communication-with-the-code-using-signal-tag" title="Link to this heading">¶</a></h1>
<p>It is possible to interactively communicate with the MagIC code <strong>during a run</strong>,
using a file which is systematically created when the simulation starts, called
<strong>signal.TAG</strong>. By default, this file contains only the word <code class="docutils literal notranslate"><span class="pre">NOT</span></code> and does
nothing to the simulation. Replacing <code class="docutils literal notranslate"><span class="pre">NOT</span></code> by one of the following allowed
keywords will have some influence on the outputs or possibly force the code to
terminate its execution:</p>
<blockquote>
<div><ul class="simple">
<li><p><strong>END</strong>: Changing the word <code class="docutils literal notranslate"><span class="pre">NOT</span></code> to <code class="docutils literal notranslate"><span class="pre">END</span></code> will cause the code to
finish after the current time step and write all the outputs as if it was
programmed to finish at that time from the start. This will thus normally
produce the <a class="reference internal" href="outputFiles/outRst.html#secrestartfile"><span class="std std-ref">checkpoint_end.TAG</span></a> file that will possibly
allow you to continue this run later at your convenience.</p></li>
<li><p><strong>GRA</strong>: Changing the word <code class="docutils literal notranslate"><span class="pre">NOT</span></code> to <code class="docutils literal notranslate"><span class="pre">GRA</span></code> will cause the code to produce
a graphic ouptut file <a class="reference internal" href="outputFiles/outGraph.html#secgraphfile"><span class="std std-ref">G_#.TAG</span></a>. The keyword will be
automatically restored to <code class="docutils literal notranslate"><span class="pre">NOT</span></code> once the graphic file has been produced.</p></li>
<li><p><strong>RST</strong>: Changing the word <code class="docutils literal notranslate"><span class="pre">NOT</span></code> to <code class="docutils literal notranslate"><span class="pre">RST</span></code> will cause the code to produce
a restart file <a class="reference internal" href="outputFiles/outRst.html#secrestartfile"><span class="std std-ref">checkpoint_t#.TAG</span></a>. The keyword will then be
restored to <code class="docutils literal notranslate"><span class="pre">NOT</span></code> once the restart file has been written.</p></li>
<li><p><strong>SPE</strong>: Changing the word <code class="docutils literal notranslate"><span class="pre">NOT</span></code> to <code class="docutils literal notranslate"><span class="pre">SPE</span></code> will cause the code to produce
spectra <a class="reference internal" href="outputFiles/outSpecFiles.html#seckinspecfile"><span class="std std-ref">kin_spec_#.TAG</span></a> (and possibly
<a class="reference internal" href="outputFiles/outSpecFiles.html#secmagspecfile"><span class="std std-ref">mag_spec_#.TAG</span></a> and <cite>T_spec_#.TAG <secTSpecFile></cite> depending
if the run is magnetic or not, or if it solves a temperature/entropy equation).
Once the spectra files have been written, the keyword will be automatically replaced
by <code class="docutils literal notranslate"><span class="pre">NOT</span></code>.</p></li>
<li><p><strong>POT</strong>: Changing the word <code class="docutils literal notranslate"><span class="pre">NOT</span></code> to <code class="docutils literal notranslate"><span class="pre">POT</span></code> will cause the code to produce
the potential files <a class="reference internal" href="outputFiles/outPotFiles.html#secpotfiles"><span class="std std-ref">V_lmr_#.TAG</span></a> (and possibly
<a class="reference internal" href="outputFiles/outPotFiles.html#secpotfiles"><span class="std std-ref">B_lmr_#.TAG</span></a>, <cite>T_lmr_#.TAG <secPotFiles></cite> and
<cite>Xi_lmr_#.TAG <secPotFiles></cite> depending
if the run is magnetic or not, or if it solves a temperature/entropy and/or
chemical composition equations).
Once the potential files have been written, the keyword will be automatically replaced
by <code class="docutils literal notranslate"><span class="pre">NOT</span></code>.</p></li>
</ul>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Those keywords are <strong>case-insensitive</strong>.</p>
</div>
</div></blockquote>
<p>Instead of editing the file with your favorite editor to specify the requested
keyword, we recommand using instead the shell command <code class="docutils literal notranslate"><span class="pre">echo</span></code> to avoid some
possible crash during the code execution when writing into the <code class="docutils literal notranslate"><span class="pre">signal.TAG</span></code>
file. For instance, if you want a <a class="reference internal" href="outputFiles/outGraph.html#secgraphfile"><span class="std std-ref">graphic output file</span></a>, just use
the following command (adapted to your current <a class="reference internal" href="inputNamelists/controlNamelist.html#vartag"><span class="std std-ref">TAG</span></a>):</p>
<blockquote>
<div><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span><span class="nb">echo</span><span class="w"> </span>GRA<span class="w"> </span>><span class="w"> </span>signal.TAG
</pre></div>
</div>
</div></blockquote>
</section>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="inputNamelists/mantle_icNamelist.html"
title="previous chapter">Mantle and Inner Core Namelists</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="outputFiles/outFiles.html"
title="next chapter">Output files</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/signalFile.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="outputFiles/outFiles.html" title="Output files"
>next</a> |</li>
<li class="right" >
<a href="inputNamelists/mantle_icNamelist.html" title="Mantle and Inner Core Namelists"
>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="">Interactive communication with the code using <code class="docutils literal notranslate"><span class="pre">signal.TAG</span></code></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>