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 PetscErrorCode ierr; 92 93 PetscFunctionBegin; 94 ierr = PetscOptionsHead("ICC Options");CHKERRQ(ierr); 95 ierr = PCSetFromOptions_Factor(pc);CHKERRQ(ierr); 96 97 ierr = PetscOptionsReal("-pc_factor_levels","levels of fill","PCFactorSetLevels",((PC_Factor*)icc)->info.levels,&((PC_Factor*)icc)->info.levels,&flg);CHKERRQ(ierr); 98 ierr = PetscOptionsTail();CHKERRQ(ierr); 99 PetscFunctionReturn(0); 100 } 101 102 #undef __FUNCT__ 103 #define __FUNCT__ "PCView_ICC" 104 static PetscErrorCode PCView_ICC(PC pc,PetscViewer viewer) 105 { 106 PC_ICC *icc = (PC_ICC*)pc->data; 107 PetscErrorCode ierr; 108 PetscTruth isstring,iascii; 109 110 PetscFunctionBegin; 111 ierr = PetscTypeCompare((PetscObject)viewer,PETSC_VIEWER_STRING,&isstring);CHKERRQ(ierr); 112 ierr = PetscTypeCompare((PetscObject)viewer,PETSC_VIEWER_ASCII,&iascii);CHKERRQ(ierr); 113 if (iascii) { 114 if (((PC_Factor*)icc)->info.levels == 1) { 115 ierr = PetscViewerASCIIPrintf(viewer," ICC: %D level of fill\n",(PetscInt)((PC_Factor*)icc)->info.levels);CHKERRQ(ierr); 116 } else { 117 ierr = PetscViewerASCIIPrintf(viewer," ICC: %D levels of fill\n",(PetscInt)((PC_Factor*)icc)->info.levels);CHKERRQ(ierr); 118 } 119 ierr = PetscViewerASCIIPrintf(viewer," ICC: factor fill ratio allocated %G, ordering used %s\n",((PC_Factor*)icc)->info.fill,((PC_Factor*)icc)->ordering);CHKERRQ(ierr); 120 if (((PC_Factor*)icc)->info.shiftpd) {ierr = PetscViewerASCIIPrintf(viewer," ICC: using Manteuffel shift\n");CHKERRQ(ierr);} 121 if (((PC_Factor*)icc)->info.shiftnz) {ierr = PetscViewerASCIIPrintf(viewer," ICC: using diagonal shift to prevent zero pivot\n");CHKERRQ(ierr);} 122 if (((PC_Factor*)icc)->fact) { 123 ierr = PetscViewerASCIIPrintf(viewer," ICC: factor fill ratio needed %G\n",icc->actualfill);CHKERRQ(ierr); 124 ierr = PetscViewerASCIIPrintf(viewer," Factored matrix follows\n");CHKERRQ(ierr); 125 ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 126 ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 127 ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 128 ierr = PetscViewerPushFormat(viewer,PETSC_VIEWER_ASCII_INFO);CHKERRQ(ierr); 129 ierr = MatView(((PC_Factor*)icc)->fact,viewer);CHKERRQ(ierr); 130 ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr); 131 ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 132 ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 133 ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 134 } 135 } else if (isstring) { 136 ierr = PetscViewerStringSPrintf(viewer," lvls=%D",(PetscInt)((PC_Factor*)icc)->info.levels);CHKERRQ(ierr);CHKERRQ(ierr); 137 } else { 138 SETERRQ1(PETSC_ERR_SUP,"Viewer type %s not supported for PCICC",((PetscObject)viewer)->type_name); 139 } 140 PetscFunctionReturn(0); 141 } 142 143 /*MC 144 PCICC - Incomplete Cholesky factorization preconditioners. 145 146 Options Database Keys: 147 + -pc_factor_levels <k> - number of levels of fill for ICC(k) 148 . -pc_factor_in_place - only for ICC(0) with natural ordering, reuses the space of the matrix for 149 its factorization (overwrites original matrix) 150 . -pc_factor_fill <nfill> - expected amount of fill in factored matrix compared to original matrix, nfill > 1 151 . -pc_factor_mat_ordering_type <natural,nd,1wd,rcm,qmd> - set the row/column ordering of the factored matrix 152 . -pc_factor_shift_nonzero <shift> - Sets shift amount or PETSC_DECIDE for the default 153 - -pc_factor_shift_positive_definite [PETSC_TRUE/PETSC_FALSE] - Activate/Deactivate PCFactorSetShiftPd(); the value 154 is optional with PETSC_TRUE being the default 155 156 Level: beginner 157 158 Concepts: incomplete Cholesky factorization 159 160 Notes: Only implemented for some matrix formats. Not implemented in parallel. 161 162 For BAIJ matrices this implements a point block ICC. 163 164 The Manteuffel shift is only implemented for matrices with block size 1 165 166 By default, the Manteuffel is applied (for matrices with block size 1). Call PCFactorSetShiftPd(pc,PETSC_FALSE); 167 to turn off the shift. 168 169 References: 170 Review article: APPROXIMATE AND INCOMPLETE FACTORIZATIONS, TONY F. CHAN AND HENK A. VAN DER VORST 171 http://igitur-archive.library.uu.nl/math/2001-0621-115821/proc.pdf chapter in Parallel Numerical 172 Algorithms, edited by D. Keyes, A. Semah, V. Venkatakrishnan, ICASE/LaRC Interdisciplinary Series in 173 Science and Engineering, Kluwer, pp. 167--202. 174 175 176 .seealso: PCCreate(), PCSetType(), PCType (for list of available types), PC, PCSOR, MatOrderingType, 177 PCFactorSetZeroPivot(), PCFactorSetShiftNonzero(), PCFactorSetShiftPd(),PCFactorSetShiftInBlocks(), 178 PCFactorSetFill(), PCFactorSetMatOrderingType(), PCFactorSetReuseOrdering(), 179 PCFactorSetLevels() 180 181 M*/ 182 183 EXTERN_C_BEGIN 184 #undef __FUNCT__ 185 #define __FUNCT__ "PCCreate_ICC" 186 PetscErrorCode PETSCKSP_DLLEXPORT PCCreate_ICC(PC pc) 187 { 188 PetscErrorCode ierr; 189 PC_ICC *icc; 190 191 PetscFunctionBegin; 192 ierr = PetscNewLog(pc,PC_ICC,&icc);CHKERRQ(ierr); 193 194 ((PC_Factor*)icc)->fact = 0; 195 ierr = PetscStrallocpy(MATORDERING_NATURAL,&((PC_Factor*)icc)->ordering);CHKERRQ(ierr); 196 ierr = PetscStrallocpy(MAT_SOLVER_PETSC,&((PC_Factor*)icc)->solvertype);CHKERRQ(ierr); 197 ierr = MatFactorInfoInitialize(&((PC_Factor*)icc)->info);CHKERRQ(ierr); 198 ((PC_Factor*)icc)->info.levels = 0.; 199 ((PC_Factor*)icc)->info.fill = 1.0; 200 icc->implctx = 0; 201 202 ((PC_Factor*)icc)->info.dtcol = PETSC_DEFAULT; 203 ((PC_Factor*)icc)->info.shiftnz = 0.0; 204 ((PC_Factor*)icc)->info.shiftpd = 1.0; /* true */ 205 ((PC_Factor*)icc)->info.zeropivot = 1.e-12; 206 pc->data = (void*)icc; 207 208 pc->ops->apply = PCApply_ICC; 209 pc->ops->setup = PCSetup_ICC; 210 pc->ops->destroy = PCDestroy_ICC; 211 pc->ops->setfromoptions = PCSetFromOptions_ICC; 212 pc->ops->view = PCView_ICC; 213 pc->ops->getfactoredmatrix = PCFactorGetMatrix_Factor; 214 pc->ops->applysymmetricleft = PCApplySymmetricLeft_ICC; 215 pc->ops->applysymmetricright = PCApplySymmetricRight_ICC; 216 217 ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFactorGetMatSolverPackage_C","PCFactorGetMatSolverPackage_Factor", 218 PCFactorGetMatSolverPackage_Factor);CHKERRQ(ierr); 219 ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFactorSetZeroPivot_C","PCFactorSetZeroPivot_Factor", 220 PCFactorSetZeroPivot_Factor);CHKERRQ(ierr); 221 ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFactorSetShiftNonzero_C","PCFactorSetShiftNonzero_Factor", 222 PCFactorSetShiftNonzero_Factor);CHKERRQ(ierr); 223 ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFactorSetShiftPd_C","PCFactorSetShiftPd_Factor", 224 PCFactorSetShiftPd_Factor);CHKERRQ(ierr); 225 ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFactorSetShiftInBlocks_C","PCFactorSetShiftInBlocks_Factor", 226 PCFactorSetShiftInBlocks_Factor);CHKERRQ(ierr); 227 228 ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFactorSetLevels_C","PCFactorSetLevels_Factor", 229 PCFactorSetLevels_Factor);CHKERRQ(ierr); 230 ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFactorSetFill_C","PCFactorSetFill_Factor", 231 PCFactorSetFill_Factor);CHKERRQ(ierr); 232 ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFactorSetMatOrderingType_C","PCFactorSetMatOrderingType_Factor", 233 PCFactorSetMatOrderingType_Factor);CHKERRQ(ierr); 234 ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFactorSetMatSolverPackage_C","PCFactorSetMatSolverPackage_Factor", 235 PCFactorSetMatSolverPackage_Factor);CHKERRQ(ierr); 236 PetscFunctionReturn(0); 237 } 238 EXTERN_C_END 239 240 241