Adding util function to test for depletion (#1015)

terrapower · Dec 13, 2022 · 186d0c2 · 186d0c2
1 parent 68d5c3b
commit 186d0c2
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 0 deletions.
diff --git a/armi/utils/__init__.py b/armi/utils/__init__.py
@@ -319,6 +319,21 @@ def getBurnSteps(cs):
     return [len(steps) for steps in stepLengths]
 
 
+def hasBurnup(cs):
+    """Is depletion being modeled?
+
+    Parameters
+    ----------
+    cs : case settings object
+
+    Returns
+    -------
+    bool
+        Are there any burnup steps?
+    """
+    return sum(getBurnSteps(cs)) > 0
+
+
 def getMaxBurnSteps(cs):
     burnSteps = getBurnSteps(cs)
     return max(burnSteps)

diff --git a/armi/utils/tests/test_utils.py b/armi/utils/tests/test_utils.py
@@ -37,6 +37,7 @@
     getCycleNodeFromCumulativeNode,
     getPreviousTimeNode,
     getCumulativeNodeNum,
+    hasBurnup,
 )
 
 
@@ -300,6 +301,9 @@ def test_getBurnSteps(self):
             getBurnSteps(self.standaloneSimpleCS), self.burnStepsSimpleSolution
         )
 
+    def test_hasBurnup(self):
+        self.assertTrue(hasBurnup(self.standaloneDetailedCS))
+
     def test_getMaxBurnSteps(self):
         self.assertEqual(
             getMaxBurnSteps(self.standaloneDetailedCS),