1*77c4ece6SBarry Smith /* $Id: pc.h,v 1.55 1996/03/04 05:17:33 bsmith Exp bsmith $ */ 2d03aef70SBarry Smith 3d03aef70SBarry Smith /* 4f26ada1bSBarry Smith Preconditioner module. Defines the preconditioner routines. 5d03aef70SBarry Smith */ 6d03aef70SBarry Smith #if !defined(__PC_PACKAGE) 7d03aef70SBarry Smith #define __PC_PACKAGE 8d03aef70SBarry Smith #include "petsc.h" 9d03aef70SBarry Smith #include "mat.h" 10d03aef70SBarry Smith 11070d5079SBarry Smith typedef enum { PCNONE, PCJACOBI, PCSOR, PCLU, PCSHELL, PCBJACOBI, PCMG, 124b0e389bSBarry Smith PCEISENSTAT, PCILU, PCICC, PCASM, PCBGS } PCType; 13d03aef70SBarry Smith 14d03aef70SBarry Smith typedef struct _PC* PC; 159e25ed09SBarry Smith #define PC_COOKIE PETSC_COOKIE+9 16d03aef70SBarry Smith 1721e95762SBarry Smith typedef struct _PCNullSpace* PCNullSpace; 1821e95762SBarry Smith #define PCNULLSPACE_COOKIE PETSC_COOKIE+17 1921e95762SBarry Smith 20aad2872bSLois Curfman McInnes typedef enum { PC_LEFT, PC_RIGHT, PC_SYMMETRIC } PCSide; 2172b7852fSLois Curfman McInnes 226b5873e3SBarry Smith extern int PCCreate(MPI_Comm,PC*); 234b0e389bSBarry Smith extern int PCSetType(PC,PCType); 248ed539a5SBarry Smith extern int PCSetUp(PC); 256d84be18SBarry Smith extern int PCSetUpOnBlocks(PC); 26aabeff55SBarry Smith extern int PCApply(PC,Vec,Vec); 27*77c4ece6SBarry Smith extern int PCApplySymmetricLeft(PC,Vec,Vec); 28*77c4ece6SBarry Smith extern int PCApplySymmetricRight(PC,Vec,Vec); 29aad2872bSLois Curfman McInnes extern int PCApplyBAorAB(PC,PCSide,Vec,Vec,Vec); 30aabeff55SBarry Smith extern int PCApplyTrans(PC,Vec,Vec); 31aad2872bSLois Curfman McInnes extern int PCApplyBAorABTrans(PC,PCSide,Vec,Vec,Vec); 32aabeff55SBarry Smith extern int PCApplyRichardson(PC,Vec,Vec,Vec,int); 33*77c4ece6SBarry Smith extern int PCApplyRichardsonExists(PC,PetscTruth*); 348ed539a5SBarry Smith extern int PCRegisterAll(); 35d6dfbf8fSBarry Smith extern int PCRegisterDestroy(); 364b0e389bSBarry Smith extern int PCRegister(PCType,char *,int (*)(PC)); 378ed539a5SBarry Smith extern int PCDestroy(PC); 388ed539a5SBarry Smith extern int PCSetFromOptions(PC); 394b0e389bSBarry Smith extern int PCGetType(PC,PCType*,char**); 40291315efSLois Curfman McInnes extern int PCGetFactoredMatrix(PC,Mat*); 415b116368SBarry Smith 4215c3ef5cSLois Curfman McInnes typedef enum {SAME_NONZERO_PATTERN=0,DIFFERENT_NONZERO_PATTERN=1,SAME_PRECONDITIONER=2} 43112a2221SBarry Smith MatStructure; 4496e03844SLois Curfman McInnes extern int PCSetOperators(PC,Mat,Mat,MatStructure); 454b0e389bSBarry Smith extern int PCGetOperators(PC,Mat*,Mat*,MatStructure*); 464b0e389bSBarry Smith 478ed539a5SBarry Smith extern int PCSetVector(PC,Vec); 488ed539a5SBarry Smith extern int PCPrintHelp(PC); 49023758ceSLois Curfman McInnes extern int PCView(PC,Viewer); 507bc3d0afSSatish Balay 511eb62cbbSBarry Smith extern int PCSetOptionsPrefix(PC,char*); 520985bb82SSatish Balay extern int PCAppendOptionsPrefix(PC,char*); 530985bb82SSatish Balay extern int PCGetOptionsPrefix(PC,char**); 548ed539a5SBarry Smith 554b0e389bSBarry Smith extern int PCNullSpaceCreate(MPI_Comm,int,int,Vec *,PCNullSpace*); 564b0e389bSBarry Smith extern int PCNullSpaceDestroy(PCNullSpace); 574b0e389bSBarry Smith extern int PCNullSpaceRemove(PCNullSpace,Vec); 584b0e389bSBarry Smith 594b0e389bSBarry Smith /* options specific to particular preconditioners */ 60ddda3453SLois Curfman McInnes extern int PCSORSetSymmetric(PC, MatSORType); 618ed539a5SBarry Smith extern int PCSORSetOmega(PC, double); 625b116368SBarry Smith extern int PCEisenstatSetOmega(PC, double); 6320563c6bSBarry Smith extern int PCSORSetIterations(PC, int); 64d03aef70SBarry Smith 65d171954fSSatish Balay typedef enum {BGS_FORWARD_SWEEP=1,BGS_SYMMETRIC_SWEEP=2} PCBGSType; 66b4fd4287SBarry Smith extern int PCBGSSetSymmetric(PC, PCBGSType); 67b4fd4287SBarry Smith 6849c46530SBarry Smith extern int PCBJacobiSetUseTrueLocal(PC); 6949c46530SBarry Smith extern int PCBJacobiSetTotalBlocks(PC, int, int*,int*); 7049c46530SBarry Smith extern int PCBJacobiSetLocalBlocks(PC, int, int*,int*); 711eb62cbbSBarry Smith 727daf8ffeSSatish Balay extern int PCBGSSetUseTrueLocal(PC); 737daf8ffeSSatish Balay extern int PCBGSSetTotalBlocks(PC, int, int*,int*); 747daf8ffeSSatish Balay extern int PCBGSSetLocalBlocks(PC, int, int*,int*); 757daf8ffeSSatish Balay extern int PCBGSSetSymmetric(PC, PCBGSType); 767daf8ffeSSatish Balay 77aabeff55SBarry Smith extern int PCShellSetApply(PC, int (*)(void*,Vec,Vec), void*); 78f0479e8cSBarry Smith extern int PCShellSetApplyRichardson(PC,int (*)(void*,Vec,Vec,Vec,int),void*); 795f789019SLois Curfman McInnes extern int PCShellSetName(PC,char*); 805f789019SLois Curfman McInnes extern int PCShellGetName(PC,char**); 81aabeff55SBarry Smith 820213d9f2SLois Curfman McInnes extern int PCLUSetUseInPlace(PC); 830213d9f2SLois Curfman McInnes extern int PCILUSetUseInPlace(PC); 849e25ed09SBarry Smith extern int PCILUSetLevels(PC,int); 8524a74354SBarry Smith extern int PCEisenstatUseDiagonalScaling(PC); 869e25ed09SBarry Smith 876d84be18SBarry Smith extern int PCASMSetLocalSubdomains(PC, int, IS *); 886d84be18SBarry Smith extern int PCASMSetTotalSubdomains(PC, int, IS *); 89de55ef05SSatish Balay extern int PCASMSetOverlap(PC, int); 90*77c4ece6SBarry Smith 91*77c4ece6SBarry Smith extern int PCASMCreateSubdomains2D(int,int,int,int,int,int,int *,IS **); 92d03aef70SBarry Smith #endif 93da3a660dSBarry Smith 94