From f7a85dda546a6813fedd15ccc1771611a9a218ec Mon Sep 17 00:00:00 2001 From: guillaume Date: Thu, 6 Jul 2017 19:38:53 -0400 Subject: [PATCH] Updated docs with surface tallies --- docs/source/io_formats/tallies.rst | 14 ++++++++++---- docs/source/usersguide/tallies.rst | 4 ++-- 2 files changed, 12 insertions(+), 6 deletions(-) diff --git a/docs/source/io_formats/tallies.rst b/docs/source/io_formats/tallies.rst index 25f40c3704..93c58c3489 100644 --- a/docs/source/io_formats/tallies.rst +++ b/docs/source/io_formats/tallies.rst @@ -124,8 +124,8 @@ attributes/sub-elements: :type: The type of the filter. Accepted options are "cell", "cellfrom", - "cellborn", "material", "universe", "energy", "energyout", "mu", "polar", - "azimuthal", "mesh", "distribcell", "delayedgroup", and + "cellborn", "surface", "material", "universe", "energy", "energyout", "mu", + "polar", "azimuthal", "mesh", "distribcell", "delayedgroup", and "energyfunction". :bins: @@ -157,13 +157,19 @@ should be set to: A list of cells or unique IDs for cells in which the tally should be accumulated. +:surface: + This filter allows the tally to be scored when crossing a surface. A list of + surface IDs should be given.It does not specify in which direction the + surface is crossed, and a cellfrom or a cell filter may be used to tally + partial currents. + :cellfrom: This filter allows the tally to be scored when crossing a surface and the particle came from a specified cell. A list of cell or cell IDs should be given. To tally a partial current from a cell to another, this filter should be - used in combination with a cell filter. - This filter should not be used in combination with a surface or meshfilter. + used in combination with a cell filter, to define the other cell. + This filter should not be used in combination with a meshfilter. :cellborn: This filter allows the tally to be scored to only when particles were diff --git a/docs/source/usersguide/tallies.rst b/docs/source/usersguide/tallies.rst index 46ad97721b..521735a833 100644 --- a/docs/source/usersguide/tallies.rst +++ b/docs/source/usersguide/tallies.rst @@ -271,10 +271,10 @@ The following tables show all valid scores: |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. | + | |a current score or a mesh filter. | | |It may be used in conjunction with any other score.| | |Surfaces can be defined with cell_from and cell | - | |(to) filters. | + | |(to) filters or surface filters. | +----------------------+---------------------------------------------------+ |events |Number of scoring events. Units are events per | | |source particle. |