fipy.solvers.scipy package

Submodules

fipy.solvers.scipy.linearBicgstabSolver module

class fipy.solvers.scipy.linearBicgstabSolver.LinearBicgstabSolver(tolerance=1e-15, iterations=2000, precon=None)

Bases: _ScipyKrylovSolver

The LinearBicgstabSolver is an interface to the Bicgstab solver in Scipy, with no preconditioning by default.

Parameters:
  • tolerance (float) – Required error tolerance.

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

  • precon – Preconditioner to use.

__enter__()
__exit__(exc_type, exc_value, traceback)
__repr__()

Return repr(self).

fipy.solvers.scipy.linearCGSSolver module

class fipy.solvers.scipy.linearCGSSolver.LinearCGSSolver(tolerance=1e-15, iterations=2000, precon=None)

Bases: _ScipyKrylovSolver

The LinearCGSSolver is an interface to the CGS solver in Scipy, with no preconditioning by default.

Parameters:
  • tolerance (float) – Required error tolerance.

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

  • precon – Preconditioner to use.

__enter__()
__exit__(exc_type, exc_value, traceback)
__repr__()

Return repr(self).

fipy.solvers.scipy.linearGMRESSolver module

class fipy.solvers.scipy.linearGMRESSolver.LinearGMRESSolver(tolerance=1e-15, iterations=2000, precon=None)

Bases: _ScipyKrylovSolver

The LinearGMRESSolver is an interface to the GMRES solver in Scipy, with no preconditioning by default.

Parameters:
  • tolerance (float) – Required error tolerance.

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

  • precon – Preconditioner to use.

__enter__()
__exit__(exc_type, exc_value, traceback)
__repr__()

Return repr(self).

fipy.solvers.scipy.linearLUSolver module

class fipy.solvers.scipy.linearLUSolver.LinearLUSolver(tolerance=1e-10, iterations=1000, precon=None)

Bases: _ScipySolver

The LinearLUSolver solves a linear system of equations using LU-factorization. The LinearLUSolver is a wrapper class for the the Scipy scipy.sparse.linalg.splu module.

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.

__enter__()
__exit__(exc_type, exc_value, traceback)
__repr__()

Return repr(self).

fipy.solvers.scipy.linearPCGSolver module

class fipy.solvers.scipy.linearPCGSolver.LinearPCGSolver(tolerance=1e-15, iterations=2000, precon=None)

Bases: _ScipyKrylovSolver

The LinearPCGSolver is an interface to the CG solver in Scipy, with no preconditioning by default.

Parameters:
  • tolerance (float) – Required error tolerance.

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

  • precon – Preconditioner to use.

__enter__()
__exit__(exc_type, exc_value, traceback)
__repr__()

Return repr(self).

fipy.solvers.scipy.scipyKrylovSolver module

fipy.solvers.scipy.scipySolver module

Module contents

fipy.solvers.scipy.DefaultAsymmetricSolver

alias of LinearLUSolver

fipy.solvers.scipy.DefaultSolver

alias of LinearLUSolver

fipy.solvers.scipy.DummySolver

alias of LinearGMRESSolver

fipy.solvers.scipy.GeneralSolver

alias of LinearLUSolver

class fipy.solvers.scipy.LinearBicgstabSolver(tolerance=1e-15, iterations=2000, precon=None)

Bases: _ScipyKrylovSolver

The LinearBicgstabSolver is an interface to the Bicgstab solver in Scipy, with no preconditioning by default.

Parameters:
  • tolerance (float) – Required error tolerance.

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

  • precon – Preconditioner to use.

__enter__()
__exit__(exc_type, exc_value, traceback)
__repr__()

Return repr(self).

class fipy.solvers.scipy.LinearCGSSolver(tolerance=1e-15, iterations=2000, precon=None)

Bases: _ScipyKrylovSolver

The LinearCGSSolver is an interface to the CGS solver in Scipy, with no preconditioning by default.

Parameters:
  • tolerance (float) – Required error tolerance.

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

  • precon – Preconditioner to use.

__enter__()
__exit__(exc_type, exc_value, traceback)
__repr__()

Return repr(self).

class fipy.solvers.scipy.LinearGMRESSolver(tolerance=1e-15, iterations=2000, precon=None)

Bases: _ScipyKrylovSolver

The LinearGMRESSolver is an interface to the GMRES solver in Scipy, with no preconditioning by default.

Parameters:
  • tolerance (float) – Required error tolerance.

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

  • precon – Preconditioner to use.

__enter__()
__exit__(exc_type, exc_value, traceback)
__repr__()

Return repr(self).

class fipy.solvers.scipy.LinearLUSolver(tolerance=1e-10, iterations=1000, precon=None)

Bases: _ScipySolver

The LinearLUSolver solves a linear system of equations using LU-factorization. The LinearLUSolver is a wrapper class for the the Scipy scipy.sparse.linalg.splu module.

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.

__enter__()
__exit__(exc_type, exc_value, traceback)
__repr__()

Return repr(self).

class fipy.solvers.scipy.LinearPCGSolver(tolerance=1e-15, iterations=2000, precon=None)

Bases: _ScipyKrylovSolver

The LinearPCGSolver is an interface to the CG solver in Scipy, with no preconditioning by default.

Parameters:
  • tolerance (float) – Required error tolerance.

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

  • precon – Preconditioner to use.

__enter__()
__exit__(exc_type, exc_value, traceback)
__repr__()

Return repr(self).

Last updated on Jun 15, 2022. Created using Sphinx 5.0.1.