1 /* $Id: pc.h,v 1.62 1996/08/19 23:02:28 curfman Exp curfman $ */ 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 extern int PCSetModifySubMatrices(PC,int(*)(PC,int,IS*,IS*,Mat*,void*),void*); 42 extern int PCModifySubMatrices(PC,int,IS*,IS*,Mat*,void*); 43 extern int PCPreSolve(PC,KSP); 44 extern int PCPostSolve(PC,KSP); 45 46 typedef enum {SAME_NONZERO_PATTERN,DIFFERENT_NONZERO_PATTERN,SAME_PRECONDITIONER} 47 MatStructure; 48 extern int PCSetOperators(PC,Mat,Mat,MatStructure); 49 extern int PCGetOperators(PC,Mat*,Mat*,MatStructure*); 50 51 extern int PCSetVector(PC,Vec); 52 extern int PCPrintHelp(PC); 53 extern int PCView(PC,Viewer); 54 55 extern int PCSetOptionsPrefix(PC,char*); 56 extern int PCAppendOptionsPrefix(PC,char*); 57 extern int PCGetOptionsPrefix(PC,char**); 58 59 extern int PCNullSpaceCreate(MPI_Comm,int,int,Vec *,PCNullSpace*); 60 extern int PCNullSpaceDestroy(PCNullSpace); 61 extern int PCNullSpaceRemove(PCNullSpace,Vec); 62 63 /* options specific to particular preconditioners */ 64 extern int PCSORSetSymmetric(PC, MatSORType); 65 extern int PCSORSetOmega(PC, double); 66 extern int PCEisenstatSetOmega(PC, double); 67 extern int PCSORSetIterations(PC, int); 68 69 typedef enum {PCBGS_FORWARD_SWEEP=1,PCBGS_SYMMETRIC_SWEEP=2} PCBGSType; 70 extern int PCBGSSetSymmetric(PC, PCBGSType); 71 72 #define USE_PRECONDITIONER_MATRIX 0 73 #define USE_TRUE_MATRIX 1 74 extern int PCBJacobiSetUseTrueLocal(PC); 75 extern int PCBJacobiSetTotalBlocks(PC, int, int*); 76 extern int PCBJacobiSetLocalBlocks(PC, int, int*); 77 78 extern int PCBGSSetUseTrueLocal(PC); 79 extern int PCBGSSetTotalBlocks(PC, int, int*); 80 extern int PCBGSSetLocalBlocks(PC, int, int*); 81 extern int PCBGSSetSymmetric(PC, PCBGSType); 82 83 extern int PCShellSetApply(PC, int (*)(void*,Vec,Vec), void*); 84 extern int PCShellSetApplyRichardson(PC,int (*)(void*,Vec,Vec,Vec,int),void*); 85 extern int PCShellSetName(PC,char*); 86 extern int PCShellGetName(PC,char**); 87 88 extern int PCLUSetUseInPlace(PC); 89 extern int PCILUSetUseInPlace(PC); 90 extern int PCILUSetLevels(PC,int); 91 extern int PCILUSetReuseReordering(PC,PetscTruth); 92 extern int PCILUSetUseDropTolerance(PC,double,int); 93 extern int PCILUSetReuseFill(PC,PetscTruth); 94 95 extern int PCEisenstatUseDiagonalScaling(PC); 96 97 extern int PCASMSetLocalSubdomains(PC, int, IS *); 98 extern int PCASMSetTotalSubdomains(PC, int, IS *); 99 extern int PCASMSetOverlap(PC, int); 100 101 extern int PCASMCreateSubdomains2D(int,int,int,int,int,int,int *,IS **); 102 #endif 103 104