From ea0892f0f3e53169a8ea80e424a5002c3d643935 Mon Sep 17 00:00:00 2001 From: Paul Romano Date: Mon, 21 Nov 2022 15:20:12 -0600 Subject: [PATCH] Updated docstring to better explain chain_file and micro_xs --- openmc/deplete/independent_operator.py | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/openmc/deplete/independent_operator.py b/openmc/deplete/independent_operator.py index a8249a98e9..d117302405 100644 --- a/openmc/deplete/independent_operator.py +++ b/openmc/deplete/independent_operator.py @@ -31,6 +31,9 @@ class IndependentOperator(OpenMCOperator): passed to an integrator class, such as :class:`openmc.deplete.CECMIntegrator`. + Note that passing an empty :class:`~openmc.deplete.MicroXS` instance to the + ``micro_xs`` argument allows a decay-only calculation to be run. + .. versionadded:: 0.13.1 Parameters @@ -38,9 +41,11 @@ class IndependentOperator(OpenMCOperator): materials : openmc.Materials Materials to deplete. micro_xs : MicroXS - One-group microscopic cross sections in [b] . + One-group microscopic cross sections in [b]. If the + :class:`~openmc.deplete.MicroXS` is empty, a decay-only calculation will + be run. chain_file : str - Path to the depletion chain XML file. Defaults to + Path to the depletion chain XML file. Defaults to ``openmc.config['chain_file']``. keff : 2-tuple of float, optional keff eigenvalue and uncertainty from transport calculation. @@ -169,9 +174,12 @@ class IndependentOperator(OpenMCOperator): Dictionary with nuclide names as keys and nuclide concentrations as values. micro_xs : MicroXS - One-group microscopic cross sections. + One-group microscopic cross sections in [b]. If the + :class:`~openmc.deplete.MicroXS` is empty, a decay-only calculation + will be run. chain_file : str, optional - Path to the depletion chain XML file. + Path to the depletion chain XML file. Defaults to + ``openmc.config['chain_file']``. nuc_units : {'atom/cm3', 'atom/b-cm'}, optional Units for nuclide concentration. keff : 2-tuple of float, optional