mirror of
https://github.com/openmc-dev/openmc.git
synced 2026-07-29 06:35:48 -04:00
Updated user's guide.
This commit is contained in:
Paul Romano
parent
0a8fed139e
commit
96e4e97817
9 changed files with 34 additions and 209 deletions
Binary file not shown.
|
Before Width: | Height: | Size: 707 B |
|
|
@ -1,37 +0,0 @@
|
|||
============ ====================== =============================================
|
||||
Type Variable Description
|
||||
============ ====================== =============================================
|
||||
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
|
||||
integer(4) run_mode Run mode used. 1 = criticality, 2 = fixed
|
||||
source
|
||||
integer(8) n_particles Number of particles used per generation.
|
||||
integer(4) n_batches Total number of batches (active + inactive).
|
||||
integer(4) n_inactive Number of inactive batches
|
||||
integer(4) gen_per_batch Number of generations per batch for
|
||||
criticality calculations
|
||||
integer(4) current_batch Number of batches already simulated.
|
||||
============ ====================== =============================================
|
||||
|
||||
The next variable appears only for a criticality calculation (run_mode =
|
||||
MODE_CRITICALITY = 1).
|
||||
|
||||
============ ====================== =============================================
|
||||
real(8) k_batch(i), i = 1, k-effective for the i-th batch
|
||||
current_batch
|
||||
============ ====================== =============================================
|
||||
|
||||
The next variable appears only for a criticality calculation where Shannon
|
||||
entropy has been turned on.
|
||||
|
||||
============ ====================== =============================================
|
||||
real(8) entropy(i), i = 1, Shannon entropy for the i-th batch
|
||||
current_batch
|
||||
============ ====================== =============================================
|
||||
|
||||
|
||||
|
|
@ -21,12 +21,24 @@ the problem at hand (mostly on the number of nuclides in the problem).
|
|||
New Features
|
||||
------------
|
||||
|
||||
- Suppress creation of summary.out and cross_sections.out by default with option
|
||||
to turn them on with <output> tag in settings.xml file.
|
||||
- Ability to create HDF5 state points.
|
||||
- Binary source file is now part of state point file by default.
|
||||
- Enhanced state point usage and added state point Python scripts.
|
||||
- Turning confidence intervals on affects k-effective.
|
||||
- Option to specify <upper_right> for tally meshes.
|
||||
|
||||
---------
|
||||
Bug Fixes
|
||||
---------
|
||||
|
||||
- 7ee416_: Fixed bug with multi-line input using type='word'.
|
||||
- 792eb3_: Fixed degrees of freedom for confidence intervals.
|
||||
- 7fd617_: Fixed bug with restart runs in parallel.
|
||||
- dc4a8f_: Fixed bug with fixed source restart runs.
|
||||
|
||||
.. _7ee416: https://github.com/mit-crpg/openmc/commit/7ee416
|
||||
.. _792eb3: https://github.com/mit-crpg/openmc/commit/792eb3
|
||||
.. _7fd617: https://github.com/mit-crpg/openmc/commit/7fd617
|
||||
.. _dc4a8f: https://github.com/mit-crpg/openmc/commit/dc4a8f
|
||||
|
|
|
|||
|
|
@ -938,6 +938,13 @@ sub-elements:
|
|||
Specifies the custom color for the cell or material. Should be 3 integers separated
|
||||
by spaces.
|
||||
|
||||
As an example, if your plot is colored by material and you want material 23
|
||||
to be blue, the corresponding ``col_spec`` element would look like:
|
||||
|
||||
.. code-block:: xml
|
||||
|
||||
<col_spec id="23" rgb="0 0 255" />
|
||||
|
||||
*Default*: None
|
||||
|
||||
:mask:
|
||||
|
|
|
|||
|
|
@ -1,171 +0,0 @@
|
|||
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title><no title> — OpenMC Documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="../_static/haiku.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/print.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '../',
|
||||
VERSION: '0.4.3',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="../_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||||
<script type="text/javascript" src="../_static/theme_extras.js"></script>
|
||||
<link rel="top" title="OpenMC Documentation" href="../index.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="header">
|
||||
<a href="../index.html">
|
||||
<img class="logo" src="../_static/openmc.png" alt="Logo"/>
|
||||
</a>
|
||||
</div>
|
||||
<div class="topnav">
|
||||
|
||||
<p>
|
||||
<a class="uplink" href="../index.html">Contents</a>
|
||||
</p>
|
||||
|
||||
</div>
|
||||
<div class="content">
|
||||
|
||||
|
||||
<table border="1" class="docutils">
|
||||
<colgroup>
|
||||
<col width="15%" />
|
||||
<col width="28%" />
|
||||
<col width="57%" />
|
||||
</colgroup>
|
||||
<thead valign="bottom">
|
||||
<tr class="row-odd"><th class="head">Type</th>
|
||||
<th class="head">Variable</th>
|
||||
<th class="head">Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody valign="top">
|
||||
<tr class="row-even"><td>integer(4)</td>
|
||||
<td>REVISION_STATEPOINT</td>
|
||||
<td>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.</td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td>integer(4)</td>
|
||||
<td>VERSION_MAJOR</td>
|
||||
<td>Major version number for OpenMC</td>
|
||||
</tr>
|
||||
<tr class="row-even"><td>integer(4)</td>
|
||||
<td>VERSION_MINOR</td>
|
||||
<td>Minor version number for OpenMC</td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td>integer(4)</td>
|
||||
<td>VERSION_RELEASE</td>
|
||||
<td>Release version number for OpenMC</td>
|
||||
</tr>
|
||||
<tr class="row-even"><td>integer(4)</td>
|
||||
<td>run_mode</td>
|
||||
<td>Run mode used. 1 = criticality, 2 = fixed
|
||||
source</td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td>integer(8)</td>
|
||||
<td>n_particles</td>
|
||||
<td>Number of particles used per generation.</td>
|
||||
</tr>
|
||||
<tr class="row-even"><td>integer(4)</td>
|
||||
<td>n_batches</td>
|
||||
<td>Total number of batches (active + inactive).</td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td>integer(4)</td>
|
||||
<td>n_inactive</td>
|
||||
<td>Number of inactive batches</td>
|
||||
</tr>
|
||||
<tr class="row-even"><td>integer(4)</td>
|
||||
<td>gen_per_batch</td>
|
||||
<td>Number of generations per batch for
|
||||
criticality calculations</td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td>integer(4)</td>
|
||||
<td>current_batch</td>
|
||||
<td>Number of batches already simulated.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p>The next variable appears only for a criticality calculation (run_mode =
|
||||
MODE_CRITICALITY = 1).</p>
|
||||
<table border="1" class="docutils">
|
||||
<colgroup>
|
||||
<col width="15%" />
|
||||
<col width="28%" />
|
||||
<col width="57%" />
|
||||
</colgroup>
|
||||
<tbody valign="top">
|
||||
<tr class="row-odd"><td>real(8)</td>
|
||||
<td>k_batch(i), i = 1,
|
||||
current_batch</td>
|
||||
<td>k-effective for the i-th batch</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p>The next variable appears only for a criticality calculation where Shannon
|
||||
entropy has been turned on.</p>
|
||||
<table border="1" class="docutils">
|
||||
<colgroup>
|
||||
<col width="15%" />
|
||||
<col width="28%" />
|
||||
<col width="57%" />
|
||||
</colgroup>
|
||||
<tbody valign="top">
|
||||
<tr class="row-odd"><td>real(8)</td>
|
||||
<td>entropy(i), i = 1,
|
||||
current_batch</td>
|
||||
<td>Shannon entropy for the i-th batch</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
|
||||
</div>
|
||||
<div class="bottomnav">
|
||||
|
||||
<p>
|
||||
<a class="uplink" href="../index.html">Contents</a>
|
||||
</p>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="footer">
|
||||
© Copyright 2011-2012, Massachusetts Institute of Technology.
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
|
||||
</div>
|
||||
<script type="text/javascript">
|
||||
|
||||
var _gaq = _gaq || [];
|
||||
_gaq.push(['_setAccount', 'UA-30411614-1']);
|
||||
_gaq.push(['_trackPageview']);
|
||||
|
||||
(function() {
|
||||
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
|
||||
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
|
||||
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
|
||||
})();
|
||||
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
BIN
objects.inv
BIN
objects.inv
Binary file not shown.
|
|
@ -69,13 +69,22 @@ the problem at hand (mostly on the number of nuclides in the problem).</p>
|
|||
<div class="section" id="new-features">
|
||||
<h2>New Features<a class="headerlink" href="#new-features" title="Permalink to this headline">¶</a></h2>
|
||||
<ul class="simple">
|
||||
<li>Suppress creation of summary.out and cross_sections.out by default with option
|
||||
to turn them on with <output> tag in settings.xml file.</li>
|
||||
<li>Ability to create HDF5 state points.</li>
|
||||
<li>Binary source file is now part of state point file by default.</li>
|
||||
<li>Enhanced state point usage and added state point Python scripts.</li>
|
||||
<li>Turning confidence intervals on affects k-effective.</li>
|
||||
<li>Option to specify <upper_right> for tally meshes.</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="bug-fixes">
|
||||
<h2>Bug Fixes<a class="headerlink" href="#bug-fixes" title="Permalink to this headline">¶</a></h2>
|
||||
<ul class="simple">
|
||||
<li><a class="reference external" href="https://github.com/mit-crpg/openmc/commit/7ee416">7ee416</a>: Fixed bug with multi-line input using type=’word’.</li>
|
||||
<li><a class="reference external" href="https://github.com/mit-crpg/openmc/commit/792eb3">792eb3</a>: Fixed degrees of freedom for confidence intervals.</li>
|
||||
<li><a class="reference external" href="https://github.com/mit-crpg/openmc/commit/7fd617">7fd617</a>: Fixed bug with restart runs in parallel.</li>
|
||||
<li><a class="reference external" href="https://github.com/mit-crpg/openmc/commit/dc4a8f">dc4a8f</a>: Fixed bug with fixed source restart runs.</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
|
@ -1026,6 +1026,11 @@ by spaces.</td>
|
|||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p>As an example, if your plot is colored by material and you want material 23
|
||||
to be blue, the corresponding <tt class="docutils literal"><span class="pre">col_spec</span></tt> element would look like:</p>
|
||||
<div class="highlight-xml"><div class="highlight"><pre><span class="nt"><col_spec</span> <span class="na">id=</span><span class="s">"23"</span> <span class="na">rgb=</span><span class="s">"0 0 255"</span> <span class="nt">/></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p><em>Default</em>: None</p>
|
||||
</td>
|
||||
</tr>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue