Updated documentation.

This commit is contained in:
Paul Romano 2013-01-15 08:52:29 -05:00
parent 272b35b7af
commit 53cb5a11ff
11 changed files with 677 additions and 85 deletions

View file

@ -4,6 +4,238 @@
State Point Binary File Specifications
======================================
----------
Revision 7
----------
**integer(4) REVISION_STATEPOINT**
Revision of the binary state point file. Any time a change is made in the
format of the state-point file, this integer is incremented.
**integer(4) VERSION_MAJOR**
Major version number for OpenMC
**integer(4) VERSION_MINOR**
Minor version number for OpenMC
**integer(4) VERSION_RELEASE**
Release version number for OpenMC
**character(19) time_stamp**
Date and time the state point was written.
**character(255) path**
Absolute path to directory containing input files.
**integer(8) seed**
Pseudo-random number generator seed.
**integer(4) run_mode**
run mode used. The modes are described in constants.F90.
**integer(8) n_particles**
Number of particles used per generation.
**integer(4) n_batches**
Total number of batches (active + inactive).
**integer(4) current_batch**
The number of batches already simulated.
if (run_mode == MODE_CRITICALITY)
**integer(4) n_inactive**
Number of inactive batches
**integer(4) gen_per_batch**
Number of generations per batch for criticality calculations
*do i = 1, current_batch*
**real(8) k_batch(i)**
k-effective for the i-th batch
*do i = 1, current_batch*
**real(8) entropy(i)**
Shannon entropy for the i-th batch
**integer(4) n_meshes**
Number of meshes in tallies.xml file
*do i = 1, n_meshes*
**integer(4) meshes(i) % id**
Unique ID of mesh.
**integer(4) meshes(i) % type**
Type of mesh.
**integer(4) meshes(i) % n_dimension**
Number of dimensions for mesh (2 or 3).
**integer(4) meshes(i) % dimension(:)**
Number of mesh cells in each dimension.
**real(8) meshes(i) % lower_left(:)**
Coordinates of lower-left corner of mesh.
**real(8) meshes(i) % upper_right(:)**
Coordinates of upper-right corner of mesh.
**real(8) meshes(i) % width(:)**
Width of each mesh cell in each dimension.
**integer(4) n_tallies**
*do i = 1, n_tallies*
**integer(4) tallies(i) % id**
Unique ID of tally.
**integer(4) tallies(i) % n_realizations**
Number of realizations for the i-th tally.
**integer(4) size(tallies(i) % scores, 1)**
Total number of score bins for the i-th tally
**integer(4) size(tallies(i) % scores, 2)**
Total number of filter bins for the i-th tally
**integer(4) tallies(i) % n_filters**
*do j = 1, tallies(i) % n_filters*
**integer(4) tallies(i) % filter(j) % type**
Type of tally filter.
**integer(4) tallies(i) % filter(j) % n_bins**
Number of bins for filter.
**integer(4)/real(8) tallies(i) % filter(j) % bins(:)**
Value for each filter bin of this type.
**integer(4) tallies(i) % n_nuclide_bins**
Number of nuclide bins. If none are specified, this is just one.
*do j = 1, tallies(i) % n_nuclide_bins*
**integer(4) tallies(i) % nuclide_bins(j)**
Values of specified nuclide bins
**integer(4) tallies(i) % n_score_bins**
Number of scoring bins.
*do j = 1, tallies(i) % n_score_bins*
**integer(4) tallies(i) % score_bins(j)**
Values of specified scoring bins (e.g. SCORE_FLUX).
*do j = 1, tallies(i) % n_score_bins*
**integer(4) tallies(i) % scatt_order(j)**
Scattering Order specified scoring bins.
**integer(4) tallies(i) % n_score_bins**
Number of scoring bins without accounting for those added by
the scatter-pn command.
**integer(4) n_realizations**
Number of realizations for global tallies.
**integer(4) N_GLOBAL_TALLIES**
Number of global tally scores
*do i = 1, N_GLOBAL_TALLIES*
**real(8) global_tallies(i) % sum**
Accumulated sum for the i-th global tally
**real(8) global_tallies(i) % sum_sq**
Accumulated sum of squares for the i-th global tally
**integer(4) tallies_on**
Flag indicated if tallies are present in the file.
if (tallies_on > 0)
*do i = 1, n_tallies*
*do k = 1, size(tallies(i) % scores, 2)*
*do j = 1, size(tallies(i) % scores, 1)*
**real(8) tallies(i) % scores(j,k) % sum**
Accumulated sum for the j-th score and k-th filter of the
i-th tally
**real(8) tallies(i) % scores(j,k) % sum_sq**
Accumulated sum of squares for the j-th score and k-th
filter of the i-th tally
if (run_mode == MODE_CRITICALITY)
*do i = 1, n_particles*
**real(8) source_bank(i) % wgt**
Weight of the i-th source particle
**real(8) source_bank(i) % xyz(1:3)**
Coordinates of the i-th source particle.
**real(8) source_bank(i) % uvw(1:3)**
Direction of the i-th source particle
**real(8) source_bank(i) % E**
Energy of the i-th source particle.
----------
Revision 6
----------

View file

