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"
94: #define KSPEKSM "eksm"
96: /* Logging support */
97: PETSC_EXTERN PetscClassId KSP_CLASSID;
98: PETSC_EXTERN PetscClassId KSPGUESS_CLASSID;
99: PETSC_EXTERN PetscClassId DMKSP_CLASSID;
101: PETSC_EXTERN PetscErrorCode KSPCreate(MPI_Comm, KSP *);
102: PETSC_EXTERN PetscErrorCode KSPSetType(KSP, KSPType);
103: PETSC_EXTERN PetscErrorCode KSPGetType(KSP, KSPType *);
104: PETSC_EXTERN PetscErrorCode KSPSetUp(KSP);
105: PETSC_EXTERN PetscErrorCode KSPSetUpOnBlocks(KSP);
106: PETSC_EXTERN PetscErrorCode KSPSolve(KSP, Vec, Vec);
107: PETSC_EXTERN PetscErrorCode KSPSolveTranspose(KSP, Vec, Vec);
108: PETSC_EXTERN PetscErrorCode KSPSetUseExplicitTranspose(KSP, PetscBool);
109: PETSC_EXTERN PetscErrorCode KSPMatSolve(KSP, Mat, Mat);
110: PETSC_EXTERN PetscErrorCode KSPMatSolveTranspose(KSP, Mat, Mat);
111: PETSC_EXTERN PetscErrorCode KSPSetMatSolveBatchSize(KSP, PetscInt);
112: PETSC_DEPRECATED_FUNCTION(3, 15, 0, "KSPSetMatSolveBatchSize()", ) static inline PetscErrorCode KSPSetMatSolveBlockSize(KSP ksp, PetscInt n)
113: {
114: return KSPSetMatSolveBatchSize(ksp, n);
115: }
116: PETSC_EXTERN PetscErrorCode KSPGetMatSolveBatchSize(KSP, PetscInt *);
117: PETSC_DEPRECATED_FUNCTION(3, 15, 0, "KSPGetMatSolveBatchSize()", ) static inline PetscErrorCode KSPGetMatSolveBlockSize(KSP ksp, PetscInt *n)
118: {
119: return KSPGetMatSolveBatchSize(ksp, n);
120: }
121: PETSC_EXTERN PetscErrorCode KSPReset(KSP);
122: PETSC_EXTERN PetscErrorCode KSPResetViewers(KSP);
123: PETSC_EXTERN PetscErrorCode KSPDestroy(KSP *);
124: PETSC_EXTERN PetscErrorCode KSPSetReusePreconditioner(KSP, PetscBool);
125: PETSC_EXTERN PetscErrorCode KSPGetReusePreconditioner(KSP, PetscBool *);
126: PETSC_EXTERN PetscErrorCode KSPSetSkipPCSetFromOptions(KSP, PetscBool);
127: PETSC_EXTERN PetscErrorCode KSPCheckSolve(KSP, PC, Vec);
128: PETSC_EXTERN PetscErrorCode KSPCheckMatSolve(KSP, PC, Mat);
130: PETSC_EXTERN PetscFunctionList KSPList;
131: PETSC_EXTERN PetscFunctionList KSPGuessList;
132: PETSC_EXTERN PetscFunctionList KSPMonitorList;
133: PETSC_EXTERN PetscFunctionList KSPMonitorCreateList;
134: PETSC_EXTERN PetscFunctionList KSPMonitorDestroyList;
135: PETSC_EXTERN PetscErrorCode KSPRegister(const char[], PetscErrorCode (*)(KSP));
137: /*S
138: KSPMonitorRegisterFn - A function prototype for functions provided to `KSPMonitorRegister()`
140: Calling Sequence:
141: + ksp - iterative solver obtained from `KSPCreate()`
142: . it - iteration number
143: . rnorm - (estimated) 2-norm of (preconditioned) residual
144: - ctx - `PetscViewerAndFormat` object
146: Level: beginner
148: Note:
149: This is a `KSPMonitorFn` specialized for a context of `PetscViewerAndFormat`
151: .seealso: [](ch_snes), `KSP`, `KSPMonitorSet()`, `KSPMonitorRegister()`, `KSPMonitorFn`, `KSPMonitorRegisterCreateFn`, `KSPMonitorRegisterDestroyFn`
152: S*/
153: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode KSPMonitorRegisterFn(KSP ksp, PetscInt it, PetscReal rnorm, PetscViewerAndFormat *ctx);
155: /*S
156: KSPMonitorRegisterCreateFn - A function prototype for functions that do the creation when provided to `KSPMonitorRegister()`
158: Calling Sequence:
159: + viewer - the viewer to be used with the `KSPMonitorRegisterFn`
160: . format - the format of the viewer
161: . ctx - a context for the monitor
162: - result - a `PetscViewerAndFormat` object
164: Level: beginner
166: .seealso: [](ch_snes), `KSPMonitorRegisterFn`, `KSP`, `KSPMonitorSet()`, `KSPMonitorRegister()`, `KSPMonitorFn`, `KSPMonitorRegisterDestroyFn`
167: S*/
168: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode KSPMonitorRegisterCreateFn(PetscViewer viewer, PetscViewerFormat format, PetscCtx ctx, PetscViewerAndFormat **result);
170: /*S
171: KSPMonitorRegisterDestroyFn - A function prototype for functions that do the after use destruction when provided to `KSPMonitorRegister()`
173: Calling Sequence:
174: . vf - a `PetscViewerAndFormat` object to be destroyed, including any context
176: Level: beginner
178: .seealso: [](ch_snes), `KSPMonitorRegisterFn`, `KSP`, `KSPMonitorSet()`, `KSPMonitorRegister()`, `KSPMonitorFn`, `KSPMonitorRegisterCreateFn`
179: S*/
180: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode KSPMonitorRegisterDestroyFn(PetscViewerAndFormat **result);
182: PETSC_EXTERN PetscErrorCode KSPMonitorRegister(const char[], PetscViewerType, PetscViewerFormat, KSPMonitorRegisterFn *, KSPMonitorRegisterCreateFn *, KSPMonitorRegisterDestroyFn *);
184: PETSC_EXTERN PetscErrorCode KSPSetPCSide(KSP, PCSide);
185: PETSC_EXTERN PetscErrorCode KSPGetPCSide(KSP, PCSide *);
186: PETSC_EXTERN PetscErrorCode KSPSetTolerances(KSP, PetscReal, PetscReal, PetscReal, PetscInt);
187: PETSC_EXTERN PetscErrorCode KSPGetTolerances(KSP, PetscReal *, PetscReal *, PetscReal *, PetscInt *);
188: PETSC_EXTERN PetscErrorCode KSPSetMinimumIterations(KSP, PetscInt);
189: PETSC_EXTERN PetscErrorCode KSPGetMinimumIterations(KSP, PetscInt *);
190: PETSC_EXTERN PetscErrorCode KSPSetInitialGuessNonzero(KSP, PetscBool);
191: PETSC_EXTERN PetscErrorCode KSPGetInitialGuessNonzero(KSP, PetscBool *);
192: PETSC_EXTERN PetscErrorCode KSPSetErrorIfNotConverged(KSP, PetscBool);
193: PETSC_EXTERN PetscErrorCode KSPGetErrorIfNotConverged(KSP, PetscBool *);
194: PETSC_EXTERN PetscErrorCode KSPSetComputeEigenvalues(KSP, PetscBool);
195: PETSC_EXTERN PetscErrorCode KSPSetComputeRitz(KSP, PetscBool);
196: PETSC_EXTERN PetscErrorCode KSPGetComputeEigenvalues(KSP, PetscBool *);
197: PETSC_EXTERN PetscErrorCode KSPSetComputeSingularValues(KSP, PetscBool);
198: PETSC_EXTERN PetscErrorCode KSPGetComputeSingularValues(KSP, PetscBool *);
199: PETSC_EXTERN PetscErrorCode KSPGetRhs(KSP, Vec *);
200: PETSC_EXTERN PetscErrorCode KSPGetSolution(KSP, Vec *);
201: PETSC_EXTERN PetscErrorCode KSPGetResidualNorm(KSP, PetscReal *);
202: PETSC_EXTERN PetscErrorCode KSPGetIterationNumber(KSP, PetscInt *);
203: PETSC_EXTERN PetscErrorCode KSPGetTotalIterations(KSP, PetscInt *);
204: PETSC_EXTERN PetscErrorCode KSPCreateVecs(KSP, PetscInt, Vec **, PetscInt, Vec **);
205: PETSC_DEPRECATED_FUNCTION(3, 6, 0, "KSPCreateVecs()", ) static inline PetscErrorCode KSPGetVecs(KSP ksp, PetscInt n, Vec **x, PetscInt m, Vec **y)
206: {
207: return KSPCreateVecs(ksp, n, x, m, y);
208: }
210: /*S
211: KSPPSolveFn - A function prototype for functions provided to `KSPSetPreSolve()` and `KSPSetPostSolve()`
213: Calling Sequence:
214: + ksp - the `KSP` context
215: . rhs - the right-hand side vector
216: . x - the solution vector
217: - ctx - optional context that was provided with `KSPSetPreSolve()` or `KSPSetPostSolve()`
219: Level: intermediate
221: .seealso: [](ch_snes), `KSP`, `KSPSetPreSolve()`, `KSPSetPostSolve()`, `PCShellPSolveFn`
222: S*/
223: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode KSPPSolveFn(KSP ksp, Vec rhs, Vec x, PetscCtx ctx);
225: PETSC_EXTERN PetscErrorCode KSPSetPreSolve(KSP, KSPPSolveFn *, PetscCtx);
226: PETSC_EXTERN PetscErrorCode KSPSetPostSolve(KSP, KSPPSolveFn *, PetscCtx);
227: PETSC_EXTERN PetscErrorCode KSPPreSolve(KSP, Vec, Vec);
228: PETSC_EXTERN PetscErrorCode KSPPostSolve(KSP, Vec, Vec);
230: PETSC_EXTERN PetscErrorCode KSPSetPC(KSP, PC);
231: PETSC_EXTERN PetscErrorCode KSPGetPC(KSP, PC *);
232: PETSC_EXTERN PetscErrorCode KSPSetNestLevel(KSP, PetscInt);
233: PETSC_EXTERN PetscErrorCode KSPGetNestLevel(KSP, PetscInt *);
235: /*S
236: KSPMonitorFn - A function prototype for functions provided to `KSPMonitorSet()`
238: Calling Sequence:
239: + ksp - iterative solver obtained from `KSPCreate()`
240: . it - iteration number
241: . rnorm - (estimated) 2-norm of (preconditioned) residual
242: - ctx - optional monitoring context, as provided with `KSPMonitorSet()`
244: Level: beginner
246: .seealso: [](ch_snes), `KSP`, `KSPMonitorSet()`
247: S*/
248: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode KSPMonitorFn(KSP ksp, PetscInt it, PetscReal rnorm, PetscCtx ctx);
250: PETSC_EXTERN PetscErrorCode KSPMonitor(KSP, PetscInt, PetscReal);
251: PETSC_EXTERN PetscErrorCode KSPMonitorSet(KSP, KSPMonitorFn *, PetscCtx, PetscCtxDestroyFn *);
252: PETSC_EXTERN PetscErrorCode KSPMonitorCancel(KSP);
253: PETSC_EXTERN PetscErrorCode KSPGetMonitorContext(KSP, PetscCtxRt);
254: PETSC_EXTERN PetscErrorCode KSPGetResidualHistory(KSP, const PetscReal *[], PetscInt *);
255: PETSC_EXTERN PetscErrorCode KSPSetResidualHistory(KSP, PetscReal[], PetscCount, PetscBool);
256: PETSC_EXTERN PetscErrorCode KSPGetErrorHistory(KSP, const PetscReal *[], PetscInt *);
257: PETSC_EXTERN PetscErrorCode KSPSetErrorHistory(KSP, PetscReal[], PetscCount, PetscBool);
259: PETSC_EXTERN PetscErrorCode KSPBuildSolutionDefault(KSP, Vec, Vec *);
260: PETSC_EXTERN PetscErrorCode KSPBuildResidualDefault(KSP, Vec, Vec, Vec *);
261: PETSC_EXTERN PetscErrorCode KSPDestroyDefault(KSP);
262: PETSC_EXTERN PetscErrorCode KSPSetWorkVecs(KSP, PetscInt);
264: PETSC_EXTERN PetscErrorCode PCKSPGetKSP(PC, KSP *);
265: PETSC_EXTERN PetscErrorCode PCKSPSetKSP(PC, KSP);
266: PETSC_EXTERN PetscErrorCode PCBJacobiGetSubKSP(PC, PetscInt *, PetscInt *, KSP *[]);
267: PETSC_EXTERN PetscErrorCode PCASMGetSubKSP(PC, PetscInt *, PetscInt *, KSP *[]);
268: PETSC_EXTERN PetscErrorCode PCGASMGetSubKSP(PC, PetscInt *, PetscInt *, KSP *[]);
269: PETSC_EXTERN PetscErrorCode PCPatchGetSubKSP(PC, PetscInt *, KSP *[]);
270: PETSC_EXTERN PetscErrorCode PCFieldSplitGetSubKSP(PC, PetscInt *, KSP *[]);
271: PETSC_EXTERN PetscErrorCode PCFieldSplitSchurGetSubKSP(PC, PetscInt *, KSP *[]);
272: PETSC_EXTERN PetscErrorCode PCMGGetSmoother(PC, PetscInt, KSP *);
273: PETSC_EXTERN PetscErrorCode PCMGGetSmootherDown(PC, PetscInt, KSP *);
274: PETSC_EXTERN PetscErrorCode PCMGGetSmootherUp(PC, PetscInt, KSP *);
275: PETSC_EXTERN PetscErrorCode PCMGGetCoarseSolve(PC, KSP *);
276: PETSC_EXTERN PetscErrorCode PCGalerkinGetKSP(PC, KSP *);
277: PETSC_EXTERN PetscErrorCode PCDeflationGetCoarseKSP(PC, KSP *);
279: /*S
280: PCMGCoarseSpaceConstructorFn - A function prototype for functions registered with `PCMGRegisterCoarseSpaceConstructor()`
282: Calling Sequence:
283: + pc - The `PC` object
284: . l - The multigrid level, 0 is the coarse level
285: . dm - The `DM` for this level
286: . smooth - The level smoother
287: . Nc - The size of the coarse space
288: . initGuess - Basis for an initial guess for the space
289: - coarseSp - A basis for the computed coarse space
291: Level: beginner
293: .seealso: [](ch_ksp), `PCMGRegisterCoarseSpaceConstructor()`, `PCMGGetCoarseSpaceConstructor()`
294: S*/
295: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode PCMGCoarseSpaceConstructorFn(PC pc, PetscInt l, DM dm, KSP smooth, PetscInt Nc, Mat initGuess, Mat *coarseSp);
297: PETSC_EXTERN PetscFunctionList PCMGCoarseList;
298: PETSC_EXTERN PetscErrorCode PCMGRegisterCoarseSpaceConstructor(const char[], PCMGCoarseSpaceConstructorFn *);
299: PETSC_EXTERN PetscErrorCode PCMGGetCoarseSpaceConstructor(const char[], PCMGCoarseSpaceConstructorFn **);
301: PETSC_EXTERN PetscErrorCode KSPBuildSolution(KSP, Vec, Vec *);
302: PETSC_EXTERN PetscErrorCode KSPBuildResidual(KSP, Vec, Vec, Vec *);
304: /*E
305: KSPChebyshevKind - Which kind of Chebyshev polynomial to use with `KSPCHEBYSHEV`
307: Values:
308: + `KSP_CHEBYSHEV_FIRST` - "classic" first-kind Chebyshev polynomial
309: . `KSP_CHEBYSHEV_FOURTH` - fourth-kind Chebyshev polynomial
310: - `KSP_CHEBYSHEV_OPT_FOURTH` - optimized fourth-kind Chebyshev polynomial
312: Level: intermediate
314: .seealso: [](ch_ksp), `KSPCHEBYSHEV`, `KSPChebyshevSetKind()`, `KSPChebyshevGetKind()`
315: E*/
316: typedef enum {
317: KSP_CHEBYSHEV_FIRST,
318: KSP_CHEBYSHEV_FOURTH,
319: KSP_CHEBYSHEV_OPT_FOURTH
320: } KSPChebyshevKind;
322: PETSC_EXTERN PetscErrorCode KSPRichardsonSetScale(KSP, PetscReal);
323: PETSC_EXTERN PetscErrorCode KSPRichardsonSetSelfScale(KSP, PetscBool);
324: PETSC_EXTERN PetscErrorCode KSPChebyshevSetEigenvalues(KSP, PetscReal, PetscReal);
325: PETSC_EXTERN PetscErrorCode KSPChebyshevEstEigSet(KSP, PetscReal, PetscReal, PetscReal, PetscReal);
326: PETSC_EXTERN PetscErrorCode KSPChebyshevEstEigSetUseNoisy(KSP, PetscBool);
327: PETSC_EXTERN PetscErrorCode KSPChebyshevSetKind(KSP, KSPChebyshevKind);
328: PETSC_EXTERN PetscErrorCode KSPChebyshevGetKind(KSP, KSPChebyshevKind *);
329: PETSC_EXTERN PetscErrorCode KSPChebyshevEstEigGetKSP(KSP, KSP *);
330: PETSC_EXTERN PetscErrorCode KSPComputeExtremeSingularValues(KSP, PetscReal *, PetscReal *);
331: PETSC_EXTERN PetscErrorCode KSPComputeEigenvalues(KSP, PetscInt, PetscReal[], PetscReal[], PetscInt *);
332: PETSC_EXTERN PetscErrorCode KSPComputeEigenvaluesExplicitly(KSP, PetscInt, PetscReal[], PetscReal[]);
333: PETSC_EXTERN PetscErrorCode KSPComputeRitz(KSP, PetscBool, PetscBool, PetscInt *, Vec[], PetscReal[], PetscReal[]);
335: /*E
336: KSPFCDTruncationType - Define how stored directions are used to orthogonalize in flexible conjugate directions (FCD) methods
338: Values:
339: + `KSP_FCD_TRUNC_TYPE_STANDARD` - uses all (up to `mmax`) stored directions
340: - `KSP_FCD_TRUNC_TYPE_NOTAY` - uses the last `max(1,mod(i,mmax))` stored directions at iteration i = 0, 1, ...
342: Level: intermediate
344: Note:
345: Function such as `KSPFCGSetMmax()`, `KSPPIPEGCRSetNMax()`, `KSPPIPEGCRSetNMax()`, and `KSPPIPEFCGSetNMax()` may be
346: used to provide `nmax` or they may be provided with the option database.
348: .seealso: [](ch_ksp), `KSP`, `KSPFCG`, `KSPPIPEFCG`, `KSPPIPEGCR`, `KSPFCGSetTruncationType()`, `KSPFCGGetTruncationType()`,
349: `KSPPIPEGCRSetTruncationType()`, `KSPPIPEGCRGetTruncationType()`,
350: `KSPFCGSetMmax()`, `KSPPIPEGCRSetNMax()`, `KSPPIPEGCRGetNMax()`, `KSPPIPEFCGGetNMax()`
351: E*/
352: typedef enum {
353: KSP_FCD_TRUNC_TYPE_STANDARD,
354: KSP_FCD_TRUNC_TYPE_NOTAY
355: } KSPFCDTruncationType;
356: PETSC_EXTERN const char *const KSPFCDTruncationTypes[];
358: PETSC_EXTERN PetscErrorCode KSPFCGSetMmax(KSP, PetscInt);
359: PETSC_EXTERN PetscErrorCode KSPFCGGetMmax(KSP, PetscInt *);
360: PETSC_EXTERN PetscErrorCode KSPFCGSetNprealloc(KSP, PetscInt);
361: PETSC_EXTERN PetscErrorCode KSPFCGGetNprealloc(KSP, PetscInt *);
362: PETSC_EXTERN PetscErrorCode KSPFCGSetTruncationType(KSP, KSPFCDTruncationType);
363: PETSC_EXTERN PetscErrorCode KSPFCGGetTruncationType(KSP, KSPFCDTruncationType *);
365: PETSC_EXTERN PetscErrorCode KSPPIPEFCGSetMmax(KSP, PetscInt);
366: PETSC_EXTERN PetscErrorCode KSPPIPEFCGGetMmax(KSP, PetscInt *);
367: PETSC_EXTERN PetscErrorCode KSPPIPEFCGSetNprealloc(KSP, PetscInt);
368: PETSC_EXTERN PetscErrorCode KSPPIPEFCGGetNprealloc(KSP, PetscInt *);
369: PETSC_EXTERN PetscErrorCode KSPPIPEFCGSetTruncationType(KSP, KSPFCDTruncationType);
370: PETSC_EXTERN PetscErrorCode KSPPIPEFCGGetTruncationType(KSP, KSPFCDTruncationType *);
372: PETSC_EXTERN PetscErrorCode KSPPIPEGCRSetMmax(KSP, PetscInt);
373: PETSC_EXTERN PetscErrorCode KSPPIPEGCRGetMmax(KSP, PetscInt *);
374: PETSC_EXTERN PetscErrorCode KSPPIPEGCRSetNprealloc(KSP, PetscInt);
375: PETSC_EXTERN PetscErrorCode KSPPIPEGCRGetNprealloc(KSP, PetscInt *);
376: PETSC_EXTERN PetscErrorCode KSPPIPEGCRSetTruncationType(KSP, KSPFCDTruncationType);
377: PETSC_EXTERN PetscErrorCode KSPPIPEGCRGetTruncationType(KSP, KSPFCDTruncationType *);
378: PETSC_EXTERN PetscErrorCode KSPPIPEGCRSetUnrollW(KSP, PetscBool);
379: PETSC_EXTERN PetscErrorCode KSPPIPEGCRGetUnrollW(KSP, PetscBool *);
381: /*S
382: KSPFlexibleModifyPCFn - A prototype of a function used to modify the preconditioner during the use of flexible `KSP` methods, such as `KSPFGMRES`
384: Calling Sequence:
385: + ksp - the `KSP` context being used.
386: . total_its - the total number of iterations that have occurred.
387: . local_its - the number of iterations since last restart if applicable
388: . res_norm - the current residual norm
389: - ctx - optional context variable set with `KSPFlexibleSetModifyPC()`
391: Level: beginner
393: .seealso: [](ch_ksp), `KSP`, `KSPFlexibleSetModifyPC()`
394: S*/
395: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode KSPFlexibleModifyPCFn(KSP ksp, PetscInt total_its, PetscInt local_its, PetscReal res_norm, PetscCtx ctx);
397: PETSC_EXTERN PetscErrorCode KSPFlexibleSetModifyPC(KSP, KSPFlexibleModifyPCFn *, PetscCtx, PetscCtxDestroyFn *);
399: PETSC_DEPRECATED_FUNCTION(3, 25, 0, "KSPFlexibleSetModifyPC()", ) static inline PetscErrorCode KSPPIPEGCRSetModifyPC(KSP ksp, KSPFlexibleModifyPCFn *fun, PetscCtx ctx, PetscCtxDestroyFn *dfun)
400: {
401: return KSPFlexibleSetModifyPC(ksp, fun, ctx, dfun);
402: }
404: PETSC_EXTERN PetscErrorCode KSPGMRESSetRestart(KSP, PetscInt);
405: PETSC_EXTERN PetscErrorCode KSPGMRESGetRestart(KSP, PetscInt *);
406: PETSC_EXTERN PetscErrorCode KSPGMRESSetHapTol(KSP, PetscReal);
407: PETSC_EXTERN PetscErrorCode KSPGMRESSetBreakdownTolerance(KSP, PetscReal);
409: PETSC_EXTERN PetscErrorCode KSPGMRESSetPreAllocateVectors(KSP);
411: PETSC_EXTERN PetscErrorCode KSPLGMRESSetAugDim(KSP, PetscInt);
412: PETSC_EXTERN PetscErrorCode KSPLGMRESSetConstant(KSP);
414: PETSC_EXTERN PetscErrorCode KSPPIPEFGMRESSetShift(KSP, PetscScalar);
416: PETSC_EXTERN PetscErrorCode KSPGCRSetRestart(KSP, PetscInt);
417: PETSC_EXTERN PetscErrorCode KSPGCRGetRestart(KSP, PetscInt *);
419: PETSC_EXTERN PetscErrorCode KSPIDRSetS(KSP, PetscInt);
420: PETSC_EXTERN PetscErrorCode KSPIDRGetS(KSP, PetscInt *);
421: PETSC_EXTERN PetscErrorCode KSPIDRSetCosine(KSP, PetscReal);
422: PETSC_EXTERN PetscErrorCode KSPIDRGetCosine(KSP, PetscReal *);
423: PETSC_EXTERN PetscErrorCode KSPIDRSetRandom(KSP, PetscRandom);
424: PETSC_EXTERN PetscErrorCode KSPIDRGetRandom(KSP, PetscRandom *);
426: PETSC_EXTERN PetscErrorCode KSPEKSMSetHapTol(KSP, PetscReal);
427: PETSC_EXTERN PetscErrorCode KSPEKSMGetHapTol(KSP, PetscReal *);
428: PETSC_EXTERN PetscErrorCode KSPEKSMSetKSP(KSP, KSP, KSP);
429: PETSC_EXTERN PetscErrorCode KSPEKSMGetKSP(KSP, KSP *, KSP *);
430: PETSC_EXTERN PetscErrorCode KSPEKSMSetShift(KSP, PetscScalar);
431: PETSC_EXTERN PetscErrorCode KSPEKSMGetShift(KSP, PetscScalar *);
433: PETSC_DEPRECATED_FUNCTION(3, 25, 0, "KSPFlexibleSetModifyPC()", ) static inline PetscErrorCode KSPGCRSetModifyPC(KSP ksp, KSPFlexibleModifyPCFn *fun, PetscCtx ctx, PetscCtxDestroyFn *dfun)
434: {
435: return KSPFlexibleSetModifyPC(ksp, fun, ctx, dfun);
436: }
438: PETSC_EXTERN PetscErrorCode KSPMINRESSetRadius(KSP, PetscReal);
439: PETSC_EXTERN PetscErrorCode KSPMINRESGetUseQLP(KSP, PetscBool *);
440: PETSC_EXTERN PetscErrorCode KSPMINRESSetUseQLP(KSP, PetscBool);
442: PETSC_EXTERN PetscErrorCode KSPFETIDPGetInnerBDDC(KSP, PC *);
443: PETSC_EXTERN PetscErrorCode KSPFETIDPSetInnerBDDC(KSP, PC);
444: PETSC_EXTERN PetscErrorCode KSPFETIDPGetInnerKSP(KSP, KSP *);
445: PETSC_EXTERN PetscErrorCode KSPFETIDPSetPressureOperator(KSP, Mat);
447: PETSC_EXTERN PetscErrorCode KSPHPDDMSetDeflationMat(KSP, Mat);
448: PETSC_EXTERN PetscErrorCode KSPHPDDMGetDeflationMat(KSP, Mat *);
449: #if PetscDefined(HAVE_HPDDM)
450: PETSC_DEPRECATED_FUNCTION(3, 18, 0, "KSPHPDDMSetDeflationMat()", ) static inline PetscErrorCode KSPHPDDMSetDeflationSpace(KSP ksp, Mat U)
451: {
452: return KSPHPDDMSetDeflationMat(ksp, U);
453: }
454: PETSC_DEPRECATED_FUNCTION(3, 18, 0, "KSPHPDDMGetDeflationMat()", ) static inline PetscErrorCode KSPHPDDMGetDeflationSpace(KSP ksp, Mat *U)
455: {
456: return KSPHPDDMGetDeflationMat(ksp, U);
457: }
458: #endif
459: PETSC_DEPRECATED_FUNCTION(3, 14, 0, "KSPMatSolve()", ) static inline PetscErrorCode KSPHPDDMMatSolve(KSP ksp, Mat B, Mat X)
460: {
461: return KSPMatSolve(ksp, B, X);
462: }
463: /*E
464: KSPHPDDMType - Type of Krylov method used by `KSPHPDDM`
466: Values:
467: + `KSP_HPDDM_TYPE_GMRES` (default) - Generalized Minimal Residual method
468: . `KSP_HPDDM_TYPE_BGMRES` - block GMRES
469: . `KSP_HPDDM_TYPE_CG` - Conjugate Gradient
470: . `KSP_HPDDM_TYPE_BCG` - block CG
471: . `KSP_HPDDM_TYPE_GCRODR` - Generalized Conjugate Residual method with inner Orthogonalization and Deflated Restarting
472: . `KSP_HPDDM_TYPE_BGCRODR` - block GCRODR
473: . `KSP_HPDDM_TYPE_BFBCG` - breakdown-free BCG
474: - `KSP_HPDDM_TYPE_PREONLY` - apply the preconditioner only
476: Level: intermediate
478: .seealso: [](ch_ksp), `KSPHPDDM`, `KSPHPDDMSetType()`
479: E*/
480: typedef enum {
481: KSP_HPDDM_TYPE_GMRES = 0,
482: KSP_HPDDM_TYPE_BGMRES = 1,
483: KSP_HPDDM_TYPE_CG = 2,
484: KSP_HPDDM_TYPE_BCG = 3,
485: KSP_HPDDM_TYPE_GCRODR = 4,
486: KSP_HPDDM_TYPE_BGCRODR = 5,
487: KSP_HPDDM_TYPE_BFBCG = 6,
488: KSP_HPDDM_TYPE_PREONLY = 7
489: } KSPHPDDMType;
490: PETSC_EXTERN const char *const KSPHPDDMTypes[];
492: PETSC_EXTERN PetscErrorCode KSPHPDDMSetType(KSP, KSPHPDDMType);
493: PETSC_EXTERN PetscErrorCode KSPHPDDMGetType(KSP, KSPHPDDMType *);
495: /*S
496: KSPOrthogonalizationFn - A function prototype for functions provided to `KSPOrthogonalizationSet()`
498: Calling Sequence:
499: + ksp - the `KSP` context
500: . V - array of previously computed orthonormal vectors
501: . n - number of vectors
502: . x - vector to be orthogonalized (may be `NULL`)
503: - h - computed orthogonalization coefficients
505: Level: intermediate
507: Note:
508: If no `x` is given, then the vector to be orthogonalized is assumed to be located at `V[n]`.
510: .seealso: [](ch_ksp), `KSP`, `KSPOrthogonalizationSet()`
511: S*/
512: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode KSPOrthogonalizationFn(KSP ksp, Vec V[], PetscInt n, Vec x, PetscScalar h[]);
514: PETSC_EXTERN PetscErrorCode KSPOrthogonalizationSet(KSP, KSPOrthogonalizationFn *);
515: PETSC_EXTERN PetscErrorCode KSPOrthogonalizationGet(KSP, KSPOrthogonalizationFn **);
516: PETSC_EXTERN KSPOrthogonalizationFn KSPOrthogonalizationClassicalGramSchmidt;
517: PETSC_EXTERN KSPOrthogonalizationFn KSPOrthogonalizationModifiedGramSchmidt;
519: #define KSP_GMRES_CGS_REFINE_NEVER_DEPRECATED KSP_GMRES_CGS_REFINE_NEVER PETSC_DEPRECATED_ENUM(3, 26, 0, "KSP_ORTHOGONALIZATION_CGS_REFINE_NEVER", )
520: #define KSP_GMRES_CGS_REFINE_IFNEEDED_DEPRECATED KSP_GMRES_CGS_REFINE_IFNEEDED PETSC_DEPRECATED_ENUM(3, 26, 0, "KSP_ORTHOGONALIZATION_CGS_REFINE_IFNEEDED", )
521: #define KSP_GMRES_CGS_REFINE_ALWAYS_DEPRECATED KSP_GMRES_CGS_REFINE_ALWAYS PETSC_DEPRECATED_ENUM(3, 26, 0, "KSP_ORTHOGONALIZATION_CGS_REFINE_ALWAYS", )
522: /*E
523: KSPOrthogonalizationCGSRefinementType - How the classical (unmodified) Gram-Schmidt is performed in the GMRES solvers
525: Values:
526: + `KSP_ORTHOGONALIZATION_CGS_REFINE_NEVER` - one step of classical Gram-Schmidt
527: . `KSP_ORTHOGONALIZATION_CGS_REFINE_IFNEEDED` - a second step is performed if the first step does not satisfy some criteria
528: - `KSP_ORTHOGONALIZATION_CGS_REFINE_ALWAYS` - always perform two steps
530: Level: advanced
532: .seealso: [](ch_ksp), `KSP`, `KSPGMRES`, `KSPOrthogonalizationClassicalGramSchmidt()`, `KSPOrthogonalizationSet()`,
533: `KSPOrthogonalizationGet()`,
534: `KSPOrthogonalizationSetCGSRefinementType()`, `KSPOrthogonalizationGetCGSRefinementType()`, `KSPOrthogonalizationModifiedGramSchmidt()`
535: E*/
536: typedef enum {
537: KSP_ORTHOGONALIZATION_CGS_REFINE_NEVER = 0,
538: KSP_ORTHOGONALIZATION_CGS_REFINE_IFNEEDED = 1,
539: KSP_ORTHOGONALIZATION_CGS_REFINE_ALWAYS = 2,
540: KSP_GMRES_CGS_REFINE_NEVER_DEPRECATED = 0,
541: KSP_GMRES_CGS_REFINE_IFNEEDED_DEPRECATED = 1,
542: KSP_GMRES_CGS_REFINE_ALWAYS_DEPRECATED = 2
543: } KSPOrthogonalizationCGSRefinementType;
544: PETSC_EXTERN const char *const KSPOrthogonalizationCGSRefinementTypes[];
546: /*MC
547: KSP_ORTHOGONALIZATION_CGS_REFINE_NEVER - Do the classical (unmodified) Gram-Schmidt process
549: Level: advanced
551: Note:
552: Possibly unstable, but the fastest to compute
554: .seealso: [](ch_ksp), `KSPGMRES`, `KSPOrthogonalizationCGSRefinementType`, `KSPOrthogonalizationClassicalGramSchmidt()`, `KSPOrthogonalizationSet()`,
555: `KSP`, `KSPOrthogonalizationGet()`,
556: `KSPOrthogonalizationSetCGSRefinementType()`, `KSPOrthogonalizationGetCGSRefinementType()`, `KSP_ORTHOGONALIZATION_CGS_REFINE_IFNEEDED`, `KSP_ORTHOGONALIZATION_CGS_REFINE_ALWAYS`,
557: `KSPOrthogonalizationModifiedGramSchmidt()`
558: M*/
560: /*MC
561: KSP_ORTHOGONALIZATION_CGS_REFINE_IFNEEDED - Do the classical (unmodified) Gram-Schmidt process and one step of
562: iterative refinement if an estimate of the orthogonality of the resulting vectors indicates
563: poor orthogonality.
565: Level: advanced
567: Note:
568: This is slower than `KSP_ORTHOGONALIZATION_CGS_REFINE_NEVER` because it requires an extra norm computation to
569: estimate the orthogonality but is more stable.
571: .seealso: [](ch_ksp), `KSPGMRES`, `KSPOrthogonalizationCGSRefinementType`, `KSPOrthogonalizationClassicalGramSchmidt()`, `KSPOrthogonalizationSet()`,
572: `KSP`, `KSPOrthogonalizationGet()`,
573: `KSPOrthogonalizationSetCGSRefinementType()`, `KSPOrthogonalizationGetCGSRefinementType()`, `KSP_ORTHOGONALIZATION_CGS_REFINE_NEVER`, `KSP_ORTHOGONALIZATION_CGS_REFINE_ALWAYS`,
574: `KSPOrthogonalizationModifiedGramSchmidt()`
575: M*/
577: /*MC
578: KSP_ORTHOGONALIZATION_CGS_REFINE_ALWAYS - Do two steps of the classical (unmodified) Gram-Schmidt process.
580: Level: advanced
582: Notes:
583: This is roughly twice the cost of `KSP_ORTHOGONALIZATION_CGS_REFINE_NEVER` because it performs the process twice
584: but it saves the extra norm calculation needed by `KSP_ORTHOGONALIZATION_CGS_REFINE_IFNEEDED`.
586: You should only use this if you absolutely know that the iterative refinement is needed.
588: .seealso: [](ch_ksp), `KSPGMRES`, `KSPOrthogonalizationCGSRefinementType`, `KSPOrthogonalizationClassicalGramSchmidt()`, `KSPOrthogonalizationSet()`,
589: `KSP`, `KSPOrthogonalizationGet()`,
590: `KSPOrthogonalizationSetCGSRefinementType()`, `KSPOrthogonalizationGetCGSRefinementType()`, `KSP_ORTHOGONALIZATION_CGS_REFINE_IFNEEDED`, `KSP_ORTHOGONALIZATION_CGS_REFINE_ALWAYS`,
591: `KSPOrthogonalizationModifiedGramSchmidt()`
592: M*/
594: PETSC_EXTERN PetscErrorCode KSPOrthogonalizationSetCGSRefinementType(KSP, KSPOrthogonalizationCGSRefinementType);
595: PETSC_EXTERN PetscErrorCode KSPOrthogonalizationGetCGSRefinementType(KSP, KSPOrthogonalizationCGSRefinementType *);
597: PETSC_DEPRECATED_FUNCTION(3, 26, 0, "KSPOrthogonalizationModifiedGramSchmidt()", ) static inline PetscErrorCode KSPGMRESModifiedGramSchmidtOrthogonalization(KSP ksp, PETSC_UNUSED PetscInt it)
598: {
599: SETERRQ(PetscObjectComm((PetscObject)ksp), PETSC_ERR_SUP, "Use KSPOrthogonalizationModifiedGramSchmidt()");
600: }
601: PETSC_DEPRECATED_FUNCTION(3, 26, 0, "KSPOrthogonalizationClassicalGramSchmidt()", ) static inline PetscErrorCode KSPGMRESClassicalGramSchmidtOrthogonalization(KSP ksp, PETSC_UNUSED PetscInt it)
602: {
603: SETERRQ(PetscObjectComm((PetscObject)ksp), PETSC_ERR_SUP, "Use KSPOrthogonalizationClassicalGramSchmidt()");
604: }
605: PETSC_DEPRECATED_FUNCTION(3, 26, 0, "KSPOrthogonalizationSet()", ) static inline PetscErrorCode KSPGMRESSetOrthogonalization(KSP ksp, PETSC_UNUSED PetscErrorCode (*orthog)(KSP, PetscInt))
606: {
607: SETERRQ(PetscObjectComm((PetscObject)ksp), PETSC_ERR_SUP, "Use KSPOrthogonalizationSet()");
608: }
609: PETSC_DEPRECATED_FUNCTION(3, 26, 0, "KSPOrthogonalizationGet()", ) static inline PetscErrorCode KSPGMRESGetOrthogonalization(KSP ksp, PETSC_UNUSED PetscErrorCode (**orthog)(KSP, PetscInt))
610: {
611: SETERRQ(PetscObjectComm((PetscObject)ksp), PETSC_ERR_SUP, "Use KSPOrthogonalizationGet()");
612: }
613: PETSC_DEPRECATED_TYPEDEF(3, 26, 0, "KSPOrthogonalizationCGSRefinementType", ) typedef KSPOrthogonalizationCGSRefinementType KSPGMRESCGSRefinementType;
614: PETSC_DEPRECATED_FUNCTION(3, 26, 0, "KSPOrthogonalizationSetCGSRefinementType()", )
615: static inline PetscErrorCode KSPGMRESSetCGSRefinementType(KSP ksp, KSPOrthogonalizationCGSRefinementType type)
616: {
617: return KSPOrthogonalizationSetCGSRefinementType(ksp, type);
618: }
619: PETSC_DEPRECATED_FUNCTION(3, 26, 0, "KSPOrthogonalizationGetCGSRefinementType()", )
620: static inline PetscErrorCode KSPGMRESGetCGSRefinementType(KSP ksp, KSPOrthogonalizationCGSRefinementType *type)
621: {
622: return KSPOrthogonalizationGetCGSRefinementType(ksp, type);
623: }
625: PETSC_EXTERN KSPFlexibleModifyPCFn KSPFlexibleModifyPCNoChange;
626: PETSC_EXTERN KSPFlexibleModifyPCFn KSPFlexibleModifyPCKSP;
628: PETSC_DEPRECATED_FUNCTION(3, 25, 0, "KSPFlexibleModifyPCNoChange()", ) static inline PetscErrorCode KSPFGMRESModifyPCNoChange(KSP ksp, PetscInt total_its, PetscInt loc_its, PetscReal res_norm, PetscCtx ctx)
629: {
630: return KSPFlexibleModifyPCNoChange(ksp, total_its, loc_its, res_norm, ctx);
631: }
633: PETSC_DEPRECATED_FUNCTION(3, 25, 0, "KSPFlexibleModifyPCKSP()", ) static inline PetscErrorCode KSPFGMRESModifyPCKSP(KSP ksp, PetscInt total_its, PetscInt loc_its, PetscReal res_norm, PetscCtx ctx)
634: {
635: return KSPFlexibleModifyPCKSP(ksp, total_its, loc_its, res_norm, ctx);
636: }
638: PETSC_EXTERN PetscErrorCode KSPQCGSetTrustRegionRadius(KSP, PetscReal);
639: PETSC_EXTERN PetscErrorCode KSPQCGGetQuadratic(KSP, PetscReal *);
640: PETSC_EXTERN PetscErrorCode KSPQCGGetTrialStepNorm(KSP, PetscReal *);
642: PETSC_EXTERN PetscErrorCode KSPBCGSLSetXRes(KSP, PetscReal);
643: PETSC_EXTERN PetscErrorCode KSPBCGSLSetPol(KSP, PetscBool);
644: PETSC_EXTERN PetscErrorCode KSPBCGSLSetEll(KSP, PetscInt);
645: PETSC_EXTERN PetscErrorCode KSPBCGSLSetUsePseudoinverse(KSP, PetscBool);
647: PETSC_EXTERN PetscErrorCode KSPSetFromOptions(KSP);
648: PETSC_EXTERN PetscErrorCode KSPResetFromOptions(KSP);
650: PETSC_EXTERN PetscErrorCode KSPMonitorSetFromOptions(KSP, const char[], const char[], PetscCtx);
651: PETSC_EXTERN KSPMonitorRegisterFn KSPMonitorResidual;
652: PETSC_EXTERN KSPMonitorRegisterFn KSPMonitorResidualView;
653: PETSC_DEPRECATED_FUNCTION(3, 23, 0, "KSPMonitorResidualDraw()", ) static inline PetscErrorCode KSPMonitorResidualDraw(KSP ksp, PetscInt n, PetscReal rnorm, PetscViewerAndFormat *vf)
654: {
655: return KSPMonitorResidualView(ksp, n, rnorm, vf);
656: }
657: PETSC_EXTERN KSPMonitorRegisterFn KSPMonitorResidualDrawLG;
658: PETSC_EXTERN PetscErrorCode KSPMonitorResidualDrawLGCreate(PetscViewer, PetscViewerFormat, PetscCtx, PetscViewerAndFormat **);
659: PETSC_DEPRECATED_FUNCTION(3, 26, 0, "KSPMonitorResidual()", ) static inline PetscErrorCode KSPMonitorResidualShort(KSP ksp, PetscInt n, PetscReal rnorm, PetscViewerAndFormat *vf)
660: {
661: return KSPMonitorResidual(ksp, n, rnorm, vf);
662: }
663: PETSC_EXTERN KSPMonitorRegisterFn KSPMonitorResidualRange;
664: PETSC_EXTERN KSPMonitorRegisterFn KSPMonitorTrueResidual;
665: PETSC_EXTERN KSPMonitorRegisterFn KSPMonitorTrueResidualView;
666: PETSC_DEPRECATED_FUNCTION(3, 23, 0, "KSPMonitorTrueResidualDraw()", ) static inline PetscErrorCode KSPMonitorTrueResidualDraw(KSP ksp, PetscInt n, PetscReal rnorm, PetscViewerAndFormat *vf)
667: {
668: return KSPMonitorTrueResidualView(ksp, n, rnorm, vf);
669: }
670: PETSC_EXTERN KSPMonitorRegisterFn KSPMonitorTrueResidualDrawLG;
671: PETSC_EXTERN PetscErrorCode KSPMonitorTrueResidualDrawLGCreate(PetscViewer, PetscViewerFormat, PetscCtx, PetscViewerAndFormat **);
672: PETSC_EXTERN KSPMonitorRegisterFn KSPMonitorTrueResidualMax;
673: PETSC_EXTERN KSPMonitorRegisterFn KSPMonitorError;
674: PETSC_EXTERN KSPMonitorRegisterFn KSPMonitorErrorDraw;
675: PETSC_EXTERN KSPMonitorRegisterFn KSPMonitorErrorDrawLG;
676: PETSC_EXTERN PetscErrorCode KSPMonitorErrorDrawLGCreate(PetscViewer, PetscViewerFormat, PetscCtx, PetscViewerAndFormat **);
677: PETSC_EXTERN KSPMonitorRegisterFn KSPMonitorSolution;
678: PETSC_EXTERN KSPMonitorRegisterFn KSPMonitorSolutionDraw;
679: PETSC_EXTERN KSPMonitorRegisterFn KSPMonitorSolutionDrawLG;
680: PETSC_EXTERN PetscErrorCode KSPMonitorSolutionDrawLGCreate(PetscViewer, PetscViewerFormat, PetscCtx, PetscViewerAndFormat **);
681: PETSC_EXTERN KSPMonitorRegisterFn KSPMonitorSingularValue;
682: PETSC_EXTERN PetscErrorCode KSPMonitorSingularValueCreate(PetscViewer, PetscViewerFormat, PetscCtx, PetscViewerAndFormat **);
683: PETSC_DEPRECATED_FUNCTION(3, 15, 0, "KSPMonitorResidual()", ) static inline PetscErrorCode KSPMonitorDefault(KSP ksp, PetscInt n, PetscReal rnorm, PetscViewerAndFormat *vf)
684: {
685: return KSPMonitorResidual(ksp, n, rnorm, vf);
686: }
687: PETSC_DEPRECATED_FUNCTION(3, 15, 0, "KSPMonitorTrueResidual()", ) static inline PetscErrorCode KSPMonitorTrueResidualNorm(KSP ksp, PetscInt n, PetscReal rnorm, PetscViewerAndFormat *vf)
688: {
689: return KSPMonitorTrueResidual(ksp, n, rnorm, vf);
690: }
691: PETSC_DEPRECATED_FUNCTION(3, 15, 0, "KSPMonitorTrueResidualMax()", ) static inline PetscErrorCode KSPMonitorTrueResidualMaxNorm(KSP ksp, PetscInt n, PetscReal rnorm, PetscViewerAndFormat *vf)
692: {
693: return KSPMonitorTrueResidualMax(ksp, n, rnorm, vf);
694: }
696: PETSC_EXTERN PetscErrorCode KSPGMRESMonitorKrylov(KSP, PetscInt, PetscReal, void *);
697: PETSC_EXTERN PetscErrorCode KSPMonitorDynamicTolerance(KSP, PetscInt, PetscReal, PetscCtx);
698: PETSC_EXTERN PetscErrorCode KSPMonitorDynamicToleranceDestroy(PetscCtxRt);
699: PETSC_EXTERN PetscErrorCode KSPMonitorDynamicToleranceCreate(void *);
700: PETSC_EXTERN PetscErrorCode KSPMonitorDynamicToleranceSetCoefficient(void *, PetscReal);
701: PETSC_EXTERN PetscErrorCode KSPMonitorSAWs(KSP, PetscInt, PetscReal, void *);
702: PETSC_EXTERN PetscErrorCode KSPMonitorSAWsCreate(KSP, void **);
703: PETSC_EXTERN PetscErrorCode KSPMonitorSAWsDestroy(PetscCtxRt);
705: PETSC_EXTERN PetscErrorCode KSPUnwindPreconditioner(KSP, Vec, Vec);
706: PETSC_EXTERN PetscErrorCode KSPInitialResidual(KSP, Vec, Vec, Vec, Vec, Vec);
708: PETSC_EXTERN PetscErrorCode KSPSetOperators(KSP, Mat, Mat);
709: PETSC_EXTERN PetscErrorCode KSPGetOperators(KSP, Mat *, Mat *);
710: PETSC_EXTERN PetscErrorCode KSPGetOperatorsSet(KSP, PetscBool *, PetscBool *);
711: PETSC_EXTERN PetscErrorCode KSPSetOptionsPrefix(KSP, const char[]);
712: PETSC_EXTERN PetscErrorCode KSPAppendOptionsPrefix(KSP, const char[]);
713: PETSC_EXTERN PetscErrorCode KSPGetOptionsPrefix(KSP, const char *[]);
715: /*S
716: KSPConvergedReasonViewFn - A prototype of a function used with `KSPConvergedReasonViewSet()`
718: Calling Sequence:
719: + ksp - the `KSP` object whose `KSPConvergedReason` is to be viewed
720: - ctx - context used by the function, set with `KSPConvergedReasonViewSet()`
722: Level: beginner
724: .seealso: [](ch_ksp), `KSP`, `KSPConvergedReasonView()`, `KSPConvergedReasonViewSet()`, `KSPConvergedReasonViewFromOptions()`, `KSPView()`
725: S*/
726: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode KSPConvergedReasonViewFn(KSP ksp, PetscCtx ctx);
728: PETSC_EXTERN PetscErrorCode KSPView(KSP, PetscViewer);
729: PETSC_EXTERN PetscErrorCode KSPLoad(KSP, PetscViewer);
730: PETSC_EXTERN PetscErrorCode KSPViewFromOptions(KSP, PetscObject, const char[]);
731: PETSC_EXTERN PetscErrorCode KSPConvergedReasonView(KSP, PetscViewer);
732: PETSC_EXTERN PetscErrorCode KSPConvergedReasonViewSet(KSP, KSPConvergedReasonViewFn *, void *, PetscCtxDestroyFn *);
733: PETSC_EXTERN PetscErrorCode KSPConvergedReasonViewFromOptions(KSP);
734: PETSC_EXTERN PetscErrorCode KSPConvergedReasonViewCancel(KSP);
735: PETSC_EXTERN PetscErrorCode KSPConvergedRateView(KSP, PetscViewer);
737: PETSC_DEPRECATED_FUNCTION(3, 14, 0, "KSPConvergedReasonView()", ) static inline PetscErrorCode KSPReasonView(KSP ksp, PetscViewer v)
738: {
739: return KSPConvergedReasonView(ksp, v);
740: }
741: PETSC_DEPRECATED_FUNCTION(3, 14, 0, "KSPConvergedReasonViewFromOptions()", ) static inline PetscErrorCode KSPReasonViewFromOptions(KSP ksp)
742: {
743: return KSPConvergedReasonViewFromOptions(ksp);
744: }
746: #define KSP_FILE_CLASSID 1211223
748: PETSC_EXTERN PetscErrorCode KSPLSQRSetExactMatNorm(KSP, PetscBool);
749: PETSC_EXTERN PetscErrorCode KSPLSQRSetComputeStandardErrorVec(KSP, PetscBool);
750: PETSC_EXTERN PetscErrorCode KSPLSQRGetStandardErrorVec(KSP, Vec *);
751: PETSC_EXTERN PetscErrorCode KSPLSQRGetNorms(KSP, PetscReal *, PetscReal *);
752: PETSC_EXTERN KSPMonitorRegisterFn KSPLSQRMonitorResidual;
753: PETSC_EXTERN KSPMonitorRegisterFn KSPLSQRMonitorResidualDrawLG;
754: PETSC_EXTERN PetscErrorCode KSPLSQRMonitorResidualDrawLGCreate(PetscViewer, PetscViewerFormat, void *, PetscViewerAndFormat **);
756: PETSC_EXTERN PetscErrorCode PCRedundantGetKSP(PC, KSP *);
757: PETSC_EXTERN PetscErrorCode PCRedistributeGetKSP(PC, KSP *);
758: PETSC_EXTERN PetscErrorCode PCTelescopeGetKSP(PC, KSP *);
759: PETSC_EXTERN PetscErrorCode PCMPIGetKSP(PC, KSP *);
761: /*E
762: KSPNormType - Norm calculated by the `KSP` and passed in the Krylov convergence
763: test routines.
765: Values:
766: + `KSP_NORM_DEFAULT` - use the default for the current `KSPType`
767: . `KSP_NORM_NONE` - use no norm calculation
768: . `KSP_NORM_PRECONDITIONED` - use the preconditioned residual norm
769: . `KSP_NORM_UNPRECONDITIONED` - use the unpreconditioned residual norm
770: - `KSP_NORM_NATURAL` - use the natural norm (the norm induced by the linear operator)
772: Level: advanced
774: Note:
775: Each solver only supports a subset of these and some may support different ones
776: depending on whether left or right preconditioning is used, see `KSPSetPCSide()`
778: .seealso: [](ch_ksp), `KSP`, `PCSide`, `KSPSolve()`, `KSPGetConvergedReason()`, `KSPSetNormType()`,
779: `KSPSetConvergenceTest()`, `KSPSetPCSide()`, `KSP_NORM_DEFAULT`, `KSP_NORM_NONE`, `KSP_NORM_PRECONDITIONED`, `KSP_NORM_UNPRECONDITIONED`, `KSP_NORM_NATURAL`
780: E*/
781: typedef enum {
782: KSP_NORM_DEFAULT = -1,
783: KSP_NORM_NONE = 0,
784: KSP_NORM_PRECONDITIONED = 1,
785: KSP_NORM_UNPRECONDITIONED = 2,
786: KSP_NORM_NATURAL = 3
787: } KSPNormType;
788: #define KSP_NORM_MAX (KSP_NORM_NATURAL + 1)
789: PETSC_EXTERN const char *const *const KSPNormTypes;
791: /*MC
792: KSP_NORM_NONE - Do not compute a norm during the Krylov process. This will
793: possibly save some computation but means the convergence test cannot
794: be based on a norm of a residual etc.
796: Level: advanced
798: Note:
799: Some Krylov methods need to compute a residual norm (such as `KPSGMRES`) and then this option is ignored
801: .seealso: [](ch_ksp), `KSPNormType`, `KSP`, `KSPSetNormType()`, `KSP_NORM_PRECONDITIONED`, `KSP_NORM_UNPRECONDITIONED`, `KSP_NORM_NATURAL`
802: M*/
804: /*MC
805: KSP_NORM_PRECONDITIONED - Compute the norm of the preconditioned residual B*(b - A*x), if left preconditioning, and pass that to the
806: convergence test routine.
808: Level: advanced
810: .seealso: [](ch_ksp), `KSPNormType`, `KSP`, `KSPSetNormType()`, `KSP_NORM_NONE`, `KSP_NORM_UNPRECONDITIONED`, `KSP_NORM_NATURAL`, `KSPSetConvergenceTest()`
811: M*/
813: /*MC
814: KSP_NORM_UNPRECONDITIONED - Compute the norm of the true residual (b - A*x) and pass that to the
815: convergence test routine.
817: Level: advanced
819: .seealso: [](ch_ksp), `KSPNormType`, `KSP`, `KSPSetNormType()`, `KSP_NORM_NONE`, `KSP_NORM_PRECONDITIONED`, `KSP_NORM_NATURAL`, `KSPSetConvergenceTest()`
820: M*/
822: /*MC
823: KSP_NORM_NATURAL - Compute the 'natural norm' of residual sqrt((b - A*x)*B*(b - A*x)) and pass that to the
824: convergence test routine. This is only supported by `KSPCG`, `KSPCR`, `KSPCGNE`, `KSPCGS`, `KSPFCG`, `KSPPIPEFCG`, `KSPPIPEGCR`
826: Level: advanced
828: .seealso: [](ch_ksp), `KSPNormType`, `KSP`, `KSPSetNormType()`, `KSP_NORM_NONE`, `KSP_NORM_PRECONDITIONED`, `KSP_NORM_UNPRECONDITIONED`, `KSPSetConvergenceTest()`
829: M*/
831: PETSC_EXTERN PetscErrorCode KSPSetNormType(KSP, KSPNormType);
832: PETSC_EXTERN PetscErrorCode KSPGetNormType(KSP, KSPNormType *);
833: PETSC_EXTERN PetscErrorCode KSPSetSupportedNorm(KSP, KSPNormType, PCSide, PetscInt);
834: PETSC_EXTERN PetscErrorCode KSPSetCheckNormIteration(KSP, PetscInt);
835: PETSC_EXTERN PetscErrorCode KSPSetLagNorm(KSP, PetscBool);
837: #define KSP_CONVERGED_CG_NEG_CURVE_DEPRECATED KSP_CONVERGED_CG_NEG_CURVE PETSC_DEPRECATED_ENUM(3, 19, 0, "KSP_CONVERGED_NEG_CURVE", )
838: #define KSP_CONVERGED_CG_CONSTRAINED_DEPRECATED KSP_CONVERGED_CG_CONSTRAINED PETSC_DEPRECATED_ENUM(3, 19, 0, "KSP_CONVERGED_STEP_LENGTH", )
839: #define KSP_CONVERGED_RTOL_NORMAL_DEPRECATED KSP_CONVERGED_RTOL_NORMAL PETSC_DEPRECATED_ENUM(3, 24, 0, "KSP_CONVERGED_RTOL_NORMAL_EQUATIONS", )
840: #define KSP_CONVERGED_ATOL_NORMAL_DEPRECATED KSP_CONVERGED_ATOL_NORMAL PETSC_DEPRECATED_ENUM(3, 24, 0, "KSP_CONVERGED_ATOL_NORMAL_EQUATIONS", )
841: /*E
842: KSPConvergedReason - reason a Krylov method was determined to have converged or diverged
844: Values:
845: + `KSP_CONVERGED_RTOL_NORMAL_EQUATIONS` - requested decrease in the residual of the normal equations, for `KSPLSQR`
846: . `KSP_CONVERGED_ATOL_NORMAL_EQUATIONS` - requested absolute value in the residual of the normal equations, for `KSPLSQR`
847: . `KSP_CONVERGED_RTOL` - requested decrease in the residual
848: . `KSP_CONVERGED_ATOL` - requested absolute value in the residual
849: . `KSP_CONVERGED_ITS` - requested number of iterations
850: . `KSP_CONVERGED_NEG_CURVE` - see note below
851: . `KSP_CONVERGED_STEP_LENGTH` - see note below
852: . `KSP_CONVERGED_HAPPY_BREAKDOWN` - happy breakdown (meaning early convergence of the `KSPType` occurred).
853: . `KSP_CONVERGED_USER` - the user has indicated convergence for an arbitrary reason
854: . `KSP_DIVERGED_NULL` - breakdown when solving the Hessenberg system within `KSPGMRES`
855: . `KSP_DIVERGED_ITS` - requested number of iterations
856: . `KSP_DIVERGED_DTOL` - large increase in the residual norm indicating the solution is diverging
857: . `KSP_DIVERGED_BREAKDOWN` - breakdown in the Krylov method
858: . `KSP_DIVERGED_BREAKDOWN_BICG` - breakdown in the `KSPBCGS` Krylov method
859: . `KSP_DIVERGED_NONSYMMETRIC` - the operator or preonditioner was not symmetric for a `KSPType` that requires symmetry
860: . `KSP_DIVERGED_INDEFINITE_PC` - the preconditioner was indefinite for a `KSPType` that requires it be definite, such as `KSPCG`
861: . `KSP_DIVERGED_NANORINF` - a not a number of infinity was detected in a vector during the computation
862: . `KSP_DIVERGED_INDEFINITE_MAT` - the operator was indefinite for a `KSPType` that requires it be definite, such as `KSPCG`
863: . `KSP_DIVERGED_PC_FAILED` - the action of the preconditioner failed for some reason
864: . `KSP_DIVERGED_USER` - the user has indicated divergence for an arbitrary reason
865: - `KSP_DIVERGED_INNER_SOLVE_FAILED` - the inner `KSPSolve()` failed for some reason
867: Level: beginner
869: Note:
870: The values `KSP_CONVERGED_NEG_CURVE`, and `KSP_CONVERGED_STEP_LENGTH` are returned only by `KSPCG`, `KSPMINRES` and by
871: the special `KSPNASH`, `KSPSTCG`, and `KSPGLTR` solvers which are used by the `SNESNEWTONTR` (trust region) solver.
873: Developer Note:
874: The string versions of these are `KSPConvergedReasons`; if you change
875: any of the values here also change them that array of names.
877: .seealso: [](ch_ksp), `KSP`, `KSPSolve()`, `KSPGetConvergedReason()`, `KSPSetTolerances()`, `KSPConvergedReasonView()`
878: E*/
879: typedef enum { /* converged */
880: KSP_CONVERGED_RTOL_NORMAL_DEPRECATED = 1,
881: KSP_CONVERGED_RTOL_NORMAL_EQUATIONS = 1,
882: KSP_CONVERGED_ATOL_NORMAL_DEPRECATED = 9,
883: KSP_CONVERGED_ATOL_NORMAL_EQUATIONS = 9,
884: KSP_CONVERGED_RTOL = 2,
885: KSP_CONVERGED_ATOL = 3,
886: KSP_CONVERGED_ITS = 4,
887: KSP_CONVERGED_NEG_CURVE = 5,
888: KSP_CONVERGED_CG_NEG_CURVE_DEPRECATED = 5,
889: KSP_CONVERGED_CG_CONSTRAINED_DEPRECATED = 6,
890: KSP_CONVERGED_STEP_LENGTH = 6,
891: KSP_CONVERGED_HAPPY_BREAKDOWN = 7,
892: KSP_CONVERGED_USER = 8,
893: /* diverged */
894: KSP_DIVERGED_NULL = -2,
895: KSP_DIVERGED_ITS = -3,
896: KSP_DIVERGED_DTOL = -4,
897: KSP_DIVERGED_BREAKDOWN = -5,
898: KSP_DIVERGED_BREAKDOWN_BICG = -6,
899: KSP_DIVERGED_NONSYMMETRIC = -7,
900: KSP_DIVERGED_INDEFINITE_PC = -8,
901: KSP_DIVERGED_NANORINF = -9,
902: KSP_DIVERGED_INDEFINITE_MAT = -10,
903: KSP_DIVERGED_PC_FAILED = -11,
904: KSP_DIVERGED_PCSETUP_FAILED_DEPRECATED = -11,
905: KSP_DIVERGED_USER = -12,
906: KSP_DIVERGED_INNER_SOLVE_FAILED = -13,
908: KSP_CONVERGED_ITERATING = 0
909: } KSPConvergedReason;
910: PETSC_EXTERN const char *const *KSPConvergedReasons;
912: /*MC
913: KSP_CONVERGED_RTOL - $||r|| \le rtol*||b||$ or $rtol*||b - A*x_0||$ if `KSPConvergedDefaultSetUIRNorm()` was called
915: Level: beginner
917: Notes:
918: See `KSPNormType` and `KSPSetNormType()` for possible norms that may be used. By default
919: for left preconditioning it is the 2-norm of the preconditioned residual, and the
920: 2-norm of the residual for right preconditioning
922: See also `KSP_CONVERGED_ATOL` which may apply before this tolerance.
924: .seealso: [](ch_ksp), `KSPNormType`, `KSP_CONVERGED_ATOL`, `KSP_DIVERGED_DTOL`, `KSPSolve()`, `KSPGetConvergedReason()`, `KSPConvergedReason`, `KSPSetTolerances()`
925: M*/
927: /*MC
928: KSP_CONVERGED_ATOL - $||r|| \le atol$
930: Level: beginner
932: Notes:
933: See `KSPNormType` and `KSPSetNormType()` for possible norms that may be used. By default
934: for left preconditioning it is the 2-norm of the preconditioned residual, and the
935: 2-norm of the residual for right preconditioning
937: See also `KSP_CONVERGED_RTOL` which may apply before this tolerance.
939: .seealso: [](ch_ksp), `KSPNormType`, `KSP_CONVERGED_RTOL`, `KSP_DIVERGED_DTOL`, `KSPSolve()`, `KSPGetConvergedReason()`, `KSPConvergedReason`, `KSPSetTolerances()`
940: M*/
942: /*MC
943: KSP_DIVERGED_DTOL - $||r|| \ge dtol*||b||$
945: Level: beginner
947: Note:
948: See `KSPNormType` and `KSPSetNormType()` for possible norms that may be used. By default
949: for left preconditioning it is the 2-norm of the preconditioned residual, and the
950: 2-norm of the residual for right preconditioning
952: .seealso: [](ch_ksp), `KSPNormType`, `KSP_CONVERGED_ATOL`, `KSP_CONVERGED_RTOL`, `KSPSolve()`, `KSPGetConvergedReason()`, `KSPConvergedReason`, `KSPSetTolerances()`
953: M*/
955: /*MC
956: KSP_DIVERGED_ITS - Ran out of iterations before any convergence criteria was
957: reached
959: Level: beginner
961: .seealso: [](ch_ksp), `KSPSolve()`, `KSPGetConvergedReason()`, `KSPConvergedReason`, `KSPSetTolerances()`
962: M*/
964: /*MC
965: KSP_CONVERGED_ITS - Used by the `KSPPREONLY` solver after the single iteration of
966: the preconditioner is applied. Also used when the `KSPConvergedSkip()` convergence
967: test routine is set in `KSP`.
969: Level: beginner
971: .seealso: [](ch_ksp), `KSPSolve()`, `KSPGetConvergedReason()`, `KSPConvergedReason`, `KSPSetTolerances()`
972: M*/
974: /*MC
975: KSP_DIVERGED_BREAKDOWN - A breakdown in the Krylov method was detected so the
976: method could not continue to enlarge the Krylov space. Could be due to a singular matrix or
977: preconditioner. In `KSPHPDDM`, this is also returned when some search directions within a block
978: are collinear.
980: Level: beginner
982: .seealso: [](ch_ksp), `KSPSolve()`, `KSPGetConvergedReason()`, `KSPConvergedReason`, `KSPSetTolerances()`
983: M*/
985: /*MC
986: KSP_DIVERGED_BREAKDOWN_BICG - A breakdown in the `KSPBICG` method was detected so the
987: method could not continue to enlarge the Krylov space.
989: Level: beginner
991: .seealso: [](ch_ksp), `KSPSolve()`, `KSPGetConvergedReason()`, `KSPConvergedReason`, `KSPSetTolerances()`
992: M*/
994: /*MC
995: KSP_DIVERGED_NONSYMMETRIC - It appears the operator or preconditioner is not
996: symmetric and this Krylov method (`KSPCG`, `KSPMINRES`, `KSPCR`) requires symmetry
998: Level: beginner
1000: .seealso: [](ch_ksp), `KSPSolve()`, `KSPGetConvergedReason()`, `KSPConvergedReason`, `KSPSetTolerances()`
1001: M*/
1003: /*MC
1004: KSP_DIVERGED_INDEFINITE_PC - It appears the preconditioner is indefinite (has both
1005: positive and negative eigenvalues) and this Krylov method (`KSPCG`) requires it to
1006: be symmetric positive definite (SPD).
1008: Level: beginner
1010: Note:
1011: This can happen with the `PCICC` preconditioner, use the options database option `-pc_factor_shift_positive_definite` to force
1012: the `PCICC` preconditioner to generate a positive definite preconditioner
1014: .seealso: [](ch_ksp), `KSPSolve()`, `KSPGetConvergedReason()`, `KSPConvergedReason`, `KSPSetTolerances()`
1015: M*/
1017: /*MC
1018: KSP_DIVERGED_PC_FAILED - It was not possible to build or use the requested preconditioner. This is usually due to a
1019: zero pivot in a factorization. It can also result from a failure in a subpreconditioner inside a nested preconditioner
1020: such as `PCFIELDSPLIT`.
1022: Level: beginner
1024: Note:
1025: Run with `-ksp_error_if_not_converged` to stop the program when the error is detected and print an error message with details.
1027: .seealso: [](ch_ksp), `KSPSolve()`, `KSPGetConvergedReason()`, `KSPConvergedReason`, `KSPSetTolerances()`
1028: M*/
1030: /*MC
1031: KSP_DIVERGED_USER - The user has indicated divergence for an arbitrary reason.
1033: Level: beginner
1035: .seealso: [](ch_ksp), `KSPSolve()`, `KSPGetConvergedReason()`, `KSPConvergedReason`, `KSPSetTolerances()`
1036: M*/
1038: /*MC
1039: KSP_DIVERGED_INNER_SOLVE_FAILED - It was not possible to solve an inner linear system in solvers such as `KSPEKSM`.
1041: Level: beginner
1043: Note:
1044: Run with `-ksp_error_if_not_converged` to stop the program when the error is detected and print an error message with details.
1046: .seealso: [](ch_ksp), `KSPSolve()`, `KSPGetConvergedReason()`, `KSPConvergedReason`, `KSPSetTolerances()`
1047: M*/
1049: /*MC
1050: KSP_CONVERGED_ITERATING - This flag is returned if `KSPGetConvergedReason()` is called
1051: while `KSPSolve()` is still running.
1053: Level: beginner
1055: .seealso: [](ch_ksp), `KSPSolve()`, `KSPGetConvergedReason()`, `KSPConvergedReason`, `KSPSetTolerances()`
1056: M*/
1058: /*S
1059: KSPConvergenceTestFn - A prototype of a function used with `KSPSetConvergenceTest()`
1061: Calling Sequence:
1062: + ksp - iterative solver obtained from `KSPCreate()`
1063: . it - iteration number
1064: . rnorm - (estimated) 2-norm of (preconditioned) residual
1065: . reason - the reason why it has converged or diverged
1066: - ctx - optional convergence context, as set by `KSPSetConvergenceTest()`
1068: Level: beginner
1070: .seealso: [](ch_ksp), `KSP`, `KSPSetConvergenceTest()`, `KSPGetConvergenceTest()`
1071: S*/
1072: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode KSPConvergenceTestFn(KSP ksp, PetscInt it, PetscReal rnorm, KSPConvergedReason *reason, PetscCtx ctx);
1074: PETSC_EXTERN PetscErrorCode KSPSetConvergenceTest(KSP, KSPConvergenceTestFn *, void *, PetscCtxDestroyFn *);
1075: PETSC_EXTERN PetscErrorCode KSPGetConvergenceTest(KSP, KSPConvergenceTestFn **, PetscCtxRt, PetscCtxDestroyFn **);
1076: PETSC_EXTERN PetscErrorCode KSPGetAndClearConvergenceTest(KSP, KSPConvergenceTestFn **, PetscCtxRt, PetscCtxDestroyFn **);
1077: PETSC_EXTERN PetscErrorCode KSPGetConvergenceContext(KSP, PetscCtxRt);
1078: PETSC_EXTERN KSPConvergenceTestFn KSPConvergedDefault;
1079: PETSC_EXTERN KSPConvergenceTestFn KSPLSQRConvergedDefault;
1080: PETSC_EXTERN PetscCtxDestroyFn KSPConvergedDefaultDestroy;
1081: PETSC_EXTERN PetscErrorCode KSPConvergedDefaultCreate(void **);
1082: PETSC_EXTERN PetscErrorCode KSPConvergedDefaultSetUIRNorm(KSP);
1083: PETSC_EXTERN PetscErrorCode KSPConvergedDefaultSetUMIRNorm(KSP);
1084: PETSC_EXTERN PetscErrorCode KSPConvergedDefaultSetConvergedMaxits(KSP, PetscBool);
1085: PETSC_EXTERN PetscErrorCode KSPConvergedSkip(KSP, PetscInt, PetscReal, KSPConvergedReason *, void *);
1086: PETSC_EXTERN PetscErrorCode KSPGetConvergedReason(KSP, KSPConvergedReason *);
1087: PETSC_EXTERN PetscErrorCode KSPGetConvergedReasonString(KSP, const char *[]);
1088: PETSC_EXTERN PetscErrorCode KSPComputeConvergenceRate(KSP, PetscReal *, PetscReal *, PetscReal *, PetscReal *);
1089: PETSC_EXTERN PetscErrorCode KSPSetConvergedNegativeCurvature(KSP, PetscBool);
1090: PETSC_EXTERN PetscErrorCode KSPGetConvergedNegativeCurvature(KSP, PetscBool *);
1092: PETSC_DEPRECATED_FUNCTION(3, 5, 0, "KSPConvergedDefault()", ) static inline void KSPDefaultConverged(void)
1093: { /* never called */
1094: }
1095: #define KSPDefaultConverged (KSPDefaultConverged, KSPConvergedDefault)
1096: PETSC_DEPRECATED_FUNCTION(3, 5, 0, "KSPConvergedDefaultDestroy()", ) static inline void KSPDefaultConvergedDestroy(void)
1097: { /* never called */
1098: }
1099: #define KSPDefaultConvergedDestroy (KSPDefaultConvergedDestroy, KSPConvergedDefaultDestroy)
1100: PETSC_DEPRECATED_FUNCTION(3, 5, 0, "KSPConvergedDefaultCreate()", ) static inline void KSPDefaultConvergedCreate(void)
1101: { /* never called */
1102: }
1103: #define KSPDefaultConvergedCreate (KSPDefaultConvergedCreate, KSPConvergedDefaultCreate)
1104: PETSC_DEPRECATED_FUNCTION(3, 5, 0, "KSPConvergedDefaultSetUIRNorm()", ) static inline void KSPDefaultConvergedSetUIRNorm(void)
1105: { /* never called */
1106: }
1107: #define KSPDefaultConvergedSetUIRNorm (KSPDefaultConvergedSetUIRNorm, KSPConvergedDefaultSetUIRNorm)
1108: PETSC_DEPRECATED_FUNCTION(3, 5, 0, "KSPConvergedDefaultSetUMIRNorm()", ) static inline void KSPDefaultConvergedSetUMIRNorm(void)
1109: { /* never called */
1110: }
1111: #define KSPDefaultConvergedSetUMIRNorm (KSPDefaultConvergedSetUMIRNorm, KSPConvergedDefaultSetUMIRNorm)
1112: PETSC_DEPRECATED_FUNCTION(3, 5, 0, "KSPConvergedSkip()", ) static inline void KSPSkipConverged(void)
1113: { /* never called */
1114: }
1115: #define KSPSkipConverged (KSPSkipConverged, KSPConvergedSkip)
1117: PETSC_EXTERN PetscErrorCode KSPComputeOperator(KSP, MatType, Mat *);
1118: PETSC_DEPRECATED_FUNCTION(3, 12, 0, "KSPComputeOperator()", ) static inline PetscErrorCode KSPComputeExplicitOperator(KSP A, Mat *B)
1119: {
1120: return KSPComputeOperator(A, PETSC_NULLPTR, B);
1121: }
1123: /*E
1124: KSPCGType - Determines what type of `KSPCG` to use
1126: Values:
1127: + `KSP_CG_SYMMETRIC` - the matrix is complex symmetric
1128: - `KSP_CG_HERMITIAN` - the matrix is complex Hermitian
1130: Level: beginner
1132: .seealso: [](ch_ksp), `KSPCG`, `KSP`, `KSPCGSetType()`
1133: E*/
1134: typedef enum {
1135: KSP_CG_SYMMETRIC = 0,
1136: KSP_CG_HERMITIAN = 1
1137: } KSPCGType;
1138: PETSC_EXTERN const char *const KSPCGTypes[];
1140: PETSC_EXTERN PetscErrorCode KSPCGSetType(KSP, KSPCGType);
1141: PETSC_EXTERN PetscErrorCode KSPCGUseSingleReduction(KSP, PetscBool);
1143: PETSC_EXTERN PetscErrorCode KSPCGSetRadius(KSP, PetscReal);
1144: PETSC_EXTERN PetscErrorCode KSPCGSetObjectiveTarget(KSP, PetscReal);
1145: PETSC_EXTERN PetscErrorCode KSPCGGetNormD(KSP, PetscReal *);
1146: PETSC_EXTERN PetscErrorCode KSPCGGetObjFcn(KSP, PetscReal *);
1148: PETSC_EXTERN PetscErrorCode KSPGLTRGetMinEig(KSP, PetscReal *);
1149: PETSC_EXTERN PetscErrorCode KSPGLTRGetLambda(KSP, PetscReal *);
1150: PETSC_DEPRECATED_FUNCTION(3, 12, 0, "KSPGLTRGetMinEig()", ) static inline PetscErrorCode KSPCGGLTRGetMinEig(KSP ksp, PetscReal *x)
1151: {
1152: return KSPGLTRGetMinEig(ksp, x);
1153: }
1154: PETSC_DEPRECATED_FUNCTION(3, 12, 0, "KSPGLTRGetLambda()", ) static inline PetscErrorCode KSPCGGLTRGetLambda(KSP ksp, PetscReal *x)
1155: {
1156: return KSPGLTRGetLambda(ksp, x);
1157: }
1159: PETSC_EXTERN PetscErrorCode KSPPythonSetType(KSP, const char[]);
1160: PETSC_EXTERN PetscErrorCode KSPPythonGetType(KSP, const char *[]);
1162: PETSC_EXTERN PetscErrorCode PCPreSolve(PC, KSP);
1163: PETSC_EXTERN PetscErrorCode PCPostSolve(PC, KSP);
1165: PETSC_EXTERN PetscErrorCode KSPMonitorLGRange(KSP, PetscInt, PetscReal, void *);
1167: /*S
1168: PCShellPSolveFn - A function prototype for functions provided to `PCShellSetPreSolve()` and `PCShellSetPostSolve()`
1170: Calling Sequence:
1171: + pc - the preconditioner `PC` context
1172: . ksp - the `KSP` context
1173: . xin - input vector
1174: - xout - output vector
1176: Level: intermediate
1178: .seealso: [](ch_snes), `KSPPSolveFn`, `KSP`, `PCShellSetPreSolve()`, `PCShellSetPostSolve()`
1179: S*/
1180: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode PCShellPSolveFn(PC pc, KSP ksp, Vec xim, Vec xout);
1182: PETSC_EXTERN PetscErrorCode PCShellSetPreSolve(PC, PCShellPSolveFn *);
1183: PETSC_EXTERN PetscErrorCode PCShellSetPostSolve(PC, PCShellPSolveFn *);
1185: /*S
1186: KSPGuess - Abstract PETSc object that manages all initial guess generation methods for Krylov methods.
1188: Level: intermediate
1190: Note:
1191: These methods generate initial guesses based on a series of previous, related, linear solves. For example,
1192: in implicit time-stepping with `TS`.
1194: .seealso: [](ch_ksp), `KSPCreate()`, `KSPGuessSetType()`, `KSPGuessType`
1195: S*/
1196: typedef struct _p_KSPGuess *KSPGuess;
1198: /*J
1199: KSPGuessType - String with the name of a PETSc initial guess approach for Krylov methods.
1201: Values:
1202: + `KSPGUESSFISCHER` - methodology developed by Paul Fischer
1203: - `KSPGUESSPOD` - methodology based on proper orthogonal decomposition (POD)
1205: Options Database Key:
1206: . -ksp_guess_type (fischer|pod) - set the type
1208: Level: intermediate
1210: .seealso: [](ch_ksp), `KSP`, `KSPGuess`, `KSPGuessSetType()`
1211: J*/
1212: typedef const char *KSPGuessType;
1213: #define KSPGUESSFISCHER "fischer"
1214: #define KSPGUESSPOD "pod"
1216: PETSC_EXTERN PetscErrorCode KSPGuessRegister(const char[], PetscErrorCode (*)(KSPGuess));
1217: PETSC_EXTERN PetscErrorCode KSPSetGuess(KSP, KSPGuess);
1218: PETSC_EXTERN PetscErrorCode KSPGetGuess(KSP, KSPGuess *);
1219: PETSC_EXTERN PetscErrorCode KSPGuessView(KSPGuess, PetscViewer);
1220: PETSC_EXTERN PetscErrorCode KSPGuessDestroy(KSPGuess *);
1221: PETSC_EXTERN PetscErrorCode KSPGuessCreate(MPI_Comm, KSPGuess *);
1222: PETSC_EXTERN PetscErrorCode KSPGuessSetType(KSPGuess, KSPGuessType);
1223: PETSC_EXTERN PetscErrorCode KSPGuessGetType(KSPGuess, KSPGuessType *);
1224: PETSC_EXTERN PetscErrorCode KSPGuessSetTolerance(KSPGuess, PetscReal);
1225: PETSC_EXTERN PetscErrorCode KSPGuessSetUp(KSPGuess);
1226: PETSC_EXTERN PetscErrorCode KSPGuessUpdate(KSPGuess, Vec, Vec);
1227: PETSC_EXTERN PetscErrorCode KSPGuessFormGuess(KSPGuess, Vec, Vec);
1228: PETSC_EXTERN PetscErrorCode KSPGuessSetFromOptions(KSPGuess);
1229: PETSC_EXTERN PetscErrorCode KSPGuessFischerSetModel(KSPGuess, PetscInt, PetscInt);
1230: PETSC_EXTERN PetscErrorCode KSPSetUseFischerGuess(KSP, PetscInt, PetscInt);
1231: PETSC_EXTERN PetscErrorCode KSPSetInitialGuessKnoll(KSP, PetscBool);
1232: PETSC_EXTERN PetscErrorCode KSPGetInitialGuessKnoll(KSP, PetscBool *);
1234: /*E
1235: MatSchurComplementAinvType - Determines how to approximate the inverse of the (0,0) block in Schur complement matrix assembly routines
1237: Level: intermediate
1239: .seealso: `MatSchurComplementGetAinvType()`, `MatSchurComplementSetAinvType()`, `MatSchurComplementGetPmat()`, `MatGetSchurComplement()`,
1240: `MatCreateSchurComplementPmat()`, `MatCreateSchurComplement()`
1241: E*/
1242: typedef enum {
1243: MAT_SCHUR_COMPLEMENT_AINV_DIAG,
1244: MAT_SCHUR_COMPLEMENT_AINV_LUMP,
1245: MAT_SCHUR_COMPLEMENT_AINV_BLOCK_DIAG,
1246: MAT_SCHUR_COMPLEMENT_AINV_FULL
1247: } MatSchurComplementAinvType;
1248: PETSC_EXTERN const char *const MatSchurComplementAinvTypes[];
1250: PETSC_EXTERN PetscErrorCode MatCreateSchurComplement(Mat, Mat, Mat, Mat, Mat, Mat *);
1251: PETSC_EXTERN PetscErrorCode MatSchurComplementGetKSP(Mat, KSP *);
1252: PETSC_EXTERN PetscErrorCode MatSchurComplementSetKSP(Mat, KSP);
1253: PETSC_EXTERN PetscErrorCode MatSchurComplementSetSubMatrices(Mat, Mat, Mat, Mat, Mat, Mat);
1254: PETSC_EXTERN PetscErrorCode MatSchurComplementUpdateSubMatrices(Mat, Mat, Mat, Mat, Mat, Mat);
1255: PETSC_EXTERN PetscErrorCode MatSchurComplementGetSubMatrices(Mat, Mat *, Mat *, Mat *, Mat *, Mat *);
1256: PETSC_EXTERN PetscErrorCode MatSchurComplementSetAinvType(Mat, MatSchurComplementAinvType);
1257: PETSC_EXTERN PetscErrorCode MatSchurComplementGetAinvType(Mat, MatSchurComplementAinvType *);
1258: PETSC_EXTERN PetscErrorCode MatSchurComplementGetPmat(Mat, MatReuse, Mat *);
1259: PETSC_EXTERN PetscErrorCode MatSchurComplementComputeExplicitOperator(Mat, Mat *);
1260: PETSC_EXTERN PetscErrorCode MatGetSchurComplement(Mat, IS, IS, IS, IS, MatReuse, Mat *, MatSchurComplementAinvType, MatReuse, Mat *);
1261: PETSC_EXTERN PetscErrorCode MatCreateSchurComplementPmat(Mat, Mat, Mat, Mat, MatSchurComplementAinvType, MatReuse, Mat *);
1263: PETSC_EXTERN PetscErrorCode MatCreateLMVMDFP(MPI_Comm, PetscInt, PetscInt, Mat *);
1264: PETSC_EXTERN PetscErrorCode MatCreateLMVMBFGS(MPI_Comm, PetscInt, PetscInt, Mat *);
1265: PETSC_EXTERN PetscErrorCode MatCreateLMVMDBFGS(MPI_Comm, PetscInt, PetscInt, Mat *);
1266: PETSC_EXTERN PetscErrorCode MatCreateLMVMDDFP(MPI_Comm, PetscInt, PetscInt, Mat *);
1267: PETSC_EXTERN PetscErrorCode MatCreateLMVMDQN(MPI_Comm, PetscInt, PetscInt, Mat *);
1268: PETSC_EXTERN PetscErrorCode MatCreateLMVMSR1(MPI_Comm, PetscInt, PetscInt, Mat *);
1269: PETSC_EXTERN PetscErrorCode MatCreateLMVMBroyden(MPI_Comm, PetscInt, PetscInt, Mat *);
1270: PETSC_EXTERN PetscErrorCode MatCreateLMVMBadBroyden(MPI_Comm, PetscInt, PetscInt, Mat *);
1271: PETSC_EXTERN PetscErrorCode MatCreateLMVMSymBroyden(MPI_Comm, PetscInt, PetscInt, Mat *);
1272: PETSC_EXTERN PetscErrorCode MatCreateLMVMSymBadBroyden(MPI_Comm, PetscInt, PetscInt, Mat *);
1273: PETSC_EXTERN PetscErrorCode MatCreateLMVMDiagBroyden(MPI_Comm, PetscInt, PetscInt, Mat *);
1275: PETSC_EXTERN PetscErrorCode MatLMVMUpdate(Mat, Vec, Vec);
1276: PETSC_EXTERN PetscErrorCode MatLMVMIsAllocated(Mat, PetscBool *);
1277: PETSC_EXTERN PetscErrorCode MatLMVMAllocate(Mat, Vec, Vec);
1278: PETSC_EXTERN PetscErrorCode MatLMVMReset(Mat, PetscBool);
1279: PETSC_EXTERN PetscErrorCode MatLMVMResetShift(Mat);
1280: PETSC_EXTERN PetscErrorCode MatLMVMClearJ0(Mat);
1281: PETSC_EXTERN PetscErrorCode MatLMVMSetJ0(Mat, Mat);
1282: PETSC_EXTERN PetscErrorCode MatLMVMSetJ0Scale(Mat, PetscReal);
1283: PETSC_EXTERN PetscErrorCode MatLMVMSetJ0Diag(Mat, Vec);
1284: PETSC_EXTERN PetscErrorCode MatLMVMSetJ0PC(Mat, PC);
1285: PETSC_EXTERN PetscErrorCode MatLMVMSetJ0KSP(Mat, KSP);
1286: PETSC_EXTERN PetscErrorCode MatLMVMApplyJ0Fwd(Mat, Vec, Vec);
1287: PETSC_EXTERN PetscErrorCode MatLMVMApplyJ0Inv(Mat, Vec, Vec);
1288: PETSC_EXTERN PetscErrorCode MatLMVMGetLastUpdate(Mat, Vec *, Vec *);
1289: PETSC_EXTERN PetscErrorCode MatLMVMGetJ0(Mat, Mat *);
1290: PETSC_EXTERN PetscErrorCode MatLMVMGetJ0PC(Mat, PC *);
1291: PETSC_EXTERN PetscErrorCode MatLMVMGetJ0KSP(Mat, KSP *);
1292: PETSC_EXTERN PetscErrorCode MatLMVMSetHistorySize(Mat, PetscInt);
1293: PETSC_EXTERN PetscErrorCode MatLMVMGetHistorySize(Mat, PetscInt *);
1294: PETSC_EXTERN PetscErrorCode MatLMVMGetUpdateCount(Mat, PetscInt *);
1295: PETSC_EXTERN PetscErrorCode MatLMVMGetRejectCount(Mat, PetscInt *);
1296: PETSC_EXTERN PetscErrorCode MatLMVMSymBroydenSetDelta(Mat, PetscScalar);
1298: /*E
1299: MatLMVMMultAlgorithm - The type of algorithm used for matrix-vector products and solves used internally by a `MatLMVM` matrix
1301: Values:
1302: + `MAT_LMVM_MULT_RECURSIVE` - Use recursive formulas for products and solves
1303: . `MAT_LMVM_MULT_DENSE` - Use dense formulas for products and solves when possible
1304: - `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
1306: Level: advanced
1308: Options Database Keys:
1309: . -mat_lmvm_mult_algorithm (recursive|dense|compact_dense) - the algorithm to use for multiplication
1311: .seealso: [](ch_matrices), `MATLMVM`, `MatLMVMSetMultAlgorithm()`, `MatLMVMGetMultAlgorithm()`
1312: E*/
1313: typedef enum {
1314: MAT_LMVM_MULT_RECURSIVE,
1315: MAT_LMVM_MULT_DENSE,
1316: MAT_LMVM_MULT_COMPACT_DENSE,
1317: } MatLMVMMultAlgorithm;
1319: PETSC_EXTERN const char *const MatLMVMMultAlgorithms[];
1321: PETSC_EXTERN PetscErrorCode MatLMVMSetMultAlgorithm(Mat, MatLMVMMultAlgorithm);
1322: PETSC_EXTERN PetscErrorCode MatLMVMGetMultAlgorithm(Mat, MatLMVMMultAlgorithm *);
1324: /*E
1325: MatLMVMSymBroydenScaleType - Rescaling type for the initial Hessian of a symmetric Broyden matrix.
1327: Values:
1328: + `MAT_LMVM_SYMBROYDEN_SCALE_NONE` - no rescaling
1329: . `MAT_LMVM_SYMBROYDEN_SCALE_SCALAR` - scalar rescaling
1330: . `MAT_LMVM_SYMBROYDEN_SCALE_DIAGONAL` - diagonal rescaling
1331: . `MAT_LMVM_SYMBROYDEN_SCALE_USER` - same as `MAT_LMVM_SYMBROYDN_SCALE_NONE`
1332: - `MAT_LMVM_SYMBROYDEN_SCALE_DECIDE` - let PETSc decide rescaling
1334: Level: intermediate
1336: .seealso: [](ch_matrices), `MATLMVM`, `MatLMVMSymBroydenSetScaleType()`
1337: E*/
1338: typedef enum {
1339: MAT_LMVM_SYMBROYDEN_SCALE_NONE = 0,
1340: MAT_LMVM_SYMBROYDEN_SCALE_SCALAR = 1,
1341: MAT_LMVM_SYMBROYDEN_SCALE_DIAGONAL = 2,
1342: MAT_LMVM_SYMBROYDEN_SCALE_USER = 3,
1343: MAT_LMVM_SYMBROYDEN_SCALE_DECIDE = 4
1344: } MatLMVMSymBroydenScaleType;
1345: PETSC_EXTERN const char *const MatLMVMSymBroydenScaleTypes[];
1347: PETSC_EXTERN PetscErrorCode MatLMVMSymBroydenSetScaleType(Mat, MatLMVMSymBroydenScaleType);
1348: PETSC_EXTERN PetscErrorCode MatLMVMSymBroydenGetPhi(Mat, PetscReal *);
1349: PETSC_EXTERN PetscErrorCode MatLMVMSymBroydenSetPhi(Mat, PetscReal);
1350: PETSC_EXTERN PetscErrorCode MatLMVMSymBadBroydenGetPsi(Mat, PetscReal *);
1351: PETSC_EXTERN PetscErrorCode MatLMVMSymBadBroydenSetPsi(Mat, PetscReal);
1353: /*E
1354: MatLMVMDenseType - Memory storage strategy for dense variants of `MATLMVM`.
1356: Values:
1357: + `MAT_LMVM_DENSE_REORDER` - reorders memory to minimize kernel launch
1358: - `MAT_LMVM_DENSE_INPLACE` - computes inplace to minimize memory movement
1360: Level: intermediate
1362: .seealso: [](ch_matrices), `MatLMVM`, `MatLMVMDenseSetType()`
1363: E*/
1364: typedef enum {
1365: MAT_LMVM_DENSE_REORDER,
1366: MAT_LMVM_DENSE_INPLACE
1367: } MatLMVMDenseType;
1368: PETSC_EXTERN const char *const MatLMVMDenseTypes[];
1370: PETSC_EXTERN PetscErrorCode MatLMVMDenseSetType(Mat, MatLMVMDenseType);
1372: PETSC_EXTERN PetscErrorCode KSPSetDM(KSP, DM);
1374: /*E
1375: KSPDMActive - Indicates if the `DM` attached to the `KSP` should be used to compute the operator, the right-hand side, or the initial guess
1377: Values:
1378: + `KSP_DMACTIVE_OPERATOR` - compute the operator
1379: . `KSP_DMACTIVE_RHS` - compute the right-hand side
1380: . `KSP_DMACTIVE_INITIAL_GUESS` - compute the initial guess
1381: - `KSP_DMACTIVE_ALL` - compute all of them
1383: Level: intermediate
1385: .seealso: [](ch_ksp), `KSP`, `KSPSetDMActive()`, `KSPSetDM()`
1386: E*/
1387: typedef enum {
1388: KSP_DMACTIVE_OPERATOR = 1,
1389: KSP_DMACTIVE_RHS = 2,
1390: KSP_DMACTIVE_INITIAL_GUESS = 4,
1391: KSP_DMACTIVE_ALL = 1 + 2 + 4
1392: } KSPDMActive;
1393: PETSC_EXTERN PetscErrorCode KSPSetDMActive(KSP, KSPDMActive, PetscBool);
1395: PETSC_EXTERN PetscErrorCode KSPGetDM(KSP, DM *);
1396: PETSC_EXTERN PetscErrorCode KSPSetApplicationContext(KSP, PetscCtx);
1397: PETSC_EXTERN PetscErrorCode KSPGetApplicationContext(KSP, PetscCtxRt);
1399: /*S
1400: KSPComputeRHSFn - A prototype of a `KSP` evaluation function that would be passed to `KSPSetComputeRHS()`
1402: Calling Sequence:
1403: + ksp - `ksp` context
1404: . b - output vector
1405: - ctx - [optional] user-defined function context
1407: Level: beginner
1409: .seealso: [](ch_ksp), `KSP`, `KSPSetComputeRHS()`, `SNESGetFunction()`, `KSPComputeInitialGuessFn`, `KSPComputeOperatorsFn`
1410: S*/
1411: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode KSPComputeRHSFn(KSP ksp, Vec b, PetscCtx ctx);
1413: PETSC_EXTERN PetscErrorCode KSPSetComputeRHS(KSP, KSPComputeRHSFn *, void *);
1415: /*S
1416: KSPComputeOperatorsFn - A prototype of a `KSP` evaluation function that would be passed to `KSPSetComputeOperators()`
1418: Calling Sequence:
1419: + ksp - `KSP` context
1420: . A - the operator that defines the linear system
1421: . P - an operator from which to build the preconditioner (often the same as `A`)
1422: - ctx - [optional] user-defined function context
1424: Level: beginner
1426: .seealso: [](ch_ksp), `KSP`, `KSPSetComputeRHS()`, `SNESGetFunction()`, `KSPComputeRHSFn`, `KSPComputeInitialGuessFn`
1427: S*/
1428: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode KSPComputeOperatorsFn(KSP ksp, Mat A, Mat P, PetscCtx ctx);
1430: PETSC_EXTERN PetscErrorCode KSPSetComputeOperators(KSP, KSPComputeOperatorsFn, void *);
1432: /*S
1433: KSPCreateOperatorsFn - A prototype of a `KSP` operator creation function that would be passed to `DMKSPSetCreateOperators()`
1435: Calling Sequence:
1436: + ksp - `KSP` context
1437: . A - the created operator that defines the linear system
1438: . P - the created operator from which to build the preconditioner, often the same as `A`
1439: - ctx - [optional] user-defined function context
1441: Level: developer
1443: Notes:
1444: The returned matrices are owned by the caller, similar to `DMCreateMatrix()`.
1446: `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`.
1448: .seealso: [](ch_ksp), `DMKSPSetCreateOperators()`, `DMKSPGetCreateOperators()`, `KSPComputeOperatorsFn`, `KSPSetOperators()`
1449: S*/
1450: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode KSPCreateOperatorsFn(KSP ksp, Mat *A, Mat *P, PetscCtx ctx);
1452: /*S
1453: KSPComputeInitialGuessFn - A prototype of a `KSP` evaluation function that would be passed to `KSPSetComputeInitialGuess()`
1455: Calling Sequence:
1456: + ksp - `ksp` context
1457: . x - output vector
1458: - ctx - [optional] user-defined function context
1460: Level: beginner
1462: .seealso: [](ch_ksp), `KSP`, `KSPSetComputeInitialGuess()`, `SNESGetFunction()`, `KSPComputeRHSFn`, `KSPComputeOperatorsFn`
1463: S*/
1464: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode KSPComputeInitialGuessFn(KSP ksp, Vec x, PetscCtx ctx);
1466: PETSC_EXTERN PetscErrorCode KSPSetComputeInitialGuess(KSP, KSPComputeInitialGuessFn *, void *);
1467: PETSC_EXTERN PetscErrorCode DMKSPSetComputeOperators(DM, KSPComputeOperatorsFn *, void *);
1468: PETSC_EXTERN PetscErrorCode DMKSPGetComputeOperators(DM, KSPComputeOperatorsFn **, void *);
1469: PETSC_EXTERN PetscErrorCode DMKSPSetCreateOperators(DM, KSPCreateOperatorsFn *, void *);
1470: PETSC_EXTERN PetscErrorCode DMKSPGetCreateOperators(DM, KSPCreateOperatorsFn **, void *);
1471: PETSC_EXTERN PetscErrorCode DMKSPSetComputeRHS(DM, KSPComputeRHSFn *, void *);
1472: PETSC_EXTERN PetscErrorCode DMKSPGetComputeRHS(DM, KSPComputeRHSFn **, void *);
1473: PETSC_EXTERN PetscErrorCode DMKSPSetComputeInitialGuess(DM, KSPComputeInitialGuessFn *, void *);
1474: PETSC_EXTERN PetscErrorCode DMKSPGetComputeInitialGuess(DM, KSPComputeInitialGuessFn **, void *);
1476: PETSC_EXTERN PetscErrorCode DMGlobalToLocalSolve(DM, Vec, Vec);
1477: PETSC_EXTERN PetscErrorCode DMSwarmProjectFields(DM, DM, PetscInt, const char *[], Vec[], ScatterMode);
1478: PETSC_EXTERN PetscErrorCode DMSwarmProjectGradientFields(DM, DM, PetscInt, const char *[], Vec[], ScatterMode);
1480: PETSC_EXTERN PetscErrorCode DMAdaptInterpolator(DM, DM, Mat, KSP, Mat, Mat, Mat *, void *);
1481: PETSC_EXTERN PetscErrorCode DMCheckInterpolator(DM, Mat, Mat, Mat, PetscReal);
1483: PETSC_EXTERN PetscErrorCode PCBJKOKKOSSetKSP(PC, KSP);
1484: PETSC_EXTERN PetscErrorCode PCBJKOKKOSGetKSP(PC, KSP *);
1486: PETSC_EXTERN PetscErrorCode DMCopyDMKSP(DM, DM);
1488: #include <petscdstypes.h>
1489: PETSC_EXTERN PetscErrorCode DMProjectField(DM, PetscReal, Vec, PetscPointFn **, InsertMode, Vec);