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

Clarified the MGXS docstring as an abstract base class

Browse source
This commit is contained in:
Will Boyd 2015-10-28 11:50:56 -04:00
parent b9eef474d8
commit e1283c7bf0
1 changed files with 4 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

6
openmc/mgxs/mgxs.py
View file

@ -47,13 +47,15 @@ _DOMAINS = [openmc.Cell,
class MGXS(object):
"""A multi-group cross section for some energy group structure within
some spatial domain.
"""An abstract multi-group cross section for some energy group structure
within some spatial domain.
This class can be used for both OpenMC input generation and tally data
post-processing to compute spatially-homogenized and energy-integrated
multi-group cross sections for deterministic neutronics calculations.
NOTE: Users should instantiate the subclasses of this abstract class.
Parameters
----------
domain : Material or Cell or Universe