openmc.Trigger

class openmc.Trigger(trigger_type: str, threshold: float)[source]

A criterion for when to finish a simulation based on tally uncertainties.

Parameters
  • trigger_type ({'variance', 'std_dev', 'rel_err'}) – Determine whether to trigger on the variance, standard deviation, or relative error of scores.

  • threshold (float) – The threshold for the trigger type.

Variables
  • trigger_type ({'variance', 'std_dev', 'rel_err'}) – Determine whether to trigger on the variance, standard deviation, or relative error of scores.

  • threshold (float) – The threshold for the trigger type.

  • scores (list of str) – Scores which should be checked against the trigger

classmethod from_xml_element(elem: Element)[source]

Generate trigger object from an XML element

Parameters

elem (lxml.etree._Element) – XML element

Returns

Trigger object

Return type

openmc.Trigger

to_xml_element()[source]

Return XML representation of the trigger

Returns

element – XML element containing trigger data

Return type

lxml.etree._Element