@ -761,8 +761,8 @@ The ``<tally>`` element accepts the following sub-elements:
*Default*: total
:scores:
The desired responses to be accumulated. See below for full details on what
responses can be tallied.
The desired responses to be accumulated. See below for full details on the
responses which be tallied.
The following filters can be specified for a tally:
@ -815,26 +815,18 @@ The following responses can be tallied.
multiplicity from (n,2n), (n,3n), and (n,4n) reactions and should be
slightly higher than the scattering rate.
:scatter-0:
Zeroth scattering moment. Can also be identified with the ``scatter``
response type, but is provided for consistency with the higher order
scattering moments.
:scatter-N:
Tally the N\ :sup:`th` \ scattering moment, where N is the Legendre expansion order.
N must be between 0 and 10. As an example, tallying the 2\ :sup:`nd` \ scattering
moment would be specified as ``<scores> scatter-2 </scores>``.
:scatter-1:
First scattering moment
:scatter-2:
Second scattering moment
:scatter-3:
Third scattering moment
:scatter-PN:
Tally all of the scattering moments from order 0 to N, where N is
the Legendre expansion order. That is, ``scatter-P1`` is equivalent
to requesting tallies of ``scatter-0`` and ``scatter-1``.
N must be between 0 and 10. As an example, tallying up to the 2\ :sup:`nd` \
scattering moment would be specified as ``<scores> scatter-P2 </scores>``.
:scatter-4:
Fourth scattering moment
:scatter-5:
Fifth scattering moment
:absorption:
Total absorption rate. This accounts for all reactions which do not produce
secondary neutrons.

View file

@ -126,11 +126,33 @@ This will build an executable named ``openmc``.
Compiling on Windows
--------------------
To compile OpenMC on a Windows operating system, you will need to first install
Cygwin_, a Linux-like environment for Windows. When configuring Cygwin, make
sure you install both the gfortran compiler as well as git. Once you have
obtained the source code, run the following commands from within the source code
root directory:
Using Cygwin
------------
One option for compiling OpenMC on a Windows operating system is to use Cygwin_,
a Linux-like environment for Windows. You will need to first `install
Cygwin`_. When you are asked to select packages, make sure the following are
selected:
* Devel: gcc4-core
* Devel: gcc4-fortran
* Devel: make
If you plan on obtaining the source code directly using git, select the
following packages:
* Devel: git
* Devel: git-completion (Optional)
* Devel: gitk (Optional)
In order to use the Python scripts provided with OpenMC, you will also need to
install Python. This can be done within Cygwin or directly in Windows. To
install within Cygwin, select the following packages:
* Python: python (Version > 2.7 recommended)
Once you have obtained the source code, run the following commands from within
the source code root directory:
.. code-block:: sh
@ -139,29 +161,93 @@ root directory:
This will build an executable named ``openmc``.
.. _Cygwin: http://www.cygwin.com/
.. _Cygwin: http://cygwin.com/
.. _install Cygwin: http://cygwin.com/setup.exe
Using MinGW
-----------
An alternate option for installing OpenMC on Windows is using MinGW_, which
stands for Minimalist GNU for Windows. An executable for installing the MinGW
distribution is available on SourceForge_. When installing MinGW, make sure the
following components are selected:
* MinGW Compiler Suite: Fortran Compiler
* MSYS Basic System
Once MinGW is installed, copy the OpenMC source distribution to your MinGW home
directory (usually C:\\MinGW\\msys\\1.0\\home\\YourUsername). Once you have
the source code in place, run the following commands from within the MinGW shell
in the root directory of the OpenMC distribution:
.. code-block:: sh
cd src
make
This will build an executable named ``openmc``.
.. _MinGW: http://www.mingw.org
.. _SourceForge: http://sourceforge.net/projects/mingw
---------------------------
Cross-Section Configuration
Cross Section Configuration
---------------------------
In order to run a simulation with OpenMC, you will need cross-section data for
each nuclide in your problem. Since OpenMC uses ACE format cross-sections, you
can use nuclear data distributed with MCNP_ or Serpent_.
In order to run a simulation with OpenMC, you will need cross section data for
each nuclide in your problem. Since OpenMC uses ACE format cross sections, you
can use nuclear data that was processed with NJOY, such as that distributed with
MCNP_ or Serpent_.
Using JEFF Cross Sections from OECD/NEA
---------------------------------------
The NEA_ provides processed ACE data from the JEFF_ nuclear library upon
request. A DVD of the data can be requested here_. To use this data with OpenMC,
the following steps must be taken:
1. Copy and unzip the data on the DVD to a directory on your computer.
2. In the root directory, a file named ``xsdir``, or some variant thereof,
should be present. This file contains a listing of all the cross sections and
is used by MCNP. This file should be converted to a ``cross_sections.xml``
file for use with OpenMC. A Python script is provided in the OpenMC
distribution for this purpose:
.. code-block:: sh
openmc/src/utils/convert_xsdir.py xsdir31 cross_sections.xml
3. In the converted ``cross_sections.xml`` file, change the contents of the
<directory> element to the absolute path of the directory containing the
actual ACE files.
4. Additionally, you may need to change any occurrences of upper-case "ACE"
within the ``cross_sections.xml`` file to lower-case.
5. Either set the :ref:`cross_sections` in a settings.xml file or the
:envvar:`CROSS_SECTIONS` environment variable to the absolute path of the
``cross_sections.xml`` file.
Using Cross Sections from MCNP
------------------------------
To use cross sections distributed with MCNP, change the <directory> element in
the ``cross_sections.xml`` file in the root directory of the OpenMC distribution
to the location of the MCNP cross-sections. Then, either set the
to the location of the MCNP cross sections. Then, either set the
:ref:`cross_sections` in a settings.xml file or the :envvar:`CROSS_SECTIONS`
environment variable to the absolute path of the ``cross_sections.xml`` file.
Similarly, to use cross-sections distributed with Serpent, change the
<directory> element in the ``cross_sections_serpent.xml`` file in the root
directory of the OpenMC distribution to the location of the Serpent
cross-sections. Then, either set the :ref:`cross_sections` in a settings.xml
file or the :envvar:`CROSS_SECTIONS` environment variable to the absolute path
of the ``cross_sections_serpent.xml`` file.
Using Cross Sections from Serpent
---------------------------------
To use cross sections distributed with Serpent, change the <directory> element
in the ``cross_sections_serpent.xml`` file in the root directory of the OpenMC
distribution to the location of the Serpent cross sections. Then, either set the
:ref:`cross_sections` in a settings.xml file or the :envvar:`CROSS_SECTIONS`
environment variable to the absolute path of the ``cross_sections_serpent.xml``
file.
.. _NEA: http://www.oecd-nea.org
.. _JEFF: http://www.oecd-nea.org/dbdata/jeff/
.. _here: http://www.oecd-nea.org/dbdata/pubs/jeff312-cd.html
.. _MCNP: http://mcnp.lanl.gov
.. _Serpent: http://montecarlo.vtt.fi

