solvers Package Documentation

This page contains the solvers Package documentation.

• pysparse Package Documentation
  • The linearCGSSolver Module
  • The linearGMRESSolver Module
  • The linearJORSolver Module
  • The linearLUSolver Module
  • The linearPCGSolver Module
  • The pysparseSolver Module
• trilinos Package Documentation
  • preconditioners Package Documentation
    • The domDecompPreconditioner Module
    • The icPreconditioner Module
    • The jacobiPreconditioner Module
    • The multilevelDDMLPreconditioner Module
    • The multilevelDDPreconditioner Module
    • The multilevelNSSAPreconditioner Module
    • The multilevelSAPreconditioner Module
    • The multilevelSGSPreconditioner Module
    • The multilevelSolverSmootherPreconditioner Module
    • The preconditioner Module
  • The linearBicgstabSolver Module
  • The linearCGSSolver Module
  • The linearGMRESSolver Module
  • The linearLUSolver Module
  • The linearPCGSolver Module
  • The trilinosAztecOOSolver Module
  • The trilinosMLTest Module
  • The trilinosSolver Module

The solver Module

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

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

Bases: fipy.solvers.solver.PreconditionerWarning

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

Bases: fipy.solvers.solver.SolverConvergenceWarning

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

Bases: fipy.solvers.solver.SolverConvergenceWarning

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

Bases: fipy.solvers.solver.PreconditionerWarning

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

Bases: fipy.solvers.solver.SolverConvergenceWarning

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

Bases: fipy.solvers.solver.SolverConvergenceWarning

class fipy.solvers.solver.Solver(tolerance=1e-10, iterations=1000, steps=None, precon=None)

The base LinearXSolver class.

Attention

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

Create a Solver object.

Parameters :

• tolerance: The required error tolerance.
• iterations: The maximum number of iterative steps to perform.
• steps: A deprecated name for iterations.
• precon: Preconditioner to use. This parameter is only available for Trilinos solvers.

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

Bases: exceptions.Warning

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

Bases: fipy.solvers.solver.SolverConvergenceWarning

The test Module