1 /* 2 Preconditioner module. 3 */ 4 #ifndef PETSCPC_H 5 #define PETSCPC_H 6 7 #include <petscmat.h> 8 #include <petscdmtypes.h> 9 #include <petscpctypes.h> 10 11 /* SUBMANSEC = PC */ 12 13 PETSC_EXTERN PetscErrorCode PCInitializePackage(void); 14 PETSC_EXTERN PetscErrorCode PCFinalizePackage(void); 15 16 /* 17 PCList contains the list of preconditioners currently registered 18 These are added with PCRegister() 19 */ 20 PETSC_EXTERN PetscFunctionList PCList; 21 22 /* Logging support */ 23 PETSC_EXTERN PetscClassId PC_CLASSID; 24 25 /* Arrays of names for options in implementation PCs */ 26 PETSC_EXTERN const char *const *const PCSides; 27 PETSC_EXTERN const char *const PCJacobiTypes[]; 28 PETSC_EXTERN const char *const PCASMTypes[]; 29 PETSC_EXTERN const char *const PCGASMTypes[]; 30 PETSC_EXTERN const char *const PCCompositeTypes[]; 31 PETSC_EXTERN const char *const PCFieldSplitSchurPreTypes[]; 32 PETSC_EXTERN const char *const PCFieldSplitSchurFactTypes[]; 33 PETSC_EXTERN const char *const PCPARMSGlobalTypes[]; 34 PETSC_EXTERN const char *const PCPARMSLocalTypes[]; 35 PETSC_EXTERN const char *const PCMGTypes[]; 36 PETSC_EXTERN const char *const PCMGCycleTypes[]; 37 PETSC_EXTERN const char *const PCMGGalerkinTypes[]; 38 PETSC_EXTERN const char *const PCMGCoarseSpaceTypes[]; 39 PETSC_EXTERN const char *const PCExoticTypes[]; 40 PETSC_EXTERN const char *const PCPatchConstructTypes[]; 41 PETSC_EXTERN const char *const PCDeflationTypes[]; 42 PETSC_EXTERN const char *const *const PCFailedReasons; 43 44 PETSC_EXTERN PetscErrorCode PCCreate(MPI_Comm, PC *); 45 PETSC_EXTERN PetscErrorCode PCSetType(PC, PCType); 46 PETSC_EXTERN PetscErrorCode PCGetType(PC, PCType *); 47 PETSC_EXTERN PetscErrorCode PCSetUp(PC); 48 49 PETSC_EXTERN PetscErrorCode PCSetKSPNestLevel(PC, PetscInt); 50 PETSC_EXTERN PetscErrorCode PCGetKSPNestLevel(PC, PetscInt *); 51 52 PETSC_EXTERN PetscErrorCode PCSetFailedReason(PC, PCFailedReason); 53 PETSC_EXTERN PetscErrorCode PCGetFailedReason(PC, PCFailedReason *); 54 PETSC_DEPRECATED_FUNCTION(3, 11, 0, "PCGetFailedReason()", ) static inline PetscErrorCode PCGetSetUpFailedReason(PC pc, PCFailedReason *reason) 55 { 56 return PCGetFailedReason(pc, reason); 57 } 58 PETSC_EXTERN PetscErrorCode PCGetFailedReasonRank(PC, PCFailedReason *); 59 PETSC_EXTERN PetscErrorCode PCReduceFailedReason(PC); 60 61 PETSC_EXTERN PetscErrorCode PCSetUpOnBlocks(PC); 62 PETSC_EXTERN PetscErrorCode PCApply(PC, Vec, Vec); 63 PETSC_EXTERN PetscErrorCode PCMatApply(PC, Mat, Mat); 64 PETSC_EXTERN PetscErrorCode PCApplySymmetricLeft(PC, Vec, Vec); 65 PETSC_EXTERN PetscErrorCode PCApplySymmetricRight(PC, Vec, Vec); 66 PETSC_EXTERN PetscErrorCode PCApplyBAorAB(PC, PCSide, Vec, Vec, Vec); 67 PETSC_EXTERN PetscErrorCode PCApplyTranspose(PC, Vec, Vec); 68 PETSC_EXTERN PetscErrorCode PCApplyTransposeExists(PC, PetscBool *); 69 PETSC_EXTERN PetscErrorCode PCApplyBAorABTranspose(PC, PCSide, Vec, Vec, Vec); 70 PETSC_EXTERN PetscErrorCode PCSetReusePreconditioner(PC, PetscBool); 71 PETSC_EXTERN PetscErrorCode PCGetReusePreconditioner(PC, PetscBool *); 72 PETSC_EXTERN PetscErrorCode PCSetErrorIfFailure(PC, PetscBool); 73 74 #define PC_FILE_CLASSID 1211222 75 76 PETSC_EXTERN PetscErrorCode PCApplyRichardson(PC, Vec, Vec, Vec, PetscReal, PetscReal, PetscReal, PetscInt, PetscBool, PetscInt *, PCRichardsonConvergedReason *); 77 PETSC_EXTERN PetscErrorCode PCApplyRichardsonExists(PC, PetscBool *); 78 PETSC_EXTERN PetscErrorCode PCSetUseAmat(PC, PetscBool); 79 PETSC_EXTERN PetscErrorCode PCGetUseAmat(PC, PetscBool *); 80 81 PETSC_EXTERN PetscErrorCode PCRegister(const char[], PetscErrorCode (*)(PC)); 82 83 PETSC_EXTERN PetscErrorCode PCReset(PC); 84 PETSC_EXTERN PetscErrorCode PCDestroy(PC *); 85 PETSC_EXTERN PetscErrorCode PCSetFromOptions(PC); 86 87 PETSC_EXTERN PetscErrorCode PCFactorGetMatrix(PC, Mat *); 88 PETSC_EXTERN PetscErrorCode PCSetModifySubMatrices(PC, PetscErrorCode (*)(PC, PetscInt, const IS[], const IS[], Mat[], void *), void *); 89 PETSC_EXTERN PetscErrorCode PCModifySubMatrices(PC, PetscInt, const IS[], const IS[], Mat[], void *); 90 91 PETSC_EXTERN PetscErrorCode PCSetOperators(PC, Mat, Mat); 92 PETSC_EXTERN PetscErrorCode PCGetOperators(PC, Mat *, Mat *); 93 PETSC_EXTERN PetscErrorCode PCGetOperatorsSet(PC, PetscBool *, PetscBool *); 94 95 PETSC_EXTERN PetscErrorCode PCView(PC, PetscViewer); 96 PETSC_EXTERN PetscErrorCode PCLoad(PC, PetscViewer); 97 PETSC_EXTERN PetscErrorCode PCViewFromOptions(PC, PetscObject, const char[]); 98 99 PETSC_EXTERN PetscErrorCode PCSetOptionsPrefix(PC, const char[]); 100 PETSC_EXTERN PetscErrorCode PCAppendOptionsPrefix(PC, const char[]); 101 PETSC_EXTERN PetscErrorCode PCGetOptionsPrefix(PC, const char *[]); 102 103 PETSC_EXTERN PetscErrorCode PCComputeOperator(PC, MatType, Mat *); 104 PETSC_DEPRECATED_FUNCTION(3, 12, 0, "PCComputeOperator()", ) static inline PetscErrorCode PCComputeExplicitOperator(PC A, Mat *B) 105 { 106 return PCComputeOperator(A, PETSC_NULLPTR, B); 107 } 108 109 /* 110 These are used to provide extra scaling of preconditioned 111 operator for time-stepping schemes like in SUNDIALS 112 */ 113 PETSC_EXTERN PetscErrorCode PCGetDiagonalScale(PC, PetscBool *); 114 PETSC_EXTERN PetscErrorCode PCDiagonalScaleLeft(PC, Vec, Vec); 115 PETSC_EXTERN PetscErrorCode PCDiagonalScaleRight(PC, Vec, Vec); 116 PETSC_EXTERN PetscErrorCode PCSetDiagonalScale(PC, Vec); 117 118 PETSC_EXTERN PetscErrorCode PCSetDM(PC, DM); 119 PETSC_EXTERN PetscErrorCode PCGetDM(PC, DM *); 120 121 PETSC_EXTERN PetscErrorCode PCGetInterpolations(PC, PetscInt *, Mat *[]); 122 PETSC_EXTERN PetscErrorCode PCGetCoarseOperators(PC pc, PetscInt *, Mat *[]); 123 124 PETSC_EXTERN PetscErrorCode PCSetCoordinates(PC, PetscInt, PetscInt, PetscReal[]); 125 126 PETSC_EXTERN PetscErrorCode PCSetApplicationContext(PC, void *); 127 PETSC_EXTERN PetscErrorCode PCGetApplicationContext(PC, void *); 128 129 /* ------------- options specific to particular preconditioners --------- */ 130 131 PETSC_EXTERN PetscErrorCode PCJacobiSetType(PC, PCJacobiType); 132 PETSC_EXTERN PetscErrorCode PCJacobiGetType(PC, PCJacobiType *); 133 PETSC_EXTERN PetscErrorCode PCJacobiSetUseAbs(PC, PetscBool); 134 PETSC_EXTERN PetscErrorCode PCJacobiGetUseAbs(PC, PetscBool *); 135 PETSC_EXTERN PetscErrorCode PCJacobiSetFixDiagonal(PC, PetscBool); 136 PETSC_EXTERN PetscErrorCode PCJacobiGetFixDiagonal(PC, PetscBool *); 137 PETSC_EXTERN PetscErrorCode PCSORSetSymmetric(PC, MatSORType); 138 PETSC_EXTERN PetscErrorCode PCSORGetSymmetric(PC, MatSORType *); 139 PETSC_EXTERN PetscErrorCode PCSORSetOmega(PC, PetscReal); 140 PETSC_EXTERN PetscErrorCode PCSORGetOmega(PC, PetscReal *); 141 PETSC_EXTERN PetscErrorCode PCSORSetIterations(PC, PetscInt, PetscInt); 142 PETSC_EXTERN PetscErrorCode PCSORGetIterations(PC, PetscInt *, PetscInt *); 143 144 PETSC_EXTERN PetscErrorCode PCEisenstatSetOmega(PC, PetscReal); 145 PETSC_EXTERN PetscErrorCode PCEisenstatGetOmega(PC, PetscReal *); 146 PETSC_EXTERN PetscErrorCode PCEisenstatSetNoDiagonalScaling(PC, PetscBool); 147 PETSC_EXTERN PetscErrorCode PCEisenstatGetNoDiagonalScaling(PC, PetscBool *); 148 149 PETSC_EXTERN PetscErrorCode PCBJacobiSetTotalBlocks(PC, PetscInt, const PetscInt[]); 150 PETSC_EXTERN PetscErrorCode PCBJacobiGetTotalBlocks(PC, PetscInt *, const PetscInt *[]); 151 PETSC_EXTERN PetscErrorCode PCBJacobiSetLocalBlocks(PC, PetscInt, const PetscInt[]); 152 PETSC_EXTERN PetscErrorCode PCBJacobiGetLocalBlocks(PC, PetscInt *, const PetscInt *[]); 153 154 PETSC_EXTERN PetscErrorCode PCShellSetApply(PC, PetscErrorCode (*)(PC, Vec, Vec)); 155 PETSC_EXTERN PetscErrorCode PCShellSetMatApply(PC, PetscErrorCode (*)(PC, Mat, Mat)); 156 PETSC_EXTERN PetscErrorCode PCShellSetApplySymmetricLeft(PC, PetscErrorCode (*)(PC, Vec, Vec)); 157 PETSC_EXTERN PetscErrorCode PCShellSetApplySymmetricRight(PC, PetscErrorCode (*)(PC, Vec, Vec)); 158 PETSC_EXTERN PetscErrorCode PCShellSetApplyBA(PC, PetscErrorCode (*)(PC, PCSide, Vec, Vec, Vec)); 159 PETSC_EXTERN PetscErrorCode PCShellSetApplyTranspose(PC, PetscErrorCode (*)(PC, Vec, Vec)); 160 PETSC_EXTERN PetscErrorCode PCShellSetSetUp(PC, PetscErrorCode (*)(PC)); 161 PETSC_EXTERN PetscErrorCode PCShellSetApplyRichardson(PC, PetscErrorCode (*)(PC, Vec, Vec, Vec, PetscReal, PetscReal, PetscReal, PetscInt, PetscBool, PetscInt *, PCRichardsonConvergedReason *)); 162 PETSC_EXTERN PetscErrorCode PCShellSetView(PC, PetscErrorCode (*)(PC, PetscViewer)); 163 PETSC_EXTERN PetscErrorCode PCShellSetDestroy(PC, PetscErrorCode (*)(PC)); 164 PETSC_EXTERN PetscErrorCode PCShellSetContext(PC, void *); 165 PETSC_EXTERN PetscErrorCode PCShellGetContext(PC, void *); 166 PETSC_EXTERN PetscErrorCode PCShellSetName(PC, const char[]); 167 PETSC_EXTERN PetscErrorCode PCShellGetName(PC, const char *[]); 168 169 PETSC_EXTERN PetscErrorCode PCFactorSetZeroPivot(PC, PetscReal); 170 171 PETSC_EXTERN PetscErrorCode PCFactorSetShiftType(PC, MatFactorShiftType); 172 PETSC_EXTERN PetscErrorCode PCFactorSetShiftAmount(PC, PetscReal); 173 174 PETSC_EXTERN PetscErrorCode PCFactorSetMatSolverType(PC, MatSolverType); 175 PETSC_EXTERN PetscErrorCode PCFactorGetMatSolverType(PC, MatSolverType *); 176 PETSC_EXTERN PetscErrorCode PCFactorSetUpMatSolverType(PC); 177 PETSC_DEPRECATED_FUNCTION(3, 9, 0, "PCFactorSetMatSolverType()", ) static inline PetscErrorCode PCFactorSetMatSolverPackage(PC pc, MatSolverType stype) 178 { 179 return PCFactorSetMatSolverType(pc, stype); 180 } 181 PETSC_DEPRECATED_FUNCTION(3, 9, 0, "PCFactorGetMatSolverType()", ) static inline PetscErrorCode PCFactorGetMatSolverPackage(PC pc, MatSolverType *stype) 182 { 183 return PCFactorGetMatSolverType(pc, stype); 184 } 185 PETSC_DEPRECATED_FUNCTION(3, 9, 0, "PCFactorSetUpMatSolverType()", ) static inline PetscErrorCode PCFactorSetUpMatSolverPackage(PC pc) 186 { 187 return PCFactorSetUpMatSolverType(pc); 188 } 189 190 PETSC_EXTERN PetscErrorCode PCFactorSetFill(PC, PetscReal); 191 PETSC_EXTERN PetscErrorCode PCFactorSetColumnPivot(PC, PetscReal); 192 PETSC_EXTERN PetscErrorCode PCFactorReorderForNonzeroDiagonal(PC, PetscReal); 193 194 PETSC_EXTERN PetscErrorCode PCFactorSetMatOrderingType(PC, MatOrderingType); 195 PETSC_EXTERN PetscErrorCode PCFactorSetReuseOrdering(PC, PetscBool); 196 PETSC_EXTERN PetscErrorCode PCFactorSetReuseFill(PC, PetscBool); 197 PETSC_EXTERN PetscErrorCode PCFactorSetUseInPlace(PC, PetscBool); 198 PETSC_EXTERN PetscErrorCode PCFactorGetUseInPlace(PC, PetscBool *); 199 PETSC_EXTERN PetscErrorCode PCFactorSetAllowDiagonalFill(PC, PetscBool); 200 PETSC_EXTERN PetscErrorCode PCFactorGetAllowDiagonalFill(PC, PetscBool *); 201 PETSC_EXTERN PetscErrorCode PCFactorSetPivotInBlocks(PC, PetscBool); 202 203 PETSC_EXTERN PetscErrorCode PCFactorSetLevels(PC, PetscInt); 204 PETSC_EXTERN PetscErrorCode PCFactorGetLevels(PC, PetscInt *); 205 PETSC_EXTERN PetscErrorCode PCFactorSetDropTolerance(PC, PetscReal, PetscReal, PetscInt); 206 PETSC_EXTERN PetscErrorCode PCFactorGetZeroPivot(PC, PetscReal *); 207 PETSC_EXTERN PetscErrorCode PCFactorGetShiftAmount(PC, PetscReal *); 208 PETSC_EXTERN PetscErrorCode PCFactorGetShiftType(PC, MatFactorShiftType *); 209 210 PETSC_EXTERN PetscErrorCode PCASMSetLocalSubdomains(PC, PetscInt, IS[], IS[]); 211 PETSC_EXTERN PetscErrorCode PCASMSetTotalSubdomains(PC, PetscInt, IS[], IS[]); 212 PETSC_EXTERN PetscErrorCode PCASMSetOverlap(PC, PetscInt); 213 PETSC_EXTERN PetscErrorCode PCASMSetDMSubdomains(PC, PetscBool); 214 PETSC_EXTERN PetscErrorCode PCASMGetDMSubdomains(PC, PetscBool *); 215 PETSC_EXTERN PetscErrorCode PCASMSetSortIndices(PC, PetscBool); 216 217 PETSC_EXTERN PetscErrorCode PCASMSetType(PC, PCASMType); 218 PETSC_EXTERN PetscErrorCode PCASMGetType(PC, PCASMType *); 219 PETSC_EXTERN PetscErrorCode PCASMSetLocalType(PC, PCCompositeType); 220 PETSC_EXTERN PetscErrorCode PCASMGetLocalType(PC, PCCompositeType *); 221 PETSC_EXTERN PetscErrorCode PCASMCreateSubdomains(Mat, PetscInt, IS *[]); 222 PETSC_EXTERN PetscErrorCode PCASMDestroySubdomains(PetscInt, IS[], IS[]); 223 PETSC_EXTERN PetscErrorCode PCASMCreateSubdomains2D(PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt *, IS **, IS **); 224 PETSC_EXTERN PetscErrorCode PCASMGetLocalSubdomains(PC, PetscInt *, IS *[], IS *[]); 225 PETSC_EXTERN PetscErrorCode PCASMGetLocalSubmatrices(PC, PetscInt *, Mat *[]); 226 PETSC_EXTERN PetscErrorCode PCASMGetSubMatType(PC, MatType *); 227 PETSC_EXTERN PetscErrorCode PCASMSetSubMatType(PC, MatType); 228 229 PETSC_EXTERN PetscErrorCode PCGASMSetTotalSubdomains(PC, PetscInt); 230 PETSC_EXTERN PetscErrorCode PCGASMSetSubdomains(PC, PetscInt, IS[], IS[]); 231 PETSC_EXTERN PetscErrorCode PCGASMSetOverlap(PC, PetscInt); 232 PETSC_EXTERN PetscErrorCode PCGASMSetUseDMSubdomains(PC, PetscBool); 233 PETSC_EXTERN PetscErrorCode PCGASMGetUseDMSubdomains(PC, PetscBool *); 234 PETSC_EXTERN PetscErrorCode PCGASMSetSortIndices(PC, PetscBool); 235 236 PETSC_EXTERN PetscErrorCode PCGASMSetType(PC, PCGASMType); 237 PETSC_EXTERN PetscErrorCode PCGASMCreateSubdomains(Mat, PetscInt, PetscInt *, IS *[]); 238 PETSC_EXTERN PetscErrorCode PCGASMDestroySubdomains(PetscInt, IS *[], IS *[]); 239 PETSC_EXTERN PetscErrorCode PCGASMCreateSubdomains2D(PC, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt *, IS **, IS **); 240 PETSC_EXTERN PetscErrorCode PCGASMGetSubdomains(PC, PetscInt *, IS *[], IS *[]); 241 PETSC_EXTERN PetscErrorCode PCGASMGetSubmatrices(PC, PetscInt *, Mat *[]); 242 243 PETSC_EXTERN PetscErrorCode PCCompositeSetType(PC, PCCompositeType); 244 PETSC_EXTERN PetscErrorCode PCCompositeGetType(PC, PCCompositeType *); 245 PETSC_EXTERN PetscErrorCode PCCompositeAddPCType(PC, PCType); 246 PETSC_EXTERN PetscErrorCode PCCompositeAddPC(PC, PC); 247 PETSC_EXTERN PetscErrorCode PCCompositeGetNumberPC(PC, PetscInt *); 248 PETSC_EXTERN PetscErrorCode PCCompositeGetPC(PC, PetscInt, PC *); 249 PETSC_EXTERN PetscErrorCode PCCompositeSpecialSetAlpha(PC, PetscScalar); 250 251 PETSC_EXTERN PetscErrorCode PCRedundantSetNumber(PC, PetscInt); 252 PETSC_EXTERN PetscErrorCode PCRedundantSetScatter(PC, VecScatter, VecScatter); 253 PETSC_EXTERN PetscErrorCode PCRedundantGetOperators(PC, Mat *, Mat *); 254 255 PETSC_EXTERN PetscErrorCode PCSPAISetEpsilon(PC, PetscReal); 256 PETSC_EXTERN PetscErrorCode PCSPAISetNBSteps(PC, PetscInt); 257 PETSC_EXTERN PetscErrorCode PCSPAISetMax(PC, PetscInt); 258 PETSC_EXTERN PetscErrorCode PCSPAISetMaxNew(PC, PetscInt); 259 PETSC_EXTERN PetscErrorCode PCSPAISetBlockSize(PC, PetscInt); 260 PETSC_EXTERN PetscErrorCode PCSPAISetCacheSize(PC, PetscInt); 261 PETSC_EXTERN PetscErrorCode PCSPAISetVerbose(PC, PetscInt); 262 PETSC_EXTERN PetscErrorCode PCSPAISetSp(PC, PetscInt); 263 264 PETSC_EXTERN PetscErrorCode PCHYPRESetType(PC, const char[]); 265 PETSC_EXTERN PetscErrorCode PCHYPREGetType(PC, const char *[]); 266 PETSC_EXTERN PetscErrorCode PCHYPRESetDiscreteGradient(PC, Mat); 267 PETSC_EXTERN PetscErrorCode PCHYPRESetDiscreteCurl(PC, Mat); 268 PETSC_EXTERN PetscErrorCode PCHYPRESetInterpolations(PC, PetscInt, Mat, Mat[], Mat, Mat[]); 269 PETSC_EXTERN PetscErrorCode PCHYPRESetEdgeConstantVectors(PC, Vec, Vec, Vec); 270 PETSC_EXTERN PetscErrorCode PCHYPREAMSSetInteriorNodes(PC, Vec); 271 PETSC_EXTERN PetscErrorCode PCHYPRESetAlphaPoissonMatrix(PC, Mat); 272 PETSC_EXTERN PetscErrorCode PCHYPRESetBetaPoissonMatrix(PC, Mat); 273 274 PETSC_EXTERN PetscErrorCode PCFieldSplitSetFields(PC, const char[], PetscInt, const PetscInt *, const PetscInt *); 275 PETSC_EXTERN PetscErrorCode PCFieldSplitSetType(PC, PCCompositeType); 276 PETSC_EXTERN PetscErrorCode PCFieldSplitGetType(PC, PCCompositeType *); 277 PETSC_EXTERN PetscErrorCode PCFieldSplitSetBlockSize(PC, PetscInt); 278 PETSC_EXTERN PetscErrorCode PCFieldSplitSetIS(PC, const char[], IS); 279 PETSC_EXTERN PetscErrorCode PCFieldSplitGetIS(PC, const char[], IS *); 280 PETSC_EXTERN PetscErrorCode PCFieldSplitGetISByIndex(PC, PetscInt, IS *); 281 PETSC_EXTERN PetscErrorCode PCFieldSplitRestrictIS(PC, IS); 282 PETSC_EXTERN PetscErrorCode PCFieldSplitSetDMSplits(PC, PetscBool); 283 PETSC_EXTERN PetscErrorCode PCFieldSplitGetDMSplits(PC, PetscBool *); 284 PETSC_EXTERN PetscErrorCode PCFieldSplitSetDiagUseAmat(PC, PetscBool); 285 PETSC_EXTERN PetscErrorCode PCFieldSplitGetDiagUseAmat(PC, PetscBool *); 286 PETSC_EXTERN PetscErrorCode PCFieldSplitSetOffDiagUseAmat(PC, PetscBool); 287 PETSC_EXTERN PetscErrorCode PCFieldSplitGetOffDiagUseAmat(PC, PetscBool *); 288 289 PETSC_EXTERN PETSC_DEPRECATED_FUNCTION(3, 5, 0, "PCFieldSplitSetSchurPre()", ) PetscErrorCode PCFieldSplitSchurPrecondition(PC, PCFieldSplitSchurPreType, Mat); 290 PETSC_EXTERN PetscErrorCode PCFieldSplitSetSchurPre(PC, PCFieldSplitSchurPreType, Mat); 291 PETSC_EXTERN PetscErrorCode PCFieldSplitGetSchurPre(PC, PCFieldSplitSchurPreType *, Mat *); 292 PETSC_EXTERN PetscErrorCode PCFieldSplitSetSchurFactType(PC, PCFieldSplitSchurFactType); 293 PETSC_EXTERN PetscErrorCode PCFieldSplitSetSchurScale(PC, PetscScalar); 294 PETSC_EXTERN PetscErrorCode PCFieldSplitGetSchurBlocks(PC, Mat *, Mat *, Mat *, Mat *); 295 PETSC_EXTERN PetscErrorCode PCFieldSplitSchurGetS(PC, Mat *S); 296 PETSC_EXTERN PetscErrorCode PCFieldSplitSchurRestoreS(PC, Mat *S); 297 PETSC_EXTERN PetscErrorCode PCFieldSplitGetDetectSaddlePoint(PC, PetscBool *); 298 PETSC_EXTERN PetscErrorCode PCFieldSplitSetDetectSaddlePoint(PC, PetscBool); 299 PETSC_EXTERN PetscErrorCode PCFieldSplitSetGKBTol(PC, PetscReal); 300 PETSC_EXTERN PetscErrorCode PCFieldSplitSetGKBNu(PC, PetscReal); 301 PETSC_EXTERN PetscErrorCode PCFieldSplitSetGKBMaxit(PC, PetscInt); 302 PETSC_EXTERN PetscErrorCode PCFieldSplitSetGKBDelay(PC, PetscInt); 303 304 PETSC_EXTERN PetscErrorCode PCGalerkinSetRestriction(PC, Mat); 305 PETSC_EXTERN PetscErrorCode PCGalerkinSetInterpolation(PC, Mat); 306 PETSC_EXTERN PetscErrorCode PCGalerkinSetComputeSubmatrix(PC, PetscErrorCode (*)(PC, Mat, Mat, Mat *, void *), void *); 307 308 PETSC_EXTERN PetscErrorCode PCPythonSetType(PC, const char[]); 309 PETSC_EXTERN PetscErrorCode PCPythonGetType(PC, const char *[]); 310 311 PETSC_EXTERN PetscErrorCode PCPARMSSetGlobal(PC, PCPARMSGlobalType); 312 PETSC_EXTERN PetscErrorCode PCPARMSSetLocal(PC, PCPARMSLocalType); 313 PETSC_EXTERN PetscErrorCode PCPARMSSetSolveTolerances(PC, PetscReal, PetscInt); 314 PETSC_EXTERN PetscErrorCode PCPARMSSetSolveRestart(PC, PetscInt); 315 PETSC_EXTERN PetscErrorCode PCPARMSSetNonsymPerm(PC, PetscBool); 316 PETSC_EXTERN PetscErrorCode PCPARMSSetFill(PC, PetscInt, PetscInt, PetscInt); 317 318 PETSC_EXTERN PetscErrorCode PCGAMGSetType(PC, PCGAMGType); 319 PETSC_EXTERN PetscErrorCode PCGAMGGetType(PC, PCGAMGType *); 320 PETSC_EXTERN PetscErrorCode PCGAMGSetProcEqLim(PC, PetscInt); 321 322 PETSC_EXTERN PetscErrorCode PCGAMGSetRepartition(PC, PetscBool); 323 PETSC_EXTERN PetscErrorCode PCGAMGSetUseSAEstEig(PC, PetscBool); 324 PETSC_EXTERN PetscErrorCode PCGAMGSetEigenvalues(PC, PetscReal, PetscReal); 325 PETSC_EXTERN PetscErrorCode PCGAMGASMSetUseAggs(PC, PetscBool); 326 PETSC_EXTERN PetscErrorCode PCGAMGSetUseParallelCoarseGridSolve(PC, PetscBool); 327 PETSC_EXTERN PetscErrorCode PCGAMGSetCpuPinCoarseGrids(PC, PetscBool); 328 PETSC_EXTERN PetscErrorCode PCGAMGSetCoarseGridLayoutType(PC, PCGAMGLayoutType); 329 PETSC_EXTERN PetscErrorCode PCGAMGSetThreshold(PC, PetscReal[], PetscInt); 330 PETSC_EXTERN PetscErrorCode PCGAMGSetRankReductionFactors(PC, PetscInt[], PetscInt); 331 PETSC_EXTERN PetscErrorCode PCGAMGSetThresholdScale(PC, PetscReal); 332 PETSC_EXTERN PetscErrorCode PCGAMGSetCoarseEqLim(PC, PetscInt); 333 PETSC_EXTERN PetscErrorCode PCGAMGSetNlevels(PC, PetscInt); 334 PETSC_EXTERN PetscErrorCode PCGAMGSetNSmooths(PC, PetscInt); 335 PETSC_EXTERN PetscErrorCode PCGAMGSetSquareGraph(PC, PetscInt); 336 PETSC_EXTERN PetscErrorCode PCGAMGSetAggressiveLevels(PC, PetscInt); 337 PETSC_EXTERN PetscErrorCode PCGAMGSetReuseInterpolation(PC, PetscBool); 338 PETSC_EXTERN PetscErrorCode PCGAMGFinalizePackage(void); 339 PETSC_EXTERN PetscErrorCode PCGAMGInitializePackage(void); 340 PETSC_EXTERN PetscErrorCode PCGAMGRegister(PCGAMGType, PetscErrorCode (*)(PC)); 341 PETSC_EXTERN PetscErrorCode PCGAMGCreateGraph(PC, Mat, Mat *); 342 343 PETSC_EXTERN PetscErrorCode PCGAMGClassicalSetType(PC, PCGAMGClassicalType); 344 PETSC_EXTERN PetscErrorCode PCGAMGClassicalGetType(PC, PCGAMGClassicalType *); 345 346 PETSC_EXTERN PetscErrorCode PCBDDCSetDiscreteGradient(PC, Mat, PetscInt, PetscInt, PetscBool, PetscBool); 347 PETSC_EXTERN PetscErrorCode PCBDDCSetDivergenceMat(PC, Mat, PetscBool, IS); 348 PETSC_EXTERN PetscErrorCode PCBDDCSetChangeOfBasisMat(PC, Mat, PetscBool); 349 PETSC_EXTERN PetscErrorCode PCBDDCSetPrimalVerticesIS(PC, IS); 350 PETSC_EXTERN PetscErrorCode PCBDDCSetPrimalVerticesLocalIS(PC, IS); 351 PETSC_EXTERN PetscErrorCode PCBDDCGetPrimalVerticesIS(PC, IS *); 352 PETSC_EXTERN PetscErrorCode PCBDDCGetPrimalVerticesLocalIS(PC, IS *); 353 PETSC_EXTERN PetscErrorCode PCBDDCSetCoarseningRatio(PC, PetscInt); 354 PETSC_EXTERN PetscErrorCode PCBDDCSetLevels(PC, PetscInt); 355 PETSC_EXTERN PetscErrorCode PCBDDCSetDirichletBoundaries(PC, IS); 356 PETSC_EXTERN PetscErrorCode PCBDDCSetDirichletBoundariesLocal(PC, IS); 357 PETSC_EXTERN PetscErrorCode PCBDDCGetDirichletBoundaries(PC, IS *); 358 PETSC_EXTERN PetscErrorCode PCBDDCGetDirichletBoundariesLocal(PC, IS *); 359 PETSC_EXTERN PetscErrorCode PCBDDCSetInterfaceExtType(PC, PCBDDCInterfaceExtType); 360 PETSC_EXTERN PetscErrorCode PCBDDCSetNeumannBoundaries(PC, IS); 361 PETSC_EXTERN PetscErrorCode PCBDDCSetNeumannBoundariesLocal(PC, IS); 362 PETSC_EXTERN PetscErrorCode PCBDDCGetNeumannBoundaries(PC, IS *); 363 PETSC_EXTERN PetscErrorCode PCBDDCGetNeumannBoundariesLocal(PC, IS *); 364 PETSC_EXTERN PetscErrorCode PCBDDCSetDofsSplitting(PC, PetscInt, IS[]); 365 PETSC_EXTERN PetscErrorCode PCBDDCSetDofsSplittingLocal(PC, PetscInt, IS[]); 366 PETSC_EXTERN PetscErrorCode PCBDDCSetLocalAdjacencyGraph(PC, PetscInt, const PetscInt[], const PetscInt[], PetscCopyMode); 367 PETSC_EXTERN PetscErrorCode PCBDDCCreateFETIDPOperators(PC, PetscBool, const char *, Mat *, PC *); 368 PETSC_EXTERN PetscErrorCode PCBDDCMatFETIDPGetRHS(Mat, Vec, Vec); 369 PETSC_EXTERN PetscErrorCode PCBDDCMatFETIDPGetSolution(Mat, Vec, Vec); 370 PETSC_EXTERN PetscErrorCode PCBDDCFinalizePackage(void); 371 PETSC_EXTERN PetscErrorCode PCBDDCInitializePackage(void); 372 373 PETSC_EXTERN PetscErrorCode PCISInitialize(PC); 374 PETSC_EXTERN PetscErrorCode PCISSetUp(PC, PetscBool, PetscBool); 375 PETSC_EXTERN PetscErrorCode PCISSetUseStiffnessScaling(PC, PetscBool); 376 PETSC_EXTERN PetscErrorCode PCISSetSubdomainScalingFactor(PC, PetscScalar); 377 PETSC_EXTERN PetscErrorCode PCISSetSubdomainDiagonalScaling(PC, Vec); 378 PETSC_EXTERN PetscErrorCode PCISScatterArrayNToVecB(PC, PetscScalar *, Vec, InsertMode, ScatterMode); 379 PETSC_EXTERN PetscErrorCode PCISApplySchur(PC, Vec, Vec, Vec, Vec, Vec); 380 PETSC_EXTERN PetscErrorCode PCISApplyInvSchur(PC, Vec, Vec, Vec, Vec); 381 PETSC_EXTERN PetscErrorCode PCISReset(PC); 382 383 PETSC_EXTERN PetscInt PetscMGLevelId; 384 PETSC_EXTERN PetscErrorCode PCMGSetType(PC, PCMGType); 385 PETSC_EXTERN PetscErrorCode PCMGGetType(PC, PCMGType *); 386 PETSC_EXTERN PetscErrorCode PCMGSetLevels(PC, PetscInt, MPI_Comm *); 387 PETSC_EXTERN PetscErrorCode PCMGGetLevels(PC, PetscInt *); 388 389 PETSC_EXTERN PetscErrorCode PCMGSetDistinctSmoothUp(PC); 390 PETSC_EXTERN PetscErrorCode PCMGSetNumberSmooth(PC, PetscInt); 391 PETSC_EXTERN PetscErrorCode PCMGSetCycleType(PC, PCMGCycleType); 392 PETSC_EXTERN PetscErrorCode PCMGSetCycleTypeOnLevel(PC, PetscInt, PCMGCycleType); 393 PETSC_DEPRECATED_FUNCTION(3, 5, 0, "PCMGSetCycleTypeOnLevel()", ) static inline PetscErrorCode PCMGSetCyclesOnLevel(PC pc, PetscInt l, PetscInt t) 394 { 395 return PCMGSetCycleTypeOnLevel(pc, l, (PCMGCycleType)t); 396 } 397 PETSC_EXTERN PetscErrorCode PCMGMultiplicativeSetCycles(PC, PetscInt); 398 PETSC_EXTERN PetscErrorCode PCMGSetGalerkin(PC, PCMGGalerkinType); 399 PETSC_EXTERN PetscErrorCode PCMGGetGalerkin(PC, PCMGGalerkinType *); 400 PETSC_EXTERN PetscErrorCode PCMGSetAdaptCoarseSpaceType(PC, PCMGCoarseSpaceType); 401 PETSC_EXTERN PetscErrorCode PCMGGetAdaptCoarseSpaceType(PC, PCMGCoarseSpaceType *); 402 PETSC_EXTERN PetscErrorCode PCMGSetAdaptCR(PC, PetscBool); 403 PETSC_EXTERN PetscErrorCode PCMGGetAdaptCR(PC, PetscBool *); 404 /* MATT: Remove? */ 405 PETSC_EXTERN PetscErrorCode PCMGSetAdaptInterpolation(PC, PetscBool); 406 PETSC_EXTERN PetscErrorCode PCMGGetAdaptInterpolation(PC, PetscBool *); 407 408 PETSC_EXTERN PetscErrorCode PCMGSetRhs(PC, PetscInt, Vec); 409 PETSC_EXTERN PetscErrorCode PCMGSetX(PC, PetscInt, Vec); 410 PETSC_EXTERN PetscErrorCode PCMGSetR(PC, PetscInt, Vec); 411 412 PETSC_EXTERN PetscErrorCode PCMGSetRestriction(PC, PetscInt, Mat); 413 PETSC_EXTERN PetscErrorCode PCMGGetRestriction(PC, PetscInt, Mat *); 414 PETSC_EXTERN PetscErrorCode PCMGSetInjection(PC, PetscInt, Mat); 415 PETSC_EXTERN PetscErrorCode PCMGGetInjection(PC, PetscInt, Mat *); 416 PETSC_EXTERN PetscErrorCode PCMGSetInterpolation(PC, PetscInt, Mat); 417 PETSC_EXTERN PetscErrorCode PCMGSetOperators(PC, PetscInt, Mat, Mat); 418 PETSC_EXTERN PetscErrorCode PCMGGetInterpolation(PC, PetscInt, Mat *); 419 PETSC_EXTERN PetscErrorCode PCMGSetRScale(PC, PetscInt, Vec); 420 PETSC_EXTERN PetscErrorCode PCMGGetRScale(PC, PetscInt, Vec *); 421 PETSC_EXTERN PetscErrorCode PCMGSetResidual(PC, PetscInt, PetscErrorCode (*)(Mat, Vec, Vec, Vec), Mat); 422 PETSC_EXTERN PetscErrorCode PCMGSetResidualTranspose(PC, PetscInt, PetscErrorCode (*)(Mat, Vec, Vec, Vec), Mat); 423 PETSC_EXTERN PetscErrorCode PCMGResidualDefault(Mat, Vec, Vec, Vec); 424 PETSC_EXTERN PetscErrorCode PCMGResidualTransposeDefault(Mat, Vec, Vec, Vec); 425 PETSC_EXTERN PetscErrorCode PCMGMatResidualDefault(Mat, Mat, Mat, Mat); 426 PETSC_EXTERN PetscErrorCode PCMGMatResidualTransposeDefault(Mat, Mat, Mat, Mat); 427 PETSC_EXTERN PetscErrorCode PCMGGalerkinSetMatProductAlgorithm(PC, const char[]); 428 PETSC_EXTERN PetscErrorCode PCMGGalerkinGetMatProductAlgorithm(PC, const char *[]); 429 PETSC_EXTERN PetscErrorCode PCMGGetGridComplexity(PC, PetscReal *, PetscReal *); 430 431 PETSC_EXTERN PetscErrorCode PCHMGSetReuseInterpolation(PC, PetscBool); 432 PETSC_EXTERN PetscErrorCode PCHMGSetUseSubspaceCoarsening(PC, PetscBool); 433 PETSC_EXTERN PetscErrorCode PCHMGSetInnerPCType(PC, PCType); 434 PETSC_EXTERN PetscErrorCode PCHMGSetCoarseningComponent(PC, PetscInt); 435 PETSC_EXTERN PetscErrorCode PCHMGUseMatMAIJ(PC, PetscBool); 436 437 PETSC_EXTERN PetscErrorCode PCTelescopeGetSubcommType(PC, PetscSubcommType *); 438 PETSC_EXTERN PetscErrorCode PCTelescopeSetSubcommType(PC, PetscSubcommType); 439 PETSC_EXTERN PetscErrorCode PCTelescopeGetReductionFactor(PC, PetscInt *); 440 PETSC_EXTERN PetscErrorCode PCTelescopeSetReductionFactor(PC, PetscInt); 441 PETSC_EXTERN PetscErrorCode PCTelescopeGetIgnoreDM(PC, PetscBool *); 442 PETSC_EXTERN PetscErrorCode PCTelescopeSetIgnoreDM(PC, PetscBool); 443 PETSC_EXTERN PetscErrorCode PCTelescopeGetUseCoarseDM(PC, PetscBool *); 444 PETSC_EXTERN PetscErrorCode PCTelescopeSetUseCoarseDM(PC, PetscBool); 445 PETSC_EXTERN PetscErrorCode PCTelescopeGetIgnoreKSPComputeOperators(PC, PetscBool *); 446 PETSC_EXTERN PetscErrorCode PCTelescopeSetIgnoreKSPComputeOperators(PC, PetscBool); 447 PETSC_EXTERN PetscErrorCode PCTelescopeGetDM(PC, DM *); 448 449 PETSC_EXTERN PetscErrorCode PCPatchSetSaveOperators(PC, PetscBool); 450 PETSC_EXTERN PetscErrorCode PCPatchGetSaveOperators(PC, PetscBool *); 451 PETSC_EXTERN PetscErrorCode PCPatchSetPrecomputeElementTensors(PC, PetscBool); 452 PETSC_EXTERN PetscErrorCode PCPatchGetPrecomputeElementTensors(PC, PetscBool *); 453 PETSC_EXTERN PetscErrorCode PCPatchSetPartitionOfUnity(PC, PetscBool); 454 PETSC_EXTERN PetscErrorCode PCPatchGetPartitionOfUnity(PC, PetscBool *); 455 PETSC_EXTERN PetscErrorCode PCPatchSetSubMatType(PC, MatType); 456 PETSC_EXTERN PetscErrorCode PCPatchGetSubMatType(PC, MatType *); 457 PETSC_EXTERN PetscErrorCode PCPatchSetCellNumbering(PC, PetscSection); 458 PETSC_EXTERN PetscErrorCode PCPatchGetCellNumbering(PC, PetscSection *); 459 PETSC_EXTERN PetscErrorCode PCPatchSetConstructType(PC, PCPatchConstructType, PetscErrorCode (*)(PC, PetscInt *, IS **, IS *, void *), void *); 460 PETSC_EXTERN PetscErrorCode PCPatchGetConstructType(PC, PCPatchConstructType *, PetscErrorCode (**)(PC, PetscInt *, IS **, IS *, void *), void **); 461 PETSC_EXTERN PetscErrorCode PCPatchSetDiscretisationInfo(PC, PetscInt, DM *, PetscInt *, PetscInt *, const PetscInt **, const PetscInt *, PetscInt, const PetscInt *, PetscInt, const PetscInt *); 462 PETSC_EXTERN PetscErrorCode PCPatchSetComputeOperator(PC, PetscErrorCode (*)(PC, PetscInt, Vec, Mat, IS, PetscInt, const PetscInt *, const PetscInt *, void *), void *); 463 PETSC_EXTERN PetscErrorCode PCPatchSetComputeFunction(PC pc, PetscErrorCode (*func)(PC, PetscInt, Vec, Vec, IS, PetscInt, const PetscInt *, const PetscInt *, void *), void *ctx); 464 PETSC_EXTERN PetscErrorCode PCPatchSetComputeOperatorInteriorFacets(PC, PetscErrorCode (*)(PC, PetscInt, Vec, Mat, IS, PetscInt, const PetscInt *, const PetscInt *, void *), void *); 465 PETSC_EXTERN PetscErrorCode PCPatchSetComputeFunctionInteriorFacets(PC pc, PetscErrorCode (*func)(PC, PetscInt, Vec, Vec, IS, PetscInt, const PetscInt *, const PetscInt *, void *), void *ctx); 466 467 PETSC_EXTERN PetscErrorCode PCLMVMSetMatLMVM(PC, Mat); 468 PETSC_EXTERN PetscErrorCode PCLMVMGetMatLMVM(PC, Mat *); 469 PETSC_EXTERN PetscErrorCode PCLMVMSetIS(PC, IS); 470 PETSC_EXTERN PetscErrorCode PCLMVMClearIS(PC); 471 472 PETSC_EXTERN PetscErrorCode PCExoticSetType(PC, PCExoticType); 473 474 PETSC_EXTERN PetscErrorCode PCDeflationSetInitOnly(PC, PetscBool); 475 PETSC_EXTERN PetscErrorCode PCDeflationSetLevels(PC, PetscInt); 476 PETSC_EXTERN PetscErrorCode PCDeflationSetReductionFactor(PC, PetscInt); 477 PETSC_EXTERN PetscErrorCode PCDeflationSetCorrectionFactor(PC, PetscScalar); 478 PETSC_EXTERN PetscErrorCode PCDeflationSetSpaceToCompute(PC, PCDeflationSpaceType, PetscInt); 479 PETSC_EXTERN PetscErrorCode PCDeflationSetSpace(PC, Mat, PetscBool); 480 PETSC_EXTERN PetscErrorCode PCDeflationSetProjectionNullSpaceMat(PC, Mat); 481 PETSC_EXTERN PetscErrorCode PCDeflationSetCoarseMat(PC, Mat); 482 PETSC_EXTERN PetscErrorCode PCDeflationGetPC(PC, PC *); 483 484 PETSC_EXTERN PetscErrorCode PCHPDDMSetAuxiliaryMat(PC, IS, Mat, PetscErrorCode (*)(Mat, PetscReal, Vec, Vec, PetscReal, IS, void *), void *); 485 PETSC_EXTERN PetscErrorCode PCHPDDMSetRHSMat(PC, Mat); 486 PETSC_EXTERN PetscErrorCode PCHPDDMHasNeumannMat(PC, PetscBool); 487 PETSC_EXTERN PetscErrorCode PCHPDDMSetCoarseCorrectionType(PC, PCHPDDMCoarseCorrectionType); 488 PETSC_EXTERN PetscErrorCode PCHPDDMGetCoarseCorrectionType(PC, PCHPDDMCoarseCorrectionType *); 489 PETSC_EXTERN PetscErrorCode PCHPDDMSetSTShareSubKSP(PC, PetscBool); 490 PETSC_EXTERN PetscErrorCode PCHPDDMGetSTShareSubKSP(PC, PetscBool *); 491 PETSC_EXTERN PetscErrorCode PCHPDDMSetDeflationMat(PC, IS, Mat); 492 PETSC_EXTERN PetscErrorCode PCHPDDMFinalizePackage(void); 493 PETSC_EXTERN PetscErrorCode PCHPDDMInitializePackage(void); 494 495 PETSC_EXTERN PetscErrorCode PCAmgXGetResources(PC, void *); 496 497 PETSC_EXTERN PetscErrorCode PCMatSetApplyOperation(PC, MatOperation); 498 PETSC_EXTERN PetscErrorCode PCMatGetApplyOperation(PC, MatOperation *); 499 500 #endif /* PETSCPC_H */ 501