mirror of
https://github.com/openmc-dev/openmc.git
synced 2026-07-26 13:15:39 -04:00
Add missing versionadded directives
This commit is contained in:
parent
adbc9e0537
commit
02f1815299
10 changed files with 37 additions and 7 deletions
|
|
@ -178,6 +178,8 @@ def kalbach_slope(energy_projectile, energy_emitted, za_projectile,
|
|||
energies are not calculated with the AWR number, but approximated with
|
||||
the number of mass instead.
|
||||
|
||||
.. versionadded:: 0.13.1
|
||||
|
||||
Parameters
|
||||
----------
|
||||
energy_projectile : float
|
||||
|
|
@ -593,6 +595,9 @@ class KalbachMann(AngleEnergy):
|
|||
If the projectile is a neutron, the slope is calculated when it is
|
||||
not given explicitly.
|
||||
|
||||
.. versionchanged:: 0.13.1
|
||||
Arguments changed to accommodate slope calculation
|
||||
|
||||
Parameters
|
||||
----------
|
||||
file_obj : file-like object
|
||||
|
|
|
|||
|
|
@ -56,6 +56,7 @@ def _find_cross_sections(model):
|
|||
)
|
||||
return cross_sections
|
||||
|
||||
|
||||
def _get_nuclides_with_data(cross_sections):
|
||||
"""Loads cross_sections.xml file to find nuclides with neutron data
|
||||
|
||||
|
|
@ -81,6 +82,7 @@ def _get_nuclides_with_data(cross_sections):
|
|||
|
||||
return nuclides
|
||||
|
||||
|
||||
class CoupledOperator(OpenMCOperator):
|
||||
"""Transport-coupled transport operator.
|
||||
|
||||
|
|
@ -93,6 +95,9 @@ class CoupledOperator(OpenMCOperator):
|
|||
The geometry and settings parameters have been replaced with a
|
||||
model parameter that takes a :class:`~openmc.model.Model` object
|
||||
|
||||
.. versionchanged:: 0.13.1
|
||||
Name changed from ``Operator`` to ``CoupledOperator``
|
||||
|
||||
Parameters
|
||||
----------
|
||||
model : openmc.model.Model
|
||||
|
|
@ -534,6 +539,7 @@ class CoupledOperator(OpenMCOperator):
|
|||
if self.cleanup_when_done:
|
||||
openmc.lib.finalize()
|
||||
|
||||
|
||||
# Retain deprecated name for the time being
|
||||
def Operator(*args, **kwargs):
|
||||
# warn of name change
|
||||
|
|
|
|||
|
|
@ -6,8 +6,6 @@ transport solver by using user-provided one-group cross sections.
|
|||
"""
|
||||
|
||||
import copy
|
||||
from collections import OrderedDict
|
||||
from warnings import warn
|
||||
from itertools import product
|
||||
|
||||
import numpy as np
|
||||
|
|
@ -22,6 +20,7 @@ from .microxs import MicroXS
|
|||
from .results import Results
|
||||
from .helpers import ChainFissionHelper, ConstantFissionYieldHelper, SourceRateHelper
|
||||
|
||||
|
||||
class IndependentOperator(OpenMCOperator):
|
||||
"""Transport-independent transport operator that uses one-group cross
|
||||
sections to calculate reaction rates.
|
||||
|
|
@ -32,6 +31,8 @@ class IndependentOperator(OpenMCOperator):
|
|||
passed to an integrator class, such as
|
||||
:class:`openmc.deplete.CECMIntegrator`.
|
||||
|
||||
.. versionadded:: 0.13.1
|
||||
|
||||
Parameters
|
||||
----------
|
||||
materials : openmc.Materials
|
||||
|
|
|
|||
|
|
@ -25,8 +25,10 @@ _valid_rxns.append('fission')
|
|||
|
||||
|
||||
class MicroXS(DataFrame):
|
||||
"""Stores microscopic cross section data for use in
|
||||
transport-independent depletion.
|
||||
"""Microscopic cross section data for use in transport-independent depletion.
|
||||
|
||||
.. versionadded:: 0.13.1
|
||||
|
||||
"""
|
||||
|
||||
@classmethod
|
||||
|
|
@ -59,7 +61,7 @@ class MicroXS(DataFrame):
|
|||
energy_bound : 2-tuple of float, optional
|
||||
Bounds for the energy group.
|
||||
run_kwargs : dict, optional
|
||||
Keyword arguments for :meth:`openmc.model.Model.run()`
|
||||
Keyword arguments passed to :meth:`openmc.model.Model.run`
|
||||
|
||||
Returns
|
||||
-------
|
||||
|
|
|
|||
|
|
@ -1340,6 +1340,8 @@ class EnergyFilter(RealFilter):
|
|||
def from_group_structure(cls, group_structure):
|
||||
"""Construct an EnergyFilter instance from a standard group structure.
|
||||
|
||||
.. versionadded:: 0.13.1
|
||||
|
||||
Parameters
|
||||
----------
|
||||
group_structure : str
|
||||
|
|
|
|||
|
|
@ -463,6 +463,8 @@ class Material(IDManagerMixin):
|
|||
def remove_element(self, element):
|
||||
"""Remove an element from the material
|
||||
|
||||
.. versionadded:: 0.13.1
|
||||
|
||||
Parameters
|
||||
----------
|
||||
element : str
|
||||
|
|
@ -918,7 +920,7 @@ class Material(IDManagerMixin):
|
|||
Returns
|
||||
-------
|
||||
Union[dict, float]
|
||||
If by_nuclide is True then a dictionary whose keys are nuclide
|
||||
If by_nuclide is True then a dictionary whose keys are nuclide
|
||||
names and values are activity is returned. Otherwise the activity
|
||||
of the material is returned as a float.
|
||||
"""
|
||||
|
|
|
|||
|
|
@ -269,6 +269,8 @@ class Region(ABC):
|
|||
inplace : bool
|
||||
Whether or not to return a region based on new surfaces or one based
|
||||
on the original surfaces that have been modified.
|
||||
|
||||
.. versionadded:: 0.13.1
|
||||
memo : dict or None
|
||||
Dictionary used for memoization. This parameter is used internally
|
||||
and should not be specified by the user.
|
||||
|
|
|
|||
|
|
@ -205,6 +205,8 @@ class Discrete(Univariate):
|
|||
def merge(cls, dists, probs):
|
||||
"""Merge multiple discrete distributions into a single distribution
|
||||
|
||||
.. versionadded:: 0.13.1
|
||||
|
||||
Parameters
|
||||
----------
|
||||
dists : iterable of openmc.stats.Discrete
|
||||
|
|
|
|||
|
|
@ -644,6 +644,8 @@ class DAGMCUniverse(UniverseBase):
|
|||
bounding_box : 2-tuple of numpy.array
|
||||
Lower-left and upper-right coordinates of an axis-aligned bounding box
|
||||
of the universe.
|
||||
|
||||
.. versionadded:: 0.13.1
|
||||
"""
|
||||
|
||||
def __init__(self,
|
||||
|
|
@ -726,6 +728,9 @@ class DAGMCUniverse(UniverseBase):
|
|||
def bounding_region(self, bounded_type='box', boundary_type='vacuum', starting_id=10000):
|
||||
"""Creates a either a spherical or box shaped bounding region around
|
||||
the DAGMC geometry.
|
||||
|
||||
.. versionadded:: 0.13.1
|
||||
|
||||
Parameters
|
||||
----------
|
||||
bounded_type : str
|
||||
|
|
@ -740,6 +745,7 @@ class DAGMCUniverse(UniverseBase):
|
|||
Starting ID of the surface(s) used in the region. For bounded_type
|
||||
'box', the next 5 IDs will also be used. Defaults to 10000 to reduce
|
||||
the chance of an overlap of surface IDs with the DAGMC geometry.
|
||||
|
||||
Returns
|
||||
-------
|
||||
openmc.Region
|
||||
|
|
|
|||
|
|
@ -409,7 +409,9 @@ class WeightWindows(IDManagerMixin):
|
|||
|
||||
|
||||
def wwinp_to_wws(path):
|
||||
"""Creates WeightWindows classes from a wwinp file
|
||||
"""Create WeightWindows instances from a wwinp file
|
||||
|
||||
.. versionadded:: 0.13.1
|
||||
|
||||
Parameters
|
||||
----------
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue