Make axial linking aware of block grids for axial expansion

armi/reactor/assemblies.py

@@ -31,7 +31,7 @@
 from armi import runLog
 from armi.materials.material import Fluid
 from armi.reactor import assemblyParameters, blocks, composites, grids
-from armi.reactor.flags import Flags
+from armi.reactor.flags import Flags, TypeSpec
 from armi.reactor.parameters import ParamLocation
 from armi.reactor.spentFuelPool import SpentFuelPool
 
@@ -288,9 +288,9 @@ def getVolume(self):
         """Calculate the total assembly volume in cm^3."""
         return self.getArea() * self.getTotalHeight()
 
-    def getPinPlenumVolumeInCubicMeters(self):
+    def getPinPlenumVolumeInCubicMeters(self) -> float:
         """
-        Return the volume of the plenum for a pin in an assembly.
+        Return the total volume of the plenum for an assembly in m^3.
 
         Notes
         -----
@@ -299,12 +299,19 @@ def getPinPlenumVolumeInCubicMeters(self):
         Warning
         -------
         This is a bit design-specific for pinned assemblies.
+
+        Returns
+        -------
+        float: Total plenum volume for an assembly.
         """
         plenumVolume = 0.0
         for b in self.iterChildrenWithFlags(Flags.PLENUM):
-            cladId = b.getComponent(Flags.CLAD).getDimension("id")
             length = b.getHeight()
-            plenumVolume += math.pi * (cladId / 2.0) ** 2.0 * length * 1e-6  # convert cm^3 to m^3
+            for c in b.iterChildrenWithFlags(Flags.CLAD):
+                cladId = c.getDimension("id")
+                plenumVolume += math.pi * (cladId / 2.0) ** 2.0 * length
+        # convert vol from cm^3 to m^3
+        plenumVolume *= 1e-6
         return plenumVolume
 
     def getAveragePlenumTemperature(self):
@@ -848,14 +855,14 @@ def getBlocksAndZ(self, typeSpec=None, returnBottomZ=False, returnTopZ=False):
     def hasContinuousCoolantChannel(self):
         return all(b.containsAtLeastOneChildWithFlags(Flags.COOLANT) for b in self)
 
-    def getFirstBlock(self, typeSpec=None, exact=False):
+    def getFirstBlock(self, typeSpec: TypeSpec = None, exact: bool = False) -> Optional[blocks.Block]:
         """Find the first block that matches the spec.
 
         Parameters
         ----------
-        typeSpec : flag or list of flags, optional
+        typeSpec
             Specification to require on the returned block.
-        exact : bool, optional
+        exact
             Require block to exactly match ``typeSpec``
 
         Returns
@@ -874,7 +881,7 @@ def getFirstBlock(self, typeSpec=None, exact=False):
             # No items found in the iteration -> no blocks match the request
             return None
 
-    def getFirstBlockByType(self, typeName):
+    def getFirstBlockByType(self, typeName: str) -> Optional[blocks.Block]:
         blocks = filter(lambda b: b.getType() == typeName, self)
         try:
             return next(blocks)

armi/reactor/blueprints/blockBlueprint.py

@@ -168,8 +168,8 @@ def construct(self, cs, blueprint, axialIndex, axialMeshPoints, height, xsType,
                     mult = c.getDimension("mult")
                     if mult and mult != 1.0 and mult != len(c.spatialLocator):
                         raise ValueError(
-                            f"Conflicting ``mult`` input ({mult}) and number of "
-                            f"lattice positions ({len(c.spatialLocator)}) for {c}. "
+                            f"For {c} in {self.name} there is a conflicting ``mult`` input ({mult}) "
+                            f"and number of lattice positions ({len(c.spatialLocator)}). "
                             "Recommend leaving off ``mult`` input when using grids."
                         )
                     elif not mult or mult == 1.0:

armi/reactor/components/component.py

@@ -20,7 +20,7 @@
 
 import copy
 import re
-from typing import Optional
+from typing import Optional, Union
 
 import numpy as np
 
@@ -326,9 +326,12 @@ def resolveLinkedDims(self, components):
                     self.p[dimName] = _DimensionLink((comp, linkedKey))
                 except Exception:
                     if value.count(".") > 1:
-                        raise ValueError(f"Component names should not have periods in them: `{value}`")
+                        raise ValueError(
+                            f"Name of {self} has a period in it. "
+                            f"Components cannot not have periods in their names: `{value}`"
+                        )
                     else:
-                        raise KeyError(f"Bad component link `{dimName}` defined as `{value}`")
+                        raise KeyError(f"Bad component link `{dimName}` defined as `{value}` in {self}")
 
     def setLink(self, key, otherComp, otherCompKey):
         """Set the dimension link."""
@@ -662,7 +665,7 @@ def getNumberDensity(self, nucName):
         """
         return self.p.numberDensities.get(nucName, 0.0)
 
