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 enum {KSP_GMRESOrthogonalization, KSP_MAX_EVENTS}; 50 extern int KSPEvents[KSP_MAX_EVENTS]; 51 #define KSPLogEventBegin(e,o1,o2,o3,o4) PetscLogEventBegin(KSPEvents[e],o1,o2,o3,o4) 52 #define KSPLogEventEnd(e,o1,o2,o3,o4) PetscLogEventEnd(KSPEvents[e],o1,o2,o3,o4) 53 54 EXTERN int KSPCreate(MPI_Comm,KSP *); 55 EXTERN int KSPSetType(KSP,KSPType); 56 EXTERN int KSPSetUp(KSP); 57 EXTERN int KSPSolve(KSP,int *); 58 EXTERN int KSPSolveTranspose(KSP,int *); 59 EXTERN int KSPDestroy(KSP); 60 61 extern PetscFList KSPList; 62 EXTERN int KSPRegisterAll(char *); 63 EXTERN int KSPRegisterDestroy(void); 64 65 EXTERN int KSPRegister(char*,char*,char*,int(*)(KSP)); 66 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 67 #define KSPRegisterDynamic(a,b,c,d) KSPRegister(a,b,c,0) 68 #else 69 #define KSPRegisterDynamic(a,b,c,d) KSPRegister(a,b,c,d) 70 #endif 71 72 EXTERN int KSPGetType(KSP,KSPType *); 73 EXTERN int KSPSetPreconditionerSide(KSP,PCSide); 74 EXTERN int KSPGetPreconditionerSide(KSP,PCSide*); 75 EXTERN int KSPGetTolerances(KSP,PetscReal*,PetscReal*,PetscReal*,int*); 76 EXTERN int KSPSetTolerances(KSP,PetscReal,PetscReal,PetscReal,int); 77 EXTERN int KSPSetComputeResidual(KSP,PetscTruth); 78 EXTERN int KSPSetUsePreconditionedResidual(KSP,PetscTruth); 79 EXTERN int KSPSetInitialGuessNonzero(KSP,PetscTruth); 80 EXTERN int KSPGetInitialGuessNonzero(KSP,PetscTruth *); 81 EXTERN int KSPSetComputeEigenvalues(KSP,PetscTruth); 82 EXTERN int KSPSetComputeSingularValues(KSP,PetscTruth); 83 EXTERN int KSPSetRhs(KSP,Vec); 84 EXTERN int KSPGetRhs(KSP,Vec *); 85 EXTERN int KSPSetSolution(KSP,Vec); 86 EXTERN int KSPGetSolution(KSP,Vec *); 87 EXTERN int KSPGetResidualNorm(KSP,PetscReal*); 88 EXTERN int KSPGetIterationNumber(KSP,int*); 89 90 EXTERN int KSPSetPC(KSP,PC); 91 EXTERN int KSPGetPC(KSP,PC*); 92 93 EXTERN int KSPSetAvoidNorms(KSP,PetscTruth); 94 95 EXTERN int KSPSetMonitor(KSP,int (*)(KSP,int,PetscReal,void*),void *,int (*)(void*)); 96 EXTERN int KSPClearMonitor(KSP); 97 EXTERN int KSPGetMonitorContext(KSP,void **); 98 EXTERN int KSPGetResidualHistory(KSP,PetscReal **,int *); 99 EXTERN int KSPSetResidualHistory(KSP,PetscReal *,int,PetscTruth); 100 101 102 EXTERN int KSPBuildSolution(KSP,Vec,Vec *); 103 EXTERN int KSPBuildResidual(KSP,Vec,Vec,Vec *); 104 105 EXTERN int KSPRichardsonSetScale(KSP,PetscReal); 106 EXTERN int KSPChebychevSetEigenvalues(KSP,PetscReal,PetscReal); 107 EXTERN int KSPComputeExtremeSingularValues(KSP,PetscReal*,PetscReal*); 108 EXTERN int KSPComputeEigenvalues(KSP,int,PetscReal*,PetscReal*,int *); 109 EXTERN int KSPComputeEigenvaluesExplicitly(KSP,int,PetscReal*,PetscReal*); 110 111 EXTERN int KSPGMRESSetRestart(KSP,int); 112 EXTERN int KSPGMRESSetHapTol(KSP,PetscReal); 113 EXTERN int KSPGMRESSetPreAllocateVectors(KSP); 114 EXTERN int KSPGMRESSetOrthogonalization(KSP,int (*)(KSP,int)); 115 EXTERN int KSPGMRESUnmodifiedGramSchmidtOrthogonalization(KSP,int); 116 EXTERN int KSPGMRESModifiedGramSchmidtOrthogonalization(KSP,int); 117 EXTERN int KSPGMRESIROrthogonalization(KSP,int); 118 119 EXTERN int KSPFGMRESModifyPCNoChange(KSP,int,int,PetscReal,void*); 120 EXTERN int KSPFGMRESModifyPCSLES(KSP,int,int,PetscReal,void*); 121 EXTERN int KSPFGMRESSetModifyPC(KSP,int (*)(KSP,int,int,PetscReal,void*),void*,int(*)(void*)); 122 123 EXTERN int KSPQCGSetTrustRegionRadius(KSP,PetscReal); 124 EXTERN int KSPQCGGetQuadratic(KSP,PetscReal*); 125 EXTERN int KSPQCGGetTrialStepNorm(KSP,PetscReal*); 126 127 EXTERN int KSPSetFromOptions(KSP); 128 EXTERN int KSPAddOptionsChecker(int (*)(KSP)); 129 130 EXTERN int KSPSingularValueMonitor(KSP,int,PetscReal,void *); 131 EXTERN int KSPDefaultMonitor(KSP,int,PetscReal,void *); 132 EXTERN int KSPTrueMonitor(KSP,int,PetscReal,void *); 133 EXTERN int KSPDefaultSMonitor(KSP,int,PetscReal,void *); 134 EXTERN int KSPVecViewMonitor(KSP,int,PetscReal,void *); 135 EXTERN int KSPGMRESKrylovMonitor(KSP,int,PetscReal,void *); 136 137 EXTERN int KSPUnwindPreconditioner(KSP,Vec,Vec); 138 EXTERN int KSPDefaultBuildSolution(KSP,Vec,Vec*); 139 EXTERN int KSPDefaultBuildResidual(KSP,Vec,Vec,Vec *); 140 141 EXTERN int KSPSetOptionsPrefix(KSP,char*); 142 EXTERN int KSPAppendOptionsPrefix(KSP,char*); 143 EXTERN int KSPGetOptionsPrefix(KSP,char**); 144 145 EXTERN int KSPView(KSP,PetscViewer); 146 147 /*E 148 KSPConvergedReason - reason a Krylov method was said to 149 have converged or diverged 150 151 Level: beginner 152 153 Notes: this must match finclude/petscksp.h 154 155 .seealso: SLESSolve(), KSPSolve(), KSPGetConvergedReason() 156 E*/ 157 typedef enum {/* converged */ 158 KSP_CONVERGED_RTOL = 2, 159 KSP_CONVERGED_ATOL = 3, 160 KSP_CONVERGED_ITS = 4, 161 KSP_CONVERGED_QCG_NEG_CURVE = 5, 162 KSP_CONVERGED_QCG_CONSTRAINED = 6, 163 KSP_CONVERGED_STEP_LENGTH = 7, 164 /* diverged */ 165 KSP_DIVERGED_ITS = -3, 166 KSP_DIVERGED_DTOL = -4, 167 KSP_DIVERGED_BREAKDOWN = -5, 168 KSP_DIVERGED_BREAKDOWN_BICG = -6, 169 KSP_DIVERGED_NONSYMMETRIC = -7, 170 KSP_DIVERGED_INDEFINITE_PC = -8, 171 172 KSP_CONVERGED_ITERATING = 0} KSPConvergedReason; 173 174 EXTERN int KSPSetConvergenceTest(KSP,int (*)(KSP,int,PetscReal,KSPConvergedReason*,void*),void *); 175 EXTERN int KSPGetConvergenceContext(KSP,void **); 176 EXTERN int KSPDefaultConverged(KSP,int,PetscReal,KSPConvergedReason*,void *); 177 EXTERN int KSPSkipConverged(KSP,int,PetscReal,KSPConvergedReason*,void *); 178 EXTERN int KSPGetConvergedReason(KSP,KSPConvergedReason *); 179 180 EXTERN int KSPComputeExplicitOperator(KSP,Mat *); 181 182 /*E 183 KSPCGType - Determines what type of CG to use 184 185 Level: beginner 186 187 .seealso: KSPCGSetType() 188 E*/ 189 typedef enum {KSP_CG_SYMMETRIC=1,KSP_CG_HERMITIAN=2} KSPCGType; 190 191 EXTERN int KSPCGSetType(KSP,KSPCGType); 192 193 EXTERN int PCPreSolve(PC,KSP); 194 EXTERN int PCPostSolve(PC,KSP); 195 196 EXTERN int KSPLGMonitorCreate(char*,char*,int,int,int,int,PetscDrawLG*); 197 EXTERN int KSPLGMonitor(KSP,int,PetscReal,void*); 198 EXTERN int KSPLGMonitorDestroy(PetscDrawLG); 199 EXTERN int KSPLGTrueMonitorCreate(MPI_Comm,char*,char*,int,int,int,int,PetscDrawLG*); 200 EXTERN int KSPLGTrueMonitor(KSP,int,PetscReal,void*); 201 EXTERN int KSPLGTrueMonitorDestroy(PetscDrawLG); 202 203 #endif 204 205 206