1*4b0e389bSBarry Smith /* $Id: pc.h,v 1.41 1995/12/21 18:34:37 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, 12*4b0e389bSBarry 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 206b5873e3SBarry Smith extern int PCCreate(MPI_Comm,PC*); 21*4b0e389bSBarry Smith extern int PCSetType(PC,PCType); 228ed539a5SBarry Smith extern int PCSetUp(PC); 23aabeff55SBarry Smith extern int PCApply(PC,Vec,Vec); 24aabeff55SBarry Smith extern int PCApplyBAorAB(PC,int,Vec,Vec,Vec); 25aabeff55SBarry Smith extern int PCApplyTrans(PC,Vec,Vec); 26aabeff55SBarry Smith extern int PCApplyBAorABTrans(PC,int,Vec,Vec,Vec); 27aabeff55SBarry Smith extern int PCApplyRichardson(PC,Vec,Vec,Vec,int); 288ed539a5SBarry Smith extern int PCApplyRichardsonExists(PC); 298ed539a5SBarry Smith extern int PCRegisterAll(); 30d6dfbf8fSBarry Smith extern int PCRegisterDestroy(); 31*4b0e389bSBarry Smith extern int PCRegister(PCType,char *,int (*)(PC)); 328ed539a5SBarry Smith extern int PCDestroy(PC); 338ed539a5SBarry Smith extern int PCSetFromOptions(PC); 34*4b0e389bSBarry Smith extern int PCGetType(PC,PCType*,char**); 35291315efSLois Curfman McInnes extern int PCGetFactoredMatrix(PC,Mat*); 365b116368SBarry Smith 3796e03844SLois Curfman McInnes typedef enum {ALLMAT_DIFFERENT_NONZERO_PATTERN=0,MAT_SAME_NONZERO_PATTERN=1, 38f26ada1bSBarry Smith PMAT_SAME_NONZERO_PATTERN=2,ALLMAT_SAME_NONZERO_PATTERN=3} MatStructure; 3996e03844SLois Curfman McInnes extern int PCSetOperators(PC,Mat,Mat,MatStructure); 40*4b0e389bSBarry Smith extern int PCGetOperators(PC,Mat*,Mat*,MatStructure*); 41*4b0e389bSBarry Smith 428ed539a5SBarry Smith extern int PCSetVector(PC,Vec); 438ed539a5SBarry Smith extern int PCPrintHelp(PC); 44023758ceSLois Curfman McInnes extern int PCView(PC,Viewer); 451eb62cbbSBarry Smith extern int PCSetOptionsPrefix(PC,char*); 468ed539a5SBarry Smith 47*4b0e389bSBarry Smith extern int PCNullSpaceCreate(MPI_Comm,int,int,Vec *,PCNullSpace*); 48*4b0e389bSBarry Smith extern int PCNullSpaceDestroy(PCNullSpace); 49*4b0e389bSBarry Smith extern int PCNullSpaceRemove(PCNullSpace,Vec); 50*4b0e389bSBarry Smith 51*4b0e389bSBarry Smith /* options specific to particular preconditioners */ 52ddda3453SLois Curfman McInnes extern int PCSORSetSymmetric(PC, MatSORType); 538ed539a5SBarry Smith extern int PCSORSetOmega(PC, double); 545b116368SBarry Smith extern int PCEisenstatSetOmega(PC, double); 5520563c6bSBarry Smith extern int PCSORSetIterations(PC, int); 56d03aef70SBarry Smith 57b4fd4287SBarry Smith typedef enum {BGS_FORWARD_SWEEP=1,BGS_BACKWARD_SWEEP=2,BGS_SYMMETRIC_SWEEP=3} PCBGSType; 58b4fd4287SBarry Smith extern int PCBGSSetSymmetric(PC, PCBGSType); 59b4fd4287SBarry Smith 6049c46530SBarry Smith #define USE_PRECONDITIONER_MATRIX 0 6149c46530SBarry Smith #define USE_TRUE_MATRIX 1 6249c46530SBarry Smith 6349c46530SBarry Smith extern int PCBJacobiSetUseTrueLocal(PC); 6449c46530SBarry Smith extern int PCBJacobiSetTotalBlocks(PC, int, int*,int*); 6549c46530SBarry Smith extern int PCBJacobiSetLocalBlocks(PC, int, int*,int*); 661eb62cbbSBarry Smith 67e3e2a4cfSLois Curfman McInnes extern int PCBSIterSetBlockSolve(PC); 687d5e31e2SLois Curfman McInnes extern int PCBSIterSetFromOptions(PC); 69e3e2a4cfSLois Curfman McInnes extern int PCBSIterSolve(PC,Vec,Vec,int*); 70c06847eeSLois Curfman McInnes 71aabeff55SBarry Smith extern int PCShellSetApply(PC, int (*)(void*,Vec,Vec), void*); 72f0479e8cSBarry Smith extern int PCShellSetApplyRichardson(PC,int (*)(void*,Vec,Vec,Vec,int),void*); 73aabeff55SBarry Smith 740213d9f2SLois Curfman McInnes extern int PCLUSetUseInPlace(PC); 750213d9f2SLois Curfman McInnes extern int PCILUSetUseInPlace(PC); 769e25ed09SBarry Smith extern int PCILUSetLevels(PC,int); 7724a74354SBarry Smith extern int PCEisenstatUseDiagonalScaling(PC); 789e25ed09SBarry Smith 79d7e8b826SBarry Smith extern int PCASMCreateSubdomains2D(int,int,int,int,int,int,int *,IS **); 80d7e8b826SBarry Smith extern int PCASMSetSubdomains(PC, int, IS *); 8160907fceSBarry Smith 82d03aef70SBarry Smith #endif 83da3a660dSBarry Smith 84