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