From 0c97807da84541093a5740f1aaa46f29fb00e3b5 Mon Sep 17 00:00:00 2001 From: Andrew Johnson Date: Tue, 5 Nov 2019 09:18:24 -0500 Subject: [PATCH] Clarify documentation on Operator diff_burnable_mats In PR #1392, it was revealed that the distribution of material volumes with ``diff_burnable_mats`` was not clear. In that PR, the Operator now divides the volume of the shared material equally across all identical and newly created instances. This commit adds some clarifying language into the Operator docstring and depletion users guide on the handling of volumes across repeated materials. --- docs/source/usersguide/depletion.rst | 4 +++- openmc/deplete/operator.py | 1 + 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/source/usersguide/depletion.rst b/docs/source/usersguide/depletion.rst index 9e26930986..4a4c7b1f88 100644 --- a/docs/source/usersguide/depletion.rst +++ b/docs/source/usersguide/depletion.rst @@ -127,7 +127,9 @@ of the same material as a unique material definition with:: For our example problem, this would deplete fuel on the outer region of the problem with different reaction rates than those in the center. Materials will be depleted corresponding to their local neutron spectra, and have unique compositions at each -transport step. +transport step. The volume of the original ``fuel_3`` material must represent +the volume of **all** the ``fuel_3`` in the problem. When creating the unique +materials, this volume will be equally distributed across all material instances. .. note:: diff --git a/openmc/deplete/operator.py b/openmc/deplete/operator.py index 5ce725a67b..8eb033783f 100644 --- a/openmc/deplete/operator.py +++ b/openmc/deplete/operator.py @@ -82,6 +82,7 @@ class Operator(TransportOperator): in the previous results. diff_burnable_mats : bool, optional Whether to differentiate burnable materials with multiple instances. + Volumes are divided equally from the original material volume. Default: False. energy_mode : {"energy-deposition", "fission-q"} Indicator for computing system energy. ``"energy-deposition"`` will