Add impl details for I_ARMI_DEPL_ABC

keckler · Jan 22, 2024 · 6f68c35 · 6f68c35
1 parent 0678a49
commit 6f68c35
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/armi/physics/neutronics/isotopicDepletion/isotopicDepletionInterface.py b/armi/physics/neutronics/isotopicDepletion/isotopicDepletionInterface.py
@@ -86,6 +86,11 @@ class AbstractIsotopicDepleter:
     .. impl:: ARMI provides a base class to deplete isotopes.
         :id: I_ARMI_DEPL_ABC
         :implements: R_ARMI_DEPL_ABC
+
+        This class provides some basic infrastructure typically needed in depletion
+        calculations within the ARMI framework. It stores a reactor, operator,
+        and case settings object, and also defines methods to store and retrieve
+        the objects which should be depleted based on their names.
     """
 
     name = None