Merge pull request #57 from paulromano/fixes-2693

Final fixes for PR 2693

Author: church89

docs/source/io_formats/depletion_results.rst

@@ -4,7 +4,7 @@
 Depletion Results File Format
 =============================
 
-The current version of the depletion results file format is 1.2.
+The current version of the depletion results file format is 1.3.
 
 **/**
 
@@ -29,6 +29,8 @@ The current version of the depletion results file format is 1.2.
            - **depletion time** (*double[]*) -- Average process time in [s]
              spent depleting a material across all burnable materials and,
              if applicable, MPI processes.
+           - **keff_search_root** (*double[]*) -- Root of the keff search at the
+             end of the timestep, if applicable.
 
 **/materials/<id>/**
 

openmc/deplete/abc.py

@@ -160,7 +160,7 @@ def __init__(self, chain_file=None, fission_q=None, prev_results=None):
             self.prev_res = prev_results
 
     @abstractmethod
-    def __call__(self, vec, source_rate):
+    def __call__(self, vec, source_rate) -> OperatorResult:
         """Runs a simulation.
 
         Parameters
@@ -839,7 +839,7 @@ def _get_start_data(self) -> tuple[float, int]:
         return (self.operator.prev_res[-1].time[0],
                 len(self.operator.prev_res) - 1)
 
-    def _restore_keff_search_control(self, res):
+    def _restore_keff_search_control(self, res: StepResult):
         """Restore keff search control from restart results."""
         keff_search_root = res.keff_search_root
         if keff_search_root is None:

openmc/deplete/coupled_operator.py

@@ -399,7 +399,7 @@ def _generate_materials_xml(self):
 
         self.materials.export_to_xml(nuclides_to_ignore=self._decay_nucs)
 
-    def __call__(self, vec, source_rate):
+    def __call__(self, vec, source_rate) -> OperatorResult:
         """Runs a simulation.
 
         Simulation will abort under the following circumstances:

openmc/deplete/independent_operator.py

@@ -384,7 +384,7 @@ def initial_condition(self):
         # Return number density vector
         return super().initial_condition(self.materials)
 
-    def __call__(self, vec, source_rate):
+    def __call__(self, vec, source_rate) -> OperatorResult:
         """Obtain the reaction rates
 
         Parameters

openmc/deplete/stepresult.py

@@ -16,7 +16,7 @@
 from openmc.checkvalue import PathLike
 from .reaction_rates import ReactionRates
 
-VERSION_RESULTS = (1, 2)
+VERSION_RESULTS = (1, 3)
 
 
 __all__ = ["StepResult"]

openmc/search.py

@@ -202,4 +202,3 @@ def search_for_keff(model_builder, initial_guess=None, target=1.0,
     zero_value = root_finder(**args)
 
     return zero_value, guesses, results
-