Deploying to main from @ terrapower/armi@6ad5fa5 🚀

armi/.apidocs/armi.physics.html

@@ -288,6 +288,7 @@ <h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to thi
 <li class="toctree-l2"><a class="reference internal" href="armi.physics.neutronics.html#armi.physics.neutronics.NeutronicsPlugin"><code class="docutils literal notranslate"><span class="pre">NeutronicsPlugin</span></code></a><ul>
 <li class="toctree-l3"><a class="reference internal" href="armi.physics.neutronics.html#armi.physics.neutronics.NeutronicsPlugin.exposeInterfaces"><code class="docutils literal notranslate"><span class="pre">NeutronicsPlugin.exposeInterfaces()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="armi.physics.neutronics.html#armi.physics.neutronics.NeutronicsPlugin.defineParameters"><code class="docutils literal notranslate"><span class="pre">NeutronicsPlugin.defineParameters()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="armi.physics.neutronics.html#armi.physics.neutronics.NeutronicsPlugin.defineParameterRenames"><code class="docutils literal notranslate"><span class="pre">NeutronicsPlugin.defineParameterRenames()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="armi.physics.neutronics.html#armi.physics.neutronics.NeutronicsPlugin.defineEntryPoints"><code class="docutils literal notranslate"><span class="pre">NeutronicsPlugin.defineEntryPoints()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="armi.physics.neutronics.html#armi.physics.neutronics.NeutronicsPlugin.defineSettings"><code class="docutils literal notranslate"><span class="pre">NeutronicsPlugin.defineSettings()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="armi.physics.neutronics.html#armi.physics.neutronics.NeutronicsPlugin.defineSettingsValidators"><code class="docutils literal notranslate"><span class="pre">NeutronicsPlugin.defineSettingsValidators()</span></code></a></li>
@@ -340,6 +341,7 @@ <h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to thi
 <li class="toctree-l4"><a class="reference internal" href="armi.physics.neutronics.crossSectionGroupManager.html#armi.physics.neutronics.crossSectionGroupManager.BlockCollection"><code class="docutils literal notranslate"><span class="pre">BlockCollection</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="armi.physics.neutronics.crossSectionGroupManager.html#armi.physics.neutronics.crossSectionGroupManager.MedianBlockCollection"><code class="docutils literal notranslate"><span class="pre">MedianBlockCollection</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="armi.physics.neutronics.crossSectionGroupManager.html#armi.physics.neutronics.crossSectionGroupManager.AverageBlockCollection"><code class="docutils literal notranslate"><span class="pre">AverageBlockCollection</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="armi.physics.neutronics.crossSectionGroupManager.html#armi.physics.neutronics.crossSectionGroupManager.getBlockNuclideTemperature"><code class="docutils literal notranslate"><span class="pre">getBlockNuclideTemperature()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="armi.physics.neutronics.crossSectionGroupManager.html#armi.physics.neutronics.crossSectionGroupManager.getBlockNuclideTemperatureAvgTerms"><code class="docutils literal notranslate"><span class="pre">getBlockNuclideTemperatureAvgTerms()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="armi.physics.neutronics.crossSectionGroupManager.html#armi.physics.neutronics.crossSectionGroupManager.CylindricalComponentsAverageBlockCollection"><code class="docutils literal notranslate"><span class="pre">CylindricalComponentsAverageBlockCollection</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="armi.physics.neutronics.crossSectionGroupManager.html#armi.physics.neutronics.crossSectionGroupManager.CylindricalComponentsDuctHetAverageBlockCollection"><code class="docutils literal notranslate"><span class="pre">CylindricalComponentsDuctHetAverageBlockCollection</span></code></a></li>

armi/.apidocs/armi.physics.neutronics.crossSectionGroupManager.html

@@ -156,6 +156,7 @@
 <p class="rubric">Examples</p>
 <p>csm = CrossSectionGroupManager()
 csm._setBuGroupBounds(cs[‘buGroups’])
+csm._setTempGroupBounds(cs[‘tempGroups’]) # or empty list
 csm._addXsGroupsFromBlocks(blockList)
 csm.createRepresentativeBlocks()
 representativeBlockList = csm.representativeBlocks.values()
@@ -252,6 +253,12 @@
 removal fractions.</p>
 </dd></dl>
 
+<dl class="py function">
+<dt class="sig sig-object py" id="armi.physics.neutronics.crossSectionGroupManager.getBlockNuclideTemperature">
+<span class="sig-prename descclassname"><span class="pre">armi.physics.neutronics.crossSectionGroupManager.</span></span><span class="sig-name descname"><span class="pre">getBlockNuclideTemperature</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">block</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nuclide</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/armi/physics/neutronics/crossSectionGroupManager.html#getBlockNuclideTemperature"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#armi.physics.neutronics.crossSectionGroupManager.getBlockNuclideTemperature" title="Permalink to this definition"></a></dt>
+<dd><p>Return the average temperature for 1 nuclide.</p>
+</dd></dl>
+
 <dl class="py function">
 <dt class="sig sig-object py" id="armi.physics.neutronics.crossSectionGroupManager.getBlockNuclideTemperatureAvgTerms">
 <span class="sig-prename descclassname"><span class="pre">armi.physics.neutronics.crossSectionGroupManager.</span></span><span class="sig-name descname"><span class="pre">getBlockNuclideTemperatureAvgTerms</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">block</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allNucNames</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/armi/physics/neutronics/crossSectionGroupManager.html#getBlockNuclideTemperatureAvgTerms"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#armi.physics.neutronics.crossSectionGroupManager.getBlockNuclideTemperatureAvgTerms" title="Permalink to this definition"></a></dt>
@@ -468,23 +475,23 @@
 </dd></dl>
 
 <dl class="py method">
-<dt class="sig sig-object py" id="armi.physics.neutronics.crossSectionGroupManager.CrossSectionGroupManager.disableBuGroupUpdates">
-<span class="sig-name descname"><span class="pre">disableBuGroupUpdates</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/armi/physics/neutronics/crossSectionGroupManager.html#CrossSectionGroupManager.disableBuGroupUpdates"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#armi.physics.neutronics.crossSectionGroupManager.CrossSectionGroupManager.disableBuGroupUpdates" title="Permalink to this definition"></a></dt>
-<dd><p>Turn off updating bu groups based on burnup.</p>
+<dt class="sig sig-object py" id="armi.physics.neutronics.crossSectionGroupManager.CrossSectionGroupManager.disableEnvGroupUpdates">
+<span class="sig-name descname"><span class="pre">disableEnvGroupUpdates</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/armi/physics/neutronics/crossSectionGroupManager.html#CrossSectionGroupManager.disableEnvGroupUpdates"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#armi.physics.neutronics.crossSectionGroupManager.CrossSectionGroupManager.disableEnvGroupUpdates" title="Permalink to this definition"></a></dt>
+<dd><p>Turn off updating Env groups based on environment.</p>
 <p>Useful during reactivity coefficient calculations to be consistent with ref. run.</p>
 <div class="admonition seealso">
 <p class="admonition-title">See also</p>
-<p><a class="reference internal" href="#armi.physics.neutronics.crossSectionGroupManager.CrossSectionGroupManager.enableBuGroupUpdates" title="armi.physics.neutronics.crossSectionGroupManager.CrossSectionGroupManager.enableBuGroupUpdates"><code class="xref py py-obj docutils literal notranslate"><span class="pre">enableBuGroupUpdates</span></code></a></p>
+<p><a class="reference internal" href="#armi.physics.neutronics.crossSectionGroupManager.CrossSectionGroupManager.enableEnvGroupUpdates" title="armi.physics.neutronics.crossSectionGroupManager.CrossSectionGroupManager.enableEnvGroupUpdates"><code class="xref py py-obj docutils literal notranslate"><span class="pre">enableEnvGroupUpdates</span></code></a></p>
 </div>
 </dd></dl>
 
 <dl class="py method">
-<dt class="sig sig-object py" id="armi.physics.neutronics.crossSectionGroupManager.CrossSectionGroupManager.enableBuGroupUpdates">
-<span class="sig-name descname"><span class="pre">enableBuGroupUpdates</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/armi/physics/neutronics/crossSectionGroupManager.html#CrossSectionGroupManager.enableBuGroupUpdates"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#armi.physics.neutronics.crossSectionGroupManager.CrossSectionGroupManager.enableBuGroupUpdates" title="Permalink to this definition"></a></dt>
-<dd><p>Turn on updating bu groups based on burnup.</p>
+<dt class="sig sig-object py" id="armi.physics.neutronics.crossSectionGroupManager.CrossSectionGroupManager.enableEnvGroupUpdates">
+<span class="sig-name descname"><span class="pre">enableEnvGroupUpdates</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/armi/physics/neutronics/crossSectionGroupManager.html#CrossSectionGroupManager.enableEnvGroupUpdates"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#armi.physics.neutronics.crossSectionGroupManager.CrossSectionGroupManager.enableEnvGroupUpdates" title="Permalink to this definition"></a></dt>
+<dd><p>Turn on updating Env groups based on environment.</p>
 <div class="admonition seealso">
 <p class="admonition-title">See also</p>
-<p><a class="reference internal" href="#armi.physics.neutronics.crossSectionGroupManager.CrossSectionGroupManager.disableBuGroupUpdates" title="armi.physics.neutronics.crossSectionGroupManager.CrossSectionGroupManager.disableBuGroupUpdates"><code class="xref py py-obj docutils literal notranslate"><span class="pre">disableBuGroupUpdates</span></code></a></p>
+<p><a class="reference internal" href="#armi.physics.neutronics.crossSectionGroupManager.CrossSectionGroupManager.disableEnvGroupUpdates" title="armi.physics.neutronics.crossSectionGroupManager.CrossSectionGroupManager.disableEnvGroupUpdates"><code class="xref py py-obj docutils literal notranslate"><span class="pre">disableEnvGroupUpdates</span></code></a></p>
 </div>
 </dd></dl>