petsc4py.PETSc.KSP.ConvergedReason#
- class petsc4py.PETSc.KSP.ConvergedReason#
Bases:
objectKSP Converged Reason.
CONVERGED_ITERATINGStill iterating
ITERATINGStill iterating
CONVERGED_RTOL_NORMALUndocumented.
CONVERGED_ATOL_NORMALUndocumented.
CONVERGED_RTOL∥r∥ <= rtolnorm(b) or rtolnorm(b - Ax₀)
CONVERGED_ATOL∥r∥ <= atol
CONVERGED_ITSUsed by the
Type.PREONLYsolver after the single iteration of the preconditioner is applied. Also used when theKSPConvergedSkipconvergence test routine is set in KSP.CONVERGED_NEG_CURVEUndocumented.
CONVERGED_STEP_LENGTHUndocumented.
CONVERGED_HAPPY_BREAKDOWNUndocumented.
DIVERGED_NULLUndocumented.
DIVERGED_MAX_ITRan out of iterations before any convergence criteria was reached.
DIVERGED_DTOLnorm(r) >= dtol*norm(b)
DIVERGED_BREAKDOWNA breakdown in the Krylov method was detected so the method could not continue to enlarge the Krylov space. Could be due to a singular matrix or preconditioner. In KSPHPDDM, this is also returned when some search directions within a block are colinear.
DIVERGED_BREAKDOWN_BICGA breakdown in the KSPBICG method was detected so the method could not continue to enlarge the Krylov space.
DIVERGED_NONSYMMETRICIt appears the operator or preconditioner is not symmetric and this Krylov method (
Type.CG,Type.MINRES,Type.CR) requires symmetry.DIVERGED_INDEFINITE_PCIt appears the preconditioner is indefinite (has both positive and negative eigenvalues) and this Krylov method (
Type.CG) requires it to be positive definite.DIVERGED_NANORINFUndocumented.
DIVERGED_INDEFINITE_MATUndocumented.
DIVERGED_PCSETUP_FAILEDIt was not possible to build or use the requested preconditioner. This is usually due to a zero pivot in a factorization. It can also result from a failure in a subpreconditioner inside a nested preconditioner such as
PC.Type.FIELDSPLIT.
See also
Attributes Summary
Constant
CONVERGED_ATOLof typeintConstant
CONVERGED_ATOL_NORMALof typeintConstant
CONVERGED_HAPPY_BREAKDOWNof typeintConstant
CONVERGED_ITERATINGof typeintConstant
CONVERGED_ITSof typeintConstant
CONVERGED_NEG_CURVEof typeintConstant
CONVERGED_RTOLof typeintConstant
CONVERGED_RTOL_NORMALof typeintConstant
CONVERGED_STEP_LENGTHof typeintConstant
DIVERGED_BREAKDOWNof typeintConstant
DIVERGED_BREAKDOWN_BICGof typeintConstant
DIVERGED_DTOLof typeintConstant
DIVERGED_INDEFINITE_MATof typeintConstant
DIVERGED_INDEFINITE_PCof typeintConstant
DIVERGED_MAX_ITof typeintConstant
DIVERGED_NANORINFof typeintConstant
DIVERGED_NONSYMMETRICof typeintConstant
DIVERGED_NULLof typeintConstant
DIVERGED_PCSETUP_FAILEDof typeintConstant
ITERATINGof typeintAttributes Documentation
- CONVERGED_HAPPY_BREAKDOWN: int = CONVERGED_HAPPY_BREAKDOWN#
Constant
CONVERGED_HAPPY_BREAKDOWNof typeint
- DIVERGED_BREAKDOWN_BICG: int = DIVERGED_BREAKDOWN_BICG#
Constant
DIVERGED_BREAKDOWN_BICGof typeint
- DIVERGED_INDEFINITE_MAT: int = DIVERGED_INDEFINITE_MAT#
Constant
DIVERGED_INDEFINITE_MATof typeint