pyAMG Package

pyAMG Package

fipy.solvers.pyAMG.DefaultSolver

alias of LinearGMRESSolver

fipy.solvers.pyAMG.DummySolver

alias of LinearGMRESSolver

fipy.solvers.pyAMG.DefaultAsymmetricSolver

alias of LinearLUSolver

fipy.solvers.pyAMG.GeneralSolver

alias of LinearGeneralSolver

class fipy.solvers.pyAMG.LinearGMRESSolver(tolerance=1e-15, iterations=2000, precon=<fipy.solvers.pyAMG.preconditioners.smoothedAggregationPreconditioner.SmoothedAggregationPreconditioner instance at 0x110160a28>)

Bases: fipy.solvers.scipy.linearGMRESSolver.LinearGMRESSolver

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

Parameters :

• tolerance: The required error tolerance.
• iterations: The maximum number of iterative steps to perform.
• precon: Preconditioner to use.

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

Bases: fipy.solvers.scipy.linearCGSSolver.LinearCGSSolver

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

Parameters :

• tolerance: The required error tolerance.
• iterations: The maximum number of iterative steps to perform.
• precon: Preconditioner to use.

class fipy.solvers.pyAMG.LinearPCGSolver(tolerance=1e-15, iterations=2000, precon=<fipy.solvers.pyAMG.preconditioners.smoothedAggregationPreconditioner.SmoothedAggregationPreconditioner instance at 0x110160710>)

Bases: fipy.solvers.scipy.linearPCGSolver.LinearPCGSolver

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

Parameters :

• tolerance: The required error tolerance.
• iterations: The maximum number of iterative steps to perform.
• precon: Preconditioner to use.

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-factorisation. The LinearLUSolver is a wrapper class for the the Scipy scipy.sparse.linalg.splu moduleq.

Create a Solver object.

Parameters :

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

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: The required error tolerance.
• iterations: The maximum number of iterative steps to perform.
• precon: Preconditioner to use. This parameter is only available for Trilinos solvers.

linearCGSSolver Module

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

Bases: fipy.solvers.scipy.linearCGSSolver.LinearCGSSolver

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

Parameters :

• tolerance: The required error tolerance.
• iterations: The maximum number of iterative steps to perform.
• precon: Preconditioner to use.

linearGMRESSolver Module

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

Bases: fipy.solvers.scipy.linearGMRESSolver.LinearGMRESSolver

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

Parameters :

• tolerance: The required error tolerance.
• iterations: The maximum number of iterative steps to perform.
• precon: Preconditioner to use.

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: The required error tolerance.
• iterations: The maximum number of iterative steps to perform.
• precon: Preconditioner to use. This parameter is only available for Trilinos solvers.

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-factorisation. The LinearLUSolver is a wrapper class for the the Scipy scipy.sparse.linalg.splu moduleq.

Create a Solver object.

Parameters :

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

linearPCGSolver Module

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

Bases: fipy.solvers.scipy.linearPCGSolver.LinearPCGSolver

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

Parameters :

• tolerance: The required error tolerance.
• iterations: The maximum number of iterative steps to perform.
• precon: Preconditioner to use.

smoothedAggregationSolver Module

Subpackages

• preconditioners Package
  • preconditioners Package
  • smoothedAggregationPreconditioner Module