crp/OpenMC
1
0
Fork 0
mirror of https://github.com/openmc-dev/openmc.git synced 2026-07-28 14:15:42 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

Improve documentation of MGXS classes

Browse source
This commit is contained in:
Paul Romano 2016-06-01 15:40:35 -05:00
parent d21ea5697e
commit 96351c9b1c
4 changed files with 455 additions and 66 deletions
Download patch file Download diff file Expand all files Collapse all files

8
docs/source/_templates/myclassinherit.rst Normal file
View file

@ -0,0 +1,8 @@
{{ fullname }}
{{ underline }}
.. currentmodule:: {{ module }}
.. autoclass:: {{ objname }}
:members:
:inherited-members:

5
docs/source/pythonapi/index.rst
View file

@ -271,14 +271,17 @@ Multi-group Cross Sections
.. autosummary::
:toctree: generated
:nosignatures:
:template: myclass.rst
:template: myclassinherit.rst
openmc.mgxs.MGXS
openmc.mgxs.AbsorptionXS
openmc.mgxs.CaptureXS
openmc.mgxs.Chi
openmc.mgxs.FissionXS
openmc.mgxs.KappaFissionXS
openmc.mgxs.MultiplicityMatrixXS
openmc.mgxs.NuFissionXS
openmc.mgxs.NuFissionMatrixXS
openmc.mgxs.NuScatterXS
openmc.mgxs.NuScatterMatrixXS
openmc.mgxs.ScatterXS

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

@ -1598,7 +1598,8 @@ The ``<tally>`` element accepts the following sub-elements:
|Score | Description |
+======================+===================================================+
|absorption |Total absorption rate. This accounts for all |
| |reactions which do not produce secondary neutrons. |
| |reactions which do not produce secondary neutrons |
| |as well as fission. |
+----------------------+---------------------------------------------------+
|elastic |Elastic scattering reaction rate. |
+----------------------+---------------------------------------------------+