View file

@ -82,12 +82,13 @@ as debugging.</p>
<li class="toctree-l1"><a class="reference internal" href="workflow.html">3. Development Workflow</a></li>
<li class="toctree-l1"><a class="reference internal" href="xml-fortran.html">4. xml-fortran Input Parsing</a></li>
<li class="toctree-l1"><a class="reference internal" href="statepoint.html">5. State Point Binary File Specifications</a><ul>
<li class="toctree-l2"><a class="reference internal" href="statepoint.html#revision-6">5.1. Revision 6</a></li>
<li class="toctree-l2"><a class="reference internal" href="statepoint.html#revision-5">5.2. Revision 5</a></li>
<li class="toctree-l2"><a class="reference internal" href="statepoint.html#revision-4">5.3. Revision 4</a></li>
<li class="toctree-l2"><a class="reference internal" href="statepoint.html#revision-3">5.4. Revision 3</a></li>
<li class="toctree-l2"><a class="reference internal" href="statepoint.html#revision-2">5.5. Revision 2</a></li>
<li class="toctree-l2"><a class="reference internal" href="statepoint.html#revision-1">5.6. Revision 1</a></li>
<li class="toctree-l2"><a class="reference internal" href="statepoint.html#revision-7">5.1. Revision 7</a></li>
<li class="toctree-l2"><a class="reference internal" href="statepoint.html#revision-6">5.2. Revision 6</a></li>
<li class="toctree-l2"><a class="reference internal" href="statepoint.html#revision-5">5.3. Revision 5</a></li>
<li class="toctree-l2"><a class="reference internal" href="statepoint.html#revision-4">5.4. Revision 4</a></li>
<li class="toctree-l2"><a class="reference internal" href="statepoint.html#revision-3">5.5. Revision 3</a></li>
<li class="toctree-l2"><a class="reference internal" href="statepoint.html#revision-2">5.6. Revision 2</a></li>
<li class="toctree-l2"><a class="reference internal" href="statepoint.html#revision-1">5.7. Revision 1</a></li>
</ul>
</li>
</ul>

View file

