diff --git a/docs/source/conf.py b/docs/source/conf.py index 18f93b66fc..fe7a0203a4 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -23,7 +23,7 @@ sys.path.insert(0, os.path.abspath('../sphinxext')) # Add any Sphinx extension module names here, as strings. They can be extensions # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions = ['sphinx.ext.pngmath', 'sphinxcontrib.tikz'] +extensions = ['sphinx.ext.pngmath', 'sphinxcontrib.tikz', 'sphinx.ext.numfig'] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -37,8 +37,10 @@ source_suffix = '.rst' # The master toctree document. if tags.has('latex'): master_doc = 'index_tex' + exclude_patterns = ['index.rst'] else: master_doc = 'index' + exclude_patterns = ['index_tex.rst'] # General information about the project. project = u'OpenMC' diff --git a/docs/source/methods/cmfd.rst b/docs/source/methods/cmfd.rst index 098f0de204..3077168b60 100644 --- a/docs/source/methods/cmfd.rst +++ b/docs/source/methods/cmfd.rst @@ -439,7 +439,7 @@ by the user. Once all diffusion parameters are calculated, CMFD matrices are formed where energy groups are the inner most iteration index. In OpenMC, compressed row storage sparse matrices are used due to the sparsity of CMFD operators. An example of this sparsity is shown for the 3-D BEAVRS model in -figures :ref:`fig_loss` and :ref:`fig_prod` [BEAVRS]_. These matrices represent +figures :num:`fig-loss` and :num:`fig-prod` [BEAVRS]_. These matrices represent an assembly radial mesh, 24 cell mesh in the axial direction and two energy groups. The loss matrix is 99.92% sparse and the production matrix is 99.99% sparse. Although the loss matrix looks like it is tridiagonal, it is really a @@ -473,14 +473,14 @@ no fission neutrons appear with energies in the thermal group. | \ :math:`\left\langle\overline{J}^{u,g}_{l\pm 1/2,m,n}\Delta_m^v\Delta_n^w\right\rangle` | current | mesh, energy | +--------------------------------------------------------------------------------------------+----------------+---------------------------+ -.. _fig_loss: +.. _fig-loss: .. figure:: ../_images/loss.png :scale: 50 Sparsity of Neutron Loss Operator -.. _fig_prod: +.. _fig-prod: .. figure:: ../_images/prod.png :scale: 50 diff --git a/docs/source/methods/geometry.rst b/docs/source/methods/geometry.rst index 8dda10e013..9eece1e919 100644 --- a/docs/source/methods/geometry.rst +++ b/docs/source/methods/geometry.rst @@ -42,9 +42,11 @@ One can confirm that any point inside this sphere will correspond to In OpenMC, every surface defined by the user is assigned an integer to uniquely identify it. We can then refer to either of the two half-spaces created by a surface by a combination of the unique ID of the surface and a positive/negative -sign. The following illustration shows an example of an ellipse with unique ID 1 +sign. Figure :num:`fig-halfspace` shows an example of an ellipse with unique ID 1 dividing space into two half-spaces. +.. _fig-halfspace: + .. figure:: ../_images/halfspace.* :align: center :figclass: align-center @@ -57,9 +59,11 @@ to be defined by intersections, unions, and differences or half-spaces, OpenMC is currently limited to cells defined only as intersections of half-spaces. Thus, the specification of the cell must include a list of half-space references whose intersection defines the region. The region is then -assigned a material defined elsewhere. The following illustration shows an +assigned a material defined elsewhere. Figure :num:`fig-union` shows an example of a cell defined as the intersection of an ellipse and two planes. - + +.. _fig-union: + .. figure:: ../_images/union.* :align: center :figclass: align-center @@ -399,10 +403,12 @@ Rectilinear Lattice Indexing ---------------------------- Indices are assigned to tiles in a rectilinear lattice based on the tile's -position along the :math:`x`, :math:`y`, and :math:`z` axes. The figure below -maps the indices for a 2D lattice. The indices, (1, 1), map to the -lower-left tile. (5, 1) and (5, 5) map to the lower-right and upper-right -tiles, respectively. +position along the :math:`x`, :math:`y`, and :math:`z` axes. Figure +:num:`fig-rect-lat` maps the indices for a 2D lattice. The indices, (1, 1), +map to the lower-left tile. (5, 1) and (5, 5) map to the lower-right and +upper-right tiles, respectively. + +.. _fig-rect-lat: .. figure:: ../_images/rect_lat.* :align: center @@ -431,12 +437,15 @@ corner of the lattice, and :math:`p_0, p_1, p_2` are the pitches along the Hexagonal Lattice Indexing -------------------------- -A skewed coordinate system is used for indexing hexagonal lattice tiles. Rather -than a :math:`y`-axis, another axis is used that is rotated 30 degrees +A skewed coordinate system is used for indexing hexagonal lattice tiles. +Rather than a :math:`y`-axis, another axis is used that is rotated 30 degrees counter-clockwise from the :math:`y`-axis. This axis is referred to as the -:math:`\alpha`-axis. The figure below shows how 2D hexagonal tiles are mapped -with the :math:`(x, \alpha)` basis. In this system, (0, 0) maps to the center -tile, (0, 2) to the top tile, and (2, -1) to the middle tile on the right side. +:math:`\alpha`-axis. Figure :num:`fig-hex-lat` shows how 2D hexagonal tiles +are mapped with the :math:`(x, \alpha)` basis. In this system, (0, 0) maps to +the center tile, (0, 2) to the top tile, and (2, -1) to the middle tile on the +right side. + +.. _fig-hex-lat: .. figure:: ../_images/hex_lat.* :align: center