crp/OpenMC
1
0
Fork 0
mirror of https://github.com/openmc-dev/openmc.git synced 2026-07-27 05:35:49 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Fix a few issues with MGXS documentation

Browse source
This commit is contained in:
Paul Romano 2016-03-25 13:17:49 -05:00
parent 9c020cfb62
commit 6e6e253fa6
6 changed files with 134 additions and 40 deletions
Download patch file Download diff file Expand all files Collapse all files

57
docs/source/pythonapi/mgxs.rst
View file

@ -4,31 +4,57 @@
Multi-Group Cross Sections
==========================
.. currentmodule:: openmc.mgxs.mgxs
----------------------------
Summary of Available Classes
----------------------------
Energy Groups
-------------
.. currentmodule:: openmc.mgxs.groups
.. autosummary::
MGXS
AbsorptionXS
CaptureXS
Chi
FissionXS
NuFissionXS
NuScatterXS
NuScatterMatrixXS
ScatterXS
ScatterMatrixXS
TotalXS
TransportXS
EnergyGroups
Multi-group Cross Sections
--------------------------
.. currentmodule:: openmc.mgxs.mgxs
.. autosummary::
MGXS
AbsorptionXS
CaptureXS
Chi
FissionXS
NuFissionXS
NuScatterXS
NuScatterMatrixXS
ScatterXS
ScatterMatrixXS
TotalXS
TransportXS
Multi-group Cross Section Libraries
-----------------------------------
.. currentmodule:: openmc.mgxs.library
.. autosummary::
Library
-------------------
Class Documentation
-------------------
.. automodule:: openmc.mgxs.groups
:members:
.. currentmodule:: openmc.mgxs.mgxs
.. autoclass:: MGXS
:members:
@ -64,3 +90,6 @@ Class Documentation
.. autoclass:: TransportXS
:members:
.. automodule:: openmc.mgxs.library
:members: