Flesh out impl for I_ARMI_DEPL_DEPLETABLE

keckler · Jan 22, 2024 · 0678a49 · 0678a49
1 parent 3410c33
commit 0678a49
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/armi/physics/neutronics/isotopicDepletion/isotopicDepletionInterface.py b/armi/physics/neutronics/isotopicDepletion/isotopicDepletionInterface.py
@@ -45,6 +45,10 @@ def isDepletable(obj: composites.ArmiObject):
         :id: I_ARMI_DEPL_DEPLETABLE
         :implements: R_ARMI_DEPL_DEPLETABLE
 
+        Uses :py:meth:`~armi.reactor.composite.ArmiObject.hasFlags` or
+        :py:meth:`~armi.reactor.composite.ArmiObject.containsAtLeastOneChildWithFlags`
+        to determine if the "depletable" flag is in the ``obj``. If so, returns True.
+
     .. warning:: The ``DEPLETABLE`` flag is automatically added to compositions that have
         active nuclides. If you explicitly define any flags at all, you must also
         manually include ``DEPLETABLE`` or else the objects will silently not deplete.