xref: /petsc/include/petscksp.h (revision f0479e8c2158d05ab5c06def5bd82110ef658075)
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*f0479e8cSBarry Smith #define KSP_COOKIE         0x202020
10*f0479e8cSBarry 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();
278ed539a5SBarry Smith extern int KSPRegister(KSPMETHOD,char *,int (*)(KSP));
282eac72dbSBarry Smith 
298ed539a5SBarry Smith extern int KSPGetMethodName(KSPMETHOD,char **);
308ed539a5SBarry Smith extern int KSPGetWorkCounts(KSP,int*,int*,int*,int*,int*);
318ed539a5SBarry Smith extern int KSPClearWorkCounts(KSP);
322eac72dbSBarry Smith 
338ed539a5SBarry Smith extern int KSPSetIterations(KSP,int);
348ed539a5SBarry Smith extern int KSPSetRightPreconditioner(KSP);
358ed539a5SBarry Smith extern int KSPGetPreconditionerSide(KSP,int *);
368ed539a5SBarry Smith extern int KSPGetMethodFromContext(KSP,KSPMETHOD *);
371eb62cbbSBarry Smith extern int KSPGetMethodFromOptions(KSP,KSPMETHOD *);
388ed539a5SBarry Smith extern int KSPSetRelativeTolerance(KSP,double);
398ed539a5SBarry Smith extern int KSPSetAbsoluteTolerance(KSP,double);
408ed539a5SBarry Smith extern int KSPSetDivergenceTolerance(KSP,double);
418ed539a5SBarry Smith extern int KSPSetCalculateResidual(KSP);
428ed539a5SBarry Smith extern int KSPSetDoNotCalculateResidual(KSP);
438ed539a5SBarry Smith extern int KSPSetUsePreconditionedResidual(KSP);
44aabeff55SBarry Smith extern int KSPSetInitialGuessNonZero(KSP);
458ed539a5SBarry Smith extern int KSPSetCalculateEigenvalues(KSP);
468ed539a5SBarry Smith extern int KSPSetRhs(KSP,Vec);
478ed539a5SBarry Smith extern int KSPGetRhs(KSP,Vec *);
488ed539a5SBarry Smith extern int KSPSetSolution(KSP,Vec);
498ed539a5SBarry Smith extern int KSPGetSolution(KSP,Vec *);
502eac72dbSBarry Smith 
51aabeff55SBarry Smith extern int KSPSetAmult(KSP,Mat);
52aabeff55SBarry Smith extern int KSPGetAmult(KSP,Mat *);
53aabeff55SBarry Smith extern int KSPSetBinv(KSP,PC);
54aabeff55SBarry Smith extern int KSPGetBinv(KSP,PC*);
55aabeff55SBarry Smith 
568ed539a5SBarry Smith extern int KSPSetMonitor(KSP,int (*)(KSP,int,double, void*), void *);
578ed539a5SBarry Smith extern int KSPGetMonitorContext(KSP,void **);
588ed539a5SBarry Smith extern int KSPSetResidualHistory(KSP, double *,int);
598ed539a5SBarry Smith extern int KSPSetConvergenceTest(KSP,int (*)(KSP,int,double, void*), void *);
608ed539a5SBarry Smith extern int KSPGetConvergenceContext(KSP,void **);
612eac72dbSBarry Smith 
628ed539a5SBarry Smith extern int KSPBuildSolution(KSP, Vec,Vec *);
638ed539a5SBarry Smith extern int KSPBuildResidual(KSP, Vec, Vec,Vec *);
642eac72dbSBarry Smith 
658ed539a5SBarry Smith extern int KSPRichardsonSetScale(KSP , double);
668ed539a5SBarry Smith extern int KSPChebychevSetEigenvalues(KSP , double, double);
678ed539a5SBarry Smith extern int KSPCGGetEigenvalues(KSP, int n,double*,double*);
688ed539a5SBarry Smith extern int KSPGMRESSetRestart(KSP, int);
698ed539a5SBarry Smith extern int KSPSetFromOptions(KSP);
702eac72dbSBarry Smith 
718ed539a5SBarry Smith extern int KSPDefaultCGMonitor(KSP,int,double, void * );
728ed539a5SBarry Smith extern int KSPDefaultCGConverged(KSP,int,double, void *);
738ed539a5SBarry Smith extern int KSPDefaultMonitor(KSP,int,double, void *);
748ed539a5SBarry Smith extern int KSPLineGraphMonitor(KSP,int,double, void *);
758ed539a5SBarry Smith extern int KSPDefaultConverged(KSP,int,double, void *);
762eac72dbSBarry Smith 
778ed539a5SBarry Smith extern int KSPPrintHelp(KSP);
788ed539a5SBarry Smith 
791eb62cbbSBarry Smith extern int KSPSetOptionsPrefix(KSP,char*);
801eb62cbbSBarry Smith 
818ed539a5SBarry Smith extern int KSPView(KSP,Viewer);
821eb62cbbSBarry Smith 
831eb62cbbSBarry Smith #if defined(__DRAW_PACKAGE)
841eb62cbbSBarry Smith extern int KSPLGMonitorCreate(char*,char*,int,int,int,int,DrawLGCtx*);
851eb62cbbSBarry Smith extern int KSPLGMonitor(KSP,int,double,void*);
861eb62cbbSBarry Smith extern int KSPLGMonitorDestroy(DrawLGCtx);
871eb62cbbSBarry Smith #endif
881eb62cbbSBarry Smith 
892eac72dbSBarry Smith #endif
902eac72dbSBarry Smith 
912eac72dbSBarry Smith 
92