mirror of
https://github.com/openmc-dev/openmc.git
synced 2026-07-29 06:35:48 -04:00
Updated gh-pages with more recent documentation.
This commit is contained in:
Paul Romano
parent
6fc37a62ec
commit
827f32f6da
22 changed files with 196 additions and 59 deletions
Binary file not shown.
|
Before Width: | Height: | Size: 443 B |
Binary file not shown.
|
Before Width: | Height: | Size: 373 B |
Binary file not shown.
|
Before Width: | Height: | Size: 419 B |
Binary file not shown.
|
Before Width: | Height: | Size: 471 B |
Binary file not shown.
|
Before Width: | Height: | Size: 377 B |
Binary file not shown.
|
Before Width: | Height: | Size: 327 B |
Binary file not shown.
|
Before Width: | Height: | Size: 551 B |
Binary file not shown.
|
Before Width: | Height: | Size: 341 B |
Binary file not shown.
|
Before Width: | Height: | Size: 388 B |
Binary file not shown.
|
Before Width: | Height: | Size: 196 B |
|
|
@ -13,11 +13,25 @@ on your machine. Since a number of Fortran 2003 features are used in the code,
|
|||
it is recommended that you use the latest version of whatever compiler you
|
||||
choose. For gfortran_, it is recommended that you use version 4.5.0 or above.
|
||||
|
||||
If you are using Debian or a Debian derivative such as Ubuntu, you can install
|
||||
the gfortran compiler using the following command::
|
||||
|
||||
sudo apt-get install gfortran
|
||||
|
||||
.. warning:: The runtime preformance with the Intel Fortran compiler and PGI
|
||||
Fortran compiler will likely exceed that of the gfortran compiler. Compiling
|
||||
with high optimization on the gfortran compiler may make up for some of the
|
||||
performance difference
|
||||
|
||||
To compile with support for parallel runs on a distributed-memory architecture,
|
||||
you will need to have a valid implementation of MPI installed on your
|
||||
machine. The code has been tested and is known to work with the latest versions
|
||||
of both OpenMPI_ and MPICH2_. You may use older versions of MPI implementations at
|
||||
your own risk.
|
||||
of both OpenMPI_ and MPICH2_. You may use older versions of MPI implementations
|
||||
at your own risk. OpenMPI and/or MPICH2 can be installed on Debian derivatives
|
||||
with::
|
||||
|
||||
sudo apt-get install mpich2
|
||||
sudo apt-get install openmpi-bin
|
||||
|
||||
.. _gfortran: http://gcc.gnu.org/wiki/GFortran
|
||||
.. _OpenMPI: http://www.open-mpi.org
|
||||
|
|
@ -55,12 +69,15 @@ USE_MPI
|
|||
also set the MPI root directory by setting the MPI variable further down in
|
||||
the Makefile.
|
||||
|
||||
USE_MPI
|
||||
USE_OPENMP
|
||||
Enables parallel runs on shared-memory architecture using OpenMP threading.
|
||||
|
||||
USE_COARRAY
|
||||
Enables parallel runs using Fortran 2008 coarrays.
|
||||
|
||||
.. note:: OpenMC does not yet support parallelism using OpenMP or Fortran 2008
|
||||
coarrays.
|
||||
|
||||
---------
|
||||
Compiling
|
||||
---------
|
||||
|
|
@ -69,6 +86,6 @@ To compile the code, run the following commands from within the root directory
|
|||
for OpenMC::
|
||||
|
||||
cd openmc/src
|
||||
make -f Makefile
|
||||
make
|
||||
|
||||
This will build an executable named ``openmc``.
|
||||
|
|
|
|||
|
|
@ -8,6 +8,6 @@ Welcome to the OpenMC User's Guide! This tutorial will guide you through the
|
|||
essential aspects of using OpenMC to perform neutronic simulations.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:maxdepth: 2
|
||||
|
||||
input
|
||||
|
|
|
|||
|
|
@ -30,12 +30,12 @@ materials, and settings for a Monte Carlo simulation.
|
|||
|
||||
.. _XML: http://www.w3.org/XML/
|
||||
|
||||
-----
|
||||
Files
|
||||
-----
|
||||
-----------------
|
||||
Overview of Files
|
||||
-----------------
|
||||
|
||||
To assemble a complete model for OpenMC, one needs to create separate XML files
|
||||
for the geometry, materails, and settings. Additionally, an optional tallies XML
|
||||
for the geometry, materials, and settings. Additionally, an optional tallies XML
|
||||
file specifies physical quantities to be tallied. OpenMC expects that these
|
||||
files are called:
|
||||
|
||||
|
|
@ -48,6 +48,56 @@ files are called:
|
|||
Geometry Specification -- geometry.xml
|
||||
--------------------------------------
|
||||
|
||||
The geometry in OpenMC is described using `constructive solid geometry`_ (CSG),
|
||||
also sometimes referred to as combinatorial geometry. CSG allows a user to
|
||||
create complex objects using Boolean operators on a set of simpler surfaces. In
|
||||
the geometry model, each unique closed volume in defined by its bounding
|
||||
surfaces. In OpenMC, most `quadratic surfaces`_ can be modeled and used as
|
||||
bounding surfaces.
|
||||
|
||||
Every geometry.xml must have an XML declaration at the beginning of the file and
|
||||
a root element named geometry. Within the root element the user can define any
|
||||
number of cells, surfaces, and lattices. Let us look at the following example::
|
||||
|
||||
<?xml version="1.0">
|
||||
<geometry>
|
||||
<!-- This is a comment -->
|
||||
|
||||
<surface>
|
||||
<uid>1</uid>
|
||||
<type>sphere</type>
|
||||
<coeffs>0.0 0.0 0.0 5.0</coeffs>
|
||||
<boundary>vacuum</boundary>
|
||||
<surface>
|
||||
|
||||
<cell>
|
||||
<uid>1</uid>
|
||||
<universe>0</universe>
|
||||
<material>1</material>
|
||||
<surfaces>-1</surfaces>
|
||||
</cell>
|
||||
</geometry>
|
||||
|
||||
At the beginning of this file is a comment, denoted by a tag starting with
|
||||
``<!--`` and ending with ``-->``. Comments, as well as any other type of input,
|
||||
may span multiple lines. One convenient feature of the XML input format is that
|
||||
sub-elements of the ``cell`` and ``surface`` elements can also be equivalently
|
||||
expressed of attributes of the original element, e.g. the geometry file above
|
||||
could be written as::
|
||||
|
||||
<?xml version="1.0">
|
||||
<geometry>
|
||||
<!-- This is a comment -->
|
||||
|
||||
<surface uid="1" type="sphere" coeffs="0.0 0.0 0.0 5.0" boundary="vacuum" />
|
||||
<cell uid="1" universe="0" material="1" surfaces="-1" />
|
||||
|
||||
</geometry>
|
||||
|
||||
.. _constructive solid geometry: http://en.wikipedia.org/wiki/Constructive_solid_geometry
|
||||
|
||||
.. _quadratic surfaces: http://en.wikipedia.org/wiki/Quadric
|
||||
|
||||
Types of surfaces:
|
||||
|
||||
``x-plane``
|
||||
|
|
|
|||
|
|
@ -7,13 +7,13 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Development Team — OpenMC v0.3.1 documentation</title>
|
||||
<title>Development Team — OpenMC v0.3.2 documentation</title>
|
||||
<link rel="stylesheet" href="_static/default.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '',
|
||||
VERSION: '0.3.1',
|
||||
VERSION: '0.3.2',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
|
|
@ -22,7 +22,7 @@
|
|||
<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>
|
||||
<link rel="top" title="OpenMC v0.3.1 documentation" href="index.html" />
|
||||
<link rel="top" title="OpenMC v0.3.2 documentation" href="index.html" />
|
||||
<link rel="prev" title="Creating XML Input Files" href="usersguide/input.html" />
|
||||
</head>
|
||||
<body>
|
||||
|
|
@ -35,7 +35,7 @@
|
|||
<li class="right" >
|
||||
<a href="usersguide/input.html" title="Creating XML Input Files"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li><a href="index.html">OpenMC v0.3.1 documentation</a> »</li>
|
||||
<li><a href="index.html">OpenMC v0.3.2 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
|
|
@ -98,7 +98,7 @@
|
|||
<li class="right" >
|
||||
<a href="usersguide/input.html" title="Creating XML Input Files"
|
||||
>previous</a> |</li>
|
||||
<li><a href="index.html">OpenMC v0.3.1 documentation</a> »</li>
|
||||
<li><a href="index.html">OpenMC v0.3.2 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
|
|
|
|||
|
|
@ -7,13 +7,13 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Index — OpenMC v0.3.1 documentation</title>
|
||||
<title>Index — OpenMC v0.3.2 documentation</title>
|
||||
<link rel="stylesheet" href="_static/default.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '',
|
||||
VERSION: '0.3.1',
|
||||
VERSION: '0.3.2',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
|
|
@ -22,7 +22,7 @@
|
|||
<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>
|
||||
<link rel="top" title="OpenMC v0.3.1 documentation" href="index.html" />
|
||||
<link rel="top" title="OpenMC v0.3.2 documentation" href="index.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
|
|
@ -31,7 +31,7 @@
|
|||
<li class="right" style="margin-right: 10px">
|
||||
<a href="#" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li><a href="index.html">OpenMC v0.3.1 documentation</a> »</li>
|
||||
<li><a href="index.html">OpenMC v0.3.2 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
|
|
@ -79,7 +79,7 @@
|
|||
<li class="right" style="margin-right: 10px">
|
||||
<a href="#" title="General Index"
|
||||
>index</a></li>
|
||||
<li><a href="index.html">OpenMC v0.3.1 documentation</a> »</li>
|
||||
<li><a href="index.html">OpenMC v0.3.2 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
|
|
|
|||
10
index.html
10
index.html
|
|
@ -7,13 +7,13 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>The OpenMC Monte Carlo Code — OpenMC v0.3.1 documentation</title>
|
||||
<title>The OpenMC Monte Carlo Code — OpenMC v0.3.2 documentation</title>
|
||||
<link rel="stylesheet" href="_static/default.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '',
|
||||
VERSION: '0.3.1',
|
||||
VERSION: '0.3.2',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
|
|
@ -22,7 +22,7 @@
|
|||
<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>
|
||||
<link rel="top" title="OpenMC v0.3.1 documentation" href="#" />
|
||||
<link rel="top" title="OpenMC v0.3.2 documentation" href="#" />
|
||||
<link rel="next" title="Installation" href="install.html" />
|
||||
</head>
|
||||
<body>
|
||||
|
|
@ -35,7 +35,7 @@
|
|||
<li class="right" >
|
||||
<a href="install.html" title="Installation"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li><a href="#">OpenMC v0.3.1 documentation</a> »</li>
|
||||
<li><a href="#">OpenMC v0.3.2 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
|
|
@ -117,7 +117,7 @@ within the <a class="reference external" href="http://crpg.mit.edu">Computationa
|
|||
<li class="right" >
|
||||
<a href="install.html" title="Installation"
|
||||
>next</a> |</li>
|
||||
<li><a href="#">OpenMC v0.3.1 documentation</a> »</li>
|
||||
<li><a href="#">OpenMC v0.3.2 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
|
|
|
|||
38
install.html
38
install.html
|
|
@ -7,13 +7,13 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Installation — OpenMC v0.3.1 documentation</title>
|
||||
<title>Installation — OpenMC v0.3.2 documentation</title>
|
||||
<link rel="stylesheet" href="_static/default.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '',
|
||||
VERSION: '0.3.1',
|
||||
VERSION: '0.3.2',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
|
|
@ -22,7 +22,7 @@
|
|||
<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>
|
||||
<link rel="top" title="OpenMC v0.3.1 documentation" href="index.html" />
|
||||
<link rel="top" title="OpenMC v0.3.2 documentation" href="index.html" />
|
||||
<link rel="next" title="Methodology" href="methods/index.html" />
|
||||
<link rel="prev" title="The OpenMC Monte Carlo Code" href="index.html" />
|
||||
</head>
|
||||
|
|
@ -39,7 +39,7 @@
|
|||
<li class="right" >
|
||||
<a href="index.html" title="The OpenMC Monte Carlo Code"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li><a href="index.html">OpenMC v0.3.1 documentation</a> »</li>
|
||||
<li><a href="index.html">OpenMC v0.3.2 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
|
|
@ -56,11 +56,26 @@
|
|||
on your machine. Since a number of Fortran 2003 features are used in the code,
|
||||
it is recommended that you use the latest version of whatever compiler you
|
||||
choose. For <a class="reference external" href="http://gcc.gnu.org/wiki/GFortran">gfortran</a>, it is recommended that you use version 4.5.0 or above.</p>
|
||||
<p>If you are using Debian or a Debian derivative such as Ubuntu, you can install
|
||||
the gfortran compiler using the following command:</p>
|
||||
<div class="highlight-python"><pre>sudo apt-get install gfortran</pre>
|
||||
</div>
|
||||
<div class="admonition warning">
|
||||
<p class="first admonition-title">Warning</p>
|
||||
<p class="last">The runtime preformance with the Intel Fortran compiler and PGI
|
||||
Fortran compiler will likely exceed that of the gfortran compiler. Compiling
|
||||
with high optimization on the gfortran compiler may make up for some of the
|
||||
performance difference</p>
|
||||
</div>
|
||||
<p>To compile with support for parallel runs on a distributed-memory architecture,
|
||||
you will need to have a valid implementation of MPI installed on your
|
||||
machine. The code has been tested and is known to work with the latest versions
|
||||
of both <a class="reference external" href="http://www.open-mpi.org">OpenMPI</a> and <a class="reference external" href="http://www.mcs.anl.gov/mpi/mpich/">MPICH2</a>. You may use older versions of MPI implementations at
|
||||
your own risk.</p>
|
||||
of both <a class="reference external" href="http://www.open-mpi.org">OpenMPI</a> and <a class="reference external" href="http://www.mcs.anl.gov/mpi/mpich/">MPICH2</a>. You may use older versions of MPI implementations
|
||||
at your own risk. OpenMPI and/or MPICH2 can be installed on Debian derivatives
|
||||
with:</p>
|
||||
<div class="highlight-python"><pre>sudo apt-get install mpich2
|
||||
sudo apt-get install openmpi-bin</pre>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="configuration">
|
||||
<h2>Configuration<a class="headerlink" href="#configuration" title="Permalink to this headline">¶</a></h2>
|
||||
|
|
@ -87,18 +102,23 @@ interprocedural optimization.</dd>
|
|||
<dd>Enables parallel runs using the Message Passing Interface. Users should
|
||||
also set the MPI root directory by setting the MPI variable further down in
|
||||
the Makefile.</dd>
|
||||
<dt>USE_MPI</dt>
|
||||
<dt>USE_OPENMP</dt>
|
||||
<dd>Enables parallel runs on shared-memory architecture using OpenMP threading.</dd>
|
||||
<dt>USE_COARRAY</dt>
|
||||
<dd>Enables parallel runs using Fortran 2008 coarrays.</dd>
|
||||
</dl>
|
||||
<div class="admonition note">
|
||||
<p class="first admonition-title">Note</p>
|
||||
<p class="last">OpenMC does not yet support parallelism using OpenMP or Fortran 2008
|
||||
coarrays.</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="compiling">
|
||||
<h2>Compiling<a class="headerlink" href="#compiling" title="Permalink to this headline">¶</a></h2>
|
||||
<p>To compile the code, run the following commands from within the root directory
|
||||
for OpenMC:</p>
|
||||
<div class="highlight-python"><pre>cd openmc/src
|
||||
make -f Makefile</pre>
|
||||
make</pre>
|
||||
</div>
|
||||
<p>This will build an executable named <tt class="docutils literal"><span class="pre">openmc</span></tt>.</p>
|
||||
</div>
|
||||
|
|
@ -160,7 +180,7 @@ make -f Makefile</pre>
|
|||
<li class="right" >
|
||||
<a href="index.html" title="The OpenMC Monte Carlo Code"
|
||||
>previous</a> |</li>
|
||||
<li><a href="index.html">OpenMC v0.3.1 documentation</a> »</li>
|
||||
<li><a href="index.html">OpenMC v0.3.2 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
|
|
|
|||
|
|
@ -7,13 +7,13 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Methodology — OpenMC v0.3.1 documentation</title>
|
||||
<title>Methodology — OpenMC v0.3.2 documentation</title>
|
||||
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '../',
|
||||
VERSION: '0.3.1',
|
||||
VERSION: '0.3.2',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
|
|
@ -22,7 +22,7 @@
|
|||
<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>
|
||||
<link rel="top" title="OpenMC v0.3.1 documentation" href="../index.html" />
|
||||
<link rel="top" title="OpenMC v0.3.2 documentation" href="../index.html" />
|
||||
<link rel="next" title="User’s Guide" href="../usersguide/index.html" />
|
||||
<link rel="prev" title="Installation" href="../install.html" />
|
||||
</head>
|
||||
|
|
@ -39,7 +39,7 @@
|
|||
<li class="right" >
|
||||
<a href="../install.html" title="Installation"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li><a href="../index.html">OpenMC v0.3.1 documentation</a> »</li>
|
||||
<li><a href="../index.html">OpenMC v0.3.2 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
|
|
@ -123,7 +123,7 @@ gradient to the surface at the point of crossing, i.e. <img class="math" src="..
|
|||
<li class="right" >
|
||||
<a href="../install.html" title="Installation"
|
||||
>previous</a> |</li>
|
||||
<li><a href="../index.html">OpenMC v0.3.1 documentation</a> »</li>
|
||||
<li><a href="../index.html">OpenMC v0.3.2 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
|
|
|
|||
10
search.html
10
search.html
|
|
@ -7,13 +7,13 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Search — OpenMC v0.3.1 documentation</title>
|
||||
<title>Search — OpenMC v0.3.2 documentation</title>
|
||||
<link rel="stylesheet" href="_static/default.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '',
|
||||
VERSION: '0.3.1',
|
||||
VERSION: '0.3.2',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
|
|
@ -23,7 +23,7 @@
|
|||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||
<script type="text/javascript" src="_static/searchtools.js"></script>
|
||||
<link rel="top" title="OpenMC v0.3.1 documentation" href="index.html" />
|
||||
<link rel="top" title="OpenMC v0.3.2 documentation" href="index.html" />
|
||||
<script type="text/javascript">
|
||||
jQuery(function() { Search.loadIndex("searchindex.js"); });
|
||||
</script>
|
||||
|
|
@ -37,7 +37,7 @@
|
|||
<li class="right" style="margin-right: 10px">
|
||||
<a href="genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li><a href="index.html">OpenMC v0.3.1 documentation</a> »</li>
|
||||
<li><a href="index.html">OpenMC v0.3.2 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
|
|
@ -85,7 +85,7 @@
|
|||
<li class="right" style="margin-right: 10px">
|
||||
<a href="genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li><a href="index.html">OpenMC v0.3.1 documentation</a> »</li>
|
||||
<li><a href="index.html">OpenMC v0.3.2 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
|
|
|
|||
|
|
@ -1 +1 @@
|
|||
Search.setIndex({objects:{},terms:{all:1,code:[0,5,3,1,2],forget:5,execut:1,thi:[2,1,4],move:3,focus:0,through:[4,3],aspect:4,materail:2,follow:[2,1],paul:[0,5],languag:2,reactor:0,xml:[2,4],whose:2,group:0,firstnam:2,also:[0,1],configur:1,makefil:1,should:1,fortran:1,mcnp:0,openmpi:1,vec:[],els:1,bracket:2,hat:[],lastnam:2,risk:1,thei:3,format:[0,2],webpag:2,familiar:2,piec:2,secondari:3,gfortran:1,characterist:2,use_mpi:1,bryan:5,intel:1,specif:2,arbitrari:2,cdot:[],anyth:1,html:2,gener:3,separ:2,vector:3,massachusett:0,team:[0,5],debug:1,architectur:1,where:3,compil:1,set:[2,1],began:0,direct:3,second:0,expect:2,pass:1,run:[2,1],carlo:[0,5,3,2],transport:[0,3],variabl:1,shown:3,gradient:3,section:[0,1],content:0,kord:5,written:[2,3],version:1,health:2,use_coarrai:1,between:2,paramet:1,ever:2,method:3,math:[],whatev:1,machin:1,led:5,serpent:0,coeffici:2,openmc:[0,1,2,3,4,5],romano:[0,5],physicist:2,free:0,perpendicular:2,extens:2,base:0,let:2,here:2,prerequisit:1,advisor:5,solv:3,depend:1,becom:3,sinc:1,card:2,both:1,about:2,thread:1,angl:2,interprocedur:1,materi:2,current:5,technolog:0,construct:0,simul:[0,4,2],profil:1,length:2,tutori:4,equat:3,geometri:[0,3,2],mani:2,chang:1,undergo:3,interact:0,first:2,softwar:1,own:1,effici:2,point:3,feel:0,exchang:2,within:[0,1],number:1,pgi:1,down:1,unlik:2,done:1,been:1,openmp:1,instal:[0,1],stand:2,guid:[0,4],your:1,unit:3,smith:[2,5],differ:2,from:1,describ:2,wai:2,memori:1,addition:2,data:[0,2],support:1,enabl:1,messag:1,parallel:1,much:2,interfac:[2,1],includ:5,recommend:1,call:2,choos:1,locat:1,type:2,tell:1,more:0,option:[2,1],name:1,benoit:5,methodolog:[0,3],specifi:2,particl:[0,3],flag:1,enclos:2,examin:2,particular:2,known:1,coarrai:1,talli:2,john:2,input:[2,4],gnu:1,solid:0,work:1,see:[2,1],structur:2,project:5,calcul:0,can:[3,1],abov:[3,1],root:1,veloc:3,randomli:3,program:2,featur:1,comput:0,have:1,creat:[2,3,4],order:[0,1],share:1,indic:2,activ:5,high:1,sphere:2,critic:0,tag:2,implement:1,file:[2,4],further:1,need:[2,1],seen:2,collis:3,ascii:2,occup:2,quadrat:2,denot:2,surfac:[0,3,2],develop:[0,5],form:[2,3],inform:0,perform:4,cylind:2,make:1,gprof:1,when:1,cross:[0,3],same:2,contact:0,other:2,valid:1,anyon:2,build:1,which:[2,1],test:1,you:[4,1],simpl:2,neutron:[0,3,4],complet:2,infinit:2,mpich2:1,unless:1,distribut:1,normal:3,optim:1,mont:[0,5,3,2],nest:2,who:2,reflect:3,capabl:0,plane:2,track:3,user:[0,1,4],mai:1,src:1,associ:2,herman:5,physic:[0,2],welcom:4,sete:2,experienc:1,essenti:4,older:1,directori:1,assembl:2,markup:2,well:1,quantiti:2,mpi:1,person:2,exampl:2,command:1,wherebi:[2,3],allow:2,institut:0,paral:2,model:[0,2],axi:2,travel:3,latest:1},objtypes:{},titles:["The OpenMC Monte Carlo Code","Installation","Creating XML Input Files","Methodology","User’s Guide","Development Team"],objnames:{},filenames:["index","install","usersguide/input","methods/index","usersguide/index","developers"]})
|
||||
Search.setIndex({objects:{},terms:{oper:2,all:1,code:[0,5,3,1,2],forget:5,execut:1,thi:[2,1,4],move:3,focus:0,through:[4,3],aspect:4,follow:[2,1],paul:[0,5],yet:1,languag:2,reactor:0,xml:[2,4],cell:2,group:0,firstnam:2,also:[0,1,2],materi:[2,4],configur:1,makefil:1,complex:2,should:1,fortran:1,mcnp:0,openmpi:1,herman:5,overview:[2,4],els:1,bracket:2,bin:1,lastnam:2,everi:2,risk:1,thei:3,get:1,webpag:2,familiar:2,express:2,piec:2,secondari:3,use_openmp:1,volum:2,vacuum:2,characterist:2,use_mpi:1,bryan:5,end:2,intel:1,specif:[2,4],anyth:1,arbitrari:2,separ:2,vector:3,declar:2,massachusett:0,have:[2,1],team:[0,5],debug:1,architectur:1,where:3,valid:1,compil:1,set:[2,1,4],began:0,some:1,direct:3,combinatori:2,second:0,doe:1,expect:2,pass:1,run:[2,1],carlo:[0,5,3,2],transport:[0,3],input:[2,4],variabl:1,shown:3,sub:2,gradient:3,openmc:[0,1,2,3,4,5],boundari:2,current:5,kord:5,written:[2,3],version:[2,1],health:2,use_coarrai:1,lattic:2,gfortran:1,content:0,ever:2,method:3,element:2,refer:2,machin:1,object:2,led:5,deriv:1,serpent:0,whose:2,romano:[0,5],gener:3,each:2,coeffici:2,perpendicular:2,free:0,like:1,extens:2,base:0,let:2,here:2,prerequisit:1,advisor:5,solv:3,depend:1,construct:[0,2],becom:3,between:2,card:2,simpler:2,both:1,about:2,particl:[0,3],would:[],thread:1,capabl:0,angl:2,interprocedur:1,veloc:3,materail:[],technolog:0,geometri:[0,4,3,2],simul:[0,4,2],profil:1,length:2,tutori:4,equat:3,span:2,section:[0,1],mani:2,chang:1,undergo:3,travel:3,interact:0,first:2,comment:2,softwar:1,own:1,effici:2,point:3,feel:0,exchang:2,format:[0,2],within:[0,1,2],bound:2,apt:1,pgi:1,down:1,unlik:2,"boolean":2,done:1,been:1,openmp:1,instal:[0,1],stand:2,guid:[0,4],your:1,unit:3,smith:[2,5],coarrai:1,differ:[2,1],from:1,describ:2,wai:2,memori:1,addition:2,data:[0,2],support:1,univers:2,sometim:2,messag:1,sinc:1,start:2,much:2,interfac:[2,1],includ:5,recommend:1,paramet:1,call:2,choos:1,conveni:2,type:2,tell:1,more:0,option:[2,1],name:[2,1],benoit:5,methodolog:[0,3],enabl:1,specifi:2,warn:1,flag:1,exce:1,enclos:2,examin:2,particular:2,known:1,number:[2,1],line:2,talli:[2,4],origin:2,must:2,john:2,look:2,gnu:1,solid:[0,2],coeff:2,work:1,uniqu:2,structur:2,project:5,defin:2,calcul:0,whatev:1,abov:[2,3,1],otherwis:[],root:[2,1],could:2,randomli:3,program:2,featur:[2,1],comput:0,uid:2,creat:[2,3,4],order:[0,1],can:[2,3,1],sudo:1,share:1,ani:2,indic:2,activ:5,high:1,sphere:2,critic:0,tag:2,implement:1,file:[2,4],further:1,need:[2,1],seen:2,quantiti:2,ascii:2,physicist:2,quadrat:2,denot:2,surfac:[0,3,2],multipl:2,form:[2,3],equival:2,inform:0,perform:[4,1],cylind:2,csg:2,gprof:1,when:1,cross:[0,3],same:2,contact:0,note:1,other:2,html:2,anyon:2,build:1,which:[2,1],test:1,you:[4,1],occup:2,simpl:2,neutron:[0,3,4],complet:2,close:2,infinit:2,begin:2,mpich2:1,unless:1,distribut:1,see:[2,1],normal:3,optim:1,mont:[0,5,3,2],nest:2,who:2,reflect:3,most:2,plane:2,track:3,user:[0,4,1,2],preform:1,mai:[2,1],develop:[0,5],attribut:2,src:1,associ:2,parallel:1,physic:[0,2],welcom:4,sete:2,experienc:1,essenti:4,wherebi:[2,3],older:1,directori:1,assembl:2,markup:2,collis:3,well:[2,1],locat:1,mpi:1,person:2,debian:1,exampl:2,command:1,runtim:1,allow:2,institut:0,paral:2,model:[0,2],axi:2,make:1,ubuntu:1,latest:1},objtypes:{},titles:["The OpenMC Monte Carlo Code","Installation","Creating XML Input Files","Methodology","User’s Guide","Development Team"],objnames:{},filenames:["index","install","usersguide/input","methods/index","usersguide/index","developers"]})
|
||||
|
|
@ -7,13 +7,13 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>User’s Guide — OpenMC v0.3.1 documentation</title>
|
||||
<title>User’s Guide — OpenMC v0.3.2 documentation</title>
|
||||
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '../',
|
||||
VERSION: '0.3.1',
|
||||
VERSION: '0.3.2',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
|
|
@ -22,7 +22,7 @@
|
|||
<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>
|
||||
<link rel="top" title="OpenMC v0.3.1 documentation" href="../index.html" />
|
||||
<link rel="top" title="OpenMC v0.3.2 documentation" href="../index.html" />
|
||||
<link rel="next" title="Creating XML Input Files" href="input.html" />
|
||||
<link rel="prev" title="Methodology" href="../methods/index.html" />
|
||||
</head>
|
||||
|
|
@ -39,7 +39,7 @@
|
|||
<li class="right" >
|
||||
<a href="../methods/index.html" title="Methodology"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li><a href="../index.html">OpenMC v0.3.1 documentation</a> »</li>
|
||||
<li><a href="../index.html">OpenMC v0.3.2 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
|
|
@ -54,7 +54,14 @@
|
|||
essential aspects of using OpenMC to perform neutronic simulations.</p>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="input.html">Creating XML Input Files</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="input.html">Creating XML Input Files</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="input.html#overview-of-files">Overview of Files</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="input.html#geometry-specification-geometry-xml">Geometry Specification – geometry.xml</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="input.html#materials-specification-materials-xml">Materials Specification – materials.xml</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="input.html#settings-specification-settings-xml">Settings Specification – settings.xml</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="input.html#tallies-specification-tallies-xml">Tallies Specification – tallies.xml</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -105,7 +112,7 @@ essential aspects of using OpenMC to perform neutronic simulations.</p>
|
|||
<li class="right" >
|
||||
<a href="../methods/index.html" title="Methodology"
|
||||
>previous</a> |</li>
|
||||
<li><a href="../index.html">OpenMC v0.3.1 documentation</a> »</li>
|
||||
<li><a href="../index.html">OpenMC v0.3.2 documentation</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
|
|
|
|||
|
|
@ -7,13 +7,13 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Creating XML Input Files — OpenMC v0.3.1 documentation</title>
|
||||
<title>Creating XML Input Files — OpenMC v0.3.2 documentation</title>
|
||||
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '../',
|
||||
VERSION: '0.3.1',
|
||||
VERSION: '0.3.2',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
|
|
@ -22,7 +22,7 @@
|
|||
<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>
|
||||
<link rel="top" title="OpenMC v0.3.1 documentation" href="../index.html" />
|
||||
<link rel="top" title="OpenMC v0.3.2 documentation" href="../index.html" />
|
||||
<link rel="up" title="User’s Guide" href="index.html" />
|
||||
<link rel="next" title="Development Team" href="../developers.html" />
|
||||
<link rel="prev" title="User’s Guide" href="index.html" />
|
||||
|
|
@ -40,7 +40,7 @@
|
|||
<li class="right" >
|
||||
<a href="index.html" title="User’s Guide"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li><a href="../index.html">OpenMC v0.3.1 documentation</a> »</li>
|
||||
<li><a href="../index.html">OpenMC v0.3.2 documentation</a> »</li>
|
||||
<li><a href="index.html" accesskey="U">User’s Guide</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
|
@ -72,10 +72,10 @@ person. The nested tags <em>firstname</em>, <em>lastname</em>, <em>age</em>, and
|
|||
indicate characteristics about the person being described.</p>
|
||||
<p>In much the same way, OpenMC input uses XML tags to describe the geometry, the
|
||||
materials, and settings for a Monte Carlo simulation.</p>
|
||||
<div class="section" id="files">
|
||||
<h2>Files<a class="headerlink" href="#files" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="overview-of-files">
|
||||
<h2>Overview of Files<a class="headerlink" href="#overview-of-files" title="Permalink to this headline">¶</a></h2>
|
||||
<p>To assemble a complete model for OpenMC, one needs to create separate XML files
|
||||
for the geometry, materails, and settings. Additionally, an optional tallies XML
|
||||
for the geometry, materials, and settings. Additionally, an optional tallies XML
|
||||
file specifies physical quantities to be tallied. OpenMC expects that these
|
||||
files are called:</p>
|
||||
<ul class="simple">
|
||||
|
|
@ -87,6 +87,49 @@ files are called:</p>
|
|||
</div>
|
||||
<div class="section" id="geometry-specification-geometry-xml">
|
||||
<h2>Geometry Specification – geometry.xml<a class="headerlink" href="#geometry-specification-geometry-xml" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The geometry in OpenMC is described using <a class="reference external" href="http://en.wikipedia.org/wiki/Constructive_solid_geometry">constructive solid geometry</a> (CSG),
|
||||
also sometimes referred to as combinatorial geometry. CSG allows a user to
|
||||
create complex objects using Boolean operators on a set of simpler surfaces. In
|
||||
the geometry model, each unique closed volume in defined by its bounding
|
||||
surfaces. In OpenMC, most <a class="reference external" href="http://en.wikipedia.org/wiki/Quadric">quadratic surfaces</a> can be modeled and used as
|
||||
bounding surfaces.</p>
|
||||
<p>Every geometry.xml must have an XML declaration at the beginning of the file and
|
||||
a root element named geometry. Within the root element the user can define any
|
||||
number of cells, surfaces, and lattices. Let us look at the following example:</p>
|
||||
<div class="highlight-python"><pre><?xml version="1.0">
|
||||
<geometry>
|
||||
<!-- This is a comment -->
|
||||
|
||||
<surface>
|
||||
<uid>1</uid>
|
||||
<type>sphere</type>
|
||||
<coeffs>0.0 0.0 0.0 5.0</coeffs>
|
||||
<boundary>vacuum</boundary>
|
||||
<surface>
|
||||
|
||||
<cell>
|
||||
<uid>1</uid>
|
||||
<universe>0</universe>
|
||||
<material>1</material>
|
||||
<surfaces>-1</surfaces>
|
||||
</cell>
|
||||
</geometry></pre>
|
||||
</div>
|
||||
<p>At the beginning of this file is a comment, denoted by a tag starting with
|
||||
<tt class="docutils literal"><span class="pre"><!--</span></tt> and ending with <tt class="docutils literal"><span class="pre">--></span></tt>. Comments, as well as any other type of input,
|
||||
may span multiple lines. One convenient feature of the XML input format is that
|
||||
sub-elements of the <tt class="docutils literal"><span class="pre">cell</span></tt> and <tt class="docutils literal"><span class="pre">surface</span></tt> elements can also be equivalently
|
||||
expressed of attributes of the original element, e.g. the geometry file above
|
||||
could be written as:</p>
|
||||
<div class="highlight-python"><pre><?xml version="1.0">
|
||||
<geometry>
|
||||
<!-- This is a comment -->
|
||||
|
||||
<surface uid="1" type="sphere" coeffs="0.0 0.0 0.0 5.0" boundary="vacuum" />
|
||||
<cell uid="1" universe="0" material="1" surfaces="-1" />
|
||||
|
||||
</geometry></pre>
|
||||
</div>
|
||||
<p>Types of surfaces:</p>
|
||||
<dl class="docutils">
|
||||
<dt><tt class="docutils literal"><span class="pre">x-plane</span></tt></dt>
|
||||
|
|
@ -138,7 +181,7 @@ R^2"/>. The coefficients specified are “<img class="math" src="../_images/
|
|||
<h3><a href="../index.html">Table Of Contents</a></h3>
|
||||
<ul>
|
||||
<li><a class="reference internal" href="#">Creating XML Input Files</a><ul>
|
||||
<li><a class="reference internal" href="#files">Files</a></li>
|
||||
<li><a class="reference internal" href="#overview-of-files">Overview of Files</a></li>
|
||||
<li><a class="reference internal" href="#geometry-specification-geometry-xml">Geometry Specification – geometry.xml</a></li>
|
||||
<li><a class="reference internal" href="#materials-specification-materials-xml">Materials Specification – materials.xml</a></li>
|
||||
<li><a class="reference internal" href="#settings-specification-settings-xml">Settings Specification – settings.xml</a></li>
|
||||
|
|
@ -187,7 +230,7 @@ R^2"/>. The coefficients specified are “<img class="math" src="../_images/
|
|||
<li class="right" >
|
||||
<a href="index.html" title="User’s Guide"
|
||||
>previous</a> |</li>
|
||||
<li><a href="../index.html">OpenMC v0.3.1 documentation</a> »</li>
|
||||
<li><a href="../index.html">OpenMC v0.3.2 documentation</a> »</li>
|
||||
<li><a href="index.html" >User’s Guide</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue