1 #define PETSCKSP_DLL 2 3 #include "../src/ksp/pc/impls/factor/icc/icc.h" /*I "petscpc.h" I*/ 4 5 #undef __FUNCT__ 6 #define __FUNCT__ "PCSetup_ICC" 7 static PetscErrorCode PCSetup_ICC(PC pc) 8 { 9 PC_ICC *icc = (PC_ICC*)pc->data; 10 IS perm,cperm; 11 PetscErrorCode ierr; 12 MatInfo info; 13 14 PetscFunctionBegin; 15 ierr = MatGetOrdering(pc->pmat, ((PC_Factor*)icc)->ordering,&perm,&cperm);CHKERRQ(ierr); 16 17 if (!pc->setupcalled) { 18 ierr = MatGetFactor(pc->pmat,((PC_Factor*)icc)->solvertype,MAT_FACTOR_ICC,& ((PC_Factor*)icc)->fact);CHKERRQ(ierr); 19 ierr = MatICCFactorSymbolic(((PC_Factor*)icc)->fact,pc->pmat,perm,&((PC_Factor*)icc)->info);CHKERRQ(ierr); 20 } else if (pc->flag != SAME_NONZERO_PATTERN) { 21 ierr = MatDestroy(((PC_Factor*)icc)->fact);CHKERRQ(ierr); 22 ierr = MatGetFactor(pc->pmat,MAT_SOLVER_PETSC,MAT_FACTOR_ICC,&((PC_Factor*)icc)->fact);CHKERRQ(ierr); 23 ierr = MatICCFactorSymbolic(((PC_Factor*)icc)->fact,pc->pmat,perm,&((PC_Factor*)icc)->info);CHKERRQ(ierr); 24 } 25 ierr = MatGetInfo(((PC_Factor*)icc)->fact,MAT_LOCAL,&info);CHKERRQ(ierr); 26 icc->actualfill = info.fill_ratio_needed; 27 28 ierr = ISDestroy(cperm);CHKERRQ(ierr); 29 ierr = ISDestroy(perm);CHKERRQ(ierr); 30 ierr = MatCholeskyFactorNumeric(((PC_Factor*)icc)->fact,pc->pmat,&((PC_Factor*)icc)->info);CHKERRQ(ierr); 31 PetscFunctionReturn(0); 32 } 33 34 #undef __FUNCT__ 35 #define __FUNCT__ "PCDestroy_ICC" 36 static PetscErrorCode PCDestroy_ICC(PC pc) 37 { 38 PC_ICC *icc = (PC_ICC*)pc->data; 39 PetscErrorCode ierr; 40 41 PetscFunctionBegin; 42 if (((PC_Factor*)icc)->fact) {ierr = MatDestroy(((PC_Factor*)icc)->fact);CHKERRQ(ierr);} 43 ierr = PetscStrfree(((PC_Factor*)icc)->ordering);CHKERRQ(ierr); 44 ierr = PetscStrfree(((PC_Factor*)icc)->solvertype);CHKERRQ(ierr); 45 ierr = PetscFree(icc);CHKERRQ(ierr); 46 PetscFunctionReturn(0); 47 } 48 49 #undef __FUNCT__ 50 #define __FUNCT__ "PCApply_ICC" 51 static PetscErrorCode PCApply_ICC(PC pc,Vec x,Vec y) 52 { 53 PC_ICC *icc = (PC_ICC*)pc->data; 54 PetscErrorCode ierr; 55 56 PetscFunctionBegin; 57 ierr = MatSolve(((PC_Factor*)icc)->fact,x,y);CHKERRQ(ierr); 58 PetscFunctionReturn(0); 59 } 60 61 #undef __FUNCT__ 62 #define __FUNCT__ "PCApplySymmetricLeft_ICC" 63 static PetscErrorCode PCApplySymmetricLeft_ICC(PC pc,Vec x,Vec y) 64 { 65 PetscErrorCode ierr; 66 PC_ICC *icc = (PC_ICC*)pc->data; 67 68 PetscFunctionBegin; 69 ierr = MatForwardSolve(((PC_Factor*)icc)->fact,x,y);CHKERRQ(ierr); 70 PetscFunctionReturn(0); 71 } 72 73 #undef __FUNCT__ 74 #define __FUNCT__ "PCApplySymmetricRight_ICC" 75 static PetscErrorCode PCApplySymmetricRight_ICC(PC pc,Vec x,Vec y) 76 { 77 PetscErrorCode ierr; 78 PC_ICC *icc = (PC_ICC*)pc->data; 79 80 PetscFunctionBegin; 81 ierr = MatBackwardSolve(((PC_Factor*)icc)->fact,x,y);CHKERRQ(ierr); 82 PetscFunctionReturn(0); 83 } 84 85 #undef __FUNCT__ 86 #define __FUNCT__ "PCSetFromOptions_ICC" 87 static PetscErrorCode PCSetFromOptions_ICC(PC pc) 88 { 89 PC_ICC *icc = (PC_ICC*)pc->data; 90 PetscTruth flg; 91 PetscInt dtmax = 3; 92 PetscReal dt[3]; 93 PetscErrorCode ierr; 94 95 PetscFunctionBegin; 96 ierr = PetscOptionsHead("ICC Options");CHKERRQ(ierr); 97 ierr = PCSetFromOptions_Factor(pc);CHKERRQ(ierr); 98 99 ierr = PetscOptionsReal("-pc_factor_levels","levels of fill","PCFactorSetLevels",((PC_Factor*)icc)->info.levels,&((PC_Factor*)icc)->info.levels,&flg);CHKERRQ(ierr); 100 dt[0] = ((PC_Factor*)icc)->info.dt; 101 dt[1] = ((PC_Factor*)icc)->info.dtcol; 102 dt[2] = ((PC_Factor*)icc)->info.dtcount; 103 ierr = PetscOptionsRealArray("-pc_factor_drop_tolerance","<dt,dtcol,maxrowcount>","PCFactorSetDropTolerance",dt,&dtmax,&flg);CHKERRQ(ierr); 104 if (flg) { 105 ierr = PCFactorSetDropTolerance(pc,dt[0],dt[1],(PetscInt)dt[2]);CHKERRQ(ierr); 106 } 107 108 ierr = PetscOptionsTail();CHKERRQ(ierr); 109 PetscFunctionReturn(0); 110 } 111 112 #undef __FUNCT__ 113 #define __FUNCT__ "PCView_ICC" 114 static PetscErrorCode PCView_ICC(PC pc,PetscViewer viewer) 115 { 116 PetscErrorCode ierr; 117 118 PetscFunctionBegin; 119 ierr = PCView_Factor(pc,viewer);CHKERRQ(ierr); 120 PetscFunctionReturn(0); 121 } 122 123 EXTERN_C_BEGIN 124 extern PetscErrorCode PETSCKSP_DLLEXPORT PCFactorSetDropTolerance_ILU(PC,PetscReal,PetscReal,PetscInt); 125 EXTERN_C_END 126 127 /*MC 128 PCICC - Incomplete Cholesky factorization preconditioners. 129 130 Options Database Keys: 131 + -pc_factor_levels <k> - number of levels of fill for ICC(k) 132 . -pc_factor_in_place - only for ICC(0) with natural ordering, reuses the space of the matrix for 133 its factorization (overwrites original matrix) 134 . -pc_factor_fill <nfill> - expected amount of fill in factored matrix compared to original matrix, nfill > 1 135 - -pc_factor_mat_ordering_type <natural,nd,1wd,rcm,qmd> - set the row/column ordering of the factored matrix 136 137 Level: beginner 138 139 Concepts: incomplete Cholesky factorization 140 141 Notes: Only implemented for some matrix formats. Not implemented in parallel. 142 143 For BAIJ matrices this implements a point block ICC. 144 145 The Manteuffel shift is only implemented for matrices with block size 1 146 147 By default, the Manteuffel is applied (for matrices with block size 1). Call PCFactorSetShiftType(pc,MAT_SHIFT_POSITIVE_DEFINITE); 148 to turn off the shift. 149 150 References: 151 Review article: APPROXIMATE AND INCOMPLETE FACTORIZATIONS, TONY F. CHAN AND HENK A. VAN DER VORST 152 http://igitur-archive.library.uu.nl/math/2001-0621-115821/proc.pdf chapter in Parallel Numerical 153 Algorithms, edited by D. Keyes, A. Semah, V. Venkatakrishnan, ICASE/LaRC Interdisciplinary Series in 154 Science and Engineering, Kluwer, pp. 167--202. 155 156 157 .seealso: PCCreate(), PCSetType(), PCType (for list of available types), PC, PCSOR, MatOrderingType, 158 PCFactorSetZeroPivot(), PCFactorSetShiftType(), PCFactorSetShiftAmount(), 159 PCFactorSetFill(), PCFactorSetMatOrderingType(), PCFactorSetReuseOrdering(), 160 PCFactorSetLevels() 161 162 M*/ 163 164 EXTERN_C_BEGIN 165 #undef __FUNCT__ 166 #define __FUNCT__ "PCCreate_ICC" 167 PetscErrorCode PETSCKSP_DLLEXPORT PCCreate_ICC(PC pc) 168 { 169 PetscErrorCode ierr; 170 PC_ICC *icc; 171 172 PetscFunctionBegin; 173 ierr = PetscNewLog(pc,PC_ICC,&icc);CHKERRQ(ierr); 174 175 ((PC_Factor*)icc)->fact = 0; 176 ierr = PetscStrallocpy(MATORDERING_NATURAL,&((PC_Factor*)icc)->ordering);CHKERRQ(ierr); 177 ierr = PetscStrallocpy(MAT_SOLVER_PETSC,&((PC_Factor*)icc)->solvertype);CHKERRQ(ierr); 178 ierr = MatFactorInfoInitialize(&((PC_Factor*)icc)->info);CHKERRQ(ierr); 179 ((PC_Factor*)icc)->info.levels = 0.; 180 ((PC_Factor*)icc)->info.fill = 1.0; 181 icc->implctx = 0; 182 183 ((PC_Factor*)icc)->info.dtcol = PETSC_DEFAULT; 184 ((PC_Factor*)icc)->info.shifttype = MAT_SHIFT_POSITIVE_DEFINITE; 185 ((PC_Factor*)icc)->info.shiftamount = 0.0; 186 ((PC_Factor*)icc)->info.zeropivot = 1.e-12; 187 188 pc->data = (void*)icc; 189 pc->ops->apply = PCApply_ICC; 190 pc->ops->setup = PCSetup_ICC; 191 pc->ops->destroy = PCDestroy_ICC; 192 pc->ops->setfromoptions = PCSetFromOptions_ICC; 193 pc->ops->view = PCView_ICC; 194 pc->ops->getfactoredmatrix = PCFactorGetMatrix_Factor; 195 pc->ops->applysymmetricleft = PCApplySymmetricLeft_ICC; 196 pc->ops->applysymmetricright = PCApplySymmetricRight_ICC; 197 198 ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFactorGetMatSolverPackage_C","PCFactorGetMatSolverPackage_Factor", 199 PCFactorGetMatSolverPackage_Factor);CHKERRQ(ierr); 200 ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFactorSetZeroPivot_C","PCFactorSetZeroPivot_Factor", 201 PCFactorSetZeroPivot_Factor);CHKERRQ(ierr); 202 ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFactorSetShiftType_C","PCFactorSetShiftType_Factor", 203 PCFactorSetShiftType_Factor);CHKERRQ(ierr); 204 ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFactorSetShiftAmount_C","PCFactorSetShiftAmount_Factor", 205 PCFactorSetShiftAmount_Factor);CHKERRQ(ierr); 206 ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFactorSetLevels_C","PCFactorSetLevels_Factor", 207 PCFactorSetLevels_Factor);CHKERRQ(ierr); 208 ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFactorSetFill_C","PCFactorSetFill_Factor", 209 PCFactorSetFill_Factor);CHKERRQ(ierr); 210 ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFactorSetMatOrderingType_C","PCFactorSetMatOrderingType_Factor", 211 PCFactorSetMatOrderingType_Factor);CHKERRQ(ierr); 212 ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFactorSetMatSolverPackage_C","PCFactorSetMatSolverPackage_Factor", 213 PCFactorSetMatSolverPackage_Factor);CHKERRQ(ierr); 214 ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFactorSetDropTolerance_C","PCFactorSetDropTolerance_ILU", 215 PCFactorSetDropTolerance_ILU);CHKERRQ(ierr); 216 PetscFunctionReturn(0); 217 } 218 EXTERN_C_END 219 220 221