openmc.CollisionFilter

class openmc.CollisionFilter(bins, filter_id=None)[source]

Bins tally events based on the number of collisions.

New in version 0.12.2.

Parameters:
  • bins (Iterable of int) – A list or iterable of the number of collisions, as integer values. The events whose post-scattering collision number equals one of the provided values will be counted.
  • filter_id (int) – Unique identifier for the filter
Variables:
  • id (int) – Unique identifier for the filter
  • bins (numpy.ndarray) – An array of integer values representing the number of collisions events by which to filter
  • num_bins (int) – The number of filter bins
check_bins(bins)[source]

Make sure given bins are valid for this filter.

Raises:
to_xml_element()[source]

Return XML Element representing the Filter.

Returns:element – XML element containing filter data
Return type:xml.etree.ElementTree.Element