1 /* $Id: pc.h,v 1.53 1996/02/08 18:28:49 bsmith 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 PCApply(PC,Vec,Vec); 26 extern int PCApplySymmLeft(PC,Vec,Vec); 27 extern int PCApplySymmRight(PC,Vec,Vec); 28 extern int PCApplyBAorAB(PC,PCSide,Vec,Vec,Vec); 29 extern int PCApplyTrans(PC,Vec,Vec); 30 extern int PCApplyBAorABTrans(PC,PCSide,Vec,Vec,Vec); 31 extern int PCApplyRichardson(PC,Vec,Vec,Vec,int); 32 extern int PCApplyRichardsonExists(PC); 33 extern int PCRegisterAll(); 34 extern int PCRegisterDestroy(); 35 extern int PCRegister(PCType,char *,int (*)(PC)); 36 extern int PCDestroy(PC); 37 extern int PCSetFromOptions(PC); 38 extern int PCGetType(PC,PCType*,char**); 39 extern int PCGetFactoredMatrix(PC,Mat*); 40 41 typedef enum {SAME_NONZERO_PATTERN=0,DIFFERENT_NONZERO_PATTERN=1,SAME_PRECONDITIONER=2} 42 MatStructure; 43 extern int PCSetOperators(PC,Mat,Mat,MatStructure); 44 extern int PCGetOperators(PC,Mat*,Mat*,MatStructure*); 45 46 extern int PCSetVector(PC,Vec); 47 extern int PCPrintHelp(PC); 48 extern int PCView(PC,Viewer); 49 50 extern int PCSetOptionsPrefix(PC,char*); 51 extern int PCAppendOptionsPrefix(PC,char*); 52 extern int PCGetOptionsPrefix(PC,char**); 53 54 extern int PCNullSpaceCreate(MPI_Comm,int,int,Vec *,PCNullSpace*); 55 extern int PCNullSpaceDestroy(PCNullSpace); 56 extern int PCNullSpaceRemove(PCNullSpace,Vec); 57 58 /* options specific to particular preconditioners */ 59 extern int PCSORSetSymmetric(PC, MatSORType); 60 extern int PCSORSetOmega(PC, double); 61 extern int PCEisenstatSetOmega(PC, double); 62 extern int PCSORSetIterations(PC, int); 63 64 typedef enum {BGS_FORWARD_SWEEP=1,BGS_SYMMETRIC_SWEEP=2} PCBGSType; 65 extern int PCBGSSetSymmetric(PC, PCBGSType); 66 67 #define USE_PRECONDITIONER_MATRIX 0 68 #define USE_TRUE_MATRIX 1 69 70 extern int PCBJacobiSetUseTrueLocal(PC); 71 extern int PCBJacobiSetTotalBlocks(PC, int, int*,int*); 72 extern int PCBJacobiSetLocalBlocks(PC, int, int*,int*); 73 74 extern int PCBGSSetUseTrueLocal(PC); 75 extern int PCBGSSetTotalBlocks(PC, int, int*,int*); 76 extern int PCBGSSetLocalBlocks(PC, int, int*,int*); 77 extern int PCBGSSetSymmetric(PC, PCBGSType); 78 79 extern int PCBSIterSetBlockSolve(PC); 80 extern int PCBSIterSetFromOptions(PC); 81 extern int PCBSIterSolve(PC,Vec,Vec,int*); 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 PCEisenstatUseDiagonalScaling(PC); 92 93 extern int PCASMCreateSubdomains2D(int,int,int,int,int,int,int *,IS **); 94 extern int PCASMSetSubdomains(PC, int, IS *); 95 extern int PCASMSetOverlap(PC, int); 96 #endif 97 98