fipy.solvers.petsc.linearPCGSolver

Classes

LinearPCGSolver([tolerance, ...])

The LinearPCGSolver is an interface to the cg solver in PETSc.
class fipy.solvers.petsc.linearPCGSolver.LinearPCGSolver(tolerance='default', absolute_tolerance=None, divergence_tolerance=None, criterion='default', iterations='default', precon='default')

Bases: PETScKrylovSolver

The LinearPCGSolver is an interface to the cg solver in PETSc.

Parameters:

  • tolerance (float) – Required relative error tolerance.

  • absolute_tolerance (float) – Required absolute error tolerance.

  • divergence_tolerance (float) – Required divergence error tolerance.

  • criterion ({'default', 'unscaled', 'RHS', 'matrix', 'initial', 'preconditioned', 'natural', 'legacy'}) – Interpretation of tolerance. See Convergence for more information.

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

  • precon (PETScPreconditioner, optional) – Preconditioner to apply to the matrix. A value of None means to perform an unpreconditioned solve. (default: DefaultPreconditioner).

DEFAULT_ITERATIONS = 1000

Default maximum number of iterative steps to perform

DEFAULT_PRECONDITIONER

alias of DefaultPreconditioner

DEFAULT_TOLERANCE = 1e-05

Default tolerance for linear solves unless criterion=”legacy”

LEGACY_TOLERANCE = 1e-10

Default tolerance for linear solves if criterion=”legacy”

__repr__()

Return repr(self).

property default_tolerance

Default tolerance for linear solve

Last updated on Jun 26, 2024. Created using Sphinx 7.1.2.