Add regression test for surface source read/write feature

tests/regression_tests/surface_source/inputs_true_read.dat

@@ -0,0 +1,33 @@
+<?xml version='1.0' encoding='utf-8'?>
+<geometry>
+  <cell id="1" material="void" region="-1" universe="1" />
+  <cell id="2" material="void" region="1 -2" universe="1" />
+  <cell id="3" material="void" region="2 -3" universe="1" />
+  <cell id="4" material="void" region="3 -4" universe="1" />
+  <surface coeffs="0.0 0.0 0.0 1.0" id="1" type="sphere" />
+  <surface coeffs="0.0 0.0 0.0 2.0" id="2" type="sphere" />
+  <surface coeffs="0.0 0.0 0.0 2.5" id="3" type="sphere" />
+  <surface boundary="vacuum" coeffs="0.0 0.0 0.0 4.0" id="4" type="sphere" />
+</geometry>
+<?xml version='1.0' encoding='utf-8'?>
+<materials>
+</materials>
+<?xml version='1.0' encoding='utf-8'?>
+<settings>
+  <run_mode>fixed source</run_mode>
+  <particles>1000</particles>
+  <batches>10</batches>
+  <surf_src_read>
+    <path>surface_source_true.h5</path>
+  </surf_src_read>
+</settings>
+<?xml version='1.0' encoding='utf-8'?>
+<tallies>
+  <filter id="1" type="cell">
+    <bins>3</bins>
+  </filter>
+  <tally id="1">
+    <filters>1</filters>
+    <scores>flux</scores>
+  </tally>
+</tallies>

tests/regression_tests/surface_source/inputs_true_write.dat

@@ -0,0 +1,39 @@
+<?xml version='1.0' encoding='utf-8'?>
+<geometry>
+  <cell id="1" material="void" region="-1" universe="1" />
+  <cell id="2" material="void" region="1 -2" universe="1" />
+  <cell id="3" material="void" region="2 -3" universe="1" />
+  <cell id="4" material="void" region="3 -4" universe="1" />
+  <surface coeffs="0.0 0.0 0.0 1.0" id="1" type="sphere" />
+  <surface coeffs="0.0 0.0 0.0 2.0" id="2" type="sphere" />
+  <surface coeffs="0.0 0.0 0.0 2.5" id="3" type="sphere" />
+  <surface boundary="vacuum" coeffs="0.0 0.0 0.0 4.0" id="4" type="sphere" />
+</geometry>
+<?xml version='1.0' encoding='utf-8'?>
+<materials>
+</materials>
+<?xml version='1.0' encoding='utf-8'?>
+<settings>
+  <run_mode>fixed source</run_mode>
+  <particles>1000</particles>
+  <batches>10</batches>
+  <source strength="1.0">
+    <space type="point">
+      <parameters>0 0 0</parameters>
+    </space>
+  </source>
+  <surf_src_write>
+    <surf_ids>1</surf_ids>
+    <max_surf_banks>1000</max_surf_banks>
+  </surf_src_write>
+</settings>
+<?xml version='1.0' encoding='utf-8'?>
+<tallies>
+  <filter id="1" type="cell">
+    <bins>3</bins>
+  </filter>
+  <tally id="1">
+    <filters>1</filters>
+    <scores>flux</scores>
+  </tally>
+</tallies>

tests/regression_tests/surface_source/results_true.dat

@@ -0,0 +1,3 @@
+tally 1:
+5.000000E+00
+2.500000E+00

tests/regression_tests/surface_source/test.py

@@ -0,0 +1,127 @@
+import os
+import h5py
+import numpy as np
+
+import pytest
+import openmc
+
+from tests.testing_harness import PyAPITestHarness
+
+
+@pytest.fixture
+def model(request):
+    marker = request.node.get_closest_marker("surf_src_op")
+    surf_src_op = marker.args[0]
+
+    model = openmc.model.Model()
+
+    # Materials
+    # None
+
+    # Geometry
+    # Concentric void spheres
+    # - Innermost sphere to bank surface sources
+    # - Second shell to tally cell flux
+    # - Outermost sphere as vacuum boundary
+    sph_1 = openmc.Sphere(r=1.0, surface_id=1)  # Surface to bank/write sources.
+    sph_2 = openmc.Sphere(r=2.0, surface_id=2)
+    sph_3 = openmc.Sphere(r=2.5, surface_id=3)
+    sph_4 = openmc.Sphere(r=4.0, surface_id=4, boundary_type='vacuum')
+    cell_1 = openmc.Cell(1, region=-sph_1)
+    cell_2 = openmc.Cell(2, region=+sph_1&-sph_2)
+    cell_3 = openmc.Cell(3, region=+sph_2&-sph_3)  # Cell to tally flux.
+    cell_4 = openmc.Cell(4, region=+sph_3&-sph_4)
+    root = openmc.Universe(universe_id=1,
+                           cells=[cell_1, cell_2, cell_3, cell_4])
+    model.geometry = openmc.Geometry(root)
+
+    # Settings
+    model.settings.run_mode = 'fixed source'
+    model.settings.particles = 1000
+    model.settings.batches = 10
+
+    if surf_src_op == 'write':
+        point = openmc.stats.Point((0, 0, 0))
+        pt_src = openmc.Source(space=point)
+        model.settings.source = pt_src
+
+        model.settings.surf_src_write = {'surf_ids': [1],
+                                         'max_surf_banks': 1000}
+
+    elif surf_src_op == 'read':
+        model.settings.surf_src_read = {'path': 'surface_source_true.h5'}
+
+    # Tallies
+    tal = openmc.Tally(1)
+    cell_filter = openmc.CellFilter(cell_3, 1)
+    tal.filters = [cell_filter]
+    tal.scores = ['flux']
+    model.tallies.append(tal)
+
+    return model
+
+
+class SurfaceSourceTestHarness(PyAPITestHarness):
+
+    def _test_output_created(self):
+        super()._test_output_created()
+        # Check 'surface_source.h5'
+        if self._model.settings.surf_src_write:
+            assert os.path.exists('surface_source.h5'), \
+                'Surface source file does not exist.'
+
+    def _compare_output(self):
+        if self._model.settings.surf_src_write:
+            with h5py.File("surface_source_true.h5", 'r') as f:
+                src_true = f['source_bank'][()]
+            with h5py.File("surface_source.h5", 'r') as f:
+                src_test = f['source_bank'][()]
+            assert np.all(np.sort(src_true) == np.sort(src_test))
+
+    def execute_test(self):
+        """Build input XMLs, run OpenMC, and verify correct results."""
+        try:
+            self._build_inputs()
+            inputs = self._get_inputs()
+            self._write_inputs(inputs)
+            self._compare_inputs()
+            self._run_openmc()
+            self._test_output_created()
+            self._compare_output()
+            results = self._get_results()
+            self._write_results(results)
+            self._compare_results()
+        finally:
+            self._cleanup()
+
+    def _cleanup(self):
+        super()._cleanup()
+        fs = 'surface_source.h5'
+        if os.path.exists(fs):
+            os.remove(fs)
+
+    # - create model geom, mat, (fxd_src) sett - without surf_src_read/write cap
+    # - add surf_src_write sett
+    # - run with tally
+    # - check surf_src.h5 exist - give sample/ref?
+    # - compare tally result, check
+    # - restart, add surf_src_read sett
+    # - run with the same tally
+    # - compare tally result, check
+
+@pytest.mark.surf_src_op('write')
+def test_surface_source_write(model):
+
+    harness = SurfaceSourceTestHarness('statepoint.10.h5',
+                                       model,
+                                       'inputs_true_write.dat')
+    harness.main()
+
+
+@pytest.mark.surf_src_op('read')
+def test_surface_source_read(model):
+
+    harness = SurfaceSourceTestHarness('statepoint.10.h5',
+                                       model,
+                                       'inputs_true_read.dat')
+    harness.main()