fipy.solvers.solver

The iterative solvers may output warnings if the solution is considered unsatisfactory. If you are not interested in these warnings, you can invoke python with a warning filter such as:

$ python -Wignore::fipy.SolverConvergenceWarning myscript.py

If you are extremely concerned about your preconditioner for some reason, you can abort whenever it has problems with:

$ python -Werror::fipy.PreconditionerWarning myscript.py

Classes

Solver([tolerance, criterion, iterations, ...])

The base LinearXSolver class.

Exceptions

BreakdownWarning(solver, iter, relres)
IllConditionedPreconditionerWarning(solver, ...)
IllegalInputOrBreakdownWarning(solver, iter, ...)
LossOfPrecisionWarning(solver, iter, relres)
MatrixIllConditionedWarning(solver, iter, relres)
MaximumIterationWarning(solver, iter, relres)
NormalConvergence(solver, iter, relres)
ParameterWarning(solver, iter, relres)
PreconditionerNotPositiveDefiniteWarning(...)
PreconditionerWarning(solver, iter, relres)
ScalarQuantityOutOfRangeWarning(solver, ...)
SolverConvergenceWarning(solver, iter, relres)
StagnatedSolverWarning(solver, iter, relres)

exception fipy.solvers.solver.BreakdownWarning(solver, iter, relres)

Bases: SolverConvergenceWarning

__cause__

exception cause

__context__

exception context

__delattr__(name, /)

Implement delattr(self, name).

__getattribute__(name, /)

Return getattr(self, name).

__reduce__()

Helper for pickle.

__repr__()

Return repr(self).

__setattr__(name, value, /)

Implement setattr(self, name, value).

__str__()

Return str(self).

add_note()

Exception.add_note(note) – add a note to the exception

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception fipy.solvers.solver.IllConditionedPreconditionerWarning(solver, iter, relres)

Bases: PreconditionerWarning

__cause__

exception cause

__context__

exception context

__delattr__(name, /)

Implement delattr(self, name).

__getattribute__(name, /)

Return getattr(self, name).

__reduce__()

Helper for pickle.

__repr__()

Return repr(self).

__setattr__(name, value, /)

Implement setattr(self, name, value).

__str__()

Return str(self).

add_note()

Exception.add_note(note) – add a note to the exception

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception fipy.solvers.solver.IllegalInputOrBreakdownWarning(solver, iter, relres)

Bases: SolverConvergenceWarning

__cause__

exception cause

__context__

exception context

__delattr__(name, /)

Implement delattr(self, name).

__getattribute__(name, /)

Return getattr(self, name).

__reduce__()

Helper for pickle.

__repr__()

Return repr(self).

__setattr__(name, value, /)

Implement setattr(self, name, value).

__str__()

Return str(self).

add_note()

Exception.add_note(note) – add a note to the exception

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception fipy.solvers.solver.LossOfPrecisionWarning(solver, iter, relres)

Bases: SolverConvergenceWarning

__cause__

exception cause

__context__

exception context

__delattr__(name, /)

Implement delattr(self, name).

__getattribute__(name, /)

Return getattr(self, name).

__reduce__()

Helper for pickle.

__repr__()

Return repr(self).

__setattr__(name, value, /)

Implement setattr(self, name, value).

__str__()

Return str(self).

add_note()

Exception.add_note(note) – add a note to the exception

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception fipy.solvers.solver.MatrixIllConditionedWarning(solver, iter, relres)

Bases: SolverConvergenceWarning

__cause__

exception cause

__context__

exception context

__delattr__(name, /)

Implement delattr(self, name).

__getattribute__(name, /)

Return getattr(self, name).

__reduce__()

Helper for pickle.

__repr__()

Return repr(self).

__setattr__(name, value, /)

Implement setattr(self, name, value).

__str__()

Return str(self).

add_note()

Exception.add_note(note) – add a note to the exception

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception fipy.solvers.solver.MaximumIterationWarning(solver, iter, relres)

Bases: SolverConvergenceWarning

__cause__

exception cause

__context__

exception context

__delattr__(name, /)

Implement delattr(self, name).

__getattribute__(name, /)

Return getattr(self, name).

__reduce__()

Helper for pickle.

__repr__()

Return repr(self).

__setattr__(name, value, /)

Implement setattr(self, name, value).

__str__()

Return str(self).

add_note()

Exception.add_note(note) – add a note to the exception

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception fipy.solvers.solver.NormalConvergence(solver, iter, relres)

Bases: SolverConvergenceWarning

__cause__

exception cause

__context__

exception context

__delattr__(name, /)

Implement delattr(self, name).

__getattribute__(name, /)

Return getattr(self, name).

__reduce__()

Helper for pickle.

__repr__()

Return repr(self).

__setattr__(name, value, /)

Implement setattr(self, name, value).

__str__()

Return str(self).

add_note()

Exception.add_note(note) – add a note to the exception

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception fipy.solvers.solver.ParameterWarning(solver, iter, relres)

Bases: SolverConvergenceWarning

__cause__

exception cause

__context__

exception context

__delattr__(name, /)

Implement delattr(self, name).

__getattribute__(name, /)

Return getattr(self, name).

__reduce__()

Helper for pickle.

__repr__()

Return repr(self).

__setattr__(name, value, /)

Implement setattr(self, name, value).

__str__()

Return str(self).

add_note()

Exception.add_note(note) – add a note to the exception

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception fipy.solvers.solver.PreconditionerNotPositiveDefiniteWarning(solver, iter, relres)

Bases: PreconditionerWarning

__cause__

exception cause

__context__

exception context

__delattr__(name, /)

Implement delattr(self, name).

__getattribute__(name, /)

Return getattr(self, name).

__reduce__()

Helper for pickle.

__repr__()

Return repr(self).

__setattr__(name, value, /)

Implement setattr(self, name, value).

__str__()

Return str(self).

add_note()

Exception.add_note(note) – add a note to the exception

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception fipy.solvers.solver.PreconditionerWarning(solver, iter, relres)

Bases: SolverConvergenceWarning

__cause__

exception cause

__context__

exception context

__delattr__(name, /)

Implement delattr(self, name).

__getattribute__(name, /)

Return getattr(self, name).

__reduce__()

Helper for pickle.

__repr__()

Return repr(self).

__setattr__(name, value, /)

Implement setattr(self, name, value).

__str__()

Return str(self).

add_note()

Exception.add_note(note) – add a note to the exception

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception fipy.solvers.solver.ScalarQuantityOutOfRangeWarning(solver, iter, relres)

Bases: SolverConvergenceWarning

__cause__

exception cause

__context__

exception context

__delattr__(name, /)

Implement delattr(self, name).

__getattribute__(name, /)

Return getattr(self, name).

__reduce__()

Helper for pickle.

__repr__()

Return repr(self).

__setattr__(name, value, /)

Implement setattr(self, name, value).

__str__()

Return str(self).

add_note()

Exception.add_note(note) – add a note to the exception

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

class fipy.solvers.solver.Solver(tolerance='default', criterion='default', iterations='default', precon='default')

Bases: object

The base LinearXSolver class.

Attention

This class is abstract. Always create one of its subclasses.

Create a Solver object.

Parameters:

• tolerance (float) – Required residual tolerance.

• criterion ({'default', 'initial', 'unscaled', 'RHS', 'matrix', 'solution', 'preconditioned', 'natural', 'legacy'}, optional) – Interpretation of tolerance. See Convergence for more information.

• iterations (int) – Maximum number of iterative steps to perform.

• precon (Preconditioner) – Preconditioner to use. Not all solver suites support preconditioners.

DEFAULT_ITERATIONS = 1000

Default maximum number of iterative steps to perform

DEFAULT_PRECONDITIONER = None

Default preconditioner to apply to the matrix

DEFAULT_TOLERANCE = 1e-05

Default tolerance for linear solves unless criterion=”legacy”

LEGACY_TOLERANCE = 1e-10

Default tolerance for linear solves if criterion=”legacy”

__repr__()

Return repr(self).

property default_tolerance

Default tolerance for linear solve

exception fipy.solvers.solver.SolverConvergenceWarning(solver, iter, relres)

Bases: Warning

__cause__

exception cause

__context__

exception context

__delattr__(name, /)

Implement delattr(self, name).

__getattribute__(name, /)

Return getattr(self, name).

__reduce__()

Helper for pickle.

__repr__()

Return repr(self).

__setattr__(name, value, /)

Implement setattr(self, name, value).

__str__()

Return str(self).

add_note()

Exception.add_note(note) – add a note to the exception

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception fipy.solvers.solver.StagnatedSolverWarning(solver, iter, relres)

Bases: SolverConvergenceWarning

__cause__

exception cause

__context__

exception context

__delattr__(name, /)

Implement delattr(self, name).

__getattribute__(name, /)

Return getattr(self, name).

__reduce__()

Helper for pickle.

__repr__()

Return repr(self).

__setattr__(name, value, /)

Implement setattr(self, name, value).

__str__()

Return str(self).

add_note()

Exception.add_note(note) – add a note to the exception

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

Last updated on Jun 26, 2024. Created using Sphinx 7.1.2.