fipy.steppers

(Obsolete) utilities for iterating time steps

Use steppyngstounes instead.

fipy.steppers.L1error(*args, **kwds)

Deprecated since version 4.0: Calculate error explicitly with L1norm.

\[\frac{\|\mathtt{var} - \mathtt{var}^\text{old}\|_1} {\|\mathtt{var}^\text{old}\|_1}\]

where \(\|\vec{x}\|_1\) is the \(L^1\) norm of \(\vec{x}\).

Parameters:

• var (CellVariable) – The CellVariable in question.

• matrix – (ignored)

• RHSvector – (ignored)

fipy.steppers.L2error(*args, **kwds)

Deprecated since version 4.0: Calculate error explicitly with L2norm.

\[\frac{\|\mathtt{var} - \mathtt{var}^\text{old}\|_2} {\|\mathtt{var}^\text{old}\|_2}\]

where \(\|\vec{x}\|_2\) is the \(L^2\) norm of \(\vec{x}\).

Parameters:

• var (CellVariable) – The CellVariable in question.

• matrix – (ignored)

• RHSvector – (ignored)

fipy.steppers.LINFerror(*args, **kwds)

Deprecated since version 4.0: Calculate error explicitly with LINFnorm.

\[\frac{\|\mathtt{var} - \mathtt{var}^\text{old}\|_\infty} {\|\mathtt{var}^\text{old}\|_\infty}\]

where \(\|\vec{x}\|_\infty\) is the \(L^\infty\) norm of \(\vec{x}\).

Parameters:

• var (CellVariable) – The CellVariable in question.

• matrix – (ignored)

• RHSvector – (ignored)

fipy.steppers.error(*args, **kwds)

Deprecated since version 4.0: Calculate error explicitly with numerix.

\[\frac{\|\mathtt{var} - \mathtt{var}^\text{old}\|_?} {\|\mathtt{var}^\text{old}\|_?}\]

where \(\|\vec{x}\|_?\) is the normalization of \(\vec{x}\) provided by norm().

Parameters:

• var (CellVariable) – The CellVariable in question.

• matrix – (ignored)

• RHSvector – (ignored)

• norm (function) – A function that will normalize its array argument and return a single number (default: L1norm()).

fipy.steppers.residual(*args, **kwds)

Deprecated since version 4.0: Pass a residualFn to sweep().

Determines the residual for the current solution matrix and variable.

\[\|\mathsf{L}\vec{x} - \vec{b}\|_\infty\]

where \(\|\vec{\xi}\|_\infty\) is the \(L^\infty\) norm of \(\vec{\xi}\).

Parameters:

• var (CellVariable) – The CellVariable in question, prior to solution.

• matrix (_SparseMatrix) – The coefficient matrix at this step/sweep

• RHSvector (ndarray) – The right hand side vector

fipy.steppers.sweepMonotonic(*args, **kwds)

Deprecated since version 4.0: Use the steppyngstounes package instead.

Repeatedly calls fn(*args, **kwargs)() until the residual returned by fn() is no longer decreasing.

Parameters:

• fn (function) – The function to call

• *args –

• **kwargs –

Return type:

float

Modules

fipy.steppers.pidStepper
fipy.steppers.pseudoRKQSStepper
fipy.steppers.stepper

Last updated on Sep 16, 2025. Created using Sphinx 7.1.2.