fipy.solvers.pyAMG package

Submodules

fipy.solvers.pyAMG.linearCGSSolver module

class fipy.solvers.pyAMG.linearCGSSolver.LinearCGSSolver(tolerance=1e-15, iterations=2000, precon=<fipy.solvers.pyAMG.preconditioners.smoothedAggregationPreconditioner.SmoothedAggregationPreconditioner object>)

Bases: fipy.solvers.scipy.linearCGSSolver.LinearCGSSolver

The LinearCGSSolver is an interface to the CGS solver in Scipy, using the PyAMG SmoothedAggregationPreconditioner by default.

Parameters
__init__(tolerance=1e-15, iterations=2000, precon=<fipy.solvers.pyAMG.preconditioners.smoothedAggregationPreconditioner.SmoothedAggregationPreconditioner object>)
Parameters
__module__ = 'fipy.solvers.pyAMG.linearCGSSolver'

fipy.solvers.pyAMG.linearGMRESSolver module

class fipy.solvers.pyAMG.linearGMRESSolver.LinearGMRESSolver(tolerance=1e-15, iterations=2000, precon=<fipy.solvers.pyAMG.preconditioners.smoothedAggregationPreconditioner.SmoothedAggregationPreconditioner object>)

Bases: fipy.solvers.scipy.linearGMRESSolver.LinearGMRESSolver

The LinearGMRESSolver is an interface to the GMRES solver in Scipy, using the PyAMG SmoothedAggregationPreconditioner by default.

Parameters
__init__(tolerance=1e-15, iterations=2000, precon=<fipy.solvers.pyAMG.preconditioners.smoothedAggregationPreconditioner.SmoothedAggregationPreconditioner object>)
Parameters
__module__ = 'fipy.solvers.pyAMG.linearGMRESSolver'

fipy.solvers.pyAMG.linearGeneralSolver module

class fipy.solvers.pyAMG.linearGeneralSolver.LinearGeneralSolver(tolerance=1e-10, iterations=1000, precon=None)

Bases: fipy.solvers.scipy.scipySolver._ScipySolver

The LinearGeneralSolver is an interface to the generic PyAMG, which solves the arbitrary system Ax=b with the best out-of-the box choice for a solver. See pyAMG.solve for details.

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.

__module__ = 'fipy.solvers.pyAMG.linearGeneralSolver'

fipy.solvers.pyAMG.linearLUSolver module

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

Bases: fipy.solvers.scipy.scipySolver._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.

__module__ = 'fipy.solvers.scipy.linearLUSolver'

fipy.solvers.pyAMG.linearPCGSolver module

class fipy.solvers.pyAMG.linearPCGSolver.LinearPCGSolver(tolerance=1e-15, iterations=2000, precon=<fipy.solvers.pyAMG.preconditioners.smoothedAggregationPreconditioner.SmoothedAggregationPreconditioner object>)

Bases: fipy.solvers.scipy.linearPCGSolver.LinearPCGSolver

The LinearPCGSolver is an interface to the PCG solver in Scipy, using the PyAMG SmoothedAggregationPreconditioner by default.

Parameters
__init__(tolerance=1e-15, iterations=2000, precon=<fipy.solvers.pyAMG.preconditioners.smoothedAggregationPreconditioner.SmoothedAggregationPreconditioner object>)
Parameters
__module__ = 'fipy.solvers.pyAMG.linearPCGSolver'

Module contents

fipy.solvers.pyAMG.DefaultAsymmetricSolver

alias of fipy.solvers.scipy.linearLUSolver.LinearLUSolver

fipy.solvers.pyAMG.DefaultSolver

alias of fipy.solvers.pyAMG.linearGMRESSolver.LinearGMRESSolver

fipy.solvers.pyAMG.DummySolver

alias of fipy.solvers.pyAMG.linearGMRESSolver.LinearGMRESSolver

fipy.solvers.pyAMG.GeneralSolver

alias of fipy.solvers.pyAMG.linearGeneralSolver.LinearGeneralSolver

class fipy.solvers.pyAMG.LinearCGSSolver(tolerance=1e-15, iterations=2000, precon=<fipy.solvers.pyAMG.preconditioners.smoothedAggregationPreconditioner.SmoothedAggregationPreconditioner object>)

Bases: fipy.solvers.scipy.linearCGSSolver.LinearCGSSolver

The LinearCGSSolver is an interface to the CGS solver in Scipy, using the PyAMG SmoothedAggregationPreconditioner by default.

Parameters
__annotations__ = {}
__init__(tolerance=1e-15, iterations=2000, precon=<fipy.solvers.pyAMG.preconditioners.smoothedAggregationPreconditioner.SmoothedAggregationPreconditioner object>)
Parameters
__module__ = 'fipy.solvers.pyAMG.linearCGSSolver'
class fipy.solvers.pyAMG.LinearGMRESSolver(tolerance=1e-15, iterations=2000, precon=<fipy.solvers.pyAMG.preconditioners.smoothedAggregationPreconditioner.SmoothedAggregationPreconditioner object>)

Bases: fipy.solvers.scipy.linearGMRESSolver.LinearGMRESSolver

The LinearGMRESSolver is an interface to the GMRES solver in Scipy, using the PyAMG SmoothedAggregationPreconditioner by default.

Parameters
__annotations__ = {}
__init__(tolerance=1e-15, iterations=2000, precon=<fipy.solvers.pyAMG.preconditioners.smoothedAggregationPreconditioner.SmoothedAggregationPreconditioner object>)
Parameters
__module__ = 'fipy.solvers.pyAMG.linearGMRESSolver'
class fipy.solvers.pyAMG.LinearGeneralSolver(tolerance=1e-10, iterations=1000, precon=None)

Bases: fipy.solvers.scipy.scipySolver._ScipySolver

The LinearGeneralSolver is an interface to the generic PyAMG, which solves the arbitrary system Ax=b with the best out-of-the box choice for a solver. See pyAMG.solve for details.

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.

__annotations__ = {}
__module__ = 'fipy.solvers.pyAMG.linearGeneralSolver'
class fipy.solvers.pyAMG.LinearLUSolver(tolerance=1e-10, iterations=1000, precon=None)

Bases: fipy.solvers.scipy.scipySolver._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.

__annotations__ = {}
__module__ = 'fipy.solvers.scipy.linearLUSolver'
class fipy.solvers.pyAMG.LinearPCGSolver(tolerance=1e-15, iterations=2000, precon=<fipy.solvers.pyAMG.preconditioners.smoothedAggregationPreconditioner.SmoothedAggregationPreconditioner object>)

Bases: fipy.solvers.scipy.linearPCGSolver.LinearPCGSolver

The LinearPCGSolver is an interface to the PCG solver in Scipy, using the PyAMG SmoothedAggregationPreconditioner by default.

Parameters
__annotations__ = {}
__init__(tolerance=1e-15, iterations=2000, precon=<fipy.solvers.pyAMG.preconditioners.smoothedAggregationPreconditioner.SmoothedAggregationPreconditioner object>)
Parameters
__module__ = 'fipy.solvers.pyAMG.linearPCGSolver'
Last updated on Jan 14, 2021. Created using Sphinx 3.4.3.