openmc.Trigger¶
-
class
openmc.
Trigger
(trigger_type, threshold)[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
-
add_score
(score)[source]¶ Add a score to the list of scores to be checked against the trigger.
Parameters: score (str) – Score to append
-
get_trigger_xml
(element)[source]¶ Return XML representation of the trigger
Returns: element – XML element containing trigger data Return type: xml.etree.ElementTree.Element