xref: /petsc/include/petscksp.h (revision f0479e8c2158d05ab5c06def5bd82110ef658075)
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         0x202020
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(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 KSPRegister(KSPMETHOD,char *,int (*)(KSP));
28 
29 extern int KSPGetMethodName(KSPMETHOD,char **);
30 extern int KSPGetWorkCounts(KSP,int*,int*,int*,int*,int*);
31 extern int KSPClearWorkCounts(KSP);
32 
33 extern int KSPSetIterations(KSP,int);
34 extern int KSPSetRightPreconditioner(KSP);
35 extern int KSPGetPreconditionerSide(KSP,int *);
36 extern int KSPGetMethodFromContext(KSP,KSPMETHOD *);
37 extern int KSPGetMethodFromOptions(KSP,KSPMETHOD *);
38 extern int KSPSetRelativeTolerance(KSP,double);
39 extern int KSPSetAbsoluteTolerance(KSP,double);
40 extern int KSPSetDivergenceTolerance(KSP,double);
41 extern int KSPSetCalculateResidual(KSP);
42 extern int KSPSetDoNotCalculateResidual(KSP);
43 extern int KSPSetUsePreconditionedResidual(KSP);
44 extern int KSPSetInitialGuessNonZero(KSP);
45 extern int KSPSetCalculateEigenvalues(KSP);
46 extern int KSPSetRhs(KSP,Vec);
47 extern int KSPGetRhs(KSP,Vec *);
48 extern int KSPSetSolution(KSP,Vec);
49 extern int KSPGetSolution(KSP,Vec *);
50 
51 extern int KSPSetAmult(KSP,Mat);
52 extern int KSPGetAmult(KSP,Mat *);
53 extern int KSPSetBinv(KSP,PC);
54 extern int KSPGetBinv(KSP,PC*);
55 
56 extern int KSPSetMonitor(KSP,int (*)(KSP,int,double, void*), void *);
57 extern int KSPGetMonitorContext(KSP,void **);
58 extern int KSPSetResidualHistory(KSP, double *,int);
59 extern int KSPSetConvergenceTest(KSP,int (*)(KSP,int,double, void*), void *);
60 extern int KSPGetConvergenceContext(KSP,void **);
61 
62 extern int KSPBuildSolution(KSP, Vec,Vec *);
63 extern int KSPBuildResidual(KSP, Vec, Vec,Vec *);
64 
65 extern int KSPRichardsonSetScale(KSP , double);
66 extern int KSPChebychevSetEigenvalues(KSP , double, double);
67 extern int KSPCGGetEigenvalues(KSP, int n,double*,double*);
68 extern int KSPGMRESSetRestart(KSP, int);
69 extern int KSPSetFromOptions(KSP);
70 
71 extern int KSPDefaultCGMonitor(KSP,int,double, void * );
72 extern int KSPDefaultCGConverged(KSP,int,double, void *);
73 extern int KSPDefaultMonitor(KSP,int,double, void *);
74 extern int KSPLineGraphMonitor(KSP,int,double, void *);
75 extern int KSPDefaultConverged(KSP,int,double, void *);
76 
77 extern int KSPPrintHelp(KSP);
78 
79 extern int KSPSetOptionsPrefix(KSP,char*);
80 
81 extern int KSPView(KSP,Viewer);
82 
83 #if defined(__DRAW_PACKAGE)
84 extern int KSPLGMonitorCreate(char*,char*,int,int,int,int,DrawLGCtx*);
85 extern int KSPLGMonitor(KSP,int,double,void*);
86 extern int KSPLGMonitorDestroy(DrawLGCtx);
87 #endif
88 
89 #endif
90 
91 
92