1 /* $Id: pc.h,v 1.60 1996/07/08 22:24:30 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 typedef enum { PC_LEFT, PC_RIGHT, PC_SYMMETRIC } PCSide; 21 22 extern int PCCreate(MPI_Comm,PC*); 23 extern int PCSetType(PC,PCType); 24 extern int PCSetUp(PC); 25 extern int PCSetUpOnBlocks(PC); 26 extern int PCApply(PC,Vec,Vec); 27 extern int PCApplySymmetricLeft(PC,Vec,Vec); 28 extern int PCApplySymmetricRight(PC,Vec,Vec); 29 extern int PCApplyBAorAB(PC,PCSide,Vec,Vec,Vec); 30 extern int PCApplyTrans(PC,Vec,Vec); 31 extern int PCApplyBAorABTrans(PC,PCSide,Vec,Vec,Vec); 32 extern int PCApplyRichardson(PC,Vec,Vec,Vec,int); 33 extern int PCApplyRichardsonExists(PC,PetscTruth*); 34 extern int PCRegisterAll(); 35 extern int PCRegisterDestroy(); 36 extern int PCRegister(PCType,char *,int (*)(PC)); 37 extern int PCDestroy(PC); 38 extern int PCSetFromOptions(PC); 39 extern int PCGetType(PC,PCType*,char**); 40 extern int PCGetFactoredMatrix(PC,Mat*); 41 42 typedef enum {SAME_NONZERO_PATTERN,DIFFERENT_NONZERO_PATTERN,SAME_PRECONDITIONER} 43 MatStructure; 44 extern int PCSetOperators(PC,Mat,Mat,MatStructure); 45 extern int PCGetOperators(PC,Mat*,Mat*,MatStructure*); 46 47 extern int PCSetVector(PC,Vec); 48 extern int PCPrintHelp(PC); 49 extern int PCView(PC,Viewer); 50 51 extern int PCSetOptionsPrefix(PC,char*); 52 extern int PCAppendOptionsPrefix(PC,char*); 53 extern int PCGetOptionsPrefix(PC,char**); 54 55 extern int PCNullSpaceCreate(MPI_Comm,int,int,Vec *,PCNullSpace*); 56 extern int PCNullSpaceDestroy(PCNullSpace); 57 extern int PCNullSpaceRemove(PCNullSpace,Vec); 58 59 /* options specific to particular preconditioners */ 60 extern int PCSORSetSymmetric(PC, MatSORType); 61 extern int PCSORSetOmega(PC, double); 62 extern int PCEisenstatSetOmega(PC, double); 63 extern int PCSORSetIterations(PC, int); 64 65 typedef enum {PCBGS_FORWARD_SWEEP=1,PCBGS_SYMMETRIC_SWEEP=2} PCBGSType; 66 extern int PCBGSSetSymmetric(PC, PCBGSType); 67 68 #define USE_PRECONDITIONER_MATRIX 0 69 #define USE_TRUE_MATRIX 1 70 extern int PCBJacobiSetUseTrueLocal(PC); 71 extern int PCBJacobiSetTotalBlocks(PC, int, int*); 72 extern int PCBJacobiSetLocalBlocks(PC, int, int*); 73 74 extern int PCBGSSetUseTrueLocal(PC); 75 extern int PCBGSSetTotalBlocks(PC, int, int*); 76 extern int PCBGSSetLocalBlocks(PC, int, int*); 77 extern int PCBGSSetSymmetric(PC, PCBGSType); 78 79 extern int PCShellSetApply(PC, int (*)(void*,Vec,Vec), void*); 80 extern int PCShellSetApplyRichardson(PC,int (*)(void*,Vec,Vec,Vec,int),void*); 81 extern int PCShellSetName(PC,char*); 82 extern int PCShellGetName(PC,char**); 83 84 extern int PCLUSetUseInPlace(PC); 85 extern int PCILUSetUseInPlace(PC); 86 extern int PCILUSetLevels(PC,int); 87 extern int PCILUSetReuseReordering(PC,PetscTruth); 88 extern int PCILUSetUseDropTolerance(PC,double,int); 89 extern int PCILUSetReuseFill(PC,PetscTruth); 90 91 extern int PCEisenstatUseDiagonalScaling(PC); 92 93 extern int PCASMSetLocalSubdomains(PC, int, IS *); 94 extern int PCASMSetTotalSubdomains(PC, int, IS *); 95 extern int PCASMSetOverlap(PC, int); 96 97 extern int PCASMCreateSubdomains2D(int,int,int,int,int,int,int *,IS **); 98 #endif 99 100