From 806a8a0c9a1d7bf9639e60846a3e8ba316ba1793 Mon Sep 17 00:00:00 2001 From: Sterling Harper Date: Mon, 25 Apr 2016 19:03:31 -0400 Subject: [PATCH] Move all I/O file formats to special docs section --- docs/source/index.rst | 1 + docs/source/io_formats/data_wmp.rst | 92 +++++++++++++++++++ .../output => io_formats}/index.rst | 10 +- .../mgxs_library.rst | 2 +- .../particle_restart.rst | 2 +- .../output => io_formats}/source.rst | 2 +- .../output => io_formats}/statepoint.rst | 2 +- .../output => io_formats}/summary.rst | 2 +- .../output => io_formats}/track.rst | 2 +- .../output => io_formats}/voxel.rst | 2 +- docs/source/methods/cross_sections.rst | 3 + docs/source/usersguide/index.rst | 2 - docs/source/usersguide/input.rst | 2 +- docs/source/usersguide/processing.rst | 4 +- 14 files changed, 112 insertions(+), 16 deletions(-) create mode 100644 docs/source/io_formats/data_wmp.rst rename docs/source/{usersguide/output => io_formats}/index.rst (55%) rename docs/source/{usersguide => io_formats}/mgxs_library.rst (99%) rename docs/source/{usersguide/output => io_formats}/particle_restart.rst (97%) rename docs/source/{usersguide/output => io_formats}/source.rst (96%) rename docs/source/{usersguide/output => io_formats}/statepoint.rst (99%) rename docs/source/{usersguide/output => io_formats}/summary.rst (99%) rename docs/source/{usersguide/output => io_formats}/track.rst (96%) rename docs/source/{usersguide/output => io_formats}/voxel.rst (95%) diff --git a/docs/source/index.rst b/docs/source/index.rst index 54ba825e58..605f3c9777 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -34,6 +34,7 @@ free to send a message to the User's Group `mailing list`_. usersguide/index devguide/index pythonapi/index + io_formats/index publications license developers diff --git a/docs/source/io_formats/data_wmp.rst b/docs/source/io_formats/data_wmp.rst new file mode 100644 index 0000000000..1e791d6c59 --- /dev/null +++ b/docs/source/io_formats/data_wmp.rst @@ -0,0 +1,92 @@ +.. _io_data_wmp: + +========================================== +The Windowed Multipole Library Format v0.2 +========================================== + +**/nuclide/** + - **broaden_poly** (*int[]*) + If 1, Doppler broaden curve fit for window with corresponding index. + If 0, do not. + - **curvefit** (*double[][][]*) + Curve fit coefficients. Indexed by (reaction type, coefficient index, + window index). + - **data** (*complex[][]*) + Complex poles and residues. Each pole has a corresponding set of + residues. For example, the `i`th pole and corresponding residues are + stored as `data[:,i] = [pole, residue_1, residue_2, ...]`. The + residues are in the order: total, competitive if present, absorption, + fission. Complex numbers are stored by forming a type with `"r"` and + `"i"` identifiers, similar to how `h5py` does it. + - **start_E** (*double*) + Lowest energy the windowed multipole part of the library is valid for. + - **end_E** (*double*) + Highest energy the windowed multipole part of the library is valid for. + - **energy_points** (*double[]*) + Energy grid for the pointwise library in the reaction group. + - **fissionable** (*int*) + 1 if this nuclide has fission data. 0 if it does not. + - **fit_order** (*int*) + The order of the curve fit. + - **formalism** (*int*) + The formalism of the underlying data. Uses the `ENDF-6`_ format + formalism numbers. + + .. table:: Table of supported formalisms. + + +-------------+------------------+ + | Formalism | Formalism number | + +=============+==================+ + | MLBW | 2 | + +-------------+------------------+ + | Reich-Moore | 3 | + +-------------+------------------+ + + - **l_value** (*int[]*) + The index for a corresponding pole. Equivalent to the :math:`l` quantum + number of the resonance the pole comes from :math:`+1`. + - **length** (*int*) + Total count of poles in `data`. + - **max_w** (*int*) + Maximum number of poles in a window. + - **MT_count** (*int*) + Number of pointwise tables in the library. + - **MT_list** (*int[]*) + A list of available MT identifiers. See `ENDF-6`_ for meaning. + - **n_grid** (*int*) + Total length of the pointwise data. + - **num_l** (*int*) + Number of possible :math:`l` quantum states for this nuclide. + - **pseudo_K0RS** (*double[]*) + :math:`l` dependent value of + + .. math:: + \sqrt{\frac{2 m_n}{\hbar}}\frac{AWR}{AWR + 1} r_{s,l} + + Where :math:`m_n` is mass of neutron, :math:`AWR` is the atomic weight + ratio of the target to the neutron, and :math:`r_{s,l}` is the + scattering radius for a given :math:`l`. + - **spacing** (*double*) + .. math:: + \frac{\sqrt{E_{max}}- \sqrt{E_{min}}}{n_w} + + Where :math:`E_{max}` is the maximum energy the windows go up to. This + is not equivalent to the maximum energy for which the windowed multipole + data is valid for. It is slightly higher to ensure an integer number of + windows. :math:`E_{min}` is the minimum energy and equivalent to + `start_E`, and :math:`n_w` is the number of windows, given by `windows`. + - **sqrtAWR** (*double*) + Square root of the atomic weight ratio. + - **w_start** (*int[]*) + The pole to start from for each window. + - **w_end** (*int[]*) + The pole to end at for each window. + - **windows** (*int*) + Number of windows. + +**/nuclide/reactions/MT** + - **MT_sigma** (*double[]*) -- Cross section value for this reaction. + - **Q_value** (*double*) -- Energy released in this reaction, in eV. + - **threshold** (*int*) -- The first non-zero entry in `MT_sigma`. + +.. _ENDF-6: https://www.oecd-nea.org/dbdata/data/manual-endf/endf102.pdf diff --git a/docs/source/usersguide/output/index.rst b/docs/source/io_formats/index.rst similarity index 55% rename from docs/source/usersguide/output/index.rst rename to docs/source/io_formats/index.rst index 31bd1da917..33c43df081 100644 --- a/docs/source/usersguide/output/index.rst +++ b/docs/source/io_formats/index.rst @@ -1,13 +1,15 @@ -.. _usersguide_output: +.. _io_file_formats: -=================== -Output File Formats -=================== +=============== +IO File Formats +=============== .. toctree:: :numbered: :maxdepth: 3 + data_wmp + mgxs_library statepoint source summary diff --git a/docs/source/usersguide/mgxs_library.rst b/docs/source/io_formats/mgxs_library.rst similarity index 99% rename from docs/source/usersguide/mgxs_library.rst rename to docs/source/io_formats/mgxs_library.rst index a5d2ec0d06..e6284e3287 100644 --- a/docs/source/usersguide/mgxs_library.rst +++ b/docs/source/io_formats/mgxs_library.rst @@ -1,4 +1,4 @@ -.. _usersguide_mgxs_library: +.. _io_mgxs_library: ======================================== Multi-Group Cross Section Library Format diff --git a/docs/source/usersguide/output/particle_restart.rst b/docs/source/io_formats/particle_restart.rst similarity index 97% rename from docs/source/usersguide/output/particle_restart.rst rename to docs/source/io_formats/particle_restart.rst index 70f00a930f..c30eda3189 100644 --- a/docs/source/usersguide/output/particle_restart.rst +++ b/docs/source/io_formats/particle_restart.rst @@ -1,4 +1,4 @@ -.. _usersguide_particle_restart: +.. _io_particle_restart: ============================ Particle Restart File Format diff --git a/docs/source/usersguide/output/source.rst b/docs/source/io_formats/source.rst similarity index 96% rename from docs/source/usersguide/output/source.rst rename to docs/source/io_formats/source.rst index 53841a5ebc..a0a62afca0 100644 --- a/docs/source/usersguide/output/source.rst +++ b/docs/source/io_formats/source.rst @@ -1,4 +1,4 @@ -.. _usersguide_source: +.. _io_source: ================== Source File Format diff --git a/docs/source/usersguide/output/statepoint.rst b/docs/source/io_formats/statepoint.rst similarity index 99% rename from docs/source/usersguide/output/statepoint.rst rename to docs/source/io_formats/statepoint.rst index 95a3d842c2..e8b8f8b90b 100644 --- a/docs/source/usersguide/output/statepoint.rst +++ b/docs/source/io_formats/statepoint.rst @@ -1,4 +1,4 @@ -.. _usersguide_statepoint: +.. _io_statepoint: ======================= State Point File Format diff --git a/docs/source/usersguide/output/summary.rst b/docs/source/io_formats/summary.rst similarity index 99% rename from docs/source/usersguide/output/summary.rst rename to docs/source/io_formats/summary.rst index cb9f725e86..8af4f2398a 100644 --- a/docs/source/usersguide/output/summary.rst +++ b/docs/source/io_formats/summary.rst @@ -1,4 +1,4 @@ -.. _usersguide_summary: +.. _io_summary: =================== Summary File Format diff --git a/docs/source/usersguide/output/track.rst b/docs/source/io_formats/track.rst similarity index 96% rename from docs/source/usersguide/output/track.rst rename to docs/source/io_formats/track.rst index d3c7a27d83..e5cb5d46e3 100644 --- a/docs/source/usersguide/output/track.rst +++ b/docs/source/io_formats/track.rst @@ -1,4 +1,4 @@ -.. _usersguide_track: +.. _io_track: ================= Track File Format diff --git a/docs/source/usersguide/output/voxel.rst b/docs/source/io_formats/voxel.rst similarity index 95% rename from docs/source/usersguide/output/voxel.rst rename to docs/source/io_formats/voxel.rst index 1da501fb54..6b73f2800a 100644 --- a/docs/source/usersguide/output/voxel.rst +++ b/docs/source/io_formats/voxel.rst @@ -1,4 +1,4 @@ -.. _usersguide_voxel: +.. _io_voxel: ====================== Voxel Plot File Format diff --git a/docs/source/methods/cross_sections.rst b/docs/source/methods/cross_sections.rst index 50a97d5754..ec8f8fe451 100644 --- a/docs/source/methods/cross_sections.rst +++ b/docs/source/methods/cross_sections.rst @@ -136,6 +136,9 @@ Note that the implementation of WMP in OpenMC currently assumes that inelastic scattering does not occur in the resolved resonance region. This is usually, but not always the case. Future library versions may eliminate this issue. +The data format used by OpenMC to represent windowed multipole data is specified +in :ref:`io_data_wmp` + .. only:: html .. rubric:: References diff --git a/docs/source/usersguide/index.rst b/docs/source/usersguide/index.rst index 0338c5cef0..f8b4e64faa 100644 --- a/docs/source/usersguide/index.rst +++ b/docs/source/usersguide/index.rst @@ -14,7 +14,5 @@ essential aspects of using OpenMC to perform simulations. beginners install input - mgxs_library - output/index processing troubleshoot diff --git a/docs/source/usersguide/input.rst b/docs/source/usersguide/input.rst index 324fbfc2db..24a8ac3e7c 100644 --- a/docs/source/usersguide/input.rst +++ b/docs/source/usersguide/input.rst @@ -1941,7 +1941,7 @@ sub-elements: datafiles can be processed into 3D SILO files using the ``openmc-voxel-to-silovtk`` utility provided with the OpenMC source, and subsequently viewed with a 3D viewer such as VISIT or Paraview. See the - :ref:`usersguide_voxel` for information about the datafile structure. + :ref:`io_voxel` for information about the datafile structure. .. note:: Since the PPM format is saved without any kind of compression, the resulting file sizes can be quite large. Saving the image in diff --git a/docs/source/usersguide/processing.rst b/docs/source/usersguide/processing.rst index 059659dbc1..93a17a7b8b 100644 --- a/docs/source/usersguide/processing.rst +++ b/docs/source/usersguide/processing.rst @@ -161,7 +161,7 @@ or * `VTK `_ with python bindings. On debian derivatives, these are easily obtained with ``sudo apt-get install python-vtk`` -For the HDF5 file structure, see :ref:`usersguide_voxel`. +For the HDF5 file structure, see :ref:`io_voxel`. Once processed into a standard 3D file format, colors and masks can be defined using the stored id numbers to better explore the geometry. The process for @@ -195,7 +195,7 @@ Data Extraction --------------- A great deal of information is available in statepoint files (See -:ref:`usersguide_statepoint`), all of which is accessible through the Python +:ref:`io_statepoint`), all of which is accessible through the Python API. The :class:`openmc.StatePoint` class can load statepoints and access data as requested; it is used in many of the provided plotting utilities, OpenMC's regression test suite, and can be used in user-created scripts to carry out