current_data.html

<!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>current_data &#8212; Clawpack 5.14.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?v=03e43079" />
    <link rel="stylesheet" type="text/css" href="_static/flasky.css?v=59fe8e2d" />
    <link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=4ae1632d" />
    <script src="_static/documentation_options.js?v=f5e26b61"></script>
    <script src="_static/doctools.js?v=9bcbadda"></script>
    <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
    <link rel="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">
      <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.14.x documentation</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="plotting.html" accesskey="U">Plotting with Visclaw</a> &#187;</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="Link 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="Link 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">
        <div class="sphinxsidebarwrapper">
<p><a href="http://clawpack.org/">
    <img class="logo" src= "_static/clawlogo.jpg" alt="Logo"/>
</a>
<h2>Version 5.14.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>
<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>
<h4>Latest Version</h4>
<ul>
  <li><a href="./dev/current_data.html">dev</a></li>
  <li><a href="current_data.html">v5.14.x</a></li>
</ul>
<h4>Older Versions</h4>
<ul>
  <li><a href="./v5.10.x/current_data.html">v5.10.x</a></li>
  <li><a href="./v5.11.x/current_data.html">v5.11.x</a></li>
  <li><a href="./v5.12.x/current_data.html">v5.12.x</a></li>
  <li><a href="./v5.13.x/current_data.html">v5.13.x</a></li>
  <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">
    &copy; Copyright CC-BY 2026, 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>