mufem.SteadyRunner

class mufem.SteadyRunner

Bases: RunnerTrait

Steady runner class implementing the steady-state simulation.

Parameters:

total_iterations (int) – Total number of iterations for the simulation.

__init__(self: mufem.SteadyRunner, total_iterations: int) → None

Methods

__init__(self, total_iterations)
advance(self[, iterations])	Advance the simulation by a given number of iterations.
get_total_iterations(self)	Get the total number of iterations.
run(self)	Run the steady-state simulation.

advance(self: mufem.SteadyRunner, iterations: int = 1) → None

Advance the simulation by a given number of iterations.

Parameters:

iterations (int, optional) – Number of iterations to advance. Defaults to 1.

get_total_iterations(self: mufem.SteadyRunner) → int

Get the total number of iterations.

Returns:

Total number of iterations configured for the runner.

Return type:

int

run(self: mufem.SteadyRunner) → None

Run the steady-state simulation.