1 /* $Id: petscksp.h,v 1.107 2001/08/06 21:16:38 bsmith Exp $ */ 2 /* 3 Defines the interface functions for the Krylov subspace accelerators. 4 */ 5 #ifndef __PETSCKSP_H 6 #define __PETSCKSP_H 7 #include "petscpc.h" 8 PETSC_EXTERN_CXX_BEGIN 9 10 EXTERN int KSPInitializePackage(const char[]); 11 12 /*S 13 KSP - Abstract PETSc object that manages all Krylov methods 14 15 Level: beginner 16 17 Concepts: Krylov methods 18 19 .seealso: KSPCreate(), KSPSetType(), KSPType, SNES, TS, PC, KSP 20 S*/ 21 typedef struct _p_KSP* KSP; 22 23 /*E 24 KSPType - String with the name of a PETSc Krylov method or the creation function 25 with an optional dynamic library name, for example 26 http://www.mcs.anl.gov/petsc/lib.a:mykspcreate() 27 28 Level: beginner 29 30 .seealso: KSPSetType(), KSP 31 E*/ 32 #define KSPRICHARDSON "richardson" 33 #define KSPCHEBYCHEV "chebychev" 34 #define KSPCG "cg" 35 #define KSPCGNE "cgne" 36 #define KSPGMRES "gmres" 37 #define KSPTCQMR "tcqmr" 38 #define KSPBCGS "bcgs" 39 #define KSPCGS "cgs" 40 #define KSPTFQMR "tfqmr" 41 #define KSPCR "cr" 42 #define KSPLSQR "lsqr" 43 #define KSPPREONLY "preonly" 44 #define KSPQCG "qcg" 45 #define KSPBICG "bicg" 46 #define KSPFGMRES "fgmres" 47 #define KSPMINRES "minres" 48 #define KSPSYMMLQ "symmlq" 49 #define KSPLGMRES "lgmres" 50 #define KSPType char* 51 52 /* Logging support */ 53 extern int KSP_COOKIE; 54 extern int KSP_GMRESOrthogonalization; 55 extern int KSP_SetUp, KSP_Solve; 56 57 EXTERN int KSPCreate(MPI_Comm,KSP *); 58 EXTERN int KSPSetType(KSP,const KSPType); 59 EXTERN int KSPSetUp(KSP); 60 EXTERN int KSPSetUpOnBlocks(KSP); 61 EXTERN int KSPSolve(KSP,Vec,Vec); 62 EXTERN int KSPSolveTranspose(KSP,Vec,Vec); 63 EXTERN int KSPDestroy(KSP); 64 65 extern PetscFList KSPList; 66 EXTERN int KSPRegisterAll(const char[]); 67 EXTERN int KSPRegisterDestroy(void); 68 69 EXTERN int KSPRegister(const char[],const char[],const char[],int(*)(KSP)); 70 71 /*MC 72 KSPRegisterDynamic - Adds a method to the Krylov subspace solver package. 73 74 Synopsis: 75 int KSPRegisterDynamic(char *name_solver,char *path,char *name_create,int (*routine_create)(KSP)) 76 77 Not Collective 78 79 Input Parameters: 80 + name_solver - name of a new user-defined solver 81 . path - path (either absolute or relative) the library containing this solver 82 . name_create - name of routine to create method context 83 - routine_create - routine to create method context 84 85 Notes: 86 KSPRegisterDynamic() may be called multiple times to add several user-defined solvers. 87 88 If dynamic libraries are used, then the fourth input argument (routine_create) 89 is ignored. 90 91 Sample usage: 92 .vb 93 KSPRegisterDynamic("my_solver",/home/username/my_lib/lib/libO/solaris/mylib.a, 94 "MySolverCreate",MySolverCreate); 95 .ve 96 97 Then, your solver can be chosen with the procedural interface via 98 $ KSPSetType(ksp,"my_solver") 99 or at runtime via the option 100 $ -ksp_type my_solver 101 102 Level: advanced 103 104 Notes: Environmental variables such as ${PETSC_ARCH}, ${PETSC_DIR}, ${PETSC_LIB_DIR}, ${BOPT}, 105 and others of the form ${any_environmental_variable} occuring in pathname will be 106 replaced with appropriate values. 107 If your function is not being put into a shared library then use KSPRegister() instead 108 109 .keywords: KSP, register 110 111 .seealso: KSPRegisterAll(), KSPRegisterDestroy() 112 113 M*/ 114 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 115 #define KSPRegisterDynamic(a,b,c,d) KSPRegister(a,b,c,0) 116 #else 117 #define KSPRegisterDynamic(a,b,c,d) KSPRegister(a,b,c,d) 118 #endif 119 120 EXTERN int KSPGetType(KSP,KSPType *); 121 EXTERN int KSPSetPreconditionerSide(KSP,PCSide); 122 EXTERN int KSPGetPreconditionerSide(KSP,PCSide*); 123 EXTERN int KSPGetTolerances(KSP,PetscReal*,PetscReal*,PetscReal*,int*); 124 EXTERN int KSPSetTolerances(KSP,PetscReal,PetscReal,PetscReal,int); 125 EXTERN int KSPSetInitialGuessNonzero(KSP,PetscTruth); 126 EXTERN int KSPGetInitialGuessNonzero(KSP,PetscTruth *); 127 EXTERN int KSPSetInitialGuessKnoll(KSP,PetscTruth); 128 EXTERN int KSPGetInitialGuessKnoll(KSP,PetscTruth*); 129 EXTERN int KSPSetComputeEigenvalues(KSP,PetscTruth); 130 EXTERN int KSPSetComputeSingularValues(KSP,PetscTruth); 131 EXTERN int KSPGetRhs(KSP,Vec *); 132 EXTERN int KSPGetSolution(KSP,Vec *); 133 EXTERN int KSPGetResidualNorm(KSP,PetscReal*); 134 EXTERN int KSPGetIterationNumber(KSP,int*); 135 EXTERN int KSPSetNullSpace(KSP,MatNullSpace); 136 EXTERN int KSPGetNullSpace(KSP,MatNullSpace*); 137 138 EXTERN int KSPSetPC(KSP,PC); 139 EXTERN int KSPGetPC(KSP,PC*); 140 141 EXTERN int KSPSetMonitor(KSP,int (*)(KSP,int,PetscReal,void*),void *,int (*)(void*)); 142 EXTERN int KSPClearMonitor(KSP); 143 EXTERN int KSPGetMonitorContext(KSP,void **); 144 EXTERN int KSPGetResidualHistory(KSP,PetscReal*[],int *); 145 EXTERN int KSPSetResidualHistory(KSP,PetscReal[],int,PetscTruth); 146 147 /* not sure where to put this */ 148 EXTERN int PCKSPGetKSP(PC,KSP*); 149 EXTERN int PCBJacobiGetSubKSP(PC,int*,int*,KSP*[]); 150 EXTERN int PCASMGetSubKSP(PC,int*,int*,KSP*[]); 151 152 EXTERN int KSPBuildSolution(KSP,Vec,Vec *); 153 EXTERN int KSPBuildResidual(KSP,Vec,Vec,Vec *); 154 155 EXTERN int KSPRichardsonSetScale(KSP,PetscReal); 156 EXTERN int KSPChebychevSetEigenvalues(KSP,PetscReal,PetscReal); 157 EXTERN int KSPComputeExtremeSingularValues(KSP,PetscReal*,PetscReal*); 158 EXTERN int KSPComputeEigenvalues(KSP,int,PetscReal*,PetscReal*,int *); 159 EXTERN int KSPComputeEigenvaluesExplicitly(KSP,int,PetscReal*,PetscReal*); 160 161 EXTERN int KSPGMRESSetRestart(KSP, int); 162 EXTERN int KSPGMRESSetHapTol(KSP,PetscReal); 163 164 EXTERN int KSPGMRESSetPreAllocateVectors(KSP); 165 EXTERN int KSPGMRESSetOrthogonalization(KSP,int (*)(KSP,int)); 166 EXTERN int KSPGMRESModifiedGramSchmidtOrthogonalization(KSP,int); 167 EXTERN int KSPGMRESClassicalGramSchmidtOrthogonalization(KSP,int); 168 169 EXTERN int KSPLGMRESSetAugDim(KSP,int); 170 EXTERN int KSPLGMRESSetConstant(KSP); 171 172 /*E 173 KSPGMRESCGSRefinementType - How the classical (unmodified) Gram-Schmidt is performed. 174 175 Level: advanced 176 177 .seealso: KSPGMRESClassicalGramSchmidtOrthogonalization(), KSPGMRESSetOrthogonalization(), 178 KSPGMRESSetCGSRefinementType(), KSPGMRESModifiedGramSchmidtOrthogonalization() 179 180 E*/ 181 typedef enum {KSP_GMRES_CGS_REFINE_NEVER, KSP_GMRES_CGS_REFINE_IFNEEDED, KSP_GMRES_CGS_REFINE_ALWAYS} KSPGMRESCGSRefinementType; 182 183 /*M 184 KSP_GMRES_CGS_REFINE_NEVER - Just do the classical (unmodified) Gram-Schmidt process 185 186 Level: advanced 187 188 Note: Possible unstable, but the fastest to compute 189 190 .seealso: KSPGMRESClassicalGramSchmidtOrthogonalization(), KSPGMRESSetOrthogonalization(), 191 KSPGMRESSetCGSRefinementType(), KSP_GMRES_CGS_REFINE_IFNEEDED, KSP_GMRES_CGS_REFINE_ALWAYS, 192 KSPGMRESModifiedGramSchmidtOrthogonalization() 193 M*/ 194 195 /*M 196 KSP_GMRES_CGS_REFINE_IFNEEDED - Do the classical (unmodified) Gram-Schmidt process and one step of 197 iterative refinement if an estimate of the orthogonality of the resulting vectors indicates 198 poor orthogonality. 199 200 Level: advanced 201 202 Note: This is slower than KSP_GMRES_CGS_REFINE_NEVER because it requires an extra norm computation to 203 estimate the orthogonality but is more stable. 204 205 .seealso: KSPGMRESClassicalGramSchmidtOrthogonalization(), KSPGMRESSetOrthogonalization(), 206 KSPGMRESSetCGSRefinementType(), KSP_GMRES_CGS_REFINE_NEVER, KSP_GMRES_CGS_REFINE_ALWAYS, 207 KSPGMRESModifiedGramSchmidtOrthogonalization() 208 M*/ 209 210 /*M 211 KSP_GMRES_CGS_REFINE_NEVER - Do two steps of the classical (unmodified) Gram-Schmidt process. 212 213 Level: advanced 214 215 Note: This is roughly twice the cost of KSP_GMRES_CGS_REFINE_NEVER because it performs the process twice 216 but it saves the extra norm calculation needed by KSP_GMRES_CGS_REFINE_IFNEEDED. 217 218 You should only use this if you absolutely know that the iterative refinement is needed. 219 220 .seealso: KSPGMRESClassicalGramSchmidtOrthogonalization(), KSPGMRESSetOrthogonalization(), 221 KSPGMRESSetCGSRefinementType(), KSP_GMRES_CGS_REFINE_IFNEEDED, KSP_GMRES_CGS_REFINE_ALWAYS, 222 KSPGMRESModifiedGramSchmidtOrthogonalization() 223 M*/ 224 225 EXTERN int KSPGMRESSetCGSRefinementType(KSP,KSPGMRESCGSRefinementType); 226 227 EXTERN int KSPFGMRESModifyPCNoChange(KSP,int,int,PetscReal,void*); 228 EXTERN int KSPFGMRESModifyPCKSP(KSP,int,int,PetscReal,void*); 229 EXTERN int KSPFGMRESSetModifyPC(KSP,int (*)(KSP,int,int,PetscReal,void*),void*,int(*)(void*)); 230 231 EXTERN int KSPQCGSetTrustRegionRadius(KSP,PetscReal); 232 EXTERN int KSPQCGGetQuadratic(KSP,PetscReal*); 233 EXTERN int KSPQCGGetTrialStepNorm(KSP,PetscReal*); 234 235 EXTERN int KSPSetFromOptions(KSP); 236 EXTERN int KSPAddOptionsChecker(int (*)(KSP)); 237 238 EXTERN int KSPSingularValueMonitor(KSP,int,PetscReal,void *); 239 EXTERN int KSPDefaultMonitor(KSP,int,PetscReal,void *); 240 EXTERN int KSPTrueMonitor(KSP,int,PetscReal,void *); 241 EXTERN int KSPDefaultSMonitor(KSP,int,PetscReal,void *); 242 EXTERN int KSPVecViewMonitor(KSP,int,PetscReal,void *); 243 EXTERN int KSPGMRESKrylovMonitor(KSP,int,PetscReal,void *); 244 245 EXTERN int KSPUnwindPreconditioner(KSP,Vec,Vec); 246 EXTERN int KSPDefaultBuildSolution(KSP,Vec,Vec*); 247 EXTERN int KSPDefaultBuildResidual(KSP,Vec,Vec,Vec *); 248 249 EXTERN int KSPSetOperators(KSP,Mat,Mat,MatStructure); 250 EXTERN int KSPSetOptionsPrefix(KSP,const char[]); 251 EXTERN int KSPAppendOptionsPrefix(KSP,const char[]); 252 EXTERN int KSPGetOptionsPrefix(KSP,char*[]); 253 254 EXTERN int KSPSetDiagonalScale(KSP,PetscTruth); 255 EXTERN int KSPGetDiagonalScale(KSP,PetscTruth*); 256 EXTERN int KSPSetDiagonalScaleFix(KSP,PetscTruth); 257 EXTERN int KSPGetDiagonalScaleFix(KSP,PetscTruth*); 258 259 EXTERN int KSPView(KSP,PetscViewer); 260 261 /*E 262 KSPNormType - Norm that is passed in the Krylov convergence 263 test routines. 264 265 Level: advanced 266 267 Notes: this must match finclude/petscksp.h 268 269 .seealso: KSPSolve(), KSPGetConvergedReason(), KSPSetNormType(), 270 KSPSetConvergenceTest() 271 E*/ 272 typedef enum {KSP_NO_NORM = 0, 273 KSP_PRECONDITIONED_NORM = 1, 274 KSP_UNPRECONDITIONED_NORM = 2, 275 KSP_NATURAL_NORM = 3} KSPNormType; 276 277 /*M 278 KSP_NO_NORM - Do not compute a norm during the Krylov process. This will 279 possibly save some computation but means the convergence test cannot 280 be based on a norm of a residual etc. 281 282 Level: advanced 283 284 Note: Some Krylov methods need to compute a residual norm and then this is ignored 285 286 .seealso: KSPNormType, KSPSetNormType(), KSP_PRECONDITIONED_NORM, KSP_UNPRECONDITIONED_NORM, KSP_NATURAL_NORM 287 M*/ 288 289 /*M 290 KSP_PRECONDITIONED_NORM - Compute the norm of the preconditioned residual and pass that to the 291 convergence test routine. 292 293 Level: advanced 294 295 .seealso: KSPNormType, KSPSetNormType(), KSP_NO_NORM, KSP_UNPRECONDITIONED_NORM, KSP_NATURAL_NORM, KSPSetConvergenceTest() 296 M*/ 297 298 /*M 299 KSP_UNPRECONDITIONED_NORM - Compute the norm of the true residual (b - A*x) and pass that to the 300 convergence test routine. 301 302 Level: advanced 303 304 .seealso: KSPNormType, KSPSetNormType(), KSP_NO_NORM, KSP_PRECONDITIONED_NORM, KSP_NATURAL_NORM, KSPSetConvergenceTest() 305 M*/ 306 307 /*M 308 KSP_NATURAL_NORM - Compute the 'natural norm' of residual sqrt((b - A*x)*B*(b - A*x)) and pass that to the 309 convergence test routine. 310 311 Level: advanced 312 313 .seealso: KSPNormType, KSPSetNormType(), KSP_NO_NORM, KSP_PRECONDITIONED_NORM, KSP_UNPRECONDITIONED_NORM, KSPSetConvergenceTest() 314 M*/ 315 316 EXTERN int KSPSetNormType(KSP,KSPNormType); 317 318 /*E 319 KSPConvergedReason - reason a Krylov method was said to 320 have converged or diverged 321 322 Level: beginner 323 324 Notes: this must match finclude/petscksp.h 325 326 Developer note: The string versions of these are in 327 src/ksp/ksp/interface/itfunc.c called convergedreasons. 328 If these enums are changed you much change those. 329 330 .seealso: KSPSolve(), KSPGetConvergedReason() 331 E*/ 332 typedef enum {/* converged */ 333 KSP_CONVERGED_RTOL = 2, 334 KSP_CONVERGED_ATOL = 3, 335 KSP_CONVERGED_ITS = 4, 336 KSP_CONVERGED_QCG_NEG_CURVE = 5, 337 KSP_CONVERGED_QCG_CONSTRAINED = 6, 338 KSP_CONVERGED_STEP_LENGTH = 7, 339 /* diverged */ 340 KSP_DIVERGED_ITS = -3, 341 KSP_DIVERGED_DTOL = -4, 342 KSP_DIVERGED_BREAKDOWN = -5, 343 KSP_DIVERGED_BREAKDOWN_BICG = -6, 344 KSP_DIVERGED_NONSYMMETRIC = -7, 345 KSP_DIVERGED_INDEFINITE_PC = -8, 346 347 KSP_CONVERGED_ITERATING = 0} KSPConvergedReason; 348 349 EXTERN int KSPSetConvergenceTest(KSP,int (*)(KSP,int,PetscReal,KSPConvergedReason*,void*),void *); 350 EXTERN int KSPGetConvergenceContext(KSP,void **); 351 EXTERN int KSPDefaultConverged(KSP,int,PetscReal,KSPConvergedReason*,void *); 352 EXTERN int KSPSkipConverged(KSP,int,PetscReal,KSPConvergedReason*,void *); 353 EXTERN int KSPGetConvergedReason(KSP,KSPConvergedReason *); 354 355 EXTERN int KSPComputeExplicitOperator(KSP,Mat *); 356 357 /*E 358 KSPCGType - Determines what type of CG to use 359 360 Level: beginner 361 362 .seealso: KSPCGSetType() 363 E*/ 364 typedef enum {KSP_CG_SYMMETRIC=1,KSP_CG_HERMITIAN=2} KSPCGType; 365 366 EXTERN int KSPCGSetType(KSP,KSPCGType); 367 368 EXTERN int PCPreSolve(PC,KSP); 369 EXTERN int PCPostSolve(PC,KSP); 370 371 EXTERN int KSPLGMonitorCreate(const char[],const char[],int,int,int,int,PetscDrawLG*); 372 EXTERN int KSPLGMonitor(KSP,int,PetscReal,void*); 373 EXTERN int KSPLGMonitorDestroy(PetscDrawLG); 374 EXTERN int KSPLGTrueMonitorCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscDrawLG*); 375 EXTERN int KSPLGTrueMonitor(KSP,int,PetscReal,void*); 376 EXTERN int KSPLGTrueMonitorDestroy(PetscDrawLG); 377 378 PETSC_EXTERN_CXX_END 379 #endif 380