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 /*S 11 KSP - Abstract PETSc object that manages all Krylov methods 12 13 Level: beginner 14 15 Concepts: Krylov methods 16 17 .seealso: KSPCreate(), KSPSetType(), KSPType, SNES, TS, PC, SLES 18 S*/ 19 typedef struct _p_KSP* KSP; 20 21 /*E 22 KSPType - String with the name of a PETSc Krylov method or the creation function 23 with an optional dynamic library name, for example 24 http://www.mcs.anl.gov/petsc/lib.a:mykspcreate() 25 26 Level: beginner 27 28 .seealso: KSPSetType(), KSP 29 E*/ 30 #define KSPRICHARDSON "richardson" 31 #define KSPCHEBYCHEV "chebychev" 32 #define KSPCG "cg" 33 #define KSPGMRES "gmres" 34 #define KSPTCQMR "tcqmr" 35 #define KSPBCGS "bcgs" 36 #define KSPCGS "cgs" 37 #define KSPTFQMR "tfqmr" 38 #define KSPCR "cr" 39 #define KSPLSQR "lsqr" 40 #define KSPPREONLY "preonly" 41 #define KSPQCG "qcg" 42 #define KSPBICG "bicg" 43 #define KSPFGMRES "fgmres" 44 #define KSPMINRES "minres" 45 #define KSPSYMMLQ "symmlq" 46 #define KSPLGMRES "lgmres" 47 typedef char * KSPType; 48 49 /* Logging support */ 50 extern int KSP_COOKIE; 51 extern int KSP_GMRESOrthogonalization; 52 53 EXTERN int KSPCreate(MPI_Comm,KSP *); 54 EXTERN int KSPSetType(KSP,KSPType); 55 EXTERN int KSPSetUp(KSP); 56 EXTERN int KSPSolve(KSP,int *); 57 EXTERN int KSPSolveTranspose(KSP,int *); 58 EXTERN int KSPDestroy(KSP); 59 60 extern PetscFList KSPList; 61 EXTERN int KSPRegisterAll(const char[]); 62 EXTERN int KSPRegisterDestroy(void); 63 64 EXTERN int KSPRegister(const char[],const char[],const char[],int(*)(KSP)); 65 66 /*MC 67 KSPRegisterDynamic - Adds a method to the Krylov subspace solver package. 68 69 Synopsis: 70 int KSPRegisterDynamic(char *name_solver,char *path,char *name_create,int (*routine_create)(KSP)) 71 72 Not Collective 73 74 Input Parameters: 75 + name_solver - name of a new user-defined solver 76 . path - path (either absolute or relative) the library containing this solver 77 . name_create - name of routine to create method context 78 - routine_create - routine to create method context 79 80 Notes: 81 KSPRegisterDynamic() may be called multiple times to add several user-defined solvers. 82 83 If dynamic libraries are used, then the fourth input argument (routine_create) 84 is ignored. 85 86 Sample usage: 87 .vb 88 KSPRegisterDynamic("my_solver",/home/username/my_lib/lib/libO/solaris/mylib.a, 89 "MySolverCreate",MySolverCreate); 90 .ve 91 92 Then, your solver can be chosen with the procedural interface via 93 $ KSPSetType(ksp,"my_solver") 94 or at runtime via the option 95 $ -ksp_type my_solver 96 97 Level: advanced 98 99 Notes: Environmental variables such as ${PETSC_ARCH}, ${PETSC_DIR}, ${PETSC_LIB_DIR}, ${BOPT}, 100 and others of the form ${any_environmental_variable} occuring in pathname will be 101 replaced with appropriate values. 102 If your function is not being put into a shared library then use KSPRegister() instead 103 104 .keywords: KSP, register 105 106 .seealso: KSPRegisterAll(), KSPRegisterDestroy() 107 108 M*/ 109 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 110 #define KSPRegisterDynamic(a,b,c,d) KSPRegister(a,b,c,0) 111 #else 112 #define KSPRegisterDynamic(a,b,c,d) KSPRegister(a,b,c,d) 113 #endif 114 115 EXTERN int KSPGetType(KSP,KSPType *); 116 EXTERN int KSPSetPreconditionerSide(KSP,PCSide); 117 EXTERN int KSPGetPreconditionerSide(KSP,PCSide*); 118 EXTERN int KSPGetTolerances(KSP,PetscReal*,PetscReal*,PetscReal*,int*); 119 EXTERN int KSPSetTolerances(KSP,PetscReal,PetscReal,PetscReal,int); 120 EXTERN int KSPSetInitialGuessNonzero(KSP,PetscTruth); 121 EXTERN int KSPGetInitialGuessNonzero(KSP,PetscTruth *); 122 EXTERN int KSPSetInitialGuessKnoll(KSP,PetscTruth); 123 EXTERN int KSPGetInitialGuessKnoll(KSP,PetscTruth*); 124 EXTERN int KSPSetComputeEigenvalues(KSP,PetscTruth); 125 EXTERN int KSPSetComputeSingularValues(KSP,PetscTruth); 126 EXTERN int KSPSetRhs(KSP,Vec); 127 EXTERN int KSPGetRhs(KSP,Vec *); 128 EXTERN int KSPSetSolution(KSP,Vec); 129 EXTERN int KSPGetSolution(KSP,Vec *); 130 EXTERN int KSPGetResidualNorm(KSP,PetscReal*); 131 EXTERN int KSPGetIterationNumber(KSP,int*); 132 133 EXTERN int KSPSetPC(KSP,PC); 134 EXTERN int KSPGetPC(KSP,PC*); 135 136 EXTERN int KSPSetMonitor(KSP,int (*)(KSP,int,PetscReal,void*),void *,int (*)(void*)); 137 EXTERN int KSPClearMonitor(KSP); 138 EXTERN int KSPGetMonitorContext(KSP,void **); 139 EXTERN int KSPGetResidualHistory(KSP,PetscReal*[],int *); 140 EXTERN int KSPSetResidualHistory(KSP,PetscReal[],int,PetscTruth); 141 142 143 EXTERN int KSPBuildSolution(KSP,Vec,Vec *); 144 EXTERN int KSPBuildResidual(KSP,Vec,Vec,Vec *); 145 146 EXTERN int KSPRichardsonSetScale(KSP,PetscReal); 147 EXTERN int KSPChebychevSetEigenvalues(KSP,PetscReal,PetscReal); 148 EXTERN int KSPComputeExtremeSingularValues(KSP,PetscReal*,PetscReal*); 149 EXTERN int KSPComputeEigenvalues(KSP,int,PetscReal*,PetscReal*,int *); 150 EXTERN int KSPComputeEigenvaluesExplicitly(KSP,int,PetscReal*,PetscReal*); 151 152 #define KSPGMRESSetRestart(ksp,r) PetscTryMethod((ksp),KSPGMRESSetRestart_C,(KSP,int),((ksp),(r))) 153 #define KSPGMRESSetHapTol(ksp,tol) PetscTryMethod((ksp),KSPGMRESSetHapTol_C,(KSP,PetscReal),((ksp),(tol))) 154 155 EXTERN int KSPGMRESSetPreAllocateVectors(KSP); 156 EXTERN int KSPGMRESSetOrthogonalization(KSP,int (*)(KSP,int)); 157 EXTERN int KSPGMRESUnmodifiedGramSchmidtOrthogonalization(KSP,int); 158 EXTERN int KSPGMRESModifiedGramSchmidtOrthogonalization(KSP,int); 159 EXTERN int KSPGMRESIROrthogonalization(KSP,int); 160 161 EXTERN int KSPFGMRESModifyPCNoChange(KSP,int,int,PetscReal,void*); 162 EXTERN int KSPFGMRESModifyPCSLES(KSP,int,int,PetscReal,void*); 163 EXTERN int KSPFGMRESSetModifyPC(KSP,int (*)(KSP,int,int,PetscReal,void*),void*,int(*)(void*)); 164 165 EXTERN int KSPQCGSetTrustRegionRadius(KSP,PetscReal); 166 EXTERN int KSPQCGGetQuadratic(KSP,PetscReal*); 167 EXTERN int KSPQCGGetTrialStepNorm(KSP,PetscReal*); 168 169 EXTERN int KSPSetFromOptions(KSP); 170 EXTERN int KSPAddOptionsChecker(int (*)(KSP)); 171 172 EXTERN int KSPSingularValueMonitor(KSP,int,PetscReal,void *); 173 EXTERN int KSPDefaultMonitor(KSP,int,PetscReal,void *); 174 EXTERN int KSPTrueMonitor(KSP,int,PetscReal,void *); 175 EXTERN int KSPDefaultSMonitor(KSP,int,PetscReal,void *); 176 EXTERN int KSPVecViewMonitor(KSP,int,PetscReal,void *); 177 EXTERN int KSPGMRESKrylovMonitor(KSP,int,PetscReal,void *); 178 179 EXTERN int KSPUnwindPreconditioner(KSP,Vec,Vec); 180 EXTERN int KSPDefaultBuildSolution(KSP,Vec,Vec*); 181 EXTERN int KSPDefaultBuildResidual(KSP,Vec,Vec,Vec *); 182 183 EXTERN int KSPSetOptionsPrefix(KSP,const char[]); 184 EXTERN int KSPAppendOptionsPrefix(KSP,const char[]); 185 EXTERN int KSPGetOptionsPrefix(KSP,char*[]); 186 187 EXTERN int KSPView(KSP,PetscViewer); 188 189 /*E 190 KSPNormType - Norm that is passed in the Krylov convergence 191 test routines. 192 193 Level: advanced 194 195 Notes: this must match finclude/petscksp.h 196 197 .seealso: SLESSolve(), KSPSolve(), KSPGetConvergedReason(), KSPSetNormType(), 198 KSPSetConvergenceTest() 199 E*/ 200 typedef enum {KSP_NO_NORM = 0, 201 KSP_PRECONDITIONED_NORM = 1, 202 KSP_UNPRECONDITIONED_NORM = 2, 203 KSP_NATURAL_NORM = 3} KSPNormType; 204 EXTERN int KSPSetNormType(KSP,KSPNormType); 205 206 /*E 207 KSPConvergedReason - reason a Krylov method was said to 208 have converged or diverged 209 210 Level: beginner 211 212 Notes: this must match finclude/petscksp.h 213 214 Developer note: The string versions of these are in 215 src/sles/ksp/interface/itfunc.c called convergedreasons. 216 If these enums are changed you much change those. 217 218 .seealso: SLESSolve(), KSPSolve(), KSPGetConvergedReason() 219 E*/ 220 typedef enum {/* converged */ 221 KSP_CONVERGED_RTOL = 2, 222 KSP_CONVERGED_ATOL = 3, 223 KSP_CONVERGED_ITS = 4, 224 KSP_CONVERGED_QCG_NEG_CURVE = 5, 225 KSP_CONVERGED_QCG_CONSTRAINED = 6, 226 KSP_CONVERGED_STEP_LENGTH = 7, 227 /* diverged */ 228 KSP_DIVERGED_ITS = -3, 229 KSP_DIVERGED_DTOL = -4, 230 KSP_DIVERGED_BREAKDOWN = -5, 231 KSP_DIVERGED_BREAKDOWN_BICG = -6, 232 KSP_DIVERGED_NONSYMMETRIC = -7, 233 KSP_DIVERGED_INDEFINITE_PC = -8, 234 235 KSP_CONVERGED_ITERATING = 0} KSPConvergedReason; 236 237 EXTERN int KSPSetConvergenceTest(KSP,int (*)(KSP,int,PetscReal,KSPConvergedReason*,void*),void *); 238 EXTERN int KSPGetConvergenceContext(KSP,void **); 239 EXTERN int KSPDefaultConverged(KSP,int,PetscReal,KSPConvergedReason*,void *); 240 EXTERN int KSPSkipConverged(KSP,int,PetscReal,KSPConvergedReason*,void *); 241 EXTERN int KSPGetConvergedReason(KSP,KSPConvergedReason *); 242 243 EXTERN int KSPComputeExplicitOperator(KSP,Mat *); 244 245 /*E 246 KSPCGType - Determines what type of CG to use 247 248 Level: beginner 249 250 .seealso: KSPCGSetType() 251 E*/ 252 typedef enum {KSP_CG_SYMMETRIC=1,KSP_CG_HERMITIAN=2} KSPCGType; 253 254 EXTERN int KSPCGSetType(KSP,KSPCGType); 255 256 EXTERN int PCPreSolve(PC,KSP); 257 EXTERN int PCPostSolve(PC,KSP); 258 259 EXTERN int KSPLGMonitorCreate(const char[],const char[],int,int,int,int,PetscDrawLG*); 260 EXTERN int KSPLGMonitor(KSP,int,PetscReal,void*); 261 EXTERN int KSPLGMonitorDestroy(PetscDrawLG); 262 EXTERN int KSPLGTrueMonitorCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscDrawLG*); 263 EXTERN int KSPLGTrueMonitor(KSP,int,PetscReal,void*); 264 EXTERN int KSPLGTrueMonitorDestroy(PetscDrawLG); 265 266 PETSC_EXTERN_CXX_END 267 #endif 268