Actual source code: petscpc.h
1: /* $Id: petscpc.h,v 1.122 2001/08/21 21:03:12 bsmith Exp $ */
3: /*
4: Preconditioner module.
5: */
8: #include petscmat.h
10: /*
11: PCList contains the list of preconditioners currently registered
12: These are added with the PCRegisterDynamic() macro
13: */
14: extern PetscFList PCList;
15: typedef char *PCType;
17: /*S
18: PC - Abstract PETSc object that manages all preconditioners
20: Level: beginner
22: Concepts: preconditioners
24: .seealso: PCCreate(), PCSetType(), PCType
25: S*/
26: typedef struct _p_PC* PC;
28: /*E
29: PCType - String with the name of a PETSc preconditioner method or the creation function
30: with an optional dynamic library name, for example
31: http://www.mcs.anl.gov/petsc/lib.a:mypccreate()
33: Level: beginner
35: .seealso: PCSetType(), PC
36: E*/
37: #define PCNONE "none"
38: #define PCJACOBI "jacobi"
39: #define PCSOR "sor"
40: #define PCLU "lu"
41: #define PCSHELL "shell"
42: #define PCBJACOBI "bjacobi"
43: #define PCMG "mg"
44: #define PCEISENSTAT "eisenstat"
45: #define PCILU "ilu"
46: #define PCICC "icc"
47: #define PCASM "asm"
48: #define PCSLES "sles"
49: #define PCCOMPOSITE "composite"
50: #define PCREDUNDANT "redundant"
51: #define PCSPAI "spai"
52: #define PCMILU "milu"
53: #define PCNN "nn"
54: #define PCCHOLESKY "cholesky"
55: #define PCRAMG "ramg"
56: #define PCPBJACOBI "pbjacobi"
57: #define PCMULTILEVEL "multilevel"
58: #define PCSCHUR "schur"
59: #define PCESI "esi"
60: #define PCPETSCESI "petscesi"
61: #define PCMAT "mat"
62: #define PCHYPRE "hypre"
64: /* Logging support */
65: extern int PC_COOKIE;
66: extern int PC_SetUp, PC_SetUpOnBlocks, PC_Apply, PC_ApplyCoarse, PC_ApplyMultiple, PC_ApplySymmetricLeft;
67: extern int PC_ApplySymmetricRight, PC_ModifySubMatrices;
69: /*E
70: PCSide - If the preconditioner is to be applied to the left, right
71: or symmetrically around the operator.
73: Level: beginner
75: .seealso:
76: E*/
77: typedef enum { PC_LEFT,PC_RIGHT,PC_SYMMETRIC } PCSide;
79: EXTERN int PCCreate(MPI_Comm,PC*);
80: EXTERN int PCSetType(PC,PCType);
81: EXTERN int PCSetUp(PC);
82: EXTERN int PCSetUpOnBlocks(PC);
83: EXTERN int PCApply(PC,Vec,Vec);
84: EXTERN int PCApplySymmetricLeft(PC,Vec,Vec);
85: EXTERN int PCApplySymmetricRight(PC,Vec,Vec);
86: EXTERN int PCApplyBAorAB(PC,PCSide,Vec,Vec,Vec);
87: EXTERN int PCApplyTranspose(PC,Vec,Vec);
88: EXTERN int PCApplyBAorABTranspose(PC,PCSide,Vec,Vec,Vec);
89: EXTERN int PCApplyRichardson(PC,Vec,Vec,Vec,PetscReal,PetscReal,PetscReal,int);
90: EXTERN int PCApplyRichardsonExists(PC,PetscTruth*);
92: EXTERN int PCRegisterDestroy(void);
93: EXTERN int PCRegisterAll(char*);
94: extern PetscTruth PCRegisterAllCalled;
96: EXTERN int PCRegister(char*,char*,char*,int(*)(PC));
97: #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
98: #define PCRegisterDynamic(a,b,c,d) PCRegister(a,b,c,0)
99: #else
100: #define PCRegisterDynamic(a,b,c,d) PCRegister(a,b,c,d)
101: #endif
103: EXTERN int PCDestroy(PC);
104: EXTERN int PCSetFromOptions(PC);
105: EXTERN int PCESISetFromOptions(PC);
106: EXTERN int PCGetType(PC,PCType*);
108: EXTERN int PCGetFactoredMatrix(PC,Mat*);
109: EXTERN int PCSetModifySubMatrices(PC,int(*)(PC,int,IS*,IS*,Mat*,void*),void*);
110: EXTERN int PCModifySubMatrices(PC,int,IS*,IS*,Mat*,void*);
112: EXTERN int PCSetOperators(PC,Mat,Mat,MatStructure);
113: EXTERN int PCGetOperators(PC,Mat*,Mat*,MatStructure*);
115: EXTERN int PCSetVector(PC,Vec);
116: EXTERN int PCGetVector(PC,Vec*);
117: EXTERN int PCView(PC,PetscViewer);
119: EXTERN int PCSetOptionsPrefix(PC,char*);
120: EXTERN int PCAppendOptionsPrefix(PC,char*);
121: EXTERN int PCGetOptionsPrefix(PC,char**);
123: EXTERN int PCNullSpaceAttach(PC,MatNullSpace);
125: EXTERN int PCComputeExplicitOperator(PC,Mat*);
127: /*
128: These are used to provide extra scaling of preconditioned
129: operator for time-stepping schemes like in PVODE
130: */
131: EXTERN int PCDiagonalScale(PC,PetscTruth*);
132: EXTERN int PCDiagonalScaleLeft(PC,Vec,Vec);
133: EXTERN int PCDiagonalScaleRight(PC,Vec,Vec);
134: EXTERN int PCDiagonalScaleSet(PC,Vec);
136: /* ------------- options specific to particular preconditioners --------- */
138: EXTERN int PCJacobiSetUseRowMax(PC);
139: EXTERN int PCSORSetSymmetric(PC,MatSORType);
140: EXTERN int PCSORSetOmega(PC,PetscReal);
141: EXTERN int PCSORSetIterations(PC,int,int);
143: EXTERN int PCEisenstatSetOmega(PC,PetscReal);
144: EXTERN int PCEisenstatNoDiagonalScaling(PC);
146: #define USE_PRECONDITIONER_MATRIX 0
147: #define USE_TRUE_MATRIX 1
148: EXTERN int PCBJacobiSetUseTrueLocal(PC);
149: EXTERN int PCBJacobiSetTotalBlocks(PC,int,int*);
150: EXTERN int PCBJacobiSetLocalBlocks(PC,int,int*);
152: EXTERN int PCSLESSetUseTrue(PC);
154: EXTERN int PCShellSetApply(PC,int (*)(void*,Vec,Vec),void*);
155: EXTERN int PCShellSetSetUp(PC,int (*)(void*));
156: EXTERN int PCShellSetApplyRichardson(PC,int (*)(void*,Vec,Vec,Vec,PetscReal,PetscReal,PetscReal,int),void*);
157: EXTERN int PCShellSetView(PC,int (*)(void*,PetscViewer));
158: EXTERN int PCShellSetName(PC,char*);
159: EXTERN int PCShellGetName(PC,char**);
161: EXTERN int PCLUSetMatOrdering(PC,MatOrderingType);
162: EXTERN int PCLUSetReuseOrdering(PC,PetscTruth);
163: EXTERN int PCLUSetReuseFill(PC,PetscTruth);
164: EXTERN int PCLUSetUseInPlace(PC);
165: EXTERN int PCLUSetFill(PC,PetscReal);
166: EXTERN int PCLUSetDamping(PC,PetscReal);
167: EXTERN int PCLUSetPivoting(PC,PetscReal);
168: EXTERN int PCLUSetPivotInBlocks(PC,PetscTruth);
170: EXTERN int PCCholeskySetMatOrdering(PC,MatOrderingType);
171: EXTERN int PCCholeskySetReuseOrdering(PC,PetscTruth);
172: EXTERN int PCCholeskySetReuseFill(PC,PetscTruth);
173: EXTERN int PCCholeskySetUseInPlace(PC);
174: EXTERN int PCCholeskySetFill(PC,PetscReal);
175: EXTERN int PCCholeskySetDamping(PC,PetscReal);
176: EXTERN int PCCholeskySetPivotInBlocks(PC,PetscTruth);
178: EXTERN int PCILUSetMatOrdering(PC,MatOrderingType);
179: EXTERN int PCILUSetUseInPlace(PC);
180: EXTERN int PCILUSetFill(PC,PetscReal);
181: EXTERN int PCILUSetLevels(PC,int);
182: EXTERN int PCILUSetReuseOrdering(PC,PetscTruth);
183: EXTERN int PCILUSetUseDropTolerance(PC,PetscReal,PetscReal,int);
184: EXTERN int PCILUDTSetReuseFill(PC,PetscTruth);
185: EXTERN int PCILUSetAllowDiagonalFill(PC);
186: EXTERN int PCILUSetDamping(PC,PetscReal);
187: EXTERN int PCILUSetSinglePrecisionSolves(PC,PetscTruth);
188: EXTERN int PCILUSetPivotInBlocks(PC,PetscTruth);
190: EXTERN int PCICCSetMatOrdering(PC,MatOrderingType);
191: EXTERN int PCICCSetFill(PC,PetscReal);
192: EXTERN int PCICCSetLevels(PC,int);
193: EXTERN int PCICCSetPivotInBlocks(PC,PetscTruth);
195: EXTERN int PCASMSetLocalSubdomains(PC,int,IS *);
196: EXTERN int PCASMSetTotalSubdomains(PC,int,IS *);
197: EXTERN int PCASMSetOverlap(PC,int);
198: /*E
199: PCASMType - Type of additive Schwarz method to use
201: $ PC_ASM_BASIC - symmetric version where residuals from the ghost points are used
202: $ and computed values in ghost regions are added together. Classical
203: $ standard additive Schwarz
204: $ PC_ASM_RESTRICT - residuals from ghost points are used but computed values in ghost
205: $ region are discarded. Default
206: $ PC_ASM_INTERPOLATE - residuals from ghost points are not used, computed values in ghost
207: $ region are added back in
208: $ PC_ASM_NONE - ghost point residuals are not used, computed ghost values are discarded
209: $ not very good.
211: Level: beginner
213: .seealso: PCASMSetType()
214: E*/
215: typedef enum {PC_ASM_BASIC = 3,PC_ASM_RESTRICT = 1,PC_ASM_INTERPOLATE = 2,PC_ASM_NONE = 0} PCASMType;
216: EXTERN int PCASMSetType(PC,PCASMType);
217: EXTERN int PCASMCreateSubdomains2D(int,int,int,int,int,int,int *,IS **);
218: EXTERN int PCASMSetUseInPlace(PC);
219: EXTERN int PCASMGetLocalSubdomains(PC,int*,IS**);
220: EXTERN int PCASMGetLocalSubmatrices(PC,int*,Mat**);
222: /*E
223: PCCompositeType - Determines how two or more preconditioner are composed
225: $ PC_COMPOSITE_ADDITIVE - results from application of all preconditioners are added together
226: $ PC_COMPOSITE_MULTIPLICATIVE - preconditioners are applied sequentially to the residual freshly
227: $ computed after the previous preconditioner application
228: $ PC_COMPOSITE_SPECIAL - This is very special for a matrix of the form alpha I + R + S
229: $ where first preconditioner is built from alpha I + S and second from
230: $ alpha I + R
232: Level: beginner
234: .seealso: PCCompositeSetType()
235: E*/
236: typedef enum {PC_COMPOSITE_ADDITIVE,PC_COMPOSITE_MULTIPLICATIVE,PC_COMPOSITE_SPECIAL} PCCompositeType;
237: EXTERN int PCCompositeSetUseTrue(PC);
238: EXTERN int PCCompositeSetType(PC,PCCompositeType);
239: EXTERN int PCCompositeAddPC(PC,PCType);
240: EXTERN int PCCompositeGetPC(PC pc,int n,PC *);
241: EXTERN int PCCompositeSpecialSetAlpha(PC,PetscScalar);
243: EXTERN int PCRedundantSetScatter(PC,VecScatter,VecScatter);
244: EXTERN int PCRedundantGetOperators(PC,Mat*,Mat*);
245: EXTERN int PCRedundantGetPC(PC,PC*);
246: EXTERN int MatGetOrderingList(PetscFList *list);
248: EXTERN int PCMultiLevelSetFields(PC, int, int);
249: EXTERN int PCMultiLevelSetNonlinearIterate(PC, Vec);
250: EXTERN int PCMultiLevelSetGradientOperator(PC, int, int, PetscScalar);
251: EXTERN int PCMultiLevelApplyGradient(PC, Vec, Vec);
252: EXTERN int PCMultiLevelApplyGradientTrans(PC, Vec, Vec);
253: EXTERN int PCMultiLevelBuildSolution(PC, Vec);
254: EXTERN int PCMultiLevelGetMultiplier(PC, Vec, Vec);
256: EXTERN int PCSchurSetGradientOperator(PC, int, int);
257: EXTERN int PCSchurGetIterationNumber(PC, int *, int *);
259: EXTERN int PCSPAISetEpsilon(PC,double);
260: EXTERN int PCSPAISetNBSteps(PC,int);
261: EXTERN int PCSPAISetMax(PC,int);
262: EXTERN int PCSPAISetMaxNew(PC,int);
263: EXTERN int PCSPAISetBlockSize(PC,int);
264: EXTERN int PCSPAISetCacheSize(PC,int);
265: EXTERN int PCSPAISetVerbose(PC,int);
266: EXTERN int PCSPAISetSp(PC,int);
272: #endif /* __PETSCPC_H */