1 /* $Id: ksp.h,v 1.59 1997/11/12 19:49:50 bsmith Exp bsmith $ */ 2 /* 3 Defines the interface functions for the Krylov subspace accelerators. 4 */ 5 #ifndef __KSP_PACKAGE 6 #define __KSP_PACKAGE 7 #include "petsc.h" 8 #include "vec.h" 9 #include "mat.h" 10 #include "pc.h" 11 12 #define KSP_COOKIE PETSC_COOKIE+8 13 14 typedef struct _p_KSP* KSP; 15 16 typedef enum { KSPRICHARDSON, KSPCHEBYCHEV, KSPCG, KSPGMRES, KSPTCQMR, KSPBCGS, 17 KSPCGS, KSPTFQMR, KSPCR, KSPLSQR, KSPPREONLY, KSPQCG, KSPNEW} KSPType; 18 19 extern int KSPCreate(MPI_Comm,KSP *); 20 extern int KSPSetType(KSP,KSPType); 21 extern int KSPSetUp(KSP); 22 extern int KSPSolve(KSP,int *); 23 extern int KSPDestroy(KSP); 24 25 extern int KSPRegisterAll(); 26 extern int KSPRegisterDestroy(); 27 extern int KSPRegister_Private(KSPType,char *,char *,int (*)(KSP),KSPType*); 28 #if defined(USE_DYNAMIC_LIBRARIES) 29 #define KSPRegister(a,b,c,d,e) KSPRegister_Private(a,b,c,0,e) 30 #else 31 #define KSPRegister(a,b,c,d,e) KSPRegister_Private(a,b,c,d,e) 32 #endif 33 extern int KSPRegisterAllCalled; 34 35 extern int KSPGetType(KSP, KSPType *,char **); 36 extern int KSPSetPreconditionerSide(KSP,PCSide); 37 extern int KSPGetPreconditionerSide(KSP,PCSide*); 38 extern int KSPGetTolerances(KSP,double*,double*,double*,int*); 39 extern int KSPSetTolerances(KSP,double,double,double,int); 40 extern int KSPSetComputeResidual(KSP,PetscTruth); 41 extern int KSPSetUsePreconditionedResidual(KSP); 42 extern int KSPSetInitialGuessNonzero(KSP); 43 extern int KSPSetComputeEigenvalues(KSP); 44 extern int KSPSetComputeSingularValues(KSP); 45 extern int KSPSetRhs(KSP,Vec); 46 extern int KSPGetRhs(KSP,Vec *); 47 extern int KSPSetSolution(KSP,Vec); 48 extern int KSPGetSolution(KSP,Vec *); 49 extern int KSPGetResidualNorm(KSP,double*); 50 51 extern int KSPSetPC(KSP,PC); 52 extern int KSPGetPC(KSP,PC*); 53 54 extern int KSPSetMonitor(KSP,int (*)(KSP,int,double, void*), void *); 55 extern int KSPGetMonitorContext(KSP,void **); 56 extern int KSPSetResidualHistory(KSP, double *,int); 57 58 extern int KSPSetConvergenceTest(KSP,int (*)(KSP,int,double, void*), void *); 59 extern int KSPGetConvergenceContext(KSP,void **); 60 61 extern int KSPBuildSolution(KSP, Vec,Vec *); 62 extern int KSPBuildResidual(KSP, Vec, Vec,Vec *); 63 64 extern int KSPRichardsonSetScale(KSP , double); 65 extern int KSPChebychevSetEigenvalues(KSP , double, double); 66 extern int KSPComputeExtremeSingularValues(KSP, double*,double*); 67 extern int KSPComputeEigenvalues(KSP,int,double*,double*); 68 extern int KSPComputeEigenvaluesExplicitly(KSP,int,double*,double*); 69 70 extern int KSPGMRESSetRestart(KSP, int); 71 extern int KSPGMRESSetPreAllocateVectors(KSP); 72 extern int KSPGMRESSetOrthogonalization(KSP,int (*)(KSP,int)); 73 extern int KSPGMRESUnmodifiedGramSchmidtOrthogonalization(KSP,int); 74 extern int KSPGMRESModifiedGramSchmidtOrthogonalization(KSP,int); 75 extern int KSPGMRESIROrthogonalization(KSP,int); 76 extern int KSPGMRESDGKSOrthogonalization(KSP,int); 77 78 extern int KSPSetFromOptions(KSP); 79 extern int KSPAddOptionsChecker(int (*)(KSP)); 80 81 extern int KSPSingularValueMonitor(KSP,int,double, void * ); 82 extern int KSPDefaultMonitor(KSP,int,double, void *); 83 extern int KSPTrueMonitor(KSP,int,double, void *); 84 extern int KSPDefaultSMonitor(KSP,int,double, void *); 85 86 extern int KSPDefaultConverged(KSP,int,double, void *); 87 88 extern int KSPResidual(KSP,Vec,Vec,Vec,Vec,Vec,Vec); 89 extern int KSPUnwindPreconditioner(KSP,Vec,Vec); 90 extern int KSPDefaultBuildSolution(KSP,Vec,Vec*); 91 extern int KSPDefaultBuildResidual(KSP,Vec,Vec,Vec *); 92 93 extern int KSPPrintHelp(KSP); 94 95 extern int KSPSetOptionsPrefix(KSP,char*); 96 extern int KSPAppendOptionsPrefix(KSP,char*); 97 extern int KSPGetOptionsPrefix(KSP,char**); 98 99 extern int KSPView(KSP,Viewer); 100 101 extern int KSPComputeExplicitOperator(KSP,Mat *); 102 103 typedef enum {KSP_CG_SYMMETRIC=1, KSP_CG_HERMITIAN=2} KSPCGType; 104 extern int KSPCGSetType(KSP,KSPCGType); 105 106 extern int PCPreSolve(PC,KSP); 107 extern int PCPostSolve(PC,KSP); 108 109 extern int KSPLGMonitorCreate(char*,char*,int,int,int,int,DrawLG*); 110 extern int KSPLGMonitor(KSP,int,double,void*); 111 extern int KSPLGMonitorDestroy(DrawLG); 112 extern int KSPLGTrueMonitorCreate(MPI_Comm,char*,char*,int,int,int,int,DrawLG*); 113 extern int KSPLGTrueMonitor(KSP,int,double,void*); 114 extern int KSPLGTrueMonitorDestroy(DrawLG); 115 116 #endif 117 118 119