Skip to content

Commit

Permalink
Updating MeshFilter and MeshSurfaceFilter docstrings.
Browse files Browse the repository at this point in the history
  • Loading branch information
pshriwise committed Apr 28, 2021
1 parent 933bc22 commit d0353c8
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion openmc/filter.py
Original file line number Diff line number Diff line change
Expand Up @@ -716,6 +716,9 @@ class MeshFilter(Filter):
The mesh object that events will be tallied onto
id : int
Unique identifier for the filter
translation : Iterable of float
This array specifies a vector that is used to translate (shift)
the mesh for this filter
bins : list of tuple
A list of mesh indices for each filter bin, e.g. [(1, 1, 1), (2, 1, 1),
...]
Expand Down Expand Up @@ -789,7 +792,7 @@ def translation(self, t):
if t is not None:
cv.check_type('mesh filter translation', t, Iterable, Real)
cv.check_length('mesh filter translation', t, 3)
self._translation = t
self._translation = np.asarray(t)

def can_merge(self, other):
# Mesh filters cannot have more than one bin
Expand Down Expand Up @@ -892,6 +895,9 @@ class MeshSurfaceFilter(MeshFilter):
The mesh ID
mesh : openmc.MeshBase
The mesh object that events will be tallied onto
translation : Iterable of float
This array specifies a vector that is used to translate (shift)
the mesh for this filter
id : int
Unique identifier for the filter
bins : list of tuple
Expand Down

0 comments on commit d0353c8

Please sign in to comment.