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()", )
398: static inline PetscErrorCode KSPPIPEGCRSetModifyPC(KSP ksp, KSPFlexibleModifyPCFn *fun, PetscCtx ctx, PetscCtxDestroyFn *dfun)
399: {
400: return KSPFlexibleSetModifyPC(ksp, fun, ctx, dfun);
401: }
403: PETSC_EXTERN PetscErrorCode KSPGMRESSetRestart(KSP, PetscInt);
404: PETSC_EXTERN PetscErrorCode KSPGMRESGetRestart(KSP, PetscInt *);
405: PETSC_EXTERN PetscErrorCode KSPGMRESSetHapTol(KSP, PetscReal);
406: PETSC_EXTERN PetscErrorCode KSPGMRESSetBreakdownTolerance(KSP, PetscReal);
408: PETSC_EXTERN PetscErrorCode KSPGMRESSetPreAllocateVectors(KSP);
409: PETSC_EXTERN PetscErrorCode KSPGMRESSetOrthogonalization(KSP, PetscErrorCode (*)(KSP, PetscInt));
410: PETSC_EXTERN PetscErrorCode KSPGMRESGetOrthogonalization(KSP, PetscErrorCode (**)(KSP, PetscInt));
411: PETSC_EXTERN PetscErrorCode KSPGMRESModifiedGramSchmidtOrthogonalization(KSP, PetscInt);
412: PETSC_EXTERN PetscErrorCode KSPGMRESClassicalGramSchmidtOrthogonalization(KSP, PetscInt);
414: PETSC_EXTERN PetscErrorCode KSPLGMRESSetAugDim(KSP, PetscInt);
415: PETSC_EXTERN PetscErrorCode KSPLGMRESSetConstant(KSP);
417: PETSC_EXTERN PetscErrorCode KSPPIPEFGMRESSetShift(KSP, PetscScalar);
419: PETSC_EXTERN PetscErrorCode KSPGCRSetRestart(KSP, PetscInt);
420: PETSC_EXTERN PetscErrorCode KSPGCRGetRestart(KSP, PetscInt *);
422: PETSC_EXTERN PetscErrorCode KSPIDRSetS(KSP, PetscInt);
423: PETSC_EXTERN PetscErrorCode KSPIDRGetS(KSP, PetscInt *);
424: PETSC_EXTERN PetscErrorCode KSPIDRSetCosine(KSP, PetscReal);
425: PETSC_EXTERN PetscErrorCode KSPIDRGetCosine(KSP, PetscReal *);
426: PETSC_EXTERN PetscErrorCode KSPIDRSetRandom(KSP, PetscRandom);
427: PETSC_EXTERN PetscErrorCode KSPIDRGetRandom(KSP, PetscRandom *);
429: PETSC_DEPRECATED_FUNCTION(3, 25, 0, "KSPFlexibleSetModifyPC()", )
430: static inline PetscErrorCode KSPGCRSetModifyPC(KSP ksp, KSPFlexibleModifyPCFn *fun, PetscCtx ctx, PetscCtxDestroyFn *dfun)
431: {
432: return KSPFlexibleSetModifyPC(ksp, fun, ctx, dfun);
433: }
435: PETSC_EXTERN PetscErrorCode KSPMINRESSetRadius(KSP, PetscReal);
436: PETSC_EXTERN PetscErrorCode KSPMINRESGetUseQLP(KSP, PetscBool *);
437: PETSC_EXTERN PetscErrorCode KSPMINRESSetUseQLP(KSP, PetscBool);
439: PETSC_EXTERN PetscErrorCode KSPFETIDPGetInnerBDDC(KSP, PC *);
440: PETSC_EXTERN PetscErrorCode KSPFETIDPSetInnerBDDC(KSP, PC);
441: PETSC_EXTERN PetscErrorCode KSPFETIDPGetInnerKSP(KSP, KSP *);
442: PETSC_EXTERN PetscErrorCode KSPFETIDPSetPressureOperator(KSP, Mat);
444: PETSC_EXTERN PetscErrorCode KSPHPDDMSetDeflationMat(KSP, Mat);
445: PETSC_EXTERN PetscErrorCode KSPHPDDMGetDeflationMat(KSP, Mat *);
446: #if PetscDefined(HAVE_HPDDM)
447: PETSC_DEPRECATED_FUNCTION(3, 18, 0, "KSPHPDDMSetDeflationMat()", ) static inline PetscErrorCode KSPHPDDMSetDeflationSpace(KSP ksp, Mat U)
448: {
449: return KSPHPDDMSetDeflationMat(ksp, U);
450: }
451: PETSC_DEPRECATED_FUNCTION(3, 18, 0, "KSPHPDDMGetDeflationMat()", ) static inline PetscErrorCode KSPHPDDMGetDeflationSpace(KSP ksp, Mat *U)
452: {
453: return KSPHPDDMGetDeflationMat(ksp, U);
454: }
455: #endif
456: PETSC_DEPRECATED_FUNCTION(3, 14, 0, "KSPMatSolve()", ) static inline PetscErrorCode KSPHPDDMMatSolve(KSP ksp, Mat B, Mat X)
457: {
458: return KSPMatSolve(ksp, B, X);
459: }
460: /*E
461: KSPHPDDMType - Type of Krylov method used by `KSPHPDDM`
463: Values:
464: + `KSP_HPDDM_TYPE_GMRES` (default) - Generalized Minimal Residual method
465: . `KSP_HPDDM_TYPE_BGMRES` - block GMRES
466: . `KSP_HPDDM_TYPE_CG` - Conjugate Gradient
467: . `KSP_HPDDM_TYPE_BCG` - block CG
468: . `KSP_HPDDM_TYPE_GCRODR` - Generalized Conjugate Residual method with inner Orthogonalization and Deflated Restarting
469: . `KSP_HPDDM_TYPE_BGCRODR` - block GCRODR
470: . `KSP_HPDDM_TYPE_BFBCG` - breakdown-free BCG
471: - `KSP_HPDDM_TYPE_PREONLY` - apply the preconditioner only
473: Level: intermediate
475: .seealso: [](ch_ksp), `KSPHPDDM`, `KSPHPDDMSetType()`
476: E*/
477: typedef enum {
478: KSP_HPDDM_TYPE_GMRES = 0,
479: KSP_HPDDM_TYPE_BGMRES = 1,
480: KSP_HPDDM_TYPE_CG = 2,
481: KSP_HPDDM_TYPE_BCG = 3,
482: KSP_HPDDM_TYPE_GCRODR = 4,
483: KSP_HPDDM_TYPE_BGCRODR = 5,
484: KSP_HPDDM_TYPE_BFBCG = 6,
485: KSP_HPDDM_TYPE_PREONLY = 7
486: } KSPHPDDMType;
487: PETSC_EXTERN const char *const KSPHPDDMTypes[];
489: PETSC_EXTERN PetscErrorCode KSPHPDDMSetType(KSP, KSPHPDDMType);
490: PETSC_EXTERN PetscErrorCode KSPHPDDMGetType(KSP, KSPHPDDMType *);
492: /*E
493: KSPGMRESCGSRefinementType - How the classical (unmodified) Gram-Schmidt is performed in the GMRES solvers
495: Values:
496: + `KSP_GMRES_CGS_REFINE_NEVER` - one step of classical Gram-Schmidt
497: . `KSP_GMRES_CGS_REFINE_IFNEEDED` - a second step is performed if the first step does not satisfy some criteria
498: - `KSP_GMRES_CGS_REFINE_ALWAYS` - always perform two steps
500: Level: advanced
502: .seealso: [](ch_ksp), `KSP`, `KSPGMRES`, `KSPGMRESClassicalGramSchmidtOrthogonalization()`, `KSPGMRESSetOrthogonalization()`,
503: `KSPGMRESGetOrthogonalization()`,
504: `KSPGMRESSetCGSRefinementType()`, `KSPGMRESGetCGSRefinementType()`, `KSPGMRESModifiedGramSchmidtOrthogonalization()`
505: E*/
506: typedef enum {
507: KSP_GMRES_CGS_REFINE_NEVER,
508: KSP_GMRES_CGS_REFINE_IFNEEDED,
509: KSP_GMRES_CGS_REFINE_ALWAYS
510: } KSPGMRESCGSRefinementType;
511: PETSC_EXTERN const char *const KSPGMRESCGSRefinementTypes[];
513: /*MC
514: KSP_GMRES_CGS_REFINE_NEVER - Do the classical (unmodified) Gram-Schmidt process
516: Level: advanced
518: Note:
519: Possibly unstable, but the fastest to compute
521: .seealso: [](ch_ksp), `KSPGMRES`, `KSPGMRESCGSRefinementType`, `KSPGMRESClassicalGramSchmidtOrthogonalization()`, `KSPGMRESSetOrthogonalization()`,
522: `KSP`, `KSPGMRESGetOrthogonalization()`,
523: `KSPGMRESSetCGSRefinementType()`, `KSPGMRESGetCGSRefinementType()`, `KSP_GMRES_CGS_REFINE_IFNEEDED`, `KSP_GMRES_CGS_REFINE_ALWAYS`,
524: `KSPGMRESModifiedGramSchmidtOrthogonalization()`
525: M*/
527: /*MC
528: KSP_GMRES_CGS_REFINE_IFNEEDED - Do the classical (unmodified) Gram-Schmidt process and one step of
529: iterative refinement if an estimate of the orthogonality of the resulting vectors indicates
530: poor orthogonality.
532: Level: advanced
534: Note:
535: This is slower than `KSP_GMRES_CGS_REFINE_NEVER` because it requires an extra norm computation to
536: estimate the orthogonality but is more stable.
538: .seealso: [](ch_ksp), `KSPGMRES`, `KSPGMRESCGSRefinementType`, `KSPGMRESClassicalGramSchmidtOrthogonalization()`, `KSPGMRESSetOrthogonalization()`,
539: `KSP`, `KSPGMRESGetOrthogonalization()`,
540: `KSPGMRESSetCGSRefinementType()`, `KSPGMRESGetCGSRefinementType()`, `KSP_GMRES_CGS_REFINE_NEVER`, `KSP_GMRES_CGS_REFINE_ALWAYS`,
541: `KSPGMRESModifiedGramSchmidtOrthogonalization()`
542: M*/
544: /*MC
545: KSP_GMRES_CGS_REFINE_ALWAYS - Do two steps of the classical (unmodified) Gram-Schmidt process.
547: Level: advanced
549: Notes:
550: This is roughly twice the cost of `KSP_GMRES_CGS_REFINE_NEVER` because it performs the process twice
551: but it saves the extra norm calculation needed by `KSP_GMRES_CGS_REFINE_IFNEEDED`.
553: You should only use this if you absolutely know that the iterative refinement is needed.
555: .seealso: [](ch_ksp), `KSPGMRES`, `KSPGMRESCGSRefinementType`, `KSPGMRESClassicalGramSchmidtOrthogonalization()`, `KSPGMRESSetOrthogonalization()`,
556: `KSP`, `KSPGMRESGetOrthogonalization()`,
557: `KSPGMRESSetCGSRefinementType()`, `KSPGMRESGetCGSRefinementType()`, `KSP_GMRES_CGS_REFINE_IFNEEDED`, `KSP_GMRES_CGS_REFINE_ALWAYS`,
558: `KSPGMRESModifiedGramSchmidtOrthogonalization()`
559: M*/
561: PETSC_EXTERN PetscErrorCode KSPGMRESSetCGSRefinementType(KSP, KSPGMRESCGSRefinementType);
562: PETSC_EXTERN PetscErrorCode KSPGMRESGetCGSRefinementType(KSP, KSPGMRESCGSRefinementType *);
564: PETSC_EXTERN KSPFlexibleModifyPCFn KSPFlexibleModifyPCNoChange;
565: PETSC_EXTERN KSPFlexibleModifyPCFn KSPFlexibleModifyPCKSP;
567: PETSC_DEPRECATED_FUNCTION(3, 25, 0, "KSPFlexibleModifyPCNoChange()", )
568: static inline PetscErrorCode KSPFGMRESModifyPCNoChange(KSP ksp, PetscInt total_its, PetscInt loc_its, PetscReal res_norm, PetscCtx ctx)
569: {
570: return KSPFlexibleModifyPCNoChange(ksp, total_its, loc_its, res_norm, ctx);
571: }
573: PETSC_DEPRECATED_FUNCTION(3, 25, 0, "KSPFlexibleModifyPCKSP()", )
574: static inline PetscErrorCode KSPFGMRESModifyPCKSP(KSP ksp, PetscInt total_its, PetscInt loc_its, PetscReal res_norm, PetscCtx ctx)
575: {
576: return KSPFlexibleModifyPCKSP(ksp, total_its, loc_its, res_norm, ctx);
577: }
579: PETSC_EXTERN PetscErrorCode KSPQCGSetTrustRegionRadius(KSP, PetscReal);
580: PETSC_EXTERN PetscErrorCode KSPQCGGetQuadratic(KSP, PetscReal *);
581: PETSC_EXTERN PetscErrorCode KSPQCGGetTrialStepNorm(KSP, PetscReal *);
583: PETSC_EXTERN PetscErrorCode KSPBCGSLSetXRes(KSP, PetscReal);
584: PETSC_EXTERN PetscErrorCode KSPBCGSLSetPol(KSP, PetscBool);
585: PETSC_EXTERN PetscErrorCode KSPBCGSLSetEll(KSP, PetscInt);
586: PETSC_EXTERN PetscErrorCode KSPBCGSLSetUsePseudoinverse(KSP, PetscBool);
588: PETSC_EXTERN PetscErrorCode KSPSetFromOptions(KSP);
589: PETSC_EXTERN PetscErrorCode KSPResetFromOptions(KSP);
591: PETSC_EXTERN PetscErrorCode KSPMonitorSetFromOptions(KSP, const char[], const char[], PetscCtx);
592: PETSC_EXTERN KSPMonitorRegisterFn KSPMonitorResidual;
593: PETSC_EXTERN KSPMonitorRegisterFn KSPMonitorResidualView;
594: PETSC_DEPRECATED_FUNCTION(3, 23, 0, "KSPMonitorResidualDraw()", ) static inline PetscErrorCode KSPMonitorResidualDraw(KSP ksp, PetscInt n, PetscReal rnorm, PetscViewerAndFormat *vf)
595: {
596: return KSPMonitorResidualView(ksp, n, rnorm, vf);
597: }
598: PETSC_EXTERN KSPMonitorRegisterFn KSPMonitorResidualDrawLG;
599: PETSC_EXTERN PetscErrorCode KSPMonitorResidualDrawLGCreate(PetscViewer, PetscViewerFormat, PetscCtx, PetscViewerAndFormat **);
600: PETSC_EXTERN KSPMonitorRegisterFn KSPMonitorResidualShort;
601: PETSC_EXTERN KSPMonitorRegisterFn KSPMonitorResidualRange;
602: PETSC_EXTERN KSPMonitorRegisterFn KSPMonitorTrueResidual;
603: PETSC_EXTERN KSPMonitorRegisterFn KSPMonitorTrueResidualView;
604: PETSC_DEPRECATED_FUNCTION(3, 23, 0, "KSPMonitorTrueResidualDraw()", ) static inline PetscErrorCode KSPMonitorTrueResidualDraw(KSP ksp, PetscInt n, PetscReal rnorm, PetscViewerAndFormat *vf)
605: {
606: return KSPMonitorTrueResidualView(ksp, n, rnorm, vf);
607: }
608: PETSC_EXTERN KSPMonitorRegisterFn KSPMonitorTrueResidualDrawLG;
609: PETSC_EXTERN PetscErrorCode KSPMonitorTrueResidualDrawLGCreate(PetscViewer, PetscViewerFormat, PetscCtx, PetscViewerAndFormat **);
610: PETSC_EXTERN KSPMonitorRegisterFn KSPMonitorTrueResidualMax;
611: PETSC_EXTERN KSPMonitorRegisterFn KSPMonitorError;
612: PETSC_EXTERN KSPMonitorRegisterFn KSPMonitorErrorDraw;
613: PETSC_EXTERN KSPMonitorRegisterFn KSPMonitorErrorDrawLG;
614: PETSC_EXTERN PetscErrorCode KSPMonitorErrorDrawLGCreate(PetscViewer, PetscViewerFormat, PetscCtx, PetscViewerAndFormat **);
615: PETSC_EXTERN KSPMonitorRegisterFn KSPMonitorSolution;
616: PETSC_EXTERN KSPMonitorRegisterFn KSPMonitorSolutionDraw;
617: PETSC_EXTERN KSPMonitorRegisterFn KSPMonitorSolutionDrawLG;
618: PETSC_EXTERN PetscErrorCode KSPMonitorSolutionDrawLGCreate(PetscViewer, PetscViewerFormat, PetscCtx, PetscViewerAndFormat **);
619: PETSC_EXTERN KSPMonitorRegisterFn KSPMonitorSingularValue;
620: PETSC_EXTERN PetscErrorCode KSPMonitorSingularValueCreate(PetscViewer, PetscViewerFormat, PetscCtx, PetscViewerAndFormat **);
621: PETSC_DEPRECATED_FUNCTION(3, 15, 0, "KSPMonitorResidual()", ) static inline PetscErrorCode KSPMonitorDefault(KSP ksp, PetscInt n, PetscReal rnorm, PetscViewerAndFormat *vf)
622: {
623: return KSPMonitorResidual(ksp, n, rnorm, vf);
624: }
625: PETSC_DEPRECATED_FUNCTION(3, 15, 0, "KSPMonitorTrueResidual()", ) static inline PetscErrorCode KSPMonitorTrueResidualNorm(KSP ksp, PetscInt n, PetscReal rnorm, PetscViewerAndFormat *vf)
626: {
627: return KSPMonitorTrueResidual(ksp, n, rnorm, vf);
628: }
629: PETSC_DEPRECATED_FUNCTION(3, 15, 0, "KSPMonitorTrueResidualMax()", ) static inline PetscErrorCode KSPMonitorTrueResidualMaxNorm(KSP ksp, PetscInt n, PetscReal rnorm, PetscViewerAndFormat *vf)
630: {
631: return KSPMonitorTrueResidualMax(ksp, n, rnorm, vf);
632: }
634: PETSC_EXTERN PetscErrorCode KSPGMRESMonitorKrylov(KSP, PetscInt, PetscReal, void *);
635: PETSC_EXTERN PetscErrorCode KSPMonitorDynamicTolerance(KSP, PetscInt, PetscReal, PetscCtx);
636: PETSC_EXTERN PetscErrorCode KSPMonitorDynamicToleranceDestroy(PetscCtxRt);
637: PETSC_EXTERN PetscErrorCode KSPMonitorDynamicToleranceCreate(void *);
638: PETSC_EXTERN PetscErrorCode KSPMonitorDynamicToleranceSetCoefficient(void *, PetscReal);
639: PETSC_EXTERN PetscErrorCode KSPMonitorSAWs(KSP, PetscInt, PetscReal, void *);
640: PETSC_EXTERN PetscErrorCode KSPMonitorSAWsCreate(KSP, void **);
641: PETSC_EXTERN PetscErrorCode KSPMonitorSAWsDestroy(PetscCtxRt);
643: PETSC_EXTERN PetscErrorCode KSPUnwindPreconditioner(KSP, Vec, Vec);
644: PETSC_EXTERN PetscErrorCode KSPInitialResidual(KSP, Vec, Vec, Vec, Vec, Vec);
646: PETSC_EXTERN PetscErrorCode KSPSetOperators(KSP, Mat, Mat);
647: PETSC_EXTERN PetscErrorCode KSPGetOperators(KSP, Mat *, Mat *);
648: PETSC_EXTERN PetscErrorCode KSPGetOperatorsSet(KSP, PetscBool *, PetscBool *);
649: PETSC_EXTERN PetscErrorCode KSPSetOptionsPrefix(KSP, const char[]);
650: PETSC_EXTERN PetscErrorCode KSPAppendOptionsPrefix(KSP, const char[]);
651: PETSC_EXTERN PetscErrorCode KSPGetOptionsPrefix(KSP, const char *[]);
653: PETSC_EXTERN PetscErrorCode KSPSetDiagonalScale(KSP, PetscBool);
654: PETSC_EXTERN PetscErrorCode KSPGetDiagonalScale(KSP, PetscBool *);
655: PETSC_EXTERN PetscErrorCode KSPSetDiagonalScaleFix(KSP, PetscBool);
656: PETSC_EXTERN PetscErrorCode KSPGetDiagonalScaleFix(KSP, PetscBool *);
658: /*S
659: KSPConvergedReasonViewFn - A prototype of a function used with `KSPConvergedReasonViewSet()`
661: Calling Sequence:
662: + ksp - the `KSP` object whose `KSPConvergedReason` is to be viewed
663: - ctx - context used by the function, set with `KSPConvergedReasonViewSet()`
665: Level: beginner
667: .seealso: [](ch_ksp), `KSP`, `KSPConvergedReasonView()`, `KSPConvergedReasonViewSet()`, `KSPConvergedReasonViewFromOptions()`, `KSPView()`
668: S*/
669: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode KSPConvergedReasonViewFn(KSP ksp, PetscCtx ctx);
671: PETSC_EXTERN PetscErrorCode KSPView(KSP, PetscViewer);
672: PETSC_EXTERN PetscErrorCode KSPLoad(KSP, PetscViewer);
673: PETSC_EXTERN PetscErrorCode KSPViewFromOptions(KSP, PetscObject, const char[]);
674: PETSC_EXTERN PetscErrorCode KSPConvergedReasonView(KSP, PetscViewer);
675: PETSC_EXTERN PetscErrorCode KSPConvergedReasonViewSet(KSP, KSPConvergedReasonViewFn *, void *, PetscCtxDestroyFn *);
676: PETSC_EXTERN PetscErrorCode KSPConvergedReasonViewFromOptions(KSP);
677: PETSC_EXTERN PetscErrorCode KSPConvergedReasonViewCancel(KSP);
678: PETSC_EXTERN PetscErrorCode KSPConvergedRateView(KSP, PetscViewer);
680: PETSC_DEPRECATED_FUNCTION(3, 14, 0, "KSPConvergedReasonView()", ) static inline PetscErrorCode KSPReasonView(KSP ksp, PetscViewer v)
681: {
682: return KSPConvergedReasonView(ksp, v);
683: }
684: PETSC_DEPRECATED_FUNCTION(3, 14, 0, "KSPConvergedReasonViewFromOptions()", ) static inline PetscErrorCode KSPReasonViewFromOptions(KSP ksp)
685: {
686: return KSPConvergedReasonViewFromOptions(ksp);
687: }
689: #define KSP_FILE_CLASSID 1211223
691: PETSC_EXTERN PetscErrorCode KSPLSQRSetExactMatNorm(KSP, PetscBool);
692: PETSC_EXTERN PetscErrorCode KSPLSQRSetComputeStandardErrorVec(KSP, PetscBool);
693: PETSC_EXTERN PetscErrorCode KSPLSQRGetStandardErrorVec(KSP, Vec *);
694: PETSC_EXTERN PetscErrorCode KSPLSQRGetNorms(KSP, PetscReal *, PetscReal *);
695: PETSC_EXTERN KSPMonitorRegisterFn KSPLSQRMonitorResidual;
696: PETSC_EXTERN KSPMonitorRegisterFn KSPLSQRMonitorResidualDrawLG;
697: PETSC_EXTERN PetscErrorCode KSPLSQRMonitorResidualDrawLGCreate(PetscViewer, PetscViewerFormat, void *, PetscViewerAndFormat **);
699: PETSC_EXTERN PetscErrorCode PCRedundantGetKSP(PC, KSP *);
700: PETSC_EXTERN PetscErrorCode PCRedistributeGetKSP(PC, KSP *);
701: PETSC_EXTERN PetscErrorCode PCTelescopeGetKSP(PC, KSP *);
702: PETSC_EXTERN PetscErrorCode PCMPIGetKSP(PC, KSP *);
704: /*E
705: KSPNormType - Norm calculated by the `KSP` and passed in the Krylov convergence
706: test routines.
708: Values:
709: + `KSP_NORM_DEFAULT` - use the default for the current `KSPType`
710: . `KSP_NORM_NONE` - use no norm calculation
711: . `KSP_NORM_PRECONDITIONED` - use the preconditioned residual norm
712: . `KSP_NORM_UNPRECONDITIONED` - use the unpreconditioned residual norm
713: - `KSP_NORM_NATURAL` - use the natural norm (the norm induced by the linear operator)
715: Level: advanced
717: Note:
718: Each solver only supports a subset of these and some may support different ones
719: depending on whether left or right preconditioning is used, see `KSPSetPCSide()`
721: .seealso: [](ch_ksp), `KSP`, `PCSide`, `KSPSolve()`, `KSPGetConvergedReason()`, `KSPSetNormType()`,
722: `KSPSetConvergenceTest()`, `KSPSetPCSide()`, `KSP_NORM_DEFAULT`, `KSP_NORM_NONE`, `KSP_NORM_PRECONDITIONED`, `KSP_NORM_UNPRECONDITIONED`, `KSP_NORM_NATURAL`
723: E*/
724: typedef enum {
725: KSP_NORM_DEFAULT = -1,
726: KSP_NORM_NONE = 0,
727: KSP_NORM_PRECONDITIONED = 1,
728: KSP_NORM_UNPRECONDITIONED = 2,
729: KSP_NORM_NATURAL = 3
730: } KSPNormType;
731: #define KSP_NORM_MAX (KSP_NORM_NATURAL + 1)
732: PETSC_EXTERN const char *const *const KSPNormTypes;
734: /*MC
735: KSP_NORM_NONE - Do not compute a norm during the Krylov process. This will
736: possibly save some computation but means the convergence test cannot
737: be based on a norm of a residual etc.
739: Level: advanced
741: Note:
742: Some Krylov methods need to compute a residual norm (such as `KPSGMRES`) and then this option is ignored
744: .seealso: [](ch_ksp), `KSPNormType`, `KSP`, `KSPSetNormType()`, `KSP_NORM_PRECONDITIONED`, `KSP_NORM_UNPRECONDITIONED`, `KSP_NORM_NATURAL`
745: M*/
747: /*MC
748: KSP_NORM_PRECONDITIONED - Compute the norm of the preconditioned residual B*(b - A*x), if left preconditioning, and pass that to the
749: convergence test routine.
751: Level: advanced
753: .seealso: [](ch_ksp), `KSPNormType`, `KSP`, `KSPSetNormType()`, `KSP_NORM_NONE`, `KSP_NORM_UNPRECONDITIONED`, `KSP_NORM_NATURAL`, `KSPSetConvergenceTest()`
754: M*/
756: /*MC
757: KSP_NORM_UNPRECONDITIONED - Compute the norm of the true residual (b - A*x) and pass that to the
758: convergence test routine.
760: Level: advanced
762: .seealso: [](ch_ksp), `KSPNormType`, `KSP`, `KSPSetNormType()`, `KSP_NORM_NONE`, `KSP_NORM_PRECONDITIONED`, `KSP_NORM_NATURAL`, `KSPSetConvergenceTest()`
763: M*/
765: /*MC
766: KSP_NORM_NATURAL - Compute the 'natural norm' of residual sqrt((b - A*x)*B*(b - A*x)) and pass that to the
767: convergence test routine. This is only supported by `KSPCG`, `KSPCR`, `KSPCGNE`, `KSPCGS`, `KSPFCG`, `KSPPIPEFCG`, `KSPPIPEGCR`
769: Level: advanced
771: .seealso: [](ch_ksp), `KSPNormType`, `KSP`, `KSPSetNormType()`, `KSP_NORM_NONE`, `KSP_NORM_PRECONDITIONED`, `KSP_NORM_UNPRECONDITIONED`, `KSPSetConvergenceTest()`
772: M*/
774: PETSC_EXTERN PetscErrorCode KSPSetNormType(KSP, KSPNormType);
775: PETSC_EXTERN PetscErrorCode KSPGetNormType(KSP, KSPNormType *);
776: PETSC_EXTERN PetscErrorCode KSPSetSupportedNorm(KSP, KSPNormType, PCSide, PetscInt);
777: PETSC_EXTERN PetscErrorCode KSPSetCheckNormIteration(KSP, PetscInt);
778: PETSC_EXTERN PetscErrorCode KSPSetLagNorm(KSP, PetscBool);
780: #define KSP_CONVERGED_CG_NEG_CURVE_DEPRECATED KSP_CONVERGED_CG_NEG_CURVE PETSC_DEPRECATED_ENUM(3, 19, 0, "KSP_CONVERGED_NEG_CURVE", )
781: #define KSP_CONVERGED_CG_CONSTRAINED_DEPRECATED KSP_CONVERGED_CG_CONSTRAINED PETSC_DEPRECATED_ENUM(3, 19, 0, "KSP_CONVERGED_STEP_LENGTH", )
782: #define KSP_CONVERGED_RTOL_NORMAL_DEPRECATED KSP_CONVERGED_RTOL_NORMAL PETSC_DEPRECATED_ENUM(3, 24, 0, "KSP_CONVERGED_RTOL_NORMAL_EQUATIONS", )
783: #define KSP_CONVERGED_ATOL_NORMAL_DEPRECATED KSP_CONVERGED_ATOL_NORMAL PETSC_DEPRECATED_ENUM(3, 24, 0, "KSP_CONVERGED_ATOL_NORMAL_EQUATIONS", )
784: /*E
785: KSPConvergedReason - reason a Krylov method was determined to have converged or diverged
787: Values:
788: + `KSP_CONVERGED_RTOL_NORMAL_EQUATIONS` - requested decrease in the residual of the normal equations, for `KSPLSQR`
789: . `KSP_CONVERGED_ATOL_NORMAL_EQUATIONS` - requested absolute value in the residual of the normal equations, for `KSPLSQR`
790: . `KSP_CONVERGED_RTOL` - requested decrease in the residual
791: . `KSP_CONVERGED_ATOL` - requested absolute value in the residual
792: . `KSP_CONVERGED_ITS` - requested number of iterations
793: . `KSP_CONVERGED_NEG_CURVE` - see note below
794: . `KSP_CONVERGED_STEP_LENGTH` - see note below
795: . `KSP_CONVERGED_HAPPY_BREAKDOWN` - happy breakdown (meaning early convergence of the `KSPType` occurred).
796: . `KSP_CONVERGED_USER` - the user has indicated convergence for an arbitrary reason
797: . `KSP_DIVERGED_NULL` - breakdown when solving the Hessenberg system within `KSPGMRES`
798: . `KSP_DIVERGED_ITS` - requested number of iterations
799: . `KSP_DIVERGED_DTOL` - large increase in the residual norm indicating the solution is diverging
800: . `KSP_DIVERGED_BREAKDOWN` - breakdown in the Krylov method
801: . `KSP_DIVERGED_BREAKDOWN_BICG` - breakdown in the `KSPBCGS` Krylov method
802: . `KSP_DIVERGED_NONSYMMETRIC` - the operator or preonditioner was not symmetric for a `KSPType` that requires symmetry
803: . `KSP_DIVERGED_INDEFINITE_PC` - the preconditioner was indefinite for a `KSPType` that requires it be definite, such as `KSPCG`
804: . `KSP_DIVERGED_NANORINF` - a not a number of infinity was detected in a vector during the computation
805: . `KSP_DIVERGED_INDEFINITE_MAT` - the operator was indefinite for a `KSPType` that requires it be definite, such as `KSPCG`
806: . `KSP_DIVERGED_PC_FAILED` - the action of the preconditioner failed for some reason
807: - `KSP_DIVERGED_USER` - the user has indicated divergence for an arbitrary reason
809: Level: beginner
811: Note:
812: The values `KSP_CONVERGED_NEG_CURVE`, and `KSP_CONVERGED_STEP_LENGTH` are returned only by `KSPCG`, `KSPMINRES` and by
813: the special `KSPNASH`, `KSPSTCG`, and `KSPGLTR` solvers which are used by the `SNESNEWTONTR` (trust region) solver.
815: Developer Note:
816: The string versions of these are `KSPConvergedReasons`; if you change
817: any of the values here also change them that array of names.
819: .seealso: [](ch_ksp), `KSP`, `KSPSolve()`, `KSPGetConvergedReason()`, `KSPSetTolerances()`, `KSPConvergedReasonView()`
820: E*/
821: typedef enum { /* converged */
822: KSP_CONVERGED_RTOL_NORMAL_DEPRECATED = 1,
823: KSP_CONVERGED_RTOL_NORMAL_EQUATIONS = 1,
824: KSP_CONVERGED_ATOL_NORMAL_DEPRECATED = 9,
825: KSP_CONVERGED_ATOL_NORMAL_EQUATIONS = 9,
826: KSP_CONVERGED_RTOL = 2,
827: KSP_CONVERGED_ATOL = 3,
828: KSP_CONVERGED_ITS = 4,
829: KSP_CONVERGED_NEG_CURVE = 5,
830: KSP_CONVERGED_CG_NEG_CURVE_DEPRECATED = 5,
831: KSP_CONVERGED_CG_CONSTRAINED_DEPRECATED = 6,
832: KSP_CONVERGED_STEP_LENGTH = 6,
833: KSP_CONVERGED_HAPPY_BREAKDOWN = 7,
834: KSP_CONVERGED_USER = 8,
835: /* diverged */
836: KSP_DIVERGED_NULL = -2,
837: KSP_DIVERGED_ITS = -3,
838: KSP_DIVERGED_DTOL = -4,
839: KSP_DIVERGED_BREAKDOWN = -5,
840: KSP_DIVERGED_BREAKDOWN_BICG = -6,
841: KSP_DIVERGED_NONSYMMETRIC = -7,
842: KSP_DIVERGED_INDEFINITE_PC = -8,
843: KSP_DIVERGED_NANORINF = -9,
844: KSP_DIVERGED_INDEFINITE_MAT = -10,
845: KSP_DIVERGED_PC_FAILED = -11,
846: KSP_DIVERGED_PCSETUP_FAILED_DEPRECATED = -11,
847: KSP_DIVERGED_USER = -12,
849: KSP_CONVERGED_ITERATING = 0
850: } KSPConvergedReason;
851: PETSC_EXTERN const char *const *KSPConvergedReasons;
853: /*MC
854: KSP_CONVERGED_RTOL - $||r|| \le rtol*||b||$ or $rtol*||b - A*x_0||$ if `KSPConvergedDefaultSetUIRNorm()` was called
856: Level: beginner
858: Notes:
859: See `KSPNormType` and `KSPSetNormType()` for possible norms that may be used. By default
860: for left preconditioning it is the 2-norm of the preconditioned residual, and the
861: 2-norm of the residual for right preconditioning
863: See also `KSP_CONVERGED_ATOL` which may apply before this tolerance.
865: .seealso: [](ch_ksp), `KSPNormType`, `KSP_CONVERGED_ATOL`, `KSP_DIVERGED_DTOL`, `KSPSolve()`, `KSPGetConvergedReason()`, `KSPConvergedReason`, `KSPSetTolerances()`
866: M*/
868: /*MC
869: KSP_CONVERGED_ATOL - $||r|| \le atol$
871: Level: beginner
873: Notes:
874: See `KSPNormType` and `KSPSetNormType()` for possible norms that may be used. By default
875: for left preconditioning it is the 2-norm of the preconditioned residual, and the
876: 2-norm of the residual for right preconditioning
878: See also `KSP_CONVERGED_RTOL` which may apply before this tolerance.
880: .seealso: [](ch_ksp), `KSPNormType`, `KSP_CONVERGED_RTOL`, `KSP_DIVERGED_DTOL`, `KSPSolve()`, `KSPGetConvergedReason()`, `KSPConvergedReason`, `KSPSetTolerances()`
881: M*/
883: /*MC
884: KSP_DIVERGED_DTOL - $||r|| \ge dtol*||b||$
886: Level: beginner
888: Note:
889: See `KSPNormType` and `KSPSetNormType()` for possible norms that may be used. By default
890: for left preconditioning it is the 2-norm of the preconditioned residual, and the
891: 2-norm of the residual for right preconditioning
893: .seealso: [](ch_ksp), `KSPNormType`, `KSP_CONVERGED_ATOL`, `KSP_CONVERGED_RTOL`, `KSPSolve()`, `KSPGetConvergedReason()`, `KSPConvergedReason`, `KSPSetTolerances()`
894: M*/
896: /*MC
897: KSP_DIVERGED_ITS - Ran out of iterations before any convergence criteria was
898: reached
900: Level: beginner
902: .seealso: [](ch_ksp), `KSPSolve()`, `KSPGetConvergedReason()`, `KSPConvergedReason`, `KSPSetTolerances()`
903: M*/
905: /*MC
906: KSP_CONVERGED_ITS - Used by the `KSPPREONLY` solver after the single iteration of
907: the preconditioner is applied. Also used when the `KSPConvergedSkip()` convergence
908: test routine is set in `KSP`.
910: Level: beginner
912: .seealso: [](ch_ksp), `KSPSolve()`, `KSPGetConvergedReason()`, `KSPConvergedReason`, `KSPSetTolerances()`
913: M*/
915: /*MC
916: KSP_DIVERGED_BREAKDOWN - A breakdown in the Krylov method was detected so the
917: method could not continue to enlarge the Krylov space. Could be due to a singular matrix or
918: preconditioner. In `KSPHPDDM`, this is also returned when some search directions within a block
919: are collinear.
921: Level: beginner
923: .seealso: [](ch_ksp), `KSPSolve()`, `KSPGetConvergedReason()`, `KSPConvergedReason`, `KSPSetTolerances()`
924: M*/
926: /*MC
927: KSP_DIVERGED_BREAKDOWN_BICG - A breakdown in the `KSPBICG` method was detected so the
928: method could not continue to enlarge the Krylov space.
930: Level: beginner
932: .seealso: [](ch_ksp), `KSPSolve()`, `KSPGetConvergedReason()`, `KSPConvergedReason`, `KSPSetTolerances()`
933: M*/
935: /*MC
936: KSP_DIVERGED_NONSYMMETRIC - It appears the operator or preconditioner is not
937: symmetric and this Krylov method (`KSPCG`, `KSPMINRES`, `KSPCR`) requires symmetry
939: Level: beginner
941: .seealso: [](ch_ksp), `KSPSolve()`, `KSPGetConvergedReason()`, `KSPConvergedReason`, `KSPSetTolerances()`
942: M*/
944: /*MC
945: KSP_DIVERGED_INDEFINITE_PC - It appears the preconditioner is indefinite (has both
946: positive and negative eigenvalues) and this Krylov method (`KSPCG`) requires it to
947: be symmetric positive definite (SPD).
949: Level: beginner
951: Note:
952: This can happen with the `PCICC` preconditioner, use the options database option `-pc_factor_shift_positive_definite` to force
953: the `PCICC` preconditioner to generate a positive definite preconditioner
955: .seealso: [](ch_ksp), `KSPSolve()`, `KSPGetConvergedReason()`, `KSPConvergedReason`, `KSPSetTolerances()`
956: M*/
958: /*MC
959: KSP_DIVERGED_PC_FAILED - It was not possible to build or use the requested preconditioner. This is usually due to a
960: zero pivot in a factorization. It can also result from a failure in a subpreconditioner inside a nested preconditioner
961: such as `PCFIELDSPLIT`.
963: Level: beginner
965: Note:
966: Run with `-ksp_error_if_not_converged` to stop the program when the error is detected and print an error message with details.
968: .seealso: [](ch_ksp), `KSPSolve()`, `KSPGetConvergedReason()`, `KSPConvergedReason`, `KSPSetTolerances()`
969: M*/
971: /*MC
972: KSP_CONVERGED_ITERATING - This flag is returned if `KSPGetConvergedReason()` is called
973: while `KSPSolve()` is still running.
975: Level: beginner
977: .seealso: [](ch_ksp), `KSPSolve()`, `KSPGetConvergedReason()`, `KSPConvergedReason`, `KSPSetTolerances()`
978: M*/
980: /*S
981: KSPConvergenceTestFn - A prototype of a function used with `KSPSetConvergenceTest()`
983: Calling Sequence:
984: + ksp - iterative solver obtained from `KSPCreate()`
985: . it - iteration number
986: . rnorm - (estimated) 2-norm of (preconditioned) residual
987: . reason - the reason why it has converged or diverged
988: - ctx - optional convergence context, as set by `KSPSetConvergenceTest()`
990: Level: beginner
992: .seealso: [](ch_ksp), `KSP`, `KSPSetConvergenceTest()`, `KSPGetConvergenceTest()`
993: S*/
994: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode KSPConvergenceTestFn(KSP ksp, PetscInt it, PetscReal rnorm, KSPConvergedReason *reason, PetscCtx ctx);
996: PETSC_EXTERN PetscErrorCode KSPSetConvergenceTest(KSP, KSPConvergenceTestFn *, void *, PetscCtxDestroyFn *);
997: PETSC_EXTERN PetscErrorCode KSPGetConvergenceTest(KSP, KSPConvergenceTestFn **, PetscCtxRt, PetscCtxDestroyFn **);
998: PETSC_EXTERN PetscErrorCode KSPGetAndClearConvergenceTest(KSP, KSPConvergenceTestFn **, PetscCtxRt, PetscCtxDestroyFn **);
999: PETSC_EXTERN PetscErrorCode KSPGetConvergenceContext(KSP, PetscCtxRt);
1000: PETSC_EXTERN KSPConvergenceTestFn KSPConvergedDefault;
1001: PETSC_EXTERN KSPConvergenceTestFn KSPLSQRConvergedDefault;
1002: PETSC_EXTERN PetscCtxDestroyFn KSPConvergedDefaultDestroy;
1003: PETSC_EXTERN PetscErrorCode KSPConvergedDefaultCreate(void **);
1004: PETSC_EXTERN PetscErrorCode KSPConvergedDefaultSetUIRNorm(KSP);
1005: PETSC_EXTERN PetscErrorCode KSPConvergedDefaultSetUMIRNorm(KSP);
1006: PETSC_EXTERN PetscErrorCode KSPConvergedDefaultSetConvergedMaxits(KSP, PetscBool);
1007: PETSC_EXTERN PetscErrorCode KSPConvergedSkip(KSP, PetscInt, PetscReal, KSPConvergedReason *, void *);
1008: PETSC_EXTERN PetscErrorCode KSPGetConvergedReason(KSP, KSPConvergedReason *);
1009: PETSC_EXTERN PetscErrorCode KSPGetConvergedReasonString(KSP, const char *[]);
1010: PETSC_EXTERN PetscErrorCode KSPComputeConvergenceRate(KSP, PetscReal *, PetscReal *, PetscReal *, PetscReal *);
1011: PETSC_EXTERN PetscErrorCode KSPSetConvergedNegativeCurvature(KSP, PetscBool);
1012: PETSC_EXTERN PetscErrorCode KSPGetConvergedNegativeCurvature(KSP, PetscBool *);
1014: PETSC_DEPRECATED_FUNCTION(3, 5, 0, "KSPConvergedDefault()", ) static inline void KSPDefaultConverged(void)
1015: { /* never called */
1016: }
1017: #define KSPDefaultConverged (KSPDefaultConverged, KSPConvergedDefault)
1018: PETSC_DEPRECATED_FUNCTION(3, 5, 0, "KSPConvergedDefaultDestroy()", ) static inline void KSPDefaultConvergedDestroy(void)
1019: { /* never called */
1020: }
1021: #define KSPDefaultConvergedDestroy (KSPDefaultConvergedDestroy, KSPConvergedDefaultDestroy)
1022: PETSC_DEPRECATED_FUNCTION(3, 5, 0, "KSPConvergedDefaultCreate()", ) static inline void KSPDefaultConvergedCreate(void)
1023: { /* never called */
1024: }
1025: #define KSPDefaultConvergedCreate (KSPDefaultConvergedCreate, KSPConvergedDefaultCreate)
1026: PETSC_DEPRECATED_FUNCTION(3, 5, 0, "KSPConvergedDefaultSetUIRNorm()", ) static inline void KSPDefaultConvergedSetUIRNorm(void)
1027: { /* never called */
1028: }
1029: #define KSPDefaultConvergedSetUIRNorm (KSPDefaultConvergedSetUIRNorm, KSPConvergedDefaultSetUIRNorm)
1030: PETSC_DEPRECATED_FUNCTION(3, 5, 0, "KSPConvergedDefaultSetUMIRNorm()", ) static inline void KSPDefaultConvergedSetUMIRNorm(void)
1031: { /* never called */
1032: }
1033: #define KSPDefaultConvergedSetUMIRNorm (KSPDefaultConvergedSetUMIRNorm, KSPConvergedDefaultSetUMIRNorm)
1034: PETSC_DEPRECATED_FUNCTION(3, 5, 0, "KSPConvergedSkip()", ) static inline void KSPSkipConverged(void)
1035: { /* never called */
1036: }
1037: #define KSPSkipConverged (KSPSkipConverged, KSPConvergedSkip)
1039: PETSC_EXTERN PetscErrorCode KSPComputeOperator(KSP, MatType, Mat *);
1040: PETSC_DEPRECATED_FUNCTION(3, 12, 0, "KSPComputeOperator()", ) static inline PetscErrorCode KSPComputeExplicitOperator(KSP A, Mat *B)
1041: {
1042: return KSPComputeOperator(A, PETSC_NULLPTR, B);
1043: }
1045: /*E
1046: KSPCGType - Determines what type of `KSPCG` to use
1048: Values:
1049: + `KSP_CG_SYMMETRIC` - the matrix is complex symmetric
1050: - `KSP_CG_HERMITIAN` - the matrix is complex Hermitian
1052: Level: beginner
1054: .seealso: [](ch_ksp), `KSPCG`, `KSP`, `KSPCGSetType()`
1055: E*/
1056: typedef enum {
1057: KSP_CG_SYMMETRIC = 0,
1058: KSP_CG_HERMITIAN = 1
1059: } KSPCGType;
1060: PETSC_EXTERN const char *const KSPCGTypes[];
1062: PETSC_EXTERN PetscErrorCode KSPCGSetType(KSP, KSPCGType);
1063: PETSC_EXTERN PetscErrorCode KSPCGUseSingleReduction(KSP, PetscBool);
1065: PETSC_EXTERN PetscErrorCode KSPCGSetRadius(KSP, PetscReal);
1066: PETSC_EXTERN PetscErrorCode KSPCGSetObjectiveTarget(KSP, PetscReal);
1067: PETSC_EXTERN PetscErrorCode KSPCGGetNormD(KSP, PetscReal *);
1068: PETSC_EXTERN PetscErrorCode KSPCGGetObjFcn(KSP, PetscReal *);
1070: PETSC_EXTERN PetscErrorCode KSPGLTRGetMinEig(KSP, PetscReal *);
1071: PETSC_EXTERN PetscErrorCode KSPGLTRGetLambda(KSP, PetscReal *);
1072: PETSC_DEPRECATED_FUNCTION(3, 12, 0, "KSPGLTRGetMinEig()", ) static inline PetscErrorCode KSPCGGLTRGetMinEig(KSP ksp, PetscReal *x)
1073: {
1074: return KSPGLTRGetMinEig(ksp, x);
1075: }
1076: PETSC_DEPRECATED_FUNCTION(3, 12, 0, "KSPGLTRGetLambda()", ) static inline PetscErrorCode KSPCGGLTRGetLambda(KSP ksp, PetscReal *x)
1077: {
1078: return KSPGLTRGetLambda(ksp, x);
1079: }
1081: PETSC_EXTERN PetscErrorCode KSPPythonSetType(KSP, const char[]);
1082: PETSC_EXTERN PetscErrorCode KSPPythonGetType(KSP, const char *[]);
1084: PETSC_EXTERN PetscErrorCode PCPreSolve(PC, KSP);
1085: PETSC_EXTERN PetscErrorCode PCPostSolve(PC, KSP);
1087: PETSC_EXTERN PetscErrorCode KSPMonitorLGRange(KSP, PetscInt, PetscReal, void *);
1089: /*S
1090: PCShellPSolveFn - A function prototype for functions provided to `PCShellSetPreSolve()` and `PCShellSetPostSolve()`
1092: Calling Sequence:
1093: + pc - the preconditioner `PC` context
1094: . ksp - the `KSP` context
1095: . xin - input vector
1096: - xout - output vector
1098: Level: intermediate
1100: .seealso: [](ch_snes), `KSPPSolveFn`, `KSP`, `PCShellSetPreSolve()`, `PCShellSetPostSolve()`
1101: S*/
1102: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode PCShellPSolveFn(PC pc, KSP ksp, Vec xim, Vec xout);
1104: PETSC_EXTERN PetscErrorCode PCShellSetPreSolve(PC, PCShellPSolveFn *);
1105: PETSC_EXTERN PetscErrorCode PCShellSetPostSolve(PC, PCShellPSolveFn *);
1107: /*S
1108: KSPGuess - Abstract PETSc object that manages all initial guess generation methods for Krylov methods.
1110: Level: intermediate
1112: Note:
1113: These methods generate initial guesses based on a series of previous, related, linear solves. For example,
1114: in implicit time-stepping with `TS`.
1116: .seealso: [](ch_ksp), `KSPCreate()`, `KSPGuessSetType()`, `KSPGuessType`
1117: S*/
1118: typedef struct _p_KSPGuess *KSPGuess;
1120: /*J
1121: KSPGuessType - String with the name of a PETSc initial guess approach for Krylov methods.
1123: Values:
1124: + `KSPGUESSFISCHER` - methodology developed by Paul Fischer
1125: - `KSPGUESSPOD` - methodology based on proper orthogonal decomposition (POD)
1127: Level: intermediate
1129: .seealso: [](ch_ksp), `KSP`, `KSPGuess`
1130: J*/
1131: typedef const char *KSPGuessType;
1132: #define KSPGUESSFISCHER "fischer"
1133: #define KSPGUESSPOD "pod"
1135: PETSC_EXTERN PetscErrorCode KSPGuessRegister(const char[], PetscErrorCode (*)(KSPGuess));
1136: PETSC_EXTERN PetscErrorCode KSPSetGuess(KSP, KSPGuess);
1137: PETSC_EXTERN PetscErrorCode KSPGetGuess(KSP, KSPGuess *);
1138: PETSC_EXTERN PetscErrorCode KSPGuessView(KSPGuess, PetscViewer);
1139: PETSC_EXTERN PetscErrorCode KSPGuessDestroy(KSPGuess *);
1140: PETSC_EXTERN PetscErrorCode KSPGuessCreate(MPI_Comm, KSPGuess *);
1141: PETSC_EXTERN PetscErrorCode KSPGuessSetType(KSPGuess, KSPGuessType);
1142: PETSC_EXTERN PetscErrorCode KSPGuessGetType(KSPGuess, KSPGuessType *);
1143: PETSC_EXTERN PetscErrorCode KSPGuessSetTolerance(KSPGuess, PetscReal);
1144: PETSC_EXTERN PetscErrorCode KSPGuessSetUp(KSPGuess);
1145: PETSC_EXTERN PetscErrorCode KSPGuessUpdate(KSPGuess, Vec, Vec);
1146: PETSC_EXTERN PetscErrorCode KSPGuessFormGuess(KSPGuess, Vec, Vec);
1147: PETSC_EXTERN PetscErrorCode KSPGuessSetFromOptions(KSPGuess);
1148: PETSC_EXTERN PetscErrorCode KSPGuessFischerSetModel(KSPGuess, PetscInt, PetscInt);
1149: PETSC_EXTERN PetscErrorCode KSPSetUseFischerGuess(KSP, PetscInt, PetscInt);
1150: PETSC_EXTERN PetscErrorCode KSPSetInitialGuessKnoll(KSP, PetscBool);
1151: PETSC_EXTERN PetscErrorCode KSPGetInitialGuessKnoll(KSP, PetscBool *);
1153: /*E
1154: MatSchurComplementAinvType - Determines how to approximate the inverse of the (0,0) block in Schur complement matrix assembly routines
1156: Level: intermediate
1158: .seealso: `MatSchurComplementGetAinvType()`, `MatSchurComplementSetAinvType()`, `MatSchurComplementGetPmat()`, `MatGetSchurComplement()`,
1159: `MatCreateSchurComplementPmat()`, `MatCreateSchurComplement()`
1160: E*/
1161: typedef enum {
1162: MAT_SCHUR_COMPLEMENT_AINV_DIAG,
1163: MAT_SCHUR_COMPLEMENT_AINV_LUMP,
1164: MAT_SCHUR_COMPLEMENT_AINV_BLOCK_DIAG,
1165: MAT_SCHUR_COMPLEMENT_AINV_FULL
1166: } MatSchurComplementAinvType;
1167: PETSC_EXTERN const char *const MatSchurComplementAinvTypes[];
1169: PETSC_EXTERN PetscErrorCode MatCreateSchurComplement(Mat, Mat, Mat, Mat, Mat, Mat *);
1170: PETSC_EXTERN PetscErrorCode MatSchurComplementGetKSP(Mat, KSP *);
1171: PETSC_EXTERN PetscErrorCode MatSchurComplementSetKSP(Mat, KSP);
1172: PETSC_EXTERN PetscErrorCode MatSchurComplementSetSubMatrices(Mat, Mat, Mat, Mat, Mat, Mat);
1173: PETSC_EXTERN PetscErrorCode MatSchurComplementUpdateSubMatrices(Mat, Mat, Mat, Mat, Mat, Mat);
1174: PETSC_EXTERN PetscErrorCode MatSchurComplementGetSubMatrices(Mat, Mat *, Mat *, Mat *, Mat *, Mat *);
1175: PETSC_EXTERN PetscErrorCode MatSchurComplementSetAinvType(Mat, MatSchurComplementAinvType);
1176: PETSC_EXTERN PetscErrorCode MatSchurComplementGetAinvType(Mat, MatSchurComplementAinvType *);
1177: PETSC_EXTERN PetscErrorCode MatSchurComplementGetPmat(Mat, MatReuse, Mat *);
1178: PETSC_EXTERN PetscErrorCode MatSchurComplementComputeExplicitOperator(Mat, Mat *);
1179: PETSC_EXTERN PetscErrorCode MatGetSchurComplement(Mat, IS, IS, IS, IS, MatReuse, Mat *, MatSchurComplementAinvType, MatReuse, Mat *);
1180: PETSC_EXTERN PetscErrorCode MatCreateSchurComplementPmat(Mat, Mat, Mat, Mat, MatSchurComplementAinvType, MatReuse, Mat *);
1182: PETSC_EXTERN PetscErrorCode MatCreateLMVMDFP(MPI_Comm, PetscInt, PetscInt, Mat *);
1183: PETSC_EXTERN PetscErrorCode MatCreateLMVMBFGS(MPI_Comm, PetscInt, PetscInt, Mat *);
1184: PETSC_EXTERN PetscErrorCode MatCreateLMVMDBFGS(MPI_Comm, PetscInt, PetscInt, Mat *);
1185: PETSC_EXTERN PetscErrorCode MatCreateLMVMDDFP(MPI_Comm, PetscInt, PetscInt, Mat *);
1186: PETSC_EXTERN PetscErrorCode MatCreateLMVMDQN(MPI_Comm, PetscInt, PetscInt, Mat *);
1187: PETSC_EXTERN PetscErrorCode MatCreateLMVMSR1(MPI_Comm, PetscInt, PetscInt, Mat *);
1188: PETSC_EXTERN PetscErrorCode MatCreateLMVMBroyden(MPI_Comm, PetscInt, PetscInt, Mat *);
1189: PETSC_EXTERN PetscErrorCode MatCreateLMVMBadBroyden(MPI_Comm, PetscInt, PetscInt, Mat *);
1190: PETSC_EXTERN PetscErrorCode MatCreateLMVMSymBroyden(MPI_Comm, PetscInt, PetscInt, Mat *);
1191: PETSC_EXTERN PetscErrorCode MatCreateLMVMSymBadBroyden(MPI_Comm, PetscInt, PetscInt, Mat *);
1192: PETSC_EXTERN PetscErrorCode MatCreateLMVMDiagBroyden(MPI_Comm, PetscInt, PetscInt, Mat *);
1194: PETSC_EXTERN PetscErrorCode MatLMVMUpdate(Mat, Vec, Vec);
1195: PETSC_EXTERN PetscErrorCode MatLMVMIsAllocated(Mat, PetscBool *);
1196: PETSC_EXTERN PetscErrorCode MatLMVMAllocate(Mat, Vec, Vec);
1197: PETSC_EXTERN PetscErrorCode MatLMVMReset(Mat, PetscBool);
1198: PETSC_EXTERN PetscErrorCode MatLMVMResetShift(Mat);
1199: PETSC_EXTERN PetscErrorCode MatLMVMClearJ0(Mat);
1200: PETSC_EXTERN PetscErrorCode MatLMVMSetJ0(Mat, Mat);
1201: PETSC_EXTERN PetscErrorCode MatLMVMSetJ0Scale(Mat, PetscReal);
1202: PETSC_EXTERN PetscErrorCode MatLMVMSetJ0Diag(Mat, Vec);
1203: PETSC_EXTERN PetscErrorCode MatLMVMSetJ0PC(Mat, PC);
1204: PETSC_EXTERN PetscErrorCode MatLMVMSetJ0KSP(Mat, KSP);
1205: PETSC_EXTERN PetscErrorCode MatLMVMApplyJ0Fwd(Mat, Vec, Vec);
1206: PETSC_EXTERN PetscErrorCode MatLMVMApplyJ0Inv(Mat, Vec, Vec);
1207: PETSC_EXTERN PetscErrorCode MatLMVMGetLastUpdate(Mat, Vec *, Vec *);
1208: PETSC_EXTERN PetscErrorCode MatLMVMGetJ0(Mat, Mat *);
1209: PETSC_EXTERN PetscErrorCode MatLMVMGetJ0PC(Mat, PC *);
1210: PETSC_EXTERN PetscErrorCode MatLMVMGetJ0KSP(Mat, KSP *);
1211: PETSC_EXTERN PetscErrorCode MatLMVMSetHistorySize(Mat, PetscInt);
1212: PETSC_EXTERN PetscErrorCode MatLMVMGetHistorySize(Mat, PetscInt *);
1213: PETSC_EXTERN PetscErrorCode MatLMVMGetUpdateCount(Mat, PetscInt *);
1214: PETSC_EXTERN PetscErrorCode MatLMVMGetRejectCount(Mat, PetscInt *);
1215: PETSC_EXTERN PetscErrorCode MatLMVMSymBroydenSetDelta(Mat, PetscScalar);
1217: /*E
1218: MatLMVMMultAlgorithm - The type of algorithm used for matrix-vector products and solves used internally by a `MatLMVM` matrix
1220: Values:
1221: + `MAT_LMVM_MULT_RECURSIVE` - Use recursive formulas for products and solves
1222: . `MAT_LMVM_MULT_DENSE` - Use dense formulas for products and solves when possible
1223: - `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
1225: Level: advanced
1227: Options Database Keys:
1228: . -mat_lmvm_mult_algorithm (recursive|dense|compact_dense) - the algorithm to use for multiplication
1230: .seealso: [](ch_matrices), `MATLMVM`, `MatLMVMSetMultAlgorithm()`, `MatLMVMGetMultAlgorithm()`
1231: E*/
1232: typedef enum {
1233: MAT_LMVM_MULT_RECURSIVE,
1234: MAT_LMVM_MULT_DENSE,
1235: MAT_LMVM_MULT_COMPACT_DENSE,
1236: } MatLMVMMultAlgorithm;
1238: PETSC_EXTERN const char *const MatLMVMMultAlgorithms[];
1240: PETSC_EXTERN PetscErrorCode MatLMVMSetMultAlgorithm(Mat, MatLMVMMultAlgorithm);
1241: PETSC_EXTERN PetscErrorCode MatLMVMGetMultAlgorithm(Mat, MatLMVMMultAlgorithm *);
1243: /*E
1244: MatLMVMSymBroydenScaleType - Rescaling type for the initial Hessian of a symmetric Broyden matrix.
1246: Values:
1247: + `MAT_LMVM_SYMBROYDEN_SCALE_NONE` - no rescaling
1248: . `MAT_LMVM_SYMBROYDEN_SCALE_SCALAR` - scalar rescaling
1249: . `MAT_LMVM_SYMBROYDEN_SCALE_DIAGONAL` - diagonal rescaling
1250: . `MAT_LMVM_SYMBROYDEN_SCALE_USER` - same as `MAT_LMVM_SYMBROYDN_SCALE_NONE`
1251: - `MAT_LMVM_SYMBROYDEN_SCALE_DECIDE` - let PETSc decide rescaling
1253: Level: intermediate
1255: .seealso: [](ch_matrices), `MATLMVM`, `MatLMVMSymBroydenSetScaleType()`
1256: E*/
1257: typedef enum {
1258: MAT_LMVM_SYMBROYDEN_SCALE_NONE = 0,
1259: MAT_LMVM_SYMBROYDEN_SCALE_SCALAR = 1,
1260: MAT_LMVM_SYMBROYDEN_SCALE_DIAGONAL = 2,
1261: MAT_LMVM_SYMBROYDEN_SCALE_USER = 3,
1262: MAT_LMVM_SYMBROYDEN_SCALE_DECIDE = 4
1263: } MatLMVMSymBroydenScaleType;
1264: PETSC_EXTERN const char *const MatLMVMSymBroydenScaleTypes[];
1266: PETSC_EXTERN PetscErrorCode MatLMVMSymBroydenSetScaleType(Mat, MatLMVMSymBroydenScaleType);
1267: PETSC_EXTERN PetscErrorCode MatLMVMSymBroydenGetPhi(Mat, PetscReal *);
1268: PETSC_EXTERN PetscErrorCode MatLMVMSymBroydenSetPhi(Mat, PetscReal);
1269: PETSC_EXTERN PetscErrorCode MatLMVMSymBadBroydenGetPsi(Mat, PetscReal *);
1270: PETSC_EXTERN PetscErrorCode MatLMVMSymBadBroydenSetPsi(Mat, PetscReal);
1272: /*E
1273: MatLMVMDenseType - Memory storage strategy for dense variants of `MATLMVM`.
1275: Values:
1276: + `MAT_LMVM_DENSE_REORDER` - reorders memory to minimize kernel launch
1277: - `MAT_LMVM_DENSE_INPLACE` - computes inplace to minimize memory movement
1279: Level: intermediate
1281: .seealso: [](ch_matrices), `MatLMVM`, `MatLMVMDenseSetType()`
1282: E*/
1283: typedef enum {
1284: MAT_LMVM_DENSE_REORDER,
1285: MAT_LMVM_DENSE_INPLACE
1286: } MatLMVMDenseType;
1287: PETSC_EXTERN const char *const MatLMVMDenseTypes[];
1289: PETSC_EXTERN PetscErrorCode MatLMVMDenseSetType(Mat, MatLMVMDenseType);
1291: PETSC_EXTERN PetscErrorCode KSPSetDM(KSP, DM);
1293: /*E
1294: KSPDMActive - Indicates if the `DM` attached to the `KSP` should be used to compute the operator, the right-hand side, or the initial guess
1296: Values:
1297: + `KSP_DMACTIVE_OPERATOR` - compute the operator
1298: . `KSP_DMACTIVE_RHS` - compute the right-hand side
1299: . `KSP_DMACTIVE_INITIAL_GUESS` - compute the initial guess
1300: - `KSP_DMACTIVE_ALL` - compute all of them
1302: Level: intermediate
1304: .seealso: [](ch_ksp), `KSP`, `KSPSetDMActive()`, `KSPSetDM()`
1305: E*/
1306: typedef enum {
1307: KSP_DMACTIVE_OPERATOR = 1,
1308: KSP_DMACTIVE_RHS = 2,
1309: KSP_DMACTIVE_INITIAL_GUESS = 4,
1310: KSP_DMACTIVE_ALL = 1 + 2 + 4
1311: } KSPDMActive;
1312: PETSC_EXTERN PetscErrorCode KSPSetDMActive(KSP, KSPDMActive, PetscBool);
1314: PETSC_EXTERN PetscErrorCode KSPGetDM(KSP, DM *);
1315: PETSC_EXTERN PetscErrorCode KSPSetApplicationContext(KSP, PetscCtx);
1316: PETSC_EXTERN PetscErrorCode KSPGetApplicationContext(KSP, PetscCtxRt);
1318: /*S
1319: KSPComputeRHSFn - A prototype of a `KSP` evaluation function that would be passed to `KSPSetComputeRHS()`
1321: Calling Sequence:
1322: + ksp - `ksp` context
1323: . b - output vector
1324: - ctx - [optional] user-defined function context
1326: Level: beginner
1328: .seealso: [](ch_ksp), `KSP`, `KSPSetComputeRHS()`, `SNESGetFunction()`, `KSPComputeInitialGuessFn`, `KSPComputeOperatorsFn`
1329: S*/
1330: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode KSPComputeRHSFn(KSP ksp, Vec b, PetscCtx ctx);
1332: PETSC_EXTERN PetscErrorCode KSPSetComputeRHS(KSP, KSPComputeRHSFn *, void *);
1334: /*S
1335: KSPComputeOperatorsFn - A prototype of a `KSP` evaluation function that would be passed to `KSPSetComputeOperators()`
1337: Calling Sequence:
1338: + ksp - `KSP` context
1339: . A - the operator that defines the linear system
1340: . P - an operator from which to build the preconditioner (often the same as `A`)
1341: - ctx - [optional] user-defined function context
1343: Level: beginner
1345: .seealso: [](ch_ksp), `KSP`, `KSPSetComputeRHS()`, `SNESGetFunction()`, `KSPComputeRHSFn`, `KSPComputeInitialGuessFn`
1346: S*/
1347: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode KSPComputeOperatorsFn(KSP ksp, Mat A, Mat P, PetscCtx ctx);
1349: PETSC_EXTERN PetscErrorCode KSPSetComputeOperators(KSP, KSPComputeOperatorsFn, void *);
1351: /*S
1352: KSPCreateOperatorsFn - A prototype of a `KSP` operator creation function that would be passed to `DMKSPSetCreateOperators()`
1354: Calling Sequence:
1355: + ksp - `KSP` context
1356: . A - the created operator that defines the linear system
1357: . P - the created operator from which to build the preconditioner, often the same as `A`
1358: - ctx - [optional] user-defined function context
1360: Level: developer
1362: Notes:
1363: The returned matrices are owned by the caller, similar to `DMCreateMatrix()`.
1365: `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`.
1367: .seealso: [](ch_ksp), `DMKSPSetCreateOperators()`, `DMKSPGetCreateOperators()`, `KSPComputeOperatorsFn`, `KSPSetOperators()`
1368: S*/
1369: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode KSPCreateOperatorsFn(KSP ksp, Mat *A, Mat *P, PetscCtx ctx);
1371: /*S
1372: KSPComputeInitialGuessFn - A prototype of a `KSP` evaluation function that would be passed to `KSPSetComputeInitialGuess()`
1374: Calling Sequence:
1375: + ksp - `ksp` context
1376: . x - output vector
1377: - ctx - [optional] user-defined function context
1379: Level: beginner
1381: .seealso: [](ch_ksp), `KSP`, `KSPSetComputeInitialGuess()`, `SNESGetFunction()`, `KSPComputeRHSFn`, `KSPComputeOperatorsFn`
1382: S*/
1383: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode KSPComputeInitialGuessFn(KSP ksp, Vec x, PetscCtx ctx);
1385: PETSC_EXTERN PetscErrorCode KSPSetComputeInitialGuess(KSP, KSPComputeInitialGuessFn *, void *);
1386: PETSC_EXTERN PetscErrorCode DMKSPSetComputeOperators(DM, KSPComputeOperatorsFn *, void *);
1387: PETSC_EXTERN PetscErrorCode DMKSPGetComputeOperators(DM, KSPComputeOperatorsFn **, void *);
1388: PETSC_EXTERN PetscErrorCode DMKSPSetCreateOperators(DM, KSPCreateOperatorsFn *, void *);
1389: PETSC_EXTERN PetscErrorCode DMKSPGetCreateOperators(DM, KSPCreateOperatorsFn **, void *);
1390: PETSC_EXTERN PetscErrorCode DMKSPSetComputeRHS(DM, KSPComputeRHSFn *, void *);
1391: PETSC_EXTERN PetscErrorCode DMKSPGetComputeRHS(DM, KSPComputeRHSFn **, void *);
1392: PETSC_EXTERN PetscErrorCode DMKSPSetComputeInitialGuess(DM, KSPComputeInitialGuessFn *, void *);
1393: PETSC_EXTERN PetscErrorCode DMKSPGetComputeInitialGuess(DM, KSPComputeInitialGuessFn **, void *);
1395: PETSC_EXTERN PetscErrorCode DMGlobalToLocalSolve(DM, Vec, Vec);
1396: PETSC_EXTERN PetscErrorCode DMSwarmProjectFields(DM, DM, PetscInt, const char *[], Vec[], ScatterMode);
1397: PETSC_EXTERN PetscErrorCode DMSwarmProjectGradientFields(DM, DM, PetscInt, const char *[], Vec[], ScatterMode);
1399: PETSC_EXTERN PetscErrorCode DMAdaptInterpolator(DM, DM, Mat, KSP, Mat, Mat, Mat *, void *);
1400: PETSC_EXTERN PetscErrorCode DMCheckInterpolator(DM, Mat, Mat, Mat, PetscReal);
1402: PETSC_EXTERN PetscErrorCode PCBJKOKKOSSetKSP(PC, KSP);
1403: PETSC_EXTERN PetscErrorCode PCBJKOKKOSGetKSP(PC, KSP *);
1405: PETSC_EXTERN PetscErrorCode DMCopyDMKSP(DM, DM);
1407: #include <petscdstypes.h>
1408: PETSC_EXTERN PetscErrorCode DMProjectField(DM, PetscReal, Vec, PetscPointFn **, InsertMode, Vec);