petsc/include/petscksp.h

*e2a1c21fSSatish Balay/* $Id: ksp.h,v 1.53 1997/05/20 03:18:57 bsmith Exp balay $ */
f26ada1bSBarry Smith/*
f26ada1bSBarry Smith   Defines the interface functions for the Krylov subspace accelerators.
f26ada1bSBarry Smith*/
2eac72dbSBarry Smith#ifndef __KSP_PACKAGE
2eac72dbSBarry Smith#define __KSP_PACKAGE
2eac72dbSBarry Smith#include "petsc.h"
2eac72dbSBarry Smith#include "vec.h"
aabeff55SBarry Smith#include "mat.h"
aabeff55SBarry Smith#include "pc.h"
2eac72dbSBarry Smith
9e25ed09SBarry Smith#define KSP_COOKIE  PETSC_COOKIE+8
f0479e8cSBarry Smith
*e2a1c21fSSatish Balaytypedef struct _p_KSP*     KSP;
2eac72dbSBarry Smith
f26ada1bSBarry Smithtypedef enum { KSPRICHARDSON, KSPCHEBYCHEV, KSPCG, KSPGMRES, KSPTCQMR, KSPBCGS,
84cb2905SBarry Smith               KSPCGS, KSPTFQMR, KSPCR, KSPLSQR, KSPPREONLY, KSPQCG, KSPNEW} KSPType;
2eac72dbSBarry Smith
6b5873e3SBarry Smithextern int KSPCreate(MPI_Comm,KSP *);
4b0e389bSBarry Smithextern int KSPSetType(KSP,KSPType);
8ed539a5SBarry Smithextern int KSPSetUp(KSP);
8ed539a5SBarry Smithextern int KSPSolve(KSP,int *);
8ed539a5SBarry Smithextern int KSPDestroy(KSP);
2eac72dbSBarry Smith
8ed539a5SBarry Smithextern int KSPRegisterAll();
d6dfbf8fSBarry Smithextern int KSPRegisterDestroy();
84cb2905SBarry Smithextern int KSPRegister(KSPType,KSPType*,char *,int (*)(KSP));
84cb2905SBarry Smithextern int KSPRegisterAllCalled;
2eac72dbSBarry Smith
4b0e389bSBarry Smithextern int KSPGetType(KSP, KSPType *,char **);
aad2872bSLois Curfman McInnesextern int KSPSetPreconditionerSide(KSP,PCSide);
aad2872bSLois Curfman McInnesextern int KSPGetPreconditionerSide(KSP,PCSide*);
ae622e99SLois Curfman McInnesextern int KSPGetTolerances(KSP,double*,double*,double*,int*);
f9a5357eSLois Curfman McInnesextern int KSPSetTolerances(KSP,double,double,double,int);
d4fbbf0eSBarry Smithextern int KSPSetComputeResidual(KSP,PetscTruth);
8ed539a5SBarry Smithextern int KSPSetUsePreconditionedResidual(KSP);
c39b5c85SLois Curfman McInnesextern int KSPSetInitialGuessNonzero(KSP);
90f02eecSBarry Smithextern int KSPSetComputeEigenvalues(KSP);
d4fbbf0eSBarry Smithextern int KSPSetComputeSingularValues(KSP);
8ed539a5SBarry Smithextern int KSPSetRhs(KSP,Vec);
8ed539a5SBarry Smithextern int KSPGetRhs(KSP,Vec *);
8ed539a5SBarry Smithextern int KSPSetSolution(KSP,Vec);
8ed539a5SBarry Smithextern int KSPGetSolution(KSP,Vec *);
2eac72dbSBarry Smith
77c4ece6SBarry Smithextern int KSPSetPC(KSP,PC);
77c4ece6SBarry Smithextern int KSPGetPC(KSP,PC*);
aabeff55SBarry Smith
8ed539a5SBarry Smithextern int KSPSetMonitor(KSP,int (*)(KSP,int,double, void*), void *);
8ed539a5SBarry Smithextern int KSPGetMonitorContext(KSP,void **);
8ed539a5SBarry Smithextern int KSPSetResidualHistory(KSP, double *,int);
4b0e389bSBarry Smith
8ed539a5SBarry Smithextern int KSPSetConvergenceTest(KSP,int (*)(KSP,int,double, void*), void *);
8ed539a5SBarry Smithextern int KSPGetConvergenceContext(KSP,void **);
2eac72dbSBarry Smith
8ed539a5SBarry Smithextern int KSPBuildSolution(KSP, Vec,Vec *);
8ed539a5SBarry Smithextern int KSPBuildResidual(KSP, Vec, Vec,Vec *);
2eac72dbSBarry Smith
8ed539a5SBarry Smithextern int KSPRichardsonSetScale(KSP , double);
8ed539a5SBarry Smithextern int KSPChebychevSetEigenvalues(KSP , double, double);
d4fbbf0eSBarry Smithextern int KSPComputeExtremeSingularValues(KSP, double*,double*);
d4fbbf0eSBarry Smithextern int KSPComputeEigenvalues(KSP,int,double*,double*);
d4fbbf0eSBarry Smithextern int KSPComputeEigenvaluesExplicitly(KSP,int,double*,double*);
4b0e389bSBarry Smith
8ed539a5SBarry Smithextern int KSPGMRESSetRestart(KSP, int);
b4fd4287SBarry Smithextern int KSPGMRESSetPreAllocateVectors(KSP);
77c4ece6SBarry Smithextern int KSPGMRESSetOrthogonalization(KSP,int (*)(KSP,int));
bcd2baecSBarry Smithextern int KSPGMRESUnmodifiedGramSchmidtOrthogonalization(KSP,int);
bcd2baecSBarry Smithextern int KSPGMRESModifiedGramSchmidtOrthogonalization(KSP,int);
bcd2baecSBarry Smithextern int KSPGMRESIROrthogonalization(KSP,int);
08480c60SBarry Smith
8ed539a5SBarry Smithextern int KSPSetFromOptions(KSP);
639f9d9dSBarry Smithextern int KSPAddOptionsChecker(int (*)(KSP));
2eac72dbSBarry Smith
8f4c8dbaSBarry Smithextern int KSPSingularValueMonitor(KSP,int,double, void * );
8ed539a5SBarry Smithextern int KSPDefaultMonitor(KSP,int,double, void *);
af6b99e9SBarry Smithextern int KSPTrueMonitor(KSP,int,double, void *);
8c48e012SBarry Smithextern int KSPDefaultSMonitor(KSP,int,double, void *);
84cb2905SBarry Smith
8ed539a5SBarry Smithextern int KSPDefaultConverged(KSP,int,double, void *);
2eac72dbSBarry Smith
c01c455dSBarry Smithextern int KSPResidual(KSP,Vec,Vec,Vec,Vec,Vec,Vec);
77c4ece6SBarry Smithextern int KSPUnwindPreconditioner(KSP,Vec,Vec);
c01c455dSBarry Smithextern int KSPDefaultBuildSolution(KSP,Vec,Vec*);
c01c455dSBarry Smithextern int KSPDefaultBuildResidual(KSP,Vec,Vec,Vec *);
c01c455dSBarry Smith
8ed539a5SBarry Smithextern int KSPPrintHelp(KSP);
8ed539a5SBarry Smith
1eb62cbbSBarry Smithextern int KSPSetOptionsPrefix(KSP,char*);
0985bb82SSatish Balayextern int KSPAppendOptionsPrefix(KSP,char*);
0985bb82SSatish Balayextern int KSPGetOptionsPrefix(KSP,char**);
1eb62cbbSBarry Smith
8ed539a5SBarry Smithextern int KSPView(KSP,Viewer);
1eb62cbbSBarry Smith
d4fbbf0eSBarry Smithextern int KSPComputeExplicitOperator(KSP,Mat *);
d4fbbf0eSBarry Smith
6d4a8577SBarry Smithtypedef enum {KSP_CG_SYMMETRIC=1, KSP_CG_HERMITIAN=2} KSPCGType;
6d4a8577SBarry Smithextern int KSPCGSetType(KSP,KSPCGType);
e559a7feSLois Curfman McInnes
3369ce9aSBarry Smithextern int    PCPreSolve(PC,KSP);
3369ce9aSBarry Smithextern int    PCPostSolve(PC,KSP);
3369ce9aSBarry Smith
d7e8b826SBarry Smithextern int KSPLGMonitorCreate(char*,char*,int,int,int,int,DrawLG*);
1eb62cbbSBarry Smithextern int KSPLGMonitor(KSP,int,double,void*);
d7e8b826SBarry Smithextern int KSPLGMonitorDestroy(DrawLG);
3b2fbd54SBarry Smithextern int KSPLGTrueMonitorCreate(MPI_Comm,char*,char*,int,int,int,int,DrawLG*);
af6b99e9SBarry Smithextern int KSPLGTrueMonitor(KSP,int,double,void*);
af6b99e9SBarry Smithextern int KSPLGTrueMonitorDestroy(DrawLG);
1eb62cbbSBarry Smith
2eac72dbSBarry Smith#endif
2eac72dbSBarry Smith
2eac72dbSBarry Smith