Release of version 0.15.0 (#3050)

openmc-dev · Jun 22, 2024 · 55b52b7 · 55b52b7
1 parent 00faa7d
commit 55b52b7
Show file tree

Hide file tree

Showing 60 changed files with 464 additions and 85 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -3,8 +3,8 @@ project(openmc C CXX)
 
 # Set version numbers
 set(OPENMC_VERSION_MAJOR 0)
-set(OPENMC_VERSION_MINOR 14)
-set(OPENMC_VERSION_RELEASE 1)
+set(OPENMC_VERSION_MINOR 15)
+set(OPENMC_VERSION_RELEASE 0)
 set(OPENMC_VERSION ${OPENMC_VERSION_MAJOR}.${OPENMC_VERSION_MINOR}.${OPENMC_VERSION_RELEASE})
 configure_file(include/openmc/version.h.in "${CMAKE_BINARY_DIR}/include/openmc/version.h" @ONLY)
 

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -69,9 +69,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = "0.14"
+version = "0.15"
 # The full version, including alpha/beta/rc tags.
-release = "0.14.1-dev"
+release = "0.15.0"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

diff --git a/docs/source/io_formats/settings.rst b/docs/source/io_formats/settings.rst
@@ -284,9 +284,9 @@ then, OpenMC will only use up to the :math:`P_1` data.
   .. note:: This element is not used in the continuous-energy
     :ref:`energy_mode`.
 
-------------------------
+--------------------------------
 ``<max_history_splits>`` Element
-------------------------
+--------------------------------
 
 The ``<max_history_splits>`` element indicates the number of times a particle can split during a history.
 

diff --git a/docs/source/methods/random_ray.rst b/docs/source/methods/random_ray.rst
@@ -100,11 +100,11 @@ terms on the right hand side.
 .. math::
     :label: transport
 
-    \begin{align*}
+    \begin{aligned}
     \mathbf{\Omega} \cdot \mathbf{\nabla} \psi(\mathbf{r},\mathbf{\Omega},E) & + \Sigma_t(\mathbf{r},E) \psi(\mathbf{r},\mathbf{\Omega},E) = \\
     & \int_0^\infty d E^\prime \int_{4\pi} d \Omega^{\prime} \Sigma_s(\mathbf{r},\mathbf{\Omega}^\prime \rightarrow \mathbf{\Omega}, E^\prime \rightarrow E) \psi(\mathbf{r},\mathbf{\Omega}^\prime, E^\prime) \\
     & + \frac{\chi(\mathbf{r}, E)}{4\pi k_{eff}} \int_0^\infty dE^\prime \nu \Sigma_f(\mathbf{r},E^\prime) \int_{4\pi}d \Omega^\prime \psi(\mathbf{r},\mathbf{\Omega}^\prime,E^\prime)
-    \end{align*}
+    \end{aligned}
 
 In Equation :eq:`transport`, :math:`\psi` is the angular neutron flux. This
 parameter represents the total distance traveled by all neutrons in a particular

diff --git a/docs/source/releasenotes/0.15.0.rst b/docs/source/releasenotes/0.15.0.rst
diff --git a/docs/source/releasenotes/index.rst b/docs/source/releasenotes/index.rst
@@ -7,6 +7,7 @@ Release Notes
 .. toctree::
   :maxdepth: 1
 
+  0.15.0
   0.14.0
   0.13.3
   0.13.2

diff --git a/examples/lattice/hexagonal/build_xml.py b/examples/lattice/hexagonal/build_xml.py
@@ -114,8 +114,9 @@
 
 # Create an initial uniform spatial source distribution over fissionable zones
 bounds = [-1, -1, -1, 1, 1, 1]
-uniform_dist = openmc.stats.Box(bounds[:3], bounds[3:], only_fissionable=True)
-settings_file.source = openmc.IndependentSource(space=uniform_dist)
+uniform_dist = openmc.stats.Box(bounds[:3], bounds[3:])
+settings_file.source = openmc.IndependentSource(
+    space=uniform_dist, constraints={'fissionable': True})
 
 settings_file.keff_trigger = {'type' : 'std_dev', 'threshold' : 5E-4}
 settings_file.trigger_active = True

diff --git a/examples/lattice/nested/build_xml.py b/examples/lattice/nested/build_xml.py
@@ -124,8 +124,9 @@
 
 # Create an initial uniform spatial source distribution over fissionable zones
 bounds = [-1, -1, -1, 1, 1, 1]
-uniform_dist = openmc.stats.Box(bounds[:3], bounds[3:], only_fissionable=True)
-settings_file.source = openmc.IndependentSource(space=uniform_dist)
+uniform_dist = openmc.stats.Box(bounds[:3], bounds[3:])
+settings_file.source = openmc.IndependentSource(
+    space=uniform_dist, constraints={'fissionable': True})
 
 settings_file.export_to_xml()
 

diff --git a/examples/lattice/simple/build_xml.py b/examples/lattice/simple/build_xml.py
@@ -115,8 +115,9 @@
 
 # Create an initial uniform spatial source distribution over fissionable zones
 bounds = [-1, -1, -1, 1, 1, 1]
-uniform_dist = openmc.stats.Box(bounds[:3], bounds[3:], only_fissionable=True)
-settings_file.source = openmc.IndependentSource(space=uniform_dist)
+uniform_dist = openmc.stats.Box(bounds[:3], bounds[3:])
+settings_file.source = openmc.IndependentSource(
+    space=uniform_dist, constraints={'fissionable': True})
 
 settings_file.trigger_active = True
 settings_file.trigger_max_batches = 100

diff --git a/examples/pincell/build_xml.py b/examples/pincell/build_xml.py
@@ -67,8 +67,9 @@
 # Create an initial uniform spatial source distribution over fissionable zones
 lower_left = (-pitch/2, -pitch/2, -1)
 upper_right = (pitch/2, pitch/2, 1)
-uniform_dist = openmc.stats.Box(lower_left, upper_right, only_fissionable=True)
-settings.source = openmc.IndependentSource(space=uniform_dist)
+uniform_dist = openmc.stats.Box(lower_left, upper_right)
+settings.source = openmc.IndependentSource(
+    space=uniform_dist, constraints={'fissionable': True})
 
 # For source convergence checks, add a mesh that can be used to calculate the
 # Shannon entropy

diff --git a/examples/pincell_multigroup/build_xml.py b/examples/pincell_multigroup/build_xml.py
@@ -113,8 +113,9 @@
 # Create an initial uniform spatial source distribution over fissionable zones
 lower_left = (-pitch/2, -pitch/2, -1)
 upper_right = (pitch/2, pitch/2, 1)
-uniform_dist = openmc.stats.Box(lower_left, upper_right, only_fissionable=True)
-settings.source = openmc.IndependentSource(space=uniform_dist)
+uniform_dist = openmc.stats.Box(lower_left, upper_right)
+settings.source = openmc.IndependentSource(
+    space=uniform_dist, constraints={'fissionable': True})
 settings.export_to_xml()
 
 ###############################################################################

diff --git a/include/openmc/version.h.in b/include/openmc/version.h.in
@@ -10,7 +10,7 @@ namespace openmc {
 constexpr int VERSION_MAJOR {@OPENMC_VERSION_MAJOR@};
 constexpr int VERSION_MINOR {@OPENMC_VERSION_MINOR@};
 constexpr int VERSION_RELEASE {@OPENMC_VERSION_RELEASE@};
-constexpr bool VERSION_DEV {true};
+constexpr bool VERSION_DEV {false};
 constexpr std::array<int, 3> VERSION {VERSION_MAJOR, VERSION_MINOR, VERSION_RELEASE};
 // clang-format on
 

diff --git a/openmc/__init__.py b/openmc/__init__.py
@@ -39,4 +39,4 @@
 from openmc.model import Model
 
 
-__version__ = '0.14.1-dev'
+__version__ = '0.15.0'
diff --git a/openmc/deplete/abc.py b/openmc/deplete/abc.py
@@ -786,7 +786,7 @@ def integrate(
         path : PathLike
             Path to file to write. Defaults to 'depletion_results.h5'.
 
-            .. versionadded:: 0.14.1
+            .. versionadded:: 0.15.0
         """
         with change_directory(self.operator.output_dir):
             n = self.operator.initial_condition()
@@ -993,7 +993,7 @@ def integrate(
         path : PathLike
             Path to file to write. Defaults to 'depletion_results.h5'.
 
-            .. versionadded:: 0.14.1
+            .. versionadded:: 0.15.0
         """
         with change_directory(self.operator.output_dir):
             n = self.operator.initial_condition()

diff --git a/openmc/deplete/microxs.py b/openmc/deplete/microxs.py
@@ -219,7 +219,7 @@ def from_multigroup_flux(
         sections available. MicroXS entry will be 0 if the nuclide cross section
         is not found.
 
-        .. versionadded:: 0.14.1
+        .. versionadded:: 0.15.0
 
         Parameters
         ----------

diff --git a/openmc/lib/mesh.py b/openmc/lib/mesh.py
@@ -174,7 +174,7 @@ def material_volumes(
     ) -> List[List[Tuple[Material, float]]]:
         """Determine volume of materials in each mesh element
 
-        .. versionadded:: 0.14.1
+        .. versionadded:: 0.15.0
 
         Parameters
         ----------
@@ -231,7 +231,7 @@ def get_plot_bins(
     ) -> np.ndarray:
         """Get mesh bin indices for a rasterized plot.
 
-        .. versionadded:: 0.14.1
+        .. versionadded:: 0.15.0
 
         Parameters
         ----------

diff --git a/openmc/mesh.py b/openmc/mesh.py
@@ -157,7 +157,7 @@ def get_homogenized_materials(
     ) -> List[openmc.Material]:
         """Generate homogenized materials over each element in a mesh.
 
-        .. versionadded:: 0.14.1
+        .. versionadded:: 0.15.0
 
         Parameters
         ----------
@@ -1487,6 +1487,8 @@ def get_indices_at_coords(
         ) -> Tuple[int, int, int]:
         """Finds the index of the mesh voxel at the specified x,y,z coordinates.
 
+        .. versionadded:: 0.15.0
+
         Parameters
         ----------
         coords : Sequence[float]

diff --git a/openmc/plotter.py b/openmc/plotter.py
@@ -169,7 +169,7 @@ def plot_xs(reactions, divisor_types=None, temperature=294., axis=None,
     energy_axis_units : {'eV', 'keV', 'MeV'}
         Units used on the plot energy axis
 
-        .. versionadded:: 0.14.1
+        .. versionadded:: 0.15.0
 
     Returns
     -------

diff --git a/openmc/region.py b/openmc/region.py
@@ -344,7 +344,7 @@ def rotate(self, rotation, pivot=(0., 0., 0.), order='xyz', inplace=False,
     def plot(self, *args, **kwargs):
         """Display a slice plot of the region.
 
-        .. versionadded:: 0.14.1
+        .. versionadded:: 0.15.0
 
         Parameters
         ----------

diff --git a/openmc/settings.py b/openmc/settings.py
@@ -113,7 +113,7 @@ class Settings:
     max_particle_events : int
         Maximum number of allowed particle events per source particle.
 
-        .. versionadded:: 0.14.1
+        .. versionadded:: 0.15.0
     max_order : None or int
         Maximum scattering order to apply globally when in multi-group mode.
     max_history_splits : int
@@ -158,7 +158,7 @@ class Settings:
             Starting ray distribution (must be uniform in space and angle) as
             specified by a :class:`openmc.SourceBase` object.
 
-        .. versionadded:: 0.14.1
+        .. versionadded:: 0.15.0
     resonance_scattering : dict
         Settings for resonance elastic scattering. Accepted keys are 'enable'
         (bool), 'method' (str), 'energy_min' (float), 'energy_max' (float), and

diff --git a/openmc/source.py b/openmc/source.py
@@ -264,7 +264,7 @@ class IndependentSource(SourceBase):
         Domains to reject based on, i.e., if a sampled spatial location is not
         within one of these domains, it will be rejected.
 
-        .. deprecated:: 0.14.1
+        .. deprecated:: 0.15.0
             Use the `constraints` argument instead.
     constraints : dict
         Constraints on sampled source particles. Valid keys include 'domains',
@@ -482,7 +482,7 @@ class MeshSource(SourceBase):
     strength of the mesh source as a whole is the sum of all source strengths
     applied to the elements.
 
-    .. versionadded:: 0.14.1
+    .. versionadded:: 0.15.0
 
     Parameters
     ----------
@@ -1049,7 +1049,7 @@ def write_source_file(
 def read_source_file(filename: PathLike) -> typing.List[SourceParticle]:
     """Read a source file and return a list of source particles.
 
-    .. versionadded:: 0.14.1
+    .. versionadded:: 0.15.0
 
     Parameters
     ----------

diff --git a/openmc/stats/multivariate.py b/openmc/stats/multivariate.py
@@ -769,7 +769,7 @@ class Box(Spatial):
         Whether spatial sites should only be accepted if they occur in
         fissionable materials
 
-        .. deprecated:: 0.14.1
+        .. deprecated:: 0.15.0
             Use the `constraints` argument when defining a source object instead.
 
     Attributes
@@ -782,7 +782,7 @@ class Box(Spatial):
         Whether spatial sites should only be accepted if they occur in
         fissionable materials
 
-        .. deprecated:: 0.14.1
+        .. deprecated:: 0.15.0
             Use the `constraints` argument when defining a source object instead.
 
     """

diff --git a/openmc/trigger.py b/openmc/trigger.py
@@ -22,7 +22,7 @@ class Trigger(EqualityMixin):
         can cause the trigger to fire prematurely if there are zero scores in
         any bin at the first evaluation.
 
-        .. versionadded:: 0.14.1
+        .. versionadded:: 0.15.0
 
     Attributes
     ----------

diff --git a/tests/regression_tests/filter_cellfrom/inputs_true.dat b/tests/regression_tests/filter_cellfrom/inputs_true.dat
@@ -49,9 +49,12 @@
     <batches>15</batches>
     <inactive>5</inactive>
     <source particle="neutron" strength="1.0" type="independent">
-      <space type="fission">
+      <space type="box">
         <parameters>-2.0 -2.0 -2.0 2.0 2.0 2.0</parameters>
       </space>
+      <constraints>
+        <fissionable>true</fissionable>
+      </constraints>
     </source>
     <seed>1</seed>
   </settings>

diff --git a/tests/regression_tests/filter_cellfrom/test.py b/tests/regression_tests/filter_cellfrom/test.py
@@ -142,8 +142,9 @@ def model():
         core_radius,
         core_height / 2.0,
     ]
-    distribution = openmc.stats.Box(bounds[:3], bounds[3:], only_fissionable=True)
-    model.settings.source = openmc.IndependentSource(space=distribution)
+    distribution = openmc.stats.Box(bounds[:3], bounds[3:])
+    model.settings.source = openmc.IndependentSource(
+        space=distribution, constraints={'fissionable': True})
 
     # =============================================================================
     # Tallies

diff --git a/tests/regression_tests/surface_source_write/case-01/inputs_true.dat b/tests/regression_tests/surface_source_write/case-01/inputs_true.dat
@@ -42,9 +42,12 @@
     <batches>5</batches>
     <inactive>1</inactive>
     <source particle="neutron" strength="1.0" type="independent">
-      <space type="fission">
+      <space type="box">
         <parameters>-2.0 -2.0 -2.0 2.0 2.0 2.0</parameters>
       </space>
+      <constraints>
+        <fissionable>true</fissionable>
+      </constraints>
     </source>
     <surf_source_write>
       <max_particles>300</max_particles>

diff --git a/tests/regression_tests/surface_source_write/case-02/inputs_true.dat b/tests/regression_tests/surface_source_write/case-02/inputs_true.dat
@@ -42,9 +42,12 @@
     <batches>5</batches>
     <inactive>1</inactive>
     <source particle="neutron" strength="1.0" type="independent">
-      <space type="fission">
+      <space type="box">
         <parameters>-2.0 -2.0 -2.0 2.0 2.0 2.0</parameters>
       </space>
+      <constraints>
+        <fissionable>true</fissionable>
+      </constraints>
     </source>
     <surf_source_write>
       <surface_ids>8</surface_ids>

diff --git a/tests/regression_tests/surface_source_write/case-03/inputs_true.dat b/tests/regression_tests/surface_source_write/case-03/inputs_true.dat
@@ -42,9 +42,12 @@
     <batches>5</batches>
     <inactive>1</inactive>
     <source particle="neutron" strength="1.0" type="independent">
-      <space type="fission">
+      <space type="box">
         <parameters>-2.0 -2.0 -2.0 2.0 2.0 2.0</parameters>
       </space>
+      <constraints>
+        <fissionable>true</fissionable>
+      </constraints>
     </source>
     <surf_source_write>
       <surface_ids>4 5 6 7 8 9</surface_ids>

diff --git a/tests/regression_tests/surface_source_write/case-04/inputs_true.dat b/tests/regression_tests/surface_source_write/case-04/inputs_true.dat
@@ -42,9 +42,12 @@
     <batches>5</batches>
     <inactive>1</inactive>
     <source particle="neutron" strength="1.0" type="independent">
-      <space type="fission">
+      <space type="box">
         <parameters>-2.0 -2.0 -2.0 2.0 2.0 2.0</parameters>
       </space>
+      <constraints>
+        <fissionable>true</fissionable>
+      </constraints>
     </source>
     <surf_source_write>
       <surface_ids>4 5 6 7 8 9</surface_ids>

diff --git a/tests/regression_tests/surface_source_write/case-05/inputs_true.dat b/tests/regression_tests/surface_source_write/case-05/inputs_true.dat
@@ -42,9 +42,12 @@
     <batches>5</batches>
     <inactive>1</inactive>
     <source particle="neutron" strength="1.0" type="independent">
-      <space type="fission">
+      <space type="box">
         <parameters>-2.0 -2.0 -2.0 2.0 2.0 2.0</parameters>
       </space>
+      <constraints>
+        <fissionable>true</fissionable>
+      </constraints>
     </source>
     <surf_source_write>
       <surface_ids>4 5 6 7 8 9</surface_ids>

diff --git a/tests/regression_tests/surface_source_write/case-06/inputs_true.dat b/tests/regression_tests/surface_source_write/case-06/inputs_true.dat
@@ -42,9 +42,12 @@
     <batches>5</batches>
     <inactive>1</inactive>
     <source particle="neutron" strength="1.0" type="independent">
-      <space type="fission">
+      <space type="box">
         <parameters>-2.0 -2.0 -2.0 2.0 2.0 2.0</parameters>
       </space>
+      <constraints>
+        <fissionable>true</fissionable>
+      </constraints>
     </source>
     <surf_source_write>
       <max_particles>300</max_particles>