xref: /petsc/include/petscpf.h (revision ca44d042d6f86ecc01fa7a52a5213a5161f95f53)
1*ca44d042SBarry Smith /* $Id: petscpf.h,v 1.5 2000/05/08 15:09:50 balay Exp bsmith $ */
2f97fa5f8SBarry Smith 
3f97fa5f8SBarry Smith /*
43e3e4676SBarry Smith       mathematical function module.
5f97fa5f8SBarry Smith */
60a835dfdSSatish Balay #if !defined(__PETSCPF_H)
70a835dfdSSatish Balay #define __PETSCPF_H
80a835dfdSSatish Balay #include "petscmat.h"
9f97fa5f8SBarry Smith 
10f97fa5f8SBarry Smith /*
113e3e4676SBarry Smith     PFList contains the list of preconditioners currently registered
123e3e4676SBarry Smith    These are added with the PFRegisterDynamic() macro
13f97fa5f8SBarry Smith */
143e3e4676SBarry Smith extern FList PFList;
153e3e4676SBarry Smith typedef char *PFType;
16f97fa5f8SBarry Smith 
17f97fa5f8SBarry Smith /*
183e3e4676SBarry Smith     Standard PETSc functions
19f97fa5f8SBarry Smith */
203e3e4676SBarry Smith #define PFCONSTANT      "constant"
213e3e4676SBarry Smith #define PFMAT           "mat"
223eda8832SBarry Smith #define PFSTRING        "string"
233eda8832SBarry Smith #define PFQUICK         "quick"
24f97fa5f8SBarry Smith 
253e3e4676SBarry Smith typedef struct _p_PF* PF;
263e3e4676SBarry Smith #define PF_COOKIE     PETSC_COOKIE+9
27f97fa5f8SBarry Smith 
28f97fa5f8SBarry Smith 
29*ca44d042SBarry Smith EXTERN int PFCreate(MPI_Comm,int,int,PF*);
30*ca44d042SBarry Smith EXTERN int PFSetType(PF,PFType,void*);
31*ca44d042SBarry Smith EXTERN int PFSet(PF,int(*)(void*,int,Scalar*,Scalar*),int(*)(void*,Vec,Vec),int(*)(void*,Viewer),int(*)(void*),void*);
32*ca44d042SBarry Smith EXTERN int PFApply(PF,int,Scalar*,Scalar*);
33*ca44d042SBarry Smith EXTERN int PFApplyVec(PF,Vec,Vec);
34f97fa5f8SBarry Smith 
35*ca44d042SBarry Smith EXTERN int        PFRegisterDestroy(void);
36*ca44d042SBarry Smith EXTERN int        PFRegisterAll(char*);
373eda8832SBarry Smith extern PetscTruth PFRegisterAllCalled;
38f97fa5f8SBarry Smith 
39*ca44d042SBarry Smith EXTERN int PFRegister(char*,char*,char*,int(*)(PF,void*));
40f97fa5f8SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
413e3e4676SBarry Smith #define PFRegisterDynamic(a,b,c,d) PFRegister(a,b,c,0)
42f97fa5f8SBarry Smith #else
433e3e4676SBarry Smith #define PFRegisterDynamic(a,b,c,d) PFRegister(a,b,c,d)
44f97fa5f8SBarry Smith #endif
45f97fa5f8SBarry Smith 
46*ca44d042SBarry Smith EXTERN int PFDestroy(PF);
47*ca44d042SBarry Smith EXTERN int PFSetFromOptions(PF);
48*ca44d042SBarry Smith EXTERN int PFSetTypeFromOptions(PF);
49*ca44d042SBarry Smith EXTERN int PFGetType(PF,PFType*);
50f97fa5f8SBarry Smith 
51*ca44d042SBarry Smith EXTERN int PFView(PF,Viewer);
52*ca44d042SBarry Smith EXTERN int PFPrintHelp(PF);
53f97fa5f8SBarry Smith 
543eda8832SBarry Smith #define PFSetOptionsPrefix(a,s) PetscObjectSetOptionsPrefix((PetscObject)(a),s)
55f97fa5f8SBarry Smith #endif
56f97fa5f8SBarry Smith 
57f97fa5f8SBarry Smith 
58f97fa5f8SBarry Smith 
59f97fa5f8SBarry Smith 
60