1 /* $Id: ksp.h,v 1.29 1995/11/19 00:52: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 _KSP* KSP; 15 16 /* Possible Krylov Space Methods */ 17 typedef enum { KSPRICHARDSON, KSPCHEBYCHEV, KSPCG, KSPGMRES, KSPTCQMR, KSPBCGS, 18 KSPCGS, KSPTFQMR, KSPCR, KSPLSQR, KSPPREONLY, KSPQCG} KSPMethod; 19 20 extern int KSPCreate(MPI_Comm,KSP *); 21 extern int KSPSetMethod(KSP,KSPMethod); 22 extern int KSPSetUp(KSP); 23 extern int KSPSolve(KSP,int *); 24 extern int KSPDestroy(KSP); 25 26 extern int KSPRegisterAll(); 27 extern int KSPRegisterDestroy(); 28 extern int KSPRegister(KSPMethod,char *,int (*)(KSP)); 29 30 extern int KSPGetMethodName(KSPMethod,char **); 31 extern int KSPSetRightPreconditioner(KSP); 32 extern int KSPGetPreconditionerSide(KSP,int *); 33 extern int KSPGetMethodFromContext(KSP,KSPMethod *); 34 extern int KSPGetTolerances(KSP,double*,double*,double*,int*); 35 extern int KSPSetTolerances(KSP,double,double,double,int); 36 extern int KSPSetCalculateResidual(KSP,PetscTruth); 37 extern int KSPSetUsePreconditionedResidual(KSP); 38 extern int KSPSetInitialGuessNonzero(KSP); 39 extern int KSPSetCalculateEigenvalues(KSP); 40 extern int KSPSetRhs(KSP,Vec); 41 extern int KSPGetRhs(KSP,Vec *); 42 extern int KSPSetSolution(KSP,Vec); 43 extern int KSPGetSolution(KSP,Vec *); 44 45 extern int KSPSetBinv(KSP,PC); 46 extern int KSPGetBinv(KSP,PC*); 47 48 extern int KSPSetMonitor(KSP,int (*)(KSP,int,double, void*), void *); 49 extern int KSPGetMonitorContext(KSP,void **); 50 extern int KSPSetResidualHistory(KSP, double *,int); 51 extern int KSPSetConvergenceTest(KSP,int (*)(KSP,int,double, void*), void *); 52 extern int KSPGetConvergenceContext(KSP,void **); 53 54 extern int KSPBuildSolution(KSP, Vec,Vec *); 55 extern int KSPBuildResidual(KSP, Vec, Vec,Vec *); 56 57 extern int KSPRichardsonSetScale(KSP , double); 58 extern int KSPChebychevSetEigenvalues(KSP , double, double); 59 extern int KSPCGGetEigenvalues(KSP, int n,Scalar*,Scalar*); 60 extern int KSPGMRESSetRestart(KSP, int); 61 extern int KSPGMRESSetPreAllocateVectors(KSP); 62 63 extern int KSPGMRESSetOrthogRoutine(KSP,int (*)(KSP,int)); 64 extern int KSPGMRESUnmodifiedOrthog(KSP,int); 65 extern int KSPGMRESBasicOrthog(KSP,int); 66 extern int KSPGMRESIROrthog(KSP,int); 67 68 extern int KSPSetFromOptions(KSP); 69 70 extern int KSPCGDefaultMonitor(KSP,int,double, void * ); 71 extern int KSPCGDefaultConverged(KSP,int,double, void *); 72 extern int KSPDefaultMonitor(KSP,int,double, void *); 73 extern int KSPDefaultSMonitor(KSP,int,double, void *); 74 extern int KSPDefaultConverged(KSP,int,double, void *); 75 76 extern int KSPResidual(KSP,Vec,Vec,Vec,Vec,Vec,Vec); 77 extern int KSPUnwindPre(KSP,Vec,Vec); 78 extern int KSPDefaultBuildSolution(KSP,Vec,Vec*); 79 extern int KSPDefaultBuildResidual(KSP,Vec,Vec,Vec *); 80 81 extern int KSPPrintHelp(KSP); 82 83 extern int KSPSetOptionsPrefix(KSP,char*); 84 85 extern int KSPView(KSP,Viewer); 86 87 #if defined(__DRAW_PACKAGE) 88 extern int KSPLGMonitorCreate(char*,char*,int,int,int,int,DrawLG*); 89 extern int KSPLGMonitor(KSP,int,double,void*); 90 extern int KSPLGMonitorDestroy(DrawLG); 91 #endif 92 93 #endif 94 95 96