xref: /petsc/include/petscksp.h (revision edae2e7dd0bdd187ac013a59d14cdeee7e201c06)
1 
2 #ifndef __KSP_PACKAGE
3 #define __KSP_PACKAGE
4 #include "petsc.h"
5 #include "vec.h"
6 #include "mat.h"
7 #include "pc.h"
8 
9 #define KSP_COOKIE  PETSC_COOKIE+8
10 
11 typedef struct _KSP*     KSP;
12 
13 /*  Possible Krylov Space Methods */
14 typedef enum { KSPRICHARDSON, KSPCHEBYCHEV, KSPCG, KSPGMRES,
15                KSPTCQMR, KSPBCGS, KSPCGS, KSPTFQMR, KSPCR, KSPLSQR,
16                KSPPREONLY } KSPMethod;
17 
18 extern int KSPPrintMethods(char *,char *);
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 KSPSetMaxIterations(KSP,int);
32 extern int KSPSetRightPreconditioner(KSP);
33 extern int KSPGetPreconditionerSide(KSP,int *);
34 extern int KSPGetMethodFromContext(KSP,KSPMethod *);
35 extern int KSPSetRelativeTolerance(KSP,double);
36 extern int KSPSetAbsoluteTolerance(KSP,double);
37 extern int KSPSetDivergenceTolerance(KSP,double);
38 extern int KSPSetCalculateResidual(KSP,PetscTruth);
39 extern int KSPSetUsePreconditionedResidual(KSP);
40 extern int KSPSetInitialGuessNonzero(KSP);
41 extern int KSPSetCalculateEigenvalues(KSP);
42 extern int KSPSetRhs(KSP,Vec);
43 extern int KSPGetRhs(KSP,Vec *);
44 extern int KSPSetSolution(KSP,Vec);
45 extern int KSPGetSolution(KSP,Vec *);
46 
47 extern int KSPSetBinv(KSP,PC);
48 extern int KSPGetBinv(KSP,PC*);
49 
50 extern int KSPSetMonitor(KSP,int (*)(KSP,int,double, void*), void *);
51 extern int KSPGetMonitorContext(KSP,void **);
52 extern int KSPSetResidualHistory(KSP, double *,int);
53 extern int KSPSetConvergenceTest(KSP,int (*)(KSP,int,double, void*), void *);
54 extern int KSPGetConvergenceContext(KSP,void **);
55 
56 extern int KSPBuildSolution(KSP, Vec,Vec *);
57 extern int KSPBuildResidual(KSP, Vec, Vec,Vec *);
58 
59 extern int KSPRichardsonSetScale(KSP , double);
60 extern int KSPChebychevSetEigenvalues(KSP , double, double);
61 extern int KSPCGGetEigenvalues(KSP, int n,double*,double*);
62 extern int KSPGMRESSetRestart(KSP, int);
63 extern int KSPGMRESSetUseUnmodifiedGrammSchmidt(KSP);
64 extern int KSPSetFromOptions(KSP);
65 
66 extern int KSPDefaultCGMonitor(KSP,int,double, void * );
67 extern int KSPDefaultCGConverged(KSP,int,double, void *);
68 extern int KSPDefaultMonitor(KSP,int,double, void *);
69 extern int KSPDefaultConverged(KSP,int,double, void *);
70 
71 extern int KSPPrintHelp(KSP);
72 
73 extern int KSPSetOptionsPrefix(KSP,char*);
74 
75 extern int KSPView(KSP,Viewer);
76 
77 #if defined(__DRAW_PACKAGE)
78 extern int KSPLGMonitorCreate(char*,char*,int,int,int,int,DrawLGCtx*);
79 extern int KSPLGMonitor(KSP,int,double,void*);
80 extern int KSPLGMonitorDestroy(DrawLGCtx);
81 #endif
82 
83 #endif
84 
85 
86