@ -54,8 +54,206 @@
<div class="section" id="state-point-binary-file-specifications">
<span id="devguide-statepoint"></span><h1>5. State Point Binary File Specifications<a class="headerlink" href="#state-point-binary-file-specifications" title="Permalink to this headline"></a></h1>
<div class="section" id="revision-7">
<h2>5.1. Revision 7<a class="headerlink" href="#revision-7" title="Permalink to this headline"></a></h2>
<p><strong>integer(4) REVISION_STATEPOINT</strong></p>
<blockquote>
<div>Revision of the binary state point file. Any time a change is made in the
format of the state-point file, this integer is incremented.</div></blockquote>
<p><strong>integer(4) VERSION_MAJOR</strong></p>
<blockquote>
<div>Major version number for OpenMC</div></blockquote>
<p><strong>integer(4) VERSION_MINOR</strong></p>
<blockquote>
<div>Minor version number for OpenMC</div></blockquote>
<p><strong>integer(4) VERSION_RELEASE</strong></p>
<blockquote>
<div>Release version number for OpenMC</div></blockquote>
<p><strong>character(19) time_stamp</strong></p>
<blockquote>
<div>Date and time the state point was written.</div></blockquote>
<p><strong>character(255) path</strong></p>
<blockquote>
<div>Absolute path to directory containing input files.</div></blockquote>
<p><strong>integer(8) seed</strong></p>
<blockquote>
<div>Pseudo-random number generator seed.</div></blockquote>
<p><strong>integer(4) run_mode</strong></p>
<blockquote>
<div>run mode used. The modes are described in constants.F90.</div></blockquote>
<p><strong>integer(8) n_particles</strong></p>
<blockquote>
<div>Number of particles used per generation.</div></blockquote>
<p><strong>integer(4) n_batches</strong></p>
<blockquote>
<div>Total number of batches (active + inactive).</div></blockquote>
<p><strong>integer(4) current_batch</strong></p>
<blockquote>
<div>The number of batches already simulated.</div></blockquote>
<p>if (run_mode == MODE_CRITICALITY)</p>
<blockquote>
<div><p><strong>integer(4) n_inactive</strong></p>
<blockquote>
<div>Number of inactive batches</div></blockquote>
<p><strong>integer(4) gen_per_batch</strong></p>
<blockquote>
<div>Number of generations per batch for criticality calculations</div></blockquote>
<p><em>do i = 1, current_batch</em></p>
<blockquote>
<div><p><strong>real(8) k_batch(i)</strong></p>
<blockquote>
<div>k-effective for the i-th batch</div></blockquote>
</div></blockquote>
<p><em>do i = 1, current_batch</em></p>
<blockquote>
<div><p><strong>real(8) entropy(i)</strong></p>
<blockquote>
<div>Shannon entropy for the i-th batch</div></blockquote>
</div></blockquote>
</div></blockquote>
<p><strong>integer(4) n_meshes</strong></p>
<blockquote>
<div>Number of meshes in tallies.xml file</div></blockquote>
<p><em>do i = 1, n_meshes</em></p>
<blockquote>
<div><p><strong>integer(4) meshes(i) % id</strong></p>
<blockquote>
<div>Unique ID of mesh.</div></blockquote>
<p><strong>integer(4) meshes(i) % type</strong></p>
<blockquote>
<div>Type of mesh.</div></blockquote>
<p><strong>integer(4) meshes(i) % n_dimension</strong></p>
<blockquote>
<div>Number of dimensions for mesh (2 or 3).</div></blockquote>
<p><strong>integer(4) meshes(i) % dimension(:)</strong></p>
<blockquote>
<div>Number of mesh cells in each dimension.</div></blockquote>
<p><strong>real(8) meshes(i) % lower_left(:)</strong></p>
<blockquote>
<div>Coordinates of lower-left corner of mesh.</div></blockquote>
<p><strong>real(8) meshes(i) % upper_right(:)</strong></p>
<blockquote>
<div>Coordinates of upper-right corner of mesh.</div></blockquote>
<p><strong>real(8) meshes(i) % width(:)</strong></p>
<blockquote>
<div>Width of each mesh cell in each dimension.</div></blockquote>
</div></blockquote>
<p><strong>integer(4) n_tallies</strong></p>
<p><em>do i = 1, n_tallies</em></p>
<blockquote>
<div><p><strong>integer(4) tallies(i) % id</strong></p>
<blockquote>
<div>Unique ID of tally.</div></blockquote>
<p><strong>integer(4) tallies(i) % n_realizations</strong></p>
<blockquote>
<div>Number of realizations for the i-th tally.</div></blockquote>
<p><strong>integer(4) size(tallies(i) % scores, 1)</strong></p>
<blockquote>
<div>Total number of score bins for the i-th tally</div></blockquote>
<p><strong>integer(4) size(tallies(i) % scores, 2)</strong></p>
<blockquote>
<div>Total number of filter bins for the i-th tally</div></blockquote>
<p><strong>integer(4) tallies(i) % n_filters</strong></p>
<p><em>do j = 1, tallies(i) % n_filters</em></p>
<blockquote>
<div><p><strong>integer(4) tallies(i) % filter(j) % type</strong></p>
<blockquote>
<div>Type of tally filter.</div></blockquote>
<p><strong>integer(4) tallies(i) % filter(j) % n_bins</strong></p>
<blockquote>
<div>Number of bins for filter.</div></blockquote>
<p><strong>integer(4)/real(8) tallies(i) % filter(j) % bins(:)</strong></p>
<blockquote>
<div>Value for each filter bin of this type.</div></blockquote>
</div></blockquote>
<p><strong>integer(4) tallies(i) % n_nuclide_bins</strong></p>
<blockquote>
<div>Number of nuclide bins. If none are specified, this is just one.</div></blockquote>
<p><em>do j = 1, tallies(i) % n_nuclide_bins</em></p>
<blockquote>
<div><p><strong>integer(4) tallies(i) % nuclide_bins(j)</strong></p>
<blockquote>
<div>Values of specified nuclide bins</div></blockquote>
</div></blockquote>
<p><strong>integer(4) tallies(i) % n_score_bins</strong></p>
<blockquote>
<div>Number of scoring bins.</div></blockquote>
<p><em>do j = 1, tallies(i) % n_score_bins</em></p>
<blockquote>
<div><p><strong>integer(4) tallies(i) % score_bins(j)</strong></p>
<blockquote>
<div>Values of specified scoring bins (e.g. SCORE_FLUX).</div></blockquote>
</div></blockquote>
<p><em>do j = 1, tallies(i) % n_score_bins</em></p>
<blockquote>
<div><p><strong>integer(4) tallies(i) % scatt_order(j)</strong></p>
<blockquote>
<div>Scattering Order specified scoring bins.</div></blockquote>
</div></blockquote>
<p><strong>integer(4) tallies(i) % n_score_bins</strong></p>
<blockquote>
<div>Number of scoring bins without accounting for those added by
the scatter-pn command.</div></blockquote>
</div></blockquote>
<p><strong>integer(4) n_realizations</strong></p>
<blockquote>
<div>Number of realizations for global tallies.</div></blockquote>
<p><strong>integer(4) N_GLOBAL_TALLIES</strong></p>
<blockquote>
<div>Number of global tally scores</div></blockquote>
<p><em>do i = 1, N_GLOBAL_TALLIES</em></p>
<blockquote>
<div><p><strong>real(8) global_tallies(i) % sum</strong></p>
<blockquote>
<div>Accumulated sum for the i-th global tally</div></blockquote>
<p><strong>real(8) global_tallies(i) % sum_sq</strong></p>
<blockquote>
<div>Accumulated sum of squares for the i-th global tally</div></blockquote>
</div></blockquote>
<p><strong>integer(4) tallies_on</strong></p>
<blockquote>
<div>Flag indicated if tallies are present in the file.</div></blockquote>
<p>if (tallies_on &gt; 0)</p>
<blockquote>
<div><p><em>do i = 1, n_tallies</em></p>
<blockquote>
<div><p><em>do k = 1, size(tallies(i) % scores, 2)</em></p>
<blockquote>
<div><p><em>do j = 1, size(tallies(i) % scores, 1)</em></p>
<blockquote>
<div><p><strong>real(8) tallies(i) % scores(j,k) % sum</strong></p>
<blockquote>
<div>Accumulated sum for the j-th score and k-th filter of the
i-th tally</div></blockquote>
<p><strong>real(8) tallies(i) % scores(j,k) % sum_sq</strong></p>
<blockquote>
<div>Accumulated sum of squares for the j-th score and k-th
filter of the i-th tally</div></blockquote>
</div></blockquote>
</div></blockquote>
</div></blockquote>
</div></blockquote>
<p>if (run_mode == MODE_CRITICALITY)</p>
<blockquote>
<div><p><em>do i = 1, n_particles</em></p>
<blockquote>
<div><p><strong>real(8) source_bank(i) % wgt</strong></p>
<blockquote>
<div>Weight of the i-th source particle</div></blockquote>
<p><strong>real(8) source_bank(i) % xyz(1:3)</strong></p>
<blockquote>
<div>Coordinates of the i-th source particle.</div></blockquote>
<p><strong>real(8) source_bank(i) % uvw(1:3)</strong></p>
<blockquote>
<div>Direction of the i-th source particle</div></blockquote>
<p><strong>real(8) source_bank(i) % E</strong></p>
<blockquote>
<div>Energy of the i-th source particle.</div></blockquote>
</div></blockquote>
</div></blockquote>
</div>
<div class="section" id="revision-6">
<h2>5.1. Revision 6<a class="headerlink" href="#revision-6" title="Permalink to this headline"></a></h2>
<h2>5.2. Revision 6<a class="headerlink" href="#revision-6" title="Permalink to this headline"></a></h2>
<p><strong>integer(4) REVISION_STATEPOINT</strong></p>
<blockquote>
<div>Revision of the binary state point file. Any time a change is made in the
@ -243,7 +441,7 @@ filter of the i-th tally</div></blockquote>
</div></blockquote>
</div>
<div class="section" id="revision-5">
<h2>5.2. Revision 5<a class="headerlink" href="#revision-5" title="Permalink to this headline"></a></h2>
<h2>5.3. Revision 5<a class="headerlink" href="#revision-5" title="Permalink to this headline"></a></h2>
<p><strong>integer(4) REVISION_STATEPOINT</strong></p>
<blockquote>
<div>Revision of the binary state point file. Any time a change is made in the
@ -422,7 +620,7 @@ filter of the i-th tally</div></blockquote>
</div></blockquote>
</div>
<div class="section" id="revision-4">
<h2>5.3. Revision 4<a class="headerlink" href="#revision-4" title="Permalink to this headline"></a></h2>
<h2>5.4. Revision 4<a class="headerlink" href="#revision-4" title="Permalink to this headline"></a></h2>
<p><strong>integer(4) REVISION_STATEPOINT</strong></p>
<blockquote>
<div>Revision of the binary state point file. Any time a change is made in the
@ -598,7 +796,7 @@ filter of the i-th tally</div></blockquote>
</div></blockquote>
</div>
<div class="section" id="revision-3">
<h2>5.4. Revision 3<a class="headerlink" href="#revision-3" title="Permalink to this headline"></a></h2>
<h2>5.5. Revision 3<a class="headerlink" href="#revision-3" title="Permalink to this headline"></a></h2>
<p><strong>integer(4) REVISION_STATEPOINT</strong></p>
<blockquote>
<div>Revision of the binary state point file. Any time a change is made in the
@ -771,7 +969,7 @@ filter of the i-th tally</div></blockquote>
</div></blockquote>
</div>
<div class="section" id="revision-2">
<h2>5.5. Revision 2<a class="headerlink" href="#revision-2" title="Permalink to this headline"></a></h2>
<h2>5.6. Revision 2<a class="headerlink" href="#revision-2" title="Permalink to this headline"></a></h2>
<p><strong>integer(4) REVISION_STATEPOINT</strong></p>
<blockquote>
<div>Revision of the binary state point file. Any time a change is made in the
@ -859,7 +1057,7 @@ the i-th tally</div></blockquote>
</div></blockquote>
</div>
<div class="section" id="revision-1">
<h2>5.6. Revision 1<a class="headerlink" href="#revision-1" title="Permalink to this headline"></a></h2>
<h2>5.7. Revision 1<a class="headerlink" href="#revision-1" title="Permalink to this headline"></a></h2>
<p><strong>integer(4) REVISION_STATEPOINT</strong></p>
<blockquote>
<div>Revision of the binary state point file. Any time a change is made in the

