Updated gh-pages with latest docs.

This commit is contained in:
Paul Romano 2011-09-08 23:05:18 -04:00
parent 352fef04f0
commit 6fc37a62ec
42 changed files with 358 additions and 17 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 183 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 203 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 305 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 443 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 373 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 419 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 399 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 941 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 223 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 510 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 471 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 377 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 682 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 381 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 761 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 327 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 551 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 194 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 551 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 329 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 726 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 172 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 333 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 341 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 336 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 385 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 426 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 388 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 196 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 581 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 490 B

View file

@ -27,7 +27,7 @@ your own risk.
Configuration
-------------
All configuration for OpenMC is done within the Makefile located
All configuration for OpenMC is done within the Makefile located in
``src/Makefile``. In the Makefile, you will see that there are a number of User
Options which can be changed. It is recommended that you do not change anything
else in the Makefile unless you are experienced with compiling and building

View file

@ -7,3 +7,22 @@ Methodology
The OpenMC code solves the neutron transport equation using the Monte Carlo
method whereby particles are tracked as they randomly move through a geometry,
undergoing collisions, and creating secondary particles.
-------------------
Reflective Surfaces
-------------------
In general, a surface can be written in the form :math:`f(x,y,z) = 0`. If a
neutron is traveling in direction :math:`\vec{v}` and crosses a reflective
surface of the above form, it can be shown that the velocity vector will then
become
.. math::
\mathbf{v'} = \mathbf{v} - 2 (\mathbf{v} \cdot \hat{\mathbf{n}})
\hat{\mathbf{n}}
where :math:`\hat{\mathbf{n}}` is a unit vector normal to the surface at the
point of the surface crossing. The direction of the surface normal will be the
gradient to the surface at the point of crossing, i.e. :math:`\mathbf{n} =
\nabla f(x,y,z)`.

View file

@ -9,3 +9,5 @@ essential aspects of using OpenMC to perform neutronic simulations.
.. toctree::
:maxdepth: 1
input

View file

@ -0,0 +1,99 @@
.. _usersguide_input:
========================
Creating XML Input Files
========================
Unlike many other Monte Carlo codes which use an arbitrary-format ASCII file
with "cards" to specify a particular geometry, materials, and associated run
settings, the input files for OpenMC are structured in a set of XML_ files. XML,
which stands for eXtensible Markup Language, is a simple format that allows data
to be exchanged efficiently between different programs and interfaces.
Anyone who has ever seen webpages written in HTML will be familiar with the
structure of XML whereby "tags" enclosed in angle brackets denote that a
particular piece of data will follow. Let us examine the follow example::
<person>
<firstname>John</firstname>
<lastname>Smith</lastname>
<age>27</age>
<occupation>Health Physicist</occupation>
</person>
Here we see that the first tag indicates that the following data will describe a
person. The nested tags *firstname*, *lastname*, *age*, and *occupation*
indicate characteristics about the person being described.
In much the same way, OpenMC input uses XML tags to describe the geometry, the
materials, and settings for a Monte Carlo simulation.
.. _XML: http://www.w3.org/XML/
-----
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
file specifies physical quantities to be tallied. OpenMC expects that these
files are called:
* ``geometry.xml``
* ``materials.xml``
* ``setings.xml``
* ``tallies.xml``
--------------------------------------
Geometry Specification -- geometry.xml
--------------------------------------
Types of surfaces:
``x-plane``
A plane perpendicular to the x axis, i.e. a surface of the form :math:`x - x_0
= 0`. The coefficients specified are ":math:`x_0`".
``y-plane``
A plane perpendicular to the y axis, i.e. a surface of the form :math:`y - y_0
= 0`. The coefficients specified are ":math:`y_0`".
``z-plane``
A plane perpendicular to the z axis, i.e. a surface of the form :math:`z - z_0
= 0`. The coefficients specified are ":math:`z_0`".
``plane``
An arbitrary plane of the form :math:`Ax + By + Cz = D`. The coefficients
specified are ":math:`A \: B \: C \: D`".
``x-cylinder``
An infinite cylinder whose length is paralle to the x-axis. This is a
quadratic surface of the form :math:`(y - y_0)^2 + (z - z_0)^2 = R^2`. The
coefficients specified are ":math:`y_0 \: z_0 \: R`".
``y-cylinder``
An infinite cylinder whose length is paralle to the y-axis. This is a
quadratic surface of the form :math:`(x - x_0)^2 + (z - z_0)^2 = R^2`. The
coefficients specified are ":math:`x_0 \: z_0 \: R`".
``z-cylinder``
An infinite cylinder whose length is paralle to the z-axis. This is a
quadratic surface of the form :math:`(x - x_0)^2 + (y - y_0)^2 = R^2`. The
coefficients specified are ":math:`x_0 \: y_0 \: R`".
``sphere``
A sphere of the form :math:`(x - x_0)^2 + (y - y_0)^2 + (z - z_0)^2 =
R^2`. The coefficients specified are ":math:`x_0 \: y_0 \: z_0 \: R`".
----------------------------------------
Materials Specification -- materials.xml
----------------------------------------
--------------------------------------
Settings Specification -- settings.xml
--------------------------------------
------------------------------------
Tallies Specification -- tallies.xml
------------------------------------

View file

@ -23,7 +23,7 @@
<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="prev" title="Users Guide" href="usersguide/index.html" />
<link rel="prev" title="Creating XML Input Files" href="usersguide/input.html" />
</head>
<body>
<div class="related">
@ -33,7 +33,7 @@
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="usersguide/index.html" title="Users Guide"
<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> &raquo;</li>
</ul>
@ -65,8 +65,8 @@
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="usersguide/index.html"
title="previous chapter">User&#8217;s Guide</a></p>
<p class="topless"><a href="usersguide/input.html"
title="previous chapter">Creating XML Input Files</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/developers.txt"
@ -96,7 +96,7 @@
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="usersguide/index.html" title="Users Guide"
<a href="usersguide/input.html" title="Creating XML Input Files"
>previous</a> |</li>
<li><a href="index.html">OpenMC v0.3.1 documentation</a> &raquo;</li>
</ul>

View file

@ -64,7 +64,7 @@ your own risk.</p>
</div>
<div class="section" id="configuration">
<h2>Configuration<a class="headerlink" href="#configuration" title="Permalink to this headline"></a></h2>
<p>All configuration for OpenMC is done within the Makefile located
<p>All configuration for OpenMC is done within the Makefile located in
<tt class="docutils literal"><span class="pre">src/Makefile</span></tt>. In the Makefile, you will see that there are a number of User
Options which can be changed. It is recommended that you do not change anything
else in the Makefile unless you are experienced with compiling and building

View file

@ -53,6 +53,20 @@
<p>The OpenMC code solves the neutron transport equation using the Monte Carlo
method whereby particles are tracked as they randomly move through a geometry,
undergoing collisions, and creating secondary particles.</p>
<div class="section" id="reflective-surfaces">
<h2>Reflective Surfaces<a class="headerlink" href="#reflective-surfaces" title="Permalink to this headline"></a></h2>
<p>In general, a surface can be written in the form <img class="math" src="../_images/math/7a618bda1847d33ede0ff905641965782665226a.png" alt="f(x,y,z) = 0"/>. If a
neutron is traveling in direction <img class="math" src="../_images/math/0e25809cc8ec81373d3c46ff247a7c6d3a63dcaf.png" alt="\vec{v}"/> and crosses a reflective
surface of the above form, it can be shown that the velocity vector will then
become</p>
<div class="math">
<p><img src="../_images/math/ec1573ce905ac3e6758c191cd5c52441ed093cf8.png" alt="\mathbf{v'} = \mathbf{v} - 2 (\mathbf{v} \cdot \hat{\mathbf{n}})
\hat{\mathbf{n}}" /></p>
</div><p>where <img class="math" src="../_images/math/c784dcc2598753df9d694c4439b2320311b94dca.png" alt="\hat{\mathbf{n}}"/> is a unit vector normal to the surface at the
point of the surface crossing. The direction of the surface normal will be the
gradient to the surface at the point of crossing, i.e. <img class="math" src="../_images/math/c4301d4bf1894216758b926b70a378c73b059d9a.png" alt="\mathbf{n} =
\nabla f(x,y,z)"/>.</p>
</div>
</div>
@ -61,6 +75,14 @@ undergoing collisions, and creating secondary particles.</p>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="../index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Methodology</a><ul>
<li><a class="reference internal" href="#reflective-surfaces">Reflective Surfaces</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="../install.html"
title="previous chapter">Installation</a></p>

View file

@ -2,6 +2,5 @@
# Project: OpenMC
# Version: 0.3
# The remainder of this file is compressed using zlib.
xÚmŽÁ
Â0 †ï}Š€‚§)^= ²Ã@P šÐÒVNÜÛ»ÙŽYð~ù¿ü5ä­GzƒD<°¾“é¶<C3A9>ŽWPO³rÛ€R&3ÜýÄ×Ð|aà`åþ)xÕ¼ÈMÀž)W éîÑJb9}I<>³6¤z¡NLoJaáåïn#ßœ¦<C593>²^¢f.Í g¡NO
éEžãéÒYø¬qä#\I;õ߈€¹
xÚ}ŽÁªÂ0E÷ùŠ<C3B9>'¸ê·n•÷,*¸“h†40IJ'ý{Ó¦¥ÄeνçNes«€ƒZ¼"A±îÙo,ýÀ!öR£°*¯8opaœÂGfPöГ×Oa½ê³\«ŸÅ —J¯ZBØvHht¤‘Fª¶Œ ëÖ(ÌËÏÿvŠ|Îðß%Â8(78
Ûô”Áx÷víb\݆/7cš&&Z$gÝ`\sÎå.ÎwèϲPxGòu¬ç»?µIÄ¢ pDiÅ Ù⣸

View file

@ -1 +1 @@
Search.setIndex({objects:{},terms:{all:2,code:[0,1,2,3],forget:1,execut:2,move:3,focus:0,through:[4,3],aspect:4,follow:2,paul:[0,1],reactor:0,current:1,group:0,configur:2,makefil:2,should:2,fortran:2,mcnp:0,openmpi:2,els:2,risk:2,thei:3,format:0,mpi:2,gfortran:2,use_mpi:2,bryan:1,intel:2,anyth:2,massachusett:0,team:[0,1],debug:2,architectur:2,depend:2,compil:2,set:2,second:0,src:2,pass:2,led:1,carlo:[0,1,3],transport:[0,3],variabl:2,section:[0,2],content:0,kord:1,version:2,use_coarrai:2,paramet:2,method:3,whatev:2,machin:2,run:2,serpent:0,openmc:[0,1,2,3,4],romano:[0,1],free:0,base:0,prerequisit:2,advisor:1,solv:3,locat:2,sinc:2,both:2,thread:2,interprocedur:2,technolog:0,construct:0,simul:[0,4],mont:[0,1,3],tutori:4,equat:3,geometri:[0,3],implement:2,undergo:3,interact:0,softwar:2,own:2,feel:0,activ:1,within:[0,2],number:2,pgi:2,down:2,done:2,been:2,openmp:2,instal:[0,2],guid:[0,4],your:2,smith:1,from:2,coarrai:2,memori:2,support:2,messag:2,parallel:2,interfac:2,includ:1,recommend:2,tell:2,more:0,option:2,name:2,benoit:1,methodolog:[0,3],flag:2,known:2,gnu:2,solid:0,work:2,see:2,particl:[0,3],project:1,calcul:0,can:2,abov:2,root:2,randomli:3,featur:2,comput:0,creat:3,share:2,high:2,critic:0,have:2,further:2,need:2,surfac:0,develop:[0,1],welcom:4,perform:4,make:2,gprof:2,when:2,cross:0,also:[0,2],valid:2,collis:3,build:2,which:2,test:2,you:[4,2],neutron:[0,3,4],enabl:2,mpich2:2,unless:2,distribut:2,optim:2,choos:2,capabl:0,track:3,user:[0,2,4],mai:2,secondari:3,data:0,chang:2,physic:0,experienc:2,essenti:4,older:2,directori:2,wherebi:3,well:2,order:[0,2],inform:0,contact:0,command:2,herman:1,thi:[4,2],institut:0,model:0,profil:2,began:0,latest:2},objtypes:{},titles:["The OpenMC Monte Carlo Code","Development Team","Installation","Methodology","User&#8217;s Guide"],objnames:{},filenames:["index","developers","install","methods/index","usersguide/index"]})
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&#8217;s Guide","Development Team"],objnames:{},filenames:["index","install","usersguide/input","methods/index","usersguide/index","developers"]})

View file

@ -23,7 +23,7 @@
<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="next" title="Development Team" href="../developers.html" />
<link rel="next" title="Creating XML Input Files" href="input.html" />
<link rel="prev" title="Methodology" href="../methods/index.html" />
</head>
<body>
@ -34,7 +34,7 @@
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../developers.html" title="Development Team"
<a href="input.html" title="Creating XML Input Files"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="../methods/index.html" title="Methodology"
@ -53,7 +53,8 @@
<p>Welcome to the OpenMC User&#8217;s Guide! This tutorial will guide you through the
essential aspects of using OpenMC to perform neutronic simulations.</p>
<div class="toctree-wrapper compound">
<ul class="simple">
<ul>
<li class="toctree-l1"><a class="reference internal" href="input.html">Creating XML Input Files</a></li>
</ul>
</div>
</div>
@ -68,8 +69,8 @@ essential aspects of using OpenMC to perform neutronic simulations.</p>
<p class="topless"><a href="../methods/index.html"
title="previous chapter">Methodology</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="../developers.html"
title="next chapter">Development Team</a></p>
<p class="topless"><a href="input.html"
title="next chapter">Creating XML Input Files</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/usersguide/index.txt"
@ -99,7 +100,7 @@ essential aspects of using OpenMC to perform neutronic simulations.</p>
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../developers.html" title="Development Team"
<a href="input.html" title="Creating XML Input Files"
>next</a> |</li>
<li class="right" >
<a href="../methods/index.html" title="Methodology"

199
usersguide/input.html Normal file
View file

@ -0,0 +1,199 @@
<!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>Creating XML Input Files &mdash; OpenMC v0.3.1 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',
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>
<link rel="top" title="OpenMC v0.3.1 documentation" href="../index.html" />
<link rel="up" title="Users Guide" href="index.html" />
<link rel="next" title="Development Team" href="../developers.html" />
<link rel="prev" title="Users Guide" href="index.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../developers.html" title="Development Team"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="index.html" title="Users Guide"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">OpenMC v0.3.1 documentation</a> &raquo;</li>
<li><a href="index.html" accesskey="U">User&#8217;s Guide</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="creating-xml-input-files">
<span id="usersguide-input"></span><h1>Creating XML Input Files<a class="headerlink" href="#creating-xml-input-files" title="Permalink to this headline"></a></h1>
<p>Unlike many other Monte Carlo codes which use an arbitrary-format ASCII file
with &#8220;cards&#8221; to specify a particular geometry, materials, and associated run
settings, the input files for OpenMC are structured in a set of <a class="reference external" href="http://www.w3.org/XML/">XML</a> files. XML,
which stands for eXtensible Markup Language, is a simple format that allows data
to be exchanged efficiently between different programs and interfaces.</p>
<p>Anyone who has ever seen webpages written in HTML will be familiar with the
structure of XML whereby &#8220;tags&#8221; enclosed in angle brackets denote that a
particular piece of data will follow. Let us examine the follow example:</p>
<div class="highlight-python"><pre>&lt;person&gt;
&lt;firstname&gt;John&lt;/firstname&gt;
&lt;lastname&gt;Smith&lt;/lastname&gt;
&lt;age&gt;27&lt;/age&gt;
&lt;occupation&gt;Health Physicist&lt;/occupation&gt;
&lt;/person&gt;</pre>
</div>
<p>Here we see that the first tag indicates that the following data will describe a
person. The nested tags <em>firstname</em>, <em>lastname</em>, <em>age</em>, and <em>occupation</em>
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>
<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
file specifies physical quantities to be tallied. OpenMC expects that these
files are called:</p>
<ul class="simple">
<li><tt class="docutils literal"><span class="pre">geometry.xml</span></tt></li>
<li><tt class="docutils literal"><span class="pre">materials.xml</span></tt></li>
<li><tt class="docutils literal"><span class="pre">setings.xml</span></tt></li>
<li><tt class="docutils literal"><span class="pre">tallies.xml</span></tt></li>
</ul>
</div>
<div class="section" id="geometry-specification-geometry-xml">
<h2>Geometry Specification &#8211; geometry.xml<a class="headerlink" href="#geometry-specification-geometry-xml" title="Permalink to this headline"></a></h2>
<p>Types of surfaces:</p>
<dl class="docutils">
<dt><tt class="docutils literal"><span class="pre">x-plane</span></tt></dt>
<dd>A plane perpendicular to the x axis, i.e. a surface of the form <img class="math" src="../_images/math/c97be2c5d5ea73f3537be247c4cbb9d842dd0567.png" alt="x - x_0
= 0"/>. The coefficients specified are &#8220;<img class="math" src="../_images/math/17f1249ad95b7682b8316ad21de8ce4ee9fdcf93.png" alt="x_0"/>&#8221;.</dd>
<dt><tt class="docutils literal"><span class="pre">y-plane</span></tt></dt>
<dd>A plane perpendicular to the y axis, i.e. a surface of the form <img class="math" src="../_images/math/ce995bc4e617a85ac28c2d3c238d362a1f38bb34.png" alt="y - y_0
= 0"/>. The coefficients specified are &#8220;<img class="math" src="../_images/math/721e40b7e0ac4359611aebe48cfb63122a347798.png" alt="y_0"/>&#8221;.</dd>
<dt><tt class="docutils literal"><span class="pre">z-plane</span></tt></dt>
<dd>A plane perpendicular to the z axis, i.e. a surface of the form <img class="math" src="../_images/math/309c87ef1ad84c2412670454fac9aea8f52c0481.png" alt="z - z_0
= 0"/>. The coefficients specified are &#8220;<img class="math" src="../_images/math/bab9abe98679312d2a3308c76188cf2cbc492f68.png" alt="z_0"/>&#8221;.</dd>
<dt><tt class="docutils literal"><span class="pre">plane</span></tt></dt>
<dd>An arbitrary plane of the form <img class="math" src="../_images/math/eb8661ea00d3e9e10ef23de03755960eec4b554f.png" alt="Ax + By + Cz = D"/>. The coefficients
specified are &#8220;<img class="math" src="../_images/math/5d687cb5bc98aa30d5460e4d0f34feaa8ec52008.png" alt="A \: B \: C \: D"/>&#8221;.</dd>
<dt><tt class="docutils literal"><span class="pre">x-cylinder</span></tt></dt>
<dd>An infinite cylinder whose length is paralle to the x-axis. This is a
quadratic surface of the form <img class="math" src="../_images/math/c70e001674ec3ce487852ca76aab6d872c634cbf.png" alt="(y - y_0)^2 + (z - z_0)^2 = R^2"/>. The
coefficients specified are &#8220;<img class="math" src="../_images/math/8f0dd3d5d7c73c87564b7aa9d05b3b933a107e6c.png" alt="y_0 \: z_0 \: R"/>&#8221;.</dd>
<dt><tt class="docutils literal"><span class="pre">y-cylinder</span></tt></dt>
<dd>An infinite cylinder whose length is paralle to the y-axis. This is a
quadratic surface of the form <img class="math" src="../_images/math/883b49d218bf8cf809fae9decb62b4231ecf964f.png" alt="(x - x_0)^2 + (z - z_0)^2 = R^2"/>. The
coefficients specified are &#8220;<img class="math" src="../_images/math/c495d88c348c2f010641c13f26fdd9d841973a6b.png" alt="x_0 \: z_0 \: R"/>&#8221;.</dd>
<dt><tt class="docutils literal"><span class="pre">z-cylinder</span></tt></dt>
<dd>An infinite cylinder whose length is paralle to the z-axis. This is a
quadratic surface of the form <img class="math" src="../_images/math/9486fcc643d149a10bc21b05ac1e123031f400da.png" alt="(x - x_0)^2 + (y - y_0)^2 = R^2"/>. The
coefficients specified are &#8220;<img class="math" src="../_images/math/d9efe2f18fee6e45486f86bf704b28646bcc2867.png" alt="x_0 \: y_0 \: R"/>&#8221;.</dd>
<dt><tt class="docutils literal"><span class="pre">sphere</span></tt></dt>
<dd>A sphere of the form <img class="math" src="../_images/math/62a745995df775198e16354b6b1ed9887e88c8a2.png" alt="(x - x_0)^2 + (y - y_0)^2 + (z - z_0)^2 =
R^2"/>. The coefficients specified are &#8220;<img class="math" src="../_images/math/e13d971231512283e81d8480a218782f7d68b585.png" alt="x_0 \: y_0 \: z_0 \: R"/>&#8221;.</dd>
</dl>
</div>
<div class="section" id="materials-specification-materials-xml">
<h2>Materials Specification &#8211; materials.xml<a class="headerlink" href="#materials-specification-materials-xml" title="Permalink to this headline"></a></h2>
</div>
<div class="section" id="settings-specification-settings-xml">
<h2>Settings Specification &#8211; settings.xml<a class="headerlink" href="#settings-specification-settings-xml" title="Permalink to this headline"></a></h2>
</div>
<div class="section" id="tallies-specification-tallies-xml">
<h2>Tallies Specification &#8211; tallies.xml<a class="headerlink" href="#tallies-specification-tallies-xml" title="Permalink to this headline"></a></h2>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<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="#geometry-specification-geometry-xml">Geometry Specification &#8211; geometry.xml</a></li>
<li><a class="reference internal" href="#materials-specification-materials-xml">Materials Specification &#8211; materials.xml</a></li>
<li><a class="reference internal" href="#settings-specification-settings-xml">Settings Specification &#8211; settings.xml</a></li>
<li><a class="reference internal" href="#tallies-specification-tallies-xml">Tallies Specification &#8211; tallies.xml</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="index.html"
title="previous chapter">User&#8217;s Guide</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="../developers.html"
title="next chapter">Development Team</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/usersguide/input.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../developers.html" title="Development Team"
>next</a> |</li>
<li class="right" >
<a href="index.html" title="Users Guide"
>previous</a> |</li>
<li><a href="../index.html">OpenMC v0.3.1 documentation</a> &raquo;</li>
<li><a href="index.html" >User&#8217;s Guide</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2011, Massachusetts Institute of Technology.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
</div>
</body>
</html>