openmc.EnergyFunctionFilter

class openmc.EnergyFunctionFilter(energy, y, interpolation='linear-linear', filter_id=None)[source]

Multiplies tally scores by an arbitrary function of incident energy.

The arbitrary function is described by a piecewise linear-linear interpolation of energy and y values. Values outside of the given energy range will be evaluated as zero.

Parameters:

energy (Iterable of Real) – A grid of energy values in [eV]
y (iterable of Real) – A grid of interpolant values in [eV]
interpolation (str) – Interpolation scheme: {‘histogram’, ‘linear-linear’, ‘linear-log’, ‘log-linear’, ‘log-log’, ‘quadratic’, ‘cubic’}
filter_id (int) – Unique identifier for the filter

Variables:

energy (Iterable of Real) – A grid of energy values in [eV]
y (iterable of Real) – A grid of interpolant values in [eV]
interpolation (str) – Interpolation scheme: {‘histogram’, ‘linear-linear’, ‘linear-log’, ‘log-linear’, ‘log-log’, ‘quadratic’, ‘cubic’}
id (int) – Unique identifier for the filter
num_bins (Integral) – The number of filter bins (always 1 for this filter)

can_merge(other)[source]

Determine if filter can be merged with another.

Parameters:: other (openmc.Filter) – Filter to compare with
Returns:: Whether the filter can be merged
Return type:: bool

classmethod from_hdf5(group, **kwargs)[source]

Construct a new Filter instance from HDF5 data.

Parameters:: group (h5py.Group) – HDF5 group to read from
Keyword Arguments:: meshes (dict) – Dictionary mapping integer IDs to openmc.MeshBase objects. Only used for openmc.MeshFilter objects.

classmethod from_tabulated1d(tab1d)[source]

Construct a filter from a Tabulated1D object.

Parameters:: tab1d (openmc.data.Tabulated1D) – A linear-linear Tabulated1D object with only a single interpolation region.
Return type:: EnergyFunctionFilter

classmethod from_xml_element(elem, **kwargs)[source]

Generate a filter from an XML element

Parameters:

elem (lxml.etree._Element) – XML element
**kwargs – Keyword arguments (e.g., mesh information)

Returns:

Filter object

Return type:

openmc.Filter

get_bin_index(filter_bin)[source]

Returns the index in the Filter for some bin.

Parameters:: filter_bin (int or tuple) – The bin is the integer ID for ‘material’, ‘surface’, ‘cell’, ‘cellborn’, and ‘universe’ Filters. The bin is an integer for the cell instance ID for ‘distribcell’ Filters. The bin is a 2-tuple of floats for ‘energy’ and ‘energyout’ filters corresponding to the energy boundaries of the bin of interest. The bin is an (x,y,z) 3-tuple for ‘mesh’ filters corresponding to the mesh cell of interest.
Returns:: filter_index – The index in the Tally data array for this filter bin.
Return type:: int

get_pandas_dataframe(data_size, stride, **kwargs)[source]

Builds a Pandas DataFrame for the Filter’s bins.

This method constructs a Pandas DataFrame object for the filter with columns annotated by filter bin information. This is a helper method for Tally.get_pandas_dataframe().

Parameters:

data_size (int) – The total number of bins in the tally corresponding to this filter
stride (int) – Stride in memory for the filter

Returns:

A Pandas DataFrame with a column that is filled with a hash of this filter. EnergyFunctionFilters have only 1 bin so the purpose of this DataFrame column is to differentiate the filter from other EnergyFunctionFilters. The number of rows in the DataFrame is the same as the total number of bins in the corresponding tally.

Return type:

pandas.DataFrame