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, iterations, precon])

The base LinearXSolver class.

Exceptions

IllConditionedPreconditionerWarning(solver, ...)
MatrixIllConditionedWarning(solver, iter, relres)
MaximumIterationWarning(solver, iter, relres)
PreconditionerNotPositiveDefiniteWarning(...)
PreconditionerWarning(solver, iter, relres)
ScalarQuantityOutOfRangeWarning(solver, ...)
SolverConvergenceWarning(solver, iter, relres)
StagnatedSolverWarning(solver, iter, relres)

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.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.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=1e-10, iterations=1000, precon=None)

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 error tolerance.

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

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

__repr__()

Return repr(self).

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.