1 /* $Id: ksp.h,v 1.40 1996/04/09 23:15:10 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} KSPType; 19 20 extern int KSPCreate(MPI_Comm,KSP *); 21 extern int KSPSetType(KSP,KSPType); 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(KSPType,char *,int (*)(KSP)); 29 30 extern int KSPGetType(KSP, KSPType *,char **); 31 extern int KSPSetPreconditionerSide(KSP,PCSide); 32 extern int KSPGetPreconditionerSide(KSP,PCSide*); 33 extern int KSPGetTolerances(KSP,double*,double*,double*,int*); 34 extern int KSPSetTolerances(KSP,double,double,double,int); 35 extern int KSPSetCalculateResidual(KSP,PetscTruth); 36 extern int KSPSetUsePreconditionedResidual(KSP); 37 extern int KSPSetInitialGuessNonzero(KSP); 38 extern int KSPSetCalculateSingularValues(KSP); 39 extern int KSPSetRhs(KSP,Vec); 40 extern int KSPGetRhs(KSP,Vec *); 41 extern int KSPSetSolution(KSP,Vec); 42 extern int KSPGetSolution(KSP,Vec *); 43 44 extern int KSPSetPC(KSP,PC); 45 extern int KSPGetPC(KSP,PC*); 46 47 extern int KSPSetMonitor(KSP,int (*)(KSP,int,double, void*), void *); 48 extern int KSPGetMonitorContext(KSP,void **); 49 extern int KSPSetResidualHistory(KSP, double *,int); 50 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 KSPComputeExtremeSingularValues(KSP, Scalar*,Scalar*); 60 61 extern int KSPGMRESSetRestart(KSP, int); 62 extern int KSPGMRESSetPreAllocateVectors(KSP); 63 extern int KSPGMRESSetOrthogonalization(KSP,int (*)(KSP,int)); 64 extern int KSPGMRESUnmodifiedGramSchmidtOrthogonalization(KSP,int); 65 extern int KSPGMRESModifiedGramSchmidtOrthogonalization(KSP,int); 66 extern int KSPGMRESIROrthogonalization(KSP,int); 67 68 extern int KSPSetFromOptions(KSP); 69 70 extern int KSPSingularValueMonitor(KSP,int,double, void * ); 71 extern int KSPCGDefaultConverged(KSP,int,double, void *); 72 extern int KSPDefaultMonitor(KSP,int,double, void *); 73 extern int KSPTrueMonitor(KSP,int,double, void *); 74 extern int KSPDefaultSMonitor(KSP,int,double, void *); 75 extern int KSPDefaultConverged(KSP,int,double, void *); 76 77 extern int KSPResidual(KSP,Vec,Vec,Vec,Vec,Vec,Vec); 78 extern int KSPUnwindPreconditioner(KSP,Vec,Vec); 79 extern int KSPDefaultBuildSolution(KSP,Vec,Vec*); 80 extern int KSPDefaultBuildResidual(KSP,Vec,Vec,Vec *); 81 82 extern int KSPPrintHelp(KSP); 83 84 extern int KSPSetOptionsPrefix(KSP,char*); 85 extern int KSPAppendOptionsPrefix(KSP,char*); 86 extern int KSPGetOptionsPrefix(KSP,char**); 87 88 extern int KSPView(KSP,Viewer); 89 90 typedef enum {CG_SYMMETRIC=1, CG_HERMITIAN=2} CGType; 91 extern int KSPCGSetType(KSP,CGType); 92 93 #if defined(__DRAW_PACKAGE) 94 extern int KSPLGMonitorCreate(char*,char*,int,int,int,int,DrawLG*); 95 extern int KSPLGMonitor(KSP,int,double,void*); 96 extern int KSPLGMonitorDestroy(DrawLG); 97 extern int KSPLGTrueMonitorCreate(char*,char*,int,int,int,int,DrawLG*); 98 extern int KSPLGTrueMonitor(KSP,int,double,void*); 99 extern int KSPLGTrueMonitorDestroy(DrawLG); 100 #endif 101 102 #endif 103 104 105