1 /* 2 Defines the interface functions for the Krylov subspace accelerators. 3 */ 4 #ifndef PETSCKSP_H 5 #define PETSCKSP_H 6 #include <petscpc.h> 7 8 PETSC_EXTERN PetscErrorCode KSPInitializePackage(void); 9 10 /*S 11 KSP - Abstract PETSc object that manages all Krylov methods. This is the object that manages the 12 linear solves in PETSc (even those such as direct solvers that do no use Krylov accelerators). 13 14 Level: beginner 15 16 Notes: 17 When a direct solver is used, but no Krylov solver is used, the KSP object is still used but with a 18 KSPType of KSPPREONLY, meaning that only application of the preconditioner is used as the linear solver. 19 20 .seealso: KSPCreate(), KSPSetType(), KSPType, SNES, TS, PC, KSP, KSPDestroy(), KSPCG, KSPGMRES 21 S*/ 22 typedef struct _p_KSP* KSP; 23 24 /*J 25 KSPType - String with the name of a PETSc Krylov method. 26 27 Level: beginner 28 29 .seealso: KSPSetType(), KSP, KSPRegister(), KSPCreate(), KSPSetFromOptions() 30 J*/ 31 typedef const char* KSPType; 32 #define KSPRICHARDSON "richardson" 33 #define KSPCHEBYSHEV "chebyshev" 34 #define KSPCG "cg" 35 #define KSPGROPPCG "groppcg" 36 #define KSPPIPECG "pipecg" 37 #define KSPPIPECGRR "pipecgrr" 38 #define KSPPIPELCG "pipelcg" 39 #define KSPPIPEPRCG "pipeprcg" 40 #define KSPPIPECG2 "pipecg2" 41 #define KSPCGNE "cgne" 42 #define KSPNASH "nash" 43 #define KSPSTCG "stcg" 44 #define KSPGLTR "gltr" 45 #define KSPCGNASH PETSC_DEPRECATED_MACRO("GCC warning \"KSPCGNASH macro is deprecated use KSPNASH (since version 3.11)\"") "nash" 46 #define KSPCGSTCG PETSC_DEPRECATED_MACRO("GCC warning \"KSPCGSTCG macro is deprecated use KSPSTCG (since version 3.11)\"") "stcg" 47 #define KSPCGGLTR PETSC_DEPRECATED_MACRO("GCC warning \"KSPCGGLTR macro is deprecated use KSPSGLTR (since version 3.11)\"") "gltr" 48 #define KSPFCG "fcg" 49 #define KSPPIPEFCG "pipefcg" 50 #define KSPGMRES "gmres" 51 #define KSPPIPEFGMRES "pipefgmres" 52 #define KSPFGMRES "fgmres" 53 #define KSPLGMRES "lgmres" 54 #define KSPDGMRES "dgmres" 55 #define KSPPGMRES "pgmres" 56 #define KSPTCQMR "tcqmr" 57 #define KSPBCGS "bcgs" 58 #define KSPIBCGS "ibcgs" 59 #define KSPQMRCGS "qmrcgs" 60 #define KSPFBCGS "fbcgs" 61 #define KSPFBCGSR "fbcgsr" 62 #define KSPBCGSL "bcgsl" 63 #define KSPPIPEBCGS "pipebcgs" 64 #define KSPCGS "cgs" 65 #define KSPTFQMR "tfqmr" 66 #define KSPCR "cr" 67 #define KSPPIPECR "pipecr" 68 #define KSPLSQR "lsqr" 69 #define KSPPREONLY "preonly" 70 #define KSPQCG "qcg" 71 #define KSPBICG "bicg" 72 #define KSPMINRES "minres" 73 #define KSPSYMMLQ "symmlq" 74 #define KSPLCD "lcd" 75 #define KSPPYTHON "python" 76 #define KSPGCR "gcr" 77 #define KSPPIPEGCR "pipegcr" 78 #define KSPTSIRM "tsirm" 79 #define KSPCGLS "cgls" 80 #define KSPFETIDP "fetidp" 81 #define KSPHPDDM "hpddm" 82 83 /* Logging support */ 84 PETSC_EXTERN PetscClassId KSP_CLASSID; 85 PETSC_EXTERN PetscClassId KSPGUESS_CLASSID; 86 PETSC_EXTERN PetscClassId DMKSP_CLASSID; 87 88 PETSC_EXTERN PetscErrorCode KSPCreate(MPI_Comm,KSP*); 89 PETSC_EXTERN PetscErrorCode KSPSetType(KSP,KSPType); 90 PETSC_EXTERN PetscErrorCode KSPGetType(KSP,KSPType*); 91 PETSC_EXTERN PetscErrorCode KSPSetUp(KSP); 92 PETSC_EXTERN PetscErrorCode KSPSetUpOnBlocks(KSP); 93 PETSC_EXTERN PetscErrorCode KSPSolve(KSP,Vec,Vec); 94 PETSC_EXTERN PetscErrorCode KSPSolveTranspose(KSP,Vec,Vec); 95 PETSC_EXTERN PetscErrorCode KSPSetUseExplicitTranspose(KSP,PetscBool); 96 PETSC_EXTERN PetscErrorCode KSPMatSolve(KSP,Mat,Mat); 97 PETSC_EXTERN PetscErrorCode KSPSetMatSolveBatchSize(KSP,PetscInt); 98 PETSC_DEPRECATED_FUNCTION("Use KSPSetMatSolveBatchSize() (since version 3.15)") static inline PetscErrorCode KSPSetMatSolveBlockSize(KSP ksp,PetscInt n) {return KSPSetMatSolveBatchSize(ksp,n);} 99 PETSC_EXTERN PetscErrorCode KSPGetMatSolveBatchSize(KSP,PetscInt*); 100 PETSC_DEPRECATED_FUNCTION("Use KSPGetMatSolveBatchSize() (since version 3.15)") static inline PetscErrorCode KSPGetMatSolveBlockSize(KSP ksp,PetscInt *n) {return KSPGetMatSolveBatchSize(ksp,n);} 101 PETSC_EXTERN PetscErrorCode KSPReset(KSP); 102 PETSC_EXTERN PetscErrorCode KSPResetViewers(KSP); 103 PETSC_EXTERN PetscErrorCode KSPDestroy(KSP*); 104 PETSC_EXTERN PetscErrorCode KSPSetReusePreconditioner(KSP,PetscBool); 105 PETSC_EXTERN PetscErrorCode KSPGetReusePreconditioner(KSP,PetscBool*); 106 PETSC_EXTERN PetscErrorCode KSPSetSkipPCSetFromOptions(KSP,PetscBool); 107 PETSC_EXTERN PetscErrorCode KSPCheckSolve(KSP,PC,Vec); 108 109 PETSC_EXTERN PetscFunctionList KSPList; 110 PETSC_EXTERN PetscFunctionList KSPGuessList; 111 PETSC_EXTERN PetscFunctionList KSPMonitorList; 112 PETSC_EXTERN PetscFunctionList KSPMonitorCreateList; 113 PETSC_EXTERN PetscFunctionList KSPMonitorDestroyList; 114 PETSC_EXTERN PetscErrorCode KSPRegister(const char[],PetscErrorCode (*)(KSP)); 115 PETSC_EXTERN PetscErrorCode KSPMonitorRegister(const char[], PetscViewerType, PetscViewerFormat, PetscErrorCode (*)(KSP, PetscInt, PetscReal, PetscViewerAndFormat *), PetscErrorCode (*)(PetscViewer, PetscViewerFormat, void *, PetscViewerAndFormat **), PetscErrorCode (*)(PetscViewerAndFormat **)); 116 117 PETSC_EXTERN PetscErrorCode KSPSetPCSide(KSP,PCSide); 118 PETSC_EXTERN PetscErrorCode KSPGetPCSide(KSP,PCSide*); 119 PETSC_EXTERN PetscErrorCode KSPSetTolerances(KSP,PetscReal,PetscReal,PetscReal,PetscInt); 120 PETSC_EXTERN PetscErrorCode KSPGetTolerances(KSP,PetscReal*,PetscReal*,PetscReal*,PetscInt*); 121 PETSC_EXTERN PetscErrorCode KSPSetInitialGuessNonzero(KSP,PetscBool); 122 PETSC_EXTERN PetscErrorCode KSPGetInitialGuessNonzero(KSP,PetscBool*); 123 PETSC_EXTERN PetscErrorCode KSPSetErrorIfNotConverged(KSP,PetscBool); 124 PETSC_EXTERN PetscErrorCode KSPGetErrorIfNotConverged(KSP,PetscBool*); 125 PETSC_EXTERN PetscErrorCode KSPSetComputeEigenvalues(KSP,PetscBool); 126 PETSC_EXTERN PetscErrorCode KSPSetComputeRitz(KSP,PetscBool); 127 PETSC_EXTERN PetscErrorCode KSPGetComputeEigenvalues(KSP,PetscBool*); 128 PETSC_EXTERN PetscErrorCode KSPSetComputeSingularValues(KSP,PetscBool); 129 PETSC_EXTERN PetscErrorCode KSPGetComputeSingularValues(KSP,PetscBool*); 130 PETSC_EXTERN PetscErrorCode KSPGetRhs(KSP,Vec*); 131 PETSC_EXTERN PetscErrorCode KSPGetSolution(KSP,Vec*); 132 PETSC_EXTERN PetscErrorCode KSPGetResidualNorm(KSP,PetscReal*); 133 PETSC_EXTERN PetscErrorCode KSPGetIterationNumber(KSP,PetscInt*); 134 PETSC_EXTERN PetscErrorCode KSPGetTotalIterations(KSP,PetscInt*); 135 PETSC_EXTERN PetscErrorCode KSPCreateVecs(KSP,PetscInt,Vec**,PetscInt,Vec**); 136 PETSC_DEPRECATED_FUNCTION("Use KSPCreateVecs() (since version 3.6)") static inline PetscErrorCode KSPGetVecs(KSP ksp,PetscInt n,Vec **x,PetscInt m,Vec **y) {return KSPCreateVecs(ksp,n,x,m,y);} 137 138 PETSC_EXTERN PetscErrorCode KSPSetPreSolve(KSP,PetscErrorCode (*)(KSP,Vec,Vec,void*),void*); 139 PETSC_EXTERN PetscErrorCode KSPSetPostSolve(KSP,PetscErrorCode (*)(KSP,Vec,Vec,void*),void*); 140 141 PETSC_EXTERN PetscErrorCode KSPSetPC(KSP,PC); 142 PETSC_EXTERN PetscErrorCode KSPGetPC(KSP,PC*); 143 144 PETSC_EXTERN PetscErrorCode KSPMonitor(KSP,PetscInt,PetscReal); 145 PETSC_EXTERN PetscErrorCode KSPMonitorSet(KSP,PetscErrorCode (*)(KSP,PetscInt,PetscReal,void*),void*,PetscErrorCode (*)(void**)); 146 PETSC_EXTERN PetscErrorCode KSPMonitorCancel(KSP); 147 PETSC_EXTERN PetscErrorCode KSPGetMonitorContext(KSP,void*); 148 PETSC_EXTERN PetscErrorCode KSPGetResidualHistory(KSP,const PetscReal*[],PetscInt*); 149 PETSC_EXTERN PetscErrorCode KSPSetResidualHistory(KSP,PetscReal[],PetscInt,PetscBool); 150 PETSC_EXTERN PetscErrorCode KSPGetErrorHistory(KSP,const PetscReal*[],PetscInt*); 151 PETSC_EXTERN PetscErrorCode KSPSetErrorHistory(KSP,PetscReal[],PetscInt,PetscBool); 152 153 PETSC_EXTERN PetscErrorCode KSPBuildSolutionDefault(KSP,Vec,Vec*); 154 PETSC_EXTERN PetscErrorCode KSPBuildResidualDefault(KSP,Vec,Vec,Vec*); 155 PETSC_EXTERN PetscErrorCode KSPDestroyDefault(KSP); 156 PETSC_EXTERN PetscErrorCode KSPSetWorkVecs(KSP,PetscInt); 157 158 PETSC_EXTERN PetscErrorCode PCKSPGetKSP(PC,KSP*); 159 PETSC_EXTERN PetscErrorCode PCKSPSetKSP(PC,KSP); 160 PETSC_EXTERN PetscErrorCode PCBJacobiGetSubKSP(PC,PetscInt*,PetscInt*,KSP*[]); 161 PETSC_EXTERN PetscErrorCode PCASMGetSubKSP(PC,PetscInt*,PetscInt*,KSP*[]); 162 PETSC_EXTERN PetscErrorCode PCGASMGetSubKSP(PC,PetscInt*,PetscInt*,KSP*[]); 163 PETSC_EXTERN PetscErrorCode PCFieldSplitGetSubKSP(PC,PetscInt*,KSP*[]); 164 PETSC_EXTERN PetscErrorCode PCFieldSplitSchurGetSubKSP(PC,PetscInt*,KSP*[]); 165 PETSC_EXTERN PetscErrorCode PCMGGetSmoother(PC,PetscInt,KSP*); 166 PETSC_EXTERN PetscErrorCode PCMGGetSmootherDown(PC,PetscInt,KSP*); 167 PETSC_EXTERN PetscErrorCode PCMGGetSmootherUp(PC,PetscInt,KSP*); 168 PETSC_EXTERN PetscErrorCode PCMGGetCoarseSolve(PC,KSP*); 169 PETSC_EXTERN PetscErrorCode PCGalerkinGetKSP(PC,KSP*); 170 PETSC_EXTERN PetscErrorCode PCDeflationGetCoarseKSP(PC,KSP*); 171 /* 172 PCMGCoarseList contains the list of coarse space constructor currently registered 173 These are added with PCMGRegisterCoarseSpaceConstructor() 174 */ 175 PETSC_EXTERN PetscFunctionList PCMGCoarseList; 176 PETSC_EXTERN PetscErrorCode PCMGRegisterCoarseSpaceConstructor(const char[], PetscErrorCode (*)(PC, PetscInt, DM, KSP, PetscInt, const Vec[], Vec **)); 177 PETSC_EXTERN PetscErrorCode PCMGGetCoarseSpaceConstructor(const char[], PetscErrorCode (**)(PC, PetscInt, DM, KSP, PetscInt, const Vec[], Vec **)); 178 179 PETSC_EXTERN PetscErrorCode KSPBuildSolution(KSP,Vec,Vec*); 180 PETSC_EXTERN PetscErrorCode KSPBuildResidual(KSP,Vec,Vec,Vec*); 181 182 PETSC_EXTERN PetscErrorCode KSPRichardsonSetScale(KSP,PetscReal); 183 PETSC_EXTERN PetscErrorCode KSPRichardsonSetSelfScale(KSP,PetscBool); 184 PETSC_EXTERN PetscErrorCode KSPChebyshevSetEigenvalues(KSP,PetscReal,PetscReal); 185 PETSC_EXTERN PetscErrorCode KSPChebyshevEstEigSet(KSP,PetscReal,PetscReal,PetscReal,PetscReal); 186 PETSC_EXTERN PetscErrorCode KSPChebyshevEstEigSetUseNoisy(KSP,PetscBool); 187 PETSC_EXTERN PetscErrorCode KSPChebyshevEstEigGetKSP(KSP,KSP*); 188 PETSC_EXTERN PetscErrorCode KSPComputeExtremeSingularValues(KSP,PetscReal*,PetscReal*); 189 PETSC_EXTERN PetscErrorCode KSPComputeEigenvalues(KSP,PetscInt,PetscReal[],PetscReal[],PetscInt*); 190 PETSC_EXTERN PetscErrorCode KSPComputeEigenvaluesExplicitly(KSP,PetscInt,PetscReal[],PetscReal[]); 191 PETSC_EXTERN PetscErrorCode KSPComputeRitz(KSP,PetscBool,PetscBool,PetscInt*,Vec[],PetscReal[],PetscReal[]); 192 193 /*E 194 195 KSPFCDTruncationType - Define how stored directions are used to orthogonalize in flexible conjugate directions (FCD) methods 196 197 KSP_FCD_TRUNC_TYPE_STANDARD uses all (up to mmax) stored directions 198 KSP_FCD_TRUNC_TYPE_NOTAY uses the last max(1,mod(i,mmax)) stored directions at iteration i=0,1.. 199 200 Level: intermediate 201 .seealso : KSPFCG,KSPPIPEFCG,KSPPIPEGCR,KSPFCGSetTruncationType(),KSPFCGGetTruncationType() 202 203 E*/ 204 typedef enum {KSP_FCD_TRUNC_TYPE_STANDARD,KSP_FCD_TRUNC_TYPE_NOTAY} KSPFCDTruncationType; 205 PETSC_EXTERN const char *const KSPFCDTruncationTypes[]; 206 207 PETSC_EXTERN PetscErrorCode KSPFCGSetMmax(KSP,PetscInt); 208 PETSC_EXTERN PetscErrorCode KSPFCGGetMmax(KSP,PetscInt*); 209 PETSC_EXTERN PetscErrorCode KSPFCGSetNprealloc(KSP,PetscInt); 210 PETSC_EXTERN PetscErrorCode KSPFCGGetNprealloc(KSP,PetscInt*); 211 PETSC_EXTERN PetscErrorCode KSPFCGSetTruncationType(KSP,KSPFCDTruncationType); 212 PETSC_EXTERN PetscErrorCode KSPFCGGetTruncationType(KSP,KSPFCDTruncationType*); 213 214 PETSC_EXTERN PetscErrorCode KSPPIPEFCGSetMmax(KSP,PetscInt); 215 PETSC_EXTERN PetscErrorCode KSPPIPEFCGGetMmax(KSP,PetscInt*); 216 PETSC_EXTERN PetscErrorCode KSPPIPEFCGSetNprealloc(KSP,PetscInt); 217 PETSC_EXTERN PetscErrorCode KSPPIPEFCGGetNprealloc(KSP,PetscInt*); 218 PETSC_EXTERN PetscErrorCode KSPPIPEFCGSetTruncationType(KSP,KSPFCDTruncationType); 219 PETSC_EXTERN PetscErrorCode KSPPIPEFCGGetTruncationType(KSP,KSPFCDTruncationType*); 220 221 PETSC_EXTERN PetscErrorCode KSPPIPEGCRSetMmax(KSP,PetscInt); 222 PETSC_EXTERN PetscErrorCode KSPPIPEGCRGetMmax(KSP,PetscInt*); 223 PETSC_EXTERN PetscErrorCode KSPPIPEGCRSetNprealloc(KSP,PetscInt); 224 PETSC_EXTERN PetscErrorCode KSPPIPEGCRGetNprealloc(KSP,PetscInt*); 225 PETSC_EXTERN PetscErrorCode KSPPIPEGCRSetTruncationType(KSP,KSPFCDTruncationType); 226 PETSC_EXTERN PetscErrorCode KSPPIPEGCRGetTruncationType(KSP,KSPFCDTruncationType*); 227 PETSC_EXTERN PetscErrorCode KSPPIPEGCRSetUnrollW(KSP,PetscBool); 228 PETSC_EXTERN PetscErrorCode KSPPIPEGCRGetUnrollW(KSP,PetscBool*); 229 230 PETSC_EXTERN PetscErrorCode KSPGMRESSetRestart(KSP, PetscInt); 231 PETSC_EXTERN PetscErrorCode KSPGMRESGetRestart(KSP, PetscInt*); 232 PETSC_EXTERN PetscErrorCode KSPGMRESSetHapTol(KSP,PetscReal); 233 PETSC_EXTERN PetscErrorCode KSPGMRESSetBreakdownTolerance(KSP,PetscReal); 234 235 PETSC_EXTERN PetscErrorCode KSPGMRESSetPreAllocateVectors(KSP); 236 PETSC_EXTERN PetscErrorCode KSPGMRESSetOrthogonalization(KSP,PetscErrorCode (*)(KSP,PetscInt)); 237 PETSC_EXTERN PetscErrorCode KSPGMRESGetOrthogonalization(KSP,PetscErrorCode (**)(KSP,PetscInt)); 238 PETSC_EXTERN PetscErrorCode KSPGMRESModifiedGramSchmidtOrthogonalization(KSP,PetscInt); 239 PETSC_EXTERN PetscErrorCode KSPGMRESClassicalGramSchmidtOrthogonalization(KSP,PetscInt); 240 241 PETSC_EXTERN PetscErrorCode KSPLGMRESSetAugDim(KSP,PetscInt); 242 PETSC_EXTERN PetscErrorCode KSPLGMRESSetConstant(KSP); 243 244 PETSC_EXTERN PetscErrorCode KSPPIPEFGMRESSetShift(KSP,PetscScalar); 245 246 PETSC_EXTERN PetscErrorCode KSPGCRSetRestart(KSP,PetscInt); 247 PETSC_EXTERN PetscErrorCode KSPGCRGetRestart(KSP,PetscInt*); 248 PETSC_EXTERN PetscErrorCode KSPGCRSetModifyPC(KSP,PetscErrorCode (*)(KSP,PetscInt,PetscReal,void*),void*,PetscErrorCode(*)(void*)); 249 250 PETSC_EXTERN PetscErrorCode KSPFETIDPGetInnerBDDC(KSP,PC*); 251 PETSC_EXTERN PetscErrorCode KSPFETIDPSetInnerBDDC(KSP,PC); 252 PETSC_EXTERN PetscErrorCode KSPFETIDPGetInnerKSP(KSP,KSP*); 253 PETSC_EXTERN PetscErrorCode KSPFETIDPSetPressureOperator(KSP,Mat); 254 255 PETSC_EXTERN PetscErrorCode KSPHPDDMSetDeflationSpace(KSP,Mat); 256 PETSC_EXTERN PetscErrorCode KSPHPDDMGetDeflationSpace(KSP,Mat*); 257 PETSC_DEPRECATED_FUNCTION("Use KSPMatSolve() (since version 3.14)") static inline PetscErrorCode KSPHPDDMMatSolve(KSP ksp, Mat B, Mat X) { return KSPMatSolve(ksp, B, X); } 258 /*E 259 KSPHPDDMType - Type of Krylov method used by KSPHPDDM 260 261 Level: intermediate 262 263 Values: 264 + KSP_HPDDM_TYPE_GMRES (default) 265 . KSP_HPDDM_TYPE_BGMRES 266 . KSP_HPDDM_TYPE_CG 267 . KSP_HPDDM_TYPE_BCG 268 . KSP_HPDDM_TYPE_GCRODR 269 . KSP_HPDDM_TYPE_BGCRODR 270 . KSP_HPDDM_TYPE_BFBCG 271 - KSP_HPDDM_TYPE_PREONLY 272 273 .seealso: KSPHPDDM, KSPHPDDMSetType() 274 E*/ 275 typedef enum { 276 KSP_HPDDM_TYPE_GMRES = 0, 277 KSP_HPDDM_TYPE_BGMRES = 1, 278 KSP_HPDDM_TYPE_CG = 2, 279 KSP_HPDDM_TYPE_BCG = 3, 280 KSP_HPDDM_TYPE_GCRODR = 4, 281 KSP_HPDDM_TYPE_BGCRODR = 5, 282 KSP_HPDDM_TYPE_BFBCG = 6, 283 KSP_HPDDM_TYPE_PREONLY = 7 284 } KSPHPDDMType; 285 PETSC_EXTERN const char *const KSPHPDDMTypes[]; 286 /*E 287 KSPHPDDMPrecision - Precision of Krylov bases used by KSPHPDDM 288 289 Level: intermediate 290 291 Values: 292 + KSP_HPDDM_PRECISION_HALF (currently unsupported) 293 . KSP_HPDDM_PRECISION_SINGLE (default when PETSc is configured --with-precision=single) 294 . KSP_HPDDM_PRECISION_DOUBLE (default when PETSc is configured --with-precision=double) 295 - KSP_HPDDM_PRECISION_QUADRUPLE (currently unsupported) 296 297 .seealso: KSPHPDDM 298 E*/ 299 typedef enum { 300 KSP_HPDDM_PRECISION_HALF = 0, 301 KSP_HPDDM_PRECISION_SINGLE = 1, 302 KSP_HPDDM_PRECISION_DOUBLE = 2, 303 KSP_HPDDM_PRECISION_QUADRUPLE = 3 304 } KSPHPDDMPrecision; 305 PETSC_EXTERN PetscErrorCode KSPHPDDMSetType(KSP,KSPHPDDMType); 306 PETSC_EXTERN PetscErrorCode KSPHPDDMGetType(KSP,KSPHPDDMType*); 307 308 /*E 309 KSPGMRESCGSRefinementType - How the classical (unmodified) Gram-Schmidt is performed. 310 311 Level: advanced 312 313 .seealso: KSPGMRESClassicalGramSchmidtOrthogonalization(), KSPGMRESSetOrthogonalization(), KSPGMRESGetOrthogonalization(), 314 KSPGMRESSetCGSRefinementType(), KSPGMRESGetCGSRefinementType(), KSPGMRESModifiedGramSchmidtOrthogonalization() 315 316 E*/ 317 typedef enum {KSP_GMRES_CGS_REFINE_NEVER, KSP_GMRES_CGS_REFINE_IFNEEDED, KSP_GMRES_CGS_REFINE_ALWAYS} KSPGMRESCGSRefinementType; 318 PETSC_EXTERN const char *const KSPGMRESCGSRefinementTypes[]; 319 /*MC 320 KSP_GMRES_CGS_REFINE_NEVER - Do the classical (unmodified) Gram-Schmidt process 321 322 Level: advanced 323 324 Note: Possible unstable, but the fastest to compute 325 326 .seealso: KSPGMRESClassicalGramSchmidtOrthogonalization(), KSPGMRESSetOrthogonalization(), KSPGMRESGetOrthogonalization(), 327 KSPGMRESSetCGSRefinementType(), KSPGMRESGetCGSRefinementType(), KSP_GMRES_CGS_REFINE_IFNEEDED, KSP_GMRES_CGS_REFINE_ALWAYS, 328 KSPGMRESModifiedGramSchmidtOrthogonalization() 329 M*/ 330 331 /*MC 332 KSP_GMRES_CGS_REFINE_IFNEEDED - Do the classical (unmodified) Gram-Schmidt process and one step of 333 iterative refinement if an estimate of the orthogonality of the resulting vectors indicates 334 poor orthogonality. 335 336 Level: advanced 337 338 Note: This is slower than KSP_GMRES_CGS_REFINE_NEVER because it requires an extra norm computation to 339 estimate the orthogonality but is more stable. 340 341 .seealso: KSPGMRESClassicalGramSchmidtOrthogonalization(), KSPGMRESSetOrthogonalization(), KSPGMRESGetOrthogonalization(), 342 KSPGMRESSetCGSRefinementType(), KSPGMRESGetCGSRefinementType(), KSP_GMRES_CGS_REFINE_NEVER, KSP_GMRES_CGS_REFINE_ALWAYS, 343 KSPGMRESModifiedGramSchmidtOrthogonalization() 344 M*/ 345 346 /*MC 347 KSP_GMRES_CGS_REFINE_NEVER - Do two steps of the classical (unmodified) Gram-Schmidt process. 348 349 Level: advanced 350 351 Note: This is roughly twice the cost of KSP_GMRES_CGS_REFINE_NEVER because it performs the process twice 352 but it saves the extra norm calculation needed by KSP_GMRES_CGS_REFINE_IFNEEDED. 353 354 You should only use this if you absolutely know that the iterative refinement is needed. 355 356 .seealso: KSPGMRESClassicalGramSchmidtOrthogonalization(), KSPGMRESSetOrthogonalization(), KSPGMRESGetOrthogonalization(), 357 KSPGMRESSetCGSRefinementType(), KSPGMRESGetCGSRefinementType(), KSP_GMRES_CGS_REFINE_IFNEEDED, KSP_GMRES_CGS_REFINE_ALWAYS, 358 KSPGMRESModifiedGramSchmidtOrthogonalization() 359 M*/ 360 361 PETSC_EXTERN PetscErrorCode KSPGMRESSetCGSRefinementType(KSP,KSPGMRESCGSRefinementType); 362 PETSC_EXTERN PetscErrorCode KSPGMRESGetCGSRefinementType(KSP,KSPGMRESCGSRefinementType*); 363 364 PETSC_EXTERN PetscErrorCode KSPFGMRESModifyPCNoChange(KSP,PetscInt,PetscInt,PetscReal,void*); 365 PETSC_EXTERN PetscErrorCode KSPFGMRESModifyPCKSP(KSP,PetscInt,PetscInt,PetscReal,void*); 366 PETSC_EXTERN PetscErrorCode KSPFGMRESSetModifyPC(KSP,PetscErrorCode (*)(KSP,PetscInt,PetscInt,PetscReal,void*),void*,PetscErrorCode(*)(void*)); 367 368 PETSC_EXTERN PetscErrorCode KSPQCGSetTrustRegionRadius(KSP,PetscReal); 369 PETSC_EXTERN PetscErrorCode KSPQCGGetQuadratic(KSP,PetscReal*); 370 PETSC_EXTERN PetscErrorCode KSPQCGGetTrialStepNorm(KSP,PetscReal*); 371 372 PETSC_EXTERN PetscErrorCode KSPBCGSLSetXRes(KSP,PetscReal); 373 PETSC_EXTERN PetscErrorCode KSPBCGSLSetPol(KSP,PetscBool); 374 PETSC_EXTERN PetscErrorCode KSPBCGSLSetEll(KSP,PetscInt); 375 PETSC_EXTERN PetscErrorCode KSPBCGSLSetUsePseudoinverse(KSP,PetscBool); 376 377 PETSC_EXTERN PetscErrorCode KSPSetFromOptions(KSP); 378 PETSC_EXTERN PetscErrorCode KSPResetFromOptions(KSP); 379 PETSC_EXTERN PetscErrorCode KSPAddOptionsChecker(PetscErrorCode (*)(KSP)); 380 381 PETSC_EXTERN PetscErrorCode KSPMonitorSetFromOptions(KSP,const char[],const char[],void*); 382 PETSC_EXTERN PetscErrorCode KSPMonitorLGCreate(MPI_Comm,const char[],const char[],const char[],PetscInt,const char *[],int,int,int,int,PetscDrawLG *); 383 PETSC_EXTERN PetscErrorCode KSPMonitorResidual(KSP,PetscInt,PetscReal,PetscViewerAndFormat*); 384 PETSC_EXTERN PetscErrorCode KSPMonitorResidualDraw(KSP,PetscInt,PetscReal,PetscViewerAndFormat*); 385 PETSC_EXTERN PetscErrorCode KSPMonitorResidualDrawLG(KSP,PetscInt,PetscReal,PetscViewerAndFormat*); 386 PETSC_EXTERN PetscErrorCode KSPMonitorResidualDrawLGCreate(PetscViewer,PetscViewerFormat,void *,PetscViewerAndFormat **); 387 PETSC_EXTERN PetscErrorCode KSPMonitorResidualShort(KSP,PetscInt,PetscReal,PetscViewerAndFormat*); 388 PETSC_EXTERN PetscErrorCode KSPMonitorResidualRange(KSP,PetscInt,PetscReal,PetscViewerAndFormat*); 389 PETSC_EXTERN PetscErrorCode KSPMonitorTrueResidual(KSP,PetscInt,PetscReal,PetscViewerAndFormat*); 390 PETSC_EXTERN PetscErrorCode KSPMonitorTrueResidualDraw(KSP,PetscInt,PetscReal,PetscViewerAndFormat*); 391 PETSC_EXTERN PetscErrorCode KSPMonitorTrueResidualDrawLG(KSP,PetscInt,PetscReal,PetscViewerAndFormat*); 392 PETSC_EXTERN PetscErrorCode KSPMonitorTrueResidualDrawLGCreate(PetscViewer,PetscViewerFormat,void *,PetscViewerAndFormat **); 393 PETSC_EXTERN PetscErrorCode KSPMonitorTrueResidualMax(KSP,PetscInt,PetscReal,PetscViewerAndFormat*); 394 PETSC_EXTERN PetscErrorCode KSPMonitorError(KSP,PetscInt,PetscReal,PetscViewerAndFormat*); 395 PETSC_EXTERN PetscErrorCode KSPMonitorErrorDraw(KSP,PetscInt,PetscReal,PetscViewerAndFormat*); 396 PETSC_EXTERN PetscErrorCode KSPMonitorErrorDrawLG(KSP,PetscInt,PetscReal,PetscViewerAndFormat*); 397 PETSC_EXTERN PetscErrorCode KSPMonitorErrorDrawLGCreate(PetscViewer,PetscViewerFormat,void *,PetscViewerAndFormat **); 398 PETSC_EXTERN PetscErrorCode KSPMonitorSolution(KSP,PetscInt,PetscReal,PetscViewerAndFormat*); 399 PETSC_EXTERN PetscErrorCode KSPMonitorSolutionDraw(KSP,PetscInt,PetscReal,PetscViewerAndFormat*); 400 PETSC_EXTERN PetscErrorCode KSPMonitorSolutionDrawLG(KSP,PetscInt,PetscReal,PetscViewerAndFormat*); 401 PETSC_EXTERN PetscErrorCode KSPMonitorSolutionDrawLGCreate(PetscViewer,PetscViewerFormat,void *,PetscViewerAndFormat **); 402 PETSC_EXTERN PetscErrorCode KSPMonitorSingularValue(KSP,PetscInt,PetscReal,PetscViewerAndFormat*); 403 PETSC_EXTERN PetscErrorCode KSPMonitorSingularValueCreate(PetscViewer,PetscViewerFormat,void *,PetscViewerAndFormat **); 404 PETSC_DEPRECATED_FUNCTION("Use KSPMonitorResidual() (since version 3.15)") static inline PetscErrorCode KSPMonitorDefault(KSP ksp, PetscInt n, PetscReal rnorm, PetscViewerAndFormat *vf) {return KSPMonitorResidual(ksp,n,rnorm,vf);} 405 PETSC_DEPRECATED_FUNCTION("Use KSPMonitorTrueResidual() (since version 3.15)") static inline PetscErrorCode KSPMonitorTrueResidualNorm(KSP ksp, PetscInt n, PetscReal rnorm, PetscViewerAndFormat *vf) {return KSPMonitorTrueResidual(ksp,n,rnorm,vf);} 406 PETSC_DEPRECATED_FUNCTION("Use KSPMonitorTrueResidualMax() (since version 3.15)") static inline PetscErrorCode KSPMonitorTrueResidualMaxNorm(KSP ksp, PetscInt n, PetscReal rnorm, PetscViewerAndFormat *vf) {return KSPMonitorTrueResidualMax(ksp,n,rnorm,vf);} 407 408 PETSC_EXTERN PetscErrorCode KSPGMRESMonitorKrylov(KSP,PetscInt,PetscReal,void*); 409 PETSC_EXTERN PetscErrorCode KSPMonitorDynamicTolerance(KSP ksp,PetscInt its,PetscReal fnorm,void *dummy); 410 PETSC_EXTERN PetscErrorCode KSPMonitorDynamicToleranceDestroy(void **dummy); 411 PETSC_EXTERN PetscErrorCode KSPMonitorSAWs(KSP,PetscInt,PetscReal,void*); 412 PETSC_EXTERN PetscErrorCode KSPMonitorSAWsCreate(KSP,void**); 413 PETSC_EXTERN PetscErrorCode KSPMonitorSAWsDestroy(void**); 414 415 PETSC_EXTERN PetscErrorCode KSPUnwindPreconditioner(KSP,Vec,Vec); 416 PETSC_EXTERN PetscErrorCode KSPInitialResidual(KSP,Vec,Vec,Vec,Vec,Vec); 417 418 PETSC_EXTERN PetscErrorCode KSPSetOperators(KSP,Mat,Mat); 419 PETSC_EXTERN PetscErrorCode KSPGetOperators(KSP,Mat*,Mat*); 420 PETSC_EXTERN PetscErrorCode KSPGetOperatorsSet(KSP,PetscBool*,PetscBool*); 421 PETSC_EXTERN PetscErrorCode KSPSetOptionsPrefix(KSP,const char[]); 422 PETSC_EXTERN PetscErrorCode KSPAppendOptionsPrefix(KSP,const char[]); 423 PETSC_EXTERN PetscErrorCode KSPGetOptionsPrefix(KSP,const char*[]); 424 425 PETSC_EXTERN PetscErrorCode KSPSetDiagonalScale(KSP,PetscBool); 426 PETSC_EXTERN PetscErrorCode KSPGetDiagonalScale(KSP,PetscBool*); 427 PETSC_EXTERN PetscErrorCode KSPSetDiagonalScaleFix(KSP,PetscBool); 428 PETSC_EXTERN PetscErrorCode KSPGetDiagonalScaleFix(KSP,PetscBool*); 429 430 PETSC_EXTERN PetscErrorCode KSPView(KSP,PetscViewer); 431 PETSC_EXTERN PetscErrorCode KSPLoad(KSP,PetscViewer); 432 PETSC_EXTERN PetscErrorCode KSPViewFromOptions(KSP,PetscObject,const char[]); 433 PETSC_EXTERN PetscErrorCode KSPConvergedReasonView(KSP,PetscViewer); 434 PETSC_EXTERN PetscErrorCode KSPConvergedReasonViewSet(KSP,PetscErrorCode (*)(KSP,void*),void *vctx,PetscErrorCode (*)(void**)); 435 PETSC_EXTERN PetscErrorCode KSPConvergedReasonViewFromOptions(KSP); 436 PETSC_EXTERN PetscErrorCode KSPConvergedReasonViewCancel(KSP); 437 PETSC_EXTERN PetscErrorCode KSPConvergedRateView(KSP,PetscViewer); 438 439 PETSC_DEPRECATED_FUNCTION("Use KSPConvergedReasonView() (since version 3.14)") static inline PetscErrorCode KSPReasonView(KSP ksp,PetscViewer v) {return KSPConvergedReasonView(ksp,v);} 440 PETSC_DEPRECATED_FUNCTION("Use KSPConvergedReasonViewFromOptions() (since version 3.14)") static inline PetscErrorCode KSPReasonViewFromOptions(KSP ksp) {return KSPConvergedReasonViewFromOptions(ksp);} 441 442 #define KSP_FILE_CLASSID 1211223 443 444 PETSC_EXTERN PetscErrorCode KSPLSQRSetExactMatNorm(KSP,PetscBool); 445 PETSC_EXTERN PetscErrorCode KSPLSQRSetComputeStandardErrorVec(KSP,PetscBool); 446 PETSC_EXTERN PetscErrorCode KSPLSQRGetStandardErrorVec(KSP,Vec*); 447 PETSC_EXTERN PetscErrorCode KSPLSQRGetNorms(KSP,PetscReal*,PetscReal*); 448 PETSC_EXTERN PetscErrorCode KSPLSQRMonitorResidual(KSP,PetscInt,PetscReal,PetscViewerAndFormat*); 449 PETSC_EXTERN PetscErrorCode KSPLSQRMonitorResidualDrawLG(KSP,PetscInt,PetscReal,PetscViewerAndFormat*); 450 PETSC_EXTERN PetscErrorCode KSPLSQRMonitorResidualDrawLGCreate(PetscViewer,PetscViewerFormat,void *,PetscViewerAndFormat **); 451 452 PETSC_EXTERN PetscErrorCode PCRedundantGetKSP(PC,KSP*); 453 PETSC_EXTERN PetscErrorCode PCRedistributeGetKSP(PC,KSP*); 454 PETSC_EXTERN PetscErrorCode PCTelescopeGetKSP(PC,KSP*); 455 456 /*E 457 KSPNormType - Norm that is passed in the Krylov convergence 458 test routines. 459 460 Level: advanced 461 462 Each solver only supports a subset of these and some may support different ones 463 depending on left or right preconditioning, see KSPSetPCSide() 464 465 Notes: 466 this must match petsc/finclude/petscksp.h 467 468 .seealso: KSPSolve(), KSPGetConvergedReason(), KSPSetNormType(), 469 KSPSetConvergenceTest(), KSPSetPCSide() 470 E*/ 471 typedef enum {KSP_NORM_DEFAULT = -1,KSP_NORM_NONE = 0,KSP_NORM_PRECONDITIONED = 1,KSP_NORM_UNPRECONDITIONED = 2,KSP_NORM_NATURAL = 3} KSPNormType; 472 #define KSP_NORM_MAX (KSP_NORM_NATURAL + 1) 473 PETSC_EXTERN const char *const*const KSPNormTypes; 474 475 /*MC 476 KSP_NORM_NONE - Do not compute a norm during the Krylov process. This will 477 possibly save some computation but means the convergence test cannot 478 be based on a norm of a residual etc. 479 480 Level: advanced 481 482 Note: Some Krylov methods need to compute a residual norm (such as GMRES) and then this option is ignored 483 484 .seealso: KSPNormType, KSPSetNormType(), KSP_NORM_PRECONDITIONED, KSP_NORM_UNPRECONDITIONED, KSP_NORM_NATURAL 485 M*/ 486 487 /*MC 488 KSP_NORM_PRECONDITIONED - Compute the norm of the preconditioned residual B*(b - A*x), if left preconditioning, and pass that to the 489 convergence test routine. 490 491 Level: advanced 492 493 .seealso: KSPNormType, KSPSetNormType(), KSP_NORM_NONE, KSP_NORM_UNPRECONDITIONED, KSP_NORM_NATURAL, KSPSetConvergenceTest() 494 M*/ 495 496 /*MC 497 KSP_NORM_UNPRECONDITIONED - Compute the norm of the true residual (b - A*x) and pass that to the 498 convergence test routine. 499 500 Level: advanced 501 502 .seealso: KSPNormType, KSPSetNormType(), KSP_NORM_NONE, KSP_NORM_PRECONDITIONED, KSP_NORM_NATURAL, KSPSetConvergenceTest() 503 M*/ 504 505 /*MC 506 KSP_NORM_NATURAL - Compute the 'natural norm' of residual sqrt((b - A*x)*B*(b - A*x)) and pass that to the 507 convergence test routine. This is only supported by KSPCG, KSPCR, KSPCGNE, KSPCGS, KSPFCG, KSPPIPEFCG, KSPPIPEGCR 508 509 Level: advanced 510 511 .seealso: KSPNormType, KSPSetNormType(), KSP_NORM_NONE, KSP_NORM_PRECONDITIONED, KSP_NORM_UNPRECONDITIONED, KSPSetConvergenceTest() 512 M*/ 513 514 PETSC_EXTERN PetscErrorCode KSPSetNormType(KSP,KSPNormType); 515 PETSC_EXTERN PetscErrorCode KSPGetNormType(KSP,KSPNormType*); 516 PETSC_EXTERN PetscErrorCode KSPSetSupportedNorm(KSP ksp,KSPNormType,PCSide,PetscInt); 517 PETSC_EXTERN PetscErrorCode KSPSetCheckNormIteration(KSP,PetscInt); 518 PETSC_EXTERN PetscErrorCode KSPSetLagNorm(KSP,PetscBool); 519 520 #define KSP_DIVERGED_PCSETUP_FAILED_DEPRECATED KSP_DIVERGED_PCSETUP_FAILED PETSC_DEPRECATED_ENUM("Use KSP_DIVERGED_PC_FAILED (since version 3.11)") 521 /*E 522 KSPConvergedReason - reason a Krylov method was said to have converged or diverged 523 524 Level: beginner 525 526 Notes: 527 See KSPGetConvergedReason() for explanation of each value 528 529 Developer Notes: 530 this must match petsc/finclude/petscksp.h 531 532 The string versions of these are KSPConvergedReasons; if you change 533 any of the values here also change them that array of names. 534 535 .seealso: KSPSolve(), KSPGetConvergedReason(), KSPSetTolerances(), KSPConvergedReasonView() 536 E*/ 537 typedef enum {/* converged */ 538 KSP_CONVERGED_RTOL_NORMAL = 1, 539 KSP_CONVERGED_ATOL_NORMAL = 9, 540 KSP_CONVERGED_RTOL = 2, 541 KSP_CONVERGED_ATOL = 3, 542 KSP_CONVERGED_ITS = 4, 543 KSP_CONVERGED_CG_NEG_CURVE = 5, 544 KSP_CONVERGED_CG_CONSTRAINED = 6, 545 KSP_CONVERGED_STEP_LENGTH = 7, 546 KSP_CONVERGED_HAPPY_BREAKDOWN = 8, 547 /* diverged */ 548 KSP_DIVERGED_NULL = -2, 549 KSP_DIVERGED_ITS = -3, 550 KSP_DIVERGED_DTOL = -4, 551 KSP_DIVERGED_BREAKDOWN = -5, 552 KSP_DIVERGED_BREAKDOWN_BICG = -6, 553 KSP_DIVERGED_NONSYMMETRIC = -7, 554 KSP_DIVERGED_INDEFINITE_PC = -8, 555 KSP_DIVERGED_NANORINF = -9, 556 KSP_DIVERGED_INDEFINITE_MAT = -10, 557 KSP_DIVERGED_PC_FAILED = -11, 558 KSP_DIVERGED_PCSETUP_FAILED_DEPRECATED = -11, 559 560 KSP_CONVERGED_ITERATING = 0} KSPConvergedReason; 561 PETSC_EXTERN const char *const*KSPConvergedReasons; 562 563 /*MC 564 KSP_CONVERGED_RTOL - norm(r) <= rtol*norm(b) or rtol*norm(b - A*x_0) if KSPConvergedDefaultSetUIRNorm() was called 565 566 Level: beginner 567 568 See KSPNormType and KSPSetNormType() for possible norms that may be used. By default 569 for left preconditioning it is the 2-norm of the preconditioned residual, and the 570 2-norm of the residual for right preconditioning 571 572 See also KSP_CONVERGED_ATOL which may apply before this tolerance. 573 574 .seealso: KSP_CONVERGED_ATOL, KSP_DIVERGED_DTOL, KSPSolve(), KSPGetConvergedReason(), KSPConvergedReason, KSPSetTolerances() 575 576 M*/ 577 578 /*MC 579 KSP_CONVERGED_ATOL - norm(r) <= atol 580 581 Level: beginner 582 583 See KSPNormType and KSPSetNormType() for possible norms that may be used. By default 584 for left preconditioning it is the 2-norm of the preconditioned residual, and the 585 2-norm of the residual for right preconditioning 586 587 See also KSP_CONVERGED_RTOL which may apply before this tolerance. 588 589 .seealso: KSP_CONVERGED_RTOL, KSP_DIVERGED_DTOL, KSPSolve(), KSPGetConvergedReason(), KSPConvergedReason, KSPSetTolerances() 590 591 M*/ 592 593 /*MC 594 KSP_DIVERGED_DTOL - norm(r) >= dtol*norm(b) 595 596 Level: beginner 597 598 See KSPNormType and KSPSetNormType() for possible norms that may be used. By default 599 for left preconditioning it is the 2-norm of the preconditioned residual, and the 600 2-norm of the residual for right preconditioning 601 602 Level: beginner 603 604 .seealso: KSP_CONVERGED_ATOL, KSP_DIVERGED_RTOL, KSPSolve(), KSPGetConvergedReason(), KSPConvergedReason, KSPSetTolerances() 605 606 M*/ 607 608 /*MC 609 KSP_DIVERGED_ITS - Ran out of iterations before any convergence criteria was 610 reached 611 612 Level: beginner 613 614 .seealso: KSPSolve(), KSPGetConvergedReason(), KSPConvergedReason, KSPSetTolerances() 615 616 M*/ 617 618 /*MC 619 KSP_CONVERGED_ITS - Used by the KSPPREONLY solver after the single iteration of 620 the preconditioner is applied. Also used when the KSPConvergedSkip() convergence 621 test routine is set in KSP. 622 623 Level: beginner 624 625 .seealso: KSPSolve(), KSPGetConvergedReason(), KSPConvergedReason, KSPSetTolerances() 626 627 M*/ 628 629 /*MC 630 KSP_DIVERGED_BREAKDOWN - A breakdown in the Krylov method was detected so the 631 method could not continue to enlarge the Krylov space. Could be due to a singular matrix or 632 preconditioner. In KSPHPDDM, this is also returned when some search directions within a block 633 are colinear. 634 635 Level: beginner 636 637 .seealso: KSPSolve(), KSPGetConvergedReason(), KSPConvergedReason, KSPSetTolerances() 638 639 M*/ 640 641 /*MC 642 KSP_DIVERGED_BREAKDOWN_BICG - A breakdown in the KSPBICG method was detected so the 643 method could not continue to enlarge the Krylov space. 644 645 Level: beginner 646 647 .seealso: KSPSolve(), KSPGetConvergedReason(), KSPConvergedReason, KSPSetTolerances() 648 649 M*/ 650 651 /*MC 652 KSP_DIVERGED_NONSYMMETRIC - It appears the operator or preconditioner is not 653 symmetric and this Krylov method (KSPCG, KSPMINRES, KSPCR) requires symmetry 654 655 Level: beginner 656 657 .seealso: KSPSolve(), KSPGetConvergedReason(), KSPConvergedReason, KSPSetTolerances() 658 659 M*/ 660 661 /*MC 662 KSP_DIVERGED_INDEFINITE_PC - It appears the preconditioner is indefinite (has both 663 positive and negative eigenvalues) and this Krylov method (KSPCG) requires it to 664 be positive definite 665 666 Level: beginner 667 668 Notes: 669 This can happen with the PCICC preconditioner, use -pc_factor_shift_positive_definite to force 670 the PCICC preconditioner to generate a positive definite preconditioner 671 672 .seealso: KSPSolve(), KSPGetConvergedReason(), KSPConvergedReason, KSPSetTolerances() 673 674 M*/ 675 676 /*MC 677 KSP_DIVERGED_PC_FAILED - It was not possible to build or use the requested preconditioner. This is usually due to a 678 zero pivot in a factorization. It can also result from a failure in a subpreconditioner inside a nested preconditioner 679 such as PCFIELDSPLIT. 680 681 Level: beginner 682 683 Notes: 684 Run with -ksp_error_if_not_converged to stop the program when the error is detected and print an error message with details. 685 686 .seealso: KSPSolve(), KSPGetConvergedReason(), KSPConvergedReason, KSPSetTolerances() 687 688 M*/ 689 690 /*MC 691 KSP_CONVERGED_ITERATING - This flag is returned if you call KSPGetConvergedReason() 692 while the KSPSolve() is still running. 693 694 Level: beginner 695 696 .seealso: KSPSolve(), KSPGetConvergedReason(), KSPConvergedReason, KSPSetTolerances() 697 698 M*/ 699 700 PETSC_EXTERN PetscErrorCode KSPSetConvergenceTest(KSP,PetscErrorCode (*)(KSP,PetscInt,PetscReal,KSPConvergedReason*,void*),void*,PetscErrorCode (*)(void*)); 701 PETSC_EXTERN PetscErrorCode KSPGetConvergenceTest(KSP,PetscErrorCode (**)(KSP,PetscInt,PetscReal,KSPConvergedReason*,void*),void**,PetscErrorCode (**)(void*)); 702 PETSC_EXTERN PetscErrorCode KSPGetAndClearConvergenceTest(KSP,PetscErrorCode (**)(KSP,PetscInt,PetscReal,KSPConvergedReason*,void*),void**,PetscErrorCode (**)(void*)); 703 PETSC_EXTERN PetscErrorCode KSPGetConvergenceContext(KSP,void*); 704 PETSC_EXTERN PetscErrorCode KSPConvergedDefault(KSP,PetscInt,PetscReal,KSPConvergedReason*,void*); 705 PETSC_EXTERN PetscErrorCode KSPLSQRConvergedDefault(KSP,PetscInt,PetscReal,KSPConvergedReason*,void*); 706 PETSC_EXTERN PetscErrorCode KSPConvergedDefaultDestroy(void*); 707 PETSC_EXTERN PetscErrorCode KSPConvergedDefaultCreate(void**); 708 PETSC_EXTERN PetscErrorCode KSPConvergedDefaultSetUIRNorm(KSP); 709 PETSC_EXTERN PetscErrorCode KSPConvergedDefaultSetUMIRNorm(KSP); 710 PETSC_EXTERN PetscErrorCode KSPConvergedDefaultSetConvergedMaxits(KSP,PetscBool); 711 PETSC_EXTERN PetscErrorCode KSPConvergedSkip(KSP,PetscInt,PetscReal,KSPConvergedReason*,void*); 712 PETSC_EXTERN PetscErrorCode KSPGetConvergedReason(KSP,KSPConvergedReason*); 713 PETSC_EXTERN PetscErrorCode KSPGetConvergedReasonString(KSP,const char**); 714 PETSC_EXTERN PetscErrorCode KSPComputeConvergenceRate(KSP,PetscReal*,PetscReal*,PetscReal*,PetscReal*); 715 716 PETSC_DEPRECATED_FUNCTION("Use KSPConvergedDefault() (since version 3.5)") static inline void KSPDefaultConverged(void) { /* never called */ } 717 #define KSPDefaultConverged (KSPDefaultConverged, KSPConvergedDefault) 718 PETSC_DEPRECATED_FUNCTION("Use KSPConvergedDefaultDestroy() (since version 3.5)") static inline void KSPDefaultConvergedDestroy(void) { /* never called */ } 719 #define KSPDefaultConvergedDestroy (KSPDefaultConvergedDestroy, KSPConvergedDefaultDestroy) 720 PETSC_DEPRECATED_FUNCTION("Use KSPConvergedDefaultCreate() (since version 3.5)") static inline void KSPDefaultConvergedCreate(void) { /* never called */ } 721 #define KSPDefaultConvergedCreate (KSPDefaultConvergedCreate, KSPConvergedDefaultCreate) 722 PETSC_DEPRECATED_FUNCTION("Use KSPConvergedDefaultSetUIRNorm() (since version 3.5)") static inline void KSPDefaultConvergedSetUIRNorm(void) { /* never called */ } 723 #define KSPDefaultConvergedSetUIRNorm (KSPDefaultConvergedSetUIRNorm, KSPConvergedDefaultSetUIRNorm) 724 PETSC_DEPRECATED_FUNCTION("Use KSPConvergedDefaultSetUMIRNorm() (since version 3.5)") static inline void KSPDefaultConvergedSetUMIRNorm(void) { /* never called */ } 725 #define KSPDefaultConvergedSetUMIRNorm (KSPDefaultConvergedSetUMIRNorm, KSPConvergedDefaultSetUMIRNorm) 726 PETSC_DEPRECATED_FUNCTION("Use KSPConvergedSkip() (since version 3.5)") static inline void KSPSkipConverged(void) { /* never called */ } 727 #define KSPSkipConverged (KSPSkipConverged, KSPConvergedSkip) 728 729 PETSC_EXTERN PetscErrorCode KSPComputeOperator(KSP,MatType,Mat*); 730 PETSC_DEPRECATED_FUNCTION("Use KSPComputeOperator() (since version 3.12)") static inline PetscErrorCode KSPComputeExplicitOperator(KSP A,Mat* B) { return KSPComputeOperator(A,NULL,B); } 731 732 /*E 733 KSPCGType - Determines what type of CG to use 734 735 Level: beginner 736 737 .seealso: KSPCGSetType() 738 E*/ 739 typedef enum {KSP_CG_SYMMETRIC=0,KSP_CG_HERMITIAN=1} KSPCGType; 740 PETSC_EXTERN const char *const KSPCGTypes[]; 741 742 PETSC_EXTERN PetscErrorCode KSPCGSetType(KSP,KSPCGType); 743 PETSC_EXTERN PetscErrorCode KSPCGUseSingleReduction(KSP,PetscBool); 744 745 PETSC_EXTERN PetscErrorCode KSPCGSetRadius(KSP,PetscReal); 746 PETSC_EXTERN PetscErrorCode KSPCGGetNormD(KSP,PetscReal*); 747 PETSC_EXTERN PetscErrorCode KSPCGGetObjFcn(KSP,PetscReal*); 748 749 PETSC_EXTERN PetscErrorCode KSPGLTRGetMinEig(KSP,PetscReal*); 750 PETSC_EXTERN PetscErrorCode KSPGLTRGetLambda(KSP,PetscReal*); 751 PETSC_DEPRECATED_FUNCTION("Use KSPGLTRGetMinEig (since v3.12)") static inline PetscErrorCode KSPCGGLTRGetMinEig(KSP ksp,PetscReal *x) {return KSPGLTRGetMinEig(ksp,x);} 752 PETSC_DEPRECATED_FUNCTION("Use KSPGLTRGetLambda (since v3.12)") static inline PetscErrorCode KSPCGGLTRGetLambda(KSP ksp,PetscReal *x) {return KSPGLTRGetLambda(ksp,x);} 753 754 PETSC_EXTERN PetscErrorCode KSPPythonSetType(KSP,const char[]); 755 756 PETSC_EXTERN PetscErrorCode PCSetPreSolve(PC,PetscErrorCode (*)(PC,KSP)); 757 PETSC_EXTERN PetscErrorCode PCPreSolve(PC,KSP); 758 PETSC_EXTERN PetscErrorCode PCPostSolve(PC,KSP); 759 760 #include <petscdrawtypes.h> 761 PETSC_EXTERN PetscErrorCode KSPMonitorLGRange(KSP,PetscInt,PetscReal,void*); 762 763 PETSC_EXTERN PetscErrorCode PCShellSetPreSolve(PC,PetscErrorCode (*)(PC,KSP,Vec,Vec)); 764 PETSC_EXTERN PetscErrorCode PCShellSetPostSolve(PC,PetscErrorCode (*)(PC,KSP,Vec,Vec)); 765 766 /*S 767 KSPGuess - Abstract PETSc object that manages all initial guess methods in Krylov methods. 768 769 Level: beginner 770 771 .seealso: KSPCreate(), KSPSetGuessType(), KSPGuessType 772 S*/ 773 typedef struct _p_KSPGuess* KSPGuess; 774 /*J 775 KSPGuessType - String with the name of a PETSc initial guess for Krylov methods. 776 777 Level: beginner 778 779 .seealso: KSPGuess 780 J*/ 781 typedef const char* KSPGuessType; 782 #define KSPGUESSFISCHER "fischer" 783 #define KSPGUESSPOD "pod" 784 PETSC_EXTERN PetscErrorCode KSPGuessRegister(const char[],PetscErrorCode (*)(KSPGuess)); 785 PETSC_EXTERN PetscErrorCode KSPSetGuess(KSP,KSPGuess); 786 PETSC_EXTERN PetscErrorCode KSPGetGuess(KSP,KSPGuess*); 787 PETSC_EXTERN PetscErrorCode KSPGuessView(KSPGuess,PetscViewer); 788 PETSC_EXTERN PetscErrorCode KSPGuessDestroy(KSPGuess*); 789 PETSC_EXTERN PetscErrorCode KSPGuessCreate(MPI_Comm,KSPGuess*); 790 PETSC_EXTERN PetscErrorCode KSPGuessSetType(KSPGuess,KSPGuessType); 791 PETSC_EXTERN PetscErrorCode KSPGuessGetType(KSPGuess,KSPGuessType*); 792 PETSC_EXTERN PetscErrorCode KSPGuessSetTolerance(KSPGuess,PetscReal); 793 PETSC_EXTERN PetscErrorCode KSPGuessSetUp(KSPGuess); 794 PETSC_EXTERN PetscErrorCode KSPGuessUpdate(KSPGuess,Vec,Vec); 795 PETSC_EXTERN PetscErrorCode KSPGuessFormGuess(KSPGuess,Vec,Vec); 796 PETSC_EXTERN PetscErrorCode KSPGuessSetFromOptions(KSPGuess); 797 PETSC_EXTERN PetscErrorCode KSPGuessFischerSetModel(KSPGuess,PetscInt,PetscInt); 798 PETSC_EXTERN PetscErrorCode KSPSetUseFischerGuess(KSP,PetscInt,PetscInt); 799 PETSC_EXTERN PetscErrorCode KSPSetInitialGuessKnoll(KSP,PetscBool); 800 PETSC_EXTERN PetscErrorCode KSPGetInitialGuessKnoll(KSP,PetscBool*); 801 802 /*E 803 MatSchurComplementAinvType - Determines how to approximate the inverse of the (0,0) block in Schur complement preconditioning matrix assembly routines 804 805 Level: intermediate 806 807 .seealso: MatSchurComplementGetAinvType(), MatSchurComplementSetAinvType(), MatSchurComplementGetPmat(), MatGetSchurComplement(), MatCreateSchurComplementPmat() 808 E*/ 809 typedef enum {MAT_SCHUR_COMPLEMENT_AINV_DIAG, MAT_SCHUR_COMPLEMENT_AINV_LUMP, MAT_SCHUR_COMPLEMENT_AINV_BLOCK_DIAG} MatSchurComplementAinvType; 810 PETSC_EXTERN const char *const MatSchurComplementAinvTypes[]; 811 812 typedef enum {MAT_LMVM_SYMBROYDEN_SCALE_NONE = 0, 813 MAT_LMVM_SYMBROYDEN_SCALE_SCALAR = 1, 814 MAT_LMVM_SYMBROYDEN_SCALE_DIAGONAL = 2, 815 MAT_LMVM_SYMBROYDEN_SCALE_USER = 3} MatLMVMSymBroydenScaleType; 816 PETSC_EXTERN const char *const MatLMVMSymBroydenScaleTypes[]; 817 818 PETSC_EXTERN PetscErrorCode MatCreateSchurComplement(Mat,Mat,Mat,Mat,Mat,Mat*); 819 PETSC_EXTERN PetscErrorCode MatSchurComplementGetKSP(Mat,KSP*); 820 PETSC_EXTERN PetscErrorCode MatSchurComplementSetKSP(Mat,KSP); 821 PETSC_EXTERN PetscErrorCode MatSchurComplementSetSubMatrices(Mat,Mat,Mat,Mat,Mat,Mat); 822 PETSC_EXTERN PetscErrorCode MatSchurComplementUpdateSubMatrices(Mat,Mat,Mat,Mat,Mat,Mat); 823 PETSC_EXTERN PetscErrorCode MatSchurComplementGetSubMatrices(Mat,Mat*,Mat*,Mat*,Mat*,Mat*); 824 PETSC_EXTERN PetscErrorCode MatSchurComplementSetAinvType(Mat,MatSchurComplementAinvType); 825 PETSC_EXTERN PetscErrorCode MatSchurComplementGetAinvType(Mat,MatSchurComplementAinvType*); 826 PETSC_EXTERN PetscErrorCode MatSchurComplementGetPmat(Mat,MatReuse,Mat*); 827 PETSC_EXTERN PetscErrorCode MatSchurComplementComputeExplicitOperator(Mat,Mat*); 828 PETSC_EXTERN PetscErrorCode MatGetSchurComplement(Mat,IS,IS,IS,IS,MatReuse,Mat*,MatSchurComplementAinvType,MatReuse,Mat*); 829 PETSC_EXTERN PetscErrorCode MatCreateSchurComplementPmat(Mat,Mat,Mat,Mat,MatSchurComplementAinvType,MatReuse,Mat*); 830 831 PETSC_EXTERN PetscErrorCode MatCreateLMVMDFP(MPI_Comm,PetscInt,PetscInt,Mat*); 832 PETSC_EXTERN PetscErrorCode MatCreateLMVMBFGS(MPI_Comm,PetscInt,PetscInt,Mat*); 833 PETSC_EXTERN PetscErrorCode MatCreateLMVMSR1(MPI_Comm,PetscInt,PetscInt,Mat*); 834 PETSC_EXTERN PetscErrorCode MatCreateLMVMBroyden(MPI_Comm,PetscInt,PetscInt,Mat*); 835 PETSC_EXTERN PetscErrorCode MatCreateLMVMBadBroyden(MPI_Comm,PetscInt,PetscInt,Mat*); 836 PETSC_EXTERN PetscErrorCode MatCreateLMVMSymBroyden(MPI_Comm,PetscInt,PetscInt,Mat*); 837 PETSC_EXTERN PetscErrorCode MatCreateLMVMSymBadBroyden(MPI_Comm,PetscInt,PetscInt,Mat*); 838 PETSC_EXTERN PetscErrorCode MatCreateLMVMDiagBroyden(MPI_Comm,PetscInt,PetscInt,Mat*); 839 840 PETSC_EXTERN PetscErrorCode MatLMVMUpdate(Mat, Vec, Vec); 841 PETSC_EXTERN PetscErrorCode MatLMVMIsAllocated(Mat, PetscBool*); 842 PETSC_EXTERN PetscErrorCode MatLMVMAllocate(Mat, Vec, Vec); 843 PETSC_EXTERN PetscErrorCode MatLMVMReset(Mat, PetscBool); 844 PETSC_EXTERN PetscErrorCode MatLMVMResetShift(Mat); 845 PETSC_EXTERN PetscErrorCode MatLMVMClearJ0(Mat); 846 PETSC_EXTERN PetscErrorCode MatLMVMSetJ0(Mat, Mat); 847 PETSC_EXTERN PetscErrorCode MatLMVMSetJ0Scale(Mat, PetscReal); 848 PETSC_EXTERN PetscErrorCode MatLMVMSetJ0Diag(Mat, Vec); 849 PETSC_EXTERN PetscErrorCode MatLMVMSetJ0PC(Mat, PC); 850 PETSC_EXTERN PetscErrorCode MatLMVMSetJ0KSP(Mat, KSP); 851 PETSC_EXTERN PetscErrorCode MatLMVMApplyJ0Fwd(Mat, Vec, Vec); 852 PETSC_EXTERN PetscErrorCode MatLMVMApplyJ0Inv(Mat, Vec, Vec); 853 PETSC_EXTERN PetscErrorCode MatLMVMGetJ0(Mat, Mat*); 854 PETSC_EXTERN PetscErrorCode MatLMVMGetJ0PC(Mat, PC*); 855 PETSC_EXTERN PetscErrorCode MatLMVMGetJ0KSP(Mat, KSP*); 856 PETSC_EXTERN PetscErrorCode MatLMVMSetHistorySize(Mat, PetscInt); 857 PETSC_EXTERN PetscErrorCode MatLMVMGetUpdateCount(Mat, PetscInt*); 858 PETSC_EXTERN PetscErrorCode MatLMVMGetRejectCount(Mat, PetscInt*); 859 PETSC_EXTERN PetscErrorCode MatLMVMSymBroydenSetDelta(Mat, PetscScalar); 860 PETSC_EXTERN PetscErrorCode MatLMVMSymBroydenSetScaleType(Mat, MatLMVMSymBroydenScaleType); 861 862 PETSC_EXTERN PetscErrorCode KSPSetDM(KSP,DM); 863 PETSC_EXTERN PetscErrorCode KSPSetDMActive(KSP,PetscBool); 864 PETSC_EXTERN PetscErrorCode KSPGetDM(KSP,DM*); 865 PETSC_EXTERN PetscErrorCode KSPSetApplicationContext(KSP,void*); 866 PETSC_EXTERN PetscErrorCode KSPGetApplicationContext(KSP,void*); 867 PETSC_EXTERN PetscErrorCode KSPSetComputeRHS(KSP,PetscErrorCode (*func)(KSP,Vec,void*),void*); 868 PETSC_EXTERN PetscErrorCode KSPSetComputeOperators(KSP,PetscErrorCode(*)(KSP,Mat,Mat,void*),void*); 869 PETSC_EXTERN PetscErrorCode KSPSetComputeInitialGuess(KSP,PetscErrorCode(*)(KSP,Vec,void*),void*); 870 PETSC_EXTERN PetscErrorCode DMKSPSetComputeOperators(DM,PetscErrorCode(*)(KSP,Mat,Mat,void*),void*); 871 PETSC_EXTERN PetscErrorCode DMKSPGetComputeOperators(DM,PetscErrorCode(**)(KSP,Mat,Mat,void*),void*); 872 PETSC_EXTERN PetscErrorCode DMKSPSetComputeRHS(DM,PetscErrorCode(*)(KSP,Vec,void*),void*); 873 PETSC_EXTERN PetscErrorCode DMKSPGetComputeRHS(DM,PetscErrorCode(**)(KSP,Vec,void*),void*); 874 PETSC_EXTERN PetscErrorCode DMKSPSetComputeInitialGuess(DM,PetscErrorCode(*)(KSP,Vec,void*),void*); 875 PETSC_EXTERN PetscErrorCode DMKSPGetComputeInitialGuess(DM,PetscErrorCode(**)(KSP,Vec,void*),void*); 876 877 PETSC_EXTERN PetscErrorCode DMGlobalToLocalSolve(DM,Vec,Vec); 878 PETSC_EXTERN PetscErrorCode DMProjectField(DM, PetscReal, Vec, 879 void (**)(PetscInt, PetscInt, PetscInt, 880 const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], 881 const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[], 882 PetscReal, const PetscReal [], PetscInt, const PetscScalar[], PetscScalar []), InsertMode, Vec); 883 884 PETSC_EXTERN PetscErrorCode DMAdaptInterpolator(DM, DM, Mat, KSP, PetscInt, Vec[], Vec[], Mat *, void *); 885 PETSC_EXTERN PetscErrorCode DMCheckInterpolator(DM, Mat, PetscInt, Vec[], Vec[], PetscReal); 886 #endif 887