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

changes for documentation in base.rst and tallies.rst

Browse source
This commit is contained in:
guillaume 2017-06-28 18:58:28 -04:00
parent 345f84b428
commit ca9fbb0c8f
3 changed files with 13 additions and 34 deletions
Download patch file Download diff file Expand all files Collapse all files

1
docs/source/pythonapi/base.rst
View file

@ -117,6 +117,7 @@ Constructing Tallies
openmc.UniverseFilter
openmc.MaterialFilter
openmc.CellFilter
openmc.CellFromFilter
openmc.CellbornFilter
openmc.SurfaceFilter
openmc.MeshFilter

10
docs/source/usersguide/tallies.rst
View file

@ -266,7 +266,15 @@ The following tables show all valid scores:
| |particle. Note that this score can only be used if |
| |a mesh filter has been specified. Furthermore, it |
| |may not be used in conjunction with any other |
| |score. |
| |score. Only energy and mesh filters may be used. |
+----------------------+---------------------------------------------------+
|partial_current |Partial currents on any surface previously defined |
| |in the geometry. Units are particles per source |
| |particle. Note that this score cannot be used with |
| |a current score or a surface or mesh filter. |
| |It may be used in conjunction with any other score.|
| |Surfaces can be defined with cell_from and cell |
| |(to) filters. |
+----------------------+---------------------------------------------------+
|events |Number of scoring events. Units are events per |
| |source particle. |

36
openmc/filter.py
View file

@ -603,13 +603,14 @@ class CellFilter(WithIDFilter):
def bins(self, bins):
self._smart_set_bins(bins, openmc.Cell)
class CellFromFilter(WithIDFilter):
"""Bins tally on which couple of cells the neutrons came from.
"""Bins tally on which Cell the neutron came from.
Parameters
----------
bins : openmc.Cell, Integral, or iterable thereof
The Cells to tally. Either openmc.Cell objects or their
The Cell(s) to tally. Either openmc.Cell objects or their
Integral ID numbers can be used.
filter_id : int
Unique identifier for the filter
@ -634,38 +635,7 @@ class CellFromFilter(WithIDFilter):
@bins.setter
def bins(self, bins):
self._smart_set_bins(bins, openmc.Cell)
class CellToFilter(WithIDFilter):
"""Bins tally on which couple of cells the neutrons went to.
Parameters
----------
bins : openmc.Cell, Integral, or iterable thereof
The Cells to tally. Either openmc.Cell objects or their
Integral ID numbers can be used.
filter_id : int
Unique identifier for the filter
Attributes
----------
bins : Integral or Iterable of Integral
openmc.Cell IDs.
id : int
Unique identifier for the filter
num_bins : Integral
The number of filter bins
stride : Integral
The number of filter, nuclide and score bins within each of this
filter's bins.
"""
@property
def bins(self):
return self._bins
@bins.setter
def bins(self, bins):
self._smart_set_bins(bins, openmc.Cell)
class CellbornFilter(WithIDFilter):
"""Bins tally events based on which Cell the neutron was born in.