From c74a7eacecbdd67f99f931f00d9f9fc8b5937003 Mon Sep 17 00:00:00 2001 From: Paul Romano Date: Sat, 7 Apr 2012 13:05:18 -0400 Subject: [PATCH] Updated documentation. --- docs/source/releasenotes/notes_0.4.2.rst | 12 ++++++---- docs/source/usersguide/input.rst | 30 +++++++++++++++++++++--- docs/source/usersguide/troubleshoot.rst | 2 +- 3 files changed, 36 insertions(+), 8 deletions(-) diff --git a/docs/source/releasenotes/notes_0.4.2.rst b/docs/source/releasenotes/notes_0.4.2.rst index 825a37d3a..f213581c4 100644 --- a/docs/source/releasenotes/notes_0.4.2.rst +++ b/docs/source/releasenotes/notes_0.4.2.rst @@ -22,6 +22,8 @@ hand (mostly on the number of nuclides in the problem). New Features ------------ +- Option to not reduce tallies across processors at end of each batch. +- Uniform fission site method for reducing variance on local tallies. - Reading/writing binary source files. - Added more messages for or high verbosity. - Estimator for diffusion coefficient. @@ -35,11 +37,13 @@ New Features Bug Fixes --------- -- `b2c40e`_: Fixed bug in incoming energy filter for track-length tallies. -- `5524fd`_: Mesh filter now works with track-length tallies. -- `d050c7`_: Added Bessel's correction to make estimate of variance unbiased. -- `2a5b9c`_: Fixed regression in plotting. +- 671f30_: Fixed surface currents on mesh not encompassing geometry. +- b2c40e_: Fixed bug in incoming energy filter for track-length tallies. +- 5524fd_: Mesh filter now works with track-length tallies. +- d050c7_: Added Bessel's correction to make estimate of variance unbiased. +- 2a5b9c_: Fixed regression in plotting. +.. _671f30: https://github.com/mit-crpg/openmc/commit/671f30 .. _b2c40e: https://github.com/mit-crpg/openmc/commit/b2c40e .. _5524fd: https://github.com/mit-crpg/openmc/commit/5524fd .. _d050c7: https://github.com/mit-crpg/openmc/commit/d050c7 diff --git a/docs/source/usersguide/input.rst b/docs/source/usersguide/input.rst index f6104bba4..4aab4684a 100644 --- a/docs/source/usersguide/input.rst +++ b/docs/source/usersguide/input.rst @@ -151,6 +151,19 @@ problem. It has the following attributes/sub-elements: *Default*: None +```` Element +----------------------- + +The ```` element has no attributes and has an accepted value of "on" +or "off". If set to "on", all user-defined tallies and global tallies will not +be reduced across processors in a parallel calculation. This means that the +accumulate score in one batch on a single processor is considered as an +independent realization for the tally random variable. For a problem with large +tally data, this option can significantly improve the parallel efficiency. + + *Default*: off + + ```` Element --------------------- @@ -195,12 +208,14 @@ criticality calculations. It takes the following attributes: ```` Element ------------------------------ -The ```` element has no attributes and assumes wither the -value ``on`` or ``off``. If turned on, this option will enable the use of -survival biasing, otherwise known as implicit capture or absorption. +The ```` element has no attributes and has an accepted value +of "on" or "off". If set to "on", this option will enable the use of survival +biasing, otherwise known as implicit capture or absorption. *Default*: off +.. _trace: + ```` Element ------------------- @@ -247,6 +262,15 @@ displayed. This element takes the following attributes: *Default*: 5 +```` Element +------------------------------ + +The ```` element has no attributes and has an accepted value of +"on" or "off". If set to "on", a binary source file will be written to diskat +the end of the run that can be used as a starting source for another run. + + *Default*: off + -------------------------------------- Geometry Specification -- geometry.xml -------------------------------------- diff --git a/docs/source/usersguide/troubleshoot.rst b/docs/source/usersguide/troubleshoot.rst index 40aa6a208..5943d553f 100644 --- a/docs/source/usersguide/troubleshoot.rst +++ b/docs/source/usersguide/troubleshoot.rst @@ -94,7 +94,7 @@ geometry has been specified incorrectly or is missing. The best way to debug this error is to turn on a trace for the particle getting lost. After the error message, the code will display what batch, generation, and -particle number caused the error. In your settings.xml, add a tag +particle number caused the error. In your settings.xml, add a :ref:`trace` followed by the batch, generation, and particle number. This will give you detailed output every time that particle enters a cell, crosses a boundary, or has a collision. For example, if you received this error at cycle 5, generation