1 /* $Id: ksp.h,v 1.65 1998/04/09 04:19:44 bsmith Exp curfman $ */ 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 #define KSPRICHARDSON "richardson" 17 #define KSPCHEBYCHEV "chebychev" 18 #define KSPCG "cg" 19 #define KSPGMRES "gmres" 20 #define KSPTCQMR "tcqmr" 21 #define KSPBCGS "bcgs" 22 #define KSPCGS "cgs" 23 #define KSPTFQMR "tfqmr" 24 #define KSPCR "cr" 25 #define KSPLSQR "lsqr" 26 #define KSPPREONLY "preonly" 27 #define KSPQCG "qcg" 28 typedef char * KSPType; 29 30 extern int KSPCreate(MPI_Comm,KSP *); 31 extern int KSPSetType(KSP,KSPType); 32 extern int KSPSetUp(KSP); 33 extern int KSPSolve(KSP,int *); 34 extern int KSPDestroy(KSP); 35 36 extern DLList KSPList; 37 extern int KSPRegisterAll(char *); 38 extern int KSPRegisterDestroy(void); 39 40 extern int KSPRegister_Private(char*,char*,char*,int(*)(KSP)); 41 #if defined(USE_DYNAMIC_LIBRARIES) 42 #define KSPRegister(a,b,c,d) KSPRegister_Private(a,b,c,0) 43 #else 44 #define KSPRegister(a,b,c,d) KSPRegister_Private(a,b,c,d) 45 #endif 46 47 extern int KSPGetType(KSP, KSPType *); 48 extern int KSPSetPreconditionerSide(KSP,PCSide); 49 extern int KSPGetPreconditionerSide(KSP,PCSide*); 50 extern int KSPGetTolerances(KSP,double*,double*,double*,int*); 51 extern int KSPSetTolerances(KSP,double,double,double,int); 52 extern int KSPSetComputeResidual(KSP,PetscTruth); 53 extern int KSPSetUsePreconditionedResidual(KSP); 54 extern int KSPSetInitialGuessNonzero(KSP); 55 extern int KSPSetComputeEigenvalues(KSP); 56 extern int KSPSetComputeSingularValues(KSP); 57 extern int KSPSetRhs(KSP,Vec); 58 extern int KSPGetRhs(KSP,Vec *); 59 extern int KSPSetSolution(KSP,Vec); 60 extern int KSPGetSolution(KSP,Vec *); 61 extern int KSPGetResidualNorm(KSP,double*); 62 63 extern int KSPSetPC(KSP,PC); 64 extern int KSPGetPC(KSP,PC*); 65 66 extern int KSPSetMonitor(KSP,int (*)(KSP,int,double, void*), void *); 67 extern int KSPClearMonitor(KSP); 68 extern int KSPGetMonitorContext(KSP,void **); 69 extern int KSPSetResidualHistory(KSP, double *,int); 70 71 extern int KSPSetConvergenceTest(KSP,int (*)(KSP,int,double, void*), void *); 72 extern int KSPGetConvergenceContext(KSP,void **); 73 74 extern int KSPBuildSolution(KSP, Vec,Vec *); 75 extern int KSPBuildResidual(KSP, Vec, Vec,Vec *); 76 77 extern int KSPRichardsonSetScale(KSP , double); 78 extern int KSPChebychevSetEigenvalues(KSP , double, double); 79 extern int KSPComputeExtremeSingularValues(KSP, double*,double*); 80 extern int KSPComputeEigenvalues(KSP,int,double*,double*); 81 extern int KSPComputeEigenvaluesExplicitly(KSP,int,double*,double*); 82 83 extern int KSPGMRESSetRestart(KSP, int); 84 extern int KSPGMRESSetPreAllocateVectors(KSP); 85 extern int KSPGMRESSetOrthogonalization(KSP,int (*)(KSP,int)); 86 extern int KSPGMRESUnmodifiedGramSchmidtOrthogonalization(KSP,int); 87 extern int KSPGMRESModifiedGramSchmidtOrthogonalization(KSP,int); 88 extern int KSPGMRESIROrthogonalization(KSP,int); 89 extern int KSPGMRESDGKSOrthogonalization(KSP,int); 90 91 extern int KSPSetFromOptions(KSP); 92 extern int KSPAddOptionsChecker(int (*)(KSP)); 93 94 extern int KSPSingularValueMonitor(KSP,int,double, void * ); 95 extern int KSPDefaultMonitor(KSP,int,double, void *); 96 extern int KSPTrueMonitor(KSP,int,double, void *); 97 extern int KSPDefaultSMonitor(KSP,int,double, void *); 98 99 extern int KSPDefaultConverged(KSP,int,double, void *); 100 101 extern int KSPResidual(KSP,Vec,Vec,Vec,Vec,Vec,Vec); 102 extern int KSPUnwindPreconditioner(KSP,Vec,Vec); 103 extern int KSPDefaultBuildSolution(KSP,Vec,Vec*); 104 extern int KSPDefaultBuildResidual(KSP,Vec,Vec,Vec *); 105 106 extern int KSPPrintHelp(KSP); 107 108 extern int KSPSetOptionsPrefix(KSP,char*); 109 extern int KSPAppendOptionsPrefix(KSP,char*); 110 extern int KSPGetOptionsPrefix(KSP,char**); 111 112 extern int KSPView(KSP,Viewer); 113 114 extern int KSPComputeExplicitOperator(KSP,Mat *); 115 116 typedef enum {KSP_CG_SYMMETRIC=1, KSP_CG_HERMITIAN=2} KSPCGType; 117 extern int KSPCGSetType(KSP,KSPCGType); 118 119 extern int PCPreSolve(PC,KSP); 120 extern int PCPostSolve(PC,KSP); 121 122 extern int KSPLGMonitorCreate(char*,char*,int,int,int,int,DrawLG*); 123 extern int KSPLGMonitor(KSP,int,double,void*); 124 extern int KSPLGMonitorDestroy(DrawLG); 125 extern int KSPLGTrueMonitorCreate(MPI_Comm,char*,char*,int,int,int,int,DrawLG*); 126 extern int KSPLGTrueMonitor(KSP,int,double,void*); 127 extern int KSPLGTrueMonitorDestroy(DrawLG); 128 129 #endif 130 131 132