petsc/include/petscpc.h

*0985bb82SSatish Balay/* $Id: pc.h,v 1.48 1996/01/09 15:05:40 curfman Exp balay $ */
d03aef70SBarry Smith
d03aef70SBarry Smith/*
f26ada1bSBarry Smith      Preconditioner module. Defines the preconditioner routines.
d03aef70SBarry Smith*/
d03aef70SBarry Smith#if !defined(__PC_PACKAGE)
d03aef70SBarry Smith#define __PC_PACKAGE
d03aef70SBarry Smith#include "petsc.h"
d03aef70SBarry Smith#include "mat.h"
d03aef70SBarry Smith
070d5079SBarry Smithtypedef enum { PCNONE, PCJACOBI, PCSOR, PCLU, PCSHELL, PCBJACOBI, PCMG,
4b0e389bSBarry Smith               PCEISENSTAT, PCILU, PCICC, PCASM, PCBGS } PCType;
d03aef70SBarry Smith
d03aef70SBarry Smithtypedef struct _PC* PC;
9e25ed09SBarry Smith#define PC_COOKIE    PETSC_COOKIE+9
d03aef70SBarry Smith
21e95762SBarry Smithtypedef struct _PCNullSpace* PCNullSpace;
21e95762SBarry Smith#define PCNULLSPACE_COOKIE    PETSC_COOKIE+17
21e95762SBarry Smith
aad2872bSLois Curfman McInnestypedef enum { PC_LEFT, PC_RIGHT, PC_SYMMETRIC } PCSide;
72b7852fSLois Curfman McInnes
6b5873e3SBarry Smithextern int    PCCreate(MPI_Comm,PC*);
4b0e389bSBarry Smithextern int    PCSetType(PC,PCType);
8ed539a5SBarry Smithextern int    PCSetUp(PC);
aabeff55SBarry Smithextern int    PCApply(PC,Vec,Vec);
9f0e5d82SLois Curfman McInnesextern int    PCApplySymmLeft(PC,Vec,Vec);
9f0e5d82SLois Curfman McInnesextern int    PCApplySymmRight(PC,Vec,Vec);
aad2872bSLois Curfman McInnesextern int    PCApplyBAorAB(PC,PCSide,Vec,Vec,Vec);
aabeff55SBarry Smithextern int    PCApplyTrans(PC,Vec,Vec);
aad2872bSLois Curfman McInnesextern int    PCApplyBAorABTrans(PC,PCSide,Vec,Vec,Vec);
aabeff55SBarry Smithextern int    PCApplyRichardson(PC,Vec,Vec,Vec,int);
8ed539a5SBarry Smithextern int    PCApplyRichardsonExists(PC);
8ed539a5SBarry Smithextern int    PCRegisterAll();
d6dfbf8fSBarry Smithextern int    PCRegisterDestroy();
4b0e389bSBarry Smithextern int    PCRegister(PCType,char *,int (*)(PC));
8ed539a5SBarry Smithextern int    PCDestroy(PC);
8ed539a5SBarry Smithextern int    PCSetFromOptions(PC);
4b0e389bSBarry Smithextern int    PCGetType(PC,PCType*,char**);
291315efSLois Curfman McInnesextern int    PCGetFactoredMatrix(PC,Mat*);
5b116368SBarry Smith
96e03844SLois Curfman McInnestypedef enum {ALLMAT_DIFFERENT_NONZERO_PATTERN=0,MAT_SAME_NONZERO_PATTERN=1,
f26ada1bSBarry Smith              PMAT_SAME_NONZERO_PATTERN=2,ALLMAT_SAME_NONZERO_PATTERN=3} MatStructure;
96e03844SLois Curfman McInnesextern int PCSetOperators(PC,Mat,Mat,MatStructure);
4b0e389bSBarry Smithextern int PCGetOperators(PC,Mat*,Mat*,MatStructure*);
4b0e389bSBarry Smith
8ed539a5SBarry Smithextern int PCSetVector(PC,Vec);
8ed539a5SBarry Smithextern int PCPrintHelp(PC);
023758ceSLois Curfman McInnesextern int PCView(PC,Viewer);
1eb62cbbSBarry Smithextern int PCSetOptionsPrefix(PC,char*);
*0985bb82SSatish Balayextern int PCAppendOptionsPrefix(PC,char*);
*0985bb82SSatish Balayextern int PCGetOptionsPrefix(PC,char**);
8ed539a5SBarry Smith
4b0e389bSBarry Smithextern int PCNullSpaceCreate(MPI_Comm,int,int,Vec *,PCNullSpace*);
4b0e389bSBarry Smithextern int PCNullSpaceDestroy(PCNullSpace);
4b0e389bSBarry Smithextern int PCNullSpaceRemove(PCNullSpace,Vec);
4b0e389bSBarry Smith
4b0e389bSBarry Smith/* options specific to particular preconditioners */
ddda3453SLois Curfman McInnesextern int PCSORSetSymmetric(PC, MatSORType);
8ed539a5SBarry Smithextern int PCSORSetOmega(PC, double);
5b116368SBarry Smithextern int PCEisenstatSetOmega(PC, double);
20563c6bSBarry Smithextern int PCSORSetIterations(PC, int);
d03aef70SBarry Smith
d171954fSSatish Balaytypedef enum {BGS_FORWARD_SWEEP=1,BGS_SYMMETRIC_SWEEP=2} PCBGSType;
b4fd4287SBarry Smithextern int PCBGSSetSymmetric(PC, PCBGSType);
b4fd4287SBarry Smith
49c46530SBarry Smith#define USE_PRECONDITIONER_MATRIX 0
49c46530SBarry Smith#define USE_TRUE_MATRIX           1
49c46530SBarry Smith
49c46530SBarry Smithextern int PCBJacobiSetUseTrueLocal(PC);
49c46530SBarry Smithextern int PCBJacobiSetTotalBlocks(PC, int, int*,int*);
49c46530SBarry Smithextern int PCBJacobiSetLocalBlocks(PC, int, int*,int*);
1eb62cbbSBarry Smith
7daf8ffeSSatish Balayextern int PCBGSSetUseTrueLocal(PC);
7daf8ffeSSatish Balayextern int PCBGSSetTotalBlocks(PC, int, int*,int*);
7daf8ffeSSatish Balayextern int PCBGSSetLocalBlocks(PC, int, int*,int*);
7daf8ffeSSatish Balayextern int PCBGSSetSymmetric(PC, PCBGSType);
7daf8ffeSSatish Balay
e3e2a4cfSLois Curfman McInnesextern int PCBSIterSetBlockSolve(PC);
7d5e31e2SLois Curfman McInnesextern int PCBSIterSetFromOptions(PC);
e3e2a4cfSLois Curfman McInnesextern int PCBSIterSolve(PC,Vec,Vec,int*);
c06847eeSLois Curfman McInnes
aabeff55SBarry Smithextern int PCShellSetApply(PC, int (*)(void*,Vec,Vec), void*);
f0479e8cSBarry Smithextern int PCShellSetApplyRichardson(PC,int (*)(void*,Vec,Vec,Vec,int),void*);
aabeff55SBarry Smith
0213d9f2SLois Curfman McInnesextern int PCLUSetUseInPlace(PC);
0213d9f2SLois Curfman McInnesextern int PCILUSetUseInPlace(PC);
9e25ed09SBarry Smithextern int PCILUSetLevels(PC,int);
24a74354SBarry Smithextern int PCEisenstatUseDiagonalScaling(PC);
9e25ed09SBarry Smith
d7e8b826SBarry Smithextern int PCASMCreateSubdomains2D(int,int,int,int,int,int,int *,IS **);
d7e8b826SBarry Smithextern int PCASMSetSubdomains(PC, int, IS *);
60907fceSBarry Smith
d03aef70SBarry Smith#endif
da3a660dSBarry Smith