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 9 /*S 10 KSP - Abstract PETSc object that manages all Krylov methods 11 12 Level: beginner 13 14 Concepts: Krylov methods 15 16 .seealso: KSPCreate(), KSPSetType(), KSPType, SNES, TS, PC, SLES 17 S*/ 18 typedef struct _p_KSP* KSP; 19 20 /*E 21 KSPType - String with the name of a PETSc Krylov method or the creation function 22 with an optional dynamic library name, for example 23 http://www.mcs.anl.gov/petsc/lib.a:mykspcreate() 24 25 Level: beginner 26 27 .seealso: KSPSetType(), KSP 28 E*/ 29 #define KSPRICHARDSON "richardson" 30 #define KSPCHEBYCHEV "chebychev" 31 #define KSPCG "cg" 32 #define KSPGMRES "gmres" 33 #define KSPTCQMR "tcqmr" 34 #define KSPBCGS "bcgs" 35 #define KSPCGS "cgs" 36 #define KSPTFQMR "tfqmr" 37 #define KSPCR "cr" 38 #define KSPLSQR "lsqr" 39 #define KSPPREONLY "preonly" 40 #define KSPQCG "qcg" 41 #define KSPBICG "bicg" 42 #define KSPFGMRES "fgmres" 43 #define KSPMINRES "minres" 44 #define KSPSYMMLQ "symmlq" 45 typedef char * KSPType; 46 47 /* Logging support */ 48 extern int KSP_COOKIE; 49 extern int KSP_GMRESOrthogonalization; 50 51 EXTERN int KSPCreate(MPI_Comm,KSP *); 52 EXTERN int KSPSetType(KSP,KSPType); 53 EXTERN int KSPSetUp(KSP); 54 EXTERN int KSPSolve(KSP,int *); 55 EXTERN int KSPSolveTranspose(KSP,int *); 56 EXTERN int KSPDestroy(KSP); 57 58 extern PetscFList KSPList; 59 EXTERN int KSPRegisterAll(char *); 60 EXTERN int KSPRegisterDestroy(void); 61 62 EXTERN int KSPRegister(char*,char*,char*,int(*)(KSP)); 63 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 64 #define KSPRegisterDynamic(a,b,c,d) KSPRegister(a,b,c,0) 65 #else 66 #define KSPRegisterDynamic(a,b,c,d) KSPRegister(a,b,c,d) 67 #endif 68 69 EXTERN int KSPGetType(KSP,KSPType *); 70 EXTERN int KSPSetPreconditionerSide(KSP,PCSide); 71 EXTERN int KSPGetPreconditionerSide(KSP,PCSide*); 72 EXTERN int KSPGetTolerances(KSP,PetscReal*,PetscReal*,PetscReal*,int*); 73 EXTERN int KSPSetTolerances(KSP,PetscReal,PetscReal,PetscReal,int); 74 EXTERN int KSPSetComputeResidual(KSP,PetscTruth); 75 EXTERN int KSPSetUsePreconditionedResidual(KSP,PetscTruth); 76 EXTERN int KSPSetInitialGuessNonzero(KSP,PetscTruth); 77 EXTERN int KSPGetInitialGuessNonzero(KSP,PetscTruth *); 78 EXTERN int KSPSetComputeEigenvalues(KSP,PetscTruth); 79 EXTERN int KSPSetComputeSingularValues(KSP,PetscTruth); 80 EXTERN int KSPSetRhs(KSP,Vec); 81 EXTERN int KSPGetRhs(KSP,Vec *); 82 EXTERN int KSPSetSolution(KSP,Vec); 83 EXTERN int KSPGetSolution(KSP,Vec *); 84 EXTERN int KSPGetResidualNorm(KSP,PetscReal*); 85 EXTERN int KSPGetIterationNumber(KSP,int*); 86 87 EXTERN int KSPSetPC(KSP,PC); 88 EXTERN int KSPGetPC(KSP,PC*); 89 90 EXTERN int KSPSetAvoidNorms(KSP,PetscTruth); 91 92 EXTERN int KSPSetMonitor(KSP,int (*)(KSP,int,PetscReal,void*),void *,int (*)(void*)); 93 EXTERN int KSPClearMonitor(KSP); 94 EXTERN int KSPGetMonitorContext(KSP,void **); 95 EXTERN int KSPGetResidualHistory(KSP,PetscReal **,int *); 96 EXTERN int KSPSetResidualHistory(KSP,PetscReal *,int,PetscTruth); 97 98 99 EXTERN int KSPBuildSolution(KSP,Vec,Vec *); 100 EXTERN int KSPBuildResidual(KSP,Vec,Vec,Vec *); 101 102 EXTERN int KSPRichardsonSetScale(KSP,PetscReal); 103 EXTERN int KSPChebychevSetEigenvalues(KSP,PetscReal,PetscReal); 104 EXTERN int KSPComputeExtremeSingularValues(KSP,PetscReal*,PetscReal*); 105 EXTERN int KSPComputeEigenvalues(KSP,int,PetscReal*,PetscReal*,int *); 106 EXTERN int KSPComputeEigenvaluesExplicitly(KSP,int,PetscReal*,PetscReal*); 107 108 #define KSPGMRESSetRestart(ksp,r) PetscTryMethod((ksp),KSPGMRESSetRestart_C,(KSP,int),((ksp),(r))) 109 #define KSPGMRESSetHapTol(ksp,tol) PetscTryMethod((ksp),KSPGMRESSetHapTol_C,(KSP,PetscReal),((ksp),(tol))) 110 111 EXTERN int KSPGMRESSetPreAllocateVectors(KSP); 112 EXTERN int KSPGMRESSetOrthogonalization(KSP,int (*)(KSP,int)); 113 EXTERN int KSPGMRESUnmodifiedGramSchmidtOrthogonalization(KSP,int); 114 EXTERN int KSPGMRESModifiedGramSchmidtOrthogonalization(KSP,int); 115 EXTERN int KSPGMRESIROrthogonalization(KSP,int); 116 117 EXTERN int KSPFGMRESModifyPCNoChange(KSP,int,int,PetscReal,void*); 118 EXTERN int KSPFGMRESModifyPCSLES(KSP,int,int,PetscReal,void*); 119 EXTERN int KSPFGMRESSetModifyPC(KSP,int (*)(KSP,int,int,PetscReal,void*),void*,int(*)(void*)); 120 121 EXTERN int KSPQCGSetTrustRegionRadius(KSP,PetscReal); 122 EXTERN int KSPQCGGetQuadratic(KSP,PetscReal*); 123 EXTERN int KSPQCGGetTrialStepNorm(KSP,PetscReal*); 124 125 EXTERN int KSPSetFromOptions(KSP); 126 EXTERN int KSPAddOptionsChecker(int (*)(KSP)); 127 128 EXTERN int KSPSingularValueMonitor(KSP,int,PetscReal,void *); 129 EXTERN int KSPDefaultMonitor(KSP,int,PetscReal,void *); 130 EXTERN int KSPTrueMonitor(KSP,int,PetscReal,void *); 131 EXTERN int KSPDefaultSMonitor(KSP,int,PetscReal,void *); 132 EXTERN int KSPVecViewMonitor(KSP,int,PetscReal,void *); 133 EXTERN int KSPGMRESKrylovMonitor(KSP,int,PetscReal,void *); 134 135 EXTERN int KSPUnwindPreconditioner(KSP,Vec,Vec); 136 EXTERN int KSPDefaultBuildSolution(KSP,Vec,Vec*); 137 EXTERN int KSPDefaultBuildResidual(KSP,Vec,Vec,Vec *); 138 139 EXTERN int KSPSetOptionsPrefix(KSP,char*); 140 EXTERN int KSPAppendOptionsPrefix(KSP,char*); 141 EXTERN int KSPGetOptionsPrefix(KSP,char**); 142 143 EXTERN int KSPView(KSP,PetscViewer); 144 145 /*E 146 KSPConvergedReason - reason a Krylov method was said to 147 have converged or diverged 148 149 Level: beginner 150 151 Notes: this must match finclude/petscksp.h 152 153 .seealso: SLESSolve(), KSPSolve(), KSPGetConvergedReason() 154 E*/ 155 typedef enum {/* converged */ 156 KSP_CONVERGED_RTOL = 2, 157 KSP_CONVERGED_ATOL = 3, 158 KSP_CONVERGED_ITS = 4, 159 KSP_CONVERGED_QCG_NEG_CURVE = 5, 160 KSP_CONVERGED_QCG_CONSTRAINED = 6, 161 KSP_CONVERGED_STEP_LENGTH = 7, 162 /* diverged */ 163 KSP_DIVERGED_ITS = -3, 164 KSP_DIVERGED_DTOL = -4, 165 KSP_DIVERGED_BREAKDOWN = -5, 166 KSP_DIVERGED_BREAKDOWN_BICG = -6, 167 KSP_DIVERGED_NONSYMMETRIC = -7, 168 KSP_DIVERGED_INDEFINITE_PC = -8, 169 170 KSP_CONVERGED_ITERATING = 0} KSPConvergedReason; 171 172 EXTERN int KSPSetConvergenceTest(KSP,int (*)(KSP,int,PetscReal,KSPConvergedReason*,void*),void *); 173 EXTERN int KSPGetConvergenceContext(KSP,void **); 174 EXTERN int KSPDefaultConverged(KSP,int,PetscReal,KSPConvergedReason*,void *); 175 EXTERN int KSPSkipConverged(KSP,int,PetscReal,KSPConvergedReason*,void *); 176 EXTERN int KSPGetConvergedReason(KSP,KSPConvergedReason *); 177 178 EXTERN int KSPComputeExplicitOperator(KSP,Mat *); 179 180 /*E 181 KSPCGType - Determines what type of CG to use 182 183 Level: beginner 184 185 .seealso: KSPCGSetType() 186 E*/ 187 typedef enum {KSP_CG_SYMMETRIC=1,KSP_CG_HERMITIAN=2} KSPCGType; 188 189 EXTERN int KSPCGSetType(KSP,KSPCGType); 190 191 EXTERN int PCPreSolve(PC,KSP); 192 EXTERN int PCPostSolve(PC,KSP); 193 194 EXTERN int KSPLGMonitorCreate(char*,char*,int,int,int,int,PetscDrawLG*); 195 EXTERN int KSPLGMonitor(KSP,int,PetscReal,void*); 196 EXTERN int KSPLGMonitorDestroy(PetscDrawLG); 197 EXTERN int KSPLGTrueMonitorCreate(MPI_Comm,char*,char*,int,int,int,int,PetscDrawLG*); 198 EXTERN int KSPLGTrueMonitor(KSP,int,PetscReal,void*); 199 EXTERN int KSPLGTrueMonitorDestroy(PetscDrawLG); 200 201 #endif 202 203 204