1f26ada1bSBarry Smith /* 2f26ada1bSBarry Smith Defines the interface functions for the Krylov subspace accelerators. 3f26ada1bSBarry Smith */ 426bd1501SBarry Smith #ifndef PETSCKSP_H 526bd1501SBarry Smith #define PETSCKSP_H 62c8e378dSBarry Smith #include <petscpc.h> 72eac72dbSBarry Smith 8607a6623SBarry Smith PETSC_EXTERN PetscErrorCode KSPInitializePackage(void); 91dbb0a54SBarry Smith 1028ce4d24SBarry Smith /*S 118f6c3df8SBarry Smith KSP - Abstract PETSc object that manages all Krylov methods. This is the object that manages the 128f6c3df8SBarry Smith linear solves in PETSc (even those such as direct solvers that do no use Krylov accelerators). 1328ce4d24SBarry Smith 1428ce4d24SBarry Smith Level: beginner 1528ce4d24SBarry Smith 1695452b02SPatrick Sanan Notes: 17*db3b2ab5SMatthew Knepley When a direct solver is used, but no Krylov solver is used, the KSP object is still used but with a 18*db3b2ab5SMatthew Knepley KSPType of KSPPREONLY, meaning that only application of the preconditioner is used as the linear solver. 198f6c3df8SBarry Smith 20bca11509SBarry Smith .seealso: KSPCreate(), KSPSetType(), KSPType, SNES, TS, PC, KSP, KSPDestroy(), KSPCG, KSPGMRES 2128ce4d24SBarry Smith S*/ 22e2a1c21fSSatish Balay typedef struct _p_KSP* KSP; 232eac72dbSBarry Smith 2476bdecfbSBarry Smith /*J 258f6c3df8SBarry Smith KSPType - String with the name of a PETSc Krylov method. 2628ce4d24SBarry Smith 2728ce4d24SBarry Smith Level: beginner 2828ce4d24SBarry Smith 298f6c3df8SBarry Smith .seealso: KSPSetType(), KSP, KSPRegister(), KSPCreate(), KSPSetFromOptions() 3076bdecfbSBarry Smith J*/ 3119fd82e9SBarry Smith typedef const char* KSPType; 3282bf6240SBarry Smith #define KSPRICHARDSON "richardson" 336c9de887SHong Zhang #define KSPCHEBYSHEV "chebyshev" 3482bf6240SBarry Smith #define KSPCG "cg" 352c8fc646SJed Brown #define KSPGROPPCG "groppcg" 362c8fc646SJed Brown #define KSPPIPECG "pipecg" 37901ccb91SSiegfried Cools #define KSPPIPECGRR "pipecgrr" 38265663fdSSiegfried Cools #define KSPPIPELCG "pipelcg" 39b21a8899STyler Chen #define KSPPIPEPRCG "pipeprcg" 40325e8391SManasi #define KSPPIPECG2 "pipecg2" 41df2a969aSvictorle #define KSPCGNE "cgne" 4205de396fSBarry Smith #define KSPNASH "nash" 4305de396fSBarry Smith #define KSPSTCG "stcg" 4405de396fSBarry Smith #define KSPGLTR "gltr" 4505de396fSBarry Smith #define KSPCGNASH PETSC_DEPRECATED_MACRO("GCC warning \"KSPCGNASH macro is deprecated use KSPNASH (since version 3.11)\"") "nash" 4605de396fSBarry Smith #define KSPCGSTCG PETSC_DEPRECATED_MACRO("GCC warning \"KSPCGSTCG macro is deprecated use KSPSTCG (since version 3.11)\"") "stcg" 4705de396fSBarry Smith #define KSPCGGLTR PETSC_DEPRECATED_MACRO("GCC warning \"KSPCGGLTR macro is deprecated use KSPSGLTR (since version 3.11)\"") "gltr" 48640f4f53SPatrick Sanan #define KSPFCG "fcg" 49390d8e47SPatrick Sanan #define KSPPIPEFCG "pipefcg" 5082bf6240SBarry Smith #define KSPGMRES "gmres" 51483d6965SPatrick Sanan #define KSPPIPEFGMRES "pipefgmres" 529dcbbd2bSBarry Smith #define KSPFGMRES "fgmres" 539dcbbd2bSBarry Smith #define KSPLGMRES "lgmres" 544f8e6cd9SSatish Balay #define KSPDGMRES "dgmres" 5561b468f9SJed Brown #define KSPPGMRES "pgmres" 5682bf6240SBarry Smith #define KSPTCQMR "tcqmr" 5782bf6240SBarry Smith #define KSPBCGS "bcgs" 58e1c61ce8SBarry Smith #define KSPIBCGS "ibcgs" 5918ac38e6SHong Zhang #define KSPFBCGS "fbcgs" 60c2b71004SHong Zhang #define KSPFBCGSR "fbcgsr" 61f0037002Svictorle #define KSPBCGSL "bcgsl" 62f154af2dSSiegfried Cools #define KSPPIPEBCGS "pipebcgs" 6382bf6240SBarry Smith #define KSPCGS "cgs" 6482bf6240SBarry Smith #define KSPTFQMR "tfqmr" 6582bf6240SBarry Smith #define KSPCR "cr" 662c8fc646SJed Brown #define KSPPIPECR "pipecr" 6782bf6240SBarry Smith #define KSPLSQR "lsqr" 6882bf6240SBarry Smith #define KSPPREONLY "preonly" 6982bf6240SBarry Smith #define KSPQCG "qcg" 70c9cf9b11SBarry Smith #define KSPBICG "bicg" 71b4ac9ba4SBarry Smith #define KSPMINRES "minres" 7201c5daebSSatish Balay #define KSPSYMMLQ "symmlq" 7321356919SSatish Balay #define KSPLCD "lcd" 741d6018f0SLisandro Dalcin #define KSPPYTHON "python" 7558ad63f4SBarry Smith #define KSPGCR "gcr" 76fad47a0aSPatrick Sanan #define KSPPIPEGCR "pipegcr" 77e4d80e07Szianekhodja #define KSPTSIRM "tsirm" 78e4d80e07Szianekhodja #define KSPCGLS "cgls" 79329cd39dSStefano Zampini #define KSPFETIDP "fetidp" 8038cfc46eSPierre Jolivet #define KSPHPDDM "hpddm" 812eac72dbSBarry Smith 828ba1e511SMatthew Knepley /* Logging support */ 83014dd563SJed Brown PETSC_EXTERN PetscClassId KSP_CLASSID; 84ba36735cSStefano Zampini PETSC_EXTERN PetscClassId KSPGUESS_CLASSID; 855358d0d4SBarry Smith PETSC_EXTERN PetscClassId DMKSP_CLASSID; 868ba1e511SMatthew Knepley 87014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPCreate(MPI_Comm,KSP*); 8819fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode KSPSetType(KSP,KSPType); 89c60c7ad4SBarry Smith PETSC_EXTERN PetscErrorCode KSPGetType(KSP,KSPType*); 90014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSetUp(KSP); 91014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSetUpOnBlocks(KSP); 92014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSolve(KSP,Vec,Vec); 93014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSolveTranspose(KSP,Vec,Vec); 945ea7661aSPierre Jolivet PETSC_EXTERN PetscErrorCode KSPMatSolve(KSP,Mat,Mat); 955ea7661aSPierre Jolivet PETSC_EXTERN PetscErrorCode KSPSetMatSolveBlockSize(KSP,PetscInt); 965ea7661aSPierre Jolivet PETSC_EXTERN PetscErrorCode KSPGetMatSolveBlockSize(KSP,PetscInt*); 97014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPReset(KSP); 98ef17e8b6SStefano Zampini PETSC_EXTERN PetscErrorCode KSPResetViewers(KSP); 99014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPDestroy(KSP*); 10023ee1639SBarry Smith PETSC_EXTERN PetscErrorCode KSPSetReusePreconditioner(KSP,PetscBool); 1017d85ae06SStefano Zampini PETSC_EXTERN PetscErrorCode KSPGetReusePreconditioner(KSP,PetscBool*); 10225c41539SBarry Smith PETSC_EXTERN PetscErrorCode KSPSetSkipPCSetFromOptions(KSP,PetscBool); 103c0decd05SBarry Smith PETSC_EXTERN PetscErrorCode KSPCheckSolve(KSP,PC,Vec); 1042eac72dbSBarry Smith 105140e18c1SBarry Smith PETSC_EXTERN PetscFunctionList KSPList; 106ba36735cSStefano Zampini PETSC_EXTERN PetscFunctionList KSPGuessList; 107bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode KSPRegister(const char[],PetscErrorCode (*)(KSP)); 10830de9b25SBarry Smith 109014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSetPCSide(KSP,PCSide); 110014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGetPCSide(KSP,PCSide*); 111014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSetTolerances(KSP,PetscReal,PetscReal,PetscReal,PetscInt); 112c60c7ad4SBarry Smith PETSC_EXTERN PetscErrorCode KSPGetTolerances(KSP,PetscReal*,PetscReal*,PetscReal*,PetscInt*); 113014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSetInitialGuessNonzero(KSP,PetscBool); 114014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGetInitialGuessNonzero(KSP,PetscBool*); 115014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSetErrorIfNotConverged(KSP,PetscBool); 116014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGetErrorIfNotConverged(KSP,PetscBool*); 117014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSetComputeEigenvalues(KSP,PetscBool); 1187d7fa35eSSylvain Mercier PETSC_EXTERN PetscErrorCode KSPSetComputeRitz(KSP,PetscBool); 119c60c7ad4SBarry Smith PETSC_EXTERN PetscErrorCode KSPGetComputeEigenvalues(KSP,PetscBool*); 120014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSetComputeSingularValues(KSP,PetscBool); 121c60c7ad4SBarry Smith PETSC_EXTERN PetscErrorCode KSPGetComputeSingularValues(KSP,PetscBool*); 122014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGetRhs(KSP,Vec*); 123014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGetSolution(KSP,Vec*); 124014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGetResidualNorm(KSP,PetscReal*); 125014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGetIterationNumber(KSP,PetscInt*); 126734794cfSBarry Smith PETSC_EXTERN PetscErrorCode KSPGetTotalIterations(KSP,PetscInt*); 1272a7a6963SBarry Smith PETSC_EXTERN PetscErrorCode KSPCreateVecs(KSP,PetscInt,Vec**,PetscInt,Vec**); 12825ef9dfeSBarry Smith PETSC_DEPRECATED_FUNCTION("Use KSPCreateVecs() (since version 3.6)") PETSC_STATIC_INLINE PetscErrorCode KSPGetVecs(KSP ksp,PetscInt n,Vec **x,PetscInt m,Vec **y) {return KSPCreateVecs(ksp,n,x,m,y);} 1292eac72dbSBarry Smith 130d4211eb9SBarry Smith PETSC_EXTERN PetscErrorCode KSPSetPreSolve(KSP,PetscErrorCode (*)(KSP,Vec,Vec,void*),void*); 131d4211eb9SBarry Smith PETSC_EXTERN PetscErrorCode KSPSetPostSolve(KSP,PetscErrorCode (*)(KSP,Vec,Vec,void*),void*); 132d4211eb9SBarry Smith 133014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSetPC(KSP,PC); 134014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGetPC(KSP,PC*); 135aabeff55SBarry Smith 136014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPMonitor(KSP,PetscInt,PetscReal); 137014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPMonitorSet(KSP,PetscErrorCode (*)(KSP,PetscInt,PetscReal,void*),void*,PetscErrorCode (*)(void**)); 138014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPMonitorCancel(KSP); 139014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGetMonitorContext(KSP,void**); 140014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGetResidualHistory(KSP,PetscReal*[],PetscInt*); 141014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSetResidualHistory(KSP,PetscReal[],PetscInt,PetscBool); 1424b0e389bSBarry Smith 143fa0ddf94SBarry Smith PETSC_EXTERN PetscErrorCode KSPBuildSolutionDefault(KSP,Vec,Vec*); 144fa0ddf94SBarry Smith PETSC_EXTERN PetscErrorCode KSPBuildResidualDefault(KSP,Vec,Vec,Vec*); 145fa0ddf94SBarry Smith PETSC_EXTERN PetscErrorCode KSPDestroyDefault(KSP); 146fa0ddf94SBarry Smith PETSC_EXTERN PetscErrorCode KSPSetWorkVecs(KSP,PetscInt); 147fa0ddf94SBarry Smith 148014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCKSPGetKSP(PC,KSP*); 149cfebe74eSStefano Zampini PETSC_EXTERN PetscErrorCode PCKSPSetKSP(PC,KSP); 150014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCBJacobiGetSubKSP(PC,PetscInt*,PetscInt*,KSP*[]); 151014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCASMGetSubKSP(PC,PetscInt*,PetscInt*,KSP*[]); 152014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCGASMGetSubKSP(PC,PetscInt*,PetscInt*,KSP*[]); 153014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCFieldSplitGetSubKSP(PC,PetscInt*,KSP*[]); 154285fb4e2SStefano Zampini PETSC_EXTERN PetscErrorCode PCFieldSplitSchurGetSubKSP(PC,PetscInt*,KSP*[]); 155b4876bcbSBarry Smith PETSC_EXTERN PetscErrorCode PCMGGetSmoother(PC,PetscInt,KSP*); 156b4876bcbSBarry Smith PETSC_EXTERN PetscErrorCode PCMGGetSmootherDown(PC,PetscInt,KSP*); 157b4876bcbSBarry Smith PETSC_EXTERN PetscErrorCode PCMGGetSmootherUp(PC,PetscInt,KSP*); 158b4876bcbSBarry Smith PETSC_EXTERN PetscErrorCode PCMGGetCoarseSolve(PC,KSP*); 159014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCGalerkinGetKSP(PC,KSP*); 1604a99276eSJakub Kruzik PETSC_EXTERN PetscErrorCode PCDeflationGetCoarseKSP(PC,KSP*); 161f3b08a26SMatthew G. Knepley /* 162f3b08a26SMatthew G. Knepley PCMGCoarseList contains the list of coarse space constructor currently registered 163f3b08a26SMatthew G. Knepley These are added with PCMGRegisterCoarseSpaceConstructor() 164f3b08a26SMatthew G. Knepley */ 165f3b08a26SMatthew G. Knepley PETSC_EXTERN PetscFunctionList PCMGCoarseList; 166f3b08a26SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PCMGRegisterCoarseSpaceConstructor(const char[], PetscErrorCode (*)(PC, PetscInt, DM, KSP, PetscInt, const Vec[], Vec **)); 167f3b08a26SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PCMGGetCoarseSpaceConstructor(const char[], PetscErrorCode (**)(PC, PetscInt, DM, KSP, PetscInt, const Vec[], Vec **)); 168f3b08a26SMatthew G. Knepley 1690a71e23eSMatthew Knepley 170014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPBuildSolution(KSP,Vec,Vec*); 171014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPBuildResidual(KSP,Vec,Vec,Vec*); 1722eac72dbSBarry Smith 173014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPRichardsonSetScale(KSP,PetscReal); 174014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPRichardsonSetSelfScale(KSP,PetscBool); 175014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPChebyshevSetEigenvalues(KSP,PetscReal,PetscReal); 17658450487SBarry Smith PETSC_EXTERN PetscErrorCode KSPChebyshevEstEigSet(KSP,PetscReal,PetscReal,PetscReal,PetscReal); 177b65fd476SMark Adams PETSC_EXTERN PetscErrorCode KSPChebyshevEstEigSetUseNoisy(KSP,PetscBool); 17858450487SBarry Smith PETSC_EXTERN PetscErrorCode KSPChebyshevEstEigGetKSP(KSP,KSP*); 179014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPComputeExtremeSingularValues(KSP,PetscReal*,PetscReal*); 180d38fc84dSBarry Smith PETSC_EXTERN PetscErrorCode KSPComputeEigenvalues(KSP,PetscInt,PetscReal[],PetscReal[],PetscInt*); 181d38fc84dSBarry Smith PETSC_EXTERN PetscErrorCode KSPComputeEigenvaluesExplicitly(KSP,PetscInt,PetscReal[],PetscReal[]); 1827d7fa35eSSylvain Mercier PETSC_EXTERN PetscErrorCode KSPComputeRitz(KSP,PetscBool,PetscBool,PetscInt*,Vec[],PetscReal[],PetscReal[]); 1834b0e389bSBarry Smith 184640f4f53SPatrick Sanan /*E 185640f4f53SPatrick Sanan 18606137d0aSPatrick Sanan KSPFCDTruncationType - Define how stored directions are used to orthogonalize in flexible conjugate directions (FCD) methods 187640f4f53SPatrick Sanan 18893f1e87bSPatrick Sanan KSP_FCD_TRUNC_TYPE_STANDARD uses all (up to mmax) stored directions 18993f1e87bSPatrick Sanan KSP_FCD_TRUNC_TYPE_NOTAY uses the last max(1,mod(i,mmax)) stored directions at iteration i=0,1.. 190640f4f53SPatrick Sanan 1912b26979fSBarry Smith Level: intermediate 19206137d0aSPatrick Sanan .seealso : KSPFCG,KSPPIPEFCG,KSPPIPEGCR,KSPFCGSetTruncationType(),KSPFCGGetTruncationType() 193640f4f53SPatrick Sanan 194640f4f53SPatrick Sanan E*/ 19593f1e87bSPatrick Sanan typedef enum {KSP_FCD_TRUNC_TYPE_STANDARD,KSP_FCD_TRUNC_TYPE_NOTAY} KSPFCDTruncationType; 19606137d0aSPatrick Sanan PETSC_EXTERN const char *const KSPFCDTruncationTypes[]; 197640f4f53SPatrick Sanan 198640f4f53SPatrick Sanan PETSC_EXTERN PetscErrorCode KSPFCGSetMmax(KSP,PetscInt); 199640f4f53SPatrick Sanan PETSC_EXTERN PetscErrorCode KSPFCGGetMmax(KSP,PetscInt*); 200640f4f53SPatrick Sanan PETSC_EXTERN PetscErrorCode KSPFCGSetNprealloc(KSP,PetscInt); 201640f4f53SPatrick Sanan PETSC_EXTERN PetscErrorCode KSPFCGGetNprealloc(KSP,PetscInt*); 20206137d0aSPatrick Sanan PETSC_EXTERN PetscErrorCode KSPFCGSetTruncationType(KSP,KSPFCDTruncationType); 20306137d0aSPatrick Sanan PETSC_EXTERN PetscErrorCode KSPFCGGetTruncationType(KSP,KSPFCDTruncationType*); 204640f4f53SPatrick Sanan 205390d8e47SPatrick Sanan PETSC_EXTERN PetscErrorCode KSPPIPEFCGSetMmax(KSP,PetscInt); 206390d8e47SPatrick Sanan PETSC_EXTERN PetscErrorCode KSPPIPEFCGGetMmax(KSP,PetscInt*); 207390d8e47SPatrick Sanan PETSC_EXTERN PetscErrorCode KSPPIPEFCGSetNprealloc(KSP,PetscInt); 208390d8e47SPatrick Sanan PETSC_EXTERN PetscErrorCode KSPPIPEFCGGetNprealloc(KSP,PetscInt*); 209390d8e47SPatrick Sanan PETSC_EXTERN PetscErrorCode KSPPIPEFCGSetTruncationType(KSP,KSPFCDTruncationType); 210390d8e47SPatrick Sanan PETSC_EXTERN PetscErrorCode KSPPIPEFCGGetTruncationType(KSP,KSPFCDTruncationType*); 211390d8e47SPatrick Sanan 212fad47a0aSPatrick Sanan PETSC_EXTERN PetscErrorCode KSPPIPEGCRSetMmax(KSP,PetscInt); 213fad47a0aSPatrick Sanan PETSC_EXTERN PetscErrorCode KSPPIPEGCRGetMmax(KSP,PetscInt*); 214fad47a0aSPatrick Sanan PETSC_EXTERN PetscErrorCode KSPPIPEGCRSetNprealloc(KSP,PetscInt); 215fad47a0aSPatrick Sanan PETSC_EXTERN PetscErrorCode KSPPIPEGCRGetNprealloc(KSP,PetscInt*); 216fad47a0aSPatrick Sanan PETSC_EXTERN PetscErrorCode KSPPIPEGCRSetTruncationType(KSP,KSPFCDTruncationType); 217fad47a0aSPatrick Sanan PETSC_EXTERN PetscErrorCode KSPPIPEGCRGetTruncationType(KSP,KSPFCDTruncationType*); 218fad47a0aSPatrick Sanan PETSC_EXTERN PetscErrorCode KSPPIPEGCRSetUnrollW(KSP,PetscBool); 219fad47a0aSPatrick Sanan PETSC_EXTERN PetscErrorCode KSPPIPEGCRGetUnrollW(KSP,PetscBool*); 22083f0b094SBarry Smith 221014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGMRESSetRestart(KSP, PetscInt); 222014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGMRESGetRestart(KSP, PetscInt*); 223014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGMRESSetHapTol(KSP,PetscReal); 224e3729115SFande Kong PETSC_EXTERN PetscErrorCode KSPGMRESSetBreakdownTolerance(KSP,PetscReal); 2259f236934SBarry Smith 226014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGMRESSetPreAllocateVectors(KSP); 227014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGMRESSetOrthogonalization(KSP,PetscErrorCode (*)(KSP,PetscInt)); 228014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGMRESGetOrthogonalization(KSP,PetscErrorCode (**)(KSP,PetscInt)); 229014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGMRESModifiedGramSchmidtOrthogonalization(KSP,PetscInt); 230014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGMRESClassicalGramSchmidtOrthogonalization(KSP,PetscInt); 2311d73ed98SBarry Smith 232014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPLGMRESSetAugDim(KSP,PetscInt); 233014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPLGMRESSetConstant(KSP); 2341d73ed98SBarry Smith 235483d6965SPatrick Sanan PETSC_EXTERN PetscErrorCode KSPPIPEFGMRESSetShift(KSP,PetscScalar); 236483d6965SPatrick Sanan 237014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGCRSetRestart(KSP,PetscInt); 238014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGCRGetRestart(KSP,PetscInt*); 239014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGCRSetModifyPC(KSP,PetscErrorCode (*)(KSP,PetscInt,PetscReal,void*),void*,PetscErrorCode(*)(void*)); 24058ad63f4SBarry Smith 24104d8bde8SStefano Zampini PETSC_EXTERN PetscErrorCode KSPFETIDPGetInnerBDDC(KSP,PC*); 24204d8bde8SStefano Zampini PETSC_EXTERN PetscErrorCode KSPFETIDPSetInnerBDDC(KSP,PC); 24304d8bde8SStefano Zampini PETSC_EXTERN PetscErrorCode KSPFETIDPGetInnerKSP(KSP,KSP*); 244568c15deSstefano_zampini PETSC_EXTERN PetscErrorCode KSPFETIDPSetPressureOperator(KSP,Mat); 245e82af88dSprj- 246e82af88dSprj- PETSC_EXTERN PetscErrorCode KSPHPDDMSetDeflationSpace(KSP,Mat); 247e82af88dSprj- PETSC_EXTERN PetscErrorCode KSPHPDDMGetDeflationSpace(KSP,Mat*); 2485ea7661aSPierre Jolivet PETSC_DEPRECATED_FUNCTION("Use KSPMatSolve() (since version 3.14)") PETSC_STATIC_INLINE PetscErrorCode KSPHPDDMMatSolve(KSP ksp, Mat B, Mat X) { return KSPMatSolve(ksp, B, X); } 249d55ab951SPierre Jolivet /*E 250d55ab951SPierre Jolivet KSPHPDDMType - Type of Krylov method used by KSPHPDDM 251d55ab951SPierre Jolivet 252d55ab951SPierre Jolivet Level: intermediate 253d55ab951SPierre Jolivet 254d55ab951SPierre Jolivet Values: 255d55ab951SPierre Jolivet + KSP_HPDDM_TYPE_GMRES (default) 256d55ab951SPierre Jolivet . KSP_HPDDM_TYPE_BGMRES 257d55ab951SPierre Jolivet . KSP_HPDDM_TYPE_CG 258d55ab951SPierre Jolivet . KSP_HPDDM_TYPE_BCG 259d55ab951SPierre Jolivet . KSP_HPDDM_TYPE_GCRODR 260d55ab951SPierre Jolivet . KSP_HPDDM_TYPE_BGCRODR 261d55ab951SPierre Jolivet . KSP_HPDDM_TYPE_BFBCG 262d55ab951SPierre Jolivet - KSP_HPDDM_TYPE_PREONLY 263d55ab951SPierre Jolivet 264d55ab951SPierre Jolivet .seealso: KSPHPDDM, KSPHPDDMSetType() 265d55ab951SPierre Jolivet E*/ 266d55ab951SPierre Jolivet typedef enum { 267d55ab951SPierre Jolivet KSP_HPDDM_TYPE_GMRES = 0, 268d55ab951SPierre Jolivet KSP_HPDDM_TYPE_BGMRES = 1, 269d55ab951SPierre Jolivet KSP_HPDDM_TYPE_CG = 2, 270d55ab951SPierre Jolivet KSP_HPDDM_TYPE_BCG = 3, 271d55ab951SPierre Jolivet KSP_HPDDM_TYPE_GCRODR = 4, 272d55ab951SPierre Jolivet KSP_HPDDM_TYPE_BGCRODR = 5, 273d55ab951SPierre Jolivet KSP_HPDDM_TYPE_BFBCG = 6, 274d55ab951SPierre Jolivet KSP_HPDDM_TYPE_PREONLY = 7 275d55ab951SPierre Jolivet } KSPHPDDMType; 276d55ab951SPierre Jolivet PETSC_EXTERN const char *const KSPHPDDMTypes[]; 277d55ab951SPierre Jolivet PETSC_EXTERN PetscErrorCode KSPHPDDMSetType(KSP,KSPHPDDMType); 278d55ab951SPierre Jolivet PETSC_EXTERN PetscErrorCode KSPHPDDMGetType(KSP,KSPHPDDMType*); 279e82af88dSprj- 280b49fd9e1SBarry Smith /*E 281b49fd9e1SBarry Smith KSPGMRESCGSRefinementType - How the classical (unmodified) Gram-Schmidt is performed. 282b49fd9e1SBarry Smith 283b49fd9e1SBarry Smith Level: advanced 284b49fd9e1SBarry Smith 285bef9c725SBarry Smith .seealso: KSPGMRESClassicalGramSchmidtOrthogonalization(), KSPGMRESSetOrthogonalization(), KSPGMRESGetOrthogonalization(), 286e928de20SBarry Smith KSPGMRESSetCGSRefinementType(), KSPGMRESGetCGSRefinementType(), KSPGMRESModifiedGramSchmidtOrthogonalization() 287b49fd9e1SBarry Smith 288b49fd9e1SBarry Smith E*/ 28978d1dd23SKris Buschelman typedef enum {KSP_GMRES_CGS_REFINE_NEVER, KSP_GMRES_CGS_REFINE_IFNEEDED, KSP_GMRES_CGS_REFINE_ALWAYS} KSPGMRESCGSRefinementType; 2906a6fc655SJed Brown PETSC_EXTERN const char *const KSPGMRESCGSRefinementTypes[]; 2911f7e983dSSatish Balay /*MC 2921957e957SBarry Smith KSP_GMRES_CGS_REFINE_NEVER - Do the classical (unmodified) Gram-Schmidt process 2938c5b8ba0SBarry Smith 2948c5b8ba0SBarry Smith Level: advanced 2958c5b8ba0SBarry Smith 2968c5b8ba0SBarry Smith Note: Possible unstable, but the fastest to compute 2978c5b8ba0SBarry Smith 298bef9c725SBarry Smith .seealso: KSPGMRESClassicalGramSchmidtOrthogonalization(), KSPGMRESSetOrthogonalization(), KSPGMRESGetOrthogonalization(), 299e928de20SBarry Smith KSPGMRESSetCGSRefinementType(), KSPGMRESGetCGSRefinementType(), KSP_GMRES_CGS_REFINE_IFNEEDED, KSP_GMRES_CGS_REFINE_ALWAYS, 3008c5b8ba0SBarry Smith KSPGMRESModifiedGramSchmidtOrthogonalization() 3018c5b8ba0SBarry Smith M*/ 3028c5b8ba0SBarry Smith 3031f7e983dSSatish Balay /*MC 3048c5b8ba0SBarry Smith KSP_GMRES_CGS_REFINE_IFNEEDED - Do the classical (unmodified) Gram-Schmidt process and one step of 3058c5b8ba0SBarry Smith iterative refinement if an estimate of the orthogonality of the resulting vectors indicates 3068c5b8ba0SBarry Smith poor orthogonality. 3078c5b8ba0SBarry Smith 3088c5b8ba0SBarry Smith Level: advanced 3098c5b8ba0SBarry Smith 3108c5b8ba0SBarry Smith Note: This is slower than KSP_GMRES_CGS_REFINE_NEVER because it requires an extra norm computation to 3118c5b8ba0SBarry Smith estimate the orthogonality but is more stable. 3128c5b8ba0SBarry Smith 313bef9c725SBarry Smith .seealso: KSPGMRESClassicalGramSchmidtOrthogonalization(), KSPGMRESSetOrthogonalization(), KSPGMRESGetOrthogonalization(), 314e928de20SBarry Smith KSPGMRESSetCGSRefinementType(), KSPGMRESGetCGSRefinementType(), KSP_GMRES_CGS_REFINE_NEVER, KSP_GMRES_CGS_REFINE_ALWAYS, 3158c5b8ba0SBarry Smith KSPGMRESModifiedGramSchmidtOrthogonalization() 3168c5b8ba0SBarry Smith M*/ 3178c5b8ba0SBarry Smith 3181f7e983dSSatish Balay /*MC 3198c5b8ba0SBarry Smith KSP_GMRES_CGS_REFINE_NEVER - Do two steps of the classical (unmodified) Gram-Schmidt process. 3208c5b8ba0SBarry Smith 3218c5b8ba0SBarry Smith Level: advanced 3228c5b8ba0SBarry Smith 3238c5b8ba0SBarry Smith Note: This is roughly twice the cost of KSP_GMRES_CGS_REFINE_NEVER because it performs the process twice 3248c5b8ba0SBarry Smith but it saves the extra norm calculation needed by KSP_GMRES_CGS_REFINE_IFNEEDED. 3258c5b8ba0SBarry Smith 3268c5b8ba0SBarry Smith You should only use this if you absolutely know that the iterative refinement is needed. 3278c5b8ba0SBarry Smith 328bef9c725SBarry Smith .seealso: KSPGMRESClassicalGramSchmidtOrthogonalization(), KSPGMRESSetOrthogonalization(), KSPGMRESGetOrthogonalization(), 329e928de20SBarry Smith KSPGMRESSetCGSRefinementType(), KSPGMRESGetCGSRefinementType(), KSP_GMRES_CGS_REFINE_IFNEEDED, KSP_GMRES_CGS_REFINE_ALWAYS, 3308c5b8ba0SBarry Smith KSPGMRESModifiedGramSchmidtOrthogonalization() 3318c5b8ba0SBarry Smith M*/ 3328c5b8ba0SBarry Smith 333014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGMRESSetCGSRefinementType(KSP,KSPGMRESCGSRefinementType); 334014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGMRESGetCGSRefinementType(KSP,KSPGMRESCGSRefinementType*); 33508480c60SBarry Smith 336014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPFGMRESModifyPCNoChange(KSP,PetscInt,PetscInt,PetscReal,void*); 337014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPFGMRESModifyPCKSP(KSP,PetscInt,PetscInt,PetscReal,void*); 338014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPFGMRESSetModifyPC(KSP,PetscErrorCode (*)(KSP,PetscInt,PetscInt,PetscReal,void*),void*,PetscErrorCode(*)(void*)); 339c38d4ed2SBarry Smith 340014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPQCGSetTrustRegionRadius(KSP,PetscReal); 341014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPQCGGetQuadratic(KSP,PetscReal*); 342014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPQCGGetTrialStepNorm(KSP,PetscReal*); 343121fd945SKris Buschelman 344014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPBCGSLSetXRes(KSP,PetscReal); 345014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPBCGSLSetPol(KSP,PetscBool); 346014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPBCGSLSetEll(KSP,PetscInt); 347e4b508b2SJed Brown PETSC_EXTERN PetscErrorCode KSPBCGSLSetUsePseudoinverse(KSP,PetscBool); 348d9492815SBarry Smith 349014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSetFromOptions(KSP); 35087d6299eSMatthew G. Knepley PETSC_EXTERN PetscErrorCode KSPResetFromOptions(KSP); 351014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPAddOptionsChecker(PetscErrorCode (*)(KSP)); 3522eac72dbSBarry Smith 353fe01d993SBarry Smith PETSC_EXTERN PetscErrorCode KSPMonitorSingularValue(KSP,PetscInt,PetscReal,PetscViewerAndFormat*); 354fe01d993SBarry Smith PETSC_EXTERN PetscErrorCode KSPMonitorDefault(KSP,PetscInt,PetscReal,PetscViewerAndFormat*); 355fe01d993SBarry Smith PETSC_EXTERN PetscErrorCode KSPLSQRMonitorDefault(KSP,PetscInt,PetscReal,PetscViewerAndFormat*); 356fe01d993SBarry Smith PETSC_EXTERN PetscErrorCode KSPMonitorRange(KSP,PetscInt,PetscReal,PetscViewerAndFormat*); 357390160ecSHong Zhang PETSC_EXTERN PetscErrorCode KSPMonitorDynamicTolerance(KSP ksp,PetscInt its,PetscReal fnorm,void *dummy); 358390160ecSHong Zhang PETSC_EXTERN PetscErrorCode KSPMonitorDynamicToleranceDestroy(void **dummy); 359fe01d993SBarry Smith PETSC_EXTERN PetscErrorCode KSPMonitorTrueResidualNorm(KSP,PetscInt,PetscReal,PetscViewerAndFormat*); 360fe01d993SBarry Smith PETSC_EXTERN PetscErrorCode KSPMonitorTrueResidualMaxNorm(KSP,PetscInt,PetscReal,PetscViewerAndFormat*); 361fe01d993SBarry Smith PETSC_EXTERN PetscErrorCode KSPMonitorDefaultShort(KSP,PetscInt,PetscReal,PetscViewerAndFormat*); 362fe01d993SBarry Smith PETSC_EXTERN PetscErrorCode KSPMonitorSolution(KSP,PetscInt,PetscReal,PetscViewerAndFormat*); 363e04113cfSBarry Smith PETSC_EXTERN PetscErrorCode KSPMonitorSAWs(KSP,PetscInt,PetscReal,void*); 364e04113cfSBarry Smith PETSC_EXTERN PetscErrorCode KSPMonitorSAWsCreate(KSP,void**); 365e04113cfSBarry Smith PETSC_EXTERN PetscErrorCode KSPMonitorSAWsDestroy(void**); 366014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGMRESMonitorKrylov(KSP,PetscInt,PetscReal,void*); 367fe01d993SBarry Smith PETSC_EXTERN PetscErrorCode KSPMonitorSetFromOptions(KSP,const char[],const char[],const char [],PetscErrorCode (*)(KSP,PetscInt,PetscReal,PetscViewerAndFormat*)); 36884cb2905SBarry Smith 369014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPUnwindPreconditioner(KSP,Vec,Vec); 370014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPInitialResidual(KSP,Vec,Vec,Vec,Vec,Vec); 371c01c455dSBarry Smith 37223ee1639SBarry Smith PETSC_EXTERN PetscErrorCode KSPSetOperators(KSP,Mat,Mat); 37323ee1639SBarry Smith PETSC_EXTERN PetscErrorCode KSPGetOperators(KSP,Mat*,Mat*); 374014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGetOperatorsSet(KSP,PetscBool*,PetscBool*); 375014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSetOptionsPrefix(KSP,const char[]); 376014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPAppendOptionsPrefix(KSP,const char[]); 377014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGetOptionsPrefix(KSP,const char*[]); 3781eb62cbbSBarry Smith 379014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSetDiagonalScale(KSP,PetscBool); 380014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGetDiagonalScale(KSP,PetscBool*); 381014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSetDiagonalScaleFix(KSP,PetscBool); 382014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGetDiagonalScaleFix(KSP,PetscBool*); 3831f7f0c4fSBarry Smith 384014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPView(KSP,PetscViewer); 38555849f57SBarry Smith PETSC_EXTERN PetscErrorCode KSPLoad(KSP,PetscViewer); 386fe2efc57SMark PETSC_EXTERN PetscErrorCode KSPViewFromOptions(KSP,PetscObject,const char[]); 38719a666eeSBarry Smith PETSC_EXTERN PetscErrorCode KSPConvergedReasonView(KSP,PetscViewer); 3881b2b9847SBarry Smith PETSC_EXTERN PetscErrorCode KSPConvergedReasonViewFromOptions(KSP); 3891b2b9847SBarry Smith 39019a666eeSBarry Smith PETSC_DEPRECATED_FUNCTION("Use KSPConvergedReasonView() (since version 3.14)") PETSC_STATIC_INLINE PetscErrorCode KSPReasonView(KSP ksp,PetscViewer v) {return KSPConvergedReasonView(ksp,v);} 3911b2b9847SBarry Smith PETSC_DEPRECATED_FUNCTION("Use KSPConvergedReasonViewFromOptions() (since version 3.14)") PETSC_STATIC_INLINE PetscErrorCode KSPReasonViewFromOptions(KSP ksp) {return KSPConvergedReasonViewFromOptions(ksp);} 39255849f57SBarry Smith 39355849f57SBarry Smith #define KSP_FILE_CLASSID 1211223 3941eb62cbbSBarry Smith 395dcc87044SVaclav Hapla PETSC_EXTERN PetscErrorCode KSPLSQRSetExactMatNorm(KSP,PetscBool); 3960e827bf4SVaclav Hapla PETSC_EXTERN PetscErrorCode KSPLSQRSetComputeStandardErrorVec(KSP,PetscBool); 397014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPLSQRGetStandardErrorVec(KSP,Vec*); 398884807c7SVaclav Hapla PETSC_EXTERN PetscErrorCode KSPLSQRGetNorms(KSP,PetscReal*,PetscReal*); 399db9b2ab1SHong Zhang 400014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCRedundantGetKSP(PC,KSP*); 401014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCRedistributeGetKSP(PC,KSP*); 40268ddcbeaSBarry Smith PETSC_EXTERN PetscErrorCode PCTelescopeGetKSP(PC,KSP*); 40383ab6a24SBarry Smith 40428ce4d24SBarry Smith /*E 4058a4b9c5cSBarry Smith KSPNormType - Norm that is passed in the Krylov convergence 4068a4b9c5cSBarry Smith test routines. 4078a4b9c5cSBarry Smith 4088a4b9c5cSBarry Smith Level: advanced 4098a4b9c5cSBarry Smith 410a3f661c8SBarry Smith Each solver only supports a subset of these and some may support different ones 4111718446fSBarry Smith depending on left or right preconditioning, see KSPSetPCSide() 412a3f661c8SBarry Smith 41395452b02SPatrick Sanan Notes: 41495452b02SPatrick Sanan this must match petsc/finclude/petscksp.h 4158a4b9c5cSBarry Smith 41694b7f48cSBarry Smith .seealso: KSPSolve(), KSPGetConvergedReason(), KSPSetNormType(), 4171718446fSBarry Smith KSPSetConvergenceTest(), KSPSetPCSide() 4188a4b9c5cSBarry Smith E*/ 4199e568555SJed Brown typedef enum {KSP_NORM_DEFAULT = -1,KSP_NORM_NONE = 0,KSP_NORM_PRECONDITIONED = 1,KSP_NORM_UNPRECONDITIONED = 2,KSP_NORM_NATURAL = 3} KSPNormType; 4209e568555SJed Brown #define KSP_NORM_MAX (KSP_NORM_NATURAL + 1) 421014dd563SJed Brown PETSC_EXTERN const char *const*const KSPNormTypes; 422a21b2a99SBarry Smith 4231f7e983dSSatish Balay /*MC 4249793b452SBarry Smith KSP_NORM_NONE - Do not compute a norm during the Krylov process. This will 4258c5b8ba0SBarry Smith possibly save some computation but means the convergence test cannot 4268c5b8ba0SBarry Smith be based on a norm of a residual etc. 4278c5b8ba0SBarry Smith 4288c5b8ba0SBarry Smith Level: advanced 4298c5b8ba0SBarry Smith 4301957e957SBarry Smith Note: Some Krylov methods need to compute a residual norm (such as GMRES) and then this option is ignored 4318c5b8ba0SBarry Smith 432ce9499c7SBarry Smith .seealso: KSPNormType, KSPSetNormType(), KSP_NORM_PRECONDITIONED, KSP_NORM_UNPRECONDITIONED, KSP_NORM_NATURAL 4338c5b8ba0SBarry Smith M*/ 4348c5b8ba0SBarry Smith 4351f7e983dSSatish Balay /*MC 4361957e957SBarry Smith KSP_NORM_PRECONDITIONED - Compute the norm of the preconditioned residual B*(b - A*x), if left preconditioning, and pass that to the 4378c5b8ba0SBarry Smith convergence test routine. 4388c5b8ba0SBarry Smith 4398c5b8ba0SBarry Smith Level: advanced 4408c5b8ba0SBarry Smith 4419793b452SBarry Smith .seealso: KSPNormType, KSPSetNormType(), KSP_NORM_NONE, KSP_NORM_UNPRECONDITIONED, KSP_NORM_NATURAL, KSPSetConvergenceTest() 4428c5b8ba0SBarry Smith M*/ 4438c5b8ba0SBarry Smith 4441f7e983dSSatish Balay /*MC 445ce9499c7SBarry Smith KSP_NORM_UNPRECONDITIONED - Compute the norm of the true residual (b - A*x) and pass that to the 4468c5b8ba0SBarry Smith convergence test routine. 4478c5b8ba0SBarry Smith 4488c5b8ba0SBarry Smith Level: advanced 4498c5b8ba0SBarry Smith 4509793b452SBarry Smith .seealso: KSPNormType, KSPSetNormType(), KSP_NORM_NONE, KSP_NORM_PRECONDITIONED, KSP_NORM_NATURAL, KSPSetConvergenceTest() 4518c5b8ba0SBarry Smith M*/ 4528c5b8ba0SBarry Smith 4531f7e983dSSatish Balay /*MC 454ce9499c7SBarry Smith KSP_NORM_NATURAL - Compute the 'natural norm' of residual sqrt((b - A*x)*B*(b - A*x)) and pass that to the 455390d8e47SPatrick Sanan convergence test routine. This is only supported by KSPCG, KSPCR, KSPCGNE, KSPCGS, KSPFCG, KSPPIPEFCG, KSPPIPEGCR 4568c5b8ba0SBarry Smith 4578c5b8ba0SBarry Smith Level: advanced 4588c5b8ba0SBarry Smith 4599793b452SBarry Smith .seealso: KSPNormType, KSPSetNormType(), KSP_NORM_NONE, KSP_NORM_PRECONDITIONED, KSP_NORM_UNPRECONDITIONED, KSPSetConvergenceTest() 4608c5b8ba0SBarry Smith M*/ 4618c5b8ba0SBarry Smith 462014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSetNormType(KSP,KSPNormType); 463014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGetNormType(KSP,KSPNormType*); 464014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSetSupportedNorm(KSP ksp,KSPNormType,PCSide,PetscInt); 465014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSetCheckNormIteration(KSP,PetscInt); 466014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSetLagNorm(KSP,PetscBool); 4678a4b9c5cSBarry Smith 468f0fc11ceSJed Brown #define KSP_DIVERGED_PCSETUP_FAILED_DEPRECATED KSP_DIVERGED_PCSETUP_FAILED PETSC_DEPRECATED_ENUM("Use KSP_DIVERGED_PC_FAILED (since version 3.11)") 4698a4b9c5cSBarry Smith /*E 4701957e957SBarry Smith KSPConvergedReason - reason a Krylov method was said to have converged or diverged 47128ce4d24SBarry Smith 47228ce4d24SBarry Smith Level: beginner 47328ce4d24SBarry Smith 47495452b02SPatrick Sanan Notes: 47595452b02SPatrick Sanan See KSPGetConvergedReason() for explanation of each value 47628ce4d24SBarry Smith 47795452b02SPatrick Sanan Developer Notes: 47895452b02SPatrick Sanan this must match petsc/finclude/petscksp.h 4794d0a8057SBarry Smith 4804d0a8057SBarry Smith The string versions of these are KSPConvergedReasons; if you change 4814d0a8057SBarry Smith any of the values here also change them that array of names. 48286c02ca4SBarry Smith 4831b2b9847SBarry Smith .seealso: KSPSolve(), KSPGetConvergedReason(), KSPSetTolerances(), KSPConvergedReasonView() 48428ce4d24SBarry Smith E*/ 485d15094e1SBarry Smith typedef enum {/* converged */ 4869ecb1286SBarry Smith KSP_CONVERGED_RTOL_NORMAL = 1, 4879ecb1286SBarry Smith KSP_CONVERGED_ATOL_NORMAL = 9, 488d15094e1SBarry Smith KSP_CONVERGED_RTOL = 2, 489d15094e1SBarry Smith KSP_CONVERGED_ATOL = 3, 490b335793eSSatish Balay KSP_CONVERGED_ITS = 4, 4918031f4adStmunson KSP_CONVERGED_CG_NEG_CURVE = 5, 4928031f4adStmunson KSP_CONVERGED_CG_CONSTRAINED = 6, 493329f5518SBarry Smith KSP_CONVERGED_STEP_LENGTH = 7, 494af3d8002SBarry Smith KSP_CONVERGED_HAPPY_BREAKDOWN = 8, 495d15094e1SBarry Smith /* diverged */ 496b3cc6726SBarry Smith KSP_DIVERGED_NULL = -2, 497d15094e1SBarry Smith KSP_DIVERGED_ITS = -3, 498d15094e1SBarry Smith KSP_DIVERGED_DTOL = -4, 499d15094e1SBarry Smith KSP_DIVERGED_BREAKDOWN = -5, 500b4ac9ba4SBarry Smith KSP_DIVERGED_BREAKDOWN_BICG = -6, 501b4ac9ba4SBarry Smith KSP_DIVERGED_NONSYMMETRIC = -7, 502b4ac9ba4SBarry Smith KSP_DIVERGED_INDEFINITE_PC = -8, 5034d51c080SBarry Smith KSP_DIVERGED_NANORINF = -9, 5046aee1118SBarry Smith KSP_DIVERGED_INDEFINITE_MAT = -10, 505c0decd05SBarry Smith KSP_DIVERGED_PC_FAILED = -11, 506aa4d2078SSatish Balay KSP_DIVERGED_PCSETUP_FAILED_DEPRECATED = -11, 507d15094e1SBarry Smith 508d15094e1SBarry Smith KSP_CONVERGED_ITERATING = 0} KSPConvergedReason; 509014dd563SJed Brown PETSC_EXTERN const char *const*KSPConvergedReasons; 510d15094e1SBarry Smith 511c838673bSBarry Smith /*MC 512f9fed41fSBarry Smith KSP_CONVERGED_RTOL - norm(r) <= rtol*norm(b) or rtol*norm(b - A*x_0) if KSPConvergedDefaultSetUIRNorm() was called 513c838673bSBarry Smith 514c838673bSBarry Smith Level: beginner 515c838673bSBarry Smith 516c838673bSBarry Smith See KSPNormType and KSPSetNormType() for possible norms that may be used. By default 517c838673bSBarry Smith for left preconditioning it is the 2-norm of the preconditioned residual, and the 518c838673bSBarry Smith 2-norm of the residual for right preconditioning 519c838673bSBarry Smith 520f9fed41fSBarry Smith See also KSP_CONVERGED_ATOL which may apply before this tolerance. 521f9fed41fSBarry Smith 522f9fed41fSBarry Smith .seealso: KSP_CONVERGED_ATOL, KSP_DIVERGED_DTOL, KSPSolve(), KSPGetConvergedReason(), KSPConvergedReason, KSPSetTolerances() 523c838673bSBarry Smith 524c838673bSBarry Smith M*/ 525c838673bSBarry Smith 526c838673bSBarry Smith /*MC 527c838673bSBarry Smith KSP_CONVERGED_ATOL - norm(r) <= atol 528c838673bSBarry Smith 529c838673bSBarry Smith Level: beginner 530c838673bSBarry Smith 531c838673bSBarry Smith See KSPNormType and KSPSetNormType() for possible norms that may be used. By default 532c838673bSBarry Smith for left preconditioning it is the 2-norm of the preconditioned residual, and the 533c838673bSBarry Smith 2-norm of the residual for right preconditioning 534c838673bSBarry Smith 535f9fed41fSBarry Smith See also KSP_CONVERGED_RTOL which may apply before this tolerance. 536c838673bSBarry Smith 537f9fed41fSBarry Smith .seealso: KSP_CONVERGED_RTOL, KSP_DIVERGED_DTOL, KSPSolve(), KSPGetConvergedReason(), KSPConvergedReason, KSPSetTolerances() 538c838673bSBarry Smith 539c838673bSBarry Smith M*/ 540c838673bSBarry Smith 541c838673bSBarry Smith /*MC 542c838673bSBarry Smith KSP_DIVERGED_DTOL - norm(r) >= dtol*norm(b) 543c838673bSBarry Smith 544c838673bSBarry Smith Level: beginner 545c838673bSBarry Smith 546c838673bSBarry Smith See KSPNormType and KSPSetNormType() for possible norms that may be used. By default 547c838673bSBarry Smith for left preconditioning it is the 2-norm of the preconditioned residual, and the 548c838673bSBarry Smith 2-norm of the residual for right preconditioning 549c838673bSBarry Smith 550c838673bSBarry Smith Level: beginner 551c838673bSBarry Smith 552f9fed41fSBarry Smith .seealso: KSP_CONVERGED_ATOL, KSP_DIVERGED_RTOL, KSPSolve(), KSPGetConvergedReason(), KSPConvergedReason, KSPSetTolerances() 553c838673bSBarry Smith 554c838673bSBarry Smith M*/ 555c838673bSBarry Smith 556c838673bSBarry Smith /*MC 557c838673bSBarry Smith KSP_DIVERGED_ITS - Ran out of iterations before any convergence criteria was 558c838673bSBarry Smith reached 559c838673bSBarry Smith 560c838673bSBarry Smith Level: beginner 561c838673bSBarry Smith 562c838673bSBarry Smith .seealso: KSPSolve(), KSPGetConvergedReason(), KSPConvergedReason, KSPSetTolerances() 563c838673bSBarry Smith 564c838673bSBarry Smith M*/ 565c838673bSBarry Smith 566c838673bSBarry Smith /*MC 5678c9406f6SLisandro Dalcin KSP_CONVERGED_ITS - Used by the KSPPREONLY solver after the single iteration of 5680059c7bdSJed Brown the preconditioner is applied. Also used when the KSPConvergedSkip() convergence 5694d0a8057SBarry Smith test routine is set in KSP. 570c838673bSBarry Smith 571c838673bSBarry Smith Level: beginner 572c838673bSBarry Smith 573c838673bSBarry Smith .seealso: KSPSolve(), KSPGetConvergedReason(), KSPConvergedReason, KSPSetTolerances() 574c838673bSBarry Smith 575c838673bSBarry Smith M*/ 576c838673bSBarry Smith 577c838673bSBarry Smith /*MC 578c838673bSBarry Smith KSP_DIVERGED_BREAKDOWN - A breakdown in the Krylov method was detected so the 5791de96524SPierre Jolivet method could not continue to enlarge the Krylov space. Could be due to a singular matrix or 5801de96524SPierre Jolivet preconditioner. In KSPHPDDM, this is also returned when some search directions within a block 5811de96524SPierre Jolivet are colinear. 582c838673bSBarry Smith 583c838673bSBarry Smith Level: beginner 584c838673bSBarry Smith 585c838673bSBarry Smith .seealso: KSPSolve(), KSPGetConvergedReason(), KSPConvergedReason, KSPSetTolerances() 586c838673bSBarry Smith 587c838673bSBarry Smith M*/ 588c838673bSBarry Smith 589c838673bSBarry Smith /*MC 590c838673bSBarry Smith KSP_DIVERGED_BREAKDOWN_BICG - A breakdown in the KSPBICG method was detected so the 591c838673bSBarry Smith method could not continue to enlarge the Krylov space. 592c838673bSBarry Smith 593c838673bSBarry Smith Level: beginner 594c838673bSBarry Smith 595c838673bSBarry Smith .seealso: KSPSolve(), KSPGetConvergedReason(), KSPConvergedReason, KSPSetTolerances() 596c838673bSBarry Smith 597c838673bSBarry Smith M*/ 598c838673bSBarry Smith 599c838673bSBarry Smith /*MC 600c838673bSBarry Smith KSP_DIVERGED_NONSYMMETRIC - It appears the operator or preconditioner is not 601c838673bSBarry Smith symmetric and this Krylov method (KSPCG, KSPMINRES, KSPCR) requires symmetry 602c838673bSBarry Smith 603c838673bSBarry Smith Level: beginner 604c838673bSBarry Smith 605c838673bSBarry Smith .seealso: KSPSolve(), KSPGetConvergedReason(), KSPConvergedReason, KSPSetTolerances() 606c838673bSBarry Smith 607c838673bSBarry Smith M*/ 608c838673bSBarry Smith 609c838673bSBarry Smith /*MC 610c838673bSBarry Smith KSP_DIVERGED_INDEFINITE_PC - It appears the preconditioner is indefinite (has both 611c838673bSBarry Smith positive and negative eigenvalues) and this Krylov method (KSPCG) requires it to 612c838673bSBarry Smith be positive definite 613c838673bSBarry Smith 614c838673bSBarry Smith Level: beginner 615c838673bSBarry Smith 61695452b02SPatrick Sanan Notes: 61795452b02SPatrick Sanan This can happen with the PCICC preconditioner, use -pc_factor_shift_positive_definite to force 618c838673bSBarry Smith the PCICC preconditioner to generate a positive definite preconditioner 619c838673bSBarry Smith 620c838673bSBarry Smith .seealso: KSPSolve(), KSPGetConvergedReason(), KSPConvergedReason, KSPSetTolerances() 621c838673bSBarry Smith 622c838673bSBarry Smith M*/ 623c838673bSBarry Smith 624c838673bSBarry Smith /*MC 625c0decd05SBarry Smith KSP_DIVERGED_PC_FAILED - It was not possible to build or use the requested preconditioner. This is usually due to a 6269fc87aa7SBarry Smith zero pivot in a factorization. It can also result from a failure in a subpreconditioner inside a nested preconditioner 6279fc87aa7SBarry Smith such as PCFIELDSPLIT. 6289fc87aa7SBarry Smith 6299fc87aa7SBarry Smith Level: beginner 6309fc87aa7SBarry Smith 63195452b02SPatrick Sanan Notes: 63295452b02SPatrick Sanan Run with -ksp_error_if_not_converged to stop the program when the error is detected and print an error message with details. 6339fc87aa7SBarry Smith 6349fc87aa7SBarry Smith 6359fc87aa7SBarry Smith .seealso: KSPSolve(), KSPGetConvergedReason(), KSPConvergedReason, KSPSetTolerances() 6369fc87aa7SBarry Smith 6379fc87aa7SBarry Smith M*/ 6389fc87aa7SBarry Smith 6399fc87aa7SBarry Smith /*MC 640c838673bSBarry Smith KSP_CONVERGED_ITERATING - This flag is returned if you call KSPGetConvergedReason() 641c838673bSBarry Smith while the KSPSolve() is still running. 642c838673bSBarry Smith 643c838673bSBarry Smith Level: beginner 644c838673bSBarry Smith 645c838673bSBarry Smith .seealso: KSPSolve(), KSPGetConvergedReason(), KSPConvergedReason, KSPSetTolerances() 646c838673bSBarry Smith 647c838673bSBarry Smith M*/ 648c838673bSBarry Smith 649014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSetConvergenceTest(KSP,PetscErrorCode (*)(KSP,PetscInt,PetscReal,KSPConvergedReason*,void*),void*,PetscErrorCode (*)(void*)); 650df8705c3SBarry Smith PETSC_EXTERN PetscErrorCode KSPGetConvergenceTest(KSP,PetscErrorCode (**)(KSP,PetscInt,PetscReal,KSPConvergedReason*,void*),void**,PetscErrorCode (**)(void*)); 651df8705c3SBarry Smith PETSC_EXTERN PetscErrorCode KSPGetAndClearConvergenceTest(KSP,PetscErrorCode (**)(KSP,PetscInt,PetscReal,KSPConvergedReason*,void*),void**,PetscErrorCode (**)(void*)); 652014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGetConvergenceContext(KSP,void**); 6538de4e6dcSJed Brown PETSC_EXTERN PetscErrorCode KSPConvergedDefault(KSP,PetscInt,PetscReal,KSPConvergedReason*,void*); 6543eeb4429SVaclav Hapla PETSC_EXTERN PetscErrorCode KSPLSQRConvergedDefault(KSP,PetscInt,PetscReal,KSPConvergedReason*,void*); 6558de4e6dcSJed Brown PETSC_EXTERN PetscErrorCode KSPConvergedDefaultDestroy(void*); 6568de4e6dcSJed Brown PETSC_EXTERN PetscErrorCode KSPConvergedDefaultCreate(void**); 6578de4e6dcSJed Brown PETSC_EXTERN PetscErrorCode KSPConvergedDefaultSetUIRNorm(KSP); 6588de4e6dcSJed Brown PETSC_EXTERN PetscErrorCode KSPConvergedDefaultSetUMIRNorm(KSP); 65954b05d9cSStefano Zampini PETSC_EXTERN PetscErrorCode KSPConvergedDefaultSetConvergedMaxits(KSP,PetscBool); 6600059c7bdSJed Brown PETSC_EXTERN PetscErrorCode KSPConvergedSkip(KSP,PetscInt,PetscReal,KSPConvergedReason*,void*); 661014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGetConvergedReason(KSP,KSPConvergedReason*); 662abef13c0SSatish Balay 66325ef9dfeSBarry Smith PETSC_DEPRECATED_FUNCTION("Use KSPConvergedDefault() (since version 3.5)") PETSC_STATIC_INLINE void KSPDefaultConverged(void) { /* never called */ } 6648ea1b3e6SJed Brown #define KSPDefaultConverged (KSPDefaultConverged, KSPConvergedDefault) 66525ef9dfeSBarry Smith PETSC_DEPRECATED_FUNCTION("Use KSPConvergedDefaultDestroy() (since version 3.5)") PETSC_STATIC_INLINE void KSPDefaultConvergedDestroy(void) { /* never called */ } 6668ea1b3e6SJed Brown #define KSPDefaultConvergedDestroy (KSPDefaultConvergedDestroy, KSPConvergedDefaultDestroy) 66725ef9dfeSBarry Smith PETSC_DEPRECATED_FUNCTION("Use KSPConvergedDefaultCreate() (since version 3.5)") PETSC_STATIC_INLINE void KSPDefaultConvergedCreate(void) { /* never called */ } 6688ea1b3e6SJed Brown #define KSPDefaultConvergedCreate (KSPDefaultConvergedCreate, KSPConvergedDefaultCreate) 66925ef9dfeSBarry Smith PETSC_DEPRECATED_FUNCTION("Use KSPConvergedDefaultSetUIRNorm() (since version 3.5)") PETSC_STATIC_INLINE void KSPDefaultConvergedSetUIRNorm(void) { /* never called */ } 6708ea1b3e6SJed Brown #define KSPDefaultConvergedSetUIRNorm (KSPDefaultConvergedSetUIRNorm, KSPConvergedDefaultSetUIRNorm) 67125ef9dfeSBarry Smith PETSC_DEPRECATED_FUNCTION("Use KSPConvergedDefaultSetUMIRNorm() (since version 3.5)") PETSC_STATIC_INLINE void KSPDefaultConvergedSetUMIRNorm(void) { /* never called */ } 6728ea1b3e6SJed Brown #define KSPDefaultConvergedSetUMIRNorm (KSPDefaultConvergedSetUMIRNorm, KSPConvergedDefaultSetUMIRNorm) 67325ef9dfeSBarry Smith PETSC_DEPRECATED_FUNCTION("Use KSPConvergedSkip() (since version 3.5)") PETSC_STATIC_INLINE void KSPSkipConverged(void) { /* never called */ } 6748ea1b3e6SJed Brown #define KSPSkipConverged (KSPSkipConverged, KSPConvergedSkip) 6758ea1b3e6SJed Brown 6760bacdadaSStefano Zampini PETSC_EXTERN PetscErrorCode KSPComputeOperator(KSP,MatType,Mat*); 67725ef9dfeSBarry Smith PETSC_DEPRECATED_FUNCTION("Use KSPComputeOperator() (since version 3.12)") PETSC_STATIC_INLINE PetscErrorCode KSPComputeExplicitOperator(KSP A,Mat* B) { return KSPComputeOperator(A,NULL,B); } 678d4fbbf0eSBarry Smith 67928ce4d24SBarry Smith /*E 68028ce4d24SBarry Smith KSPCGType - Determines what type of CG to use 68128ce4d24SBarry Smith 68228ce4d24SBarry Smith Level: beginner 68328ce4d24SBarry Smith 68428ce4d24SBarry Smith .seealso: KSPCGSetType() 68528ce4d24SBarry Smith E*/ 6869dcbbd2bSBarry Smith typedef enum {KSP_CG_SYMMETRIC=0,KSP_CG_HERMITIAN=1} KSPCGType; 6876a6fc655SJed Brown PETSC_EXTERN const char *const KSPCGTypes[]; 68828ce4d24SBarry Smith 689014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPCGSetType(KSP,KSPCGType); 690014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPCGUseSingleReduction(KSP,PetscBool); 6918031f4adStmunson 692dad1adc6STodd Munson PETSC_EXTERN PetscErrorCode KSPCGSetRadius(KSP,PetscReal); 693dad1adc6STodd Munson PETSC_EXTERN PetscErrorCode KSPCGGetNormD(KSP,PetscReal*); 694dad1adc6STodd Munson PETSC_EXTERN PetscErrorCode KSPCGGetObjFcn(KSP,PetscReal*); 695fcae7a14Stmunson 69605de396fSBarry Smith PETSC_EXTERN PetscErrorCode KSPGLTRGetMinEig(KSP,PetscReal*); 69705de396fSBarry Smith PETSC_EXTERN PetscErrorCode KSPGLTRGetLambda(KSP,PetscReal*); 69825ef9dfeSBarry Smith PETSC_DEPRECATED_FUNCTION("Use KSPGLTRGetMinEig (since v3.12)") PETSC_STATIC_INLINE PetscErrorCode KSPCGGLTRGetMinEig(KSP ksp,PetscReal *x) {return KSPGLTRGetMinEig(ksp,x);} 69925ef9dfeSBarry Smith PETSC_DEPRECATED_FUNCTION("Use KSPGLTRGetLambda (since v3.12)") PETSC_STATIC_INLINE PetscErrorCode KSPCGGLTRGetLambda(KSP ksp,PetscReal *x) {return KSPGLTRGetLambda(ksp,x);} 7008031f4adStmunson 701014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPPythonSetType(KSP,const char[]); 7021d6018f0SLisandro Dalcin 703014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCPreSolve(PC,KSP); 704014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCPostSolve(PC,KSP); 7053369ce9aSBarry Smith 7069804daf3SBarry Smith #include <petscdrawtypes.h> 707d96771aaSLisandro Dalcin PETSC_EXTERN PetscErrorCode KSPMonitorLGResidualNormCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscDrawLG*); 708d96771aaSLisandro Dalcin PETSC_EXTERN PetscErrorCode KSPMonitorLGResidualNorm(KSP,PetscInt,PetscReal,void*); 709d96771aaSLisandro Dalcin PETSC_EXTERN PetscErrorCode KSPMonitorLGTrueResidualNormCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscDrawLG*); 710d96771aaSLisandro Dalcin PETSC_EXTERN PetscErrorCode KSPMonitorLGTrueResidualNorm(KSP,PetscInt,PetscReal,void*); 711014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPMonitorLGRange(KSP,PetscInt,PetscReal,void*); 7122f2e5d10SKris Buschelman 713014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCShellSetPreSolve(PC,PetscErrorCode (*)(PC,KSP,Vec,Vec)); 714014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCShellSetPostSolve(PC,PetscErrorCode (*)(PC,KSP,Vec,Vec)); 71503919abeSBarry Smith 716ba36735cSStefano Zampini /*S 717ba36735cSStefano Zampini KSPGuess - Abstract PETSc object that manages all initial guess methods in Krylov methods. 718f8a50e2bSBarry Smith 719ba36735cSStefano Zampini Level: beginner 720f8a50e2bSBarry Smith 721ba36735cSStefano Zampini .seealso: KSPCreate(), KSPSetGuessType(), KSPGuessType 722ba36735cSStefano Zampini S*/ 723ba36735cSStefano Zampini typedef struct _p_KSPGuess* KSPGuess; 724ba36735cSStefano Zampini /*J 725ba36735cSStefano Zampini KSPGuessType - String with the name of a PETSc initial guess for Krylov methods. 726ba36735cSStefano Zampini 727ba36735cSStefano Zampini Level: beginner 728ba36735cSStefano Zampini 729ba36735cSStefano Zampini .seealso: KSPGuess 730ba36735cSStefano Zampini J*/ 731ba36735cSStefano Zampini typedef const char* KSPGuessType; 732ba36735cSStefano Zampini #define KSPGUESSFISCHER "fischer" 733ba36735cSStefano Zampini #define KSPGUESSPOD "pod" 7341d36bdfdSBarry Smith PETSC_EXTERN PetscErrorCode KSPGuessRegister(const char[],PetscErrorCode (*)(KSPGuess)); 735ba36735cSStefano Zampini PETSC_EXTERN PetscErrorCode KSPSetGuess(KSP,KSPGuess); 736ba36735cSStefano Zampini PETSC_EXTERN PetscErrorCode KSPGetGuess(KSP,KSPGuess*); 737ba36735cSStefano Zampini PETSC_EXTERN PetscErrorCode KSPGuessView(KSPGuess,PetscViewer); 738ba36735cSStefano Zampini PETSC_EXTERN PetscErrorCode KSPGuessDestroy(KSPGuess*); 739ba36735cSStefano Zampini PETSC_EXTERN PetscErrorCode KSPGuessCreate(MPI_Comm,KSPGuess*); 740ba36735cSStefano Zampini PETSC_EXTERN PetscErrorCode KSPGuessSetType(KSPGuess,KSPGuessType); 741ba36735cSStefano Zampini PETSC_EXTERN PetscErrorCode KSPGuessGetType(KSPGuess,KSPGuessType*); 742ba36735cSStefano Zampini PETSC_EXTERN PetscErrorCode KSPGuessSetUp(KSPGuess); 743ba36735cSStefano Zampini PETSC_EXTERN PetscErrorCode KSPGuessUpdate(KSPGuess,Vec,Vec); 744ba36735cSStefano Zampini PETSC_EXTERN PetscErrorCode KSPGuessFormGuess(KSPGuess,Vec,Vec); 745ba36735cSStefano Zampini PETSC_EXTERN PetscErrorCode KSPGuessSetFromOptions(KSPGuess); 746ba36735cSStefano Zampini PETSC_EXTERN PetscErrorCode KSPGuessFischerSetModel(KSPGuess,PetscInt,PetscInt); 747014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSetUseFischerGuess(KSP,PetscInt,PetscInt); 748ba36735cSStefano Zampini PETSC_EXTERN PetscErrorCode KSPSetInitialGuessKnoll(KSP,PetscBool); 749ba36735cSStefano Zampini PETSC_EXTERN PetscErrorCode KSPGetInitialGuessKnoll(KSP,PetscBool*); 750f8a50e2bSBarry Smith 751470b340bSDmitry Karpeev /*E 752470b340bSDmitry Karpeev MatSchurComplementAinvType - Determines how to approximate the inverse of the (0,0) block in Schur complement preconditioning matrix assembly routines 753470b340bSDmitry Karpeev 754470b340bSDmitry Karpeev Level: intermediate 755470b340bSDmitry Karpeev 756470b340bSDmitry Karpeev .seealso: MatSchurComplementGetAinvType(), MatSchurComplementSetAinvType(), MatSchurComplementGetPmat(), MatGetSchurComplement(), MatCreateSchurComplementPmat() 757470b340bSDmitry Karpeev E*/ 7580c42975cSTristan Konolige typedef enum {MAT_SCHUR_COMPLEMENT_AINV_DIAG, MAT_SCHUR_COMPLEMENT_AINV_LUMP, MAT_SCHUR_COMPLEMENT_AINV_BLOCK_DIAG} MatSchurComplementAinvType; 759470b340bSDmitry Karpeev PETSC_EXTERN const char *const MatSchurComplementAinvTypes[]; 760470b340bSDmitry Karpeev 761864588a7SAlp Dener typedef enum {MAT_LMVM_SYMBROYDEN_SCALE_NONE = 0, 762864588a7SAlp Dener MAT_LMVM_SYMBROYDEN_SCALE_SCALAR = 1, 763864588a7SAlp Dener MAT_LMVM_SYMBROYDEN_SCALE_DIAGONAL = 2, 764864588a7SAlp Dener MAT_LMVM_SYMBROYDEN_SCALE_USER = 3} MatLMVMSymBroydenScaleType; 765864588a7SAlp Dener PETSC_EXTERN const char *const MatLMVMSymBroydenScaleTypes[]; 76692f76d53SAlp Dener 767014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateSchurComplement(Mat,Mat,Mat,Mat,Mat,Mat*); 768014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSchurComplementGetKSP(Mat,KSP*); 769d2768c1eSMatthew G Knepley PETSC_EXTERN PetscErrorCode MatSchurComplementSetKSP(Mat,KSP); 770bee83525SDmitry Karpeev PETSC_EXTERN PetscErrorCode MatSchurComplementSetSubMatrices(Mat,Mat,Mat,Mat,Mat,Mat); 771aa6c7ce3SBarry Smith PETSC_EXTERN PetscErrorCode MatSchurComplementUpdateSubMatrices(Mat,Mat,Mat,Mat,Mat,Mat); 772bee83525SDmitry Karpeev PETSC_EXTERN PetscErrorCode MatSchurComplementGetSubMatrices(Mat,Mat*,Mat*,Mat*,Mat*,Mat*); 773470b340bSDmitry Karpeev PETSC_EXTERN PetscErrorCode MatSchurComplementSetAinvType(Mat,MatSchurComplementAinvType); 774470b340bSDmitry Karpeev PETSC_EXTERN PetscErrorCode MatSchurComplementGetAinvType(Mat,MatSchurComplementAinvType*); 7755bf40c1dSDmitry Karpeev PETSC_EXTERN PetscErrorCode MatSchurComplementGetPmat(Mat,MatReuse,Mat*); 7765a1c817aSMatthew G. Knepley PETSC_EXTERN PetscErrorCode MatSchurComplementComputeExplicitOperator(Mat,Mat*); 777470b340bSDmitry Karpeev PETSC_EXTERN PetscErrorCode MatGetSchurComplement(Mat,IS,IS,IS,IS,MatReuse,Mat*,MatSchurComplementAinvType,MatReuse,Mat*); 778470b340bSDmitry Karpeev PETSC_EXTERN PetscErrorCode MatCreateSchurComplementPmat(Mat,Mat,Mat,Mat,MatSchurComplementAinvType,MatReuse,Mat*); 7793f22127dSBarry Smith 78078e4361aSAlp Dener PETSC_EXTERN PetscErrorCode MatCreateLMVMDFP(MPI_Comm,PetscInt,PetscInt,Mat*); 78178e4361aSAlp Dener PETSC_EXTERN PetscErrorCode MatCreateLMVMBFGS(MPI_Comm,PetscInt,PetscInt,Mat*); 78278e4361aSAlp Dener PETSC_EXTERN PetscErrorCode MatCreateLMVMSR1(MPI_Comm,PetscInt,PetscInt,Mat*); 783864588a7SAlp Dener PETSC_EXTERN PetscErrorCode MatCreateLMVMBroyden(MPI_Comm,PetscInt,PetscInt,Mat*); 784864588a7SAlp Dener PETSC_EXTERN PetscErrorCode MatCreateLMVMBadBroyden(MPI_Comm,PetscInt,PetscInt,Mat*); 785864588a7SAlp Dener PETSC_EXTERN PetscErrorCode MatCreateLMVMSymBroyden(MPI_Comm,PetscInt,PetscInt,Mat*); 786864588a7SAlp Dener PETSC_EXTERN PetscErrorCode MatCreateLMVMSymBadBroyden(MPI_Comm,PetscInt,PetscInt,Mat*); 787864588a7SAlp Dener PETSC_EXTERN PetscErrorCode MatCreateLMVMDiagBroyden(MPI_Comm,PetscInt,PetscInt,Mat*); 788cd929ea3SAlp Dener 789cd929ea3SAlp Dener PETSC_EXTERN PetscErrorCode MatLMVMUpdate(Mat, Vec, Vec); 790b2d8c577SAlp Dener PETSC_EXTERN PetscErrorCode MatLMVMIsAllocated(Mat, PetscBool*); 791cd929ea3SAlp Dener PETSC_EXTERN PetscErrorCode MatLMVMAllocate(Mat, Vec, Vec); 792cd929ea3SAlp Dener PETSC_EXTERN PetscErrorCode MatLMVMReset(Mat, PetscBool); 793e0ed867bSAlp Dener PETSC_EXTERN PetscErrorCode MatLMVMResetShift(Mat); 7940ad3a497SAlp Dener PETSC_EXTERN PetscErrorCode MatLMVMClearJ0(Mat); 795cd929ea3SAlp Dener PETSC_EXTERN PetscErrorCode MatLMVMSetJ0(Mat, Mat); 796cd929ea3SAlp Dener PETSC_EXTERN PetscErrorCode MatLMVMSetJ0Scale(Mat, PetscReal); 797cd929ea3SAlp Dener PETSC_EXTERN PetscErrorCode MatLMVMSetJ0Diag(Mat, Vec); 798cd929ea3SAlp Dener PETSC_EXTERN PetscErrorCode MatLMVMSetJ0PC(Mat, PC); 799cd929ea3SAlp Dener PETSC_EXTERN PetscErrorCode MatLMVMSetJ0KSP(Mat, KSP); 8002d5e3849SAlp Dener PETSC_EXTERN PetscErrorCode MatLMVMApplyJ0Fwd(Mat, Vec, Vec); 801cd929ea3SAlp Dener PETSC_EXTERN PetscErrorCode MatLMVMApplyJ0Inv(Mat, Vec, Vec); 802cd929ea3SAlp Dener PETSC_EXTERN PetscErrorCode MatLMVMGetJ0(Mat, Mat*); 803cd929ea3SAlp Dener PETSC_EXTERN PetscErrorCode MatLMVMGetJ0PC(Mat, PC*); 804cd929ea3SAlp Dener PETSC_EXTERN PetscErrorCode MatLMVMGetJ0KSP(Mat, KSP*); 80592f76d53SAlp Dener PETSC_EXTERN PetscErrorCode MatLMVMSetHistorySize(Mat, PetscInt); 806cd929ea3SAlp Dener PETSC_EXTERN PetscErrorCode MatLMVMGetUpdateCount(Mat, PetscInt*); 807cd929ea3SAlp Dener PETSC_EXTERN PetscErrorCode MatLMVMGetRejectCount(Mat, PetscInt*); 808864588a7SAlp Dener PETSC_EXTERN PetscErrorCode MatLMVMSymBroydenSetDelta(Mat, PetscScalar); 809864588a7SAlp Dener PETSC_EXTERN PetscErrorCode MatLMVMSymBroydenSetScaleType(Mat, MatLMVMSymBroydenScaleType); 810cd929ea3SAlp Dener 811014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSetDM(KSP,DM); 812014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSetDMActive(KSP,PetscBool); 813014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGetDM(KSP,DM*); 814014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSetApplicationContext(KSP,void*); 815014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGetApplicationContext(KSP,void*); 816fbd07b44SBarry Smith PETSC_EXTERN PetscErrorCode KSPSetComputeRHS(KSP,PetscErrorCode (*func)(KSP,Vec,void*),void*); 81723ee1639SBarry Smith PETSC_EXTERN PetscErrorCode KSPSetComputeOperators(KSP,PetscErrorCode(*)(KSP,Mat,Mat,void*),void*); 818fbd07b44SBarry Smith PETSC_EXTERN PetscErrorCode KSPSetComputeInitialGuess(KSP,PetscErrorCode(*)(KSP,Vec,void*),void*); 81923ee1639SBarry Smith PETSC_EXTERN PetscErrorCode DMKSPSetComputeOperators(DM,PetscErrorCode(*)(KSP,Mat,Mat,void*),void*); 82023ee1639SBarry Smith PETSC_EXTERN PetscErrorCode DMKSPGetComputeOperators(DM,PetscErrorCode(**)(KSP,Mat,Mat,void*),void*); 821014dd563SJed Brown PETSC_EXTERN PetscErrorCode DMKSPSetComputeRHS(DM,PetscErrorCode(*)(KSP,Vec,void*),void*); 822014dd563SJed Brown PETSC_EXTERN PetscErrorCode DMKSPGetComputeRHS(DM,PetscErrorCode(**)(KSP,Vec,void*),void*); 823fbd07b44SBarry Smith PETSC_EXTERN PetscErrorCode DMKSPSetComputeInitialGuess(DM,PetscErrorCode(*)(KSP,Vec,void*),void*); 824fbd07b44SBarry Smith PETSC_EXTERN PetscErrorCode DMKSPGetComputeInitialGuess(DM,PetscErrorCode(**)(KSP,Vec,void*),void*); 8256c699258SBarry Smith 82602b02e71SToby Isaac PETSC_EXTERN PetscErrorCode DMGlobalToLocalSolve(DM,Vec,Vec); 8278c6c5593SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMProjectField(DM, PetscReal, Vec, 828e29c0834SMatthew G. Knepley void (**)(PetscInt, PetscInt, PetscInt, 829e29c0834SMatthew G. Knepley const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], 830e29c0834SMatthew G. Knepley const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], 831191494d9SMatthew G. Knepley PetscReal, const PetscReal [], PetscInt, const PetscScalar[], PetscScalar []), InsertMode, Vec); 832557cf195SMatthew G. Knepley 833557cf195SMatthew G. Knepley 834557cf195SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMAdaptInterpolator(DM, DM, Mat, KSP, PetscInt, Vec[], Vec[], Mat *, void *); 835557cf195SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMCheckInterpolator(DM, Mat, PetscInt, Vec[], Vec[], PetscReal); 8362eac72dbSBarry Smith #endif 837