View file

@ -60,7 +60,7 @@
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%" valign="top"><dl>
<dt><a href="usersguide/install.html#index-0">CROSS_SECTIONS</a>, <a href="usersguide/install.html#index-1">[1]</a>, <a href="usersguide/input.html#index-0">[2]</a>, <a href="usersguide/troubleshoot.html#index-2">[3]</a>, <a href="usersguide/troubleshoot.html#index-3">[4]</a>
<dt><a href="usersguide/install.html#index-0">CROSS_SECTIONS</a>, <a href="usersguide/install.html#index-1">[1]</a>, <a href="usersguide/install.html#index-2">[2]</a>, <a href="usersguide/input.html#index-0">[3]</a>, <a href="usersguide/troubleshoot.html#index-2">[4]</a>, <a href="usersguide/troubleshoot.html#index-3">[5]</a>
</dt>
</dl></td>
@ -76,7 +76,7 @@
<dd><dl>
<dt><a href="usersguide/install.html#index-0">CROSS_SECTIONS</a>, <a href="usersguide/install.html#index-1">[1]</a>, <a href="usersguide/input.html#index-0">[2]</a>, <a href="usersguide/troubleshoot.html#index-2">[3]</a>, <a href="usersguide/troubleshoot.html#index-3">[4]</a>
<dt><a href="usersguide/install.html#index-0">CROSS_SECTIONS</a>, <a href="usersguide/install.html#index-1">[1]</a>, <a href="usersguide/install.html#index-2">[2]</a>, <a href="usersguide/input.html#index-0">[3]</a>, <a href="usersguide/troubleshoot.html#index-2">[4]</a>, <a href="usersguide/troubleshoot.html#index-3">[5]</a>
</dt>

