Explicit Fission Product Modeling

armi/cases/case.py

@@ -540,7 +540,7 @@ def _initBurnChain(self):
         """
         if not self.cs["initializeBurnChain"]:
             runLog.info(
-                "Skipping burn-chain initialization due disabling of the `initializeBurnChain` setting."
+                "Skipping burn-chain initialization since `initializeBurnChain` setting is disabled."
             )
             return
 
@@ -563,38 +563,38 @@ def checkInputs(self):
         bool
             True if the inputs are all good, False otherwise
         """
+        runLog.header("=========== Settings Validation Checks ===========")
         with DirectoryChanger(self.cs.inputDirectory, dumpOnException=False):
             operatorClass = operators.getOperatorClassFromSettings(self.cs)
             inspector = operatorClass.inspector(self.cs)
             inspectorIssues = [query for query in inspector.queries if query]
-            if context.CURRENT_MODE == context.Mode.INTERACTIVE:
-                # if interactive, ask user to deal with settings issues
-                inspector.run()
-            else:
-                # when not interactive, just print out the info in the stdout
-                queryData = []
-                for i, query in enumerate(inspectorIssues, start=1):
-                    queryData.append(
-                        (
-                            i,
-                            textwrap.fill(
-                                query.statement, width=50, break_long_words=False
-                            ),
-                            textwrap.fill(
-                                query.question, width=50, break_long_words=False
-                            ),
-                        )
+
+            # Write out the settings validation issues that will be prompted for
+            # resolution if in an interactive session or forced to be resolved
+            # otherwise.
+            queryData = []
+            for i, query in enumerate(inspectorIssues, start=1):
+                queryData.append(
+                    (
+                        i,
+                        textwrap.fill(
+                            query.statement, width=50, break_long_words=False
+                        ),
+                        textwrap.fill(query.question, width=50, break_long_words=False),
                     )
+                )
 
-                if queryData and context.MPI_RANK == 0:
-                    runLog.header("=========== Settings Input Queries ===========")
-                    runLog.info(
-                        tabulate.tabulate(
-                            queryData,
-                            headers=["Number", "Statement", "Question"],
-                            tablefmt="armi",
-                        )
+            if queryData and context.MPI_RANK == 0:
+                runLog.info(
+                    tabulate.tabulate(
+                        queryData,
+                        headers=["Number", "Statement", "Question"],
+                        tablefmt="armi",
                     )
+                )
+            if context.CURRENT_MODE == context.Mode.INTERACTIVE:
+                # if interactive, ask user to deal with settings issues
+                inspector.run()
 
             return not any(inspectorIssues)
 

armi/nucDirectory/nucDir.py

@@ -362,7 +362,7 @@ def getThresholdDisplacementEnergy(nuc):
     nuc = getNuclide(nuc)
     el = elements.byZ[nuc.z]
     try:
-        ed = eDisplacement[el]
+        ed = eDisplacement[el.symbol]
     except KeyError:
         print(
             "The element {0} of nuclide {1} does not have a displacement energy in the library. Please add one."

armi/operators/settingsValidation.py

@@ -32,7 +32,6 @@
 from armi.reactor import systemLayoutInput
 from armi.physics import neutronics
 from armi.utils import directoryChangers
-from armi.settings.fwSettings import globalSettings
 from armi.settings.settingsIO import (
     prompt,
     RunLogPromptCancel,
@@ -67,7 +66,6 @@ def __init__(self, condition, statement, question, correction):
         self.correction = correction
         # True if the query is `passed` and does not result in an immediate failure
         self._passed = False
-        self._corrected = False
         self.autoResolved = True
 
     def __repr__(self):
@@ -107,9 +105,7 @@ def resolve(self):
                         )
                         if make_correction:
                             self.correction()
-                            self._corrected = True
-                        else:
-                            self._passed = True
+                        self._passed = True
                     except RunLogPromptCancel as ki:
                         raise KeyboardInterrupt from ki
                 else:
@@ -191,7 +187,6 @@ def run(self, cs=None):
 
         # the following attribute changes will alter what the queries investigate when
         # resolved
-        correctionsMade = False
         self.cs = cs or self.cs
         runLog.debug("{} executing queries.".format(self.__class__.__name__))
         if not any(self.queries):
@@ -203,8 +198,6 @@ def run(self, cs=None):
         else:
             for query in self.queries:
                 query.resolve()
-                if query._corrected:  # pylint: disable=protected-access
-                    correctionsMade = True
             issues = [
                 query
                 for query in self.queries
@@ -221,8 +214,6 @@ def run(self, cs=None):
                 )
             runLog.debug("{} has finished querying.".format(self.__class__.__name__))
 
-        return correctionsMade
-
     def addQuery(self, condition, statement, question, correction):
         """Convenience method, query must be resolved, else run fails"""
         if not callable(correction):
@@ -262,6 +253,7 @@ def _assignCS(self, key, value):
         """Lambda assignment workaround"""
         # this type of assignment works, but be mindful of
         # scoping when trying different methods
+        runLog.extra(f"Updating setting `{key}` to `{value}`")
         self.cs[key] = value
 
     def _raise(self):  # pylint: disable=no-self-use

armi/physics/fuelPerformance/executers.py

@@ -30,6 +30,7 @@
     CONF_FGR_REMOVAL,
     CONF_CLADDING_WASTAGE,
     CONF_CLADDING_STRAIN,
+    CONF_FGYF,
 )
 
 
@@ -53,6 +54,7 @@ def fromUserSettings(self, cs):
         self.fissionGasRemoval = cs[CONF_FGR_REMOVAL]
         self.claddingWastage = cs[CONF_CLADDING_WASTAGE]
         self.claddingStrain = cs[CONF_CLADDING_STRAIN]
+        self.fissionGasYieldFraction = cs[CONF_FGYF]
 
     def fromReactor(self, reactor):
         """Load options from reactor."""

armi/physics/fuelPerformance/parameters.py

@@ -36,19 +36,35 @@ def _getFuelPerformanceBlockParams():
             " thermal and/or burn-up expansion of the fuel and cladding materials.",
         )
 
+        def gasReleaseFraction(self, value):
+            if value < 0.0 or value > 1.0:
+                raise ValueError(
+                    f"Cannot set a gas release fraction "
+                    f"of {value} outside of the bounds of [0.0, 1.0]"
+                )
+            self._p_gasReleaseFraction = value
+
         pb.defParam(
             "gasReleaseFraction",
+            setter=gasReleaseFraction,
             units="fraction",
-            description="Fraction of generated fission gas that no longer exists in the block."
-            " Should be between 0 and 1, inclusive.",
+            description="Fraction of generated fission gas that no longer exists in the block.",
             categories=["eq cumulative shift"],
         )
 
+        def bondRemoved(self, value):
+            if value < 0.0 or value > 1.0:
+                raise ValueError(
+                    f"Cannot set a bond removed "
+                    f"of {value} outside of the bounds of [0.0, 1.0]"
+                )
+            self._p_bondRemoved = value
+
         pb.defParam(
             "bondRemoved",
+            setter=bondRemoved,
             units="fraction",
-            description="Fraction of thermal bond between fuel and clad that has been pushed out. "
-            "Should be between 0 and 1, inclusive.",
+            description="Fraction of thermal bond between fuel and clad that has been pushed out.",
             categories=["eq cumulative shift"],
         )
 

armi/physics/fuelPerformance/settings.py

@@ -23,6 +23,7 @@
 CONF_CLADDING_STRAIN = "claddingStrain"
 CONF_CLADDING_WASTAGE = "claddingWastage"
 CONF_FGR_REMOVAL = "fgRemoval"
+CONF_FGYF = "fissionGasYieldFraction"
 CONF_FUEL_PERFORMANCE_ENGINE = "fuelPerformanceEngine"
 
 
@@ -39,6 +40,12 @@ def defineSettings():
             ),
             options=[""],
         ),
+        setting.Setting(
+            CONF_FGYF,
+            default=0.25,
+            label="Fission Gas Yield Fraction",
+            description="The fraction of gaseous atoms produced per fission event, assuming a fission product yield of 2.0",
+        ),
         setting.Setting(
             CONF_AXIAL_EXPANSION,
             default=False,

armi/physics/neutronics/__init__.py

@@ -102,8 +102,13 @@ def defineSettings():
     def defineSettingsValidators(inspector):
         """Implementation of settings inspections for neutronics settings."""
         from armi.physics.neutronics.settings import getNeutronicsSettingValidators
+        from armi.physics.neutronics.fissionProductModel.fissionProductModelSettings import (
+            getFissionProductModelSettingValidators,
+        )
 
-        return getNeutronicsSettingValidators(inspector)
+        settingsValidators = getNeutronicsSettingValidators(inspector)
+        settingsValidators.extend(getFissionProductModelSettingValidators(inspector))
+        return settingsValidators
 
     @staticmethod
     @plugins.HOOKIMPL

armi/physics/neutronics/crossSectionGroupManager.py

@@ -346,15 +346,7 @@ def _getAverageFuelLFP(self):
         """Compute the average lumped fission products."""
         # TODO: make do actual average of LFPs
         b = self.getCandidateBlocks()[0]
-        lfpCollection = b.getLumpedFissionProductCollection()
-        if lfpCollection:
-            lfpCollectionCopy = lfpCollection.duplicate()
-            fgRemoved = self._getAverageFissionGasRemoved()
-            lfpCollectionCopy.setGasRemovedFrac(fgRemoved)
-        else:
-            lfpCollectionCopy = lfpCollection
-
-        return lfpCollectionCopy
+        return b.getLumpedFissionProductCollection()
 
     def _getNucTempHelper(self):
         """All candidate blocks are used in the average."""
@@ -1012,15 +1004,9 @@ def _summarizeGroups(self, blockCollectionsByXsGroup):
                 xsIDGroup = self._getXsIDGroup(xsID)
                 if xsIDGroup == self._REPR_GROUP:
                     reprBlock = self.representativeBlocks.get(xsID)
-                    lfps = reprBlock.getLumpedFissionProductCollection()
-                    if lfps:
-                        fissionGasRemoved = list(lfps.values())[0].getGasRemovedFrac()
-                    else:
-                        fissionGasRemoved = 0.0
                     runLog.extra(
-                        "XS ID {} contains {:4d} blocks, represented by: {:65s}"
-                        " Fission Gas Removal Fraction: {:.2f}".format(
-                            xsID, len(blocks), reprBlock, fissionGasRemoved
+                        "XS ID {} contains {:4d} blocks, represented by: {:65s}".format(
+                            xsID, len(blocks), reprBlock
                         )
                     )
                 elif xsIDGroup == self._NON_REPR_GROUP:

armi/physics/neutronics/fissionProductModel/__init__.py

@@ -17,8 +17,8 @@
 """
 
 import os
-from armi import ROOT
+from armi.context import RES
 
 REFERENCE_LUMPED_FISSION_PRODUCT_FILE = os.path.join(
-    ROOT, "resources", "referenceFissionProducts.dat"
+    RES, "referenceFissionProducts.dat"
 )