mirror of
https://github.com/openmc-dev/openmc.git
synced 2026-07-29 06:35:48 -04:00
Add versionadded directive for new arguments/functions in 0.12
This commit is contained in:
parent
5012c6b0ce
commit
5547ecf88f
20 changed files with 107 additions and 7 deletions
|
|
@ -68,6 +68,8 @@ def _future_kwargs_warning_helper(cls, *args, **kwargs):
|
|||
def get_rotation_matrix(rotation, order='xyz'):
|
||||
r"""Generate a 3x3 rotation matrix from input angles
|
||||
|
||||
.. versionadded:: 0.12
|
||||
|
||||
Parameters
|
||||
----------
|
||||
rotation : 3-tuple of float
|
||||
|
|
@ -266,6 +268,8 @@ class Surface(IDManagerMixin, ABC):
|
|||
def normalize(self, coeffs=None):
|
||||
"""Normalize coefficients by first nonzero value
|
||||
|
||||
.. versionadded:: 0.12
|
||||
|
||||
Parameters
|
||||
----------
|
||||
coeffs : tuple, optional
|
||||
|
|
@ -347,6 +351,8 @@ class Surface(IDManagerMixin, ABC):
|
|||
def rotate(self, rotation, pivot=(0., 0., 0.), order='xyz', inplace=False):
|
||||
r"""Rotate surface by angles provided or by applying matrix directly.
|
||||
|
||||
.. versionadded:: 0.12
|
||||
|
||||
Parameters
|
||||
----------
|
||||
rotation : 3-tuple of float, or 3x3 iterable
|
||||
|
|
@ -1223,6 +1229,8 @@ class Cylinder(QuadricMixin, Surface):
|
|||
def from_points(cls, p1, p2, r=1., **kwargs):
|
||||
"""Return a cylinder given points that define the axis and a radius.
|
||||
|
||||
.. versionadded:: 0.12
|
||||
|
||||
Parameters
|
||||
----------
|
||||
p1, p2 : 3-tuples
|
||||
|
|
@ -2294,6 +2302,8 @@ class Halfspace(Region):
|
|||
memo=None):
|
||||
r"""Rotate surface by angles provided or by applying matrix directly.
|
||||
|
||||
.. versionadded:: 0.12
|
||||
|
||||
Parameters
|
||||
----------
|
||||
rotation : 3-tuple of float, or 3x3 iterable
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue