Address @yardasol review comments

This commit is contained in:
Paul Romano 2022-08-16 16:19:55 -05:00
parent c252930c49
commit d31b083685
8 changed files with 32 additions and 11 deletions

View file

@ -13,11 +13,12 @@ geometry modeling, mesh functionality, source specification, depletion
capabilities, and other general enhancements. The depletion module features a
new transport operator, :class:`openmc.deplete.IndependentOperator`, that allows
a depletion calculation to be performed using arbitrary one-group cross sections
(e.g., generated by an external solver). The track file generation capability
has been significantly overhauled and a new :class:`openmc.Tracks` class was
introduced to allow access to information in track files from the Python API.
Support has been added for new ENDF thermal scattering evaluations that use
mixed coherent/incoherent elastic scattering.
(e.g., generated by an external solver) along with a
:class:`openmc.deplete.MicroXS` class for managing one-group cross sections. The
track file generation capability has been significantly overhauled and a new
:class:`openmc.Tracks` class was introduced to allow access to information in
track files from the Python API. Support has been added for new ENDF thermal
scattering evaluations that use mixed coherent/incoherent elastic scattering.
------------------------------------
Compatibility Notes and Deprecations
@ -67,7 +68,8 @@ Compatibility Notes and Deprecations
New Features
------------
- An :class:`openmc.model.IsogonalOctagon` composite surface.
- Two new composite surfaces: :class:`openmc.model.IsogonalOctagon` and
:class:`openmc.model.CylinderSector`.
- The :class:`~openmc.DAGMCUniverse` class now has a
:attr:`~openmc.DAGMCUniverse.bounding_box` attribute and a
:meth:`~openmc.DAGMCUniverse.bounding_region` method.
@ -98,7 +100,7 @@ New Features
- An ``openmc_sample_external_source`` function has been added to the C API with
a corresponding Python binding :func:`openmc.lib.sample_external_source`.
- The track file generation capability has been completely overhauled. Track
files now include much more information, and a new :class:`~openmc.TrackFile`
files now include much more information, and a new :class:`~openmc.Tracks`
class allows access to track file information from the Python API. Multiple
tracks are now written to a single file (one per MPI rank).
- A new :func:`openmc.wwinp_to_wws` function that converts weight windows from a

View file

@ -46,6 +46,9 @@ class Results(list):
each depletion step and provides extra methods for interrogating these
results.
.. versionchanged:: 0.13.1
Name changed from ``ResultsList`` to ``Results``
Parameters
----------
filename : str

View file

@ -23,6 +23,9 @@ __all__ = ["StepResult"]
class StepResult:
"""Result of a single depletion timestep
.. versionchanged:: 0.13.1
Name changed from ``Results`` to ``StepResult``
Attributes
----------
k : list of (float, float)

View file

@ -3107,6 +3107,8 @@ class ReducedAbsorptionXS(MGXS):
3\sigma_{n,4n}(r,E) \right) \psi (r, E, \Omega)}{\int_{r \in V} dr
\int_{4\pi} d\Omega \int_{E_g}^{E_{g-1}} dE \; \psi (r, E, \Omega)}.
.. versionadded:: 0.13.1
"""
def __init__(self, domain=None, domain_type=None, energy_groups=None,

View file

@ -64,6 +64,8 @@ class CylinderSector(CompositeSurface):
operators applied to it will produce a half-space. The negative
side is defined to be the region inside of the cylinder sector.
.. versionadded:: 0.13.1
Parameters
----------
r1 : float
@ -225,6 +227,8 @@ class IsogonalOctagon(CompositeSurface):
operators applied to it will produce a half-space. The negative side is
defined to be the region inside of the octogonal prism.
.. versionadded:: 0.13.1
Parameters
----------
center : iterable of float

View file

@ -377,7 +377,10 @@ class SphericalIndependent(Spatial):
:math:`\theta`, and :math:`\phi` components are sampled independently
from one another and centered on the coordinates (x0, y0, z0).
.. versionadded: 0.12
.. versionadded:: 0.12
.. versionchanged:: 0.13.1
Accepts ``cos_theta`` instead of ``theta``
Parameters
----------
@ -787,7 +790,7 @@ def spherical_uniform(r_outer, r_inner=0.0, thetas=(0., pi), phis=(0., 2*pi),
shell between `r_inner` and `r_outer`. Optionally, the range of angles
can be restricted by the `thetas` and `phis` arguments.
.. versionadded: 0.13.1
.. versionadded:: 0.13.1
Parameters
----------

View file

@ -1059,7 +1059,7 @@ class Tabular(Univariate):
def integral(self):
"""Return integral of distribution
.. versionadded: 0.13.1
.. versionadded:: 0.13.1
Returns
-------

View file

@ -47,6 +47,8 @@ class Track(Sequence):
primary/secondary particle is stored in the :attr:`particle_tracks`
attribute.
.. versionadded:: 0.13.1
Parameters
----------
dset : h5py.Dataset
@ -201,6 +203,8 @@ class Tracks(list):
This class behaves like a list and can be indexed using the normal subscript
notation. Each element in the list is a :class:`openmc.Track` object.
.. versionadded:: 0.13.1
Parameters
----------
filepath : str or pathlib.Path
@ -286,7 +290,7 @@ class Tracks(list):
# Initialize data arrays and offset.
points = vtk.vtkPoints()
cells = vtk.vtkCellArray()
point_offset = 0
for particle in self:
for pt in particle.particle_tracks: