crp/OpenMC
1
0
Fork 0
mirror of https://github.com/openmc-dev/openmc.git synced 2026-07-29 06:35:48 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

reverted simplifying Plane constructor and default args

Browse source
This commit is contained in:
Ethan Peterson 2020-02-18 10:08:22 -05:00
parent 35fb12b361
commit 2332a679fa
2 changed files with 25 additions and 74 deletions
Download patch file Download diff file Expand all files Collapse all files

98
openmc/surface.py
View file

@ -203,7 +203,7 @@ class Surface(IDManagerMixin, metaclass=ABCMeta):
coeffs = self._get_base_coeffs()
coeffs = np.asarray(coeffs)
nonzeros = ~np.isclose(coeffs, 0., rtol=0., atol=self._atol)
norm_factor = coeffs[nonzeros][0]
norm_factor = np.abs(coeffs[nonzeros][0])
return tuple([c/norm_factor for c in coeffs])
def is_equal(self, other):
@ -410,9 +410,9 @@ class Plane(PlaneMixin, Surface):
a : float, optional
The 'A' parameter for the plane. Defaults to 1.
b : float, optional
The 'B' parameter for the plane. Defaults to 1.
The 'B' parameter for the plane. Defaults to 0.
c : float, optional
The 'C' parameter for the plane. Defaults to 1.
The 'C' parameter for the plane. Defaults to 0.
d : float, optional
The 'D' parameter for the plane. Defaults to 0.
boundary_type : {'transmission, 'vacuum', 'reflective', 'white'}, optional
@ -455,82 +455,34 @@ class Plane(PlaneMixin, Surface):
_type = 'plane'
_coeff_keys = ('a', 'b', 'c', 'd')
def __new__(cls, *args, **kwargs):
# Intercept Plane creation to return a simpler form if warranted
new_cls, kwargs = cls._process_args(*args, **kwargs)
obj = super().__new__(new_cls)
if new_cls is not cls:
obj.__init__(**kwargs)
return obj
def __init__(self, a=1., b=1., c=1., d=0., *args, **kwargs):
super().__init__(**kwargs)
for key, val in zip(self._coeff_keys, (a, b, c, d)):
setattr(self, key, val)
@classmethod
def _process_args(cls, *args, **kwargs):
""" Process arguments to Plane class to determine which type of Plane
should be instantiated.
Returns
-------
tuple : tuple of type and dict
Returns a tuple where the first element is the class (XPlane,
YPlane, ZPlane, or Plane) that should be instantiated. The second
element is the dictionary of keyword arguments that should be
passed to that object's constructor.
"""
def __init__(self, a=1., b=0., c=0., d=0., *args, **kwargs):
# *args should ultimately be limited to a, b, c, d as specified in
# __init__, but to preserve the API it is allowed to accept Surface
# parameters for now, but will raise warnings if this is done.
argtup = ('a', 'b', 'c', 'd', 'boundary_type', 'name', 'surface_id')
kwargs.update(dict(zip(argtup, args)))
# Warn if Surface parameters are passed by position, not by keyword
superkwargs = {}
for k in ('boundary_type', 'name', 'surface_id'):
val = kwargs.get(k, None)
if val is not None:
superkwargs[k] = val
warn(_WARNING_KWARGS.format(type(self), k),
FutureWarning)
super().__init__(**superkwargs)
for key, val in zip(self._coeff_keys, (a, b, c, d)):
setattr(self, key, val)
# Warn if capital letter arguments are passed
for k in 'ABCD':
val = kwargs.pop(k, None)
if val is not None:
warn(_WARNING_UPPER.format(cls.__name__, k.lower(), k),
warn(_WARNING_UPPER.format(type(self), k.lower(), k),
FutureWarning)
kwargs[k.lower()] = val
# Warn if Surface parameters are passed by position, not by keyword
for k in ('boundary_type', 'name', 'surface_id'):
val = kwargs.get(k, None)
if val is not None:
warn(_WARNING_KWARGS.format(cls.__name__, k),
FutureWarning)
# Determine if a simpler version of a Plane should be returned and
# modify kwargs accordingly
a = kwargs.get('a', 1.)
b = kwargs.get('b', 1.)
c = kwargs.get('c', 1.)
# If two of a, b, or c are zero, a simpler version should be returned
if np.sum(np.isclose((a, b, c), 0., rtol=0., atol=cls._atol)) >= 2:
a = kwargs.pop('a', 1.)
b = kwargs.pop('b', 1.)
c = kwargs.pop('c', 1.)
d = kwargs.pop('d', 0.)
# Return XPlane class and kwargs
if ~np.isclose(a, 0.0, rtol=0., atol=cls._atol):
kwargs['x0'] = d/a
return XPlane, kwargs
# Return YPlane class and kwargs
elif ~np.isclose(b, 0.0, rtol=0., atol=cls._atol):
kwargs['y0'] = d/b
return YPlane, kwargs
# Return ZPlane class and kwargs
elif ~np.isclose(c, 0.0, rtol=0., atol=cls._atol):
kwargs['z0'] = d/c
return ZPlane, kwargs
else:
# Return Plane class and kwargs
return cls, kwargs
setattr(self, k.lower(), val)
@property
def a(self):
@ -729,9 +681,8 @@ class YPlane(PlaneMixin, Surface):
def __init__(self, y0=0., *args, **kwargs):
# work around for accepting Surface kwargs as positional parameters
# until they are deprecated
argsdict = {k: v for k, v in zip(('boundary_type', 'name',
'surface_id'), args)}
for k, v in argsdict.items():
argsdict = dict(zip(('boundary_type', 'name', 'surface_id'), args))
for k in argsdict.keys():
warn(_WARNING_KWARGS.format(type(self).__name__, k), FutureWarning)
kwargs.update(argsdict)
@ -810,9 +761,8 @@ class ZPlane(PlaneMixin, Surface):
def __init__(self, z0=0., *args, **kwargs):
# work around for accepting Surface kwargs as positional parameters
# until they are deprecated
argsdict = {k: v for k, v in zip(('boundary_type', 'name',
'surface_id'), args)}
for k, v in argsdict.items():
argsdict = dict(zip(('boundary_type', 'name', 'surface_id'), args))
for k in argsdict.keys():
warn(_WARNING_KWARGS.format(type(self).__name__, k), FutureWarning)
kwargs.update(argsdict)

1
tests/regression_tests/deplete/example_geometry.py
View file

@ -188,6 +188,7 @@ def segment_pin(n_rings, n_wedges, r_fuel, r_gap, r_clad):
fuel_wedges = [openmc.Plane(a=math.cos(theta[i]), b=math.sin(theta[i]))
for i in range(n_wedges)]
print(fuel_wedges)
gap_ring = openmc.ZCylinder(x0=0, y0=0, r=r_gap)
clad_ring = openmc.ZCylinder(x0=0, y0=0, r=r_clad)