AtHeartEngineer/kaipy
1
0
Fork 0
mirror of https://github.com/JHUAPL/kaipy.git synced 2026-01-09 14:28:02 -05:00
Code Issues Packages Projects Releases Wiki Activity
Files
eb7d82c9b76c3247fc2a6d04458d054b11faef1c
kaipy/docs/build/html/embiggenUtils.html
wiltbemj eb7d82c9b7 Initial setup to work with sphinx for autodoc
2024-06-12 11:47:04 -04:00

227 lines
23 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html class="writer-html5" lang="en">
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>embiggenUtils module &mdash; Kaipy 1.0.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="_static/jquery.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="gamera package" href="gamera.html" />
<link rel="prev" title="chimp package" href="chimp.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home">
Kaipy
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="modules.html">kaipy</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="cdaweb_utils.html">cdaweb_utils module</a></li>
<li class="toctree-l2"><a class="reference internal" href="chimp.html">chimp package</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">embiggenUtils module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#embiggenUtils.Bvec2Global"><code class="docutils literal notranslate"><span class="pre">Bvec2Global()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#embiggenUtils.CompRestarts"><code class="docutils literal notranslate"><span class="pre">CompRestarts()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#embiggenUtils.Corner2Global"><code class="docutils literal notranslate"><span class="pre">Corner2Global()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#embiggenUtils.Flux2Global"><code class="docutils literal notranslate"><span class="pre">Flux2Global()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#embiggenUtils.Gas2Global"><code class="docutils literal notranslate"><span class="pre">Gas2Global()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#embiggenUtils.MaxDiv"><code class="docutils literal notranslate"><span class="pre">MaxDiv()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#embiggenUtils.PullRestartMPI"><code class="docutils literal notranslate"><span class="pre">PullRestartMPI()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#embiggenUtils.PushRestartMPI"><code class="docutils literal notranslate"><span class="pre">PushRestartMPI()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#embiggenUtils.Volume"><code class="docutils literal notranslate"><span class="pre">Volume()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#embiggenUtils.ccL2G"><code class="docutils literal notranslate"><span class="pre">ccL2G()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#embiggenUtils.upCCMag"><code class="docutils literal notranslate"><span class="pre">upCCMag()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#embiggenUtils.upFlux"><code class="docutils literal notranslate"><span class="pre">upFlux()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#embiggenUtils.upGas"><code class="docutils literal notranslate"><span class="pre">upGas()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#embiggenUtils.upGrid"><code class="docutils literal notranslate"><span class="pre">upGrid()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#embiggenUtils.upVarCC"><code class="docutils literal notranslate"><span class="pre">upVarCC()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="gamera.html">gamera package</a></li>
<li class="toctree-l2"><a class="reference internal" href="gamhelio.html">gamhelio package</a></li>
<li class="toctree-l2"><a class="reference internal" href="kJobs.html">kJobs module</a></li>
<li class="toctree-l2"><a class="reference internal" href="kaiH5.html">kaiH5 module</a></li>
<li class="toctree-l2"><a class="reference internal" href="kaiTools.html">kaiTools module</a></li>
<li class="toctree-l2"><a class="reference internal" href="kaiViz.html">kaiViz module</a></li>
<li class="toctree-l2"><a class="reference internal" href="kaijson.html">kaijson module</a></li>
<li class="toctree-l2"><a class="reference internal" href="kaixdmf.html">kaixdmf module</a></li>
<li class="toctree-l2"><a class="reference internal" href="kdefs.html">kdefs module</a></li>
<li class="toctree-l2"><a class="reference internal" href="lfm2kaiju.html">lfm2kaiju module</a></li>
<li class="toctree-l2"><a class="reference internal" href="paraview.html">paraview package</a></li>
<li class="toctree-l2"><a class="reference internal" href="rcm.html">rcm package</a></li>
<li class="toctree-l2"><a class="reference internal" href="remix.html">remix package</a></li>
<li class="toctree-l2"><a class="reference internal" href="solarWind.html">solarWind package</a></li>
<li class="toctree-l2"><a class="reference internal" href="supermag_api.html">supermag_api module</a></li>
<li class="toctree-l2"><a class="reference internal" href="supermage.html">supermage module</a></li>
<li class="toctree-l2"><a class="reference internal" href="transform.html">transform module</a></li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Kaipy</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="modules.html">kaipy</a></li>
<li class="breadcrumb-item active">embiggenUtils module</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/embiggenUtils.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="module-embiggenUtils">
<span id="embiggenutils-module"></span><h1>embiggenUtils module<a class="headerlink" href="#module-embiggenUtils" title="Permalink to this heading"></a></h1>
<dl class="py function">
<dt class="sig sig-object py" id="embiggenUtils.Bvec2Global">
<span class="sig-prename descclassname"><span class="pre">embiggenUtils.</span></span><span class="sig-name descname"><span class="pre">Bvec2Global</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">B</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vID</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">iH5</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">i</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">j</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">k</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Ri</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Rj</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Rk</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Nip</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Njp</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Nkp</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#embiggenUtils.Bvec2Global" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="embiggenUtils.CompRestarts">
<span class="sig-prename descclassname"><span class="pre">embiggenUtils.</span></span><span class="sig-name descname"><span class="pre">CompRestarts</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">iStr</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">oStr</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nRes</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Ri</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Rj</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Rk</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#embiggenUtils.CompRestarts" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="embiggenUtils.Corner2Global">
<span class="sig-prename descclassname"><span class="pre">embiggenUtils.</span></span><span class="sig-name descname"><span class="pre">Corner2Global</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">Q</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vID</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">iH5</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">i</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">j</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">k</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Ri</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Rj</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Rk</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Nip</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Njp</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Nkp</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#embiggenUtils.Corner2Global" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="embiggenUtils.Flux2Global">
<span class="sig-prename descclassname"><span class="pre">embiggenUtils.</span></span><span class="sig-name descname"><span class="pre">Flux2Global</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">M</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vID</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">iH5</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">i</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">j</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">k</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Ri</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Rj</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Rk</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Nip</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Njp</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Nkp</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#embiggenUtils.Flux2Global" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="embiggenUtils.Gas2Global">
<span class="sig-prename descclassname"><span class="pre">embiggenUtils.</span></span><span class="sig-name descname"><span class="pre">Gas2Global</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">G</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vID</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">iH5</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">i</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">j</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">k</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Ri</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Rj</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Rk</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Nip</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Njp</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Nkp</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#embiggenUtils.Gas2Global" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="embiggenUtils.MaxDiv">
<span class="sig-prename descclassname"><span class="pre">embiggenUtils.</span></span><span class="sig-name descname"><span class="pre">MaxDiv</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">M</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#embiggenUtils.MaxDiv" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="embiggenUtils.PullRestartMPI">
<span class="sig-prename descclassname"><span class="pre">embiggenUtils.</span></span><span class="sig-name descname"><span class="pre">PullRestartMPI</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bStr</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nRes</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Ri</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Rj</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Rk</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#embiggenUtils.PullRestartMPI" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="embiggenUtils.PushRestartMPI">
<span class="sig-prename descclassname"><span class="pre">embiggenUtils.</span></span><span class="sig-name descname"><span class="pre">PushRestartMPI</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">outid</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nRes</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Ri</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Rj</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Rk</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">X</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Y</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Z</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nG</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nM</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nB</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">oG</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">oM</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">oB</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">G0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">f0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dtScl</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1.0</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#embiggenUtils.PushRestartMPI" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="embiggenUtils.Volume">
<span class="sig-prename descclassname"><span class="pre">embiggenUtils.</span></span><span class="sig-name descname"><span class="pre">Volume</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">Xg</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Yg</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Zg</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#embiggenUtils.Volume" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="embiggenUtils.ccL2G">
<span class="sig-prename descclassname"><span class="pre">embiggenUtils.</span></span><span class="sig-name descname"><span class="pre">ccL2G</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">i</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Ri</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Nip</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#embiggenUtils.ccL2G" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="embiggenUtils.upCCMag">
<span class="sig-prename descclassname"><span class="pre">embiggenUtils.</span></span><span class="sig-name descname"><span class="pre">upCCMag</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">B</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dV0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dVu</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vID</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'Bxyz'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#embiggenUtils.upCCMag" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="embiggenUtils.upFlux">
<span class="sig-prename descclassname"><span class="pre">embiggenUtils.</span></span><span class="sig-name descname"><span class="pre">upFlux</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">M</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#embiggenUtils.upFlux" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="embiggenUtils.upGas">
<span class="sig-prename descclassname"><span class="pre">embiggenUtils.</span></span><span class="sig-name descname"><span class="pre">upGas</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">G</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dV0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dVu</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vID</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'Gas'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#embiggenUtils.upGas" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="embiggenUtils.upGrid">
<span class="sig-prename descclassname"><span class="pre">embiggenUtils.</span></span><span class="sig-name descname"><span class="pre">upGrid</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">X</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Y</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Z</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#embiggenUtils.upGrid" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="embiggenUtils.upVarCC">
<span class="sig-prename descclassname"><span class="pre">embiggenUtils.</span></span><span class="sig-name descname"><span class="pre">upVarCC</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">Q</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dV0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dVu</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#embiggenUtils.upVarCC" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="chimp.html" class="btn btn-neutral float-left" title="chimp package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="gamera.html" class="btn btn-neutral float-right" title="gamera package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2024, Center for Geospace Storms.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink