Removing undefined acronyms from reqs & fix broken links (#1628)

armi/materials/mixture.py

@@ -21,6 +21,8 @@ class _Mixture(materials.Material):
     """
     Homogenized mixture of materials.
 
+    :meta public:
+
     .. warning:: This class is meant to be used for homogenized block models for neutronics and other
        physics solvers.
 

armi/nuclearDataIO/cccc/cccc.py

@@ -42,7 +42,7 @@
     a file for reading or writing on the ``__enter__`` and closes that file upon
     ``__exit__``. :py:class:`Stream` is an abstract base class that is
     subclassed for each CCCC file. It is subclassed directly for the CCCC files
-    that contain XS data:
+    that contain cross-section data:
 
       * :py:class:`ISOTXS <armi.nuclearDataIO.cccc.isotxs.IsotxsIO>`
       * :py:mod:`GAMISO <armi.nuclearDataIO.cccc.gamiso>`

armi/physics/neutronics/crossSectionGroupManager.py

@@ -324,7 +324,7 @@ class AverageBlockCollection(BlockCollection):
         volume-weighted average. Inheriting functionality from the abstract
         :py:class:`Reactor <armi.physics.neutronics.crossSectionGroupManager.BlockCollection>` object, this class
         will construct representative blocks using averaged parameters of all blocks in the given collection.
-        Number density averages can be computed at a component level through ``self._performAverageByComponent``,
+        Number density averages can be computed at a component level
         or at a block level by default. Average nuclide temperatures and burnup are also included when constructing a representative block.
 
     """
@@ -855,7 +855,7 @@ def __init__(self, r, cs):
     def interactBOL(self):
         """Called at the Beginning-of-Life of a run, before any cycles start.
 
-        .. impl:: The lattice physics interface and XSGM are connected at BOL.
+        .. impl:: The lattice physics interface and cross-section group manager are connected at BOL.
             :id: I_ARMI_XSGM_FREQ0
             :implements: R_ARMI_XSGM_FREQ
 
@@ -885,7 +885,7 @@ def interactBOC(self, cycle=None):
         """
         Update representative blocks and block burnup groups.
 
-        .. impl:: The lattice physics interface and XSGM are connected at BOC.
+        .. impl:: The lattice physics interface and cross-section group manager are connected at BOC.
             :id: I_ARMI_XSGM_FREQ1
             :implements: R_ARMI_XSGM_FREQ
 
@@ -910,7 +910,7 @@ def interactEOC(self, cycle=None):
     def interactEveryNode(self, cycle=None, tn=None):
         """Interaction at every time node.
 
-        .. impl:: The lattice physics interface and XSGM are connected at every time node.
+        .. impl:: The lattice physics interface and cross-section group manager are connected at every time node.
             :id: I_ARMI_XSGM_FREQ2
             :implements: R_ARMI_XSGM_FREQ
 
@@ -923,19 +923,19 @@ def interactEveryNode(self, cycle=None, tn=None):
             self.createRepresentativeBlocks()
 
     def interactCoupled(self, iteration):
-        """Update XS groups on each physics coupling iteration to get latest temperatures.
+        """Update cross-section groups on each physics coupling iteration to get latest temperatures.
 
-        .. impl:: The lattice physics interface and XSGM are connected during coupling.
+        .. impl:: The lattice physics interface and cross-section group manager are connected during coupling.
             :id: I_ARMI_XSGM_FREQ3
             :implements: R_ARMI_XSGM_FREQ
 
             This method updates representative blocks and block burnups at every node and the first coupled iteration for each cross-section ID
-            if the control logic for lattices physics frequency updates is set for the first coupled iteration (`firstCoupledIteration`) through the :py:class:`LatticePhysicsInterface <armi.physics.neutronics.latticePhysics>`.
+            if the control logic for lattices physics frequency updates is set for the first coupled iteration (``firstCoupledIteration``) through the :py:class:`LatticePhysicsInterface <armi.physics.neutronics.latticePhysics>`.
             The cross-section group manager will construct representative blocks for each cross-section ID at the first iteration of every time node.
 
         Notes
         -----
-        Updating the XS on only the first (i.e., iteration == 0) timenode can be a reasonable approximation to
+        Updating the cross-section on only the first (i.e., iteration == 0) timenode can be a reasonable approximation to
         get new cross sections with some temperature updates but not have to run lattice physics on each
         coupled iteration. If the user desires to have the cross sections updated with every coupling iteration,
         the ``latticePhysicsFrequency: all`` option.
@@ -1112,7 +1112,7 @@ def _getPregeneratedFluxFileLocationData(self, xsID):
     def createRepresentativeBlocks(self):
         """Get a representative block from each cross-section ID managed here.
 
-        .. impl:: Create collections of blocks based on XS type and burn-up group.
+        .. impl:: Create collections of blocks based on cross-section type and burn-up group.
             :id: I_ARMI_XSGM_CREATE_XS_GROUPS
             :implements: R_ARMI_XSGM_CREATE_XS_GROUPS
 

armi/physics/neutronics/globalFlux/globalFluxInterface.py

@@ -1245,7 +1245,7 @@ def computeDpaRate(mgFlux, dpaXs):
         :implements: R_ARMI_FLUX_DPA
 
         This method calculates DPA rates using the inputted multigroup flux and DPA cross sections.
-        Displacements calculated by displacement XS:
+        Displacements calculated by displacement cross-section:
 
         .. math::
             :nowrap:
@@ -1269,8 +1269,8 @@ def computeDpaRate(mgFlux, dpaXs):
 
             \frac{\text{dpa}}{s}  = \frac{\phi N \sigma}{N} = \phi * \sigma
 
-        the Number density of the structural material cancels out. It's in the macroscopic
-        XS and in the original number of atoms.
+        the number density of the structural material cancels out. It's in the macroscopic
+        cross-section and in the original number of atoms.
 
     Raises
     ------

armi/physics/neutronics/isotopicDepletion/crossSectionTable.py

@@ -187,7 +187,7 @@ def makeReactionRateTable(obj, nuclides: List = None):
         that is stored there. If ``obj`` does not belong to a ``Core``, a warning
         is printed.
 
-        For each child of ``obj``, use the ISOTXS library and the xsID for the associated block
+        For each child of ``obj``, use the ISOTXS library and the cross-section ID for the associated block
         to produce a reaction rate dictionary in units of inverse seconds for
         the nuclide specified in the original call to ``obj.getReactionRates()``.
         Because ``nDensity`` was originally specified as

armi/physics/neutronics/tests/test_crossSectionManager.py

@@ -485,7 +485,7 @@ def setUp(self):
         ]
 
     def test_ComponentAverage1DCylinder(self):
-        """Tests that the XS group manager calculates the expected component atom density
+        """Tests that the cross-section group manager calculates the expected component atom density
         and component area correctly.
 
         Order of components is also checked since in 1D cases the order of the components matters.
@@ -852,7 +852,7 @@ def test_createRepresentativeBlocksUsingExistingBlocks(self):
     def test_interactBOL(self):
         """Test `BOL` lattice physics update frequency.
 
-        .. test:: The XSGM frequency depends on the LPI frequency at BOL.
+        .. test:: The cross-section group manager frequency depends on the LPI frequency at BOL.
             :id: T_ARMI_XSGM_FREQ0
             :tests: R_ARMI_XSGM_FREQ
         """
@@ -865,7 +865,7 @@ def test_interactBOL(self):
     def test_interactBOC(self):
         """Test `BOC` lattice physics update frequency.
 
-        .. test:: The XSGM frequency depends on the LPI frequency at BOC.
+        .. test:: The cross-section group manager frequency depends on the LPI frequency at BOC.
             :id: T_ARMI_XSGM_FREQ1
             :tests: R_ARMI_XSGM_FREQ
         """
@@ -879,7 +879,7 @@ def test_interactBOC(self):
     def test_interactEveryNode(self):
         """Test `everyNode` lattice physics update frequency.
 
-        .. test:: The XSGM frequency depends on the LPI frequency at every time node.
+        .. test:: The cross-section group manager frequency depends on the LPI frequency at every time node.
             :id: T_ARMI_XSGM_FREQ2
             :tests: R_ARMI_XSGM_FREQ
         """
@@ -895,7 +895,7 @@ def test_interactEveryNode(self):
     def test_interactFirstCoupledIteration(self):
         """Test `firstCoupledIteration` lattice physics update frequency.
 
-        .. test:: The XSGM frequency depends on the LPI frequency during first coupled iteration.
+        .. test:: The cross-section group manager frequency depends on the LPI frequency during first coupled iteration.
             :id: T_ARMI_XSGM_FREQ3
             :tests: R_ARMI_XSGM_FREQ
         """
@@ -911,7 +911,7 @@ def test_interactFirstCoupledIteration(self):
     def test_interactAllCoupled(self):
         """Test `all` lattice physics update frequency.
 
-        .. test:: The XSGM frequency depends on the LPI frequency during coupling.
+        .. test:: The cross-section group manager frequency depends on the LPI frequency during coupling.
             :id: T_ARMI_XSGM_FREQ4
             :tests: R_ARMI_XSGM_FREQ
         """
@@ -927,7 +927,7 @@ def test_interactAllCoupled(self):
     def test_xsgmIsRunBeforeXS(self):
         """Test that the XSGM is run before the cross sections are calculated.
 
-        .. test:: Test that the XSGM is run before the cross sections are calculated.
+        .. test:: Test that the cross-section group manager is run before the cross sections are calculated.
             :id: T_ARMI_XSGM_FREQ5
             :tests: R_ARMI_XSGM_FREQ
         """

armi/reactor/assemblies.py

@@ -1223,7 +1223,7 @@ def getDim(self, typeSpec, dimName):
             ``dimName``. There is a hard-coded preference for Components
             to be within fuel Blocks. If there are no Blocks, then ``None``
             is returned. If ``typeSpec`` is not within the first Block, an
-            error is raised within :py:meth:`armi.reactor.blocksBlock.getDim`.
+            error is raised within :py:meth:`~armi.reactor.blocks.Block.getDim`.
         """
         # prefer fuel blocks.
         bList = self.getBlocks(Flags.FUEL)

armi/reactor/components/component.py

@@ -980,7 +980,7 @@ def getThermalExpansionFactor(self, Tc=None, T0=None):
             between ``T0`` and ``Tc`` is used to calculate the thermal expansion
             factor. If a solid material does not have a linear expansion factor
             defined and the temperature difference is greater than
-            :py:attr:`armi.reactor.components.component.Component._TOLERANCE`, an
+            a predetermined tolerance, an
             error is raised. Thermal expansion of fluids or custom materials is
             neglected, currently.
 

armi/reactor/reactors.py

@@ -396,9 +396,9 @@ def symmetry(self) -> geometry.SymmetryType:
             <armi.reactor.grids.grid.Grid>` type, :py:class:`DomainType
             <armi.reactor.geometry.DomainType>`, and :py:class:`BoundaryType
             <armi.reactor.geometry.BoundaryType>` are valid. The validity of a
-            user-specified geometry and symmetry is verified by a settings:
-            :py:meth:`Inspector
-            <armi.operators.settingsValidation.Inspector._inspectSettings`.
+            user-specified geometry and symmetry is verified by a settings
+            :py:class:`Inspector
+            <armi.operators.settingsValidation.Inspector`.
         """
         if not self.spatialGrid:
             raise ValueError("Cannot access symmetry before a spatialGrid is attached.")