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

Remove references to Nu/Prompt MGXS classes in docs

Browse source
This commit is contained in:
Paul Romano 2017-02-28 06:28:44 -06:00
parent fdd7b292ca
commit 583782864e
3 changed files with 8 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -287,17 +287,11 @@ Multi-group Cross Sections
openmc.mgxs.AbsorptionXS
openmc.mgxs.CaptureXS
openmc.mgxs.Chi
openmc.mgxs.ChiPrompt
openmc.mgxs.FissionXS
openmc.mgxs.InverseVelocity
openmc.mgxs.KappaFissionXS
openmc.mgxs.MultiplicityMatrixXS
openmc.mgxs.NuFissionXS
openmc.mgxs.NuFissionMatrixXS
openmc.mgxs.NuScatterXS
openmc.mgxs.NuScatterMatrixXS
openmc.mgxs.PromptNuFissionXS
openmc.mgxs.PromptNuFissionMatrixXS
openmc.mgxs.ScatterXS
openmc.mgxs.ScatterMatrixXS
openmc.mgxs.TotalXS

2
openmc/mgxs/mgxs.py
View file

@ -58,7 +58,7 @@ _DOMAINS = (openmc.Cell,
openmc.Material,
openmc.Mesh)
# Supported ScatterMatrixXS and NuScatterMatrixXS angular distribution types
# Supported ScatterMatrixXS angular distribution types
MU_TREATMENTS = ('legendre', 'histogram')
# Maximum Legendre order supported by OpenMC

16
openmc/mgxs_library.py
View file

@ -1563,19 +1563,17 @@ class XSdata(object):
temperature=294., nuclide='total',
xs_type='macro', subdomain=None):
"""This method allows for either the direct use of only an
openmc.mgxs.MultiplicityMatrixXS OR
an openmc.mgxs.NuScatterMatrixXS and
openmc.mgxs.MultiplicityMatrixXS or an openmc.mgxs.ScatterMatrixXS and
openmc.mgxs.ScatterMatrixXS to be used to set the scattering
multiplicity for this XSdata object. Multiplicity,
in OpenMC parlance, is a factor used to account for the production
of neutrons introduced by scattering multiplication reactions, i.e.,
(n,xn) events. In this sense, the multiplication matrix is simply
defined as the ratio of the nu-scatter and scatter matrices.
multiplicity for this XSdata object. Multiplicity, in OpenMC parlance,
is a factor used to account for the production of neutrons introduced by
scattering multiplication reactions, i.e., (n,xn) events. In this sense,
the multiplication matrix is simply defined as the ratio of the
nu-scatter and scatter matrices.
Parameters
----------
nuscatter: {openmc.mgxs.NuScatterMatrixXS,
openmc.mgxs.MultiplicityMatrixXS}
nuscatter: openmc.mgxs.ScatterMatrixXS or openmc.mgxs.MultiplicityMatrixXS
MGXS Object containing the matrix cross section for the domain
of interest.
scatter: openmc.mgxs.ScatterMatrixXS