Changed tally trigger status element to active

docs/source/usersguide/input.rst

@@ -654,11 +654,11 @@ compared with their corresponding trigger thresholds. If any triggers have not
 been met, OpenMC will continue until either all trigger thresholds have been 
 satisfied or ``<max_batches>`` has been reached.
 
-The ``<trigger>`` element describes the status of the trigger(s), the maximum 
-number of batches and the batch interval. It has the following 
-attributes/sub-elements:
+The ``<trigger>`` element provides an active "toggle switch" for tally
+precision trigger(s), the maximum number of batches and the batch interval. It 
+has the following attributes/sub-elements:
 
-  :status:
+  :active:
     This determines whether or not to use trigger(s). Trigger(s) are used when
     this tag is set to "true".
 

examples/python/lattice/hexagonal/build-xml.py

@@ -130,7 +130,7 @@ settings_file.inactive = inactive
 settings_file.particles = particles
 settings_file.set_source_space('box', [-1, -1, -1, 1, 1, 1])
 settings_file.keff_trigger = {'type' : 'std_dev', 'threshold' : 5E-4}
-settings_file.trigger_status = True
+settings_file.trigger_active = True
 settings_file.trigger_max_batches = 100
 settings_file.export_to_xml()
 

examples/python/lattice/simple/build-xml.py

@@ -130,7 +130,7 @@ settings_file.batches = batches
 settings_file.inactive = inactive
 settings_file.particles = particles
 settings_file.set_source_space('box', [-1, -1, -1, 1, 1, 1])
-settings_file.trigger_status = True
+settings_file.trigger_active = True
 settings_file.trigger_max_batches = 100
 settings_file.export_to_xml()
 

src/input_xml.F90

@@ -131,8 +131,8 @@ contains
     if (check_for_node(doc, "trigger")) then
       call get_node_ptr(doc, "trigger", node_trigger)
 
-      ! Get trigger status
-      call get_node_value(node_trigger, "status", temp_str)
+      ! Check if trigger(s) are to be turned on
+      call get_node_value(node_trigger, "active", temp_str)
       temp_str = trim(to_lower(temp_str))
 
       if (temp_str == 'true' .or. temp_str == '1') then
@@ -140,7 +140,7 @@ contains
       elseif (temp_str == 'false' .or. temp_str == '0') then
         trigger_on = .false.
       else
-        call fatal_error("Unrecognized trigger status: " // temp_str)
+        call fatal_error("Unrecognized trigger active: " // temp_str)
       end if
 
       if (trigger_on) then
@@ -196,7 +196,7 @@ contains
         n_max_batches = n_batches
       end if
 
-      !Get number of inactive batches
+      ! Get number of inactive batches
       call get_node_value(node_mode, "inactive", n_inactive)
       n_active = n_batches - n_inactive
       if (check_for_node(node_mode, "generations_per_batch")) then
@@ -2933,7 +2933,7 @@ contains
              &// trim(to_str(t % id)) // ".")
       end if
       
-      ! If settings.xml trigger status is turned on, create tally triggers
+      ! If settings.xml trigger is turned on, create tally triggers
       if (trigger_on) then
 
         ! Get list of trigger nodes for this tally

src/relaxng/settings.rnc

@@ -129,7 +129,7 @@ element settings {
   element track { list { xsd:positiveInteger+ } }? &
 
   element trigger {
-    (element status { xsd:boolean } | attribute status { xsd:boolean }) &
+    (element active { xsd:boolean } | attribute active { xsd:boolean }) &
     (element max_batches { xsd:positiveInteger } | attribute max_batches { xsd:positiveInteger }) &
     (element batch_interval { xsd:positiveInteger } | attribute batch_interval { xsd:positiveInteger })?
   }? &

src/relaxng/settings.rng

@@ -593,10 +593,10 @@
       <element name="trigger">
         <interleave>
           <choice>
-            <element name="status">
+            <element name="active">
               <data type="boolean"/>
             </element>
-            <attribute name="status">
+            <attribute name="active">
               <data type="boolean"/>
             </attribute>
           </choice>

src/utils/openmc/settings.py

@@ -44,7 +44,7 @@ class SettingsFile(object):
 
         # Trigger subelement
         self._trigger_subelement = None
-        self._trigger_status = None
+        self._trigger_active = None
         self._trigger_max_batches = None
         self._trigger_batch_interval = None
 
@@ -201,8 +201,8 @@ class SettingsFile(object):
 
 
     @property
-    def trigger_status(self):
-        return self._trigger_status
+    def trigger_active(self):
+        return self._trigger_active
 
 
     @property
@@ -895,15 +895,15 @@ class SettingsFile(object):
 
 
 
-    @trigger_status.setter
-    def trigger_status(self, trigger_status):
+    @trigger_active.setter
+    def trigger_active(self, trigger_active):
 
-        if not isinstance(trigger_status, bool):
-            msg = 'Unable to set trigger status to a ' \
-                  'non-boolean value {0}'.format(trigger_status)
+        if not isinstance(trigger_active, bool):
+            msg = 'Unable to set trigger active to a ' \
+                  'non-boolean value {0}'.format(trigger_active)
             raise ValueError(msg)
 
-        self._trigger_status = trigger_status
+        self._trigger_active = trigger_active
 
 
     @trigger_max_batches.setter
@@ -1500,21 +1500,21 @@ class SettingsFile(object):
 
     def create_trigger_subelement(self):
 
-        self.create_trigger_status_subelement()
+        self.create_trigger_active_subelement()
         self.create_trigger_max_batches_subelement()
         self.create_trigger_batch_interval_subelement()
 
 
-    def create_trigger_status_subelement(self):
+    def create_trigger_active_subelement(self):
 
-        if not self._trigger_status is None:
+        if not self._trigger_active is None:
 
             if self._trigger_subelement is None:
                 self._trigger_subelement = ET.SubElement(self._settings_file,
                                                       "trigger")
 
-            element = ET.SubElement(self._trigger_subelement, "status")
-            element.text = '{0}'.format(str(self._trigger_status).lower())
+            element = ET.SubElement(self._trigger_subelement, "active")
+            element.text = '{0}'.format(str(self._trigger_active).lower())
 
 
     def create_trigger_max_batches_subelement(self):