Binary file not shown.

File diff suppressed because one or more lines are too long

View file

@ -68,8 +68,17 @@ essential aspects of using OpenMC to perform neutronic simulations.</p>
<li class="toctree-l2"><a class="reference internal" href="install.html#obtaining-the-source">2.2. Obtaining the Source</a></li>
<li class="toctree-l2"><a class="reference internal" href="install.html#build-configuration">2.3. Build Configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="install.html#compiling-on-linux-and-mac-os-x">2.4. Compiling on Linux and Mac OS X</a></li>
<li class="toctree-l2"><a class="reference internal" href="install.html#compiling-on-windows">2.5. Compiling on Windows</a></li>
<li class="toctree-l2"><a class="reference internal" href="install.html#cross-section-configuration">2.6. Cross-Section Configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="install.html#compiling-on-windows">2.5. Compiling on Windows</a><ul>
<li class="toctree-l3"><a class="reference internal" href="install.html#using-cygwin">2.5.1. Using Cygwin</a></li>
<li class="toctree-l3"><a class="reference internal" href="install.html#using-mingw">2.5.2. Using MinGW</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="install.html#cross-section-configuration">2.6. Cross Section Configuration</a><ul>
<li class="toctree-l3"><a class="reference internal" href="install.html#using-jeff-cross-sections-from-oecd-nea">2.6.1. Using JEFF Cross Sections from OECD/NEA</a></li>
<li class="toctree-l3"><a class="reference internal" href="install.html#using-cross-sections-from-mcnp">2.6.2. Using Cross Sections from MCNP</a></li>
<li class="toctree-l3"><a class="reference internal" href="install.html#using-cross-sections-from-serpent">2.6.3. Using Cross Sections from Serpent</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="install.html#running-openmc">2.7. Running OpenMC</a></li>
<li class="toctree-l2"><a class="reference internal" href="install.html#configuring-input-validation-with-gnu-emacs-nxml-mode">2.8. Configuring Input Validation with GNU Emacs nXML mode</a></li>
</ul>

View file

@ -828,8 +828,8 @@ be:</p>
<p><em>Default</em>: total</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">scores:</th><td class="field-body"><p class="first last">The desired responses to be accumulated. See below for full details on what
responses can be tallied.</p>
<tr class="field-even field"><th class="field-name">scores:</th><td class="field-body"><p class="first last">The desired responses to be accumulated. See below for full details on the
responses which be tallied.</p>
</td>
</tr>
</tbody>
@ -885,19 +885,14 @@ response type.</td>
multiplicity from (n,2n), (n,3n), and (n,4n) reactions and should be
slightly higher than the scattering rate.</td>
</tr>
<tr class="field-odd field"><th class="field-name">scatter-0:</th><td class="field-body">Zeroth scattering moment. Can also be identified with the <tt class="docutils literal"><span class="pre">scatter</span></tt>
response type, but is provided for consistency with the higher order
scattering moments.</td>
<tr class="field-odd field"><th class="field-name">scatter-N:</th><td class="field-body">Tally the N<sup>th</sup> scattering moment, where N is the Legendre expansion order.
N must be between 0 and 10. As an example, tallying the 2<sup>nd</sup> scattering
moment would be specified as <tt class="docutils literal"><span class="pre">&lt;scores&gt;</span> <span class="pre">scatter-2</span> <span class="pre">&lt;/scores&gt;</span></tt>.</td>
</tr>
<tr class="field-even field"><th class="field-name">scatter-1:</th><td class="field-body">First scattering moment</td>
</tr>
<tr class="field-odd field"><th class="field-name">scatter-2:</th><td class="field-body">Second scattering moment</td>
</tr>
<tr class="field-even field"><th class="field-name">scatter-3:</th><td class="field-body">Third scattering moment</td>
</tr>
<tr class="field-odd field"><th class="field-name">scatter-4:</th><td class="field-body">Fourth scattering moment</td>
</tr>
<tr class="field-even field"><th class="field-name">scatter-5:</th><td class="field-body">Fifth scattering moment</td>
<tr class="field-even field"><th class="field-name">scatter-PN:</th><td class="field-body">Tally all of the scattering moments from order 0 to N, where N is
the Legendre expansion order. That is, <tt class="docutils literal"><span class="pre">scatter-P1</span></tt> is equivalent
to requesting tallies of <tt class="docutils literal"><span class="pre">scatter-0</span></tt> and <tt class="docutils literal"><span class="pre">scatter-1</span></tt>.
N must be between 0 and 10. As an example, tallying up to the 2<sup>nd</sup> scattering moment would be specified as <tt class="docutils literal"><span class="pre">&lt;scores&gt;</span> <span class="pre">scatter-P2</span> <span class="pre">&lt;/scores&gt;</span></tt>.</td>
</tr>
<tr class="field-odd field"><th class="field-name">absorption:</th><td class="field-body">Total absorption rate. This accounts for all reactions which do not produce
secondary neutrons.</td>

View file

@ -143,33 +143,112 @@ make
</div>
<div class="section" id="compiling-on-windows">
<h2>2.5. Compiling on Windows<a class="headerlink" href="#compiling-on-windows" title="Permalink to this headline"></a></h2>
<p>To compile OpenMC on a Windows operating system, you will need to first install
<a class="reference external" href="http://www.cygwin.com/">Cygwin</a>, a Linux-like environment for Windows. When configuring Cygwin, make
sure you install both the gfortran compiler as well as git. Once you have
obtained the source code, run the following commands from within the source code
root directory:</p>
<div class="section" id="using-cygwin">
<h3>2.5.1. Using Cygwin<a class="headerlink" href="#using-cygwin" title="Permalink to this headline"></a></h3>
<p>One option for compiling OpenMC on a Windows operating system is to use <a class="reference external" href="http://cygwin.com/">Cygwin</a>,
a Linux-like environment for Windows. You will need to first <a class="reference external" href="http://cygwin.com/setup.exe">install
Cygwin</a>. When you are asked to select packages, make sure the following are
selected:</p>
<ul class="simple">
<li>Devel: gcc4-core</li>
<li>Devel: gcc4-fortran</li>
<li>Devel: make</li>
</ul>
<p>If you plan on obtaining the source code directly using git, select the
following packages:</p>
<ul class="simple">
<li>Devel: git</li>
<li>Devel: git-completion (Optional)</li>
<li>Devel: gitk (Optional)</li>
</ul>
<p>In order to use the Python scripts provided with OpenMC, you will also need to
install Python. This can be done within Cygwin or directly in Windows. To
install within Cygwin, select the following packages:</p>
<ul class="simple">
<li>Python: python (Version &gt; 2.7 recommended)</li>
</ul>
<p>Once you have obtained the source code, run the following commands from within
the source code root directory:</p>
<div class="highlight-sh"><div class="highlight"><pre><span class="nb">cd </span>src
make
</pre></div>
</div>
<p>This will build an executable named <tt class="docutils literal"><span class="pre">openmc</span></tt>.</p>
</div>
<div class="section" id="using-mingw">
<h3>2.5.2. Using MinGW<a class="headerlink" href="#using-mingw" title="Permalink to this headline"></a></h3>
<p>An alternate option for installing OpenMC on Windows is using <a class="reference external" href="http://www.mingw.org">MinGW</a>, which
stands for Minimalist GNU for Windows. An executable for installing the MinGW
distribution is available on <a class="reference external" href="http://sourceforge.net/projects/mingw">SourceForge</a>. When installing MinGW, make sure the
following components are selected:</p>
<ul class="simple">
<li>MinGW Compiler Suite: Fortran Compiler</li>
<li>MSYS Basic System</li>
</ul>
<p>Once MinGW is installed, copy the OpenMC source distribution to your MinGW home
directory (usually C:\MinGW\msys\1.0\home\YourUsername). Once you have
the source code in place, run the following commands from within the MinGW shell
in the root directory of the OpenMC distribution:</p>
<div class="highlight-sh"><div class="highlight"><pre><span class="nb">cd </span>src
make
</pre></div>
</div>
<p>This will build an executable named <tt class="docutils literal"><span class="pre">openmc</span></tt>.</p>
</div>
</div>
<div class="section" id="cross-section-configuration">
<h2>2.6. Cross-Section Configuration<a class="headerlink" href="#cross-section-configuration" title="Permalink to this headline"></a></h2>
<p>In order to run a simulation with OpenMC, you will need cross-section data for
each nuclide in your problem. Since OpenMC uses ACE format cross-sections, you
can use nuclear data distributed with <a class="reference external" href="http://mcnp.lanl.gov">MCNP</a> or <a class="reference external" href="http://montecarlo.vtt.fi">Serpent</a>.</p>
<h2>2.6. Cross Section Configuration<a class="headerlink" href="#cross-section-configuration" title="Permalink to this headline"></a></h2>
<p>In order to run a simulation with OpenMC, you will need cross section data for
each nuclide in your problem. Since OpenMC uses ACE format cross sections, you
can use nuclear data that was processed with NJOY, such as that distributed with
<a class="reference external" href="http://mcnp.lanl.gov">MCNP</a> or <a class="reference external" href="http://montecarlo.vtt.fi">Serpent</a>.</p>
<div class="section" id="using-jeff-cross-sections-from-oecd-nea">
<h3>2.6.1. Using JEFF Cross Sections from OECD/NEA<a class="headerlink" href="#using-jeff-cross-sections-from-oecd-nea" title="Permalink to this headline"></a></h3>
<p>The <a class="reference external" href="http://www.oecd-nea.org">NEA</a> provides processed ACE data from the <a class="reference external" href="http://www.oecd-nea.org/dbdata/jeff/">JEFF</a> nuclear library upon
request. A DVD of the data can be requested <a class="reference external" href="http://www.oecd-nea.org/dbdata/pubs/jeff312-cd.html">here</a>. To use this data with OpenMC,
the following steps must be taken:</p>
<ol class="arabic">
<li><p class="first">Copy and unzip the data on the DVD to a directory on your computer.</p>
</li>
<li><p class="first">In the root directory, a file named <tt class="docutils literal"><span class="pre">xsdir</span></tt>, or some variant thereof,
should be present. This file contains a listing of all the cross sections and
is used by MCNP. This file should be converted to a <tt class="docutils literal"><span class="pre">cross_sections.xml</span></tt>
file for use with OpenMC. A Python script is provided in the OpenMC
distribution for this purpose:</p>
<div class="highlight-sh"><div class="highlight"><pre>openmc/src/utils/convert_xsdir.py xsdir31 cross_sections.xml
</pre></div>
</div>
</li>
<li><p class="first">In the converted <tt class="docutils literal"><span class="pre">cross_sections.xml</span></tt> file, change the contents of the
&lt;directory&gt; element to the absolute path of the directory containing the
actual ACE files.</p>
</li>
<li><p class="first">Additionally, you may need to change any occurrences of upper-case &#8220;ACE&#8221;
within the <tt class="docutils literal"><span class="pre">cross_sections.xml</span></tt> file to lower-case.</p>
</li>
<li><p class="first">Either set the <a class="reference internal" href="input.html#cross-sections"><em>&lt;cross_sections&gt; Element</em></a> in a settings.xml file or the
<span class="target" id="index-0"></span><tt class="xref std std-envvar docutils literal"><span class="pre">CROSS_SECTIONS</span></tt> environment variable to the absolute path of the
<tt class="docutils literal"><span class="pre">cross_sections.xml</span></tt> file.</p>
</li>
</ol>
</div>
<div class="section" id="using-cross-sections-from-mcnp">
<h3>2.6.2. Using Cross Sections from MCNP<a class="headerlink" href="#using-cross-sections-from-mcnp" title="Permalink to this headline"></a></h3>
<p>To use cross sections distributed with MCNP, change the &lt;directory&gt; element in
the <tt class="docutils literal"><span class="pre">cross_sections.xml</span></tt> file in the root directory of the OpenMC distribution
to the location of the MCNP cross-sections. Then, either set the
<a class="reference internal" href="input.html#cross-sections"><em>&lt;cross_sections&gt; Element</em></a> in a settings.xml file or the <span class="target" id="index-0"></span><tt class="xref std std-envvar docutils literal"><span class="pre">CROSS_SECTIONS</span></tt>
to the location of the MCNP cross sections. Then, either set the
<a class="reference internal" href="input.html#cross-sections"><em>&lt;cross_sections&gt; Element</em></a> in a settings.xml file or the <span class="target" id="index-1"></span><tt class="xref std std-envvar docutils literal"><span class="pre">CROSS_SECTIONS</span></tt>
environment variable to the absolute path of the <tt class="docutils literal"><span class="pre">cross_sections.xml</span></tt> file.</p>
<p>Similarly, to use cross-sections distributed with Serpent, change the
&lt;directory&gt; element in the <tt class="docutils literal"><span class="pre">cross_sections_serpent.xml</span></tt> file in the root
directory of the OpenMC distribution to the location of the Serpent
cross-sections. Then, either set the <a class="reference internal" href="input.html#cross-sections"><em>&lt;cross_sections&gt; Element</em></a> in a settings.xml
file or the <span class="target" id="index-1"></span><tt class="xref std std-envvar docutils literal"><span class="pre">CROSS_SECTIONS</span></tt> environment variable to the absolute path
of the <tt class="docutils literal"><span class="pre">cross_sections_serpent.xml</span></tt> file.</p>
</div>
<div class="section" id="using-cross-sections-from-serpent">
<h3>2.6.3. Using Cross Sections from Serpent<a class="headerlink" href="#using-cross-sections-from-serpent" title="Permalink to this headline"></a></h3>
<p>To use cross sections distributed with Serpent, change the &lt;directory&gt; element
in the <tt class="docutils literal"><span class="pre">cross_sections_serpent.xml</span></tt> file in the root directory of the OpenMC
distribution to the location of the Serpent cross sections. Then, either set the
<a class="reference internal" href="input.html#cross-sections"><em>&lt;cross_sections&gt; Element</em></a> in a settings.xml file or the <span class="target" id="index-2"></span><tt class="xref std std-envvar docutils literal"><span class="pre">CROSS_SECTIONS</span></tt>
environment variable to the absolute path of the <tt class="docutils literal"><span class="pre">cross_sections_serpent.xml</span></tt>
file.</p>
</div>
</div>
<div class="section" id="running-openmc">
<h2>2.7. Running OpenMC<a class="headerlink" href="#running-openmc" title="Permalink to this headline"></a></h2>