crp/OpenMC
1
0
Fork 0
mirror of https://github.com/openmc-dev/openmc.git synced 2026-07-28 06:05:58 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

Updating volume documentation.

Browse source
This commit is contained in:
Patrick Shriwise 2019-10-05 10:58:11 -05:00
parent 48fab6dcac
commit 0914330f8d
2 changed files with 12 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

12
docs/source/usersguide/volume.rst
View file

@ -37,6 +37,16 @@ arguments are not necessary. For example,
Of course, the volumes that you *need* this capability for are often the ones
with complex definitions.
A threshold for the uncertainty in volume estimates can be specified using
::attr::`openmc.VolumeCalculation.threshold` ::
vol_calc.threshold = 1E-05
If a threshold is provided, calculations will be performed iteratively using the
number of samples specified on the calculation until all volume estimates have a
standard deviation lower than this value. If no threshold is provided, the
calculation will run the number of samples specified once and return the result.
Once you have one or more :class:`openmc.VolumeCalculation` objects created, you
can then assign then to :attr:`Settings.volume_calculations`::
@ -66,4 +76,4 @@ After the results are loaded, volume estimates will be stored in
:attr:`VolumeCalculation.volumes`. There is also a
:attr:`VolumeCalculation.atoms_dataframe` attribute that shows stochastic
estimates of the number of atoms of each type of nuclide within the specified
domains along with their uncertainties.
domains along with their uncertainties.