mirror of
https://github.com/openmc-dev/openmc.git
synced 2026-07-27 21:55:41 -04:00
Add missing versionadded directives
This commit is contained in:
parent
f77aec1511
commit
7bbf5466e6
6 changed files with 13 additions and 1 deletions
|
|
@ -398,6 +398,8 @@ class Results(list):
|
|||
path : PathLike
|
||||
Path to materials XML file to read. Defaults to 'materials.xml'.
|
||||
|
||||
.. versionadded:: 0.13.3
|
||||
|
||||
Returns
|
||||
-------
|
||||
mat_file : Materials
|
||||
|
|
|
|||
|
|
@ -1349,6 +1349,8 @@ class EnergyFilter(RealFilter):
|
|||
(e.g., a source spectrum) based on tally results that were obtained from
|
||||
using an :class:`~openmc.EnergyFilter`.
|
||||
|
||||
.. versionadded:: 0.13.3
|
||||
|
||||
Parameters
|
||||
----------
|
||||
values : iterable of float
|
||||
|
|
|
|||
|
|
@ -537,6 +537,8 @@ class Geometry:
|
|||
def get_surfaces_by_name(self, name, case_sensitive=False, matching=False):
|
||||
"""Return a list of surfaces with matching names.
|
||||
|
||||
.. versionadded:: 0.13.3
|
||||
|
||||
Parameters
|
||||
----------
|
||||
name : str
|
||||
|
|
|
|||
|
|
@ -644,6 +644,8 @@ class Model:
|
|||
Exports a single model.xml file rather than separate files.
|
||||
Defaults to True.
|
||||
|
||||
.. versionadded:: 0.13.3
|
||||
|
||||
Returns
|
||||
-------
|
||||
Path
|
||||
|
|
|
|||
|
|
@ -632,6 +632,8 @@ class ZConeOneSided(CompositeSurface):
|
|||
class Polygon(CompositeSurface):
|
||||
"""Create a polygon composite surface from a path of closed points.
|
||||
|
||||
.. versionadded:: 0.13.3
|
||||
|
||||
Parameters
|
||||
----------
|
||||
points : np.ndarray
|
||||
|
|
@ -927,7 +929,7 @@ class Polygon(CompositeSurface):
|
|||
if group is None:
|
||||
sidx = next(iter(neighbor_map))
|
||||
return self._group_simplices(neighbor_map, group=[sidx])
|
||||
# Otherwise use the last simplex in the group
|
||||
# Otherwise use the last simplex in the group
|
||||
else:
|
||||
sidx = group[-1]
|
||||
# Remove current simplex from dictionary since it is in a group
|
||||
|
|
|
|||
|
|
@ -1436,6 +1436,8 @@ class Tally(IDManagerMixin):
|
|||
dimensions. This will result in more than one dimension per filter
|
||||
for the returned data array.
|
||||
|
||||
.. versionadded:: 0.13.3
|
||||
|
||||
Returns
|
||||
-------
|
||||
numpy.ndarray
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue