iterable_step

iterable_step

sorts.simulation.iterable_step(iterable, MPI=False, log=False, reduce=None)[source]

Simulation step iteration decorator.

Parameters

  • iterable (str/list) – The name/list of names of the instance properties (fetched using getattr) to iterate over. Can be multiple levels, e.g. object.subobject.a_list.

  • MPI (bool) – Determines if the iteration should be MPI-parallelized

  • log (bool) – Use the self.logger instance, if it exists, to log the execution of the iteration.

  • reduce (function) – A pointer to the binary-function used to reduce the results.