From db744637536fb41830f74b1fb3db66272507f159 Mon Sep 17 00:00:00 2001 From: Paul Romano Date: Sat, 18 Feb 2017 14:39:56 -0600 Subject: [PATCH] Address @nelsonag comments on documentation --- docs/source/pythonapi/index.rst | 2 +- docs/source/usersguide/input.rst | 5 +++-- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/source/pythonapi/index.rst b/docs/source/pythonapi/index.rst index 0f22d0102..fb6cfe927 100644 --- a/docs/source/pythonapi/index.rst +++ b/docs/source/pythonapi/index.rst @@ -115,7 +115,7 @@ Many of the above classes are derived from several abstract classes: openmc.Region openmc.Lattice -Two helpers function are also available to create rectangular and hexagonal +Two helper function are also available to create rectangular and hexagonal prisms defined by the intersection of four and six surface half-spaces, respectively. diff --git a/docs/source/usersguide/input.rst b/docs/source/usersguide/input.rst index fff479cb9..a64454e92 100644 --- a/docs/source/usersguide/input.rst +++ b/docs/source/usersguide/input.rst @@ -214,14 +214,15 @@ The ```` element indicates the number of inactive batches used in a k-eigenvalue calculation. In general, the starting fission source iterations in an eigenvalue calculation can not be used to contribute to tallies since the fission source distribution and eigenvalue are generally not converged -immediately. +immediately. This element is ignored for all run modes other than "eigenvalue". *Default*: 0 ```` Element -------------------------- -The ```` element specifies a precision trigger on the combined +The ```` element (ignored for all run modes other than +"eigenvalue".) specifies a precision trigger on the combined :math:`k_{eff}`. The trigger is a convergence criterion on the uncertainty of the estimated eigenvalue. It has the following attributes/sub-elements: