crp/OpenMC
1
0
Fork 0
mirror of https://github.com/openmc-dev/openmc.git synced 2026-07-26 21:25:36 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated documentation.

Browse source
This commit is contained in:
Paul Romano 2011-10-06 14:40:58 -04:00
parent 92b8019351
commit 80db0514ce
4 changed files with 77 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/source/conf.py
View file

@ -48,7 +48,7 @@ copyright = u'2011, Massachusetts Institute of Technology'
# The short X.Y version.
version = "0.3"
# The full version, including alpha/beta/rc tags.
release = "0.3.1"
release = "0.3.2"
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.

25
docs/source/install.rst
View file

@ -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``.

2
docs/source/usersguide/index.rst
View file

@ -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

58
docs/source/usersguide/input.rst
View file

@ -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``