Updated documentation.

This commit is contained in:
Paul Romano 2012-02-08 13:43:41 -05:00
parent c3b91a3cbf
commit 8fc482a2a4
2 changed files with 84 additions and 24 deletions

View file

@ -117,9 +117,10 @@ Each ``surface`` element can have the following attributes or sub-elements:
*Default*: None
:boundary:
The boundary condition for the surface. This can be ``vacuum`` or ``reflective``.
The boundary condition for the surface. This can be ``transmission``,
``vacuum``, or ``reflective``.
*Default*: ``reflective``
*Default*: ``transmission``
The following quadratic surfaces can be modeled:
@ -205,9 +206,8 @@ universe. A ``lattice`` accepts the following attributes or sub-elements:
:id:
A unique integer that can be used to identify the surface.
:type:
A string indicating the arrangement of lattice cells. Accepted options are
"rectangular" and "hexagonal".
:type: A string indicating the arrangement of lattice cells. Currently, the
only accepted option is "rectangular".
*Default*: rectangular
@ -266,8 +266,8 @@ Each ``material`` element can have the following attributes or sub-elements:
weight percent of that nuclide within the material, respectively. One
example would be as follows::
<nuclide name="H-1" xs="03c" ao="2.0" />
<nuclide name="O-16" xs="03c" ao="1.0" />
<nuclide name="H-1" xs="70c" ao="2.0" />
<nuclide name="O-16" xs="70c" ao="1.0" />
.. note:: If one nuclide is specified in atom percent, all others must also
be given in atom percent. The same applies for weight percentages.
@ -342,6 +342,27 @@ below which particles undergo Russian roulette.
*Default*: 0.25
``entropy_box`` Element
-----------------------
This element describes the lower-left and upper-right corners of a box to be
used for calculting Shannon entropy. This box should cover all possible
fissionable materials in the problem. The values given after this element should
be six numbers, the first of which are the Cartesian coordinates of the
lower-left corner of the box and the last three of which are the Cartesian
coordinates of the upper-right corner of the box.
*Default*: None
``ptables`` Element
-------------------
The ``ptables`` element determines whether probability tables should be used in
the unresolved resonance range if available. This element has no attributes or
sub-elements and can be set to either "off" or "on".
*Default*: on
``source`` Element
------------------
@ -367,6 +388,15 @@ survival biasing, otherwise known as implicit capture or absorption.
*Default*: off
``trace`` Element
-----------------
The ``trace`` element can be used to print out detailed information about a
single particle during a simulation. This element should be followed by two
integers, the cycle and one for the particle number.
*Default*: None
``verbosity`` Element
---------------------
@ -503,6 +533,20 @@ attributes/sub-elements:
:width:
The width of mesh cells in each direction.
``assume_separate`` Element
---------------------------
In cases where the user needs to specify many different tallies each of which
are spatially separate, this tag can be used to cut down on some of the tally
overhead. The effect of assuming all tallies are spatially separate is that once
one tally is scored to, the same event is assumed not to score to any other
tallies. This element should be followed by "yes" or "no"
.. warning:: If used incorrectly, the assumption that all tallies are spatially
separate can lead to incorrect results.
*Default*: no
-------------------------------------------
Geometry Plotting Specification -- plot.xml
-------------------------------------------
@ -532,9 +576,7 @@ the plot in each of the basis directions.
-----------------
The ``basis`` element has no attributes/sub-elements and indicates the specified
basis for plotting.
.. note:: The only accepted option currently is "xy"
basis for plotting. The only option option currently accepted is "xy".
*Default*: xy