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