openmc.deplete.pool.deplete

openmc.deplete.pool.deplete(func, chain, n, rates, dt, current_timestep=None, matrix_func=None, transfer_rates=None, external_source_rates=None, *matrix_args)[source]

Deplete materials using given reaction rates for a specified time

Parameters:
  • func (callable) – Function to use to get new compositions. Expected to have the signature func(A, n0, t) -> n1

  • chain (openmc.deplete.Chain) – Depletion chain

  • n (list of numpy.ndarray) – List of atom number arrays for each material. Each array in the list contains the number of [atom] of each nuclide.

  • rates (openmc.deplete.ReactionRates) – Reaction rates (from transport operator)

  • dt (float) – Time in [s] to deplete for

  • current_timestep (int) – Current timestep index

  • maxtrix_func (callable, optional) – Function to form the depletion matrix after calling matrix_func(chain, rates, fission_yields), where fission_yields = {parent: {product: yield_frac}} Expected to return the depletion matrix required by func

  • transfer_rates (openmc.deplete.TransferRates, Optional) –

    Transfer rates for continuous removal/feed.

    Added in version 0.14.0.

  • external_source_rates (openmc.deplete.ExternalSourceRates, Optional) –

    External source rates for continuous removal/feed.

    Added in version 0.15.3.

  • matrix_args (Any, optional) – Additional arguments passed to matrix_func

Returns:

n_result – Updated list of atom number arrays for each material. Each array in the list contains the number of [atom] of each nuclide.

Return type:

list of numpy.ndarray