mirror of
https://github.com/openmc-dev/openmc.git
synced 2026-07-25 12:35:29 -04:00
Updated documentation.
This commit is contained in:
Paul Romano
parent
c3b91a3cbf
commit
8fc482a2a4
2 changed files with 84 additions and 24 deletions
|
|
@ -4,6 +4,24 @@
|
|||
Installation
|
||||
============
|
||||
|
||||
--------------------
|
||||
Obtaining the Source
|
||||
--------------------
|
||||
|
||||
All OpenMC source code is hosted on GitHub_. This means that you will need to
|
||||
have git_ installed on your computer in order to get source code and updates
|
||||
directly from the repository. GitHub has a good set of `instructions
|
||||
<http://help.github.com/set-up-git-redirect>`_ for how to set up git to work
|
||||
with GitHub since this involves setting up ssh_ keys. With git installed and
|
||||
setup, the following command will download the full source code from the GitHub
|
||||
repository::
|
||||
|
||||
git clone git@github.com:mit-crpg/openmc.git
|
||||
|
||||
.. _GitHub: http://github.com
|
||||
.. _git: http://git-scm.com
|
||||
.. _ssh: http://en.wikipedia.org/wiki/Secure_Shell
|
||||
|
||||
-------------
|
||||
Prerequisites
|
||||
-------------
|
||||
|
|
@ -18,11 +36,6 @@ 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
|
||||
|
|
@ -33,9 +46,14 @@ with::
|
|||
sudo apt-get install mpich2
|
||||
sudo apt-get install openmpi-bin
|
||||
|
||||
To compile with support for HDF5_ output (highly recommended), you will need to
|
||||
have HDF5 installed on your computer. The installed version will need to have
|
||||
been compiled with the same compiler you intend to compile OpenMC with.
|
||||
|
||||
.. _gfortran: http://gcc.gnu.org/wiki/GFortran
|
||||
.. _OpenMPI: http://www.open-mpi.org
|
||||
.. _MPICH2: http://www.mcs.anl.gov/mpi/mpich/
|
||||
.. _HDF5: http://www.hdfgroup.org/HDF5/
|
||||
|
||||
-------------
|
||||
Configuration
|
||||
|
|
@ -65,18 +83,18 @@ OPTIMIZE
|
|||
interprocedural optimization.
|
||||
|
||||
USE_MPI
|
||||
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.
|
||||
Enables parallel runs using the Message Passing Interface. Users should also
|
||||
set the MPI_ROOT directory further down in the Makefile.
|
||||
|
||||
USE_OPENMP
|
||||
Enables parallel runs on shared-memory architecture using OpenMP threading.
|
||||
USE_HDF5
|
||||
Enables HDF5 output in addition to normal screen and text file output. Users
|
||||
should also set the HDF5_ROOT directory further down in the Makefile.
|
||||
|
||||
USE_COARRAY
|
||||
Enables parallel runs using Fortran 2008 coarrays.
|
||||
It is also possible to change these options from the command line itself. For
|
||||
example, if you want to compile with DEBUG turned on without actually change the
|
||||
Makefile, you can enter the following from a terminal::
|
||||
|
||||
.. note:: OpenMC does not yet support parallelism using OpenMP or Fortran 2008
|
||||
coarrays.
|
||||
make DEBUG=yes
|
||||
|
||||
---------
|
||||
Compiling
|
||||
|
|
|
|||
|
|
@ -117,9 +117,10 @@ Each ``surface`` element can have the following attributes or sub-elements:
|
|||
*Default*: None
|
||||
|
||||
:boundary:
|
||||
The boundary condition for the surface. This can be ``vacuum`` or ``reflective``.
|
||||
The boundary condition for the surface. This can be ``transmission``,
|
||||
``vacuum``, or ``reflective``.
|
||||
|
||||
*Default*: ``reflective``
|
||||
*Default*: ``transmission``
|
||||
|
||||
The following quadratic surfaces can be modeled:
|
||||
|
||||
|
|
@ -205,9 +206,8 @@ universe. A ``lattice`` accepts the following attributes or sub-elements:
|
|||
:id:
|
||||
A unique integer that can be used to identify the surface.
|
||||
|
||||
:type:
|
||||
A string indicating the arrangement of lattice cells. Accepted options are
|
||||
"rectangular" and "hexagonal".
|
||||
:type: A string indicating the arrangement of lattice cells. Currently, the
|
||||
only accepted option is "rectangular".
|
||||
|
||||
*Default*: rectangular
|
||||
|
||||
|
|
@ -266,8 +266,8 @@ Each ``material`` element can have the following attributes or sub-elements:
|
|||
weight percent of that nuclide within the material, respectively. One
|
||||
example would be as follows::
|
||||
|
||||
<nuclide name="H-1" xs="03c" ao="2.0" />
|
||||
<nuclide name="O-16" xs="03c" ao="1.0" />
|
||||
<nuclide name="H-1" xs="70c" ao="2.0" />
|
||||
<nuclide name="O-16" xs="70c" ao="1.0" />
|
||||
|
||||
.. note:: If one nuclide is specified in atom percent, all others must also
|
||||
be given in atom percent. The same applies for weight percentages.
|
||||
|
|
@ -342,6 +342,27 @@ below which particles undergo Russian roulette.
|
|||
|
||||
*Default*: 0.25
|
||||
|
||||
``entropy_box`` Element
|
||||
-----------------------
|
||||
|
||||
This element describes the lower-left and upper-right corners of a box to be
|
||||
used for calculting Shannon entropy. This box should cover all possible
|
||||
fissionable materials in the problem. The values given after this element should
|
||||
be six numbers, the first of which are the Cartesian coordinates of the
|
||||
lower-left corner of the box and the last three of which are the Cartesian
|
||||
coordinates of the upper-right corner of the box.
|
||||
|
||||
*Default*: None
|
||||
|
||||
``ptables`` Element
|
||||
-------------------
|
||||
|
||||
The ``ptables`` element determines whether probability tables should be used in
|
||||
the unresolved resonance range if available. This element has no attributes or
|
||||
sub-elements and can be set to either "off" or "on".
|
||||
|
||||
*Default*: on
|
||||
|
||||
``source`` Element
|
||||
------------------
|
||||
|
||||
|
|
@ -367,6 +388,15 @@ survival biasing, otherwise known as implicit capture or absorption.
|
|||
|
||||
*Default*: off
|
||||
|
||||
``trace`` Element
|
||||
-----------------
|
||||
|
||||
The ``trace`` element can be used to print out detailed information about a
|
||||
single particle during a simulation. This element should be followed by two
|
||||
integers, the cycle and one for the particle number.
|
||||
|
||||
*Default*: None
|
||||
|
||||
``verbosity`` Element
|
||||
---------------------
|
||||
|
||||
|
|
@ -503,6 +533,20 @@ attributes/sub-elements:
|
|||
:width:
|
||||
The width of mesh cells in each direction.
|
||||
|
||||
``assume_separate`` Element
|
||||
---------------------------
|
||||
|
||||
In cases where the user needs to specify many different tallies each of which
|
||||
are spatially separate, this tag can be used to cut down on some of the tally
|
||||
overhead. The effect of assuming all tallies are spatially separate is that once
|
||||
one tally is scored to, the same event is assumed not to score to any other
|
||||
tallies. This element should be followed by "yes" or "no"
|
||||
|
||||
.. warning:: If used incorrectly, the assumption that all tallies are spatially
|
||||
separate can lead to incorrect results.
|
||||
|
||||
*Default*: no
|
||||
|
||||
-------------------------------------------
|
||||
Geometry Plotting Specification -- plot.xml
|
||||
-------------------------------------------
|
||||
|
|
@ -532,9 +576,7 @@ the plot in each of the basis directions.
|
|||
-----------------
|
||||
|
||||
The ``basis`` element has no attributes/sub-elements and indicates the specified
|
||||
basis for plotting.
|
||||
|
||||
.. note:: The only accepted option currently is "xy"
|
||||
basis for plotting. The only option option currently accepted is "xy".
|
||||
|
||||
*Default*: xy
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue