mirror of
https://github.com/openmc-dev/openmc.git
synced 2026-07-28 14:15:42 -04:00
Fix MGXS documentation problems
This commit is contained in:
parent
e57ca85a7c
commit
0862adfcb7
6 changed files with 16 additions and 19 deletions
|
|
@ -5,4 +5,4 @@ Multi-Group Cross Sections
|
|||
==========================
|
||||
|
||||
.. automodule:: openmc.mgxs.mgxs
|
||||
:members: MGXS
|
||||
:members:
|
||||
|
|
|
|||
|
|
@ -1,8 +1,8 @@
|
|||
.. _pythonapi_openmc_mgxs:
|
||||
.. _pythonapi_opencg_compatible:
|
||||
|
||||
==========================
|
||||
Multi-Group Cross Sections
|
||||
==========================
|
||||
====================
|
||||
OpenCG Compatibility
|
||||
====================
|
||||
|
||||
.. automodule:: openmc.mgxs.mgxs
|
||||
.. automodule:: openmc.opencg_compatible
|
||||
:members:
|
||||
|
|
|
|||
|
|
@ -511,8 +511,9 @@ class Filter(object):
|
|||
surface, material or universe ID corresponding to each filter bin.
|
||||
|
||||
For 'distribcell' filters, the DataFrame either includes:
|
||||
1) a single column with the cell instance IDs (without summary info)
|
||||
2) separate columns for the cell IDs, universe IDs, and lattice IDs
|
||||
|
||||
1. a single column with the cell instance IDs (without summary info)
|
||||
2. separate columns for the cell IDs, universe IDs, and lattice IDs
|
||||
and x,y,z cell indices corresponding to each (with summary info).
|
||||
|
||||
For 'energy' and 'energyout' filters, the DataFrame include a single
|
||||
|
|
|
|||
|
|
@ -330,9 +330,7 @@ class Library(object):
|
|||
----------
|
||||
domain : Material or Cell or Universe or Integral
|
||||
The material, cell, or universe object of interest (or its ID)
|
||||
mgxs_type : {'total', 'transport', 'absorption', 'capture', 'fission',
|
||||
'nu-fission', 'scatter', 'nu-scatter', 'scatter matrix',
|
||||
'nu-scatter matrix', 'chi'}
|
||||
mgxs_type : {'total', 'transport', 'absorption', 'capture', 'fission', 'nu-fission', 'scatter', 'nu-scatter', 'scatter matrix', 'nu-scatter matrix', 'chi'}
|
||||
The type of multi-group cross section object to return
|
||||
|
||||
Returns
|
||||
|
|
|
|||
|
|
@ -247,9 +247,7 @@ class MGXS(object):
|
|||
|
||||
Parameters
|
||||
----------
|
||||
mgxs_type : {'total', 'transport', 'absorption', 'capture', 'fission',
|
||||
'nu-fission', 'scatter', 'nu-scatter', 'scatter matrix',
|
||||
'nu-scatter matrix', 'chi'}
|
||||
mgxs_type : {'total', 'transport', 'absorption', 'capture', 'fission', 'nu-fission', 'scatter', 'nu-scatter', 'scatter matrix', 'nu-scatter matrix', 'chi'}
|
||||
The type of multi-group cross section object to return
|
||||
domain : Material or Cell or Universe
|
||||
The domain for spatial homogenization
|
||||
|
|
@ -327,8 +325,8 @@ class MGXS(object):
|
|||
"""Get the atomic number density in units of atoms/b-cm for a nuclide
|
||||
in the cross section's spatial domain.
|
||||
|
||||
Paramters
|
||||
---------
|
||||
Parameters
|
||||
----------
|
||||
nuclide : str
|
||||
A nuclide name string (e.g., 'U-235')
|
||||
|
||||
|
|
@ -362,8 +360,8 @@ class MGXS(object):
|
|||
"""Get an array of atomic number densities in units of atom/b-cm for all
|
||||
nuclides in the cross section's spatial domain.
|
||||
|
||||
Paramters
|
||||
---------
|
||||
Parameters
|
||||
----------
|
||||
nuclides : Iterable of str or 'all' or 'sum'
|
||||
A list of nuclide name strings (e.g., ['U-235', 'U-238']). The
|
||||
special string 'all' will return the atom densities for all nuclides
|
||||
|
|
|
|||
|
|
@ -1269,7 +1269,7 @@ class Tally(object):
|
|||
correspond directly to the two filters with two and four bins.
|
||||
|
||||
Parameters
|
||||
---------
|
||||
----------
|
||||
value : str
|
||||
A string for the type of value to return - 'mean' (default),
|
||||
'std_dev', 'rel_err', 'sum', or 'sum_sq' are accepted
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue