flow.steady.SteadyOptions

flow.steady.SteadyOptions(
    max_steps=20000,
    tol=1e-07,
    check_every=50,
    adjoint_solver='gmres',
    adjoint_tol=1e-08,
    adjoint_max_steps=400,
    adjoint_restart=30,
)

Convergence settings for the forward iteration and the adjoint solve.

Attributes

Name	Type	Description
max_steps	int	Cap on pseudo-time steps. Reaching it is not an error; :func:residual_history is how a caller checks convergence.
tol	float	Relative change in the populations, per step, below which the iteration stops.
check_every	int	Steps run between residual checks. The check costs a full reduction, so amortising it over a chunk is worth more than stopping a few steps earlier.
adjoint_solver	str	"gmres" or "fixed_point".
adjoint_tol	float	Convergence tolerance for the adjoint solve.
adjoint_max_steps	int	Iteration cap for the adjoint solve.
adjoint_restart	int	Krylov subspace size for "gmres".