1 /* $Id: ksp.h,v 1.42 1996/07/08 22:24:30 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 typedef enum { KSPRICHARDSON, KSPCHEBYCHEV, KSPCG, KSPGMRES, KSPTCQMR, KSPBCGS, 17 KSPCGS, KSPTFQMR, KSPCR, KSPLSQR, KSPPREONLY, KSPQCG} 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(KSPType,char *,int (*)(KSP)); 28 29 extern int KSPGetType(KSP, KSPType *,char **); 30 extern int KSPSetPreconditionerSide(KSP,PCSide); 31 extern int KSPGetPreconditionerSide(KSP,PCSide*); 32 extern int KSPGetTolerances(KSP,double*,double*,double*,int*); 33 extern int KSPSetTolerances(KSP,double,double,double,int); 34 extern int KSPSetCalculateResidual(KSP,PetscTruth); 35 extern int KSPSetUsePreconditionedResidual(KSP); 36 extern int KSPSetInitialGuessNonzero(KSP); 37 extern int KSPSetCalculateSingularValues(KSP); 38 extern int KSPSetRhs(KSP,Vec); 39 extern int KSPGetRhs(KSP,Vec *); 40 extern int KSPSetSolution(KSP,Vec); 41 extern int KSPGetSolution(KSP,Vec *); 42 43 extern int KSPSetPC(KSP,PC); 44 extern int KSPGetPC(KSP,PC*); 45 46 extern int KSPSetMonitor(KSP,int (*)(KSP,int,double, void*), void *); 47 extern int KSPGetMonitorContext(KSP,void **); 48 extern int KSPSetResidualHistory(KSP, double *,int); 49 50 extern int KSPSetConvergenceTest(KSP,int (*)(KSP,int,double, void*), void *); 51 extern int KSPGetConvergenceContext(KSP,void **); 52 53 extern int KSPBuildSolution(KSP, Vec,Vec *); 54 extern int KSPBuildResidual(KSP, Vec, Vec,Vec *); 55 56 extern int KSPRichardsonSetScale(KSP , double); 57 extern int KSPChebychevSetEigenvalues(KSP , double, double); 58 extern int KSPComputeExtremeSingularValues(KSP, Scalar*,Scalar*); 59 60 extern int KSPGMRESSetRestart(KSP, int); 61 extern int KSPGMRESSetPreAllocateVectors(KSP); 62 extern int KSPGMRESSetOrthogonalization(KSP,int (*)(KSP,int)); 63 extern int KSPGMRESUnmodifiedGramSchmidtOrthogonalization(KSP,int); 64 extern int KSPGMRESModifiedGramSchmidtOrthogonalization(KSP,int); 65 extern int KSPGMRESIROrthogonalization(KSP,int); 66 67 extern int KSPSetFromOptions(KSP); 68 69 extern int KSPSingularValueMonitor(KSP,int,double, void * ); 70 extern int KSPCGDefaultConverged(KSP,int,double, void *); 71 extern int KSPDefaultMonitor(KSP,int,double, void *); 72 extern int KSPTrueMonitor(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 KSPUnwindPreconditioner(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 extern int KSPAppendOptionsPrefix(KSP,char*); 85 extern int KSPGetOptionsPrefix(KSP,char**); 86 87 extern int KSPView(KSP,Viewer); 88 89 typedef enum {KSP_CG_SYMMETRIC=1, KSP_CG_HERMITIAN=2} KSPCGType; 90 extern int KSPCGSetType(KSP,KSPCGType); 91 92 #if defined(__DRAW_PACKAGE) 93 extern int KSPLGMonitorCreate(char*,char*,int,int,int,int,DrawLG*); 94 extern int KSPLGMonitor(KSP,int,double,void*); 95 extern int KSPLGMonitorDestroy(DrawLG); 96 extern int KSPLGTrueMonitorCreate(char*,char*,int,int,int,int,DrawLG*); 97 extern int KSPLGTrueMonitor(KSP,int,double,void*); 98 extern int KSPLGTrueMonitorDestroy(DrawLG); 99 #endif 100 101 #endif 102 103 104