mirror of
https://github.com/openmc-dev/openmc.git
synced 2026-07-26 13:15:39 -04:00
126 lines
3.6 KiB
Python
126 lines
3.6 KiB
Python
from numbers import Real
|
|
from xml.etree import ElementTree as ET
|
|
import sys
|
|
|
|
from openmc.checkvalue import check_type, check_value
|
|
|
|
if sys.version_info[0] >= 3:
|
|
basestring = str
|
|
|
|
|
|
class Trigger(object):
|
|
"""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.
|
|
|
|
Attributes
|
|
----------
|
|
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
|
|
|
|
"""
|
|
|
|
def __init__(self, trigger_type, threshold):
|
|
# Initialize Mesh class attributes
|
|
self.trigger_type = trigger_type
|
|
self.threshold = threshold
|
|
self._scores = []
|
|
|
|
def __deepcopy__(self, memo):
|
|
existing = memo.get(id(self))
|
|
|
|
# If this is first time we have tried to copy this object, create a copy
|
|
if existing is None:
|
|
clone = type(self).__new__(type(self))
|
|
clone._trigger_type = self._trigger_type
|
|
clone._threshold = self._threshold
|
|
|
|
clone._scores = []
|
|
for score in self._scores:
|
|
clone.add_score(score)
|
|
|
|
memo[id(self)] = clone
|
|
|
|
return clone
|
|
|
|
# If this object has been copied before, return the first copy made
|
|
else:
|
|
return existing
|
|
|
|
@property
|
|
def trigger_type(self):
|
|
return self._trigger_type
|
|
|
|
@property
|
|
def threshold(self):
|
|
return self._threshold
|
|
|
|
@property
|
|
def scores(self):
|
|
return self._scores
|
|
|
|
@trigger_type.setter
|
|
def trigger_type(self, trigger_type):
|
|
check_value('tally trigger type', trigger_type,
|
|
['variance', 'std_dev', 'rel_err'])
|
|
self._trigger_type = trigger_type
|
|
|
|
@threshold.setter
|
|
def threshold(self, threshold):
|
|
check_type('tally trigger threshold', threshold, Real)
|
|
self._threshold = threshold
|
|
|
|
def add_score(self, score):
|
|
"""Add a score to the list of scores to be checked against the trigger.
|
|
|
|
Parameters
|
|
----------
|
|
score : str
|
|
Score to append
|
|
|
|
"""
|
|
|
|
if not isinstance(score, basestring):
|
|
msg = 'Unable to add score "{0}" to tally trigger since ' \
|
|
'it is not a string'.format(score)
|
|
raise ValueError(msg)
|
|
|
|
# If the score is already in the Tally, don't add it again
|
|
if score in self._scores:
|
|
return
|
|
else:
|
|
self._scores.append(score)
|
|
|
|
def __repr__(self):
|
|
string = 'Trigger\n'
|
|
string += '{0: <16}{1}{2}\n'.format('\tType', '=\t', self._trigger_type)
|
|
string += '{0: <16}{1}{2}\n'.format('\tThreshold', '=\t', self._threshold)
|
|
string += '{0: <16}{1}{2}\n'.format('\tScores', '=\t', self._scores)
|
|
return string
|
|
|
|
def get_trigger_xml(self, element):
|
|
"""Return XML representation of the trigger
|
|
|
|
Returns
|
|
-------
|
|
element : xml.etree.ElementTree.Element
|
|
XML element containing trigger data
|
|
|
|
"""
|
|
|
|
subelement = ET.SubElement(element, "trigger")
|
|
subelement.set("type", self._trigger_type)
|
|
subelement.set("threshold", str(self._threshold))
|
|
if len(self._scores) != 0:
|
|
subelement.set("scores", ' '.join(map(str, self._scores)))
|