-
Notifications
You must be signed in to change notification settings - Fork 7
/
current_data.html
306 lines (280 loc) · 13.1 KB
/
current_data.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
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<title>current_data — Clawpack 5.10.x documentation</title>
<link rel="stylesheet" href="_static/base.css" type="text/css" />
<link rel="stylesheet" href="_static/layout.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/flasky.css" />
<link rel="stylesheet" type="text/css" href="_static/graphviz.css" />
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<link rel="shortcut icon" href="_static/clawicon.ico"/>
<link rel="author" title="About these documents" href="about.html" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Plotting examples" href="plotexamples.html" />
<link rel="prev" title="ClawPlotItem" href="ClawPlotItem.html" />
</head><body>
<div id="main-wrapper" class="sphinx">
<div id="header-wrapper">
<section id="header">
<!-- <h1><a href="http://clawpack.org/">Clawpack</a></h1> -->
<h1><a href="http://clawpack.org/">Clawpack-5</a></h1>
<nav>
<ul>
<li>
<a href="contents.html">Docs</a>
</li>
<li>
<a href="installing.html">Install</a>
</li>
<li>
<a class="" href="http://clawpack.org/gallery/index.html">Gallery</a>
</li>
<li>
<a href="about.html">Citation</a>
</li>
<li>
<a class="active" href="http://github.com/clawpack">GitHub</a>
</li>
<li>
<a class="" href="community.html">Community</a>
</li>
<li>
<a class="" href="developers.html">Contribute</a>
</li>
</ul>
</nav>
</section>
<div class="decoration"></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="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="plotexamples.html" title="Plotting examples"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="ClawPlotItem.html" title="ClawPlotItem"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="contents.html">Clawpack 5.10.x documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="plotting.html" accesskey="U">Plotting with Visclaw</a> »</li>
<li class="nav-item nav-item-this"><a href="">current_data</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="current-data">
<span id="id1"></span><h1>current_data<a class="headerlink" href="#current-data" title="Permalink to this heading">¶</a></h1>
<p>The Python plotting routines often allow the user to specify a call back
function as plotting parameters, for example <a class="reference internal" href="ClawPlotAxes.html#clawplotaxes"><span class="std std-ref">ClawPlotAxes</span></a> has an
attribute <em>afteraxes</em> that can be set to a function to be executed after
performing all plots on the specified axes. This is useful for setting
parameters for these axes that are not covered by the provided attributes,
for annotating the plots on these axes, for adding a plot of the true
solution, etc.</p>
<p>Call back functions include:</p>
<blockquote>
<div><ul class="simple">
<li><p><em>beforeframe</em> and <em>afterframe</em> attributes of <a class="reference internal" href="ClawPlotData.html#clawplotdata"><span class="std std-ref">ClawPlotData</span></a></p></li>
<li><p><em>afteraxes</em> attribute of <a class="reference internal" href="ClawPlotAxes.html#clawplotaxes"><span class="std std-ref">ClawPlotAxes</span></a></p></li>
<li><p><em>afteritem</em>, <em>afterpatch</em>, <em>plot_var</em>, <em>map2d_to_1d</em> attributes of <a class="reference internal" href="ClawPlotItem.html#clawplotitem"><span class="std std-ref">ClawPlotItem</span></a></p></li>
</ul>
</div></blockquote>
<p>All of these functions are designed to take a single argument
<em>current_data</em>, an object with attributes that may be useful to the user in
evaluating the function.</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p><a class="reference internal" href="mapc2p.html#mapc2p"><span class="std std-ref">The mapc2p function</span></a> is one exception that does not take argument <em>current_data</em>.</p>
</div>
<section id="attributes-of-current-data">
<h2>Attributes of <em>current_data</em>:<a class="headerlink" href="#attributes-of-current-data" title="Permalink to this heading">¶</a></h2>
<p>Some of these may be unavailable because they don’t make sense in the
current context, e.g. in a <em>beforeframe</em> function.</p>
<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">plotdata</span> <span class="pre">:</span></span></dt>
<dd><p>parent <a class="reference internal" href="ClawPlotData.html#clawplotdata"><span class="std std-ref">ClawPlotData</span></a> object. From this object virtually any
relevant data can be accessed. Other attributes are defined for
convenience. If you find you frequently
need something else, you could modify <code class="xref py py-mod docutils literal notranslate"><span class="pre">pyclaw.plotters.frametools</span></code>
to add this to <em>current_data</em>.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">frameno</span> <span class="pre">:</span></span></dt>
<dd><p>The current frame number</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">patch</span> <span class="pre">:</span></span></dt>
<dd><p>Object of <code class="xref py py-class docutils literal notranslate"><span class="pre">pyclaw.solution.patch</span></code> with data for the last patch
plotted.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">patchno</span> <span class="pre">:</span></span></dt>
<dd><p>Grid number of this patch, of interest only in AMR calculations.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">q</span> <span class="pre">:</span></span></dt>
<dd><p>q array for current frame, so for example the in a scalar 2d problem the
value in the (i,j) cell would be <em>current_data.q[0,i,j]</em> (remember that
Python always indexes starting at 0).</p>
<p>In an AMR calculation q will be from the last patch plotted.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">aux</span> <span class="pre">:</span></span></dt>
<dd><p>aux array for current frame, provided these have been output by the
Fortran code. At the moment this requires modifying the library routine
<cite>outN.f</cite> to set outaux = .true. so that fort.a files are produced along
with fort.q files. [This should be an input parameter!]</p>
<p>If fort.a files are not found then current_data.aux will be None.</p>
<p>In an AMR calculation aux will be from the last patch plotted.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">var</span> <span class="pre">:</span></span></dt>
<dd><p>array of the variable actually plotted most recently, e.g. if
<em>plotitem.plot_var == 0</em> then in 2d <em>current_data.var[i,j] ==
current_data.q[0,i,j]</em>.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">level</span> <span class="pre">:</span></span></dt>
<dd><p>For AMR computations, where <em>current_data.patch</em> is for the last patch plotted,
<em>current_data.level</em> is the AMR level of this patch. Particularly useful
in <cite>afterpatch</cite> functions.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">t</span> <span class="pre">:</span></span></dt>
<dd><p>the current time t.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">x</span> <span class="pre">:</span></span></dt>
<dd><p>x array of cell centers corresponding to <em>current_data.q</em>.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">y</span> <span class="pre">:</span></span></dt>
<dd><p>y array of cell centers corresponding to <em>current_data.q</em> (only in 2d).</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">xlower</span> <span class="pre">:</span></span></dt>
<dd><p>left edge of current patch.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">ylower</span> <span class="pre">:</span></span></dt>
<dd><p>left edge of current patch in y (only in 2d).</p>
</dd></dl>
</section>
</section>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p><a href="http://clawpack.org/">
<img class="logo" src= "_static/clawlogo.jpg" alt="Logo"/>
</a>
<h2>Version 5.10.x</h2>
</p>
<div>
<h3><a href="contents.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">current_data</a><ul>
<li><a class="reference internal" href="#attributes-of-current-data">Attributes of <em>current_data</em>:</a></li>
</ul>
</li>
</ul>
</div><h3>Related Topics</h3>
<ul>
<li><a href="contents.html">Documentation overview</a><ul>
<li><a href="plotting.html">Plotting with Visclaw</a><ul>
<li>Previous: <a href="ClawPlotItem.html" title="previous chapter">ClawPlotItem</a></li>
<li>Next: <a href="plotexamples.html" title="next chapter">Plotting examples</a></li>
</ul></li>
</ul></li>
</ul>
<div class="widget navlinks">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/current_data.rst.txt"
rel="nofollow"
target="_blank">Source .rst</a></li>
<li><a href="https://github.com/clawpack/doc/blob/dev/doc/current_data.rst"
rel="nofollow"
target="_blank">Source on GitHub</a></li>
<li><a href="https://github.com/clawpack/doc/commits/dev/doc/current_data.rst"
rel="nofollow"
target="_blank">History</a></li>
<li><a href="https://github.com/clawpack/doc/edit/dev/doc/current_data.rst"
rel="nofollow"
target="_blank">Suggest Edits</a></li>
<li><a href="https://github.com/clawpack/doc/issues/new/choose"
rel="nofollow"
target="_blank">Raise an Issue</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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<h4>Latest Version</h4>
<ul>
<li><a href="./dev/current_data.html">dev</a></li>
<li><a href="current_data.html">v5.10.x</a></li>
</ul>
<h4>Older Versions</h4>
<ul>
<li><a href="./v5.7.x/current_data.html">v5.7.x</a></li>
<li><a href="./v5.8.x/current_data.html">v5.8.x</a></li>
<li><a href="./v5.9.x/current_data.html">v5.9.x</a></li>
</ul>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
© Copyright CC-BY 2024, The Clawpack Development Team.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a>.
</div>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-44811544-1', 'auto');
ga('send', 'pageview');
</script>
</body>
</html>