-    def getNuclideNumberDensities(self, nucNames):
+    def getNuclideNumberDensities(self, nucNames: list[str]) -> list[float]:
         """Return a list of number densities for the nuc names requested."""
         return [self.p.numberDensities.get(nucName, 0.0) for nucName in nucNames]
 
@@ -826,7 +829,7 @@ def getMassEnrichment(self):
         except ZeroDivisionError:
             return 0.0
 
-    def getMass(self, nuclideNames=None):
+    def getMass(self, nuclideNames: Union[None, str, list[str]] = None) -> float:
         r"""
         Determine the mass in grams of nuclide(s) and/or elements in this object.
 

armi/reactor/composites.py

@@ -37,7 +37,17 @@
 import itertools
 import operator
 import timeit
-from typing import Callable, Dict, Iterator, List, Optional, Tuple, Type, Union
+from typing import (
+    TYPE_CHECKING,
+    Callable,
+    Dict,
+    Iterator,
+    List,
+    Optional,
+    Tuple,
+    Type,
+    Union,
+)
 
 import numpy as np
 
@@ -51,6 +61,9 @@
 from armi.utils.densityTools import calculateNumberDensity
 from armi.utils.flags import auto
 
+if TYPE_CHECKING:
+    from armi.reactor.components.component import Component
+
 
 class FlagSerializer(parameters.Serializer):
     """
@@ -873,7 +886,7 @@ def getMaxArea(self):
         """
         raise NotImplementedError()
 
-    def getMass(self, nuclideNames=None) -> float:
+    def getMass(self, nuclideNames: Union[None, str, list[str]] = None) -> float:
         """
         Determine the mass in grams of nuclide(s) and/or elements in this object.
 
@@ -887,7 +900,7 @@ def getMass(self, nuclideNames=None) -> float:
 
         Parameters
         ----------
-        nuclideNames : str, optional
+        nuclideNames
             The nuclide/element specifier to get the mass of in the object.
             If omitted, total mass is returned.
 
@@ -917,7 +930,7 @@ def getMicroSuffix(self):
             " of composite such as Blocks or Components have the concept of micro suffixes."
         )
 
-    def _getNuclidesFromSpecifier(self, nucSpec):
+    def _getNuclidesFromSpecifier(self, nucSpec: Union[None, str, list[str]]):
         """
         Convert a nuclide specification to a list of valid nuclide/element keys.
 
@@ -2179,14 +2192,18 @@ def hasComponents(self, typeSpec: Union[TypeSpec, List[TypeSpec]], exact=False):
 
         return all(self.getComponents(t, exact) for t in typeSpec)
 
-    def getComponentByName(self, name):
+    def getComponentByName(self, name: str) -> "Component":
         """
         Gets a particular component from this object, based on its name.
 
         Parameters
         ----------
-        name : str
+        name
             The blueprint name of the component to return
+
+        Returns
+        -------
+        Component, c, whose c.name matches name.
         """
         components = [c for c in self.iterComponents() if c.name == name]
         nComp = len(components)
@@ -2197,7 +2214,7 @@ def getComponentByName(self, name):
         else:
             return components[0]
 
-    def getComponent(self, typeSpec: TypeSpec, exact=False, quiet=False):
+    def getComponent(self, typeSpec: TypeSpec, exact: bool = False, quiet: bool = False) -> Optional["Component"]:
         """
         Get a particular component from this object.
 
@@ -2217,20 +2234,24 @@ def getComponent(self, typeSpec: TypeSpec, exact=False, quiet=False):
         Returns
         -------
         Component : The component that matches the criteria or None
+
+        Raises
+        ------
+        ValueError: more than one Component matches the typeSpec
         """
         results = self.getComponents(typeSpec, exact=exact)
         if len(results) == 1:
             return results[0]
         elif not results:
             if not quiet:
                 runLog.warning(
-                    "No component matched {0} in {1}. Returning None".format(typeSpec, self),
+                    f"No component matched {typeSpec} in {self}. Returning None",
                     single=True,
-                    label="None component returned instead of {0}".format(typeSpec),
+                    label=f"None component returned instead of {typeSpec}",
                 )
             return None
         else:
-            raise ValueError("Multiple components match in {} match typeSpec {}: {}".format(self, typeSpec, results))
+            raise ValueError(f"Multiple components match in {self} match typeSpec {typeSpec}: {results}")
 
     def getNumComponents(self, typeSpec: TypeSpec, exact=False):
         """
@@ -2645,7 +2666,7 @@ def getChildren(
     def getComponents(self, typeSpec: TypeSpec = None, exact=False):
         return list(self.iterComponents(typeSpec, exact))
 
-    def iterComponents(self, typeSpec: TypeSpec = None, exact=False):
+    def iterComponents(self, typeSpec: TypeSpec = None, exact: bool = False) -> Iterator["Component"]:
         """
         Return an iterator of armi.reactor.component.Component objects within this Composite.