xref: /petsc/include/petscksp.h (revision c0decd05c6848b80907752eef350b55c8c90e696)
1f26ada1bSBarry Smith /*
2f26ada1bSBarry Smith    Defines the interface functions for the Krylov subspace accelerators.
3f26ada1bSBarry Smith */
40a835dfdSSatish Balay #ifndef __PETSCKSP_H
50a835dfdSSatish Balay #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 
1628ce4d24SBarry Smith   Concepts: Krylov methods
1728ce4d24SBarry Smith 
1895452b02SPatrick Sanan         Notes:
1995452b02SPatrick Sanan     When a direct solver is used but no Krylov solver is used the KSP object is still used by with a
208f6c3df8SBarry Smith        KSPType of KSPPREONLY (meaning application of the preconditioner is only used as the linear solver).
218f6c3df8SBarry Smith 
22bca11509SBarry Smith .seealso:  KSPCreate(), KSPSetType(), KSPType, SNES, TS, PC, KSP, KSPDestroy(), KSPCG, KSPGMRES
2328ce4d24SBarry Smith S*/
24e2a1c21fSSatish Balay typedef struct _p_KSP*     KSP;
252eac72dbSBarry Smith 
2676bdecfbSBarry Smith /*J
278f6c3df8SBarry Smith     KSPType - String with the name of a PETSc Krylov method.
2828ce4d24SBarry Smith 
2928ce4d24SBarry Smith    Level: beginner
3028ce4d24SBarry Smith 
318f6c3df8SBarry Smith .seealso: KSPSetType(), KSP, KSPRegister(), KSPCreate(), KSPSetFromOptions()
3276bdecfbSBarry Smith J*/
3319fd82e9SBarry Smith typedef const char* KSPType;
3482bf6240SBarry Smith #define KSPRICHARDSON "richardson"
356c9de887SHong Zhang #define KSPCHEBYSHEV  "chebyshev"
3682bf6240SBarry Smith #define KSPCG         "cg"
372c8fc646SJed Brown #define KSPGROPPCG    "groppcg"
382c8fc646SJed Brown #define KSPPIPECG     "pipecg"
39901ccb91SSiegfried Cools #define KSPPIPECGRR   "pipecgrr"
40265663fdSSiegfried Cools #define KSPPIPELCG     "pipelcg"
41df2a969aSvictorle #define   KSPCGNE       "cgne"
421155b781STodd Munson #define   KSPCGNASH     "nash"
431155b781STodd Munson #define   KSPCGSTCG     "stcg"
441155b781STodd Munson #define   KSPCGGLTR     "gltr"
45640f4f53SPatrick Sanan #define KSPFCG        "fcg"
46390d8e47SPatrick Sanan #define KSPPIPEFCG    "pipefcg"
4782bf6240SBarry Smith #define KSPGMRES      "gmres"
48483d6965SPatrick Sanan #define KSPPIPEFGMRES "pipefgmres"
499dcbbd2bSBarry Smith #define   KSPFGMRES     "fgmres"
509dcbbd2bSBarry Smith #define   KSPLGMRES     "lgmres"
514f8e6cd9SSatish Balay #define   KSPDGMRES     "dgmres"
5261b468f9SJed Brown #define   KSPPGMRES     "pgmres"
5382bf6240SBarry Smith #define KSPTCQMR      "tcqmr"
5482bf6240SBarry Smith #define KSPBCGS       "bcgs"
55e1c61ce8SBarry Smith #define   KSPIBCGS      "ibcgs"
5618ac38e6SHong Zhang #define   KSPFBCGS      "fbcgs"
57c2b71004SHong Zhang #define   KSPFBCGSR     "fbcgsr"
58f0037002Svictorle #define   KSPBCGSL      "bcgsl"
59f154af2dSSiegfried Cools #define   KSPPIPEBCGS   "pipebcgs"
6082bf6240SBarry Smith #define KSPCGS        "cgs"
6182bf6240SBarry Smith #define KSPTFQMR      "tfqmr"
6282bf6240SBarry Smith #define KSPCR         "cr"
632c8fc646SJed Brown #define KSPPIPECR     "pipecr"
6482bf6240SBarry Smith #define KSPLSQR       "lsqr"
6582bf6240SBarry Smith #define KSPPREONLY    "preonly"
6682bf6240SBarry Smith #define KSPQCG        "qcg"
67c9cf9b11SBarry Smith #define KSPBICG       "bicg"
68b4ac9ba4SBarry Smith #define KSPMINRES     "minres"
6901c5daebSSatish Balay #define KSPSYMMLQ     "symmlq"
7021356919SSatish Balay #define KSPLCD        "lcd"
711d6018f0SLisandro Dalcin #define KSPPYTHON     "python"
7258ad63f4SBarry Smith #define KSPGCR        "gcr"
73fad47a0aSPatrick Sanan #define KSPPIPEGCR    "pipegcr"
74e4d80e07Szianekhodja #define KSPTSIRM      "tsirm"
75e4d80e07Szianekhodja #define KSPCGLS       "cgls"
76329cd39dSStefano Zampini #define KSPFETIDP     "fetidp"
772eac72dbSBarry Smith 
788ba1e511SMatthew Knepley /* Logging support */
79014dd563SJed Brown PETSC_EXTERN PetscClassId KSP_CLASSID;
80ba36735cSStefano Zampini PETSC_EXTERN PetscClassId KSPGUESS_CLASSID;
815358d0d4SBarry Smith PETSC_EXTERN PetscClassId DMKSP_CLASSID;
828ba1e511SMatthew Knepley 
83014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPCreate(MPI_Comm,KSP*);
8419fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode KSPSetType(KSP,KSPType);
85c60c7ad4SBarry Smith PETSC_EXTERN PetscErrorCode KSPGetType(KSP,KSPType*);
86014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSetUp(KSP);
87014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSetUpOnBlocks(KSP);
88014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSolve(KSP,Vec,Vec);
89014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSolveTranspose(KSP,Vec,Vec);
90014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPReset(KSP);
91014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPDestroy(KSP*);
9223ee1639SBarry Smith PETSC_EXTERN PetscErrorCode KSPSetReusePreconditioner(KSP,PetscBool);
9325c41539SBarry Smith PETSC_EXTERN PetscErrorCode KSPSetSkipPCSetFromOptions(KSP,PetscBool);
94*c0decd05SBarry Smith PETSC_EXTERN PetscErrorCode KSPCheckSolve(KSP,PC,Vec);
952eac72dbSBarry Smith 
96140e18c1SBarry Smith PETSC_EXTERN PetscFunctionList KSPList;
97ba36735cSStefano Zampini PETSC_EXTERN PetscFunctionList KSPGuessList;
98bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode KSPRegister(const char[],PetscErrorCode (*)(KSP));
9930de9b25SBarry Smith 
100014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSetPCSide(KSP,PCSide);
101014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGetPCSide(KSP,PCSide*);
102014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSetTolerances(KSP,PetscReal,PetscReal,PetscReal,PetscInt);
103c60c7ad4SBarry Smith PETSC_EXTERN PetscErrorCode KSPGetTolerances(KSP,PetscReal*,PetscReal*,PetscReal*,PetscInt*);
104014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSetInitialGuessNonzero(KSP,PetscBool);
105014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGetInitialGuessNonzero(KSP,PetscBool*);
106014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSetErrorIfNotConverged(KSP,PetscBool);
107014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGetErrorIfNotConverged(KSP,PetscBool*);
108014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSetComputeEigenvalues(KSP,PetscBool);
1097d7fa35eSSylvain Mercier PETSC_EXTERN PetscErrorCode KSPSetComputeRitz(KSP,PetscBool);
110c60c7ad4SBarry Smith PETSC_EXTERN PetscErrorCode KSPGetComputeEigenvalues(KSP,PetscBool*);
111014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSetComputeSingularValues(KSP,PetscBool);
112c60c7ad4SBarry Smith PETSC_EXTERN PetscErrorCode KSPGetComputeSingularValues(KSP,PetscBool*);
113014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGetRhs(KSP,Vec*);
114014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGetSolution(KSP,Vec*);
115014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGetResidualNorm(KSP,PetscReal*);
116014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGetIterationNumber(KSP,PetscInt*);
117734794cfSBarry Smith PETSC_EXTERN PetscErrorCode KSPGetTotalIterations(KSP,PetscInt*);
1182a7a6963SBarry Smith PETSC_EXTERN PetscErrorCode KSPCreateVecs(KSP,PetscInt,Vec**,PetscInt,Vec**);
1192a7a6963SBarry Smith PETSC_DEPRECATED("Use KSPCreateVecs()") PETSC_STATIC_INLINE PetscErrorCode KSPGetVecs(KSP ksp,PetscInt n,Vec **x,PetscInt m,Vec **y) {return KSPCreateVecs(ksp,n,x,m,y);}
1202eac72dbSBarry Smith 
121d4211eb9SBarry Smith PETSC_EXTERN PetscErrorCode KSPSetPreSolve(KSP,PetscErrorCode (*)(KSP,Vec,Vec,void*),void*);
122d4211eb9SBarry Smith PETSC_EXTERN PetscErrorCode KSPSetPostSolve(KSP,PetscErrorCode (*)(KSP,Vec,Vec,void*),void*);
123d4211eb9SBarry Smith 
124014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSetPC(KSP,PC);
125014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGetPC(KSP,PC*);
126aabeff55SBarry Smith 
127014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPMonitor(KSP,PetscInt,PetscReal);
128014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPMonitorSet(KSP,PetscErrorCode (*)(KSP,PetscInt,PetscReal,void*),void*,PetscErrorCode (*)(void**));
129014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPMonitorCancel(KSP);
130014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGetMonitorContext(KSP,void**);
131014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGetResidualHistory(KSP,PetscReal*[],PetscInt*);
132014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSetResidualHistory(KSP,PetscReal[],PetscInt,PetscBool );
1334b0e389bSBarry Smith 
134fa0ddf94SBarry Smith PETSC_EXTERN PetscErrorCode KSPBuildSolutionDefault(KSP,Vec,Vec*);
135fa0ddf94SBarry Smith PETSC_EXTERN PetscErrorCode KSPBuildResidualDefault(KSP,Vec,Vec,Vec*);
136fa0ddf94SBarry Smith PETSC_EXTERN PetscErrorCode KSPDestroyDefault(KSP);
137fa0ddf94SBarry Smith PETSC_EXTERN PetscErrorCode KSPSetWorkVecs(KSP,PetscInt);
138fa0ddf94SBarry Smith 
139014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCKSPGetKSP(PC,KSP*);
140cfebe74eSStefano Zampini PETSC_EXTERN PetscErrorCode PCKSPSetKSP(PC,KSP);
141014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCBJacobiGetSubKSP(PC,PetscInt*,PetscInt*,KSP*[]);
142014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCASMGetSubKSP(PC,PetscInt*,PetscInt*,KSP*[]);
143014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCGASMGetSubKSP(PC,PetscInt*,PetscInt*,KSP*[]);
144014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCFieldSplitGetSubKSP(PC,PetscInt*,KSP*[]);
145285fb4e2SStefano Zampini PETSC_EXTERN PetscErrorCode PCFieldSplitSchurGetSubKSP(PC,PetscInt*,KSP*[]);
146b4876bcbSBarry Smith PETSC_EXTERN PetscErrorCode PCMGGetSmoother(PC,PetscInt,KSP*);
147b4876bcbSBarry Smith PETSC_EXTERN PetscErrorCode PCMGGetSmootherDown(PC,PetscInt,KSP*);
148b4876bcbSBarry Smith PETSC_EXTERN PetscErrorCode PCMGGetSmootherUp(PC,PetscInt,KSP*);
149b4876bcbSBarry Smith PETSC_EXTERN PetscErrorCode PCMGGetCoarseSolve(PC,KSP*);
150014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCGalerkinGetKSP(PC,KSP*);
1510a71e23eSMatthew Knepley 
152014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPBuildSolution(KSP,Vec,Vec*);
153014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPBuildResidual(KSP,Vec,Vec,Vec*);
1542eac72dbSBarry Smith 
155014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPRichardsonSetScale(KSP,PetscReal);
156014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPRichardsonSetSelfScale(KSP,PetscBool );
157014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPChebyshevSetEigenvalues(KSP,PetscReal,PetscReal);
15858450487SBarry Smith PETSC_EXTERN PetscErrorCode KSPChebyshevEstEigSet(KSP,PetscReal,PetscReal,PetscReal,PetscReal);
159b65fd476SMark Adams PETSC_EXTERN PetscErrorCode KSPChebyshevEstEigSetUseNoisy(KSP,PetscBool);
16058450487SBarry Smith PETSC_EXTERN PetscErrorCode KSPChebyshevEstEigGetKSP(KSP,KSP*);
161014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPComputeExtremeSingularValues(KSP,PetscReal*,PetscReal*);
162d38fc84dSBarry Smith PETSC_EXTERN PetscErrorCode KSPComputeEigenvalues(KSP,PetscInt,PetscReal[],PetscReal[],PetscInt*);
163d38fc84dSBarry Smith PETSC_EXTERN PetscErrorCode KSPComputeEigenvaluesExplicitly(KSP,PetscInt,PetscReal[],PetscReal[]);
1647d7fa35eSSylvain Mercier PETSC_EXTERN PetscErrorCode KSPComputeRitz(KSP,PetscBool,PetscBool,PetscInt*,Vec[],PetscReal[],PetscReal[]);
1654b0e389bSBarry Smith 
166640f4f53SPatrick Sanan /*E
167640f4f53SPatrick Sanan 
16806137d0aSPatrick Sanan   KSPFCDTruncationType - Define how stored directions are used to orthogonalize in flexible conjugate directions (FCD) methods
169640f4f53SPatrick Sanan 
17093f1e87bSPatrick Sanan   KSP_FCD_TRUNC_TYPE_STANDARD uses all (up to mmax) stored directions
17193f1e87bSPatrick Sanan   KSP_FCD_TRUNC_TYPE_NOTAY uses the last max(1,mod(i,mmax)) stored directions at iteration i=0,1..
172640f4f53SPatrick Sanan 
1732b26979fSBarry Smith    Level: intermediate
17406137d0aSPatrick Sanan .seealso : KSPFCG,KSPPIPEFCG,KSPPIPEGCR,KSPFCGSetTruncationType(),KSPFCGGetTruncationType()
175640f4f53SPatrick Sanan 
176640f4f53SPatrick Sanan E*/
17793f1e87bSPatrick Sanan typedef enum {KSP_FCD_TRUNC_TYPE_STANDARD,KSP_FCD_TRUNC_TYPE_NOTAY} KSPFCDTruncationType;
17806137d0aSPatrick Sanan PETSC_EXTERN const char *const KSPFCDTruncationTypes[];
179640f4f53SPatrick Sanan 
180640f4f53SPatrick Sanan PETSC_EXTERN PetscErrorCode KSPFCGSetMmax(KSP,PetscInt);
181640f4f53SPatrick Sanan PETSC_EXTERN PetscErrorCode KSPFCGGetMmax(KSP,PetscInt*);
182640f4f53SPatrick Sanan PETSC_EXTERN PetscErrorCode KSPFCGSetNprealloc(KSP,PetscInt);
183640f4f53SPatrick Sanan PETSC_EXTERN PetscErrorCode KSPFCGGetNprealloc(KSP,PetscInt*);
18406137d0aSPatrick Sanan PETSC_EXTERN PetscErrorCode KSPFCGSetTruncationType(KSP,KSPFCDTruncationType);
18506137d0aSPatrick Sanan PETSC_EXTERN PetscErrorCode KSPFCGGetTruncationType(KSP,KSPFCDTruncationType*);
186640f4f53SPatrick Sanan 
187390d8e47SPatrick Sanan PETSC_EXTERN PetscErrorCode KSPPIPEFCGSetMmax(KSP,PetscInt);
188390d8e47SPatrick Sanan PETSC_EXTERN PetscErrorCode KSPPIPEFCGGetMmax(KSP,PetscInt*);
189390d8e47SPatrick Sanan PETSC_EXTERN PetscErrorCode KSPPIPEFCGSetNprealloc(KSP,PetscInt);
190390d8e47SPatrick Sanan PETSC_EXTERN PetscErrorCode KSPPIPEFCGGetNprealloc(KSP,PetscInt*);
191390d8e47SPatrick Sanan PETSC_EXTERN PetscErrorCode KSPPIPEFCGSetTruncationType(KSP,KSPFCDTruncationType);
192390d8e47SPatrick Sanan PETSC_EXTERN PetscErrorCode KSPPIPEFCGGetTruncationType(KSP,KSPFCDTruncationType*);
193390d8e47SPatrick Sanan 
194fad47a0aSPatrick Sanan PETSC_EXTERN PetscErrorCode KSPPIPEGCRSetMmax(KSP,PetscInt);
195fad47a0aSPatrick Sanan PETSC_EXTERN PetscErrorCode KSPPIPEGCRGetMmax(KSP,PetscInt*);
196fad47a0aSPatrick Sanan PETSC_EXTERN PetscErrorCode KSPPIPEGCRSetNprealloc(KSP,PetscInt);
197fad47a0aSPatrick Sanan PETSC_EXTERN PetscErrorCode KSPPIPEGCRGetNprealloc(KSP,PetscInt*);
198fad47a0aSPatrick Sanan PETSC_EXTERN PetscErrorCode KSPPIPEGCRSetTruncationType(KSP,KSPFCDTruncationType);
199fad47a0aSPatrick Sanan PETSC_EXTERN PetscErrorCode KSPPIPEGCRGetTruncationType(KSP,KSPFCDTruncationType*);
200fad47a0aSPatrick Sanan PETSC_EXTERN PetscErrorCode KSPPIPEGCRSetUnrollW(KSP,PetscBool);
201fad47a0aSPatrick Sanan PETSC_EXTERN PetscErrorCode KSPPIPEGCRGetUnrollW(KSP,PetscBool*);
20283f0b094SBarry Smith 
203014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGMRESSetRestart(KSP, PetscInt);
204014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGMRESGetRestart(KSP, PetscInt*);
205014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGMRESSetHapTol(KSP,PetscReal);
2069f236934SBarry Smith 
207014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGMRESSetPreAllocateVectors(KSP);
208014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGMRESSetOrthogonalization(KSP,PetscErrorCode (*)(KSP,PetscInt));
209014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGMRESGetOrthogonalization(KSP,PetscErrorCode (**)(KSP,PetscInt));
210014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGMRESModifiedGramSchmidtOrthogonalization(KSP,PetscInt);
211014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGMRESClassicalGramSchmidtOrthogonalization(KSP,PetscInt);
2121d73ed98SBarry Smith 
213014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPLGMRESSetAugDim(KSP,PetscInt);
214014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPLGMRESSetConstant(KSP);
2151d73ed98SBarry Smith 
216483d6965SPatrick Sanan PETSC_EXTERN PetscErrorCode KSPPIPEFGMRESSetShift(KSP,PetscScalar);
217483d6965SPatrick Sanan 
218014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGCRSetRestart(KSP,PetscInt);
219014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGCRGetRestart(KSP,PetscInt*);
220014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGCRSetModifyPC(KSP,PetscErrorCode (*)(KSP,PetscInt,PetscReal,void*),void*,PetscErrorCode(*)(void*));
22158ad63f4SBarry Smith 
22204d8bde8SStefano Zampini PETSC_EXTERN PetscErrorCode KSPFETIDPGetInnerBDDC(KSP,PC*);
22304d8bde8SStefano Zampini PETSC_EXTERN PetscErrorCode KSPFETIDPSetInnerBDDC(KSP,PC);
22404d8bde8SStefano Zampini PETSC_EXTERN PetscErrorCode KSPFETIDPGetInnerKSP(KSP,KSP*);
225568c15deSstefano_zampini PETSC_EXTERN PetscErrorCode KSPFETIDPSetPressureOperator(KSP,Mat);
226b49fd9e1SBarry Smith /*E
227b49fd9e1SBarry Smith     KSPGMRESCGSRefinementType - How the classical (unmodified) Gram-Schmidt is performed.
228b49fd9e1SBarry Smith 
229b49fd9e1SBarry Smith    Level: advanced
230b49fd9e1SBarry Smith 
231bef9c725SBarry Smith .seealso: KSPGMRESClassicalGramSchmidtOrthogonalization(), KSPGMRESSetOrthogonalization(), KSPGMRESGetOrthogonalization(),
232e928de20SBarry Smith           KSPGMRESSetCGSRefinementType(), KSPGMRESGetCGSRefinementType(), KSPGMRESModifiedGramSchmidtOrthogonalization()
233b49fd9e1SBarry Smith 
234b49fd9e1SBarry Smith E*/
23578d1dd23SKris Buschelman typedef enum {KSP_GMRES_CGS_REFINE_NEVER, KSP_GMRES_CGS_REFINE_IFNEEDED, KSP_GMRES_CGS_REFINE_ALWAYS} KSPGMRESCGSRefinementType;
2366a6fc655SJed Brown PETSC_EXTERN const char *const KSPGMRESCGSRefinementTypes[];
2371f7e983dSSatish Balay /*MC
2381957e957SBarry Smith     KSP_GMRES_CGS_REFINE_NEVER - Do the classical (unmodified) Gram-Schmidt process
2398c5b8ba0SBarry Smith 
2408c5b8ba0SBarry Smith    Level: advanced
2418c5b8ba0SBarry Smith 
2428c5b8ba0SBarry Smith    Note: Possible unstable, but the fastest to compute
2438c5b8ba0SBarry Smith 
244bef9c725SBarry Smith .seealso: KSPGMRESClassicalGramSchmidtOrthogonalization(), KSPGMRESSetOrthogonalization(), KSPGMRESGetOrthogonalization(),
245e928de20SBarry Smith           KSPGMRESSetCGSRefinementType(), KSPGMRESGetCGSRefinementType(), KSP_GMRES_CGS_REFINE_IFNEEDED, KSP_GMRES_CGS_REFINE_ALWAYS,
2468c5b8ba0SBarry Smith           KSPGMRESModifiedGramSchmidtOrthogonalization()
2478c5b8ba0SBarry Smith M*/
2488c5b8ba0SBarry Smith 
2491f7e983dSSatish Balay /*MC
2508c5b8ba0SBarry Smith     KSP_GMRES_CGS_REFINE_IFNEEDED - Do the classical (unmodified) Gram-Schmidt process and one step of
2518c5b8ba0SBarry Smith           iterative refinement if an estimate of the orthogonality of the resulting vectors indicates
2528c5b8ba0SBarry Smith           poor orthogonality.
2538c5b8ba0SBarry Smith 
2548c5b8ba0SBarry Smith    Level: advanced
2558c5b8ba0SBarry Smith 
2568c5b8ba0SBarry Smith    Note: This is slower than KSP_GMRES_CGS_REFINE_NEVER because it requires an extra norm computation to
2578c5b8ba0SBarry Smith      estimate the orthogonality but is more stable.
2588c5b8ba0SBarry Smith 
259bef9c725SBarry Smith .seealso: KSPGMRESClassicalGramSchmidtOrthogonalization(), KSPGMRESSetOrthogonalization(), KSPGMRESGetOrthogonalization(),
260e928de20SBarry Smith           KSPGMRESSetCGSRefinementType(), KSPGMRESGetCGSRefinementType(), KSP_GMRES_CGS_REFINE_NEVER, KSP_GMRES_CGS_REFINE_ALWAYS,
2618c5b8ba0SBarry Smith           KSPGMRESModifiedGramSchmidtOrthogonalization()
2628c5b8ba0SBarry Smith M*/
2638c5b8ba0SBarry Smith 
2641f7e983dSSatish Balay /*MC
2658c5b8ba0SBarry Smith     KSP_GMRES_CGS_REFINE_NEVER - Do two steps of the classical (unmodified) Gram-Schmidt process.
2668c5b8ba0SBarry Smith 
2678c5b8ba0SBarry Smith    Level: advanced
2688c5b8ba0SBarry Smith 
2698c5b8ba0SBarry Smith    Note: This is roughly twice the cost of KSP_GMRES_CGS_REFINE_NEVER because it performs the process twice
2708c5b8ba0SBarry Smith      but it saves the extra norm calculation needed by KSP_GMRES_CGS_REFINE_IFNEEDED.
2718c5b8ba0SBarry Smith 
2728c5b8ba0SBarry Smith         You should only use this if you absolutely know that the iterative refinement is needed.
2738c5b8ba0SBarry Smith 
274bef9c725SBarry Smith .seealso: KSPGMRESClassicalGramSchmidtOrthogonalization(), KSPGMRESSetOrthogonalization(), KSPGMRESGetOrthogonalization(),
275e928de20SBarry Smith           KSPGMRESSetCGSRefinementType(), KSPGMRESGetCGSRefinementType(), KSP_GMRES_CGS_REFINE_IFNEEDED, KSP_GMRES_CGS_REFINE_ALWAYS,
2768c5b8ba0SBarry Smith           KSPGMRESModifiedGramSchmidtOrthogonalization()
2778c5b8ba0SBarry Smith M*/
2788c5b8ba0SBarry Smith 
279014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGMRESSetCGSRefinementType(KSP,KSPGMRESCGSRefinementType);
280014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGMRESGetCGSRefinementType(KSP,KSPGMRESCGSRefinementType*);
28108480c60SBarry Smith 
282014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPFGMRESModifyPCNoChange(KSP,PetscInt,PetscInt,PetscReal,void*);
283014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPFGMRESModifyPCKSP(KSP,PetscInt,PetscInt,PetscReal,void*);
284014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPFGMRESSetModifyPC(KSP,PetscErrorCode (*)(KSP,PetscInt,PetscInt,PetscReal,void*),void*,PetscErrorCode(*)(void*));
285c38d4ed2SBarry Smith 
286014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPQCGSetTrustRegionRadius(KSP,PetscReal);
287014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPQCGGetQuadratic(KSP,PetscReal*);
288014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPQCGGetTrialStepNorm(KSP,PetscReal*);
289121fd945SKris Buschelman 
290014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPBCGSLSetXRes(KSP,PetscReal);
291014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPBCGSLSetPol(KSP,PetscBool );
292014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPBCGSLSetEll(KSP,PetscInt);
293e4b508b2SJed Brown PETSC_EXTERN PetscErrorCode KSPBCGSLSetUsePseudoinverse(KSP,PetscBool);
294d9492815SBarry Smith 
295014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSetFromOptions(KSP);
29687d6299eSMatthew G. Knepley PETSC_EXTERN PetscErrorCode KSPResetFromOptions(KSP);
297014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPAddOptionsChecker(PetscErrorCode (*)(KSP));
2982eac72dbSBarry Smith 
299fe01d993SBarry Smith PETSC_EXTERN PetscErrorCode KSPMonitorSingularValue(KSP,PetscInt,PetscReal,PetscViewerAndFormat*);
300fe01d993SBarry Smith PETSC_EXTERN PetscErrorCode KSPMonitorDefault(KSP,PetscInt,PetscReal,PetscViewerAndFormat*);
301fe01d993SBarry Smith PETSC_EXTERN PetscErrorCode KSPLSQRMonitorDefault(KSP,PetscInt,PetscReal,PetscViewerAndFormat*);
302fe01d993SBarry Smith PETSC_EXTERN PetscErrorCode KSPMonitorRange(KSP,PetscInt,PetscReal,PetscViewerAndFormat*);
303390160ecSHong Zhang PETSC_EXTERN PetscErrorCode KSPMonitorDynamicTolerance(KSP ksp,PetscInt its,PetscReal fnorm,void *dummy);
304390160ecSHong Zhang PETSC_EXTERN PetscErrorCode KSPMonitorDynamicToleranceDestroy(void **dummy);
305fe01d993SBarry Smith PETSC_EXTERN PetscErrorCode KSPMonitorTrueResidualNorm(KSP,PetscInt,PetscReal,PetscViewerAndFormat*);
306fe01d993SBarry Smith PETSC_EXTERN PetscErrorCode KSPMonitorTrueResidualMaxNorm(KSP,PetscInt,PetscReal,PetscViewerAndFormat*);
307fe01d993SBarry Smith PETSC_EXTERN PetscErrorCode KSPMonitorDefaultShort(KSP,PetscInt,PetscReal,PetscViewerAndFormat*);
308fe01d993SBarry Smith PETSC_EXTERN PetscErrorCode KSPMonitorSolution(KSP,PetscInt,PetscReal,PetscViewerAndFormat*);
309e04113cfSBarry Smith PETSC_EXTERN PetscErrorCode KSPMonitorSAWs(KSP,PetscInt,PetscReal,void*);
310e04113cfSBarry Smith PETSC_EXTERN PetscErrorCode KSPMonitorSAWsCreate(KSP,void**);
311e04113cfSBarry Smith PETSC_EXTERN PetscErrorCode KSPMonitorSAWsDestroy(void**);
312014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGMRESMonitorKrylov(KSP,PetscInt,PetscReal,void*);
313fe01d993SBarry Smith PETSC_EXTERN PetscErrorCode KSPMonitorSetFromOptions(KSP,const char[],const char[],const char [],PetscErrorCode (*)(KSP,PetscInt,PetscReal,PetscViewerAndFormat*));
31484cb2905SBarry Smith 
315014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPUnwindPreconditioner(KSP,Vec,Vec);
316014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPInitialResidual(KSP,Vec,Vec,Vec,Vec,Vec);
317c01c455dSBarry Smith 
31823ee1639SBarry Smith PETSC_EXTERN PetscErrorCode KSPSetOperators(KSP,Mat,Mat);
31923ee1639SBarry Smith PETSC_EXTERN PetscErrorCode KSPGetOperators(KSP,Mat*,Mat*);
320014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGetOperatorsSet(KSP,PetscBool*,PetscBool*);
321014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSetOptionsPrefix(KSP,const char[]);
322014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPAppendOptionsPrefix(KSP,const char[]);
323014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGetOptionsPrefix(KSP,const char*[]);
3247287d2a3SDmitry Karpeev PETSC_EXTERN PetscErrorCode KSPSetTabLevel(KSP,PetscInt);
3257287d2a3SDmitry Karpeev PETSC_EXTERN PetscErrorCode KSPGetTabLevel(KSP,PetscInt*);
3261eb62cbbSBarry Smith 
327014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSetDiagonalScale(KSP,PetscBool );
328014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGetDiagonalScale(KSP,PetscBool*);
329014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSetDiagonalScaleFix(KSP,PetscBool );
330014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGetDiagonalScaleFix(KSP,PetscBool*);
3311f7f0c4fSBarry Smith 
332014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPView(KSP,PetscViewer);
33355849f57SBarry Smith PETSC_EXTERN PetscErrorCode KSPLoad(KSP,PetscViewer);
334685405a1SBarry Smith PETSC_STATIC_INLINE PetscErrorCode KSPViewFromOptions(KSP A,PetscObject obj,const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,obj,name);}
3352a359c20SBarry Smith PETSC_EXTERN PetscErrorCode KSPReasonView(KSP,PetscViewer);
3362a359c20SBarry Smith PETSC_EXTERN PetscErrorCode KSPReasonViewFromOptions(KSP);
33755849f57SBarry Smith 
33855849f57SBarry Smith #define KSP_FILE_CLASSID 1211223
3391eb62cbbSBarry Smith 
340dcc87044SVaclav Hapla PETSC_EXTERN PetscErrorCode KSPLSQRSetExactMatNorm(KSP,PetscBool);
3410e827bf4SVaclav Hapla PETSC_EXTERN PetscErrorCode KSPLSQRSetComputeStandardErrorVec(KSP,PetscBool);
342014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPLSQRGetStandardErrorVec(KSP,Vec*);
343884807c7SVaclav Hapla PETSC_EXTERN PetscErrorCode KSPLSQRGetNorms(KSP,PetscReal*,PetscReal*);
344db9b2ab1SHong Zhang 
345014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCRedundantGetKSP(PC,KSP*);
346014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCRedistributeGetKSP(PC,KSP*);
34768ddcbeaSBarry Smith PETSC_EXTERN PetscErrorCode PCTelescopeGetKSP(PC,KSP*);
34883ab6a24SBarry Smith 
34928ce4d24SBarry Smith /*E
3508a4b9c5cSBarry Smith     KSPNormType - Norm that is passed in the Krylov convergence
3518a4b9c5cSBarry Smith        test routines.
3528a4b9c5cSBarry Smith 
3538a4b9c5cSBarry Smith    Level: advanced
3548a4b9c5cSBarry Smith 
355a3f661c8SBarry Smith    Each solver only supports a subset of these and some may support different ones
3561718446fSBarry Smith    depending on left or right preconditioning, see KSPSetPCSide()
357a3f661c8SBarry Smith 
35895452b02SPatrick Sanan    Notes:
35995452b02SPatrick Sanan     this must match petsc/finclude/petscksp.h
3608a4b9c5cSBarry Smith 
36194b7f48cSBarry Smith .seealso: KSPSolve(), KSPGetConvergedReason(), KSPSetNormType(),
3621718446fSBarry Smith           KSPSetConvergenceTest(), KSPSetPCSide()
3638a4b9c5cSBarry Smith E*/
3649e568555SJed Brown typedef enum {KSP_NORM_DEFAULT = -1,KSP_NORM_NONE = 0,KSP_NORM_PRECONDITIONED = 1,KSP_NORM_UNPRECONDITIONED = 2,KSP_NORM_NATURAL = 3} KSPNormType;
3659e568555SJed Brown #define KSP_NORM_MAX (KSP_NORM_NATURAL + 1)
366014dd563SJed Brown PETSC_EXTERN const char *const*const KSPNormTypes;
367a21b2a99SBarry Smith 
3681f7e983dSSatish Balay /*MC
3699793b452SBarry Smith     KSP_NORM_NONE - Do not compute a norm during the Krylov process. This will
3708c5b8ba0SBarry Smith           possibly save some computation but means the convergence test cannot
3718c5b8ba0SBarry Smith           be based on a norm of a residual etc.
3728c5b8ba0SBarry Smith 
3738c5b8ba0SBarry Smith    Level: advanced
3748c5b8ba0SBarry Smith 
3751957e957SBarry Smith     Note: Some Krylov methods need to compute a residual norm (such as GMRES) and then this option is ignored
3768c5b8ba0SBarry Smith 
377ce9499c7SBarry Smith .seealso: KSPNormType, KSPSetNormType(), KSP_NORM_PRECONDITIONED, KSP_NORM_UNPRECONDITIONED, KSP_NORM_NATURAL
3788c5b8ba0SBarry Smith M*/
3798c5b8ba0SBarry Smith 
3801f7e983dSSatish Balay /*MC
3811957e957SBarry Smith     KSP_NORM_PRECONDITIONED - Compute the norm of the preconditioned residual B*(b - A*x), if left preconditioning, and pass that to the
3828c5b8ba0SBarry Smith        convergence test routine.
3838c5b8ba0SBarry Smith 
3848c5b8ba0SBarry Smith    Level: advanced
3858c5b8ba0SBarry Smith 
3869793b452SBarry Smith .seealso: KSPNormType, KSPSetNormType(), KSP_NORM_NONE, KSP_NORM_UNPRECONDITIONED, KSP_NORM_NATURAL, KSPSetConvergenceTest()
3878c5b8ba0SBarry Smith M*/
3888c5b8ba0SBarry Smith 
3891f7e983dSSatish Balay /*MC
390ce9499c7SBarry Smith     KSP_NORM_UNPRECONDITIONED - Compute the norm of the true residual (b - A*x) and pass that to the
3918c5b8ba0SBarry Smith        convergence test routine.
3928c5b8ba0SBarry Smith 
3938c5b8ba0SBarry Smith    Level: advanced
3948c5b8ba0SBarry Smith 
3959793b452SBarry Smith .seealso: KSPNormType, KSPSetNormType(), KSP_NORM_NONE, KSP_NORM_PRECONDITIONED, KSP_NORM_NATURAL, KSPSetConvergenceTest()
3968c5b8ba0SBarry Smith M*/
3978c5b8ba0SBarry Smith 
3981f7e983dSSatish Balay /*MC
399ce9499c7SBarry Smith     KSP_NORM_NATURAL - Compute the 'natural norm' of residual sqrt((b - A*x)*B*(b - A*x)) and pass that to the
400390d8e47SPatrick Sanan        convergence test routine. This is only supported by  KSPCG, KSPCR, KSPCGNE, KSPCGS, KSPFCG, KSPPIPEFCG, KSPPIPEGCR
4018c5b8ba0SBarry Smith 
4028c5b8ba0SBarry Smith    Level: advanced
4038c5b8ba0SBarry Smith 
4049793b452SBarry Smith .seealso: KSPNormType, KSPSetNormType(), KSP_NORM_NONE, KSP_NORM_PRECONDITIONED, KSP_NORM_UNPRECONDITIONED, KSPSetConvergenceTest()
4058c5b8ba0SBarry Smith M*/
4068c5b8ba0SBarry Smith 
407014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSetNormType(KSP,KSPNormType);
408014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGetNormType(KSP,KSPNormType*);
409014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSetSupportedNorm(KSP ksp,KSPNormType,PCSide,PetscInt);
410014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSetCheckNormIteration(KSP,PetscInt);
411014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSetLagNorm(KSP,PetscBool);
4128a4b9c5cSBarry Smith 
4138a4b9c5cSBarry Smith /*E
4141957e957SBarry Smith     KSPConvergedReason - reason a Krylov method was said to have converged or diverged
41528ce4d24SBarry Smith 
41628ce4d24SBarry Smith    Level: beginner
41728ce4d24SBarry Smith 
41895452b02SPatrick Sanan    Notes:
41995452b02SPatrick Sanan     See KSPGetConvergedReason() for explanation of each value
42028ce4d24SBarry Smith 
42195452b02SPatrick Sanan    Developer Notes:
42295452b02SPatrick Sanan     this must match petsc/finclude/petscksp.h
4234d0a8057SBarry Smith 
4244d0a8057SBarry Smith       The string versions of these are KSPConvergedReasons; if you change
4254d0a8057SBarry Smith       any of the values here also change them that array of names.
42686c02ca4SBarry Smith 
427c838673bSBarry Smith .seealso: KSPSolve(), KSPGetConvergedReason(), KSPSetTolerances()
42828ce4d24SBarry Smith E*/
429d15094e1SBarry Smith typedef enum {/* converged */
4309ecb1286SBarry Smith               KSP_CONVERGED_RTOL_NORMAL        =  1,
4319ecb1286SBarry Smith               KSP_CONVERGED_ATOL_NORMAL        =  9,
432d15094e1SBarry Smith               KSP_CONVERGED_RTOL               =  2,
433d15094e1SBarry Smith               KSP_CONVERGED_ATOL               =  3,
434b335793eSSatish Balay               KSP_CONVERGED_ITS                =  4,
4358031f4adStmunson               KSP_CONVERGED_CG_NEG_CURVE       =  5,
4368031f4adStmunson               KSP_CONVERGED_CG_CONSTRAINED     =  6,
437329f5518SBarry Smith               KSP_CONVERGED_STEP_LENGTH        =  7,
438af3d8002SBarry Smith               KSP_CONVERGED_HAPPY_BREAKDOWN    =  8,
439d15094e1SBarry Smith               /* diverged */
440b3cc6726SBarry Smith               KSP_DIVERGED_NULL                = -2,
441d15094e1SBarry Smith               KSP_DIVERGED_ITS                 = -3,
442d15094e1SBarry Smith               KSP_DIVERGED_DTOL                = -4,
443d15094e1SBarry Smith               KSP_DIVERGED_BREAKDOWN           = -5,
444b4ac9ba4SBarry Smith               KSP_DIVERGED_BREAKDOWN_BICG      = -6,
445b4ac9ba4SBarry Smith               KSP_DIVERGED_NONSYMMETRIC        = -7,
446b4ac9ba4SBarry Smith               KSP_DIVERGED_INDEFINITE_PC       = -8,
4474d51c080SBarry Smith               KSP_DIVERGED_NANORINF            = -9,
4486aee1118SBarry Smith               KSP_DIVERGED_INDEFINITE_MAT      = -10,
449*c0decd05SBarry Smith               KSP_DIVERGED_PC_FAILED           = -11,
450d15094e1SBarry Smith 
451d15094e1SBarry Smith               KSP_CONVERGED_ITERATING          =  0} KSPConvergedReason;
452014dd563SJed Brown PETSC_EXTERN const char *const*KSPConvergedReasons;
453d15094e1SBarry Smith 
454c838673bSBarry Smith /*MC
455f9fed41fSBarry Smith      KSP_CONVERGED_RTOL - norm(r) <= rtol*norm(b) or rtol*norm(b - A*x_0) if KSPConvergedDefaultSetUIRNorm() was called
456c838673bSBarry Smith 
457c838673bSBarry Smith    Level: beginner
458c838673bSBarry Smith 
459c838673bSBarry Smith    See KSPNormType and KSPSetNormType() for possible norms that may be used. By default
460c838673bSBarry Smith        for left preconditioning it is the 2-norm of the preconditioned residual, and the
461c838673bSBarry Smith        2-norm of the residual for right preconditioning
462c838673bSBarry Smith 
463f9fed41fSBarry Smith    See also KSP_CONVERGED_ATOL which may apply before this tolerance.
464f9fed41fSBarry Smith 
465f9fed41fSBarry Smith .seealso:  KSP_CONVERGED_ATOL, KSP_DIVERGED_DTOL, KSPSolve(), KSPGetConvergedReason(), KSPConvergedReason, KSPSetTolerances()
466c838673bSBarry Smith 
467c838673bSBarry Smith M*/
468c838673bSBarry Smith 
469c838673bSBarry Smith /*MC
470c838673bSBarry Smith      KSP_CONVERGED_ATOL - norm(r) <= atol
471c838673bSBarry Smith 
472c838673bSBarry Smith    Level: beginner
473c838673bSBarry Smith 
474c838673bSBarry Smith    See KSPNormType and KSPSetNormType() for possible norms that may be used. By default
475c838673bSBarry Smith        for left preconditioning it is the 2-norm of the preconditioned residual, and the
476c838673bSBarry Smith        2-norm of the residual for right preconditioning
477c838673bSBarry Smith 
478f9fed41fSBarry Smith    See also KSP_CONVERGED_RTOL which may apply before this tolerance.
479c838673bSBarry Smith 
480f9fed41fSBarry Smith .seealso:  KSP_CONVERGED_RTOL, KSP_DIVERGED_DTOL, KSPSolve(), KSPGetConvergedReason(), KSPConvergedReason, KSPSetTolerances()
481c838673bSBarry Smith 
482c838673bSBarry Smith M*/
483c838673bSBarry Smith 
484c838673bSBarry Smith /*MC
485c838673bSBarry Smith      KSP_DIVERGED_DTOL - norm(r) >= dtol*norm(b)
486c838673bSBarry Smith 
487c838673bSBarry Smith    Level: beginner
488c838673bSBarry Smith 
489c838673bSBarry Smith    See KSPNormType and KSPSetNormType() for possible norms that may be used. By default
490c838673bSBarry Smith        for left preconditioning it is the 2-norm of the preconditioned residual, and the
491c838673bSBarry Smith        2-norm of the residual for right preconditioning
492c838673bSBarry Smith 
493c838673bSBarry Smith    Level: beginner
494c838673bSBarry Smith 
495f9fed41fSBarry Smith .seealso:  KSP_CONVERGED_ATOL, KSP_DIVERGED_RTOL, KSPSolve(), KSPGetConvergedReason(), KSPConvergedReason, KSPSetTolerances()
496c838673bSBarry Smith 
497c838673bSBarry Smith M*/
498c838673bSBarry Smith 
499c838673bSBarry Smith /*MC
500c838673bSBarry Smith      KSP_DIVERGED_ITS - Ran out of iterations before any convergence criteria was
501c838673bSBarry Smith       reached
502c838673bSBarry Smith 
503c838673bSBarry Smith    Level: beginner
504c838673bSBarry Smith 
505c838673bSBarry Smith .seealso:  KSPSolve(), KSPGetConvergedReason(), KSPConvergedReason, KSPSetTolerances()
506c838673bSBarry Smith 
507c838673bSBarry Smith M*/
508c838673bSBarry Smith 
509c838673bSBarry Smith /*MC
5108c9406f6SLisandro Dalcin      KSP_CONVERGED_ITS - Used by the KSPPREONLY solver after the single iteration of
5110059c7bdSJed Brown            the preconditioner is applied. Also used when the KSPConvergedSkip() convergence
5124d0a8057SBarry Smith            test routine is set in KSP.
513c838673bSBarry Smith 
514c838673bSBarry Smith    Level: beginner
515c838673bSBarry Smith 
516c838673bSBarry Smith .seealso:  KSPSolve(), KSPGetConvergedReason(), KSPConvergedReason, KSPSetTolerances()
517c838673bSBarry Smith 
518c838673bSBarry Smith M*/
519c838673bSBarry Smith 
520c838673bSBarry Smith /*MC
521c838673bSBarry Smith      KSP_DIVERGED_BREAKDOWN - A breakdown in the Krylov method was detected so the
5223014e516SBarry Smith           method could not continue to enlarge the Krylov space. Could be due to a singlular matrix or
5233014e516SBarry Smith           preconditioner.
524c838673bSBarry Smith 
525c838673bSBarry Smith    Level: beginner
526c838673bSBarry Smith 
527c838673bSBarry Smith .seealso:  KSPSolve(), KSPGetConvergedReason(), KSPConvergedReason, KSPSetTolerances()
528c838673bSBarry Smith 
529c838673bSBarry Smith M*/
530c838673bSBarry Smith 
531c838673bSBarry Smith /*MC
532c838673bSBarry Smith      KSP_DIVERGED_BREAKDOWN_BICG - A breakdown in the KSPBICG method was detected so the
533c838673bSBarry Smith           method could not continue to enlarge the Krylov space.
534c838673bSBarry Smith 
535c838673bSBarry Smith    Level: beginner
536c838673bSBarry Smith 
537c838673bSBarry Smith .seealso:  KSPSolve(), KSPGetConvergedReason(), KSPConvergedReason, KSPSetTolerances()
538c838673bSBarry Smith 
539c838673bSBarry Smith M*/
540c838673bSBarry Smith 
541c838673bSBarry Smith /*MC
542c838673bSBarry Smith      KSP_DIVERGED_NONSYMMETRIC - It appears the operator or preconditioner is not
543c838673bSBarry Smith         symmetric and this Krylov method (KSPCG, KSPMINRES, KSPCR) requires symmetry
544c838673bSBarry Smith 
545c838673bSBarry Smith    Level: beginner
546c838673bSBarry Smith 
547c838673bSBarry Smith .seealso:  KSPSolve(), KSPGetConvergedReason(), KSPConvergedReason, KSPSetTolerances()
548c838673bSBarry Smith 
549c838673bSBarry Smith M*/
550c838673bSBarry Smith 
551c838673bSBarry Smith /*MC
552c838673bSBarry Smith      KSP_DIVERGED_INDEFINITE_PC - It appears the preconditioner is indefinite (has both
553c838673bSBarry Smith         positive and negative eigenvalues) and this Krylov method (KSPCG) requires it to
554c838673bSBarry Smith         be positive definite
555c838673bSBarry Smith 
556c838673bSBarry Smith    Level: beginner
557c838673bSBarry Smith 
55895452b02SPatrick Sanan      Notes:
55995452b02SPatrick Sanan     This can happen with the PCICC preconditioner, use -pc_factor_shift_positive_definite to force
560c838673bSBarry Smith   the PCICC preconditioner to generate a positive definite preconditioner
561c838673bSBarry Smith 
562c838673bSBarry Smith .seealso:  KSPSolve(), KSPGetConvergedReason(), KSPConvergedReason, KSPSetTolerances()
563c838673bSBarry Smith 
564c838673bSBarry Smith M*/
565c838673bSBarry Smith 
566c838673bSBarry Smith /*MC
567*c0decd05SBarry Smith      KSP_DIVERGED_PC_FAILED - It was not possible to build or use the requested preconditioner. This is usually due to a
5689fc87aa7SBarry Smith      zero pivot in a factorization. It can also result from a failure in a subpreconditioner inside a nested preconditioner
5699fc87aa7SBarry Smith      such as PCFIELDSPLIT.
5709fc87aa7SBarry Smith 
5719fc87aa7SBarry Smith    Level: beginner
5729fc87aa7SBarry Smith 
57395452b02SPatrick Sanan     Notes:
57495452b02SPatrick Sanan     Run with -ksp_error_if_not_converged to stop the program when the error is detected and print an error message with details.
5759fc87aa7SBarry Smith 
5769fc87aa7SBarry Smith 
5779fc87aa7SBarry Smith .seealso:  KSPSolve(), KSPGetConvergedReason(), KSPConvergedReason, KSPSetTolerances()
5789fc87aa7SBarry Smith 
5799fc87aa7SBarry Smith M*/
5809fc87aa7SBarry Smith 
5819fc87aa7SBarry Smith /*MC
582c838673bSBarry Smith      KSP_CONVERGED_ITERATING - This flag is returned if you call KSPGetConvergedReason()
583c838673bSBarry Smith         while the KSPSolve() is still running.
584c838673bSBarry Smith 
585c838673bSBarry Smith    Level: beginner
586c838673bSBarry Smith 
587c838673bSBarry Smith .seealso:  KSPSolve(), KSPGetConvergedReason(), KSPConvergedReason, KSPSetTolerances()
588c838673bSBarry Smith 
589c838673bSBarry Smith M*/
590c838673bSBarry Smith 
591014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSetConvergenceTest(KSP,PetscErrorCode (*)(KSP,PetscInt,PetscReal,KSPConvergedReason*,void*),void*,PetscErrorCode (*)(void*));
592014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGetConvergenceContext(KSP,void**);
5938de4e6dcSJed Brown PETSC_EXTERN PetscErrorCode KSPConvergedDefault(KSP,PetscInt,PetscReal,KSPConvergedReason*,void*);
5943eeb4429SVaclav Hapla PETSC_EXTERN PetscErrorCode KSPLSQRConvergedDefault(KSP,PetscInt,PetscReal,KSPConvergedReason*,void*);
5958de4e6dcSJed Brown PETSC_EXTERN PetscErrorCode KSPConvergedDefaultDestroy(void*);
5968de4e6dcSJed Brown PETSC_EXTERN PetscErrorCode KSPConvergedDefaultCreate(void**);
5978de4e6dcSJed Brown PETSC_EXTERN PetscErrorCode KSPConvergedDefaultSetUIRNorm(KSP);
5988de4e6dcSJed Brown PETSC_EXTERN PetscErrorCode KSPConvergedDefaultSetUMIRNorm(KSP);
5990059c7bdSJed Brown PETSC_EXTERN PetscErrorCode KSPConvergedSkip(KSP,PetscInt,PetscReal,KSPConvergedReason*,void*);
600014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGetConvergedReason(KSP,KSPConvergedReason*);
601abef13c0SSatish Balay 
6028ea1b3e6SJed Brown PETSC_DEPRECATED("Use KSPConvergedDefault()") PETSC_STATIC_INLINE void KSPDefaultConverged(void) { /* never called */ }
6038ea1b3e6SJed Brown #define KSPDefaultConverged (KSPDefaultConverged, KSPConvergedDefault)
6048ea1b3e6SJed Brown PETSC_DEPRECATED("Use KSPConvergedDefaultDestroy()") PETSC_STATIC_INLINE void KSPDefaultConvergedDestroy(void) { /* never called */ }
6058ea1b3e6SJed Brown #define KSPDefaultConvergedDestroy (KSPDefaultConvergedDestroy, KSPConvergedDefaultDestroy)
6068ea1b3e6SJed Brown PETSC_DEPRECATED("Use KSPConvergedDefaultCreate()") PETSC_STATIC_INLINE void KSPDefaultConvergedCreate(void) { /* never called */ }
6078ea1b3e6SJed Brown #define KSPDefaultConvergedCreate (KSPDefaultConvergedCreate, KSPConvergedDefaultCreate)
6088ea1b3e6SJed Brown PETSC_DEPRECATED("Use KSPConvergedDefaultSetUIRNorm()") PETSC_STATIC_INLINE void KSPDefaultConvergedSetUIRNorm(void) { /* never called */ }
6098ea1b3e6SJed Brown #define KSPDefaultConvergedSetUIRNorm (KSPDefaultConvergedSetUIRNorm, KSPConvergedDefaultSetUIRNorm)
6108ea1b3e6SJed Brown PETSC_DEPRECATED("Use KSPConvergedDefaultSetUMIRNorm()") PETSC_STATIC_INLINE void KSPDefaultConvergedSetUMIRNorm(void) { /* never called */ }
6118ea1b3e6SJed Brown #define KSPDefaultConvergedSetUMIRNorm (KSPDefaultConvergedSetUMIRNorm, KSPConvergedDefaultSetUMIRNorm)
6128ea1b3e6SJed Brown PETSC_DEPRECATED("Use KSPConvergedSkip()") PETSC_STATIC_INLINE void KSPSkipConverged(void) { /* never called */ }
6138ea1b3e6SJed Brown #define KSPSkipConverged (KSPSkipConverged, KSPConvergedSkip)
6148ea1b3e6SJed Brown 
615014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPComputeExplicitOperator(KSP,Mat*);
616d4fbbf0eSBarry Smith 
61728ce4d24SBarry Smith /*E
61828ce4d24SBarry Smith     KSPCGType - Determines what type of CG to use
61928ce4d24SBarry Smith 
62028ce4d24SBarry Smith    Level: beginner
62128ce4d24SBarry Smith 
62228ce4d24SBarry Smith .seealso: KSPCGSetType()
62328ce4d24SBarry Smith E*/
6249dcbbd2bSBarry Smith typedef enum {KSP_CG_SYMMETRIC=0,KSP_CG_HERMITIAN=1} KSPCGType;
6256a6fc655SJed Brown PETSC_EXTERN const char *const KSPCGTypes[];
62628ce4d24SBarry Smith 
627014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPCGSetType(KSP,KSPCGType);
628014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPCGUseSingleReduction(KSP,PetscBool );
6298031f4adStmunson 
630dad1adc6STodd Munson PETSC_EXTERN PetscErrorCode KSPCGSetRadius(KSP,PetscReal);
631dad1adc6STodd Munson PETSC_EXTERN PetscErrorCode KSPCGGetNormD(KSP,PetscReal*);
632dad1adc6STodd Munson PETSC_EXTERN PetscErrorCode KSPCGGetObjFcn(KSP,PetscReal*);
633fcae7a14Stmunson 
634d2e0dd5eSTodd Munson PETSC_EXTERN PetscErrorCode KSPCGGLTRGetMinEig(KSP,PetscReal*);
635d2e0dd5eSTodd Munson PETSC_EXTERN PetscErrorCode KSPCGGLTRGetLambda(KSP,PetscReal*);
6368031f4adStmunson 
637014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPPythonSetType(KSP,const char[]);
6381d6018f0SLisandro Dalcin 
639014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCPreSolve(PC,KSP);
640014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCPostSolve(PC,KSP);
6413369ce9aSBarry Smith 
6429804daf3SBarry Smith #include <petscdrawtypes.h>
643d96771aaSLisandro Dalcin PETSC_EXTERN PetscErrorCode KSPMonitorLGResidualNormCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscDrawLG*);
644d96771aaSLisandro Dalcin PETSC_EXTERN PetscErrorCode KSPMonitorLGResidualNorm(KSP,PetscInt,PetscReal,void*);
645d96771aaSLisandro Dalcin PETSC_EXTERN PetscErrorCode KSPMonitorLGTrueResidualNormCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscDrawLG*);
646d96771aaSLisandro Dalcin PETSC_EXTERN PetscErrorCode KSPMonitorLGTrueResidualNorm(KSP,PetscInt,PetscReal,void*);
647014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPMonitorLGRange(KSP,PetscInt,PetscReal,void*);
6482f2e5d10SKris Buschelman 
649014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCShellSetPreSolve(PC,PetscErrorCode (*)(PC,KSP,Vec,Vec));
650014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCShellSetPostSolve(PC,PetscErrorCode (*)(PC,KSP,Vec,Vec));
65103919abeSBarry Smith 
652ba36735cSStefano Zampini /*S
653ba36735cSStefano Zampini      KSPGuess - Abstract PETSc object that manages all initial guess methods in Krylov methods.
654f8a50e2bSBarry Smith 
655ba36735cSStefano Zampini    Level: beginner
656f8a50e2bSBarry Smith 
657ba36735cSStefano Zampini   Concepts: Krylov methods
658ba36735cSStefano Zampini 
659ba36735cSStefano Zampini .seealso:  KSPCreate(), KSPSetGuessType(), KSPGuessType
660ba36735cSStefano Zampini S*/
661ba36735cSStefano Zampini typedef struct _p_KSPGuess* KSPGuess;
662ba36735cSStefano Zampini /*J
663ba36735cSStefano Zampini     KSPGuessType - String with the name of a PETSc initial guess for Krylov methods.
664ba36735cSStefano Zampini 
665ba36735cSStefano Zampini    Level: beginner
666ba36735cSStefano Zampini 
667ba36735cSStefano Zampini .seealso: KSPGuess
668ba36735cSStefano Zampini J*/
669ba36735cSStefano Zampini typedef const char* KSPGuessType;
670ba36735cSStefano Zampini #define KSPGUESSFISCHER "fischer"
671ba36735cSStefano Zampini #define KSPGUESSPOD     "pod"
6721d36bdfdSBarry Smith PETSC_EXTERN PetscErrorCode KSPGuessRegister(const char[],PetscErrorCode (*)(KSPGuess));
673ba36735cSStefano Zampini PETSC_EXTERN PetscErrorCode KSPSetGuess(KSP,KSPGuess);
674ba36735cSStefano Zampini PETSC_EXTERN PetscErrorCode KSPGetGuess(KSP,KSPGuess*);
675ba36735cSStefano Zampini PETSC_EXTERN PetscErrorCode KSPGuessView(KSPGuess,PetscViewer);
676ba36735cSStefano Zampini PETSC_EXTERN PetscErrorCode KSPGuessDestroy(KSPGuess*);
677ba36735cSStefano Zampini PETSC_EXTERN PetscErrorCode KSPGuessCreate(MPI_Comm,KSPGuess*);
678ba36735cSStefano Zampini PETSC_EXTERN PetscErrorCode KSPGuessSetType(KSPGuess,KSPGuessType);
679ba36735cSStefano Zampini PETSC_EXTERN PetscErrorCode KSPGuessGetType(KSPGuess,KSPGuessType*);
680ba36735cSStefano Zampini PETSC_EXTERN PetscErrorCode KSPGuessSetUp(KSPGuess);
681ba36735cSStefano Zampini PETSC_EXTERN PetscErrorCode KSPGuessUpdate(KSPGuess,Vec,Vec);
682ba36735cSStefano Zampini PETSC_EXTERN PetscErrorCode KSPGuessFormGuess(KSPGuess,Vec,Vec);
683ba36735cSStefano Zampini PETSC_EXTERN PetscErrorCode KSPGuessSetFromOptions(KSPGuess);
684ba36735cSStefano Zampini PETSC_EXTERN PetscErrorCode KSPGuessFischerSetModel(KSPGuess,PetscInt,PetscInt);
685014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSetUseFischerGuess(KSP,PetscInt,PetscInt);
686ba36735cSStefano Zampini PETSC_EXTERN PetscErrorCode KSPSetInitialGuessKnoll(KSP,PetscBool);
687ba36735cSStefano Zampini PETSC_EXTERN PetscErrorCode KSPGetInitialGuessKnoll(KSP,PetscBool*);
688f8a50e2bSBarry Smith 
689470b340bSDmitry Karpeev /*E
690470b340bSDmitry Karpeev     MatSchurComplementAinvType - Determines how to approximate the inverse of the (0,0) block in Schur complement preconditioning matrix assembly routines
691470b340bSDmitry Karpeev 
692470b340bSDmitry Karpeev     Level: intermediate
693470b340bSDmitry Karpeev 
694470b340bSDmitry Karpeev .seealso: MatSchurComplementGetAinvType(), MatSchurComplementSetAinvType(), MatSchurComplementGetPmat(), MatGetSchurComplement(), MatCreateSchurComplementPmat()
695470b340bSDmitry Karpeev E*/
6960c42975cSTristan Konolige typedef enum {MAT_SCHUR_COMPLEMENT_AINV_DIAG, MAT_SCHUR_COMPLEMENT_AINV_LUMP, MAT_SCHUR_COMPLEMENT_AINV_BLOCK_DIAG} MatSchurComplementAinvType;
697470b340bSDmitry Karpeev PETSC_EXTERN const char *const MatSchurComplementAinvTypes[];
698470b340bSDmitry Karpeev 
699014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateSchurComplement(Mat,Mat,Mat,Mat,Mat,Mat*);
700014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSchurComplementGetKSP(Mat,KSP*);
701d2768c1eSMatthew G Knepley PETSC_EXTERN PetscErrorCode MatSchurComplementSetKSP(Mat,KSP);
702bee83525SDmitry Karpeev PETSC_EXTERN PetscErrorCode MatSchurComplementSetSubMatrices(Mat,Mat,Mat,Mat,Mat,Mat);
703aa6c7ce3SBarry Smith PETSC_EXTERN PetscErrorCode MatSchurComplementUpdateSubMatrices(Mat,Mat,Mat,Mat,Mat,Mat);
704bee83525SDmitry Karpeev PETSC_EXTERN PetscErrorCode MatSchurComplementGetSubMatrices(Mat,Mat*,Mat*,Mat*,Mat*,Mat*);
705470b340bSDmitry Karpeev PETSC_EXTERN PetscErrorCode MatSchurComplementSetAinvType(Mat,MatSchurComplementAinvType);
706470b340bSDmitry Karpeev PETSC_EXTERN PetscErrorCode MatSchurComplementGetAinvType(Mat,MatSchurComplementAinvType*);
7075bf40c1dSDmitry Karpeev PETSC_EXTERN PetscErrorCode MatSchurComplementGetPmat(Mat,MatReuse,Mat*);
7085a1c817aSMatthew G. Knepley PETSC_EXTERN PetscErrorCode MatSchurComplementComputeExplicitOperator(Mat,Mat*);
709470b340bSDmitry Karpeev PETSC_EXTERN PetscErrorCode MatGetSchurComplement(Mat,IS,IS,IS,IS,MatReuse,Mat*,MatSchurComplementAinvType,MatReuse,Mat*);
710470b340bSDmitry Karpeev PETSC_EXTERN PetscErrorCode MatCreateSchurComplementPmat(Mat,Mat,Mat,Mat,MatSchurComplementAinvType,MatReuse,Mat*);
7113f22127dSBarry Smith 
71278e4361aSAlp Dener PETSC_EXTERN PetscErrorCode MatCreateLMVMDFP(MPI_Comm,PetscInt,PetscInt,Mat*);
71378e4361aSAlp Dener PETSC_EXTERN PetscErrorCode MatCreateLMVMBFGS(MPI_Comm,PetscInt,PetscInt,Mat*);
71478e4361aSAlp Dener PETSC_EXTERN PetscErrorCode MatCreateLMVMSR1(MPI_Comm,PetscInt,PetscInt,Mat*);
71578e4361aSAlp Dener PETSC_EXTERN PetscErrorCode MatCreateLMVMBrdn(MPI_Comm,PetscInt,PetscInt,Mat*);
71678e4361aSAlp Dener PETSC_EXTERN PetscErrorCode MatCreateLMVMBadBrdn(MPI_Comm,PetscInt,PetscInt,Mat*);
71778e4361aSAlp Dener PETSC_EXTERN PetscErrorCode MatCreateLMVMSymBrdn(MPI_Comm,PetscInt,PetscInt,Mat*);
71818ad3407SAlp Dener PETSC_EXTERN PetscErrorCode MatCreateLMVMSymBadBrdn(MPI_Comm,PetscInt,PetscInt,Mat*);
71950b47da0SAdam Denchfield PETSC_EXTERN PetscErrorCode MatCreateLMVMDiagBrdn(MPI_Comm,PetscInt,PetscInt,Mat*);
720cd929ea3SAlp Dener 
721cd929ea3SAlp Dener PETSC_EXTERN PetscErrorCode MatLMVMUpdate(Mat, Vec, Vec);
722b2d8c577SAlp Dener PETSC_EXTERN PetscErrorCode MatLMVMIsAllocated(Mat, PetscBool*);
723cd929ea3SAlp Dener PETSC_EXTERN PetscErrorCode MatLMVMAllocate(Mat, Vec, Vec);
724cd929ea3SAlp Dener PETSC_EXTERN PetscErrorCode MatLMVMReset(Mat, PetscBool);
725e0ed867bSAlp Dener PETSC_EXTERN PetscErrorCode MatLMVMResetShift(Mat);
7260ad3a497SAlp Dener PETSC_EXTERN PetscErrorCode MatLMVMClearJ0(Mat);
727cd929ea3SAlp Dener PETSC_EXTERN PetscErrorCode MatLMVMSetJ0(Mat, Mat);
728cd929ea3SAlp Dener PETSC_EXTERN PetscErrorCode MatLMVMSetJ0Scale(Mat, PetscReal);
729cd929ea3SAlp Dener PETSC_EXTERN PetscErrorCode MatLMVMSetJ0Diag(Mat, Vec);
730cd929ea3SAlp Dener PETSC_EXTERN PetscErrorCode MatLMVMSetJ0PC(Mat, PC);
731cd929ea3SAlp Dener PETSC_EXTERN PetscErrorCode MatLMVMSetJ0KSP(Mat, KSP);
7322d5e3849SAlp Dener PETSC_EXTERN PetscErrorCode MatLMVMApplyJ0Fwd(Mat, Vec, Vec);
733cd929ea3SAlp Dener PETSC_EXTERN PetscErrorCode MatLMVMApplyJ0Inv(Mat, Vec, Vec);
734cd929ea3SAlp Dener PETSC_EXTERN PetscErrorCode MatLMVMGetJ0(Mat, Mat*);
735cd929ea3SAlp Dener PETSC_EXTERN PetscErrorCode MatLMVMGetJ0PC(Mat, PC*);
736cd929ea3SAlp Dener PETSC_EXTERN PetscErrorCode MatLMVMGetJ0KSP(Mat, KSP*);
737cd929ea3SAlp Dener PETSC_EXTERN PetscErrorCode MatLMVMGetUpdateCount(Mat, PetscInt*);
738cd929ea3SAlp Dener PETSC_EXTERN PetscErrorCode MatLMVMGetRejectCount(Mat, PetscInt*);
739d5ae2380SAlp Dener PETSC_EXTERN PetscErrorCode MatSymBrdnSetDelta(Mat, PetscScalar);
740cd929ea3SAlp Dener 
741014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSetDM(KSP,DM);
742014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSetDMActive(KSP,PetscBool );
743014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGetDM(KSP,DM*);
744014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSetApplicationContext(KSP,void*);
745014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGetApplicationContext(KSP,void*);
746fbd07b44SBarry Smith PETSC_EXTERN PetscErrorCode KSPSetComputeRHS(KSP,PetscErrorCode (*func)(KSP,Vec,void*),void*);
74723ee1639SBarry Smith PETSC_EXTERN PetscErrorCode KSPSetComputeOperators(KSP,PetscErrorCode(*)(KSP,Mat,Mat,void*),void*);
748fbd07b44SBarry Smith PETSC_EXTERN PetscErrorCode KSPSetComputeInitialGuess(KSP,PetscErrorCode(*)(KSP,Vec,void*),void*);
74923ee1639SBarry Smith PETSC_EXTERN PetscErrorCode DMKSPSetComputeOperators(DM,PetscErrorCode(*)(KSP,Mat,Mat,void*),void*);
75023ee1639SBarry Smith PETSC_EXTERN PetscErrorCode DMKSPGetComputeOperators(DM,PetscErrorCode(**)(KSP,Mat,Mat,void*),void*);
751014dd563SJed Brown PETSC_EXTERN PetscErrorCode DMKSPSetComputeRHS(DM,PetscErrorCode(*)(KSP,Vec,void*),void*);
752014dd563SJed Brown PETSC_EXTERN PetscErrorCode DMKSPGetComputeRHS(DM,PetscErrorCode(**)(KSP,Vec,void*),void*);
753fbd07b44SBarry Smith PETSC_EXTERN PetscErrorCode DMKSPSetComputeInitialGuess(DM,PetscErrorCode(*)(KSP,Vec,void*),void*);
754fbd07b44SBarry Smith PETSC_EXTERN PetscErrorCode DMKSPGetComputeInitialGuess(DM,PetscErrorCode(**)(KSP,Vec,void*),void*);
7556c699258SBarry Smith 
75602b02e71SToby Isaac PETSC_EXTERN PetscErrorCode DMGlobalToLocalSolve(DM,Vec,Vec);
7578c6c5593SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMProjectField(DM, PetscReal, Vec,
758e29c0834SMatthew G. Knepley                                            void (**)(PetscInt, PetscInt, PetscInt,
759e29c0834SMatthew G. Knepley                                                      const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[],
760e29c0834SMatthew G. Knepley                                                      const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[],
761191494d9SMatthew G. Knepley                                                      PetscReal, const PetscReal [], PetscInt, const PetscScalar[], PetscScalar []), InsertMode, Vec);
7622eac72dbSBarry Smith #endif
763