renaming func_args into matrix_args, fixing docstring accordingly

This commit is contained in:
Baptiste Mouginot 2023-02-16 14:50:23 +01:00
parent 5f5c0ed7a7
commit a25bbc250f

View file

@ -15,7 +15,7 @@ USE_MULTIPROCESSING = True
NUM_PROCESSES = None
def deplete(func, chain, x, rates, dt, matrix_func=None, *func_args):
def deplete(func, chain, x, rates, dt, matrix_func=None, *matrix_args):
"""Deplete materials using given reaction rates for a specified time
Parameters
@ -37,8 +37,8 @@ def deplete(func, chain, x, rates, dt, matrix_func=None, *func_args):
``fission_yields = {parent: {product: yield_frac}}``
Expected to return the depletion matrix required by
``func``
func_args : dict
Remaining keyword arguments passed to matrix_func when used
matrix_args : Any, optional
Additional arguments passed to matrix_func
Returns
-------
@ -60,7 +60,7 @@ def deplete(func, chain, x, rates, dt, matrix_func=None, *func_args):
matrices = map(chain.form_matrix, rates, fission_yields)
else:
matrices = map(matrix_func, repeat(chain), rates, fission_yields,
*func_args)
*matrix_args)
inputs = zip(matrices, x, repeat(dt))