xref: /petsc/include/petscksp.h (revision 9e25ed09632ec91e2227f4e6f1ce3bfe794e20d8)
12eac72dbSBarry Smith 
22eac72dbSBarry Smith #ifndef __KSP_PACKAGE
32eac72dbSBarry Smith #define __KSP_PACKAGE
42eac72dbSBarry Smith #include "petsc.h"
52eac72dbSBarry Smith #include "vec.h"
6aabeff55SBarry Smith #include "mat.h"
7aabeff55SBarry Smith #include "pc.h"
82eac72dbSBarry Smith 
9*9e25ed09SBarry Smith #define KSP_COOKIE  PETSC_COOKIE+8
10f0479e8cSBarry Smith 
112eac72dbSBarry Smith typedef struct _KSP*     KSP;
122eac72dbSBarry Smith 
132eac72dbSBarry Smith /*  Possible Krylov Space Methods */
142eac72dbSBarry Smith typedef enum { KSPRICHARDSON, KSPCHEBYCHEV, KSPCG, KSPGMRES,
152eac72dbSBarry Smith                KSPTCQMR, KSPBCGS, KSPCGS, KSPTFQMR, KSPCR, KSPLSQR,
162eac72dbSBarry Smith                KSPPREONLY } KSPMETHOD;
172eac72dbSBarry Smith 
181eb62cbbSBarry Smith extern int KSPPrintMethods(char *,char *);
192eac72dbSBarry Smith 
208ed539a5SBarry Smith extern int KSPCreate(KSP *);
218ed539a5SBarry Smith extern int KSPSetMethod(KSP,KSPMETHOD);
228ed539a5SBarry Smith extern int KSPSetUp(KSP);
238ed539a5SBarry Smith extern int KSPSolve(KSP,int *);
248ed539a5SBarry Smith extern int KSPDestroy(KSP);
252eac72dbSBarry Smith 
268ed539a5SBarry Smith extern int KSPRegisterAll();
27d6dfbf8fSBarry Smith extern int KSPRegisterDestroy();
288ed539a5SBarry Smith extern int KSPRegister(KSPMETHOD,char *,int (*)(KSP));
292eac72dbSBarry Smith 
308ed539a5SBarry Smith extern int KSPGetMethodName(KSPMETHOD,char **);
318ed539a5SBarry Smith extern int KSPGetWorkCounts(KSP,int*,int*,int*,int*,int*);
328ed539a5SBarry Smith extern int KSPClearWorkCounts(KSP);
332eac72dbSBarry Smith 
348ed539a5SBarry Smith extern int KSPSetIterations(KSP,int);
358ed539a5SBarry Smith extern int KSPSetRightPreconditioner(KSP);
368ed539a5SBarry Smith extern int KSPGetPreconditionerSide(KSP,int *);
378ed539a5SBarry Smith extern int KSPGetMethodFromContext(KSP,KSPMETHOD *);
381eb62cbbSBarry Smith extern int KSPGetMethodFromOptions(KSP,KSPMETHOD *);
398ed539a5SBarry Smith extern int KSPSetRelativeTolerance(KSP,double);
408ed539a5SBarry Smith extern int KSPSetAbsoluteTolerance(KSP,double);
418ed539a5SBarry Smith extern int KSPSetDivergenceTolerance(KSP,double);
428ed539a5SBarry Smith extern int KSPSetCalculateResidual(KSP);
438ed539a5SBarry Smith extern int KSPSetDoNotCalculateResidual(KSP);
448ed539a5SBarry Smith extern int KSPSetUsePreconditionedResidual(KSP);
45aabeff55SBarry Smith extern int KSPSetInitialGuessNonZero(KSP);
468ed539a5SBarry Smith extern int KSPSetCalculateEigenvalues(KSP);
478ed539a5SBarry Smith extern int KSPSetRhs(KSP,Vec);
488ed539a5SBarry Smith extern int KSPGetRhs(KSP,Vec *);
498ed539a5SBarry Smith extern int KSPSetSolution(KSP,Vec);
508ed539a5SBarry Smith extern int KSPGetSolution(KSP,Vec *);
512eac72dbSBarry Smith 
52aabeff55SBarry Smith extern int KSPSetBinv(KSP,PC);
53aabeff55SBarry Smith extern int KSPGetBinv(KSP,PC*);
54aabeff55SBarry Smith 
558ed539a5SBarry Smith extern int KSPSetMonitor(KSP,int (*)(KSP,int,double, void*), void *);
568ed539a5SBarry Smith extern int KSPGetMonitorContext(KSP,void **);
578ed539a5SBarry Smith extern int KSPSetResidualHistory(KSP, double *,int);
588ed539a5SBarry Smith extern int KSPSetConvergenceTest(KSP,int (*)(KSP,int,double, void*), void *);
598ed539a5SBarry Smith extern int KSPGetConvergenceContext(KSP,void **);
602eac72dbSBarry Smith 
618ed539a5SBarry Smith extern int KSPBuildSolution(KSP, Vec,Vec *);
628ed539a5SBarry Smith extern int KSPBuildResidual(KSP, Vec, Vec,Vec *);
632eac72dbSBarry Smith 
648ed539a5SBarry Smith extern int KSPRichardsonSetScale(KSP , double);
658ed539a5SBarry Smith extern int KSPChebychevSetEigenvalues(KSP , double, double);
668ed539a5SBarry Smith extern int KSPCGGetEigenvalues(KSP, int n,double*,double*);
678ed539a5SBarry Smith extern int KSPGMRESSetRestart(KSP, int);
688ed539a5SBarry Smith extern int KSPSetFromOptions(KSP);
692eac72dbSBarry Smith 
708ed539a5SBarry Smith extern int KSPDefaultCGMonitor(KSP,int,double, void * );
718ed539a5SBarry Smith extern int KSPDefaultCGConverged(KSP,int,double, void *);
728ed539a5SBarry Smith extern int KSPDefaultMonitor(KSP,int,double, void *);
738ed539a5SBarry Smith extern int KSPLineGraphMonitor(KSP,int,double, void *);
748ed539a5SBarry Smith extern int KSPDefaultConverged(KSP,int,double, void *);
752eac72dbSBarry Smith 
768ed539a5SBarry Smith extern int KSPPrintHelp(KSP);
778ed539a5SBarry Smith 
781eb62cbbSBarry Smith extern int KSPSetOptionsPrefix(KSP,char*);
791eb62cbbSBarry Smith 
808ed539a5SBarry Smith extern int KSPView(KSP,Viewer);
811eb62cbbSBarry Smith 
821eb62cbbSBarry Smith #if defined(__DRAW_PACKAGE)
831eb62cbbSBarry Smith extern int KSPLGMonitorCreate(char*,char*,int,int,int,int,DrawLGCtx*);
841eb62cbbSBarry Smith extern int KSPLGMonitor(KSP,int,double,void*);
851eb62cbbSBarry Smith extern int KSPLGMonitorDestroy(DrawLGCtx);
861eb62cbbSBarry Smith #endif
871eb62cbbSBarry Smith 
882eac72dbSBarry Smith #endif
892eac72dbSBarry Smith 
902eac72dbSBarry Smith 
91