1 /* $Id: pc.h,v 1.41 1995/12/21 18:34:37 bsmith Exp bsmith $ */ 2 3 /* 4 Preconditioner module. Defines the preconditioner routines. 5 */ 6 #if !defined(__PC_PACKAGE) 7 #define __PC_PACKAGE 8 #include "petsc.h" 9 #include "mat.h" 10 11 typedef enum { PCNONE, PCJACOBI, PCSOR, PCLU, PCSHELL, PCBJACOBI, PCMG, 12 PCEISENSTAT, PCILU, PCICC, PCASM, PCBGS } PCType; 13 14 typedef struct _PC* PC; 15 #define PC_COOKIE PETSC_COOKIE+9 16 17 typedef struct _PCNullSpace* PCNullSpace; 18 #define PCNULLSPACE_COOKIE PETSC_COOKIE+17 19 20 extern int PCCreate(MPI_Comm,PC*); 21 extern int PCSetType(PC,PCType); 22 extern int PCSetUp(PC); 23 extern int PCApply(PC,Vec,Vec); 24 extern int PCApplyBAorAB(PC,int,Vec,Vec,Vec); 25 extern int PCApplyTrans(PC,Vec,Vec); 26 extern int PCApplyBAorABTrans(PC,int,Vec,Vec,Vec); 27 extern int PCApplyRichardson(PC,Vec,Vec,Vec,int); 28 extern int PCApplyRichardsonExists(PC); 29 extern int PCRegisterAll(); 30 extern int PCRegisterDestroy(); 31 extern int PCRegister(PCType,char *,int (*)(PC)); 32 extern int PCDestroy(PC); 33 extern int PCSetFromOptions(PC); 34 extern int PCGetType(PC,PCType*,char**); 35 extern int PCGetFactoredMatrix(PC,Mat*); 36 37 typedef enum {ALLMAT_DIFFERENT_NONZERO_PATTERN=0,MAT_SAME_NONZERO_PATTERN=1, 38 PMAT_SAME_NONZERO_PATTERN=2,ALLMAT_SAME_NONZERO_PATTERN=3} MatStructure; 39 extern int PCSetOperators(PC,Mat,Mat,MatStructure); 40 extern int PCGetOperators(PC,Mat*,Mat*,MatStructure*); 41 42 extern int PCSetVector(PC,Vec); 43 extern int PCPrintHelp(PC); 44 extern int PCView(PC,Viewer); 45 extern int PCSetOptionsPrefix(PC,char*); 46 47 extern int PCNullSpaceCreate(MPI_Comm,int,int,Vec *,PCNullSpace*); 48 extern int PCNullSpaceDestroy(PCNullSpace); 49 extern int PCNullSpaceRemove(PCNullSpace,Vec); 50 51 /* options specific to particular preconditioners */ 52 extern int PCSORSetSymmetric(PC, MatSORType); 53 extern int PCSORSetOmega(PC, double); 54 extern int PCEisenstatSetOmega(PC, double); 55 extern int PCSORSetIterations(PC, int); 56 57 typedef enum {BGS_FORWARD_SWEEP=1,BGS_BACKWARD_SWEEP=2,BGS_SYMMETRIC_SWEEP=3} PCBGSType; 58 extern int PCBGSSetSymmetric(PC, PCBGSType); 59 60 #define USE_PRECONDITIONER_MATRIX 0 61 #define USE_TRUE_MATRIX 1 62 63 extern int PCBJacobiSetUseTrueLocal(PC); 64 extern int PCBJacobiSetTotalBlocks(PC, int, int*,int*); 65 extern int PCBJacobiSetLocalBlocks(PC, int, int*,int*); 66 67 extern int PCBSIterSetBlockSolve(PC); 68 extern int PCBSIterSetFromOptions(PC); 69 extern int PCBSIterSolve(PC,Vec,Vec,int*); 70 71 extern int PCShellSetApply(PC, int (*)(void*,Vec,Vec), void*); 72 extern int PCShellSetApplyRichardson(PC,int (*)(void*,Vec,Vec,Vec,int),void*); 73 74 extern int PCLUSetUseInPlace(PC); 75 extern int PCILUSetUseInPlace(PC); 76 extern int PCILUSetLevels(PC,int); 77 extern int PCEisenstatUseDiagonalScaling(PC); 78 79 extern int PCASMCreateSubdomains2D(int,int,int,int,int,int,int *,IS **); 80 extern int PCASMSetSubdomains(PC, int, IS *); 81 82 #endif 83 84