unwind fine-grained import booleans

Author: gonuke

docs/source/io_formats/settings.rst

@@ -549,22 +549,8 @@ generator during generation of colors in plots.
 ``<properties_file>`` Element
 --------------------------------------
 
-  The ``properties_file`` element indicates whether temperatures and densities 
-  from a properties file should override the properties present in the XML file. It contains
-  the following parameters:
-
-    :filepath:
-      The path to the properties file
-
-    :temperatures:
-       Boolean to indicate whether or not to read cell temperatures from the properties file.
-
-       *Default*: True
-
-    :densities:
-       Boolean to indicate whether or not to read cell and material densities from the properties file.
-
-       *Default*: True
+  The ``properties_file`` element has no attributes and contains the path to 
+  a properties HDF5 file to load cell temperatures/densities and material densities.
 
 
 ---------------------

include/openmc/capi.h

@@ -318,8 +318,7 @@ int openmc_properties_export(const char* filename);
 //! Import physical properties for model
 //! \param[in] filename Filename to read from
 // \return Error code
-int openmc_properties_import(
-  const char* filename, bool read_temperatures, bool read_densities);
+int openmc_properties_import(const char* filename);
 
 // Error codes
 extern int OPENMC_E_UNASSIGNED;

include/openmc/cell.h

@@ -196,10 +196,7 @@ class Cell {
 
   //! Import physical properties from HDF5
   //! \param[in] group  HDF5 group to write to
-  //! \param[in] read_temperatures whether to read temperatures
-  //! \param[in] read_densities whether to read densities
-  void import_properties_hdf5(
-    hid_t group, bool read_temperatures, bool read_densities);
+  void import_properties_hdf5(hid_t group);
 
   //! Get the BoundingBox for this cell.
   virtual BoundingBox bounding_box() const = 0;

include/openmc/material.h

@@ -76,7 +76,7 @@ class Material {
 
   //! Import physical properties from HDF5
   //! \param[in] group  HDF5 group to read from
-  void import_properties_hdf5(hid_t group, bool read_densities);
+  void import_properties_hdf5(hid_t group);
 
   //! Add nuclide to the material
   //

include/openmc/settings.h

@@ -104,10 +104,6 @@ extern bool weight_window_checkpoint_collision; //!< enable weight window check
                                                 //!< upon collision?
 extern bool write_all_tracks;     //!< write track files for every particle?
 extern bool write_initial_source; //!< write out initial source file?
-extern bool read_temperatures;    //!< read cell temperatures from
-                                  //!< properties file?
-extern bool read_densities;       //!< read cell/material densities
-                                  //!< from properties file?
 
 // Paths to various files
 extern std::string path_cross_sections; //!< path to cross_sections.xml

openmc/lib/core.py

@@ -77,7 +77,7 @@ class _SourceSite(Structure):
 _dll.openmc_properties_export.argtypes = [c_char_p]
 _dll.openmc_properties_export.restype = c_int
 _dll.openmc_properties_export.errcheck = _error_handler
-_dll.openmc_properties_import.argtypes = [c_char_p, c_bool, c_bool]
+_dll.openmc_properties_import.argtypes = [c_char_p]
 _dll.openmc_properties_import.restype = c_int
 _dll.openmc_properties_import.errcheck = _error_handler
 _dll.openmc_run.restype = c_int
@@ -304,7 +304,7 @@ def import_properties(filename):
     openmc.lib.export_properties
 
     """
-    _dll.openmc_properties_import(filename.encode(), True, True)
+    _dll.openmc_properties_import(filename.encode())
 
 
 def init(args=None, intracomm=None, output=True):

openmc/settings.py

@@ -182,10 +182,6 @@ class Settings:
     properties_file : Pathlike
         Location of the properties file to load cell temperatures/densities
         and materials
-    read_temperatures : bool
-        Whether to read cell temperatures from the properties file
-    read_densities : bool
-        Whether to read densities from the properties file
     random_ray : dict
         Options for configuring the random ray solver. Acceptable keys are:
 
@@ -400,8 +396,6 @@ def __init__(self, **kwargs):
         self._plot_seed = None
         self._ptables = None
         self._properties_file = None
-        self._read_temperatures = None
-        self._read_densities = None
         self._uniform_source_sampling = None
         self._seed = None
         self._stride = None
@@ -1039,28 +1033,6 @@ def properties_file(self, value: PathLike | None):
         else:
             cv.check_type('properties file', value, PathLike)
             self._properties_file = input_path(value)
-            self.read_temperatures = True
-            self.read_densities = True
-
-    @property
-    def read_temperatures(self) -> bool:
-        return self._read_temperatures
-
-    @read_temperatures.setter
-    def read_temperatures(self, read_temperatures : bool):
-        cv.check_type('read temperatures from properties ',
-                      read_temperatures, bool)
-        self._read_temperatures = read_temperatures
-
-    @property
-    def read_densities(self) -> bool:
-        return self._read_densities
-
-    @read_densities.setter
-    def read_densities(self, read_densities : bool):
-        cv.check_type('read temperatures from properties ',
-                      read_densities, bool)
-        self._read_densities = read_densities
 
     @property
     def trace(self) -> Iterable:
@@ -1753,22 +1725,9 @@ def _create_temperature_subelements(self, root):
                     element.text = str(value)
 
     def _create_properties_file_element(self, root):
-        if ((self.read_densities or
-             self.read_temperatures) and
-            self.properties_file is None):
-            # build warning that no properties file is specified
-            msg = ('Flag to read densities or temperatures was set without providing ' 
-                   'a properties file.')
-            warnings.warn(msg)
-
         if self.properties_file is not None:
             element = ET.Element("properties")
-            subelement = ET.SubElement(element, "filepath")
-            subelement.text = str(self.properties_file)
-            subelement = ET.SubElement(element, "temperatures")
-            subelement.text = str(self.read_temperatures).lower()
-            subelement = ET.SubElement(element, "densities")
-            subelement.text = str(self.read_densities).lower()
+            element.text = str(self.properties_file)
             root.append(element)
 
     def _create_trace_subelement(self, root):
@@ -2269,13 +2228,9 @@ def _temperature_from_xml_element(self, root):
             self.temperature['multipole'] = text in ('true', '1')
 
     def _properties_file_from_xml_element(self, root):
-        elem = root.find('properties')
-        if elem is not None:
-            self.properties_file = get_text(elem, 'filepath')
-            text = get_text(elem, 'temperatures')
-            self.read_temperatures = text in ('true', '1')
-            text = get_text(elem, 'densities')
-            self.read_densities = text in ('true', '1')
+        text = get_text(root, 'properties')
+        if text is not None:
+            self.properties_file = text
 
     def _trace_from_xml_element(self, root):
         text = get_elem_list(root, "trace", int)

src/cell.cpp

@@ -234,50 +234,45 @@ void Cell::export_properties_hdf5(hid_t group) const
   close_group(cell_group);
 }
 
-void Cell::import_properties_hdf5(
-  hid_t group, bool read_temperatures, bool read_densities)
+void Cell::import_properties_hdf5(hid_t group)
 {
   auto cell_group = open_group(group, fmt::format("cell {}", id_));
 
-  if (read_temperatures) {
-    // Read temperatures from file
-    vector<double> temps;
-    read_dataset(cell_group, "temperature", temps);
+  // Read temperatures from file
+  vector<double> temps;
+  read_dataset(cell_group, "temperature", temps);
 
-    // Ensure number of temperatures makes sense
-    auto n_temps = temps.size();
-    if (n_temps > 1 && n_temps != n_instances()) {
-      fatal_error(fmt::format(
-        "Number of temperatures for cell {} doesn't match number of instances",
-        id_));
-    }
+  // Ensure number of temperatures makes sense
+  auto n_temps = temps.size();
+  if (n_temps > 1 && n_temps != n_instances()) {
+    fatal_error(fmt::format(
+      "Number of temperatures for cell {} doesn't match number of instances",
+      id_));
+  }
 
-    // Modify temperatures for the cell
-    sqrtkT_.clear();
-    sqrtkT_.resize(temps.size());
-    for (int64_t i = 0; i < temps.size(); ++i) {
-      this->set_temperature(temps[i], i);
-    }
+  // Modify temperatures for the cell
+  sqrtkT_.clear();
+  sqrtkT_.resize(temps.size());
+  for (int64_t i = 0; i < temps.size(); ++i) {
+    this->set_temperature(temps[i], i);
   }
 
-  if (read_densities) {
-    // Read densities
-    if (object_exists(cell_group, "density")) {
-      vector<double> density;
-      read_dataset(cell_group, "density", density);
+  // Read densities
+  if (object_exists(cell_group, "density")) {
+    vector<double> density;
+    read_dataset(cell_group, "density", density);
 
-      // Ensure number of densities makes sense
-      auto n_density = density.size();
-      if (n_density > 1 && n_density != n_instances()) {
-        fatal_error(fmt::format("Number of densities for cell {} "
-                                "doesn't match number of instances",
-          id_));
-      }
+    // Ensure number of densities makes sense
+    auto n_density = density.size();
+    if (n_density > 1 && n_density != n_instances()) {
+      fatal_error(fmt::format("Number of densities for cell {} "
+                              "doesn't match number of instances",
+        id_));
+    }
 
-      // Set densities.
-      for (int32_t i = 0; i < n_density; ++i) {
-        this->set_density(density[i], i);
-      }
+    // Set densities.
+    for (int32_t i = 0; i < n_density; ++i) {
+      this->set_density(density[i], i);
     }
   }
 

src/initialize.cpp

@@ -119,8 +119,7 @@ int openmc_init(int argc, char* argv[], const void* intracomm)
     read_separate_xml_files();
 
   if (!settings::properties_file.empty()) {
-    openmc_properties_import(settings::properties_file.c_str(),
-      settings::read_temperatures, settings::read_densities);
+    openmc_properties_import(settings::properties_file.c_str());
   }
 
   // Reset locale to previous state

src/material.cpp

@@ -1138,11 +1138,8 @@ void Material::export_properties_hdf5(hid_t group) const
   close_group(material_group);
 }
 
-void Material::import_properties_hdf5(hid_t group, bool read_densities)
+void Material::import_properties_hdf5(hid_t group)
 {
-  if (!read_densities)
-    return;
-
   hid_t material_group = open_group(group, "material " + std::to_string(id_));
   double density;
   read_attribute(material_group, "atom_density", density);