openmc.deplete.abc.ReactionRateHelper

class openmc.deplete.abc.ReactionRateHelper(n_nucs, n_react)[source]

Abstract class for generating reaction rates for operators

Responsible for generating reaction rate tallies for burnable materials, given nuclides and scores from the operator.

Reaction rates are passed back to the operator to be used by an openmc.deplete.OperatorResult instance.

Parameters:

n_nucs (int) – Number of burnable nuclides tracked by openmc.deplete.abc.TransportOperator
n_react (int) – Number of reactions tracked by openmc.deplete.abc.TransportOperator

Variables:

nuclides (list of str) – All nuclides with desired reaction rates.

divide_by_atoms(number: Sequence[float])[source]

Normalize reaction rates by number of atoms

Acts on the current material examined by get_material_rates()

Parameters:: number (iterable of float) – Number of each nuclide in [atom] tracked in the calculation.
Returns:: results – Array of reactions rates of shape (n_nuclides, n_rxns) normalized by the number of nuclides
Return type:: numpy.ndarray

abstractmethod generate_tallies(materials, scores)[source]: Use the C API to build tallies needed for reaction rates

abstractmethod get_material_rates(mat_id: int, nuc_index: Sequence[str], react_index: Sequence[str])[source]

Return 2D array of [nuclide, reaction] reaction rates

Parameters: