Skip to content

Commit

Permalink
Deploying to main from @ terrapower/armi@5b3984b 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
john-science committed Sep 10, 2024
1 parent 7c00b6b commit 59c0320
Show file tree
Hide file tree
Showing 73 changed files with 2,773 additions and 1,859 deletions.
7 changes: 0 additions & 7 deletions armi/.apidocs/armi.reactor.blocks.html
Original file line number Diff line number Diff line change
Expand Up @@ -967,13 +967,6 @@ <h2>Parameter<a class="headerlink" href="#parameter" title="Permalink to this he
<dt>targetComponent: <a class="reference internal" href="armi.reactor.components.component.html#armi.reactor.components.component.Component" title="armi.reactor.components.component.Component"><code class="xref py py-class docutils literal notranslate"><span class="pre">Component</span></code></a> object</dt><dd><p>Component specified to be target component for axial expansion changer</p>
</dd>
</dl>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<dl class="simple">
<dt><code class="xref py py-obj docutils literal notranslate"><span class="pre">armi.reactor.converters.axialExpansionChanger.py</span></code></dt><dd><p>:ExpansionData::_setTargetComponents</p>
</dd>
</dl>
</div>
</section>
</dd></dl>

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,202 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta property="og:title" content="armi.reactor.converters.axialExpansionChanger.assemblyAxialLinkage module" />
<meta property="og:type" content="website" />
<meta property="og:url" content="https://terrapower.github.io/armi/.apidocs/armi.reactor.converters.axialExpansionChanger.assemblyAxialLinkage.html" />
<meta property="og:site_name" content="Advanced Reactor Modeling Interface" />
<meta property="og:image" content="https://terrapower.github.io/armi/_static/armiSchematicView.png" />
<meta property="og:image:alt" content="Advanced Reactor Modeling Interface" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>armi.reactor.converters.axialExpansionChanger.assemblyAxialLinkage module &mdash; ARMI 0.4.0 documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme_fixes.css" type="text/css" />
<link rel="stylesheet" href="../_static/graphviz.css" type="text/css" />
<link rel="stylesheet" href="../_static/sg_gallery.css" type="text/css" />
<link rel="stylesheet" href="../_static/sg_gallery-binder.css" type="text/css" />
<link rel="stylesheet" href="../_static/sg_gallery-dataframe.css" type="text/css" />
<link rel="stylesheet" href="../_static/sg_gallery-rendered-html.css" type="text/css" />
<link rel="shortcut icon" href="../_static/armiicon_16x16.ico"/>
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->

<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>
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.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="armi.reactor.converters.axialExpansionChanger.axialExpansionChanger module" href="armi.reactor.converters.axialExpansionChanger.axialExpansionChanger.html" />
<link rel="prev" title="armi.reactor.converters.axialExpansionChanger package" href="armi.reactor.converters.axialExpansionChanger.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" style="background: #233C5B" >



<a href="../index.html" class="icon icon-home">
ARMI
<img src="../_static/armiicon_24x24.ico" class="logo" alt="Logo"/>
</a>
<div class="version">
0.4.0
</div>
<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">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../user/index.html">User Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="../developer/index.html">Developer Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="../gallery/index.html">Gallery</a></li>
<li class="toctree-l1"><a class="reference internal" href="../tutorials/index.html">Tutorials</a></li>
<li class="toctree-l1"><a class="reference internal" href="../release/index.html">Release Notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../glossary.html">Glossary</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="modules.html">API Docs</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="armi.html">armi package</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="armi.html#armi.disableFutureConfigures"><code class="docutils literal notranslate"><span class="pre">disableFutureConfigures()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="armi.html#armi.isStableReleaseVersion"><code class="docutils literal notranslate"><span class="pre">isStableReleaseVersion()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="armi.html#armi.init"><code class="docutils literal notranslate"><span class="pre">init()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="armi.html#armi.getDefaultPlugins"><code class="docutils literal notranslate"><span class="pre">getDefaultPlugins()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="armi.html#armi.getDefaultPluginManager"><code class="docutils literal notranslate"><span class="pre">getDefaultPluginManager()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="armi.html#armi.isConfigured"><code class="docutils literal notranslate"><span class="pre">isConfigured()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="armi.html#armi.getPluginManager"><code class="docutils literal notranslate"><span class="pre">getPluginManager()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="armi.html#armi.getPluginManagerOrFail"><code class="docutils literal notranslate"><span class="pre">getPluginManagerOrFail()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="armi.html#armi.getApp"><code class="docutils literal notranslate"><span class="pre">getApp()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="armi.html#armi.configure"><code class="docutils literal notranslate"><span class="pre">configure()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="armi.html#armi.applyAsyncioWindowsWorkaround"><code class="docutils literal notranslate"><span class="pre">applyAsyncioWindowsWorkaround()</span></code></a></li>
<li class="toctree-l3 current"><a class="reference internal" href="armi.html#subpackages">Subpackages</a><ul class="current">
<li class="toctree-l4"><a class="reference internal" href="armi.bookkeeping.html">armi.bookkeeping package</a></li>
<li class="toctree-l4"><a class="reference internal" href="armi.cases.html">armi.cases package</a></li>
<li class="toctree-l4"><a class="reference internal" href="armi.cli.html">armi.cli package</a></li>
<li class="toctree-l4"><a class="reference internal" href="armi.materials.html">armi.materials package</a></li>
<li class="toctree-l4"><a class="reference internal" href="armi.migration.html">armi.migration package</a></li>
<li class="toctree-l4"><a class="reference internal" href="armi.nucDirectory.html">armi.nucDirectory package</a></li>
<li class="toctree-l4"><a class="reference internal" href="armi.nuclearDataIO.html">armi.nuclearDataIO package</a></li>
<li class="toctree-l4"><a class="reference internal" href="armi.operators.html">armi.operators package</a></li>
<li class="toctree-l4"><a class="reference internal" href="armi.physics.html">armi.physics package</a></li>
<li class="toctree-l4 current"><a class="reference internal" href="armi.reactor.html">armi.reactor package</a></li>
<li class="toctree-l4"><a class="reference internal" href="armi.settings.html">armi.settings package</a></li>
<li class="toctree-l4"><a class="reference internal" href="armi.tests.html">armi.tests package</a></li>
<li class="toctree-l4"><a class="reference internal" href="armi.utils.html">armi.utils package</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="armi.html#submodules">Submodules</a></li>
</ul>
</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" style="background: #233C5B" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">ARMI</a>
</nav>

<div class="wy-nav-content">
<div class="rst-content style-external-links">
<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">armi</a></li>
<li class="breadcrumb-item"><a href="armi.html">armi package</a></li>
<li class="breadcrumb-item"><a href="armi.reactor.html">armi.reactor package</a></li>
<li class="breadcrumb-item"><a href="armi.reactor.converters.html">armi.reactor.converters package</a></li>
<li class="breadcrumb-item"><a href="armi.reactor.converters.axialExpansionChanger.html">armi.reactor.converters.axialExpansionChanger package</a></li>
<li class="breadcrumb-item active">armi.reactor.converters.axialExpansionChanger.assemblyAxialLinkage module</li>
<li class="wy-breadcrumbs-aside">



</li>

</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">

<section id="module-armi.reactor.converters.axialExpansionChanger.assemblyAxialLinkage">
<span id="armi-reactor-converters-axialexpansionchanger-assemblyaxiallinkage-module"></span><h1>armi.reactor.converters.axialExpansionChanger.assemblyAxialLinkage module<a class="headerlink" href="#module-armi.reactor.converters.axialExpansionChanger.assemblyAxialLinkage" title="Permalink to this heading"></a></h1>
<dl class="py class">
<dt class="sig sig-object py" id="armi.reactor.converters.axialExpansionChanger.assemblyAxialLinkage.AssemblyAxialLinkage">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">armi.reactor.converters.axialExpansionChanger.assemblyAxialLinkage.</span></span><span class="sig-name descname"><span class="pre">AssemblyAxialLinkage</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">StdAssem</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/armi/reactor/converters/axialExpansionChanger/assemblyAxialLinkage.html#AssemblyAxialLinkage"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#armi.reactor.converters.axialExpansionChanger.assemblyAxialLinkage.AssemblyAxialLinkage" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>Determines and stores the block- and component-wise axial linkage for an assembly.</p>
<dl class="field-list simple">
<dt class="field-odd">Variables<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>a</strong> (<a class="reference internal" href="armi.reactor.assemblies.html#armi.reactor.assemblies.Assembly" title="armi.reactor.assemblies.Assembly"><code class="xref py py-class docutils literal notranslate"><span class="pre">Assembly</span></code></a>) – reference to original assembly; is directly modified/changed during expansion.</p></li>
<li><p><strong>linkedBlocks</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><em>dict</em></a>) – <ul>
<li><p>keys = <a class="reference internal" href="armi.reactor.blocks.html#armi.reactor.blocks.Block" title="armi.reactor.blocks.Block"><code class="xref py py-class docutils literal notranslate"><span class="pre">Block</span></code></a></p></li>
<li><p>values = list of axially linked blocks; index 0 = lower linked block; index 1: upper
linked block.</p></li>
</ul>
</p></li>
<li><p><strong>linkedComponents</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><em>dict</em></a>) – <ul>
<li><p>keys = <a class="reference internal" href="armi.reactor.components.component.html#armi.reactor.components.component.Component" title="armi.reactor.components.component.Component"><code class="xref py py-class docutils literal notranslate"><span class="pre">Component</span></code></a></p></li>
<li><p>values = list of axially linked components; index 0 = lower linked component;
index 1: upper linked component.</p></li>
</ul>
</p></li>
</ul>
</dd>
</dl>
</dd></dl>

</section>


</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="armi.reactor.converters.axialExpansionChanger.html" class="btn btn-neutral float-left" title="armi.reactor.converters.axialExpansionChanger package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="armi.reactor.converters.axialExpansionChanger.axialExpansionChanger.html" class="btn btn-neutral float-right" title="armi.reactor.converters.axialExpansionChanger.axialExpansionChanger module" 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 2009-2024, TerraPower, LLC.
<span class="lastupdated">Last updated on 2024-09-10.
</span></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>
Loading

0 comments on commit 59c0320

Please sign in to comment.