mirror of
https://github.com/openmc-dev/openmc.git
synced 2026-07-28 14:15:42 -04:00
Update documentation and formatting
This commit is contained in:
parent
c4b5f067cd
commit
f5625c9229
1 changed files with 10 additions and 3 deletions
|
|
@ -179,6 +179,8 @@ class DirectReactionRateHelper(ReactionRateHelper):
|
|||
|
||||
@property
|
||||
def rate_tally_means(self):
|
||||
"""The mean results of the tally of every material's reaction rates for this cycle
|
||||
"""
|
||||
# If the mean cache is empty, fill it once with this transport cycle's results
|
||||
if self._rate_tally_means_cache is None:
|
||||
self._rate_tally_means_cache = self._rate_tally.mean
|
||||
|
|
@ -186,7 +188,9 @@ class DirectReactionRateHelper(ReactionRateHelper):
|
|||
|
||||
def reset_tally_means(self):
|
||||
"""Reset the cached mean rate tallies.
|
||||
This step must be performed after each transport cycle
|
||||
.. note::
|
||||
|
||||
This step must be performed after each transport cycle
|
||||
"""
|
||||
self._rate_tally_means_cache = None
|
||||
|
||||
|
|
@ -306,6 +310,8 @@ class FluxCollapseHelper(ReactionRateHelper):
|
|||
|
||||
@property
|
||||
def rate_tally_means(self):
|
||||
"""The mean results of the tally of every material's reaction rates for this cycle
|
||||
"""
|
||||
# If the mean cache is empty, fill it once with this transport cycle's results
|
||||
if self._rate_tally_means_cache is None:
|
||||
self._rate_tally_means_cache = self._rate_tally.mean
|
||||
|
|
@ -320,13 +326,14 @@ class FluxCollapseHelper(ReactionRateHelper):
|
|||
|
||||
def reset_tally_means(self):
|
||||
"""Reset the cached mean rate and flux tallies.
|
||||
This step must be performed after each transport cycle
|
||||
.. note::
|
||||
|
||||
This step must be performed after each transport cycle
|
||||
"""
|
||||
self._flux_tally_means_cache = None
|
||||
if self._reactions_direct:
|
||||
self._rate_tally_means_cache = None
|
||||
|
||||
|
||||
def get_material_rates(self, mat_index, nuc_index, react_index):
|
||||
"""Return an array of reaction rates for a material
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue