Actual source code: petscksp.h
1: /*
2: Defines the interface functions for the Krylov subspace accelerators.
3: */
4: #pragma once
6: #include <petscpc.h>
8: /* SUBMANSEC = KSP */
10: PETSC_EXTERN PetscErrorCode KSPInitializePackage(void);
11: PETSC_EXTERN PetscErrorCode KSPFinalizePackage(void);
13: /*S
14: KSP - Abstract PETSc object that manages the linear solves in PETSc (even those such as direct factorization-based solvers that
15: do not use Krylov accelerators).
17: Level: beginner
19: Notes:
20: When a direct solver is used, but no Krylov solver is used, the `KSP` object is still used but with a
21: `KSPType` of `KSPPREONLY` (or equivalently `KSPNONE`), meaning that only application of the preconditioner is used as the linear solver.
23: Use `KSPSetType()` or the options database key `-ksp_type` to set the specific Krylov solver algorithm to use with a given `KSP` object
25: The `PC` object is used to control preconditioners in PETSc.
27: `KSP` can also be used to solve some least squares problems (over or under-determined linear systems), using, for example, `KSPLSQR`, see `PETSCREGRESSORLINEAR`
28: for additional methods that can be used to solve least squares problems and other linear regressions).
30: .seealso: [](doc_linsolve), [](ch_ksp), `KSPCreate()`, `KSPSetType()`, `KSPType`, `SNES`, `TS`, `PC`, `KSP`, `KSPDestroy()`, `KSPCG`, `KSPGMRES`
31: S*/
32: typedef struct _p_KSP *KSP;
34: /*J
35: KSPType - String with the name of a PETSc Krylov method. These are all the Krylov solvers that PETSc provides.
37: Level: beginner
39: .seealso: [](doc_linsolve), [](ch_ksp), `KSPSetType()`, `KSP`, `KSPRegister()`, `KSPCreate()`, `KSPSetFromOptions()`
40: J*/
41: typedef const char *KSPType;
42: #define KSPRICHARDSON "richardson"
43: #define KSPCHEBYSHEV "chebyshev"
44: #define KSPCG "cg"
45: #define KSPGROPPCG "groppcg"
46: #define KSPPIPECG "pipecg"
47: #define KSPPIPECGRR "pipecgrr"
48: #define KSPPIPELCG "pipelcg"
49: #define KSPPIPEPRCG "pipeprcg"
50: #define KSPPIPECG2 "pipecg2"
51: #define KSPCGNE "cgne"
52: #define KSPNASH "nash"
53: #define KSPSTCG "stcg"
54: #define KSPGLTR "gltr"
55: #define KSPCGNASH PETSC_DEPRECATED_MACRO(3, 11, 0, "KSPNASH", ) "nash"
56: #define KSPCGSTCG PETSC_DEPRECATED_MACRO(3, 11, 0, "KSPSTCG", ) "stcg"
57: #define KSPCGGLTR PETSC_DEPRECATED_MACRO(3, 11, 0, "KSPSGLTR", ) "gltr"
58: #define KSPFCG "fcg"
59: #define KSPPIPEFCG "pipefcg"
60: #define KSPGMRES "gmres"
61: #define KSPPIPEFGMRES "pipefgmres"
62: #define KSPFGMRES "fgmres"
63: #define KSPLGMRES "lgmres"
64: #define KSPDGMRES "dgmres"
65: #define KSPPGMRES "pgmres"
66: #define KSPTCQMR "tcqmr"
67: #define KSPBCGS "bcgs"
68: #define KSPIBCGS "ibcgs"
69: #define KSPQMRCGS "qmrcgs"
70: #define KSPFBCGS "fbcgs"
71: #define KSPFBCGSR "fbcgsr"
72: #define KSPBCGSL "bcgsl"
73: #define KSPPIPEBCGS "pipebcgs"
74: #define KSPCGS "cgs"
75: #define KSPTFQMR "tfqmr"
76: #define KSPCR "cr"
77: #define KSPPIPECR "pipecr"
78: #define KSPLSQR "lsqr"
79: #define KSPPREONLY "preonly"
80: #define KSPNONE "none"
81: #define KSPQCG "qcg"
82: #define KSPBICG "bicg"
83: #define KSPMINRES "minres"
84: #define KSPSYMMLQ "symmlq"
85: #define KSPLCD "lcd"
86: #define KSPPYTHON "python"
87: #define KSPGCR "gcr"
88: #define KSPPIPEGCR "pipegcr"
89: #define KSPTSIRM "tsirm"
90: #define KSPCGLS "cgls"
91: #define KSPFETIDP "fetidp"
92: #define KSPHPDDM "hpddm"
93: #define KSPIDR "idr"
95: /* Logging support */
96: PETSC_EXTERN PetscClassId KSP_CLASSID;
97: PETSC_EXTERN PetscClassId KSPGUESS_CLASSID;
98: PETSC_EXTERN PetscClassId DMKSP_CLASSID;
100: PETSC_EXTERN PetscErrorCode KSPCreate(MPI_Comm, KSP *);
101: PETSC_EXTERN PetscErrorCode KSPSetType(KSP, KSPType);
102: PETSC_EXTERN PetscErrorCode KSPGetType(KSP, KSPType *);
103: PETSC_EXTERN PetscErrorCode KSPSetUp(KSP);
104: PETSC_EXTERN PetscErrorCode KSPSetUpOnBlocks(KSP);
105: PETSC_EXTERN PetscErrorCode KSPSolve(KSP, Vec, Vec);
106: PETSC_EXTERN PetscErrorCode KSPSolveTranspose(KSP, Vec, Vec);
107: PETSC_EXTERN PetscErrorCode KSPSetUseExplicitTranspose(KSP, PetscBool);
108: PETSC_EXTERN PetscErrorCode KSPMatSolve(KSP, Mat, Mat);
109: PETSC_EXTERN PetscErrorCode KSPMatSolveTranspose(KSP, Mat, Mat);
110: PETSC_EXTERN PetscErrorCode KSPSetMatSolveBatchSize(KSP, PetscInt);
111: PETSC_DEPRECATED_FUNCTION(3, 15, 0, "KSPSetMatSolveBatchSize()", ) static inline PetscErrorCode KSPSetMatSolveBlockSize(KSP ksp, PetscInt n)
112: {
113: return KSPSetMatSolveBatchSize(ksp, n);
114: }
115: PETSC_EXTERN PetscErrorCode KSPGetMatSolveBatchSize(KSP, PetscInt *);
116: PETSC_DEPRECATED_FUNCTION(3, 15, 0, "KSPGetMatSolveBatchSize()", ) static inline PetscErrorCode KSPGetMatSolveBlockSize(KSP ksp, PetscInt *n)
117: {
118: return KSPGetMatSolveBatchSize(ksp, n);
119: }
120: PETSC_EXTERN PetscErrorCode KSPReset(KSP);
121: PETSC_EXTERN PetscErrorCode KSPResetViewers(KSP);
122: PETSC_EXTERN PetscErrorCode KSPDestroy(KSP *);
123: PETSC_EXTERN PetscErrorCode KSPSetReusePreconditioner(KSP, PetscBool);
124: PETSC_EXTERN PetscErrorCode KSPGetReusePreconditioner(KSP, PetscBool *);
125: PETSC_EXTERN PetscErrorCode KSPSetSkipPCSetFromOptions(KSP, PetscBool);
126: PETSC_EXTERN PetscErrorCode KSPCheckSolve(KSP, PC, Vec);
128: PETSC_EXTERN PetscFunctionList KSPList;
129: PETSC_EXTERN PetscFunctionList KSPGuessList;
130: PETSC_EXTERN PetscFunctionList KSPMonitorList;
131: PETSC_EXTERN PetscFunctionList KSPMonitorCreateList;
132: PETSC_EXTERN PetscFunctionList KSPMonitorDestroyList;
133: PETSC_EXTERN PetscErrorCode KSPRegister(const char[], PetscErrorCode (*)(KSP));
135: /*S
136: KSPMonitorRegisterFn - A function prototype for functions provided to `KSPMonitorRegister()`
138: Calling Sequence:
139: + ksp - iterative solver obtained from `KSPCreate()`
140: . it - iteration number
141: . rnorm - (estimated) 2-norm of (preconditioned) residual
142: - ctx - `PetscViewerAndFormat` object
144: Level: beginner
146: Note:
147: This is a `KSPMonitorFn` specialized for a context of `PetscViewerAndFormat`
149: .seealso: [](ch_snes), `KSP`, `KSPMonitorSet()`, `KSPMonitorRegister()`, `KSPMonitorFn`, `KSPMonitorRegisterCreateFn`, `KSPMonitorRegisterDestroyFn`
150: S*/
151: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode KSPMonitorRegisterFn(KSP ksp, PetscInt it, PetscReal rnorm, PetscViewerAndFormat *ctx);
153: /*S
154: KSPMonitorRegisterCreateFn - A function prototype for functions that do the creation when provided to `KSPMonitorRegister()`
156: Calling Sequence:
157: + viewer - the viewer to be used with the `KSPMonitorRegisterFn`
158: . format - the format of the viewer
159: . ctx - a context for the monitor
160: - result - a `PetscViewerAndFormat` object
162: Level: beginner
164: .seealso: [](ch_snes), `KSPMonitorRegisterFn`, `KSP`, `KSPMonitorSet()`, `KSPMonitorRegister()`, `KSPMonitorFn`, `KSPMonitorRegisterDestroyFn`
165: S*/
166: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode KSPMonitorRegisterCreateFn(PetscViewer viewer, PetscViewerFormat format, PetscCtx ctx, PetscViewerAndFormat **result);
168: /*S
169: KSPMonitorRegisterDestroyFn - A function prototype for functions that do the after use destruction when provided to `KSPMonitorRegister()`
171: Calling Sequence:
172: . vf - a `PetscViewerAndFormat` object to be destroyed, including any context
174: Level: beginner
176: .seealso: [](ch_snes), `KSPMonitorRegisterFn`, `KSP`, `KSPMonitorSet()`, `KSPMonitorRegister()`, `KSPMonitorFn`, `KSPMonitorRegisterCreateFn`
177: S*/
178: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode KSPMonitorRegisterDestroyFn(PetscViewerAndFormat **result);
180: PETSC_EXTERN PetscErrorCode KSPMonitorRegister(const char[], PetscViewerType, PetscViewerFormat, KSPMonitorRegisterFn *, KSPMonitorRegisterCreateFn *, KSPMonitorRegisterDestroyFn *);
182: PETSC_EXTERN PetscErrorCode KSPSetPCSide(KSP, PCSide);
183: PETSC_EXTERN PetscErrorCode KSPGetPCSide(KSP, PCSide *);
184: PETSC_EXTERN PetscErrorCode KSPSetTolerances(KSP, PetscReal, PetscReal, PetscReal, PetscInt);
185: PETSC_EXTERN PetscErrorCode KSPGetTolerances(KSP, PetscReal *, PetscReal *, PetscReal *, PetscInt *);
186: PETSC_EXTERN PetscErrorCode KSPSetMinimumIterations(KSP, PetscInt);
187: PETSC_EXTERN PetscErrorCode KSPGetMinimumIterations(KSP, PetscInt *);
188: PETSC_EXTERN PetscErrorCode KSPSetInitialGuessNonzero(KSP, PetscBool);
189: PETSC_EXTERN PetscErrorCode KSPGetInitialGuessNonzero(KSP, PetscBool *);
190: PETSC_EXTERN PetscErrorCode KSPSetErrorIfNotConverged(KSP, PetscBool);
191: PETSC_EXTERN PetscErrorCode KSPGetErrorIfNotConverged(KSP, PetscBool *);
192: PETSC_EXTERN PetscErrorCode KSPSetComputeEigenvalues(KSP, PetscBool);
193: PETSC_EXTERN PetscErrorCode KSPSetComputeRitz(KSP, PetscBool);
194: PETSC_EXTERN PetscErrorCode KSPGetComputeEigenvalues(KSP, PetscBool *);
195: PETSC_EXTERN PetscErrorCode KSPSetComputeSingularValues(KSP, PetscBool);
196: PETSC_EXTERN PetscErrorCode KSPGetComputeSingularValues(KSP, PetscBool *);
197: PETSC_EXTERN PetscErrorCode KSPGetRhs(KSP, Vec *);
198: PETSC_EXTERN PetscErrorCode KSPGetSolution(KSP, Vec *);
199: PETSC_EXTERN PetscErrorCode KSPGetResidualNorm(KSP, PetscReal *);
200: PETSC_EXTERN PetscErrorCode KSPGetIterationNumber(KSP, PetscInt *);
201: PETSC_EXTERN PetscErrorCode KSPGetTotalIterations(KSP, PetscInt *);
202: PETSC_EXTERN PetscErrorCode KSPCreateVecs(KSP, PetscInt, Vec **, PetscInt, Vec **);
203: PETSC_DEPRECATED_FUNCTION(3, 6, 0, "KSPCreateVecs()", ) static inline PetscErrorCode KSPGetVecs(KSP ksp, PetscInt n, Vec **x, PetscInt m, Vec **y)
204: {
205: return KSPCreateVecs(ksp, n, x, m, y);
206: }
208: /*S
209: KSPPSolveFn - A function prototype for functions provided to `KSPSetPreSolve()` and `KSPSetPostSolve()`
211: Calling Sequence:
212: + ksp - the `KSP` context
213: . rhs - the right-hand side vector
214: . x - the solution vector
215: - ctx - optional context that was provided with `KSPSetPreSolve()` or `KSPSetPostSolve()`
217: Level: intermediate
219: .seealso: [](ch_snes), `KSP`, `KSPSetPreSolve()`, `KSPSetPostSolve()`, `PCShellPSolveFn`
220: S*/
221: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode KSPPSolveFn(KSP ksp, Vec rhs, Vec x, PetscCtx ctx);
223: PETSC_EXTERN PetscErrorCode KSPSetPreSolve(KSP, KSPPSolveFn *, PetscCtx);
224: PETSC_EXTERN PetscErrorCode KSPSetPostSolve(KSP, KSPPSolveFn *, PetscCtx);
225: PETSC_EXTERN PetscErrorCode KSPPreSolve(KSP, Vec, Vec);
226: PETSC_EXTERN PetscErrorCode KSPPostSolve(KSP, Vec, Vec);
228: PETSC_EXTERN PetscErrorCode KSPSetPC(KSP, PC);
229: PETSC_EXTERN PetscErrorCode KSPGetPC(KSP, PC *);
230: PETSC_EXTERN PetscErrorCode KSPSetNestLevel(KSP, PetscInt);
231: PETSC_EXTERN PetscErrorCode KSPGetNestLevel(KSP, PetscInt *);
233: /*S
234: KSPMonitorFn - A function prototype for functions provided to `KSPMonitorSet()`
236: Calling Sequence:
237: + ksp - iterative solver obtained from `KSPCreate()`
238: . it - iteration number
239: . rnorm - (estimated) 2-norm of (preconditioned) residual
240: - ctx - optional monitoring context, as provided with `KSPMonitorSet()`
242: Level: beginner
244: .seealso: [](ch_snes), `KSP`, `KSPMonitorSet()`
245: S*/
246: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode KSPMonitorFn(KSP ksp, PetscInt it, PetscReal rnorm, PetscCtx ctx);
248: PETSC_EXTERN PetscErrorCode KSPMonitor(KSP, PetscInt, PetscReal);
249: PETSC_EXTERN PetscErrorCode KSPMonitorSet(KSP, KSPMonitorFn *, PetscCtx, PetscCtxDestroyFn *);
250: PETSC_EXTERN PetscErrorCode KSPMonitorCancel(KSP);
251: PETSC_EXTERN PetscErrorCode KSPGetMonitorContext(KSP, PetscCtxRt);
252: PETSC_EXTERN PetscErrorCode KSPGetResidualHistory(KSP, const PetscReal *[], PetscInt *);
253: PETSC_EXTERN PetscErrorCode KSPSetResidualHistory(KSP, PetscReal[], PetscCount, PetscBool);
254: PETSC_EXTERN PetscErrorCode KSPGetErrorHistory(KSP, const PetscReal *[], PetscInt *);
255: PETSC_EXTERN PetscErrorCode KSPSetErrorHistory(KSP, PetscReal[], PetscCount, PetscBool);
257: PETSC_EXTERN PetscErrorCode KSPBuildSolutionDefault(KSP, Vec, Vec *);
258: PETSC_EXTERN PetscErrorCode KSPBuildResidualDefault(KSP, Vec, Vec, Vec *);
259: PETSC_EXTERN PetscErrorCode KSPDestroyDefault(KSP);
260: PETSC_EXTERN PetscErrorCode KSPSetWorkVecs(KSP, PetscInt);
262: PETSC_EXTERN PetscErrorCode PCKSPGetKSP(PC, KSP *);
263: PETSC_EXTERN PetscErrorCode PCKSPSetKSP(PC, KSP);
264: PETSC_EXTERN PetscErrorCode PCBJacobiGetSubKSP(PC, PetscInt *, PetscInt *, KSP *[]);
265: PETSC_EXTERN PetscErrorCode PCASMGetSubKSP(PC, PetscInt *, PetscInt *, KSP *[]);
266: PETSC_EXTERN PetscErrorCode PCGASMGetSubKSP(PC, PetscInt *, PetscInt *, KSP *[]);
267: PETSC_EXTERN PetscErrorCode PCPatchGetSubKSP(PC, PetscInt *, KSP *[]);
268: PETSC_EXTERN PetscErrorCode PCFieldSplitGetSubKSP(PC, PetscInt *, KSP *[]);
269: PETSC_EXTERN PetscErrorCode PCFieldSplitSchurGetSubKSP(PC, PetscInt *, KSP *[]);
270: PETSC_EXTERN PetscErrorCode PCMGGetSmoother(PC, PetscInt, KSP *);
271: PETSC_EXTERN PetscErrorCode PCMGGetSmootherDown(PC, PetscInt, KSP *);
272: PETSC_EXTERN PetscErrorCode PCMGGetSmootherUp(PC, PetscInt, KSP *);
273: PETSC_EXTERN PetscErrorCode PCMGGetCoarseSolve(PC, KSP *);
274: PETSC_EXTERN PetscErrorCode PCGalerkinGetKSP(PC, KSP *);
275: PETSC_EXTERN PetscErrorCode PCDeflationGetCoarseKSP(PC, KSP *);
277: /*S
278: PCMGCoarseSpaceConstructorFn - A function prototype for functions registered with `PCMGRegisterCoarseSpaceConstructor()`
280: Calling Sequence:
281: + pc - The `PC` object
282: . l - The multigrid level, 0 is the coarse level
283: . dm - The `DM` for this level
284: . smooth - The level smoother
285: . Nc - The size of the coarse space
286: . initGuess - Basis for an initial guess for the space
287: - coarseSp - A basis for the computed coarse space
289: Level: beginner
291: .seealso: [](ch_ksp), `PCMGRegisterCoarseSpaceConstructor()`, `PCMGGetCoarseSpaceConstructor()`
292: S*/
293: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode PCMGCoarseSpaceConstructorFn(PC pc, PetscInt l, DM dm, KSP smooth, PetscInt Nc, Mat initGuess, Mat *coarseSp);
295: PETSC_EXTERN PetscFunctionList PCMGCoarseList;
296: PETSC_EXTERN PetscErrorCode PCMGRegisterCoarseSpaceConstructor(const char[], PCMGCoarseSpaceConstructorFn *);
297: PETSC_EXTERN PetscErrorCode PCMGGetCoarseSpaceConstructor(const char[], PCMGCoarseSpaceConstructorFn **);
299: PETSC_EXTERN PetscErrorCode KSPBuildSolution(KSP, Vec, Vec *);
300: PETSC_EXTERN PetscErrorCode KSPBuildResidual(KSP, Vec, Vec, Vec *);
302: /*E
303: KSPChebyshevKind - Which kind of Chebyshev polynomial to use with `KSPCHEBYSHEV`
305: Values:
306: + `KSP_CHEBYSHEV_FIRST` - "classic" first-kind Chebyshev polynomial
307: . `KSP_CHEBYSHEV_FOURTH` - fourth-kind Chebyshev polynomial
308: - `KSP_CHEBYSHEV_OPT_FOURTH` - optimized fourth-kind Chebyshev polynomial
310: Level: intermediate
312: .seealso: [](ch_ksp), `KSPCHEBYSHEV`, `KSPChebyshevSetKind()`, `KSPChebyshevGetKind()`
313: E*/
314: typedef enum {
315: KSP_CHEBYSHEV_FIRST,
316: KSP_CHEBYSHEV_FOURTH,
317: KSP_CHEBYSHEV_OPT_FOURTH
318: } KSPChebyshevKind;
320: PETSC_EXTERN PetscErrorCode KSPRichardsonSetScale(KSP, PetscReal);
321: PETSC_EXTERN PetscErrorCode KSPRichardsonSetSelfScale(KSP, PetscBool);
322: PETSC_EXTERN PetscErrorCode KSPChebyshevSetEigenvalues(KSP, PetscReal, PetscReal);
323: PETSC_EXTERN PetscErrorCode KSPChebyshevEstEigSet(KSP, PetscReal, PetscReal, PetscReal, PetscReal);
324: PETSC_EXTERN PetscErrorCode KSPChebyshevEstEigSetUseNoisy(KSP, PetscBool);
325: PETSC_EXTERN PetscErrorCode KSPChebyshevSetKind(KSP, KSPChebyshevKind);
326: PETSC_EXTERN PetscErrorCode KSPChebyshevGetKind(KSP, KSPChebyshevKind *);
327: PETSC_EXTERN PetscErrorCode KSPChebyshevEstEigGetKSP(KSP, KSP *);
328: PETSC_EXTERN PetscErrorCode KSPComputeExtremeSingularValues(KSP, PetscReal *, PetscReal *);
329: PETSC_EXTERN PetscErrorCode KSPComputeEigenvalues(KSP, PetscInt, PetscReal[], PetscReal[], PetscInt *);
330: PETSC_EXTERN PetscErrorCode KSPComputeEigenvaluesExplicitly(KSP, PetscInt, PetscReal[], PetscReal[]);
331: PETSC_EXTERN PetscErrorCode KSPComputeRitz(KSP, PetscBool, PetscBool, PetscInt *, Vec[], PetscReal[], PetscReal[]);
333: /*E
334: KSPFCDTruncationType - Define how stored directions are used to orthogonalize in flexible conjugate directions (FCD) methods
336: Values:
337: + `KSP_FCD_TRUNC_TYPE_STANDARD` - uses all (up to `mmax`) stored directions
338: - `KSP_FCD_TRUNC_TYPE_NOTAY` - uses the last `max(1,mod(i,mmax))` stored directions at iteration i = 0, 1, ...
340: Level: intermediate
342: Note:
343: Function such as `KSPFCGSetMmax()`, `KSPPIPEGCRSetNMax()`, `KSPPIPEGCRSetNMax()`, and `KSPPIPEFCGSetNMax()` may be
344: used to provide `nmax` or they may be provided with the option database.
346: .seealso: [](ch_ksp), `KSP`, `KSPFCG`, `KSPPIPEFCG`, `KSPPIPEGCR`, `KSPFCGSetTruncationType()`, `KSPFCGGetTruncationType()`,
347: `KSPPIPEGCRSetTruncationType()`, `KSPPIPEGCRGetTruncationType()`,
348: `KSPFCGSetMmax()`, `KSPPIPEGCRSetNMax()`, `KSPPIPEGCRGetNMax()`, `KSPPIPEFCGGetNMax()`
349: E*/
350: typedef enum {
351: KSP_FCD_TRUNC_TYPE_STANDARD,
352: KSP_FCD_TRUNC_TYPE_NOTAY
353: } KSPFCDTruncationType;
354: PETSC_EXTERN const char *const KSPFCDTruncationTypes[];
356: PETSC_EXTERN PetscErrorCode KSPFCGSetMmax(KSP, PetscInt);
357: PETSC_EXTERN PetscErrorCode KSPFCGGetMmax(KSP, PetscInt *);
358: PETSC_EXTERN PetscErrorCode KSPFCGSetNprealloc(KSP, PetscInt);
359: PETSC_EXTERN PetscErrorCode KSPFCGGetNprealloc(KSP, PetscInt *);
360: PETSC_EXTERN PetscErrorCode KSPFCGSetTruncationType(KSP, KSPFCDTruncationType);
361: PETSC_EXTERN PetscErrorCode KSPFCGGetTruncationType(KSP, KSPFCDTruncationType *);
363: PETSC_EXTERN PetscErrorCode KSPPIPEFCGSetMmax(KSP, PetscInt);
364: PETSC_EXTERN PetscErrorCode KSPPIPEFCGGetMmax(KSP, PetscInt *);
365: PETSC_EXTERN PetscErrorCode KSPPIPEFCGSetNprealloc(KSP, PetscInt);
366: PETSC_EXTERN PetscErrorCode KSPPIPEFCGGetNprealloc(KSP, PetscInt *);
367: PETSC_EXTERN PetscErrorCode KSPPIPEFCGSetTruncationType(KSP, KSPFCDTruncationType);
368: PETSC_EXTERN PetscErrorCode KSPPIPEFCGGetTruncationType(KSP, KSPFCDTruncationType *);
370: PETSC_EXTERN PetscErrorCode KSPPIPEGCRSetMmax(KSP, PetscInt);
371: PETSC_EXTERN PetscErrorCode KSPPIPEGCRGetMmax(KSP, PetscInt *);
372: PETSC_EXTERN PetscErrorCode KSPPIPEGCRSetNprealloc(KSP, PetscInt);
373: PETSC_EXTERN PetscErrorCode KSPPIPEGCRGetNprealloc(KSP, PetscInt *);
374: PETSC_EXTERN PetscErrorCode KSPPIPEGCRSetTruncationType(KSP, KSPFCDTruncationType);
375: PETSC_EXTERN PetscErrorCode KSPPIPEGCRGetTruncationType(KSP, KSPFCDTruncationType *);
376: PETSC_EXTERN PetscErrorCode KSPPIPEGCRSetUnrollW(KSP, PetscBool);
377: PETSC_EXTERN PetscErrorCode KSPPIPEGCRGetUnrollW(KSP, PetscBool *);
379: /*S
380: KSPFlexibleModifyPCFn - A prototype of a function used to modify the preconditioner during the use of flexible `KSP` methods, such as `KSPFGMRES`
382: Calling Sequence:
383: + ksp - the `KSP` context being used.
384: . total_its - the total number of iterations that have occurred.
385: . local_its - the number of iterations since last restart if applicable
386: . res_norm - the current residual norm
387: - ctx - optional context variable set with `KSPFlexibleSetModifyPC()`
389: Level: beginner
391: .seealso: [](ch_ksp), `KSP`, `KSPFlexibleSetModifyPC()`
392: S*/
393: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode KSPFlexibleModifyPCFn(KSP ksp, PetscInt total_its, PetscInt local_its, PetscReal res_norm, PetscCtx ctx);
395: PETSC_EXTERN PetscErrorCode KSPFlexibleSetModifyPC(KSP, KSPFlexibleModifyPCFn *, PetscCtx, PetscCtxDestroyFn *);
397: PETSC_DEPRECATED_FUNCTION(3, 25, 0, "KSPFlexibleSetModifyPC()", ) static inline PetscErrorCode KSPPIPEGCRSetModifyPC(KSP ksp, KSPFlexibleModifyPCFn *fun, PetscCtx ctx, PetscCtxDestroyFn *dfun)
398: {
399: return KSPFlexibleSetModifyPC(ksp, fun, ctx, dfun);
400: }
402: PETSC_EXTERN PetscErrorCode KSPGMRESSetRestart(KSP, PetscInt);
403: PETSC_EXTERN PetscErrorCode KSPGMRESGetRestart(KSP, PetscInt *);
404: PETSC_EXTERN PetscErrorCode KSPGMRESSetHapTol(KSP, PetscReal);
405: PETSC_EXTERN PetscErrorCode KSPGMRESSetBreakdownTolerance(KSP, PetscReal);
407: PETSC_EXTERN PetscErrorCode KSPGMRESSetPreAllocateVectors(KSP);
408: PETSC_EXTERN PetscErrorCode KSPGMRESSetOrthogonalization(KSP, PetscErrorCode (*)(KSP, PetscInt));
409: PETSC_EXTERN PetscErrorCode KSPGMRESGetOrthogonalization(KSP, PetscErrorCode (**)(KSP, PetscInt));
410: PETSC_EXTERN PetscErrorCode KSPGMRESModifiedGramSchmidtOrthogonalization(KSP, PetscInt);
411: PETSC_EXTERN PetscErrorCode KSPGMRESClassicalGramSchmidtOrthogonalization(KSP, PetscInt);
413: PETSC_EXTERN PetscErrorCode KSPLGMRESSetAugDim(KSP, PetscInt);
414: PETSC_EXTERN PetscErrorCode KSPLGMRESSetConstant(KSP);
416: PETSC_EXTERN PetscErrorCode KSPPIPEFGMRESSetShift(KSP, PetscScalar);
418: PETSC_EXTERN PetscErrorCode KSPGCRSetRestart(KSP, PetscInt);
419: PETSC_EXTERN PetscErrorCode KSPGCRGetRestart(KSP, PetscInt *);
421: PETSC_EXTERN PetscErrorCode KSPIDRSetS(KSP, PetscInt);
422: PETSC_EXTERN PetscErrorCode KSPIDRGetS(KSP, PetscInt *);
423: PETSC_EXTERN PetscErrorCode KSPIDRSetCosine(KSP, PetscReal);
424: PETSC_EXTERN PetscErrorCode KSPIDRGetCosine(KSP, PetscReal *);
425: PETSC_EXTERN PetscErrorCode KSPIDRSetRandom(KSP, PetscRandom);
426: PETSC_EXTERN PetscErrorCode KSPIDRGetRandom(KSP, PetscRandom *);
428: PETSC_DEPRECATED_FUNCTION(3, 25, 0, "KSPFlexibleSetModifyPC()", ) static inline PetscErrorCode KSPGCRSetModifyPC(KSP ksp, KSPFlexibleModifyPCFn *fun, PetscCtx ctx, PetscCtxDestroyFn *dfun)
429: {
430: return KSPFlexibleSetModifyPC(ksp, fun, ctx, dfun);
431: }
433: PETSC_EXTERN PetscErrorCode KSPMINRESSetRadius(KSP, PetscReal);
434: PETSC_EXTERN PetscErrorCode KSPMINRESGetUseQLP(KSP, PetscBool *);
435: PETSC_EXTERN PetscErrorCode KSPMINRESSetUseQLP(KSP, PetscBool);
437: PETSC_EXTERN PetscErrorCode KSPFETIDPGetInnerBDDC(KSP, PC *);
438: PETSC_EXTERN PetscErrorCode KSPFETIDPSetInnerBDDC(KSP, PC);
439: PETSC_EXTERN PetscErrorCode KSPFETIDPGetInnerKSP(KSP, KSP *);
440: PETSC_EXTERN PetscErrorCode KSPFETIDPSetPressureOperator(KSP, Mat);
442: PETSC_EXTERN PetscErrorCode KSPHPDDMSetDeflationMat(KSP, Mat);
443: PETSC_EXTERN PetscErrorCode KSPHPDDMGetDeflationMat(KSP, Mat *);
444: #if PetscDefined(HAVE_HPDDM)
445: PETSC_DEPRECATED_FUNCTION(3, 18, 0, "KSPHPDDMSetDeflationMat()", ) static inline PetscErrorCode KSPHPDDMSetDeflationSpace(KSP ksp, Mat U)
446: {
447: return KSPHPDDMSetDeflationMat(ksp, U);
448: }
449: PETSC_DEPRECATED_FUNCTION(3, 18, 0, "KSPHPDDMGetDeflationMat()", ) static inline PetscErrorCode KSPHPDDMGetDeflationSpace(KSP ksp, Mat *U)
450: {
451: return KSPHPDDMGetDeflationMat(ksp, U);
452: }
453: #endif
454: PETSC_DEPRECATED_FUNCTION(3, 14, 0, "KSPMatSolve()", ) static inline PetscErrorCode KSPHPDDMMatSolve(KSP ksp, Mat B, Mat X)
455: {
456: return KSPMatSolve(ksp, B, X);
457: }
458: /*E
459: KSPHPDDMType - Type of Krylov method used by `KSPHPDDM`
461: Values:
462: + `KSP_HPDDM_TYPE_GMRES` (default) - Generalized Minimal Residual method
463: . `KSP_HPDDM_TYPE_BGMRES` - block GMRES
464: . `KSP_HPDDM_TYPE_CG` - Conjugate Gradient
465: . `KSP_HPDDM_TYPE_BCG` - block CG
466: . `KSP_HPDDM_TYPE_GCRODR` - Generalized Conjugate Residual method with inner Orthogonalization and Deflated Restarting
467: . `KSP_HPDDM_TYPE_BGCRODR` - block GCRODR
468: . `KSP_HPDDM_TYPE_BFBCG` - breakdown-free BCG
469: - `KSP_HPDDM_TYPE_PREONLY` - apply the preconditioner only
471: Level: intermediate
473: .seealso: [](ch_ksp), `KSPHPDDM`, `KSPHPDDMSetType()`
474: E*/
475: typedef enum {
476: KSP_HPDDM_TYPE_GMRES = 0,
477: KSP_HPDDM_TYPE_BGMRES = 1,
478: KSP_HPDDM_TYPE_CG = 2,
479: KSP_HPDDM_TYPE_BCG = 3,
480: KSP_HPDDM_TYPE_GCRODR = 4,
481: KSP_HPDDM_TYPE_BGCRODR = 5,
482: KSP_HPDDM_TYPE_BFBCG = 6,
483: KSP_HPDDM_TYPE_PREONLY = 7
484: } KSPHPDDMType;
485: PETSC_EXTERN const char *const KSPHPDDMTypes[];
487: PETSC_EXTERN PetscErrorCode KSPHPDDMSetType(KSP, KSPHPDDMType);
488: PETSC_EXTERN PetscErrorCode KSPHPDDMGetType(KSP, KSPHPDDMType *);
490: /*E
491: KSPGMRESCGSRefinementType - How the classical (unmodified) Gram-Schmidt is performed in the GMRES solvers
493: Values:
494: + `KSP_GMRES_CGS_REFINE_NEVER` - one step of classical Gram-Schmidt
495: . `KSP_GMRES_CGS_REFINE_IFNEEDED` - a second step is performed if the first step does not satisfy some criteria
496: - `KSP_GMRES_CGS_REFINE_ALWAYS` - always perform two steps
498: Level: advanced
500: .seealso: [](ch_ksp), `KSP`, `KSPGMRES`, `KSPGMRESClassicalGramSchmidtOrthogonalization()`, `KSPGMRESSetOrthogonalization()`,
501: `KSPGMRESGetOrthogonalization()`,
502: `KSPGMRESSetCGSRefinementType()`, `KSPGMRESGetCGSRefinementType()`, `KSPGMRESModifiedGramSchmidtOrthogonalization()`
503: E*/
504: typedef enum {
505: KSP_GMRES_CGS_REFINE_NEVER,
506: KSP_GMRES_CGS_REFINE_IFNEEDED,
507: KSP_GMRES_CGS_REFINE_ALWAYS
508: } KSPGMRESCGSRefinementType;
509: PETSC_EXTERN const char *const KSPGMRESCGSRefinementTypes[];
511: /*MC
512: KSP_GMRES_CGS_REFINE_NEVER - Do the classical (unmodified) Gram-Schmidt process
514: Level: advanced
516: Note:
517: Possibly unstable, but the fastest to compute
519: .seealso: [](ch_ksp), `KSPGMRES`, `KSPGMRESCGSRefinementType`, `KSPGMRESClassicalGramSchmidtOrthogonalization()`, `KSPGMRESSetOrthogonalization()`,
520: `KSP`, `KSPGMRESGetOrthogonalization()`,
521: `KSPGMRESSetCGSRefinementType()`, `KSPGMRESGetCGSRefinementType()`, `KSP_GMRES_CGS_REFINE_IFNEEDED`, `KSP_GMRES_CGS_REFINE_ALWAYS`,
522: `KSPGMRESModifiedGramSchmidtOrthogonalization()`
523: M*/
525: /*MC
526: KSP_GMRES_CGS_REFINE_IFNEEDED - Do the classical (unmodified) Gram-Schmidt process and one step of
527: iterative refinement if an estimate of the orthogonality of the resulting vectors indicates
528: poor orthogonality.
530: Level: advanced
532: Note:
533: This is slower than `KSP_GMRES_CGS_REFINE_NEVER` because it requires an extra norm computation to
534: estimate the orthogonality but is more stable.
536: .seealso: [](ch_ksp), `KSPGMRES`, `KSPGMRESCGSRefinementType`, `KSPGMRESClassicalGramSchmidtOrthogonalization()`, `KSPGMRESSetOrthogonalization()`,
537: `KSP`, `KSPGMRESGetOrthogonalization()`,
538: `KSPGMRESSetCGSRefinementType()`, `KSPGMRESGetCGSRefinementType()`, `KSP_GMRES_CGS_REFINE_NEVER`, `KSP_GMRES_CGS_REFINE_ALWAYS`,
539: `KSPGMRESModifiedGramSchmidtOrthogonalization()`
540: M*/
542: /*MC
543: KSP_GMRES_CGS_REFINE_ALWAYS - Do two steps of the classical (unmodified) Gram-Schmidt process.
545: Level: advanced
547: Notes:
548: This is roughly twice the cost of `KSP_GMRES_CGS_REFINE_NEVER` because it performs the process twice
549: but it saves the extra norm calculation needed by `KSP_GMRES_CGS_REFINE_IFNEEDED`.
551: You should only use this if you absolutely know that the iterative refinement is needed.
553: .seealso: [](ch_ksp), `KSPGMRES`, `KSPGMRESCGSRefinementType`, `KSPGMRESClassicalGramSchmidtOrthogonalization()`, `KSPGMRESSetOrthogonalization()`,
554: `KSP`, `KSPGMRESGetOrthogonalization()`,
555: `KSPGMRESSetCGSRefinementType()`, `KSPGMRESGetCGSRefinementType()`, `KSP_GMRES_CGS_REFINE_IFNEEDED`, `KSP_GMRES_CGS_REFINE_ALWAYS`,
556: `KSPGMRESModifiedGramSchmidtOrthogonalization()`
557: M*/
559: PETSC_EXTERN PetscErrorCode KSPGMRESSetCGSRefinementType(KSP, KSPGMRESCGSRefinementType);
560: PETSC_EXTERN PetscErrorCode KSPGMRESGetCGSRefinementType(KSP, KSPGMRESCGSRefinementType *);
562: PETSC_EXTERN KSPFlexibleModifyPCFn KSPFlexibleModifyPCNoChange;
563: PETSC_EXTERN KSPFlexibleModifyPCFn KSPFlexibleModifyPCKSP;
565: PETSC_DEPRECATED_FUNCTION(3, 25, 0, "KSPFlexibleModifyPCNoChange()", ) static inline PetscErrorCode KSPFGMRESModifyPCNoChange(KSP ksp, PetscInt total_its, PetscInt loc_its, PetscReal res_norm, PetscCtx ctx)
566: {
567: return KSPFlexibleModifyPCNoChange(ksp, total_its, loc_its, res_norm, ctx);
568: }
570: PETSC_DEPRECATED_FUNCTION(3, 25, 0, "KSPFlexibleModifyPCKSP()", ) static inline PetscErrorCode KSPFGMRESModifyPCKSP(KSP ksp, PetscInt total_its, PetscInt loc_its, PetscReal res_norm, PetscCtx ctx)
571: {
572: return KSPFlexibleModifyPCKSP(ksp, total_its, loc_its, res_norm, ctx);
573: }
575: PETSC_EXTERN PetscErrorCode KSPQCGSetTrustRegionRadius(KSP, PetscReal);
576: PETSC_EXTERN PetscErrorCode KSPQCGGetQuadratic(KSP, PetscReal *);
577: PETSC_EXTERN PetscErrorCode KSPQCGGetTrialStepNorm(KSP, PetscReal *);
579: PETSC_EXTERN PetscErrorCode KSPBCGSLSetXRes(KSP, PetscReal);
580: PETSC_EXTERN PetscErrorCode KSPBCGSLSetPol(KSP, PetscBool);
581: PETSC_EXTERN PetscErrorCode KSPBCGSLSetEll(KSP, PetscInt);
582: PETSC_EXTERN PetscErrorCode KSPBCGSLSetUsePseudoinverse(KSP, PetscBool);
584: PETSC_EXTERN PetscErrorCode KSPSetFromOptions(KSP);
585: PETSC_EXTERN PetscErrorCode KSPResetFromOptions(KSP);
587: PETSC_EXTERN PetscErrorCode KSPMonitorSetFromOptions(KSP, const char[], const char[], PetscCtx);
588: PETSC_EXTERN KSPMonitorRegisterFn KSPMonitorResidual;
589: PETSC_EXTERN KSPMonitorRegisterFn KSPMonitorResidualView;
590: PETSC_DEPRECATED_FUNCTION(3, 23, 0, "KSPMonitorResidualDraw()", ) static inline PetscErrorCode KSPMonitorResidualDraw(KSP ksp, PetscInt n, PetscReal rnorm, PetscViewerAndFormat *vf)
591: {
592: return KSPMonitorResidualView(ksp, n, rnorm, vf);
593: }
594: PETSC_EXTERN KSPMonitorRegisterFn KSPMonitorResidualDrawLG;
595: PETSC_EXTERN PetscErrorCode KSPMonitorResidualDrawLGCreate(PetscViewer, PetscViewerFormat, PetscCtx, PetscViewerAndFormat **);
596: PETSC_EXTERN KSPMonitorRegisterFn KSPMonitorResidualShort;
597: PETSC_EXTERN KSPMonitorRegisterFn KSPMonitorResidualRange;
598: PETSC_EXTERN KSPMonitorRegisterFn KSPMonitorTrueResidual;
599: PETSC_EXTERN KSPMonitorRegisterFn KSPMonitorTrueResidualView;
600: PETSC_DEPRECATED_FUNCTION(3, 23, 0, "KSPMonitorTrueResidualDraw()", ) static inline PetscErrorCode KSPMonitorTrueResidualDraw(KSP ksp, PetscInt n, PetscReal rnorm, PetscViewerAndFormat *vf)
601: {
602: return KSPMonitorTrueResidualView(ksp, n, rnorm, vf);
603: }
604: PETSC_EXTERN KSPMonitorRegisterFn KSPMonitorTrueResidualDrawLG;
605: PETSC_EXTERN PetscErrorCode KSPMonitorTrueResidualDrawLGCreate(PetscViewer, PetscViewerFormat, PetscCtx, PetscViewerAndFormat **);
606: PETSC_EXTERN KSPMonitorRegisterFn KSPMonitorTrueResidualMax;
607: PETSC_EXTERN KSPMonitorRegisterFn KSPMonitorError;
608: PETSC_EXTERN KSPMonitorRegisterFn KSPMonitorErrorDraw;
609: PETSC_EXTERN KSPMonitorRegisterFn KSPMonitorErrorDrawLG;
610: PETSC_EXTERN PetscErrorCode KSPMonitorErrorDrawLGCreate(PetscViewer, PetscViewerFormat, PetscCtx, PetscViewerAndFormat **);
611: PETSC_EXTERN KSPMonitorRegisterFn KSPMonitorSolution;
612: PETSC_EXTERN KSPMonitorRegisterFn KSPMonitorSolutionDraw;
613: PETSC_EXTERN KSPMonitorRegisterFn KSPMonitorSolutionDrawLG;
614: PETSC_EXTERN PetscErrorCode KSPMonitorSolutionDrawLGCreate(PetscViewer, PetscViewerFormat, PetscCtx, PetscViewerAndFormat **);
615: PETSC_EXTERN KSPMonitorRegisterFn KSPMonitorSingularValue;
616: PETSC_EXTERN PetscErrorCode KSPMonitorSingularValueCreate(PetscViewer, PetscViewerFormat, PetscCtx, PetscViewerAndFormat **);
617: PETSC_DEPRECATED_FUNCTION(3, 15, 0, "KSPMonitorResidual()", ) static inline PetscErrorCode KSPMonitorDefault(KSP ksp, PetscInt n, PetscReal rnorm, PetscViewerAndFormat *vf)
618: {
619: return KSPMonitorResidual(ksp, n, rnorm, vf);
620: }
621: PETSC_DEPRECATED_FUNCTION(3, 15, 0, "KSPMonitorTrueResidual()", ) static inline PetscErrorCode KSPMonitorTrueResidualNorm(KSP ksp, PetscInt n, PetscReal rnorm, PetscViewerAndFormat *vf)
622: {
623: return KSPMonitorTrueResidual(ksp, n, rnorm, vf);
624: }
625: PETSC_DEPRECATED_FUNCTION(3, 15, 0, "KSPMonitorTrueResidualMax()", ) static inline PetscErrorCode KSPMonitorTrueResidualMaxNorm(KSP ksp, PetscInt n, PetscReal rnorm, PetscViewerAndFormat *vf)
626: {
627: return KSPMonitorTrueResidualMax(ksp, n, rnorm, vf);
628: }
630: PETSC_EXTERN PetscErrorCode KSPGMRESMonitorKrylov(KSP, PetscInt, PetscReal, void *);
631: PETSC_EXTERN PetscErrorCode KSPMonitorDynamicTolerance(KSP, PetscInt, PetscReal, PetscCtx);
632: PETSC_EXTERN PetscErrorCode KSPMonitorDynamicToleranceDestroy(PetscCtxRt);
633: PETSC_EXTERN PetscErrorCode KSPMonitorDynamicToleranceCreate(void *);
634: PETSC_EXTERN PetscErrorCode KSPMonitorDynamicToleranceSetCoefficient(void *, PetscReal);
635: PETSC_EXTERN PetscErrorCode KSPMonitorSAWs(KSP, PetscInt, PetscReal, void *);
636: PETSC_EXTERN PetscErrorCode KSPMonitorSAWsCreate(KSP, void **);
637: PETSC_EXTERN PetscErrorCode KSPMonitorSAWsDestroy(PetscCtxRt);
639: PETSC_EXTERN PetscErrorCode KSPUnwindPreconditioner(KSP, Vec, Vec);
640: PETSC_EXTERN PetscErrorCode KSPInitialResidual(KSP, Vec, Vec, Vec, Vec, Vec);
642: PETSC_EXTERN PetscErrorCode KSPSetOperators(KSP, Mat, Mat);
643: PETSC_EXTERN PetscErrorCode KSPGetOperators(KSP, Mat *, Mat *);
644: PETSC_EXTERN PetscErrorCode KSPGetOperatorsSet(KSP, PetscBool *, PetscBool *);
645: PETSC_EXTERN PetscErrorCode KSPSetOptionsPrefix(KSP, const char[]);
646: PETSC_EXTERN PetscErrorCode KSPAppendOptionsPrefix(KSP, const char[]);
647: PETSC_EXTERN PetscErrorCode KSPGetOptionsPrefix(KSP, const char *[]);
649: PETSC_EXTERN PetscErrorCode KSPSetDiagonalScale(KSP, PetscBool);
650: PETSC_EXTERN PetscErrorCode KSPGetDiagonalScale(KSP, PetscBool *);
651: PETSC_EXTERN PetscErrorCode KSPSetDiagonalScaleFix(KSP, PetscBool);
652: PETSC_EXTERN PetscErrorCode KSPGetDiagonalScaleFix(KSP, PetscBool *);
654: /*S
655: KSPConvergedReasonViewFn - A prototype of a function used with `KSPConvergedReasonViewSet()`
657: Calling Sequence:
658: + ksp - the `KSP` object whose `KSPConvergedReason` is to be viewed
659: - ctx - context used by the function, set with `KSPConvergedReasonViewSet()`
661: Level: beginner
663: .seealso: [](ch_ksp), `KSP`, `KSPConvergedReasonView()`, `KSPConvergedReasonViewSet()`, `KSPConvergedReasonViewFromOptions()`, `KSPView()`
664: S*/
665: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode KSPConvergedReasonViewFn(KSP ksp, PetscCtx ctx);
667: PETSC_EXTERN PetscErrorCode KSPView(KSP, PetscViewer);
668: PETSC_EXTERN PetscErrorCode KSPLoad(KSP, PetscViewer);
669: PETSC_EXTERN PetscErrorCode KSPViewFromOptions(KSP, PetscObject, const char[]);
670: PETSC_EXTERN PetscErrorCode KSPConvergedReasonView(KSP, PetscViewer);
671: PETSC_EXTERN PetscErrorCode KSPConvergedReasonViewSet(KSP, KSPConvergedReasonViewFn *, void *, PetscCtxDestroyFn *);
672: PETSC_EXTERN PetscErrorCode KSPConvergedReasonViewFromOptions(KSP);
673: PETSC_EXTERN PetscErrorCode KSPConvergedReasonViewCancel(KSP);
674: PETSC_EXTERN PetscErrorCode KSPConvergedRateView(KSP, PetscViewer);
676: PETSC_DEPRECATED_FUNCTION(3, 14, 0, "KSPConvergedReasonView()", ) static inline PetscErrorCode KSPReasonView(KSP ksp, PetscViewer v)
677: {
678: return KSPConvergedReasonView(ksp, v);
679: }
680: PETSC_DEPRECATED_FUNCTION(3, 14, 0, "KSPConvergedReasonViewFromOptions()", ) static inline PetscErrorCode KSPReasonViewFromOptions(KSP ksp)
681: {
682: return KSPConvergedReasonViewFromOptions(ksp);
683: }
685: #define KSP_FILE_CLASSID 1211223
687: PETSC_EXTERN PetscErrorCode KSPLSQRSetExactMatNorm(KSP, PetscBool);
688: PETSC_EXTERN PetscErrorCode KSPLSQRSetComputeStandardErrorVec(KSP, PetscBool);
689: PETSC_EXTERN PetscErrorCode KSPLSQRGetStandardErrorVec(KSP, Vec *);
690: PETSC_EXTERN PetscErrorCode KSPLSQRGetNorms(KSP, PetscReal *, PetscReal *);
691: PETSC_EXTERN KSPMonitorRegisterFn KSPLSQRMonitorResidual;
692: PETSC_EXTERN KSPMonitorRegisterFn KSPLSQRMonitorResidualDrawLG;
693: PETSC_EXTERN PetscErrorCode KSPLSQRMonitorResidualDrawLGCreate(PetscViewer, PetscViewerFormat, void *, PetscViewerAndFormat **);
695: PETSC_EXTERN PetscErrorCode PCRedundantGetKSP(PC, KSP *);
696: PETSC_EXTERN PetscErrorCode PCRedistributeGetKSP(PC, KSP *);
697: PETSC_EXTERN PetscErrorCode PCTelescopeGetKSP(PC, KSP *);
698: PETSC_EXTERN PetscErrorCode PCMPIGetKSP(PC, KSP *);
700: /*E
701: KSPNormType - Norm calculated by the `KSP` and passed in the Krylov convergence
702: test routines.
704: Values:
705: + `KSP_NORM_DEFAULT` - use the default for the current `KSPType`
706: . `KSP_NORM_NONE` - use no norm calculation
707: . `KSP_NORM_PRECONDITIONED` - use the preconditioned residual norm
708: . `KSP_NORM_UNPRECONDITIONED` - use the unpreconditioned residual norm
709: - `KSP_NORM_NATURAL` - use the natural norm (the norm induced by the linear operator)
711: Level: advanced
713: Note:
714: Each solver only supports a subset of these and some may support different ones
715: depending on whether left or right preconditioning is used, see `KSPSetPCSide()`
717: .seealso: [](ch_ksp), `KSP`, `PCSide`, `KSPSolve()`, `KSPGetConvergedReason()`, `KSPSetNormType()`,
718: `KSPSetConvergenceTest()`, `KSPSetPCSide()`, `KSP_NORM_DEFAULT`, `KSP_NORM_NONE`, `KSP_NORM_PRECONDITIONED`, `KSP_NORM_UNPRECONDITIONED`, `KSP_NORM_NATURAL`
719: E*/
720: typedef enum {
721: KSP_NORM_DEFAULT = -1,
722: KSP_NORM_NONE = 0,
723: KSP_NORM_PRECONDITIONED = 1,
724: KSP_NORM_UNPRECONDITIONED = 2,
725: KSP_NORM_NATURAL = 3
726: } KSPNormType;
727: #define KSP_NORM_MAX (KSP_NORM_NATURAL + 1)
728: PETSC_EXTERN const char *const *const KSPNormTypes;
730: /*MC
731: KSP_NORM_NONE - Do not compute a norm during the Krylov process. This will
732: possibly save some computation but means the convergence test cannot
733: be based on a norm of a residual etc.
735: Level: advanced
737: Note:
738: Some Krylov methods need to compute a residual norm (such as `KPSGMRES`) and then this option is ignored
740: .seealso: [](ch_ksp), `KSPNormType`, `KSP`, `KSPSetNormType()`, `KSP_NORM_PRECONDITIONED`, `KSP_NORM_UNPRECONDITIONED`, `KSP_NORM_NATURAL`
741: M*/
743: /*MC
744: KSP_NORM_PRECONDITIONED - Compute the norm of the preconditioned residual B*(b - A*x), if left preconditioning, and pass that to the
745: convergence test routine.
747: Level: advanced
749: .seealso: [](ch_ksp), `KSPNormType`, `KSP`, `KSPSetNormType()`, `KSP_NORM_NONE`, `KSP_NORM_UNPRECONDITIONED`, `KSP_NORM_NATURAL`, `KSPSetConvergenceTest()`
750: M*/
752: /*MC
753: KSP_NORM_UNPRECONDITIONED - Compute the norm of the true residual (b - A*x) and pass that to the
754: convergence test routine.
756: Level: advanced
758: .seealso: [](ch_ksp), `KSPNormType`, `KSP`, `KSPSetNormType()`, `KSP_NORM_NONE`, `KSP_NORM_PRECONDITIONED`, `KSP_NORM_NATURAL`, `KSPSetConvergenceTest()`
759: M*/
761: /*MC
762: KSP_NORM_NATURAL - Compute the 'natural norm' of residual sqrt((b - A*x)*B*(b - A*x)) and pass that to the
763: convergence test routine. This is only supported by `KSPCG`, `KSPCR`, `KSPCGNE`, `KSPCGS`, `KSPFCG`, `KSPPIPEFCG`, `KSPPIPEGCR`
765: Level: advanced
767: .seealso: [](ch_ksp), `KSPNormType`, `KSP`, `KSPSetNormType()`, `KSP_NORM_NONE`, `KSP_NORM_PRECONDITIONED`, `KSP_NORM_UNPRECONDITIONED`, `KSPSetConvergenceTest()`
768: M*/
770: PETSC_EXTERN PetscErrorCode KSPSetNormType(KSP, KSPNormType);
771: PETSC_EXTERN PetscErrorCode KSPGetNormType(KSP, KSPNormType *);
772: PETSC_EXTERN PetscErrorCode KSPSetSupportedNorm(KSP, KSPNormType, PCSide, PetscInt);
773: PETSC_EXTERN PetscErrorCode KSPSetCheckNormIteration(KSP, PetscInt);
774: PETSC_EXTERN PetscErrorCode KSPSetLagNorm(KSP, PetscBool);
776: #define KSP_CONVERGED_CG_NEG_CURVE_DEPRECATED KSP_CONVERGED_CG_NEG_CURVE PETSC_DEPRECATED_ENUM(3, 19, 0, "KSP_CONVERGED_NEG_CURVE", )
777: #define KSP_CONVERGED_CG_CONSTRAINED_DEPRECATED KSP_CONVERGED_CG_CONSTRAINED PETSC_DEPRECATED_ENUM(3, 19, 0, "KSP_CONVERGED_STEP_LENGTH", )
778: #define KSP_CONVERGED_RTOL_NORMAL_DEPRECATED KSP_CONVERGED_RTOL_NORMAL PETSC_DEPRECATED_ENUM(3, 24, 0, "KSP_CONVERGED_RTOL_NORMAL_EQUATIONS", )
779: #define KSP_CONVERGED_ATOL_NORMAL_DEPRECATED KSP_CONVERGED_ATOL_NORMAL PETSC_DEPRECATED_ENUM(3, 24, 0, "KSP_CONVERGED_ATOL_NORMAL_EQUATIONS", )
780: /*E
781: KSPConvergedReason - reason a Krylov method was determined to have converged or diverged
783: Values:
784: + `KSP_CONVERGED_RTOL_NORMAL_EQUATIONS` - requested decrease in the residual of the normal equations, for `KSPLSQR`
785: . `KSP_CONVERGED_ATOL_NORMAL_EQUATIONS` - requested absolute value in the residual of the normal equations, for `KSPLSQR`
786: . `KSP_CONVERGED_RTOL` - requested decrease in the residual
787: . `KSP_CONVERGED_ATOL` - requested absolute value in the residual
788: . `KSP_CONVERGED_ITS` - requested number of iterations
789: . `KSP_CONVERGED_NEG_CURVE` - see note below
790: . `KSP_CONVERGED_STEP_LENGTH` - see note below
791: . `KSP_CONVERGED_HAPPY_BREAKDOWN` - happy breakdown (meaning early convergence of the `KSPType` occurred).
792: . `KSP_CONVERGED_USER` - the user has indicated convergence for an arbitrary reason
793: . `KSP_DIVERGED_NULL` - breakdown when solving the Hessenberg system within `KSPGMRES`
794: . `KSP_DIVERGED_ITS` - requested number of iterations
795: . `KSP_DIVERGED_DTOL` - large increase in the residual norm indicating the solution is diverging
796: . `KSP_DIVERGED_BREAKDOWN` - breakdown in the Krylov method
797: . `KSP_DIVERGED_BREAKDOWN_BICG` - breakdown in the `KSPBCGS` Krylov method
798: . `KSP_DIVERGED_NONSYMMETRIC` - the operator or preonditioner was not symmetric for a `KSPType` that requires symmetry
799: . `KSP_DIVERGED_INDEFINITE_PC` - the preconditioner was indefinite for a `KSPType` that requires it be definite, such as `KSPCG`
800: . `KSP_DIVERGED_NANORINF` - a not a number of infinity was detected in a vector during the computation
801: . `KSP_DIVERGED_INDEFINITE_MAT` - the operator was indefinite for a `KSPType` that requires it be definite, such as `KSPCG`
802: . `KSP_DIVERGED_PC_FAILED` - the action of the preconditioner failed for some reason
803: - `KSP_DIVERGED_USER` - the user has indicated divergence for an arbitrary reason
805: Level: beginner
807: Note:
808: The values `KSP_CONVERGED_NEG_CURVE`, and `KSP_CONVERGED_STEP_LENGTH` are returned only by `KSPCG`, `KSPMINRES` and by
809: the special `KSPNASH`, `KSPSTCG`, and `KSPGLTR` solvers which are used by the `SNESNEWTONTR` (trust region) solver.
811: Developer Note:
812: The string versions of these are `KSPConvergedReasons`; if you change
813: any of the values here also change them that array of names.
815: .seealso: [](ch_ksp), `KSP`, `KSPSolve()`, `KSPGetConvergedReason()`, `KSPSetTolerances()`, `KSPConvergedReasonView()`
816: E*/
817: typedef enum { /* converged */
818: KSP_CONVERGED_RTOL_NORMAL_DEPRECATED = 1,
819: KSP_CONVERGED_RTOL_NORMAL_EQUATIONS = 1,
820: KSP_CONVERGED_ATOL_NORMAL_DEPRECATED = 9,
821: KSP_CONVERGED_ATOL_NORMAL_EQUATIONS = 9,
822: KSP_CONVERGED_RTOL = 2,
823: KSP_CONVERGED_ATOL = 3,
824: KSP_CONVERGED_ITS = 4,
825: KSP_CONVERGED_NEG_CURVE = 5,
826: KSP_CONVERGED_CG_NEG_CURVE_DEPRECATED = 5,
827: KSP_CONVERGED_CG_CONSTRAINED_DEPRECATED = 6,
828: KSP_CONVERGED_STEP_LENGTH = 6,
829: KSP_CONVERGED_HAPPY_BREAKDOWN = 7,
830: KSP_CONVERGED_USER = 8,
831: /* diverged */
832: KSP_DIVERGED_NULL = -2,
833: KSP_DIVERGED_ITS = -3,
834: KSP_DIVERGED_DTOL = -4,
835: KSP_DIVERGED_BREAKDOWN = -5,
836: KSP_DIVERGED_BREAKDOWN_BICG = -6,
837: KSP_DIVERGED_NONSYMMETRIC = -7,
838: KSP_DIVERGED_INDEFINITE_PC = -8,
839: KSP_DIVERGED_NANORINF = -9,
840: KSP_DIVERGED_INDEFINITE_MAT = -10,
841: KSP_DIVERGED_PC_FAILED = -11,
842: KSP_DIVERGED_PCSETUP_FAILED_DEPRECATED = -11,
843: KSP_DIVERGED_USER = -12,
845: KSP_CONVERGED_ITERATING = 0
846: } KSPConvergedReason;
847: PETSC_EXTERN const char *const *KSPConvergedReasons;
849: /*MC
850: KSP_CONVERGED_RTOL - $||r|| \le rtol*||b||$ or $rtol*||b - A*x_0||$ if `KSPConvergedDefaultSetUIRNorm()` was called
852: Level: beginner
854: Notes:
855: See `KSPNormType` and `KSPSetNormType()` for possible norms that may be used. By default
856: for left preconditioning it is the 2-norm of the preconditioned residual, and the
857: 2-norm of the residual for right preconditioning
859: See also `KSP_CONVERGED_ATOL` which may apply before this tolerance.
861: .seealso: [](ch_ksp), `KSPNormType`, `KSP_CONVERGED_ATOL`, `KSP_DIVERGED_DTOL`, `KSPSolve()`, `KSPGetConvergedReason()`, `KSPConvergedReason`, `KSPSetTolerances()`
862: M*/
864: /*MC
865: KSP_CONVERGED_ATOL - $||r|| \le atol$
867: Level: beginner
869: Notes:
870: See `KSPNormType` and `KSPSetNormType()` for possible norms that may be used. By default
871: for left preconditioning it is the 2-norm of the preconditioned residual, and the
872: 2-norm of the residual for right preconditioning
874: See also `KSP_CONVERGED_RTOL` which may apply before this tolerance.
876: .seealso: [](ch_ksp), `KSPNormType`, `KSP_CONVERGED_RTOL`, `KSP_DIVERGED_DTOL`, `KSPSolve()`, `KSPGetConvergedReason()`, `KSPConvergedReason`, `KSPSetTolerances()`
877: M*/
879: /*MC
880: KSP_DIVERGED_DTOL - $||r|| \ge dtol*||b||$
882: Level: beginner
884: Note:
885: See `KSPNormType` and `KSPSetNormType()` for possible norms that may be used. By default
886: for left preconditioning it is the 2-norm of the preconditioned residual, and the
887: 2-norm of the residual for right preconditioning
889: .seealso: [](ch_ksp), `KSPNormType`, `KSP_CONVERGED_ATOL`, `KSP_CONVERGED_RTOL`, `KSPSolve()`, `KSPGetConvergedReason()`, `KSPConvergedReason`, `KSPSetTolerances()`
890: M*/
892: /*MC
893: KSP_DIVERGED_ITS - Ran out of iterations before any convergence criteria was
894: reached
896: Level: beginner
898: .seealso: [](ch_ksp), `KSPSolve()`, `KSPGetConvergedReason()`, `KSPConvergedReason`, `KSPSetTolerances()`
899: M*/
901: /*MC
902: KSP_CONVERGED_ITS - Used by the `KSPPREONLY` solver after the single iteration of
903: the preconditioner is applied. Also used when the `KSPConvergedSkip()` convergence
904: test routine is set in `KSP`.
906: Level: beginner
908: .seealso: [](ch_ksp), `KSPSolve()`, `KSPGetConvergedReason()`, `KSPConvergedReason`, `KSPSetTolerances()`
909: M*/
911: /*MC
912: KSP_DIVERGED_BREAKDOWN - A breakdown in the Krylov method was detected so the
913: method could not continue to enlarge the Krylov space. Could be due to a singular matrix or
914: preconditioner. In `KSPHPDDM`, this is also returned when some search directions within a block
915: are collinear.
917: Level: beginner
919: .seealso: [](ch_ksp), `KSPSolve()`, `KSPGetConvergedReason()`, `KSPConvergedReason`, `KSPSetTolerances()`
920: M*/
922: /*MC
923: KSP_DIVERGED_BREAKDOWN_BICG - A breakdown in the `KSPBICG` method was detected so the
924: method could not continue to enlarge the Krylov space.
926: Level: beginner
928: .seealso: [](ch_ksp), `KSPSolve()`, `KSPGetConvergedReason()`, `KSPConvergedReason`, `KSPSetTolerances()`
929: M*/
931: /*MC
932: KSP_DIVERGED_NONSYMMETRIC - It appears the operator or preconditioner is not
933: symmetric and this Krylov method (`KSPCG`, `KSPMINRES`, `KSPCR`) requires symmetry
935: Level: beginner
937: .seealso: [](ch_ksp), `KSPSolve()`, `KSPGetConvergedReason()`, `KSPConvergedReason`, `KSPSetTolerances()`
938: M*/
940: /*MC
941: KSP_DIVERGED_INDEFINITE_PC - It appears the preconditioner is indefinite (has both
942: positive and negative eigenvalues) and this Krylov method (`KSPCG`) requires it to
943: be symmetric positive definite (SPD).
945: Level: beginner
947: Note:
948: This can happen with the `PCICC` preconditioner, use the options database option `-pc_factor_shift_positive_definite` to force
949: the `PCICC` preconditioner to generate a positive definite preconditioner
951: .seealso: [](ch_ksp), `KSPSolve()`, `KSPGetConvergedReason()`, `KSPConvergedReason`, `KSPSetTolerances()`
952: M*/
954: /*MC
955: KSP_DIVERGED_PC_FAILED - It was not possible to build or use the requested preconditioner. This is usually due to a
956: zero pivot in a factorization. It can also result from a failure in a subpreconditioner inside a nested preconditioner
957: such as `PCFIELDSPLIT`.
959: Level: beginner
961: Note:
962: Run with `-ksp_error_if_not_converged` to stop the program when the error is detected and print an error message with details.
964: .seealso: [](ch_ksp), `KSPSolve()`, `KSPGetConvergedReason()`, `KSPConvergedReason`, `KSPSetTolerances()`
965: M*/
967: /*MC
968: KSP_CONVERGED_ITERATING - This flag is returned if `KSPGetConvergedReason()` is called
969: while `KSPSolve()` is still running.
971: Level: beginner
973: .seealso: [](ch_ksp), `KSPSolve()`, `KSPGetConvergedReason()`, `KSPConvergedReason`, `KSPSetTolerances()`
974: M*/
976: /*S
977: KSPConvergenceTestFn - A prototype of a function used with `KSPSetConvergenceTest()`
979: Calling Sequence:
980: + ksp - iterative solver obtained from `KSPCreate()`
981: . it - iteration number
982: . rnorm - (estimated) 2-norm of (preconditioned) residual
983: . reason - the reason why it has converged or diverged
984: - ctx - optional convergence context, as set by `KSPSetConvergenceTest()`
986: Level: beginner
988: .seealso: [](ch_ksp), `KSP`, `KSPSetConvergenceTest()`, `KSPGetConvergenceTest()`
989: S*/
990: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode KSPConvergenceTestFn(KSP ksp, PetscInt it, PetscReal rnorm, KSPConvergedReason *reason, PetscCtx ctx);
992: PETSC_EXTERN PetscErrorCode KSPSetConvergenceTest(KSP, KSPConvergenceTestFn *, void *, PetscCtxDestroyFn *);
993: PETSC_EXTERN PetscErrorCode KSPGetConvergenceTest(KSP, KSPConvergenceTestFn **, PetscCtxRt, PetscCtxDestroyFn **);
994: PETSC_EXTERN PetscErrorCode KSPGetAndClearConvergenceTest(KSP, KSPConvergenceTestFn **, PetscCtxRt, PetscCtxDestroyFn **);
995: PETSC_EXTERN PetscErrorCode KSPGetConvergenceContext(KSP, PetscCtxRt);
996: PETSC_EXTERN KSPConvergenceTestFn KSPConvergedDefault;
997: PETSC_EXTERN KSPConvergenceTestFn KSPLSQRConvergedDefault;
998: PETSC_EXTERN PetscCtxDestroyFn KSPConvergedDefaultDestroy;
999: PETSC_EXTERN PetscErrorCode KSPConvergedDefaultCreate(void **);
1000: PETSC_EXTERN PetscErrorCode KSPConvergedDefaultSetUIRNorm(KSP);
1001: PETSC_EXTERN PetscErrorCode KSPConvergedDefaultSetUMIRNorm(KSP);
1002: PETSC_EXTERN PetscErrorCode KSPConvergedDefaultSetConvergedMaxits(KSP, PetscBool);
1003: PETSC_EXTERN PetscErrorCode KSPConvergedSkip(KSP, PetscInt, PetscReal, KSPConvergedReason *, void *);
1004: PETSC_EXTERN PetscErrorCode KSPGetConvergedReason(KSP, KSPConvergedReason *);
1005: PETSC_EXTERN PetscErrorCode KSPGetConvergedReasonString(KSP, const char *[]);
1006: PETSC_EXTERN PetscErrorCode KSPComputeConvergenceRate(KSP, PetscReal *, PetscReal *, PetscReal *, PetscReal *);
1007: PETSC_EXTERN PetscErrorCode KSPSetConvergedNegativeCurvature(KSP, PetscBool);
1008: PETSC_EXTERN PetscErrorCode KSPGetConvergedNegativeCurvature(KSP, PetscBool *);
1010: PETSC_DEPRECATED_FUNCTION(3, 5, 0, "KSPConvergedDefault()", ) static inline void KSPDefaultConverged(void)
1011: { /* never called */
1012: }
1013: #define KSPDefaultConverged (KSPDefaultConverged, KSPConvergedDefault)
1014: PETSC_DEPRECATED_FUNCTION(3, 5, 0, "KSPConvergedDefaultDestroy()", ) static inline void KSPDefaultConvergedDestroy(void)
1015: { /* never called */
1016: }
1017: #define KSPDefaultConvergedDestroy (KSPDefaultConvergedDestroy, KSPConvergedDefaultDestroy)
1018: PETSC_DEPRECATED_FUNCTION(3, 5, 0, "KSPConvergedDefaultCreate()", ) static inline void KSPDefaultConvergedCreate(void)
1019: { /* never called */
1020: }
1021: #define KSPDefaultConvergedCreate (KSPDefaultConvergedCreate, KSPConvergedDefaultCreate)
1022: PETSC_DEPRECATED_FUNCTION(3, 5, 0, "KSPConvergedDefaultSetUIRNorm()", ) static inline void KSPDefaultConvergedSetUIRNorm(void)
1023: { /* never called */
1024: }
1025: #define KSPDefaultConvergedSetUIRNorm (KSPDefaultConvergedSetUIRNorm, KSPConvergedDefaultSetUIRNorm)
1026: PETSC_DEPRECATED_FUNCTION(3, 5, 0, "KSPConvergedDefaultSetUMIRNorm()", ) static inline void KSPDefaultConvergedSetUMIRNorm(void)
1027: { /* never called */
1028: }
1029: #define KSPDefaultConvergedSetUMIRNorm (KSPDefaultConvergedSetUMIRNorm, KSPConvergedDefaultSetUMIRNorm)
1030: PETSC_DEPRECATED_FUNCTION(3, 5, 0, "KSPConvergedSkip()", ) static inline void KSPSkipConverged(void)
1031: { /* never called */
1032: }
1033: #define KSPSkipConverged (KSPSkipConverged, KSPConvergedSkip)
1035: PETSC_EXTERN PetscErrorCode KSPComputeOperator(KSP, MatType, Mat *);
1036: PETSC_DEPRECATED_FUNCTION(3, 12, 0, "KSPComputeOperator()", ) static inline PetscErrorCode KSPComputeExplicitOperator(KSP A, Mat *B)
1037: {
1038: return KSPComputeOperator(A, PETSC_NULLPTR, B);
1039: }
1041: /*E
1042: KSPCGType - Determines what type of `KSPCG` to use
1044: Values:
1045: + `KSP_CG_SYMMETRIC` - the matrix is complex symmetric
1046: - `KSP_CG_HERMITIAN` - the matrix is complex Hermitian
1048: Level: beginner
1050: .seealso: [](ch_ksp), `KSPCG`, `KSP`, `KSPCGSetType()`
1051: E*/
1052: typedef enum {
1053: KSP_CG_SYMMETRIC = 0,
1054: KSP_CG_HERMITIAN = 1
1055: } KSPCGType;
1056: PETSC_EXTERN const char *const KSPCGTypes[];
1058: PETSC_EXTERN PetscErrorCode KSPCGSetType(KSP, KSPCGType);
1059: PETSC_EXTERN PetscErrorCode KSPCGUseSingleReduction(KSP, PetscBool);
1061: PETSC_EXTERN PetscErrorCode KSPCGSetRadius(KSP, PetscReal);
1062: PETSC_EXTERN PetscErrorCode KSPCGSetObjectiveTarget(KSP, PetscReal);
1063: PETSC_EXTERN PetscErrorCode KSPCGGetNormD(KSP, PetscReal *);
1064: PETSC_EXTERN PetscErrorCode KSPCGGetObjFcn(KSP, PetscReal *);
1066: PETSC_EXTERN PetscErrorCode KSPGLTRGetMinEig(KSP, PetscReal *);
1067: PETSC_EXTERN PetscErrorCode KSPGLTRGetLambda(KSP, PetscReal *);
1068: PETSC_DEPRECATED_FUNCTION(3, 12, 0, "KSPGLTRGetMinEig()", ) static inline PetscErrorCode KSPCGGLTRGetMinEig(KSP ksp, PetscReal *x)
1069: {
1070: return KSPGLTRGetMinEig(ksp, x);
1071: }
1072: PETSC_DEPRECATED_FUNCTION(3, 12, 0, "KSPGLTRGetLambda()", ) static inline PetscErrorCode KSPCGGLTRGetLambda(KSP ksp, PetscReal *x)
1073: {
1074: return KSPGLTRGetLambda(ksp, x);
1075: }
1077: PETSC_EXTERN PetscErrorCode KSPPythonSetType(KSP, const char[]);
1078: PETSC_EXTERN PetscErrorCode KSPPythonGetType(KSP, const char *[]);
1080: PETSC_EXTERN PetscErrorCode PCPreSolve(PC, KSP);
1081: PETSC_EXTERN PetscErrorCode PCPostSolve(PC, KSP);
1083: PETSC_EXTERN PetscErrorCode KSPMonitorLGRange(KSP, PetscInt, PetscReal, void *);
1085: /*S
1086: PCShellPSolveFn - A function prototype for functions provided to `PCShellSetPreSolve()` and `PCShellSetPostSolve()`
1088: Calling Sequence:
1089: + pc - the preconditioner `PC` context
1090: . ksp - the `KSP` context
1091: . xin - input vector
1092: - xout - output vector
1094: Level: intermediate
1096: .seealso: [](ch_snes), `KSPPSolveFn`, `KSP`, `PCShellSetPreSolve()`, `PCShellSetPostSolve()`
1097: S*/
1098: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode PCShellPSolveFn(PC pc, KSP ksp, Vec xim, Vec xout);
1100: PETSC_EXTERN PetscErrorCode PCShellSetPreSolve(PC, PCShellPSolveFn *);
1101: PETSC_EXTERN PetscErrorCode PCShellSetPostSolve(PC, PCShellPSolveFn *);
1103: /*S
1104: KSPGuess - Abstract PETSc object that manages all initial guess generation methods for Krylov methods.
1106: Level: intermediate
1108: Note:
1109: These methods generate initial guesses based on a series of previous, related, linear solves. For example,
1110: in implicit time-stepping with `TS`.
1112: .seealso: [](ch_ksp), `KSPCreate()`, `KSPGuessSetType()`, `KSPGuessType`
1113: S*/
1114: typedef struct _p_KSPGuess *KSPGuess;
1116: /*J
1117: KSPGuessType - String with the name of a PETSc initial guess approach for Krylov methods.
1119: Values:
1120: + `KSPGUESSFISCHER` - methodology developed by Paul Fischer
1121: - `KSPGUESSPOD` - methodology based on proper orthogonal decomposition (POD)
1123: Level: intermediate
1125: .seealso: [](ch_ksp), `KSP`, `KSPGuess`
1126: J*/
1127: typedef const char *KSPGuessType;
1128: #define KSPGUESSFISCHER "fischer"
1129: #define KSPGUESSPOD "pod"
1131: PETSC_EXTERN PetscErrorCode KSPGuessRegister(const char[], PetscErrorCode (*)(KSPGuess));
1132: PETSC_EXTERN PetscErrorCode KSPSetGuess(KSP, KSPGuess);
1133: PETSC_EXTERN PetscErrorCode KSPGetGuess(KSP, KSPGuess *);
1134: PETSC_EXTERN PetscErrorCode KSPGuessView(KSPGuess, PetscViewer);
1135: PETSC_EXTERN PetscErrorCode KSPGuessDestroy(KSPGuess *);
1136: PETSC_EXTERN PetscErrorCode KSPGuessCreate(MPI_Comm, KSPGuess *);
1137: PETSC_EXTERN PetscErrorCode KSPGuessSetType(KSPGuess, KSPGuessType);
1138: PETSC_EXTERN PetscErrorCode KSPGuessGetType(KSPGuess, KSPGuessType *);
1139: PETSC_EXTERN PetscErrorCode KSPGuessSetTolerance(KSPGuess, PetscReal);
1140: PETSC_EXTERN PetscErrorCode KSPGuessSetUp(KSPGuess);
1141: PETSC_EXTERN PetscErrorCode KSPGuessUpdate(KSPGuess, Vec, Vec);
1142: PETSC_EXTERN PetscErrorCode KSPGuessFormGuess(KSPGuess, Vec, Vec);
1143: PETSC_EXTERN PetscErrorCode KSPGuessSetFromOptions(KSPGuess);
1144: PETSC_EXTERN PetscErrorCode KSPGuessFischerSetModel(KSPGuess, PetscInt, PetscInt);
1145: PETSC_EXTERN PetscErrorCode KSPSetUseFischerGuess(KSP, PetscInt, PetscInt);
1146: PETSC_EXTERN PetscErrorCode KSPSetInitialGuessKnoll(KSP, PetscBool);
1147: PETSC_EXTERN PetscErrorCode KSPGetInitialGuessKnoll(KSP, PetscBool *);
1149: /*E
1150: MatSchurComplementAinvType - Determines how to approximate the inverse of the (0,0) block in Schur complement matrix assembly routines
1152: Level: intermediate
1154: .seealso: `MatSchurComplementGetAinvType()`, `MatSchurComplementSetAinvType()`, `MatSchurComplementGetPmat()`, `MatGetSchurComplement()`,
1155: `MatCreateSchurComplementPmat()`, `MatCreateSchurComplement()`
1156: E*/
1157: typedef enum {
1158: MAT_SCHUR_COMPLEMENT_AINV_DIAG,
1159: MAT_SCHUR_COMPLEMENT_AINV_LUMP,
1160: MAT_SCHUR_COMPLEMENT_AINV_BLOCK_DIAG,
1161: MAT_SCHUR_COMPLEMENT_AINV_FULL
1162: } MatSchurComplementAinvType;
1163: PETSC_EXTERN const char *const MatSchurComplementAinvTypes[];
1165: PETSC_EXTERN PetscErrorCode MatCreateSchurComplement(Mat, Mat, Mat, Mat, Mat, Mat *);
1166: PETSC_EXTERN PetscErrorCode MatSchurComplementGetKSP(Mat, KSP *);
1167: PETSC_EXTERN PetscErrorCode MatSchurComplementSetKSP(Mat, KSP);
1168: PETSC_EXTERN PetscErrorCode MatSchurComplementSetSubMatrices(Mat, Mat, Mat, Mat, Mat, Mat);
1169: PETSC_EXTERN PetscErrorCode MatSchurComplementUpdateSubMatrices(Mat, Mat, Mat, Mat, Mat, Mat);
1170: PETSC_EXTERN PetscErrorCode MatSchurComplementGetSubMatrices(Mat, Mat *, Mat *, Mat *, Mat *, Mat *);
1171: PETSC_EXTERN PetscErrorCode MatSchurComplementSetAinvType(Mat, MatSchurComplementAinvType);
1172: PETSC_EXTERN PetscErrorCode MatSchurComplementGetAinvType(Mat, MatSchurComplementAinvType *);
1173: PETSC_EXTERN PetscErrorCode MatSchurComplementGetPmat(Mat, MatReuse, Mat *);
1174: PETSC_EXTERN PetscErrorCode MatSchurComplementComputeExplicitOperator(Mat, Mat *);
1175: PETSC_EXTERN PetscErrorCode MatGetSchurComplement(Mat, IS, IS, IS, IS, MatReuse, Mat *, MatSchurComplementAinvType, MatReuse, Mat *);
1176: PETSC_EXTERN PetscErrorCode MatCreateSchurComplementPmat(Mat, Mat, Mat, Mat, MatSchurComplementAinvType, MatReuse, Mat *);
1178: PETSC_EXTERN PetscErrorCode MatCreateLMVMDFP(MPI_Comm, PetscInt, PetscInt, Mat *);
1179: PETSC_EXTERN PetscErrorCode MatCreateLMVMBFGS(MPI_Comm, PetscInt, PetscInt, Mat *);
1180: PETSC_EXTERN PetscErrorCode MatCreateLMVMDBFGS(MPI_Comm, PetscInt, PetscInt, Mat *);
1181: PETSC_EXTERN PetscErrorCode MatCreateLMVMDDFP(MPI_Comm, PetscInt, PetscInt, Mat *);
1182: PETSC_EXTERN PetscErrorCode MatCreateLMVMDQN(MPI_Comm, PetscInt, PetscInt, Mat *);
1183: PETSC_EXTERN PetscErrorCode MatCreateLMVMSR1(MPI_Comm, PetscInt, PetscInt, Mat *);
1184: PETSC_EXTERN PetscErrorCode MatCreateLMVMBroyden(MPI_Comm, PetscInt, PetscInt, Mat *);
1185: PETSC_EXTERN PetscErrorCode MatCreateLMVMBadBroyden(MPI_Comm, PetscInt, PetscInt, Mat *);
1186: PETSC_EXTERN PetscErrorCode MatCreateLMVMSymBroyden(MPI_Comm, PetscInt, PetscInt, Mat *);
1187: PETSC_EXTERN PetscErrorCode MatCreateLMVMSymBadBroyden(MPI_Comm, PetscInt, PetscInt, Mat *);
1188: PETSC_EXTERN PetscErrorCode MatCreateLMVMDiagBroyden(MPI_Comm, PetscInt, PetscInt, Mat *);
1190: PETSC_EXTERN PetscErrorCode MatLMVMUpdate(Mat, Vec, Vec);
1191: PETSC_EXTERN PetscErrorCode MatLMVMIsAllocated(Mat, PetscBool *);
1192: PETSC_EXTERN PetscErrorCode MatLMVMAllocate(Mat, Vec, Vec);
1193: PETSC_EXTERN PetscErrorCode MatLMVMReset(Mat, PetscBool);
1194: PETSC_EXTERN PetscErrorCode MatLMVMResetShift(Mat);
1195: PETSC_EXTERN PetscErrorCode MatLMVMClearJ0(Mat);
1196: PETSC_EXTERN PetscErrorCode MatLMVMSetJ0(Mat, Mat);
1197: PETSC_EXTERN PetscErrorCode MatLMVMSetJ0Scale(Mat, PetscReal);
1198: PETSC_EXTERN PetscErrorCode MatLMVMSetJ0Diag(Mat, Vec);
1199: PETSC_EXTERN PetscErrorCode MatLMVMSetJ0PC(Mat, PC);
1200: PETSC_EXTERN PetscErrorCode MatLMVMSetJ0KSP(Mat, KSP);
1201: PETSC_EXTERN PetscErrorCode MatLMVMApplyJ0Fwd(Mat, Vec, Vec);
1202: PETSC_EXTERN PetscErrorCode MatLMVMApplyJ0Inv(Mat, Vec, Vec);
1203: PETSC_EXTERN PetscErrorCode MatLMVMGetLastUpdate(Mat, Vec *, Vec *);
1204: PETSC_EXTERN PetscErrorCode MatLMVMGetJ0(Mat, Mat *);
1205: PETSC_EXTERN PetscErrorCode MatLMVMGetJ0PC(Mat, PC *);
1206: PETSC_EXTERN PetscErrorCode MatLMVMGetJ0KSP(Mat, KSP *);
1207: PETSC_EXTERN PetscErrorCode MatLMVMSetHistorySize(Mat, PetscInt);
1208: PETSC_EXTERN PetscErrorCode MatLMVMGetHistorySize(Mat, PetscInt *);
1209: PETSC_EXTERN PetscErrorCode MatLMVMGetUpdateCount(Mat, PetscInt *);
1210: PETSC_EXTERN PetscErrorCode MatLMVMGetRejectCount(Mat, PetscInt *);
1211: PETSC_EXTERN PetscErrorCode MatLMVMSymBroydenSetDelta(Mat, PetscScalar);
1213: /*E
1214: MatLMVMMultAlgorithm - The type of algorithm used for matrix-vector products and solves used internally by a `MatLMVM` matrix
1216: Values:
1217: + `MAT_LMVM_MULT_RECURSIVE` - Use recursive formulas for products and solves
1218: . `MAT_LMVM_MULT_DENSE` - Use dense formulas for products and solves when possible
1219: - `MAT_LMVM_MULT_COMPACT_DENSE` - The same as `MATLMVM_MULT_DENSE`, but go further and ensure products and solves are computed in compact low-rank update form
1221: Level: advanced
1223: Options Database Keys:
1224: . -mat_lmvm_mult_algorithm (recursive|dense|compact_dense) - the algorithm to use for multiplication
1226: .seealso: [](ch_matrices), `MATLMVM`, `MatLMVMSetMultAlgorithm()`, `MatLMVMGetMultAlgorithm()`
1227: E*/
1228: typedef enum {
1229: MAT_LMVM_MULT_RECURSIVE,
1230: MAT_LMVM_MULT_DENSE,
1231: MAT_LMVM_MULT_COMPACT_DENSE,
1232: } MatLMVMMultAlgorithm;
1234: PETSC_EXTERN const char *const MatLMVMMultAlgorithms[];
1236: PETSC_EXTERN PetscErrorCode MatLMVMSetMultAlgorithm(Mat, MatLMVMMultAlgorithm);
1237: PETSC_EXTERN PetscErrorCode MatLMVMGetMultAlgorithm(Mat, MatLMVMMultAlgorithm *);
1239: /*E
1240: MatLMVMSymBroydenScaleType - Rescaling type for the initial Hessian of a symmetric Broyden matrix.
1242: Values:
1243: + `MAT_LMVM_SYMBROYDEN_SCALE_NONE` - no rescaling
1244: . `MAT_LMVM_SYMBROYDEN_SCALE_SCALAR` - scalar rescaling
1245: . `MAT_LMVM_SYMBROYDEN_SCALE_DIAGONAL` - diagonal rescaling
1246: . `MAT_LMVM_SYMBROYDEN_SCALE_USER` - same as `MAT_LMVM_SYMBROYDN_SCALE_NONE`
1247: - `MAT_LMVM_SYMBROYDEN_SCALE_DECIDE` - let PETSc decide rescaling
1249: Level: intermediate
1251: .seealso: [](ch_matrices), `MATLMVM`, `MatLMVMSymBroydenSetScaleType()`
1252: E*/
1253: typedef enum {
1254: MAT_LMVM_SYMBROYDEN_SCALE_NONE = 0,
1255: MAT_LMVM_SYMBROYDEN_SCALE_SCALAR = 1,
1256: MAT_LMVM_SYMBROYDEN_SCALE_DIAGONAL = 2,
1257: MAT_LMVM_SYMBROYDEN_SCALE_USER = 3,
1258: MAT_LMVM_SYMBROYDEN_SCALE_DECIDE = 4
1259: } MatLMVMSymBroydenScaleType;
1260: PETSC_EXTERN const char *const MatLMVMSymBroydenScaleTypes[];
1262: PETSC_EXTERN PetscErrorCode MatLMVMSymBroydenSetScaleType(Mat, MatLMVMSymBroydenScaleType);
1263: PETSC_EXTERN PetscErrorCode MatLMVMSymBroydenGetPhi(Mat, PetscReal *);
1264: PETSC_EXTERN PetscErrorCode MatLMVMSymBroydenSetPhi(Mat, PetscReal);
1265: PETSC_EXTERN PetscErrorCode MatLMVMSymBadBroydenGetPsi(Mat, PetscReal *);
1266: PETSC_EXTERN PetscErrorCode MatLMVMSymBadBroydenSetPsi(Mat, PetscReal);
1268: /*E
1269: MatLMVMDenseType - Memory storage strategy for dense variants of `MATLMVM`.
1271: Values:
1272: + `MAT_LMVM_DENSE_REORDER` - reorders memory to minimize kernel launch
1273: - `MAT_LMVM_DENSE_INPLACE` - computes inplace to minimize memory movement
1275: Level: intermediate
1277: .seealso: [](ch_matrices), `MatLMVM`, `MatLMVMDenseSetType()`
1278: E*/
1279: typedef enum {
1280: MAT_LMVM_DENSE_REORDER,
1281: MAT_LMVM_DENSE_INPLACE
1282: } MatLMVMDenseType;
1283: PETSC_EXTERN const char *const MatLMVMDenseTypes[];
1285: PETSC_EXTERN PetscErrorCode MatLMVMDenseSetType(Mat, MatLMVMDenseType);
1287: PETSC_EXTERN PetscErrorCode KSPSetDM(KSP, DM);
1289: /*E
1290: KSPDMActive - Indicates if the `DM` attached to the `KSP` should be used to compute the operator, the right-hand side, or the initial guess
1292: Values:
1293: + `KSP_DMACTIVE_OPERATOR` - compute the operator
1294: . `KSP_DMACTIVE_RHS` - compute the right-hand side
1295: . `KSP_DMACTIVE_INITIAL_GUESS` - compute the initial guess
1296: - `KSP_DMACTIVE_ALL` - compute all of them
1298: Level: intermediate
1300: .seealso: [](ch_ksp), `KSP`, `KSPSetDMActive()`, `KSPSetDM()`
1301: E*/
1302: typedef enum {
1303: KSP_DMACTIVE_OPERATOR = 1,
1304: KSP_DMACTIVE_RHS = 2,
1305: KSP_DMACTIVE_INITIAL_GUESS = 4,
1306: KSP_DMACTIVE_ALL = 1 + 2 + 4
1307: } KSPDMActive;
1308: PETSC_EXTERN PetscErrorCode KSPSetDMActive(KSP, KSPDMActive, PetscBool);
1310: PETSC_EXTERN PetscErrorCode KSPGetDM(KSP, DM *);
1311: PETSC_EXTERN PetscErrorCode KSPSetApplicationContext(KSP, PetscCtx);
1312: PETSC_EXTERN PetscErrorCode KSPGetApplicationContext(KSP, PetscCtxRt);
1314: /*S
1315: KSPComputeRHSFn - A prototype of a `KSP` evaluation function that would be passed to `KSPSetComputeRHS()`
1317: Calling Sequence:
1318: + ksp - `ksp` context
1319: . b - output vector
1320: - ctx - [optional] user-defined function context
1322: Level: beginner
1324: .seealso: [](ch_ksp), `KSP`, `KSPSetComputeRHS()`, `SNESGetFunction()`, `KSPComputeInitialGuessFn`, `KSPComputeOperatorsFn`
1325: S*/
1326: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode KSPComputeRHSFn(KSP ksp, Vec b, PetscCtx ctx);
1328: PETSC_EXTERN PetscErrorCode KSPSetComputeRHS(KSP, KSPComputeRHSFn *, void *);
1330: /*S
1331: KSPComputeOperatorsFn - A prototype of a `KSP` evaluation function that would be passed to `KSPSetComputeOperators()`
1333: Calling Sequence:
1334: + ksp - `KSP` context
1335: . A - the operator that defines the linear system
1336: . P - an operator from which to build the preconditioner (often the same as `A`)
1337: - ctx - [optional] user-defined function context
1339: Level: beginner
1341: .seealso: [](ch_ksp), `KSP`, `KSPSetComputeRHS()`, `SNESGetFunction()`, `KSPComputeRHSFn`, `KSPComputeInitialGuessFn`
1342: S*/
1343: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode KSPComputeOperatorsFn(KSP ksp, Mat A, Mat P, PetscCtx ctx);
1345: PETSC_EXTERN PetscErrorCode KSPSetComputeOperators(KSP, KSPComputeOperatorsFn, void *);
1347: /*S
1348: KSPCreateOperatorsFn - A prototype of a `KSP` operator creation function that would be passed to `DMKSPSetCreateOperators()`
1350: Calling Sequence:
1351: + ksp - `KSP` context
1352: . A - the created operator that defines the linear system
1353: . P - the created operator from which to build the preconditioner, often the same as `A`
1354: - ctx - [optional] user-defined function context
1356: Level: developer
1358: Notes:
1359: The returned matrices are owned by the caller, similar to `DMCreateMatrix()`.
1361: `A` and `P` may be the same object. In such a case, users do not need to increase the reference count of `A`. If `P` is not returned, then we assume it is the same of `A`.
1363: .seealso: [](ch_ksp), `DMKSPSetCreateOperators()`, `DMKSPGetCreateOperators()`, `KSPComputeOperatorsFn`, `KSPSetOperators()`
1364: S*/
1365: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode KSPCreateOperatorsFn(KSP ksp, Mat *A, Mat *P, PetscCtx ctx);
1367: /*S
1368: KSPComputeInitialGuessFn - A prototype of a `KSP` evaluation function that would be passed to `KSPSetComputeInitialGuess()`
1370: Calling Sequence:
1371: + ksp - `ksp` context
1372: . x - output vector
1373: - ctx - [optional] user-defined function context
1375: Level: beginner
1377: .seealso: [](ch_ksp), `KSP`, `KSPSetComputeInitialGuess()`, `SNESGetFunction()`, `KSPComputeRHSFn`, `KSPComputeOperatorsFn`
1378: S*/
1379: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode KSPComputeInitialGuessFn(KSP ksp, Vec x, PetscCtx ctx);
1381: PETSC_EXTERN PetscErrorCode KSPSetComputeInitialGuess(KSP, KSPComputeInitialGuessFn *, void *);
1382: PETSC_EXTERN PetscErrorCode DMKSPSetComputeOperators(DM, KSPComputeOperatorsFn *, void *);
1383: PETSC_EXTERN PetscErrorCode DMKSPGetComputeOperators(DM, KSPComputeOperatorsFn **, void *);
1384: PETSC_EXTERN PetscErrorCode DMKSPSetCreateOperators(DM, KSPCreateOperatorsFn *, void *);
1385: PETSC_EXTERN PetscErrorCode DMKSPGetCreateOperators(DM, KSPCreateOperatorsFn **, void *);
1386: PETSC_EXTERN PetscErrorCode DMKSPSetComputeRHS(DM, KSPComputeRHSFn *, void *);
1387: PETSC_EXTERN PetscErrorCode DMKSPGetComputeRHS(DM, KSPComputeRHSFn **, void *);
1388: PETSC_EXTERN PetscErrorCode DMKSPSetComputeInitialGuess(DM, KSPComputeInitialGuessFn *, void *);
1389: PETSC_EXTERN PetscErrorCode DMKSPGetComputeInitialGuess(DM, KSPComputeInitialGuessFn **, void *);
1391: PETSC_EXTERN PetscErrorCode DMGlobalToLocalSolve(DM, Vec, Vec);
1392: PETSC_EXTERN PetscErrorCode DMSwarmProjectFields(DM, DM, PetscInt, const char *[], Vec[], ScatterMode);
1393: PETSC_EXTERN PetscErrorCode DMSwarmProjectGradientFields(DM, DM, PetscInt, const char *[], Vec[], ScatterMode);
1395: PETSC_EXTERN PetscErrorCode DMAdaptInterpolator(DM, DM, Mat, KSP, Mat, Mat, Mat *, void *);
1396: PETSC_EXTERN PetscErrorCode DMCheckInterpolator(DM, Mat, Mat, Mat, PetscReal);
1398: PETSC_EXTERN PetscErrorCode PCBJKOKKOSSetKSP(PC, KSP);
1399: PETSC_EXTERN PetscErrorCode PCBJKOKKOSGetKSP(PC, KSP *);
1401: PETSC_EXTERN PetscErrorCode DMCopyDMKSP(DM, DM);
1403: #include <petscdstypes.h>
1404: PETSC_EXTERN PetscErrorCode DMProjectField(DM, PetscReal, Vec, PetscPointFn **, InsertMode, Vec);