xref: /petsc/include/petscksp.h (revision e96a0efe6c8b8b0fe5b91cf7eb4c114ad4522cf0)
1f26ada1bSBarry Smith /*
2f26ada1bSBarry Smith    Defines the interface functions for the Krylov subspace accelerators.
3f26ada1bSBarry Smith */
4a4963045SJacob Faibussowitsch #pragma once
5ac09b921SBarry Smith 
62c8e378dSBarry Smith #include <petscpc.h>
72eac72dbSBarry Smith 
8ac09b921SBarry Smith /* SUBMANSEC = KSP */
9ac09b921SBarry Smith 
10607a6623SBarry Smith PETSC_EXTERN PetscErrorCode KSPInitializePackage(void);
114bf303faSJacob Faibussowitsch PETSC_EXTERN PetscErrorCode KSPFinalizePackage(void);
121dbb0a54SBarry Smith 
1328ce4d24SBarry Smith /*S
148f6c3df8SBarry Smith      KSP - Abstract PETSc object that manages all Krylov methods. This is the object that manages the
1516a05f60SBarry Smith          linear solves in PETSc (even those such as direct factorization-based solvers that do no use Krylov accelerators).
1628ce4d24SBarry Smith 
1728ce4d24SBarry Smith    Level: beginner
1828ce4d24SBarry Smith 
1987497f52SBarry Smith    Note:
20a4d1885cSBarry Smith     When a direct solver is used, but no Krylov solver is used, the `KSP` object is still used but with a
2116a05f60SBarry Smith     `KSPType` of `KSPPREONLY` (or equivalently `KSPNONE`), meaning that only application of the preconditioner is used as the linear solver.
228f6c3df8SBarry Smith 
231cc06b55SBarry Smith .seealso: [](doc_linsolve), [](ch_ksp), `KSPCreate()`, `KSPSetType()`, `KSPType`, `SNES`, `TS`, `PC`, `KSP`, `KSPDestroy()`, `KSPCG`, `KSPGMRES`
2428ce4d24SBarry Smith S*/
25e2a1c21fSSatish Balay typedef struct _p_KSP *KSP;
262eac72dbSBarry Smith 
2776bdecfbSBarry Smith /*J
288f6c3df8SBarry Smith     KSPType - String with the name of a PETSc Krylov method.
2928ce4d24SBarry Smith 
3028ce4d24SBarry Smith    Level: beginner
3128ce4d24SBarry Smith 
321cc06b55SBarry Smith .seealso: [](doc_linsolve), [](ch_ksp), `KSPSetType()`, `KSP`, `KSPRegister()`, `KSPCreate()`, `KSPSetFromOptions()`
3376bdecfbSBarry Smith J*/
3419fd82e9SBarry Smith typedef const char *KSPType;
3582bf6240SBarry Smith #define KSPRICHARDSON "richardson"
366c9de887SHong Zhang #define KSPCHEBYSHEV  "chebyshev"
3782bf6240SBarry Smith #define KSPCG         "cg"
382c8fc646SJed Brown #define KSPGROPPCG    "groppcg"
392c8fc646SJed Brown #define KSPPIPECG     "pipecg"
40901ccb91SSiegfried Cools #define KSPPIPECGRR   "pipecgrr"
41265663fdSSiegfried Cools #define KSPPIPELCG    "pipelcg"
42b21a8899STyler Chen #define KSPPIPEPRCG   "pipeprcg"
43325e8391SManasi #define KSPPIPECG2    "pipecg2"
44df2a969aSvictorle #define KSPCGNE       "cgne"
4505de396fSBarry Smith #define KSPNASH       "nash"
4605de396fSBarry Smith #define KSPSTCG       "stcg"
4705de396fSBarry Smith #define KSPGLTR       "gltr"
48edd03b47SJacob Faibussowitsch #define KSPCGNASH     PETSC_DEPRECATED_MACRO(3, 11, 0, "KSPNASH", ) "nash"
49edd03b47SJacob Faibussowitsch #define KSPCGSTCG     PETSC_DEPRECATED_MACRO(3, 11, 0, "KSPSTCG", ) "stcg"
50edd03b47SJacob Faibussowitsch #define KSPCGGLTR     PETSC_DEPRECATED_MACRO(3, 11, 0, "KSPSGLTR", ) "gltr"
51640f4f53SPatrick Sanan #define KSPFCG        "fcg"
52390d8e47SPatrick Sanan #define KSPPIPEFCG    "pipefcg"
5382bf6240SBarry Smith #define KSPGMRES      "gmres"
54483d6965SPatrick Sanan #define KSPPIPEFGMRES "pipefgmres"
559dcbbd2bSBarry Smith #define KSPFGMRES     "fgmres"
569dcbbd2bSBarry Smith #define KSPLGMRES     "lgmres"
574f8e6cd9SSatish Balay #define KSPDGMRES     "dgmres"
5861b468f9SJed Brown #define KSPPGMRES     "pgmres"
5982bf6240SBarry Smith #define KSPTCQMR      "tcqmr"
6082bf6240SBarry Smith #define KSPBCGS       "bcgs"
61e1c61ce8SBarry Smith #define KSPIBCGS      "ibcgs"
62345ecf0bSXiangmin Jiao #define KSPQMRCGS     "qmrcgs"
6318ac38e6SHong Zhang #define KSPFBCGS      "fbcgs"
64c2b71004SHong Zhang #define KSPFBCGSR     "fbcgsr"
65f0037002Svictorle #define KSPBCGSL      "bcgsl"
66f154af2dSSiegfried Cools #define KSPPIPEBCGS   "pipebcgs"
6782bf6240SBarry Smith #define KSPCGS        "cgs"
6882bf6240SBarry Smith #define KSPTFQMR      "tfqmr"
6982bf6240SBarry Smith #define KSPCR         "cr"
702c8fc646SJed Brown #define KSPPIPECR     "pipecr"
7182bf6240SBarry Smith #define KSPLSQR       "lsqr"
7282bf6240SBarry Smith #define KSPPREONLY    "preonly"
733c2be86cSBarry Smith #define KSPNONE       "none"
7482bf6240SBarry Smith #define KSPQCG        "qcg"
75c9cf9b11SBarry Smith #define KSPBICG       "bicg"
76b4ac9ba4SBarry Smith #define KSPMINRES     "minres"
7701c5daebSSatish Balay #define KSPSYMMLQ     "symmlq"
7821356919SSatish Balay #define KSPLCD        "lcd"
791d6018f0SLisandro Dalcin #define KSPPYTHON     "python"
8058ad63f4SBarry Smith #define KSPGCR        "gcr"
81fad47a0aSPatrick Sanan #define KSPPIPEGCR    "pipegcr"
82e4d80e07Szianekhodja #define KSPTSIRM      "tsirm"
83e4d80e07Szianekhodja #define KSPCGLS       "cgls"
84329cd39dSStefano Zampini #define KSPFETIDP     "fetidp"
8538cfc46eSPierre Jolivet #define KSPHPDDM      "hpddm"
862eac72dbSBarry Smith 
878ba1e511SMatthew Knepley /* Logging support */
88014dd563SJed Brown PETSC_EXTERN PetscClassId KSP_CLASSID;
89ba36735cSStefano Zampini PETSC_EXTERN PetscClassId KSPGUESS_CLASSID;
905358d0d4SBarry Smith PETSC_EXTERN PetscClassId DMKSP_CLASSID;
918ba1e511SMatthew Knepley 
92014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPCreate(MPI_Comm, KSP *);
9319fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode KSPSetType(KSP, KSPType);
94c60c7ad4SBarry Smith PETSC_EXTERN PetscErrorCode KSPGetType(KSP, KSPType *);
95014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSetUp(KSP);
96014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSetUpOnBlocks(KSP);
97014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSolve(KSP, Vec, Vec);
98014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSolveTranspose(KSP, Vec, Vec);
9975f8e9bdSHong Zhang PETSC_EXTERN PetscErrorCode KSPSetUseExplicitTranspose(KSP, PetscBool);
1005ea7661aSPierre Jolivet PETSC_EXTERN PetscErrorCode KSPMatSolve(KSP, Mat, Mat);
101bbbebc2cSPierre Jolivet PETSC_EXTERN PetscErrorCode KSPMatSolveTranspose(KSP, Mat, Mat);
1023e00ce70SStefano Zampini PETSC_EXTERN PetscErrorCode KSPSetMatSolveBatchSize(KSP, PetscInt);
103edd03b47SJacob Faibussowitsch PETSC_DEPRECATED_FUNCTION(3, 15, 0, "KSPSetMatSolveBatchSize()", ) static inline PetscErrorCode KSPSetMatSolveBlockSize(KSP ksp, PetscInt n)
104d71ae5a4SJacob Faibussowitsch {
1059371c9d4SSatish Balay   return KSPSetMatSolveBatchSize(ksp, n);
1069371c9d4SSatish Balay }
1073e00ce70SStefano Zampini PETSC_EXTERN PetscErrorCode KSPGetMatSolveBatchSize(KSP, PetscInt *);
108edd03b47SJacob Faibussowitsch PETSC_DEPRECATED_FUNCTION(3, 15, 0, "KSPGetMatSolveBatchSize()", ) static inline PetscErrorCode KSPGetMatSolveBlockSize(KSP ksp, PetscInt *n)
109d71ae5a4SJacob Faibussowitsch {
1109371c9d4SSatish Balay   return KSPGetMatSolveBatchSize(ksp, n);
1119371c9d4SSatish Balay }
112014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPReset(KSP);
113ef17e8b6SStefano Zampini PETSC_EXTERN PetscErrorCode KSPResetViewers(KSP);
114014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPDestroy(KSP *);
11523ee1639SBarry Smith PETSC_EXTERN PetscErrorCode KSPSetReusePreconditioner(KSP, PetscBool);
1167d85ae06SStefano Zampini PETSC_EXTERN PetscErrorCode KSPGetReusePreconditioner(KSP, PetscBool *);
11725c41539SBarry Smith PETSC_EXTERN PetscErrorCode KSPSetSkipPCSetFromOptions(KSP, PetscBool);
118c0decd05SBarry Smith PETSC_EXTERN PetscErrorCode KSPCheckSolve(KSP, PC, Vec);
1192eac72dbSBarry Smith 
120140e18c1SBarry Smith PETSC_EXTERN PetscFunctionList KSPList;
121ba36735cSStefano Zampini PETSC_EXTERN PetscFunctionList KSPGuessList;
122798534f6SMatthew G. Knepley PETSC_EXTERN PetscFunctionList KSPMonitorList;
123798534f6SMatthew G. Knepley PETSC_EXTERN PetscFunctionList KSPMonitorCreateList;
124798534f6SMatthew G. Knepley PETSC_EXTERN PetscFunctionList KSPMonitorDestroyList;
125bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode    KSPRegister(const char[], PetscErrorCode (*)(KSP));
126798534f6SMatthew G. Knepley PETSC_EXTERN PetscErrorCode KSPMonitorRegister(const char[], PetscViewerType, PetscViewerFormat, PetscErrorCode (*)(KSP, PetscInt, PetscReal, PetscViewerAndFormat *), PetscErrorCode (*)(PetscViewer, PetscViewerFormat, void *, PetscViewerAndFormat **), PetscErrorCode (*)(PetscViewerAndFormat **));
12730de9b25SBarry Smith 
128014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSetPCSide(KSP, PCSide);
129014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGetPCSide(KSP, PCSide *);
130014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSetTolerances(KSP, PetscReal, PetscReal, PetscReal, PetscInt);
131c60c7ad4SBarry Smith PETSC_EXTERN PetscErrorCode KSPGetTolerances(KSP, PetscReal *, PetscReal *, PetscReal *, PetscInt *);
13225c92fe2SBarry Smith PETSC_EXTERN PetscErrorCode KSPSetMinimumIterations(KSP, PetscInt);
13325c92fe2SBarry Smith PETSC_EXTERN PetscErrorCode KSPGetMinimumIterations(KSP, PetscInt *);
134014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSetInitialGuessNonzero(KSP, PetscBool);
135014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGetInitialGuessNonzero(KSP, PetscBool *);
136014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSetErrorIfNotConverged(KSP, PetscBool);
137014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGetErrorIfNotConverged(KSP, PetscBool *);
138014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSetComputeEigenvalues(KSP, PetscBool);
1397d7fa35eSSylvain Mercier PETSC_EXTERN PetscErrorCode KSPSetComputeRitz(KSP, PetscBool);
140c60c7ad4SBarry Smith PETSC_EXTERN PetscErrorCode KSPGetComputeEigenvalues(KSP, PetscBool *);
141014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSetComputeSingularValues(KSP, PetscBool);
142c60c7ad4SBarry Smith PETSC_EXTERN PetscErrorCode KSPGetComputeSingularValues(KSP, PetscBool *);
143014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGetRhs(KSP, Vec *);
144014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGetSolution(KSP, Vec *);
145014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGetResidualNorm(KSP, PetscReal *);
146014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGetIterationNumber(KSP, PetscInt *);
147734794cfSBarry Smith PETSC_EXTERN PetscErrorCode KSPGetTotalIterations(KSP, PetscInt *);
1482a7a6963SBarry Smith PETSC_EXTERN PetscErrorCode KSPCreateVecs(KSP, PetscInt, Vec **, PetscInt, Vec **);
149edd03b47SJacob Faibussowitsch PETSC_DEPRECATED_FUNCTION(3, 6, 0, "KSPCreateVecs()", ) static inline PetscErrorCode KSPGetVecs(KSP ksp, PetscInt n, Vec **x, PetscInt m, Vec **y)
150d71ae5a4SJacob Faibussowitsch {
1519371c9d4SSatish Balay   return KSPCreateVecs(ksp, n, x, m, y);
1529371c9d4SSatish Balay }
1532eac72dbSBarry Smith 
154d4211eb9SBarry Smith PETSC_EXTERN PetscErrorCode KSPSetPreSolve(KSP, PetscErrorCode (*)(KSP, Vec, Vec, void *), void *);
155d4211eb9SBarry Smith PETSC_EXTERN PetscErrorCode KSPSetPostSolve(KSP, PetscErrorCode (*)(KSP, Vec, Vec, void *), void *);
156d4211eb9SBarry Smith 
157014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSetPC(KSP, PC);
158014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGetPC(KSP, PC *);
1593821be0aSBarry Smith PETSC_EXTERN PetscErrorCode KSPSetNestLevel(KSP, PetscInt);
1603821be0aSBarry Smith PETSC_EXTERN PetscErrorCode KSPGetNestLevel(KSP, PetscInt *);
161aabeff55SBarry Smith 
162014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPMonitor(KSP, PetscInt, PetscReal);
163014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPMonitorSet(KSP, PetscErrorCode (*)(KSP, PetscInt, PetscReal, void *), void *, PetscErrorCode (*)(void **));
164014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPMonitorCancel(KSP);
1653ec1f749SStefano Zampini PETSC_EXTERN PetscErrorCode KSPGetMonitorContext(KSP, void *);
16694a4d4ebSMatthew G. Knepley PETSC_EXTERN PetscErrorCode KSPGetResidualHistory(KSP, const PetscReal *[], PetscInt *);
167014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSetResidualHistory(KSP, PetscReal[], PetscInt, PetscBool);
16894a4d4ebSMatthew G. Knepley PETSC_EXTERN PetscErrorCode KSPGetErrorHistory(KSP, const PetscReal *[], PetscInt *);
16994a4d4ebSMatthew G. Knepley PETSC_EXTERN PetscErrorCode KSPSetErrorHistory(KSP, PetscReal[], PetscInt, PetscBool);
1704b0e389bSBarry Smith 
171fa0ddf94SBarry Smith PETSC_EXTERN PetscErrorCode KSPBuildSolutionDefault(KSP, Vec, Vec *);
172fa0ddf94SBarry Smith PETSC_EXTERN PetscErrorCode KSPBuildResidualDefault(KSP, Vec, Vec, Vec *);
173fa0ddf94SBarry Smith PETSC_EXTERN PetscErrorCode KSPDestroyDefault(KSP);
174fa0ddf94SBarry Smith PETSC_EXTERN PetscErrorCode KSPSetWorkVecs(KSP, PetscInt);
175fa0ddf94SBarry Smith 
176014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCKSPGetKSP(PC, KSP *);
177cfebe74eSStefano Zampini PETSC_EXTERN PetscErrorCode PCKSPSetKSP(PC, KSP);
178014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCBJacobiGetSubKSP(PC, PetscInt *, PetscInt *, KSP *[]);
179014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCASMGetSubKSP(PC, PetscInt *, PetscInt *, KSP *[]);
180014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCGASMGetSubKSP(PC, PetscInt *, PetscInt *, KSP *[]);
181014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCFieldSplitGetSubKSP(PC, PetscInt *, KSP *[]);
182285fb4e2SStefano Zampini PETSC_EXTERN PetscErrorCode PCFieldSplitSchurGetSubKSP(PC, PetscInt *, KSP *[]);
183b4876bcbSBarry Smith PETSC_EXTERN PetscErrorCode PCMGGetSmoother(PC, PetscInt, KSP *);
184b4876bcbSBarry Smith PETSC_EXTERN PetscErrorCode PCMGGetSmootherDown(PC, PetscInt, KSP *);
185b4876bcbSBarry Smith PETSC_EXTERN PetscErrorCode PCMGGetSmootherUp(PC, PetscInt, KSP *);
186b4876bcbSBarry Smith PETSC_EXTERN PetscErrorCode PCMGGetCoarseSolve(PC, KSP *);
187014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCGalerkinGetKSP(PC, KSP *);
1884a99276eSJakub Kruzik PETSC_EXTERN PetscErrorCode PCDeflationGetCoarseKSP(PC, KSP *);
189f3b08a26SMatthew G. Knepley /*
190f3b08a26SMatthew G. Knepley   PCMGCoarseList contains the list of coarse space constructor currently registered
191f3b08a26SMatthew G. Knepley   These are added with PCMGRegisterCoarseSpaceConstructor()
192f3b08a26SMatthew G. Knepley */
193f3b08a26SMatthew G. Knepley PETSC_EXTERN PetscFunctionList PCMGCoarseList;
1942b3cbbdaSStefano Zampini PETSC_EXTERN PetscErrorCode    PCMGRegisterCoarseSpaceConstructor(const char[], PetscErrorCode (*)(PC, PetscInt, DM, KSP, PetscInt, Mat, Mat *));
1952b3cbbdaSStefano Zampini PETSC_EXTERN PetscErrorCode    PCMGGetCoarseSpaceConstructor(const char[], PetscErrorCode (**)(PC, PetscInt, DM, KSP, PetscInt, Mat, Mat *));
196f3b08a26SMatthew G. Knepley 
197014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPBuildSolution(KSP, Vec, Vec *);
198014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPBuildResidual(KSP, Vec, Vec, Vec *);
1992eac72dbSBarry Smith 
200f2edd1f0SMalachi Phillips /*E
20195bd0b28SBarry Smith   KSPChebyshevKind - Which kind of Chebyshev polynomial to use with `KSPCHEBYSHEV`
202f2edd1f0SMalachi Phillips 
203f2edd1f0SMalachi Phillips   Values:
204f2edd1f0SMalachi Phillips + `KSP_CHEBYSHEV_FIRST`      - "classic" first-kind Chebyshev polynomial
205f2edd1f0SMalachi Phillips . `KSP_CHEBYSHEV_FOURTH`     - fourth-kind Chebyshev polynomial
206f2edd1f0SMalachi Phillips - `KSP_CHEBYSHEV_OPT_FOURTH` - optimized fourth-kind Chebyshev polynomial
207f2edd1f0SMalachi Phillips 
208f2edd1f0SMalachi Phillips   Level: intermediate
209f2edd1f0SMalachi Phillips 
2101cc06b55SBarry Smith .seealso: [](ch_ksp), `KSPCHEBYSHEV`, `KSPChebyshevSetKind()`, `KSPChebyshevGetKind()`
211f2edd1f0SMalachi Phillips E*/
212f2edd1f0SMalachi Phillips typedef enum {
213f2edd1f0SMalachi Phillips   KSP_CHEBYSHEV_FIRST,
214f2edd1f0SMalachi Phillips   KSP_CHEBYSHEV_FOURTH,
215f2edd1f0SMalachi Phillips   KSP_CHEBYSHEV_OPT_FOURTH
216f2edd1f0SMalachi Phillips } KSPChebyshevKind;
217f2edd1f0SMalachi Phillips 
218014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPRichardsonSetScale(KSP, PetscReal);
219014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPRichardsonSetSelfScale(KSP, PetscBool);
220014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPChebyshevSetEigenvalues(KSP, PetscReal, PetscReal);
22158450487SBarry Smith PETSC_EXTERN PetscErrorCode KSPChebyshevEstEigSet(KSP, PetscReal, PetscReal, PetscReal, PetscReal);
222b65fd476SMark Adams PETSC_EXTERN PetscErrorCode KSPChebyshevEstEigSetUseNoisy(KSP, PetscBool);
223f2edd1f0SMalachi Phillips PETSC_EXTERN PetscErrorCode KSPChebyshevSetKind(KSP, KSPChebyshevKind);
22416a05f60SBarry Smith PETSC_EXTERN PetscErrorCode KSPChebyshevGetKind(KSP, KSPChebyshevKind *);
22558450487SBarry Smith PETSC_EXTERN PetscErrorCode KSPChebyshevEstEigGetKSP(KSP, KSP *);
226014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPComputeExtremeSingularValues(KSP, PetscReal *, PetscReal *);
227d38fc84dSBarry Smith PETSC_EXTERN PetscErrorCode KSPComputeEigenvalues(KSP, PetscInt, PetscReal[], PetscReal[], PetscInt *);
228d38fc84dSBarry Smith PETSC_EXTERN PetscErrorCode KSPComputeEigenvaluesExplicitly(KSP, PetscInt, PetscReal[], PetscReal[]);
2297d7fa35eSSylvain Mercier PETSC_EXTERN PetscErrorCode KSPComputeRitz(KSP, PetscBool, PetscBool, PetscInt *, Vec[], PetscReal[], PetscReal[]);
2304b0e389bSBarry Smith 
231640f4f53SPatrick Sanan /*E
232640f4f53SPatrick Sanan 
23306137d0aSPatrick Sanan   KSPFCDTruncationType - Define how stored directions are used to orthogonalize in flexible conjugate directions (FCD) methods
234640f4f53SPatrick Sanan 
23567b8a455SSatish Balay   Values:
236a1cb98faSBarry Smith + `KSP_FCD_TRUNC_TYPE_STANDARD` - uses all (up to mmax) stored directions
237a1cb98faSBarry Smith - `KSP_FCD_TRUNC_TYPE_NOTAY` - uses the last max(1,mod(i,mmax)) stored directions at iteration i=0,1..
238640f4f53SPatrick Sanan 
2392b26979fSBarry Smith    Level: intermediate
240640f4f53SPatrick Sanan 
2411cc06b55SBarry Smith .seealso: [](ch_ksp), `KSP`, `KSPFCG`, `KSPPIPEFCG`, `KSPPIPEGCR`, `KSPFCGSetTruncationType()`, `KSPFCGGetTruncationType()`
242640f4f53SPatrick Sanan E*/
2439371c9d4SSatish Balay typedef enum {
2449371c9d4SSatish Balay   KSP_FCD_TRUNC_TYPE_STANDARD,
2459371c9d4SSatish Balay   KSP_FCD_TRUNC_TYPE_NOTAY
2469371c9d4SSatish Balay } KSPFCDTruncationType;
24706137d0aSPatrick Sanan PETSC_EXTERN const char *const KSPFCDTruncationTypes[];
248640f4f53SPatrick Sanan 
249640f4f53SPatrick Sanan PETSC_EXTERN PetscErrorCode KSPFCGSetMmax(KSP, PetscInt);
250640f4f53SPatrick Sanan PETSC_EXTERN PetscErrorCode KSPFCGGetMmax(KSP, PetscInt *);
251640f4f53SPatrick Sanan PETSC_EXTERN PetscErrorCode KSPFCGSetNprealloc(KSP, PetscInt);
252640f4f53SPatrick Sanan PETSC_EXTERN PetscErrorCode KSPFCGGetNprealloc(KSP, PetscInt *);
25306137d0aSPatrick Sanan PETSC_EXTERN PetscErrorCode KSPFCGSetTruncationType(KSP, KSPFCDTruncationType);
25406137d0aSPatrick Sanan PETSC_EXTERN PetscErrorCode KSPFCGGetTruncationType(KSP, KSPFCDTruncationType *);
255640f4f53SPatrick Sanan 
256390d8e47SPatrick Sanan PETSC_EXTERN PetscErrorCode KSPPIPEFCGSetMmax(KSP, PetscInt);
257390d8e47SPatrick Sanan PETSC_EXTERN PetscErrorCode KSPPIPEFCGGetMmax(KSP, PetscInt *);
258390d8e47SPatrick Sanan PETSC_EXTERN PetscErrorCode KSPPIPEFCGSetNprealloc(KSP, PetscInt);
259390d8e47SPatrick Sanan PETSC_EXTERN PetscErrorCode KSPPIPEFCGGetNprealloc(KSP, PetscInt *);
260390d8e47SPatrick Sanan PETSC_EXTERN PetscErrorCode KSPPIPEFCGSetTruncationType(KSP, KSPFCDTruncationType);
261390d8e47SPatrick Sanan PETSC_EXTERN PetscErrorCode KSPPIPEFCGGetTruncationType(KSP, KSPFCDTruncationType *);
262390d8e47SPatrick Sanan 
263fad47a0aSPatrick Sanan PETSC_EXTERN PetscErrorCode KSPPIPEGCRSetMmax(KSP, PetscInt);
264fad47a0aSPatrick Sanan PETSC_EXTERN PetscErrorCode KSPPIPEGCRGetMmax(KSP, PetscInt *);
265fad47a0aSPatrick Sanan PETSC_EXTERN PetscErrorCode KSPPIPEGCRSetNprealloc(KSP, PetscInt);
266fad47a0aSPatrick Sanan PETSC_EXTERN PetscErrorCode KSPPIPEGCRGetNprealloc(KSP, PetscInt *);
267fad47a0aSPatrick Sanan PETSC_EXTERN PetscErrorCode KSPPIPEGCRSetTruncationType(KSP, KSPFCDTruncationType);
268fad47a0aSPatrick Sanan PETSC_EXTERN PetscErrorCode KSPPIPEGCRGetTruncationType(KSP, KSPFCDTruncationType *);
269fad47a0aSPatrick Sanan PETSC_EXTERN PetscErrorCode KSPPIPEGCRSetUnrollW(KSP, PetscBool);
270fad47a0aSPatrick Sanan PETSC_EXTERN PetscErrorCode KSPPIPEGCRGetUnrollW(KSP, PetscBool *);
2714bf303faSJacob Faibussowitsch PETSC_EXTERN PetscErrorCode KSPPIPEGCRSetModifyPC(KSP, PetscErrorCode (*)(KSP, PetscInt, PetscReal, void *), void *, PetscErrorCode (*)(void *));
27283f0b094SBarry Smith 
273014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGMRESSetRestart(KSP, PetscInt);
274014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGMRESGetRestart(KSP, PetscInt *);
275014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGMRESSetHapTol(KSP, PetscReal);
276e3729115SFande Kong PETSC_EXTERN PetscErrorCode KSPGMRESSetBreakdownTolerance(KSP, PetscReal);
2779f236934SBarry Smith 
278014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGMRESSetPreAllocateVectors(KSP);
279014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGMRESSetOrthogonalization(KSP, PetscErrorCode (*)(KSP, PetscInt));
280014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGMRESGetOrthogonalization(KSP, PetscErrorCode (**)(KSP, PetscInt));
281014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGMRESModifiedGramSchmidtOrthogonalization(KSP, PetscInt);
282014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGMRESClassicalGramSchmidtOrthogonalization(KSP, PetscInt);
2831d73ed98SBarry Smith 
284014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPLGMRESSetAugDim(KSP, PetscInt);
285014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPLGMRESSetConstant(KSP);
2861d73ed98SBarry Smith 
287483d6965SPatrick Sanan PETSC_EXTERN PetscErrorCode KSPPIPEFGMRESSetShift(KSP, PetscScalar);
288483d6965SPatrick Sanan 
289014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGCRSetRestart(KSP, PetscInt);
290014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGCRGetRestart(KSP, PetscInt *);
291014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGCRSetModifyPC(KSP, PetscErrorCode (*)(KSP, PetscInt, PetscReal, void *), void *, PetscErrorCode (*)(void *));
29258ad63f4SBarry Smith 
293f87a0b54SStefano Zampini PETSC_EXTERN PetscErrorCode KSPMINRESSetRadius(KSP, PetscReal);
294f87a0b54SStefano Zampini PETSC_EXTERN PetscErrorCode KSPMINRESGetUseQLP(KSP, PetscBool *);
295f87a0b54SStefano Zampini PETSC_EXTERN PetscErrorCode KSPMINRESSetUseQLP(KSP, PetscBool);
296f87a0b54SStefano Zampini 
29704d8bde8SStefano Zampini PETSC_EXTERN PetscErrorCode KSPFETIDPGetInnerBDDC(KSP, PC *);
29804d8bde8SStefano Zampini PETSC_EXTERN PetscErrorCode KSPFETIDPSetInnerBDDC(KSP, PC);
29904d8bde8SStefano Zampini PETSC_EXTERN PetscErrorCode KSPFETIDPGetInnerKSP(KSP, KSP *);
300568c15deSstefano_zampini PETSC_EXTERN PetscErrorCode KSPFETIDPSetPressureOperator(KSP, Mat);
301e82af88dSprj- 
3026cac28cbSPierre Jolivet PETSC_EXTERN PetscErrorCode KSPHPDDMSetDeflationMat(KSP, Mat);
3036cac28cbSPierre Jolivet PETSC_EXTERN PetscErrorCode KSPHPDDMGetDeflationMat(KSP, Mat *);
3046cac28cbSPierre Jolivet #if PetscDefined(HAVE_HPDDM)
305edd03b47SJacob Faibussowitsch PETSC_DEPRECATED_FUNCTION(3, 18, 0, "KSPHPDDMSetDeflationMat()", ) static inline PetscErrorCode KSPHPDDMSetDeflationSpace(KSP ksp, Mat U)
306d71ae5a4SJacob Faibussowitsch {
3079371c9d4SSatish Balay   return KSPHPDDMSetDeflationMat(ksp, U);
3089371c9d4SSatish Balay }
309edd03b47SJacob Faibussowitsch PETSC_DEPRECATED_FUNCTION(3, 18, 0, "KSPHPDDMGetDeflationMat()", ) static inline PetscErrorCode KSPHPDDMGetDeflationSpace(KSP ksp, Mat *U)
310d71ae5a4SJacob Faibussowitsch {
3119371c9d4SSatish Balay   return KSPHPDDMGetDeflationMat(ksp, U);
3129371c9d4SSatish Balay }
3136cac28cbSPierre Jolivet #endif
314edd03b47SJacob Faibussowitsch PETSC_DEPRECATED_FUNCTION(3, 14, 0, "KSPMatSolve()", ) static inline PetscErrorCode KSPHPDDMMatSolve(KSP ksp, Mat B, Mat X)
315d71ae5a4SJacob Faibussowitsch {
3169371c9d4SSatish Balay   return KSPMatSolve(ksp, B, X);
3179371c9d4SSatish Balay }
318d55ab951SPierre Jolivet /*E
31987497f52SBarry Smith     KSPHPDDMType - Type of Krylov method used by `KSPHPDDM`
320d55ab951SPierre Jolivet 
321d55ab951SPierre Jolivet     Values:
322a4d1885cSBarry Smith +   `KSP_HPDDM_TYPE_GMRES` (default) - Generalized Minimal Residual method
323a4d1885cSBarry Smith .   `KSP_HPDDM_TYPE_BGMRES` - block GMRES
324a4d1885cSBarry Smith .   `KSP_HPDDM_TYPE_CG` - Conjugate Gradient
325a4d1885cSBarry Smith .   `KSP_HPDDM_TYPE_BCG` - block CG
326a4d1885cSBarry Smith .   `KSP_HPDDM_TYPE_GCRODR` - Generalized Conjugate Residual method with inner Orthogonalization and Deflated Restarting
327a4d1885cSBarry Smith .   `KSP_HPDDM_TYPE_BGCRODR` - block GCRODR
328a4d1885cSBarry Smith .   `KSP_HPDDM_TYPE_BFBCG` - breakdown-free BCG
329a4d1885cSBarry Smith -   `KSP_HPDDM_TYPE_PREONLY` - apply the preconditioner only
330d55ab951SPierre Jolivet 
33116a05f60SBarry Smith     Level: intermediate
33216a05f60SBarry Smith 
3331cc06b55SBarry Smith .seealso: [](ch_ksp), `KSPHPDDM`, `KSPHPDDMSetType()`
334d55ab951SPierre Jolivet E*/
335d55ab951SPierre Jolivet typedef enum {
336d55ab951SPierre Jolivet   KSP_HPDDM_TYPE_GMRES   = 0,
337d55ab951SPierre Jolivet   KSP_HPDDM_TYPE_BGMRES  = 1,
338d55ab951SPierre Jolivet   KSP_HPDDM_TYPE_CG      = 2,
339d55ab951SPierre Jolivet   KSP_HPDDM_TYPE_BCG     = 3,
340d55ab951SPierre Jolivet   KSP_HPDDM_TYPE_GCRODR  = 4,
341d55ab951SPierre Jolivet   KSP_HPDDM_TYPE_BGCRODR = 5,
342d55ab951SPierre Jolivet   KSP_HPDDM_TYPE_BFBCG   = 6,
343d55ab951SPierre Jolivet   KSP_HPDDM_TYPE_PREONLY = 7
344d55ab951SPierre Jolivet } KSPHPDDMType;
345d55ab951SPierre Jolivet PETSC_EXTERN const char *const KSPHPDDMTypes[];
346a4d1885cSBarry Smith 
3472dd49c90SPierre Jolivet /*E
34887497f52SBarry Smith     KSPHPDDMPrecision - Precision of Krylov bases used by `KSPHPDDM`
3492dd49c90SPierre Jolivet 
3502dd49c90SPierre Jolivet     Values:
351a4d1885cSBarry Smith +   `KSP_HPDDM_PRECISION_HALF` - default when PETSc is configured `--with-precision=__fp16`
352a4d1885cSBarry Smith .   `KSP_HPDDM_PRECISION_SINGLE` - default when PETSc is configured `--with-precision=single`
353a4d1885cSBarry Smith .   `KSP_HPDDM_PRECISION_DOUBLE` - default when PETSc is configured `--with-precision=double`
354a4d1885cSBarry Smith -   `KSP_HPDDM_PRECISION_QUADRUPLE` - default when PETSc is configured `--with-precision=__float128`
3552dd49c90SPierre Jolivet 
35616a05f60SBarry Smith     Level: intermediate
35716a05f60SBarry Smith 
3581cc06b55SBarry Smith .seealso: [](ch_ksp), `KSP`, `KSPHPDDM`
3592dd49c90SPierre Jolivet E*/
3602dd49c90SPierre Jolivet typedef enum {
3612dd49c90SPierre Jolivet   KSP_HPDDM_PRECISION_HALF      = 0,
3622dd49c90SPierre Jolivet   KSP_HPDDM_PRECISION_SINGLE    = 1,
3632dd49c90SPierre Jolivet   KSP_HPDDM_PRECISION_DOUBLE    = 2,
3642dd49c90SPierre Jolivet   KSP_HPDDM_PRECISION_QUADRUPLE = 3
3652dd49c90SPierre Jolivet } KSPHPDDMPrecision;
366d55ab951SPierre Jolivet PETSC_EXTERN PetscErrorCode KSPHPDDMSetType(KSP, KSPHPDDMType);
367d55ab951SPierre Jolivet PETSC_EXTERN PetscErrorCode KSPHPDDMGetType(KSP, KSPHPDDMType *);
368e82af88dSprj- 
369b49fd9e1SBarry Smith /*E
37016a05f60SBarry Smith     KSPGMRESCGSRefinementType - How the classical (unmodified) Gram-Schmidt is performed in the GMRES solvers
371b49fd9e1SBarry Smith 
372a4d1885cSBarry Smith     Values:
373a4d1885cSBarry Smith +   `KSP_GMRES_CGS_REFINE_NEVER` - one step of classical Gram-Schmidt
374a4d1885cSBarry Smith .   `KSP_GMRES_CGS_REFINE_IFNEEDED` - a second step is performed if the first step does not satisfy some criteria
375a4d1885cSBarry Smith -   `KSP_GMRES_CGS_REFINE_ALWAYS` - always perform two steps
376b49fd9e1SBarry Smith 
37716a05f60SBarry Smith    Level: advanced
37816a05f60SBarry Smith 
37995bd0b28SBarry Smith .seealso: [](ch_ksp), `KSP`, `KSPGMRES`, `KSPGMRESClassicalGramSchmidtOrthogonalization()`, `KSPGMRESSetOrthogonalization()`,
380a4d1885cSBarry Smith           `KSPGMRESGetOrthogonalization()`,
381a4d1885cSBarry Smith           `KSPGMRESSetCGSRefinementType()`, `KSPGMRESGetCGSRefinementType()`, `KSPGMRESModifiedGramSchmidtOrthogonalization()`
382b49fd9e1SBarry Smith E*/
3839371c9d4SSatish Balay typedef enum {
3849371c9d4SSatish Balay   KSP_GMRES_CGS_REFINE_NEVER,
3859371c9d4SSatish Balay   KSP_GMRES_CGS_REFINE_IFNEEDED,
3869371c9d4SSatish Balay   KSP_GMRES_CGS_REFINE_ALWAYS
3879371c9d4SSatish Balay } KSPGMRESCGSRefinementType;
3886a6fc655SJed Brown PETSC_EXTERN const char *const KSPGMRESCGSRefinementTypes[];
38916a05f60SBarry Smith 
3901f7e983dSSatish Balay /*MC
3911957e957SBarry Smith     KSP_GMRES_CGS_REFINE_NEVER - Do the classical (unmodified) Gram-Schmidt process
3928c5b8ba0SBarry Smith 
3938c5b8ba0SBarry Smith    Level: advanced
3948c5b8ba0SBarry Smith 
39587497f52SBarry Smith    Note:
39687497f52SBarry Smith    Possibly unstable, but the fastest to compute
3978c5b8ba0SBarry Smith 
39895bd0b28SBarry Smith .seealso: [](ch_ksp), `KSPGMRES`, `KSPGMRESCGSRefinementType`, `KSPGMRESClassicalGramSchmidtOrthogonalization()`, `KSPGMRESSetOrthogonalization()`,
399a4d1885cSBarry Smith           `KSP`, `KSPGMRESGetOrthogonalization()`,
400db781477SPatrick Sanan           `KSPGMRESSetCGSRefinementType()`, `KSPGMRESGetCGSRefinementType()`, `KSP_GMRES_CGS_REFINE_IFNEEDED`, `KSP_GMRES_CGS_REFINE_ALWAYS`,
401db781477SPatrick Sanan           `KSPGMRESModifiedGramSchmidtOrthogonalization()`
4028c5b8ba0SBarry Smith M*/
4038c5b8ba0SBarry Smith 
4041f7e983dSSatish Balay /*MC
4058c5b8ba0SBarry Smith     KSP_GMRES_CGS_REFINE_IFNEEDED - Do the classical (unmodified) Gram-Schmidt process and one step of
4068c5b8ba0SBarry Smith           iterative refinement if an estimate of the orthogonality of the resulting vectors indicates
4078c5b8ba0SBarry Smith           poor orthogonality.
4088c5b8ba0SBarry Smith 
4098c5b8ba0SBarry Smith    Level: advanced
4108c5b8ba0SBarry Smith 
411a4d1885cSBarry Smith    Note:
412a4d1885cSBarry Smith    This is slower than `KSP_GMRES_CGS_REFINE_NEVER` because it requires an extra norm computation to
4138c5b8ba0SBarry Smith    estimate the orthogonality but is more stable.
4148c5b8ba0SBarry Smith 
41595bd0b28SBarry Smith .seealso: [](ch_ksp), `KSPGMRES`, `KSPGMRESCGSRefinementType`, `KSPGMRESClassicalGramSchmidtOrthogonalization()`, `KSPGMRESSetOrthogonalization()`,
416a4d1885cSBarry Smith           `KSP`, `KSPGMRESGetOrthogonalization()`,
417db781477SPatrick Sanan           `KSPGMRESSetCGSRefinementType()`, `KSPGMRESGetCGSRefinementType()`, `KSP_GMRES_CGS_REFINE_NEVER`, `KSP_GMRES_CGS_REFINE_ALWAYS`,
418db781477SPatrick Sanan           `KSPGMRESModifiedGramSchmidtOrthogonalization()`
4198c5b8ba0SBarry Smith M*/
4208c5b8ba0SBarry Smith 
4211f7e983dSSatish Balay /*MC
42216a05f60SBarry Smith     KSP_GMRES_CGS_REFINE_ALWAYS - Do two steps of the classical (unmodified) Gram-Schmidt process.
4238c5b8ba0SBarry Smith 
4248c5b8ba0SBarry Smith    Level: advanced
4258c5b8ba0SBarry Smith 
42687497f52SBarry Smith    Notes:
42787497f52SBarry Smith    This is roughly twice the cost of `KSP_GMRES_CGS_REFINE_NEVER` because it performs the process twice
42887497f52SBarry Smith    but it saves the extra norm calculation needed by `KSP_GMRES_CGS_REFINE_IFNEEDED`.
4298c5b8ba0SBarry Smith 
4308c5b8ba0SBarry Smith    You should only use this if you absolutely know that the iterative refinement is needed.
4318c5b8ba0SBarry Smith 
43295bd0b28SBarry Smith .seealso: [](ch_ksp), `KSPGMRES`, `KSPGMRESCGSRefinementType`, `KSPGMRESClassicalGramSchmidtOrthogonalization()`, `KSPGMRESSetOrthogonalization()`,
433a4d1885cSBarry Smith           `KSP`, `KSPGMRESGetOrthogonalization()`,
434db781477SPatrick Sanan           `KSPGMRESSetCGSRefinementType()`, `KSPGMRESGetCGSRefinementType()`, `KSP_GMRES_CGS_REFINE_IFNEEDED`, `KSP_GMRES_CGS_REFINE_ALWAYS`,
435db781477SPatrick Sanan           `KSPGMRESModifiedGramSchmidtOrthogonalization()`
4368c5b8ba0SBarry Smith M*/
4378c5b8ba0SBarry Smith 
438014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGMRESSetCGSRefinementType(KSP, KSPGMRESCGSRefinementType);
439014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGMRESGetCGSRefinementType(KSP, KSPGMRESCGSRefinementType *);
44008480c60SBarry Smith 
441014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPFGMRESModifyPCNoChange(KSP, PetscInt, PetscInt, PetscReal, void *);
442014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPFGMRESModifyPCKSP(KSP, PetscInt, PetscInt, PetscReal, void *);
443014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPFGMRESSetModifyPC(KSP, PetscErrorCode (*)(KSP, PetscInt, PetscInt, PetscReal, void *), void *, PetscErrorCode (*)(void *));
444c38d4ed2SBarry Smith 
445014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPQCGSetTrustRegionRadius(KSP, PetscReal);
446014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPQCGGetQuadratic(KSP, PetscReal *);
447014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPQCGGetTrialStepNorm(KSP, PetscReal *);
448121fd945SKris Buschelman 
449014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPBCGSLSetXRes(KSP, PetscReal);
450014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPBCGSLSetPol(KSP, PetscBool);
451014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPBCGSLSetEll(KSP, PetscInt);
452e4b508b2SJed Brown PETSC_EXTERN PetscErrorCode KSPBCGSLSetUsePseudoinverse(KSP, PetscBool);
453d9492815SBarry Smith 
454014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSetFromOptions(KSP);
45587d6299eSMatthew G. Knepley PETSC_EXTERN PetscErrorCode KSPResetFromOptions(KSP);
4562eac72dbSBarry Smith 
457798534f6SMatthew G. Knepley PETSC_EXTERN PetscErrorCode KSPMonitorSetFromOptions(KSP, const char[], const char[], void *);
458798534f6SMatthew G. Knepley PETSC_EXTERN PetscErrorCode KSPMonitorLGCreate(MPI_Comm, const char[], const char[], const char[], PetscInt, const char *[], int, int, int, int, PetscDrawLG *);
459798534f6SMatthew G. Knepley PETSC_EXTERN PetscErrorCode KSPMonitorResidual(KSP, PetscInt, PetscReal, PetscViewerAndFormat *);
460798534f6SMatthew G. Knepley PETSC_EXTERN PetscErrorCode KSPMonitorResidualDraw(KSP, PetscInt, PetscReal, PetscViewerAndFormat *);
461798534f6SMatthew G. Knepley PETSC_EXTERN PetscErrorCode KSPMonitorResidualDrawLG(KSP, PetscInt, PetscReal, PetscViewerAndFormat *);
462798534f6SMatthew G. Knepley PETSC_EXTERN PetscErrorCode KSPMonitorResidualDrawLGCreate(PetscViewer, PetscViewerFormat, void *, PetscViewerAndFormat **);
463798534f6SMatthew G. Knepley PETSC_EXTERN PetscErrorCode KSPMonitorResidualShort(KSP, PetscInt, PetscReal, PetscViewerAndFormat *);
464798534f6SMatthew G. Knepley PETSC_EXTERN PetscErrorCode KSPMonitorResidualRange(KSP, PetscInt, PetscReal, PetscViewerAndFormat *);
465798534f6SMatthew G. Knepley PETSC_EXTERN PetscErrorCode KSPMonitorTrueResidual(KSP, PetscInt, PetscReal, PetscViewerAndFormat *);
466798534f6SMatthew G. Knepley PETSC_EXTERN PetscErrorCode KSPMonitorTrueResidualDraw(KSP, PetscInt, PetscReal, PetscViewerAndFormat *);
467798534f6SMatthew G. Knepley PETSC_EXTERN PetscErrorCode KSPMonitorTrueResidualDrawLG(KSP, PetscInt, PetscReal, PetscViewerAndFormat *);
468798534f6SMatthew G. Knepley PETSC_EXTERN PetscErrorCode KSPMonitorTrueResidualDrawLGCreate(PetscViewer, PetscViewerFormat, void *, PetscViewerAndFormat **);
469798534f6SMatthew G. Knepley PETSC_EXTERN PetscErrorCode KSPMonitorTrueResidualMax(KSP, PetscInt, PetscReal, PetscViewerAndFormat *);
470798534f6SMatthew G. Knepley PETSC_EXTERN PetscErrorCode KSPMonitorError(KSP, PetscInt, PetscReal, PetscViewerAndFormat *);
471798534f6SMatthew G. Knepley PETSC_EXTERN PetscErrorCode KSPMonitorErrorDraw(KSP, PetscInt, PetscReal, PetscViewerAndFormat *);
472798534f6SMatthew G. Knepley PETSC_EXTERN PetscErrorCode KSPMonitorErrorDrawLG(KSP, PetscInt, PetscReal, PetscViewerAndFormat *);
473798534f6SMatthew G. Knepley PETSC_EXTERN PetscErrorCode KSPMonitorErrorDrawLGCreate(PetscViewer, PetscViewerFormat, void *, PetscViewerAndFormat **);
474798534f6SMatthew G. Knepley PETSC_EXTERN PetscErrorCode KSPMonitorSolution(KSP, PetscInt, PetscReal, PetscViewerAndFormat *);
475798534f6SMatthew G. Knepley PETSC_EXTERN PetscErrorCode KSPMonitorSolutionDraw(KSP, PetscInt, PetscReal, PetscViewerAndFormat *);
476798534f6SMatthew G. Knepley PETSC_EXTERN PetscErrorCode KSPMonitorSolutionDrawLG(KSP, PetscInt, PetscReal, PetscViewerAndFormat *);
477798534f6SMatthew G. Knepley PETSC_EXTERN PetscErrorCode KSPMonitorSolutionDrawLGCreate(PetscViewer, PetscViewerFormat, void *, PetscViewerAndFormat **);
478fe01d993SBarry Smith PETSC_EXTERN PetscErrorCode KSPMonitorSingularValue(KSP, PetscInt, PetscReal, PetscViewerAndFormat *);
479798534f6SMatthew G. Knepley PETSC_EXTERN PetscErrorCode KSPMonitorSingularValueCreate(PetscViewer, PetscViewerFormat, void *, PetscViewerAndFormat **);
480edd03b47SJacob Faibussowitsch PETSC_DEPRECATED_FUNCTION(3, 15, 0, "KSPMonitorResidual()", ) static inline PetscErrorCode KSPMonitorDefault(KSP ksp, PetscInt n, PetscReal rnorm, PetscViewerAndFormat *vf)
481d71ae5a4SJacob Faibussowitsch {
4829371c9d4SSatish Balay   return KSPMonitorResidual(ksp, n, rnorm, vf);
4839371c9d4SSatish Balay }
484edd03b47SJacob Faibussowitsch PETSC_DEPRECATED_FUNCTION(3, 15, 0, "KSPMonitorTrueResidual()", ) static inline PetscErrorCode KSPMonitorTrueResidualNorm(KSP ksp, PetscInt n, PetscReal rnorm, PetscViewerAndFormat *vf)
485d71ae5a4SJacob Faibussowitsch {
4869371c9d4SSatish Balay   return KSPMonitorTrueResidual(ksp, n, rnorm, vf);
4879371c9d4SSatish Balay }
488edd03b47SJacob Faibussowitsch PETSC_DEPRECATED_FUNCTION(3, 15, 0, "KSPMonitorTrueResidualMax()", ) static inline PetscErrorCode KSPMonitorTrueResidualMaxNorm(KSP ksp, PetscInt n, PetscReal rnorm, PetscViewerAndFormat *vf)
489d71ae5a4SJacob Faibussowitsch {
4909371c9d4SSatish Balay   return KSPMonitorTrueResidualMax(ksp, n, rnorm, vf);
4919371c9d4SSatish Balay }
492798534f6SMatthew G. Knepley 
493798534f6SMatthew G. Knepley PETSC_EXTERN PetscErrorCode KSPGMRESMonitorKrylov(KSP, PetscInt, PetscReal, void *);
494341b8579SBarry Smith PETSC_EXTERN PetscErrorCode KSPMonitorDynamicTolerance(KSP, PetscInt, PetscReal, void *);
495341b8579SBarry Smith PETSC_EXTERN PetscErrorCode KSPMonitorDynamicToleranceDestroy(void **);
496341b8579SBarry Smith PETSC_EXTERN PetscErrorCode KSPMonitorDynamicToleranceCreate(void *);
497341b8579SBarry Smith PETSC_EXTERN PetscErrorCode KSPMonitorDynamicToleranceSetCoefficient(void *, PetscReal);
498e04113cfSBarry Smith PETSC_EXTERN PetscErrorCode KSPMonitorSAWs(KSP, PetscInt, PetscReal, void *);
499e04113cfSBarry Smith PETSC_EXTERN PetscErrorCode KSPMonitorSAWsCreate(KSP, void **);
500e04113cfSBarry Smith PETSC_EXTERN PetscErrorCode KSPMonitorSAWsDestroy(void **);
50184cb2905SBarry Smith 
502014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPUnwindPreconditioner(KSP, Vec, Vec);
503014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPInitialResidual(KSP, Vec, Vec, Vec, Vec, Vec);
504c01c455dSBarry Smith 
50523ee1639SBarry Smith PETSC_EXTERN PetscErrorCode KSPSetOperators(KSP, Mat, Mat);
50623ee1639SBarry Smith PETSC_EXTERN PetscErrorCode KSPGetOperators(KSP, Mat *, Mat *);
507014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGetOperatorsSet(KSP, PetscBool *, PetscBool *);
508014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSetOptionsPrefix(KSP, const char[]);
509014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPAppendOptionsPrefix(KSP, const char[]);
510014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGetOptionsPrefix(KSP, const char *[]);
5111eb62cbbSBarry Smith 
512014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSetDiagonalScale(KSP, PetscBool);
513014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGetDiagonalScale(KSP, PetscBool *);
514014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSetDiagonalScaleFix(KSP, PetscBool);
515014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGetDiagonalScaleFix(KSP, PetscBool *);
5161f7f0c4fSBarry Smith 
517014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPView(KSP, PetscViewer);
51855849f57SBarry Smith PETSC_EXTERN PetscErrorCode KSPLoad(KSP, PetscViewer);
519fe2efc57SMark PETSC_EXTERN PetscErrorCode KSPViewFromOptions(KSP, PetscObject, const char[]);
52019a666eeSBarry Smith PETSC_EXTERN PetscErrorCode KSPConvergedReasonView(KSP, PetscViewer);
521c4421ceaSFande Kong PETSC_EXTERN PetscErrorCode KSPConvergedReasonViewSet(KSP, PetscErrorCode (*)(KSP, void *), void *vctx, PetscErrorCode (*)(void **));
5221b2b9847SBarry Smith PETSC_EXTERN PetscErrorCode KSPConvergedReasonViewFromOptions(KSP);
523c4421ceaSFande Kong PETSC_EXTERN PetscErrorCode KSPConvergedReasonViewCancel(KSP);
52494a4d4ebSMatthew G. Knepley PETSC_EXTERN PetscErrorCode KSPConvergedRateView(KSP, PetscViewer);
5251b2b9847SBarry Smith 
526edd03b47SJacob Faibussowitsch PETSC_DEPRECATED_FUNCTION(3, 14, 0, "KSPConvergedReasonView()", ) static inline PetscErrorCode KSPReasonView(KSP ksp, PetscViewer v)
527d71ae5a4SJacob Faibussowitsch {
5289371c9d4SSatish Balay   return KSPConvergedReasonView(ksp, v);
5299371c9d4SSatish Balay }
530edd03b47SJacob Faibussowitsch PETSC_DEPRECATED_FUNCTION(3, 14, 0, "KSPConvergedReasonViewFromOptions()", ) static inline PetscErrorCode KSPReasonViewFromOptions(KSP ksp)
531d71ae5a4SJacob Faibussowitsch {
5329371c9d4SSatish Balay   return KSPConvergedReasonViewFromOptions(ksp);
5339371c9d4SSatish Balay }
53455849f57SBarry Smith 
53555849f57SBarry Smith #define KSP_FILE_CLASSID 1211223
5361eb62cbbSBarry Smith 
537dcc87044SVaclav Hapla PETSC_EXTERN PetscErrorCode KSPLSQRSetExactMatNorm(KSP, PetscBool);
5380e827bf4SVaclav Hapla PETSC_EXTERN PetscErrorCode KSPLSQRSetComputeStandardErrorVec(KSP, PetscBool);
539014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPLSQRGetStandardErrorVec(KSP, Vec *);
540884807c7SVaclav Hapla PETSC_EXTERN PetscErrorCode KSPLSQRGetNorms(KSP, PetscReal *, PetscReal *);
541798534f6SMatthew G. Knepley PETSC_EXTERN PetscErrorCode KSPLSQRMonitorResidual(KSP, PetscInt, PetscReal, PetscViewerAndFormat *);
542798534f6SMatthew G. Knepley PETSC_EXTERN PetscErrorCode KSPLSQRMonitorResidualDrawLG(KSP, PetscInt, PetscReal, PetscViewerAndFormat *);
543798534f6SMatthew G. Knepley PETSC_EXTERN PetscErrorCode KSPLSQRMonitorResidualDrawLGCreate(PetscViewer, PetscViewerFormat, void *, PetscViewerAndFormat **);
544db9b2ab1SHong Zhang 
545014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCRedundantGetKSP(PC, KSP *);
546014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCRedistributeGetKSP(PC, KSP *);
54768ddcbeaSBarry Smith PETSC_EXTERN PetscErrorCode PCTelescopeGetKSP(PC, KSP *);
54883ab6a24SBarry Smith 
54928ce4d24SBarry Smith /*E
550a4d1885cSBarry Smith     KSPNormType - Norm calculated by the `KSP` and passed in the Krylov convergence
5518a4b9c5cSBarry Smith        test routines.
5528a4b9c5cSBarry Smith 
553a4d1885cSBarry Smith     Values:
554a4d1885cSBarry Smith +   `KSP_NORM_DEFAULT` - use the default for the current `KSPType`
555a4d1885cSBarry Smith .   `KSP_NORM_NONE` - use no norm calculation
556a4d1885cSBarry Smith .   `KSP_NORM_PRECONDITIONED` - use the preconditioned residual norm
557a4d1885cSBarry Smith .   `KSP_NORM_UNPRECONDITIONED` - use the unpreconditioned residual norm
558a4d1885cSBarry Smith -   `KSP_NORM_NATURAL` - use the natural norm (the norm induced by the linear operator)
559a4d1885cSBarry Smith 
5608a4b9c5cSBarry Smith    Level: advanced
5618a4b9c5cSBarry Smith 
562a4d1885cSBarry Smith    Note:
563a3f661c8SBarry Smith    Each solver only supports a subset of these and some may support different ones
56416a05f60SBarry Smith    depending on whether left or right preconditioning is used, see `KSPSetPCSide()`
565a3f661c8SBarry Smith 
5661cc06b55SBarry Smith .seealso: [](ch_ksp), `KSP`, `PCSide`, `KSPSolve()`, `KSPGetConvergedReason()`, `KSPSetNormType()`,
56795bd0b28SBarry Smith           `KSPSetConvergenceTest()`, `KSPSetPCSide()`, `KSP_NORM_DEFAULT`, `KSP_NORM_NONE`, `KSP_NORM_PRECONDITIONED`, `KSP_NORM_UNPRECONDITIONED`, `KSP_NORM_NATURAL`
5688a4b9c5cSBarry Smith E*/
5699371c9d4SSatish Balay typedef enum {
5709371c9d4SSatish Balay   KSP_NORM_DEFAULT          = -1,
5719371c9d4SSatish Balay   KSP_NORM_NONE             = 0,
5729371c9d4SSatish Balay   KSP_NORM_PRECONDITIONED   = 1,
5739371c9d4SSatish Balay   KSP_NORM_UNPRECONDITIONED = 2,
5749371c9d4SSatish Balay   KSP_NORM_NATURAL          = 3
5759371c9d4SSatish Balay } KSPNormType;
5769e568555SJed Brown #define KSP_NORM_MAX (KSP_NORM_NATURAL + 1)
577014dd563SJed Brown PETSC_EXTERN const char *const *const KSPNormTypes;
578a21b2a99SBarry Smith 
5791f7e983dSSatish Balay /*MC
5809793b452SBarry Smith     KSP_NORM_NONE - Do not compute a norm during the Krylov process. This will
5818c5b8ba0SBarry Smith           possibly save some computation but means the convergence test cannot
5828c5b8ba0SBarry Smith           be based on a norm of a residual etc.
5838c5b8ba0SBarry Smith 
5848c5b8ba0SBarry Smith    Level: advanced
5858c5b8ba0SBarry Smith 
586a4d1885cSBarry Smith     Note:
587a4d1885cSBarry Smith     Some Krylov methods need to compute a residual norm (such as `KPSGMRES`) and then this option is ignored
5888c5b8ba0SBarry Smith 
5891cc06b55SBarry Smith .seealso: [](ch_ksp), `KSPNormType`, `KSP`, `KSPSetNormType()`, `KSP_NORM_PRECONDITIONED`, `KSP_NORM_UNPRECONDITIONED`, `KSP_NORM_NATURAL`
5908c5b8ba0SBarry Smith M*/
5918c5b8ba0SBarry Smith 
5921f7e983dSSatish Balay /*MC
5931957e957SBarry Smith     KSP_NORM_PRECONDITIONED - Compute the norm of the preconditioned residual B*(b - A*x), if left preconditioning, and pass that to the
5948c5b8ba0SBarry Smith        convergence test routine.
5958c5b8ba0SBarry Smith 
5968c5b8ba0SBarry Smith    Level: advanced
5978c5b8ba0SBarry Smith 
5981cc06b55SBarry Smith .seealso: [](ch_ksp), `KSPNormType`, `KSP`, `KSPSetNormType()`, `KSP_NORM_NONE`, `KSP_NORM_UNPRECONDITIONED`, `KSP_NORM_NATURAL`, `KSPSetConvergenceTest()`
5998c5b8ba0SBarry Smith M*/
6008c5b8ba0SBarry Smith 
6011f7e983dSSatish Balay /*MC
602ce9499c7SBarry Smith     KSP_NORM_UNPRECONDITIONED - Compute the norm of the true residual (b - A*x) and pass that to the
6038c5b8ba0SBarry Smith        convergence test routine.
6048c5b8ba0SBarry Smith 
6058c5b8ba0SBarry Smith    Level: advanced
6068c5b8ba0SBarry Smith 
6071cc06b55SBarry Smith .seealso: [](ch_ksp), `KSPNormType`, `KSP`, `KSPSetNormType()`, `KSP_NORM_NONE`, `KSP_NORM_PRECONDITIONED`, `KSP_NORM_NATURAL`, `KSPSetConvergenceTest()`
6088c5b8ba0SBarry Smith M*/
6098c5b8ba0SBarry Smith 
6101f7e983dSSatish Balay /*MC
611ce9499c7SBarry Smith     KSP_NORM_NATURAL - Compute the 'natural norm' of residual sqrt((b - A*x)*B*(b - A*x)) and pass that to the
61287497f52SBarry Smith        convergence test routine. This is only supported by  `KSPCG`, `KSPCR`, `KSPCGNE`, `KSPCGS`, `KSPFCG`, `KSPPIPEFCG`, `KSPPIPEGCR`
6138c5b8ba0SBarry Smith 
6148c5b8ba0SBarry Smith    Level: advanced
6158c5b8ba0SBarry Smith 
6161cc06b55SBarry Smith .seealso: [](ch_ksp), `KSPNormType`, `KSP`, `KSPSetNormType()`, `KSP_NORM_NONE`, `KSP_NORM_PRECONDITIONED`, `KSP_NORM_UNPRECONDITIONED`, `KSPSetConvergenceTest()`
6178c5b8ba0SBarry Smith M*/
6188c5b8ba0SBarry Smith 
619014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSetNormType(KSP, KSPNormType);
620014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGetNormType(KSP, KSPNormType *);
621014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSetSupportedNorm(KSP ksp, KSPNormType, PCSide, PetscInt);
622014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSetCheckNormIteration(KSP, PetscInt);
623014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSetLagNorm(KSP, PetscBool);
6248a4b9c5cSBarry Smith 
625edd03b47SJacob Faibussowitsch #define KSP_CONVERGED_CG_NEG_CURVE_DEPRECATED   KSP_CONVERGED_CG_NEG_CURVE PETSC_DEPRECATED_ENUM(3, 19, 0, "KSP_CONVERGED_NEG_CURVE", )
626edd03b47SJacob Faibussowitsch #define KSP_CONVERGED_CG_CONSTRAINED_DEPRECATED KSP_CONVERGED_CG_CONSTRAINED PETSC_DEPRECATED_ENUM(3, 19, 0, "KSP_CONVERGED_STEP_LENGTH", )
627edd03b47SJacob Faibussowitsch #define KSP_DIVERGED_PCSETUP_FAILED_DEPRECATED  KSP_DIVERGED_PCSETUP_FAILED PETSC_DEPRECATED_ENUM(3, 11, 0, "KSP_DIVERGED_PC_FAILED", )
6288a4b9c5cSBarry Smith /*E
629a4d1885cSBarry Smith     KSPConvergedReason - reason a Krylov method was determined to have converged or diverged
63028ce4d24SBarry Smith 
631a4d1885cSBarry Smith    Values:
632a4d1885cSBarry Smith +  `KSP_CONVERGED_RTOL_NORMAL` - requested decrease in the residual for the normal equations
633a4d1885cSBarry Smith .  `KSP_CONVERGED_ATOL_NORMAL` - requested absolute value in the residual for the normal equations
634a4d1885cSBarry Smith .  `KSP_CONVERGED_RTOL` - requested decrease in the residual
635a4d1885cSBarry Smith .  `KSP_CONVERGED_ATOL` - requested absolute value in the residual
636a4d1885cSBarry Smith .  `KSP_CONVERGED_ITS` - requested number of iterations
6374a221d59SStefano Zampini .  `KSP_CONVERGED_NEG_CURVE` - see note below
638a4d1885cSBarry Smith .  `KSP_CONVERGED_STEP_LENGTH` - see note below
6396e7835fbSStefano Zampini .  `KSP_CONVERGED_HAPPY_BREAKDOWN` - happy breakdown (meaning early convergence of the `KSPType` occurred).
640a4d1885cSBarry Smith .  `KSP_DIVERGED_NULL` - breakdown when solving the Hessenberg system within GMRES
641a4d1885cSBarry Smith .  `KSP_DIVERGED_ITS` - requested number of iterations
642a4d1885cSBarry Smith .  `KSP_DIVERGED_DTOL` - large increase in the residual norm
643a4d1885cSBarry Smith .  `KSP_DIVERGED_BREAKDOWN` - breakdown in the Krylov method
644a4d1885cSBarry Smith .  `KSP_DIVERGED_BREAKDOWN_BICG` - breakdown in the `KSPBGCS` Krylov method
645a4d1885cSBarry Smith .  `KSP_DIVERGED_NONSYMMETRIC` - the operator or preonditioner was not symmetric for a `KSPType` that requires symmetry
646a4d1885cSBarry Smith .  `KSP_DIVERGED_INDEFINITE_PC` - the preconditioner was indefinite for a `KSPType` that requires it be definite
647a4d1885cSBarry Smith .  `KSP_DIVERGED_NANORINF` - a not a number of infinity was detected in a vector during the computation
648a4d1885cSBarry Smith .  `KSP_DIVERGED_INDEFINITE_MAT` - the operator was indefinite for a `KSPType` that requires it be definite
649a4d1885cSBarry Smith -  `KSP_DIVERGED_PC_FAILED` - the action of the preconditioner failed for some reason
650a4d1885cSBarry Smith 
65116a05f60SBarry Smith    Level: beginner
65216a05f60SBarry Smith 
653a4d1885cSBarry Smith    Note:
6546e7835fbSStefano Zampini    The values `KSP_CONVERGED_NEG_CURVE`, and `KSP_CONVERGED_STEP_LENGTH` are returned only by `KSPCG`, `KSPMINRES` and by
6556e7835fbSStefano Zampini    the special `KSPNASH`, `KSPSTCG`, and `KSPGLTR` solvers which are used by the `SNESNEWTONTR` (trust region) solver.
65628ce4d24SBarry Smith 
65795bd0b28SBarry Smith    Developer Note:
65887497f52SBarry Smith    The string versions of these are `KSPConvergedReasons`; if you change
6594d0a8057SBarry Smith    any of the values here also change them that array of names.
66086c02ca4SBarry Smith 
6611cc06b55SBarry Smith .seealso: [](ch_ksp), `KSP`, `KSPSolve()`, `KSPGetConvergedReason()`, `KSPSetTolerances()`, `KSPConvergedReasonView()`
66228ce4d24SBarry Smith E*/
663d15094e1SBarry Smith typedef enum { /* converged */
6649ecb1286SBarry Smith   KSP_CONVERGED_RTOL_NORMAL               = 1,
6659ecb1286SBarry Smith   KSP_CONVERGED_ATOL_NORMAL               = 9,
666d15094e1SBarry Smith   KSP_CONVERGED_RTOL                      = 2,
667d15094e1SBarry Smith   KSP_CONVERGED_ATOL                      = 3,
668b335793eSSatish Balay   KSP_CONVERGED_ITS                       = 4,
6694a221d59SStefano Zampini   KSP_CONVERGED_NEG_CURVE                 = 5,
6704a221d59SStefano Zampini   KSP_CONVERGED_CG_NEG_CURVE_DEPRECATED   = 5,
6714a221d59SStefano Zampini   KSP_CONVERGED_CG_CONSTRAINED_DEPRECATED = 6,
6724a221d59SStefano Zampini   KSP_CONVERGED_STEP_LENGTH               = 6,
6734a221d59SStefano Zampini   KSP_CONVERGED_HAPPY_BREAKDOWN           = 7,
674d15094e1SBarry Smith   /* diverged */
675b3cc6726SBarry Smith   KSP_DIVERGED_NULL                      = -2,
676d15094e1SBarry Smith   KSP_DIVERGED_ITS                       = -3,
677d15094e1SBarry Smith   KSP_DIVERGED_DTOL                      = -4,
678d15094e1SBarry Smith   KSP_DIVERGED_BREAKDOWN                 = -5,
679b4ac9ba4SBarry Smith   KSP_DIVERGED_BREAKDOWN_BICG            = -6,
680b4ac9ba4SBarry Smith   KSP_DIVERGED_NONSYMMETRIC              = -7,
681b4ac9ba4SBarry Smith   KSP_DIVERGED_INDEFINITE_PC             = -8,
6824d51c080SBarry Smith   KSP_DIVERGED_NANORINF                  = -9,
6836aee1118SBarry Smith   KSP_DIVERGED_INDEFINITE_MAT            = -10,
684c0decd05SBarry Smith   KSP_DIVERGED_PC_FAILED                 = -11,
685aa4d2078SSatish Balay   KSP_DIVERGED_PCSETUP_FAILED_DEPRECATED = -11,
686d15094e1SBarry Smith 
6879371c9d4SSatish Balay   KSP_CONVERGED_ITERATING = 0
6889371c9d4SSatish Balay } KSPConvergedReason;
689014dd563SJed Brown PETSC_EXTERN const char *const *KSPConvergedReasons;
690d15094e1SBarry Smith 
691c838673bSBarry Smith /*MC
69287497f52SBarry Smith      KSP_CONVERGED_RTOL - norm(r) <= rtol*norm(b) or rtol*norm(b - A*x_0) if `KSPConvergedDefaultSetUIRNorm()` was called
693c838673bSBarry Smith 
694c838673bSBarry Smith    Level: beginner
695c838673bSBarry Smith 
69695bd0b28SBarry Smith    Notes:
69787497f52SBarry Smith    See `KSPNormType` and `KSPSetNormType()` for possible norms that may be used. By default
698c838673bSBarry Smith    for left preconditioning it is the 2-norm of the preconditioned residual, and the
699c838673bSBarry Smith    2-norm of the residual for right preconditioning
700c838673bSBarry Smith 
70187497f52SBarry Smith    See also `KSP_CONVERGED_ATOL` which may apply before this tolerance.
702f9fed41fSBarry Smith 
7031cc06b55SBarry Smith .seealso: [](ch_ksp), `KSPNormType`, `KSP_CONVERGED_ATOL`, `KSP_DIVERGED_DTOL`, `KSPSolve()`, `KSPGetConvergedReason()`, `KSPConvergedReason`, `KSPSetTolerances()`
704c838673bSBarry Smith M*/
705c838673bSBarry Smith 
706c838673bSBarry Smith /*MC
707c838673bSBarry Smith      KSP_CONVERGED_ATOL - norm(r) <= atol
708c838673bSBarry Smith 
709c838673bSBarry Smith    Level: beginner
710c838673bSBarry Smith 
71195bd0b28SBarry Smith    Notes:
71287497f52SBarry Smith    See `KSPNormType` and `KSPSetNormType()` for possible norms that may be used. By default
713c838673bSBarry Smith        for left preconditioning it is the 2-norm of the preconditioned residual, and the
714c838673bSBarry Smith        2-norm of the residual for right preconditioning
715c838673bSBarry Smith 
71687497f52SBarry Smith    See also `KSP_CONVERGED_RTOL` which may apply before this tolerance.
717c838673bSBarry Smith 
7181cc06b55SBarry Smith .seealso: [](ch_ksp), `KSPNormType`, `KSP_CONVERGED_RTOL`, `KSP_DIVERGED_DTOL`, `KSPSolve()`, `KSPGetConvergedReason()`, `KSPConvergedReason`, `KSPSetTolerances()`
719c838673bSBarry Smith M*/
720c838673bSBarry Smith 
721c838673bSBarry Smith /*MC
722c838673bSBarry Smith      KSP_DIVERGED_DTOL - norm(r) >= dtol*norm(b)
723c838673bSBarry Smith 
724c838673bSBarry Smith    Level: beginner
725c838673bSBarry Smith 
72695bd0b28SBarry Smith    Note:
72787497f52SBarry Smith    See `KSPNormType` and `KSPSetNormType()` for possible norms that may be used. By default
728c838673bSBarry Smith        for left preconditioning it is the 2-norm of the preconditioned residual, and the
729c838673bSBarry Smith        2-norm of the residual for right preconditioning
730c838673bSBarry Smith 
7311cc06b55SBarry Smith .seealso: [](ch_ksp), `KSPNormType`, `KSP_CONVERGED_ATOL`, `KSP_DIVERGED_RTOL`, `KSPSolve()`, `KSPGetConvergedReason()`, `KSPConvergedReason`, `KSPSetTolerances()`
732c838673bSBarry Smith M*/
733c838673bSBarry Smith 
734c838673bSBarry Smith /*MC
735c838673bSBarry Smith      KSP_DIVERGED_ITS - Ran out of iterations before any convergence criteria was
736c838673bSBarry Smith       reached
737c838673bSBarry Smith 
738c838673bSBarry Smith    Level: beginner
739c838673bSBarry Smith 
7401cc06b55SBarry Smith .seealso: [](ch_ksp), `KSPSolve()`, `KSPGetConvergedReason()`, `KSPConvergedReason`, `KSPSetTolerances()`
741c838673bSBarry Smith M*/
742c838673bSBarry Smith 
743c838673bSBarry Smith /*MC
74487497f52SBarry Smith      KSP_CONVERGED_ITS - Used by the `KSPPREONLY` solver after the single iteration of
74587497f52SBarry Smith            the preconditioner is applied. Also used when the `KSPConvergedSkip()` convergence
7464d0a8057SBarry Smith            test routine is set in KSP.
747c838673bSBarry Smith 
748c838673bSBarry Smith    Level: beginner
749c838673bSBarry Smith 
7501cc06b55SBarry Smith .seealso: [](ch_ksp), `KSPSolve()`, `KSPGetConvergedReason()`, `KSPConvergedReason`, `KSPSetTolerances()`
751c838673bSBarry Smith M*/
752c838673bSBarry Smith 
753c838673bSBarry Smith /*MC
754c838673bSBarry Smith      KSP_DIVERGED_BREAKDOWN - A breakdown in the Krylov method was detected so the
7551de96524SPierre Jolivet           method could not continue to enlarge the Krylov space. Could be due to a singular matrix or
75687497f52SBarry Smith           preconditioner. In `KSPHPDDM`, this is also returned when some search directions within a block
7571de96524SPierre Jolivet           are colinear.
758c838673bSBarry Smith 
759c838673bSBarry Smith    Level: beginner
760c838673bSBarry Smith 
7611cc06b55SBarry Smith .seealso: [](ch_ksp), `KSPSolve()`, `KSPGetConvergedReason()`, `KSPConvergedReason`, `KSPSetTolerances()`
762c838673bSBarry Smith M*/
763c838673bSBarry Smith 
764c838673bSBarry Smith /*MC
76587497f52SBarry Smith      KSP_DIVERGED_BREAKDOWN_BICG - A breakdown in the `KSPBICG` method was detected so the
766c838673bSBarry Smith           method could not continue to enlarge the Krylov space.
767c838673bSBarry Smith 
768c838673bSBarry Smith    Level: beginner
769c838673bSBarry Smith 
7701cc06b55SBarry Smith .seealso: [](ch_ksp), `KSPSolve()`, `KSPGetConvergedReason()`, `KSPConvergedReason`, `KSPSetTolerances()`
771c838673bSBarry Smith M*/
772c838673bSBarry Smith 
773c838673bSBarry Smith /*MC
774c838673bSBarry Smith      KSP_DIVERGED_NONSYMMETRIC - It appears the operator or preconditioner is not
77587497f52SBarry Smith         symmetric and this Krylov method (`KSPCG`, `KSPMINRES`, `KSPCR`) requires symmetry
776c838673bSBarry Smith 
777c838673bSBarry Smith    Level: beginner
778c838673bSBarry Smith 
7791cc06b55SBarry Smith .seealso: [](ch_ksp), `KSPSolve()`, `KSPGetConvergedReason()`, `KSPConvergedReason`, `KSPSetTolerances()`
780c838673bSBarry Smith M*/
781c838673bSBarry Smith 
782c838673bSBarry Smith /*MC
783c838673bSBarry Smith      KSP_DIVERGED_INDEFINITE_PC - It appears the preconditioner is indefinite (has both
78487497f52SBarry Smith         positive and negative eigenvalues) and this Krylov method (`KSPCG`) requires it to
785c838673bSBarry Smith         be positive definite
786c838673bSBarry Smith 
787c838673bSBarry Smith    Level: beginner
788c838673bSBarry Smith 
78987497f52SBarry Smith      Note:
790a4d1885cSBarry Smith     This can happen with the `PCICC` preconditioner, use the options database option `-pc_factor_shift_positive_definite` to force
79187497f52SBarry Smith   the `PCICC` preconditioner to generate a positive definite preconditioner
792c838673bSBarry Smith 
7931cc06b55SBarry Smith .seealso: [](ch_ksp), `KSPSolve()`, `KSPGetConvergedReason()`, `KSPConvergedReason`, `KSPSetTolerances()`
794c838673bSBarry Smith M*/
795c838673bSBarry Smith 
796c838673bSBarry Smith /*MC
797c0decd05SBarry Smith      KSP_DIVERGED_PC_FAILED - It was not possible to build or use the requested preconditioner. This is usually due to a
7989fc87aa7SBarry Smith      zero pivot in a factorization. It can also result from a failure in a subpreconditioner inside a nested preconditioner
79987497f52SBarry Smith      such as `PCFIELDSPLIT`.
8009fc87aa7SBarry Smith 
8019fc87aa7SBarry Smith    Level: beginner
8029fc87aa7SBarry Smith 
803a4d1885cSBarry Smith     Note:
804a4d1885cSBarry Smith     Run with `-ksp_error_if_not_converged` to stop the program when the error is detected and print an error message with details.
8059fc87aa7SBarry Smith 
8061cc06b55SBarry Smith .seealso: [](ch_ksp), `KSPSolve()`, `KSPGetConvergedReason()`, `KSPConvergedReason`, `KSPSetTolerances()`
8079fc87aa7SBarry Smith M*/
8089fc87aa7SBarry Smith 
8099fc87aa7SBarry Smith /*MC
810a4d1885cSBarry Smith      KSP_CONVERGED_ITERATING - This flag is returned if `KSPGetConvergedReason()` is called
811a4d1885cSBarry Smith         while `KSPSolve()` is still running.
812c838673bSBarry Smith 
813c838673bSBarry Smith    Level: beginner
814c838673bSBarry Smith 
8151cc06b55SBarry Smith .seealso: [](ch_ksp), `KSPSolve()`, `KSPGetConvergedReason()`, `KSPConvergedReason`, `KSPSetTolerances()`
816c838673bSBarry Smith M*/
817c838673bSBarry Smith 
818014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSetConvergenceTest(KSP, PetscErrorCode (*)(KSP, PetscInt, PetscReal, KSPConvergedReason *, void *), void *, PetscErrorCode (*)(void *));
819df8705c3SBarry Smith PETSC_EXTERN PetscErrorCode KSPGetConvergenceTest(KSP, PetscErrorCode (**)(KSP, PetscInt, PetscReal, KSPConvergedReason *, void *), void **, PetscErrorCode (**)(void *));
820df8705c3SBarry Smith PETSC_EXTERN PetscErrorCode KSPGetAndClearConvergenceTest(KSP, PetscErrorCode (**)(KSP, PetscInt, PetscReal, KSPConvergedReason *, void *), void **, PetscErrorCode (**)(void *));
8213ec1f749SStefano Zampini PETSC_EXTERN PetscErrorCode KSPGetConvergenceContext(KSP, void *);
8228de4e6dcSJed Brown PETSC_EXTERN PetscErrorCode KSPConvergedDefault(KSP, PetscInt, PetscReal, KSPConvergedReason *, void *);
8233eeb4429SVaclav Hapla PETSC_EXTERN PetscErrorCode KSPLSQRConvergedDefault(KSP, PetscInt, PetscReal, KSPConvergedReason *, void *);
8248de4e6dcSJed Brown PETSC_EXTERN PetscErrorCode KSPConvergedDefaultDestroy(void *);
8258de4e6dcSJed Brown PETSC_EXTERN PetscErrorCode KSPConvergedDefaultCreate(void **);
8268de4e6dcSJed Brown PETSC_EXTERN PetscErrorCode KSPConvergedDefaultSetUIRNorm(KSP);
8278de4e6dcSJed Brown PETSC_EXTERN PetscErrorCode KSPConvergedDefaultSetUMIRNorm(KSP);
82854b05d9cSStefano Zampini PETSC_EXTERN PetscErrorCode KSPConvergedDefaultSetConvergedMaxits(KSP, PetscBool);
8290059c7bdSJed Brown PETSC_EXTERN PetscErrorCode KSPConvergedSkip(KSP, PetscInt, PetscReal, KSPConvergedReason *, void *);
830014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGetConvergedReason(KSP, KSPConvergedReason *);
831c4421ceaSFande Kong PETSC_EXTERN PetscErrorCode KSPGetConvergedReasonString(KSP, const char **);
83294a4d4ebSMatthew G. Knepley PETSC_EXTERN PetscErrorCode KSPComputeConvergenceRate(KSP, PetscReal *, PetscReal *, PetscReal *, PetscReal *);
8332a28d964SStefano Zampini PETSC_EXTERN PetscErrorCode KSPSetConvergedNegativeCurvature(KSP, PetscBool);
8342a28d964SStefano Zampini PETSC_EXTERN PetscErrorCode KSPGetConvergedNegativeCurvature(KSP, PetscBool *);
835abef13c0SSatish Balay 
836edd03b47SJacob Faibussowitsch PETSC_DEPRECATED_FUNCTION(3, 5, 0, "KSPConvergedDefault()", ) static inline void KSPDefaultConverged(void)
837d71ae5a4SJacob Faibussowitsch { /* never called */
8389371c9d4SSatish Balay }
8398ea1b3e6SJed Brown #define KSPDefaultConverged (KSPDefaultConverged, KSPConvergedDefault)
840edd03b47SJacob Faibussowitsch PETSC_DEPRECATED_FUNCTION(3, 5, 0, "KSPConvergedDefaultDestroy()", ) static inline void KSPDefaultConvergedDestroy(void)
841d71ae5a4SJacob Faibussowitsch { /* never called */
8429371c9d4SSatish Balay }
8438ea1b3e6SJed Brown #define KSPDefaultConvergedDestroy (KSPDefaultConvergedDestroy, KSPConvergedDefaultDestroy)
844edd03b47SJacob Faibussowitsch PETSC_DEPRECATED_FUNCTION(3, 5, 0, "KSPConvergedDefaultCreate()", ) static inline void KSPDefaultConvergedCreate(void)
845d71ae5a4SJacob Faibussowitsch { /* never called */
8469371c9d4SSatish Balay }
8478ea1b3e6SJed Brown #define KSPDefaultConvergedCreate (KSPDefaultConvergedCreate, KSPConvergedDefaultCreate)
848edd03b47SJacob Faibussowitsch PETSC_DEPRECATED_FUNCTION(3, 5, 0, "KSPConvergedDefaultSetUIRNorm()", ) static inline void KSPDefaultConvergedSetUIRNorm(void)
849d71ae5a4SJacob Faibussowitsch { /* never called */
8509371c9d4SSatish Balay }
8518ea1b3e6SJed Brown #define KSPDefaultConvergedSetUIRNorm (KSPDefaultConvergedSetUIRNorm, KSPConvergedDefaultSetUIRNorm)
852edd03b47SJacob Faibussowitsch PETSC_DEPRECATED_FUNCTION(3, 5, 0, "KSPConvergedDefaultSetUMIRNorm()", ) static inline void KSPDefaultConvergedSetUMIRNorm(void)
853d71ae5a4SJacob Faibussowitsch { /* never called */
8549371c9d4SSatish Balay }
8558ea1b3e6SJed Brown #define KSPDefaultConvergedSetUMIRNorm (KSPDefaultConvergedSetUMIRNorm, KSPConvergedDefaultSetUMIRNorm)
856edd03b47SJacob Faibussowitsch PETSC_DEPRECATED_FUNCTION(3, 5, 0, "KSPConvergedSkip()", ) static inline void KSPSkipConverged(void)
857d71ae5a4SJacob Faibussowitsch { /* never called */
8589371c9d4SSatish Balay }
8598ea1b3e6SJed Brown #define KSPSkipConverged (KSPSkipConverged, KSPConvergedSkip)
8608ea1b3e6SJed Brown 
8610bacdadaSStefano Zampini PETSC_EXTERN PetscErrorCode KSPComputeOperator(KSP, MatType, Mat *);
862edd03b47SJacob Faibussowitsch PETSC_DEPRECATED_FUNCTION(3, 12, 0, "KSPComputeOperator()", ) static inline PetscErrorCode KSPComputeExplicitOperator(KSP A, Mat *B)
863d71ae5a4SJacob Faibussowitsch {
864f22e26b7SPierre Jolivet   return KSPComputeOperator(A, PETSC_NULLPTR, B);
8659371c9d4SSatish Balay }
866d4fbbf0eSBarry Smith 
86728ce4d24SBarry Smith /*E
868a4d1885cSBarry Smith     KSPCGType - Determines what type of `KSPCG` to use
86928ce4d24SBarry Smith 
870a4d1885cSBarry Smith    Values:
871a4d1885cSBarry Smith  + `KSP_CG_SYMMETRIC` - the matrix is complex symmetric
872a4d1885cSBarry Smith  - `KSP_CG_HERMITIAN` - the matrix is complex Hermitian
873a4d1885cSBarry Smith 
87416a05f60SBarry Smith    Level: beginner
87516a05f60SBarry Smith 
8761cc06b55SBarry Smith .seealso: [](ch_ksp), `KSPCG`, `KSP`, `KSPCGSetType()`
87728ce4d24SBarry Smith E*/
8789371c9d4SSatish Balay typedef enum {
8799371c9d4SSatish Balay   KSP_CG_SYMMETRIC = 0,
8809371c9d4SSatish Balay   KSP_CG_HERMITIAN = 1
8819371c9d4SSatish Balay } KSPCGType;
8826a6fc655SJed Brown PETSC_EXTERN const char *const KSPCGTypes[];
88328ce4d24SBarry Smith 
884014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPCGSetType(KSP, KSPCGType);
885014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPCGUseSingleReduction(KSP, PetscBool);
8868031f4adStmunson 
887dad1adc6STodd Munson PETSC_EXTERN PetscErrorCode KSPCGSetRadius(KSP, PetscReal);
888fb01098fSStefano Zampini PETSC_EXTERN PetscErrorCode KSPCGSetObjectiveTarget(KSP, PetscReal);
889dad1adc6STodd Munson PETSC_EXTERN PetscErrorCode KSPCGGetNormD(KSP, PetscReal *);
890dad1adc6STodd Munson PETSC_EXTERN PetscErrorCode KSPCGGetObjFcn(KSP, PetscReal *);
891fcae7a14Stmunson 
89205de396fSBarry Smith PETSC_EXTERN PetscErrorCode KSPGLTRGetMinEig(KSP, PetscReal *);
89305de396fSBarry Smith PETSC_EXTERN PetscErrorCode KSPGLTRGetLambda(KSP, PetscReal *);
894edd03b47SJacob Faibussowitsch PETSC_DEPRECATED_FUNCTION(3, 12, 0, "KSPGLTRGetMinEig()", ) static inline PetscErrorCode KSPCGGLTRGetMinEig(KSP ksp, PetscReal *x)
895d71ae5a4SJacob Faibussowitsch {
8969371c9d4SSatish Balay   return KSPGLTRGetMinEig(ksp, x);
8979371c9d4SSatish Balay }
898edd03b47SJacob Faibussowitsch PETSC_DEPRECATED_FUNCTION(3, 12, 0, "KSPGLTRGetLambda()", ) static inline PetscErrorCode KSPCGGLTRGetLambda(KSP ksp, PetscReal *x)
899d71ae5a4SJacob Faibussowitsch {
9009371c9d4SSatish Balay   return KSPGLTRGetLambda(ksp, x);
9019371c9d4SSatish Balay }
9028031f4adStmunson 
903014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPPythonSetType(KSP, const char[]);
904ebead697SStefano Zampini PETSC_EXTERN PetscErrorCode KSPPythonGetType(KSP, const char *[]);
9051d6018f0SLisandro Dalcin 
906f560b561SHong Zhang PETSC_EXTERN PetscErrorCode PCSetPreSolve(PC, PetscErrorCode (*)(PC, KSP));
907014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCPreSolve(PC, KSP);
908014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCPostSolve(PC, KSP);
9093369ce9aSBarry Smith 
9109804daf3SBarry Smith #include <petscdrawtypes.h>
911014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPMonitorLGRange(KSP, PetscInt, PetscReal, void *);
9122f2e5d10SKris Buschelman 
913014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCShellSetPreSolve(PC, PetscErrorCode (*)(PC, KSP, Vec, Vec));
914014dd563SJed Brown PETSC_EXTERN PetscErrorCode PCShellSetPostSolve(PC, PetscErrorCode (*)(PC, KSP, Vec, Vec));
91503919abeSBarry Smith 
916ba36735cSStefano Zampini /*S
917a4d1885cSBarry Smith      KSPGuess - Abstract PETSc object that manages all initial guess generation methods for Krylov methods.
918f8a50e2bSBarry Smith 
919a4d1885cSBarry Smith    Level: intermediate
920f8a50e2bSBarry Smith 
9211cc06b55SBarry Smith .seealso: [](ch_ksp), `KSPCreate()`, `KSPSetGuessType()`, `KSPGuessType`
922ba36735cSStefano Zampini S*/
923ba36735cSStefano Zampini typedef struct _p_KSPGuess *KSPGuess;
92416a05f60SBarry Smith 
925ba36735cSStefano Zampini /*J
92687497f52SBarry Smith     KSPGuessType - String with the name of a PETSc initial guess approach for Krylov methods.
927ba36735cSStefano Zampini 
928a4d1885cSBarry Smith    Values:
929a4d1885cSBarry Smith  + `KSPGUESSFISCHER` - methodology developed by Paul Fischer
930a4d1885cSBarry Smith  - `KSPGUESSPOD` - methodology based on proper orthogonal decomposition
931a4d1885cSBarry Smith 
93216a05f60SBarry Smith    Level: intermediate
93316a05f60SBarry Smith 
9341cc06b55SBarry Smith .seealso: [](ch_ksp), `KSP`, `KSPGuess`
935ba36735cSStefano Zampini J*/
936ba36735cSStefano Zampini typedef const char *KSPGuessType;
937ba36735cSStefano Zampini #define KSPGUESSFISCHER "fischer"
938ba36735cSStefano Zampini #define KSPGUESSPOD     "pod"
939a4d1885cSBarry Smith 
9401d36bdfdSBarry Smith PETSC_EXTERN PetscErrorCode KSPGuessRegister(const char[], PetscErrorCode (*)(KSPGuess));
941ba36735cSStefano Zampini PETSC_EXTERN PetscErrorCode KSPSetGuess(KSP, KSPGuess);
942ba36735cSStefano Zampini PETSC_EXTERN PetscErrorCode KSPGetGuess(KSP, KSPGuess *);
943ba36735cSStefano Zampini PETSC_EXTERN PetscErrorCode KSPGuessView(KSPGuess, PetscViewer);
944ba36735cSStefano Zampini PETSC_EXTERN PetscErrorCode KSPGuessDestroy(KSPGuess *);
945ba36735cSStefano Zampini PETSC_EXTERN PetscErrorCode KSPGuessCreate(MPI_Comm, KSPGuess *);
946ba36735cSStefano Zampini PETSC_EXTERN PetscErrorCode KSPGuessSetType(KSPGuess, KSPGuessType);
947ba36735cSStefano Zampini PETSC_EXTERN PetscErrorCode KSPGuessGetType(KSPGuess, KSPGuessType *);
9488410009bSDavid Wells PETSC_EXTERN PetscErrorCode KSPGuessSetTolerance(KSPGuess, PetscReal);
949ba36735cSStefano Zampini PETSC_EXTERN PetscErrorCode KSPGuessSetUp(KSPGuess);
950ba36735cSStefano Zampini PETSC_EXTERN PetscErrorCode KSPGuessUpdate(KSPGuess, Vec, Vec);
951ba36735cSStefano Zampini PETSC_EXTERN PetscErrorCode KSPGuessFormGuess(KSPGuess, Vec, Vec);
952ba36735cSStefano Zampini PETSC_EXTERN PetscErrorCode KSPGuessSetFromOptions(KSPGuess);
953ba36735cSStefano Zampini PETSC_EXTERN PetscErrorCode KSPGuessFischerSetModel(KSPGuess, PetscInt, PetscInt);
954014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSetUseFischerGuess(KSP, PetscInt, PetscInt);
955ba36735cSStefano Zampini PETSC_EXTERN PetscErrorCode KSPSetInitialGuessKnoll(KSP, PetscBool);
956ba36735cSStefano Zampini PETSC_EXTERN PetscErrorCode KSPGetInitialGuessKnoll(KSP, PetscBool *);
957f8a50e2bSBarry Smith 
958470b340bSDmitry Karpeev /*E
959470b340bSDmitry Karpeev     MatSchurComplementAinvType - Determines how to approximate the inverse of the (0,0) block in Schur complement preconditioning matrix assembly routines
960470b340bSDmitry Karpeev 
961470b340bSDmitry Karpeev     Level: intermediate
962470b340bSDmitry Karpeev 
963a4d1885cSBarry Smith .seealso: `MatSchurComplementGetAinvType()`, `MatSchurComplementSetAinvType()`, `MatSchurComplementGetPmat()`, `MatGetSchurComplement()`,
964a4d1885cSBarry Smith           `MatCreateSchurComplementPmat()`
965470b340bSDmitry Karpeev E*/
9669371c9d4SSatish Balay typedef enum {
9679371c9d4SSatish Balay   MAT_SCHUR_COMPLEMENT_AINV_DIAG,
9689371c9d4SSatish Balay   MAT_SCHUR_COMPLEMENT_AINV_LUMP,
9699371c9d4SSatish Balay   MAT_SCHUR_COMPLEMENT_AINV_BLOCK_DIAG,
9709371c9d4SSatish Balay   MAT_SCHUR_COMPLEMENT_AINV_FULL
9719371c9d4SSatish Balay } MatSchurComplementAinvType;
972470b340bSDmitry Karpeev PETSC_EXTERN const char *const MatSchurComplementAinvTypes[];
973470b340bSDmitry Karpeev 
974014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatCreateSchurComplement(Mat, Mat, Mat, Mat, Mat, Mat *);
975014dd563SJed Brown PETSC_EXTERN PetscErrorCode MatSchurComplementGetKSP(Mat, KSP *);
976d2768c1eSMatthew G Knepley PETSC_EXTERN PetscErrorCode MatSchurComplementSetKSP(Mat, KSP);
977bee83525SDmitry Karpeev PETSC_EXTERN PetscErrorCode MatSchurComplementSetSubMatrices(Mat, Mat, Mat, Mat, Mat, Mat);
978aa6c7ce3SBarry Smith PETSC_EXTERN PetscErrorCode MatSchurComplementUpdateSubMatrices(Mat, Mat, Mat, Mat, Mat, Mat);
979bee83525SDmitry Karpeev PETSC_EXTERN PetscErrorCode MatSchurComplementGetSubMatrices(Mat, Mat *, Mat *, Mat *, Mat *, Mat *);
980470b340bSDmitry Karpeev PETSC_EXTERN PetscErrorCode MatSchurComplementSetAinvType(Mat, MatSchurComplementAinvType);
981470b340bSDmitry Karpeev PETSC_EXTERN PetscErrorCode MatSchurComplementGetAinvType(Mat, MatSchurComplementAinvType *);
9825bf40c1dSDmitry Karpeev PETSC_EXTERN PetscErrorCode MatSchurComplementGetPmat(Mat, MatReuse, Mat *);
9835a1c817aSMatthew G. Knepley PETSC_EXTERN PetscErrorCode MatSchurComplementComputeExplicitOperator(Mat, Mat *);
984470b340bSDmitry Karpeev PETSC_EXTERN PetscErrorCode MatGetSchurComplement(Mat, IS, IS, IS, IS, MatReuse, Mat *, MatSchurComplementAinvType, MatReuse, Mat *);
985470b340bSDmitry Karpeev PETSC_EXTERN PetscErrorCode MatCreateSchurComplementPmat(Mat, Mat, Mat, Mat, MatSchurComplementAinvType, MatReuse, Mat *);
9863f22127dSBarry Smith 
98778e4361aSAlp Dener PETSC_EXTERN PetscErrorCode MatCreateLMVMDFP(MPI_Comm, PetscInt, PetscInt, Mat *);
98878e4361aSAlp Dener PETSC_EXTERN PetscErrorCode MatCreateLMVMBFGS(MPI_Comm, PetscInt, PetscInt, Mat *);
98978e4361aSAlp Dener PETSC_EXTERN PetscErrorCode MatCreateLMVMSR1(MPI_Comm, PetscInt, PetscInt, Mat *);
990864588a7SAlp Dener PETSC_EXTERN PetscErrorCode MatCreateLMVMBroyden(MPI_Comm, PetscInt, PetscInt, Mat *);
991864588a7SAlp Dener PETSC_EXTERN PetscErrorCode MatCreateLMVMBadBroyden(MPI_Comm, PetscInt, PetscInt, Mat *);
992864588a7SAlp Dener PETSC_EXTERN PetscErrorCode MatCreateLMVMSymBroyden(MPI_Comm, PetscInt, PetscInt, Mat *);
993864588a7SAlp Dener PETSC_EXTERN PetscErrorCode MatCreateLMVMSymBadBroyden(MPI_Comm, PetscInt, PetscInt, Mat *);
994864588a7SAlp Dener PETSC_EXTERN PetscErrorCode MatCreateLMVMDiagBroyden(MPI_Comm, PetscInt, PetscInt, Mat *);
995cd929ea3SAlp Dener 
996cd929ea3SAlp Dener PETSC_EXTERN PetscErrorCode MatLMVMUpdate(Mat, Vec, Vec);
997b2d8c577SAlp Dener PETSC_EXTERN PetscErrorCode MatLMVMIsAllocated(Mat, PetscBool *);
998cd929ea3SAlp Dener PETSC_EXTERN PetscErrorCode MatLMVMAllocate(Mat, Vec, Vec);
999cd929ea3SAlp Dener PETSC_EXTERN PetscErrorCode MatLMVMReset(Mat, PetscBool);
1000e0ed867bSAlp Dener PETSC_EXTERN PetscErrorCode MatLMVMResetShift(Mat);
10010ad3a497SAlp Dener PETSC_EXTERN PetscErrorCode MatLMVMClearJ0(Mat);
1002cd929ea3SAlp Dener PETSC_EXTERN PetscErrorCode MatLMVMSetJ0(Mat, Mat);
1003cd929ea3SAlp Dener PETSC_EXTERN PetscErrorCode MatLMVMSetJ0Scale(Mat, PetscReal);
1004cd929ea3SAlp Dener PETSC_EXTERN PetscErrorCode MatLMVMSetJ0Diag(Mat, Vec);
1005cd929ea3SAlp Dener PETSC_EXTERN PetscErrorCode MatLMVMSetJ0PC(Mat, PC);
1006cd929ea3SAlp Dener PETSC_EXTERN PetscErrorCode MatLMVMSetJ0KSP(Mat, KSP);
10072d5e3849SAlp Dener PETSC_EXTERN PetscErrorCode MatLMVMApplyJ0Fwd(Mat, Vec, Vec);
1008cd929ea3SAlp Dener PETSC_EXTERN PetscErrorCode MatLMVMApplyJ0Inv(Mat, Vec, Vec);
1009cd929ea3SAlp Dener PETSC_EXTERN PetscErrorCode MatLMVMGetJ0(Mat, Mat *);
1010cd929ea3SAlp Dener PETSC_EXTERN PetscErrorCode MatLMVMGetJ0PC(Mat, PC *);
1011cd929ea3SAlp Dener PETSC_EXTERN PetscErrorCode MatLMVMGetJ0KSP(Mat, KSP *);
101292f76d53SAlp Dener PETSC_EXTERN PetscErrorCode MatLMVMSetHistorySize(Mat, PetscInt);
1013cd929ea3SAlp Dener PETSC_EXTERN PetscErrorCode MatLMVMGetUpdateCount(Mat, PetscInt *);
1014cd929ea3SAlp Dener PETSC_EXTERN PetscErrorCode MatLMVMGetRejectCount(Mat, PetscInt *);
1015864588a7SAlp Dener PETSC_EXTERN PetscErrorCode MatLMVMSymBroydenSetDelta(Mat, PetscScalar);
1016*e96a0efeSStefano Zampini 
1017*e96a0efeSStefano Zampini typedef enum {
1018*e96a0efeSStefano Zampini   MAT_LMVM_SYMBROYDEN_SCALE_NONE     = 0,
1019*e96a0efeSStefano Zampini   MAT_LMVM_SYMBROYDEN_SCALE_SCALAR   = 1,
1020*e96a0efeSStefano Zampini   MAT_LMVM_SYMBROYDEN_SCALE_DIAGONAL = 2,
1021*e96a0efeSStefano Zampini   MAT_LMVM_SYMBROYDEN_SCALE_USER     = 3
1022*e96a0efeSStefano Zampini } MatLMVMSymBroydenScaleType;
1023*e96a0efeSStefano Zampini PETSC_EXTERN const char *const MatLMVMSymBroydenScaleTypes[];
1024*e96a0efeSStefano Zampini 
1025864588a7SAlp Dener PETSC_EXTERN PetscErrorCode MatLMVMSymBroydenSetScaleType(Mat, MatLMVMSymBroydenScaleType);
1026cd929ea3SAlp Dener 
1027014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSetDM(KSP, DM);
1028014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSetDMActive(KSP, PetscBool);
1029014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGetDM(KSP, DM *);
1030014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPSetApplicationContext(KSP, void *);
1031014dd563SJed Brown PETSC_EXTERN PetscErrorCode KSPGetApplicationContext(KSP, void *);
1032fbd07b44SBarry Smith PETSC_EXTERN PetscErrorCode KSPSetComputeRHS(KSP, PetscErrorCode (*func)(KSP, Vec, void *), void *);
103323ee1639SBarry Smith PETSC_EXTERN PetscErrorCode KSPSetComputeOperators(KSP, PetscErrorCode (*)(KSP, Mat, Mat, void *), void *);
1034fbd07b44SBarry Smith PETSC_EXTERN PetscErrorCode KSPSetComputeInitialGuess(KSP, PetscErrorCode (*)(KSP, Vec, void *), void *);
103523ee1639SBarry Smith PETSC_EXTERN PetscErrorCode DMKSPSetComputeOperators(DM, PetscErrorCode (*)(KSP, Mat, Mat, void *), void *);
103623ee1639SBarry Smith PETSC_EXTERN PetscErrorCode DMKSPGetComputeOperators(DM, PetscErrorCode (**)(KSP, Mat, Mat, void *), void *);
1037014dd563SJed Brown PETSC_EXTERN PetscErrorCode DMKSPSetComputeRHS(DM, PetscErrorCode (*)(KSP, Vec, void *), void *);
1038014dd563SJed Brown PETSC_EXTERN PetscErrorCode DMKSPGetComputeRHS(DM, PetscErrorCode (**)(KSP, Vec, void *), void *);
1039fbd07b44SBarry Smith PETSC_EXTERN PetscErrorCode DMKSPSetComputeInitialGuess(DM, PetscErrorCode (*)(KSP, Vec, void *), void *);
1040fbd07b44SBarry Smith PETSC_EXTERN PetscErrorCode DMKSPGetComputeInitialGuess(DM, PetscErrorCode (**)(KSP, Vec, void *), void *);
10416c699258SBarry Smith 
104202b02e71SToby Isaac PETSC_EXTERN PetscErrorCode DMGlobalToLocalSolve(DM, Vec, Vec);
10439371c9d4SSatish Balay PETSC_EXTERN PetscErrorCode DMProjectField(DM, PetscReal, Vec, void (**)(PetscInt, PetscInt, PetscInt, const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], PetscReal, const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[]), InsertMode, Vec);
10444c55a7a0SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMSwarmProjectFields(DM, PetscInt, const char **, Vec[], ScatterMode mode);
1045557cf195SMatthew G. Knepley 
10462b3cbbdaSStefano Zampini PETSC_EXTERN PetscErrorCode DMAdaptInterpolator(DM, DM, Mat, KSP, Mat, Mat, Mat *, void *);
10472b3cbbdaSStefano Zampini PETSC_EXTERN PetscErrorCode DMCheckInterpolator(DM, Mat, Mat, Mat, PetscReal);
10484bf303faSJacob Faibussowitsch 
10494bf303faSJacob Faibussowitsch PETSC_EXTERN PetscErrorCode PCBJKOKKOSSetKSP(PC, KSP);
10504bf303faSJacob Faibussowitsch PETSC_EXTERN PetscErrorCode PCBJKOKKOSGetKSP(PC, KSP *);
1051