Adding alias for CellbornFilter in the Python API

This commit is contained in:
Patrick Shriwise 2022-11-09 17:34:05 -06:00
parent aaaff62135
commit 5e7f3f7efd

View file

@ -533,7 +533,7 @@ class CellFromFilter(WithIDFilter):
expected_type = Cell
class CellbornFilter(WithIDFilter):
class CellBornFilter(WithIDFilter):
"""Bins tally events based on which cell the particle was born in.
Parameters
@ -557,6 +557,14 @@ class CellbornFilter(WithIDFilter):
expected_type = Cell
# Temporary alias for CellbornFilter
def CellbornFilter(*args, **kwargs):
warnings.warn('The name of "CellbornFilter" has changed to '
'"CellBornFilter". "CellbornFilter" will be '
'removed in the future.')
return CellBornFilter(*args, **kwargs)
class CellInstanceFilter(Filter):
"""Bins tally events based on which cell instance a particle is in.