1dba47a55SKris Buschelman #define PETSCKSP_DLL 2dba47a55SKris Buschelman 39b54502bSHong Zhang /* 49b54502bSHong Zhang Defines a ILU factorization preconditioner for any Mat implementation 59b54502bSHong Zhang */ 67c4f633dSBarry Smith #include "../src/ksp/pc/impls/factor/ilu/ilu.h" /*I "petscpc.h" I*/ 79b54502bSHong Zhang 89b54502bSHong Zhang /* ------------------------------------------------------------------------------------------*/ 9afaefe49SHong Zhang EXTERN_C_BEGIN 10afaefe49SHong Zhang #undef __FUNCT__ 112401956bSBarry Smith #define __FUNCT__ "PCFactorSetReuseFill_ILU" 122401956bSBarry Smith PetscErrorCode PETSCKSP_DLLEXPORT PCFactorSetReuseFill_ILU(PC pc,PetscTruth flag) 132401956bSBarry Smith { 14075768bcSBarry Smith PC_ILU *lu = (PC_ILU*)pc->data; 152401956bSBarry Smith 162401956bSBarry Smith PetscFunctionBegin; 172401956bSBarry Smith lu->reusefill = flag; 182401956bSBarry Smith PetscFunctionReturn(0); 192401956bSBarry Smith } 202401956bSBarry Smith EXTERN_C_END 212401956bSBarry Smith 222401956bSBarry Smith EXTERN_C_BEGIN 232401956bSBarry Smith #undef __FUNCT__ 242401956bSBarry Smith #define __FUNCT__ "PCFactorReorderForNonzeroDiagonal_ILU" 252401956bSBarry Smith PetscErrorCode PETSCKSP_DLLEXPORT PCFactorReorderForNonzeroDiagonal_ILU(PC pc,PetscReal z) 269b54502bSHong Zhang { 279b54502bSHong Zhang PC_ILU *ilu = (PC_ILU*)pc->data; 289b54502bSHong Zhang 299b54502bSHong Zhang PetscFunctionBegin; 309b54502bSHong Zhang ilu->nonzerosalongdiagonal = PETSC_TRUE; 319b54502bSHong Zhang if (z == PETSC_DECIDE) { 329b54502bSHong Zhang ilu->nonzerosalongdiagonaltol = 1.e-10; 339b54502bSHong Zhang } else { 349b54502bSHong Zhang ilu->nonzerosalongdiagonaltol = z; 359b54502bSHong Zhang } 369b54502bSHong Zhang PetscFunctionReturn(0); 379b54502bSHong Zhang } 389b54502bSHong Zhang EXTERN_C_END 399b54502bSHong Zhang 409b54502bSHong Zhang #undef __FUNCT__ 419b54502bSHong Zhang #define __FUNCT__ "PCDestroy_ILU_Internal" 429b54502bSHong Zhang PetscErrorCode PCDestroy_ILU_Internal(PC pc) 439b54502bSHong Zhang { 449b54502bSHong Zhang PC_ILU *ilu = (PC_ILU*)pc->data; 459b54502bSHong Zhang PetscErrorCode ierr; 469b54502bSHong Zhang 479b54502bSHong Zhang PetscFunctionBegin; 48075768bcSBarry Smith if (!ilu->inplace && ((PC_Factor*)ilu)->fact) {ierr = MatDestroy(((PC_Factor*)ilu)->fact);CHKERRQ(ierr);} 499b54502bSHong Zhang if (ilu->row && ilu->col && ilu->row != ilu->col) {ierr = ISDestroy(ilu->row);CHKERRQ(ierr);} 509b54502bSHong Zhang if (ilu->col) {ierr = ISDestroy(ilu->col);CHKERRQ(ierr);} 519b54502bSHong Zhang PetscFunctionReturn(0); 529b54502bSHong Zhang } 539b54502bSHong Zhang 549b54502bSHong Zhang EXTERN_C_BEGIN 559b54502bSHong Zhang #undef __FUNCT__ 56b7c853c4SBarry Smith #define __FUNCT__ "PCFactorSetDropTolerance_ILU" 57b7c853c4SBarry Smith PetscErrorCode PETSCKSP_DLLEXPORT PCFactorSetDropTolerance_ILU(PC pc,PetscReal dt,PetscReal dtcol,PetscInt dtcount) 589b54502bSHong Zhang { 59075768bcSBarry Smith PC_ILU *ilu = (PC_ILU*)pc->data; 609b54502bSHong Zhang 619b54502bSHong Zhang PetscFunctionBegin; 624c9036c7SBarry Smith if (pc->setupcalled && (((PC_Factor*)ilu)->info.dt != dt || ((PC_Factor*)ilu)->info.dtcol != dtcol || ((PC_Factor*)ilu)->info.dtcount != dtcount)) { 634c9036c7SBarry Smith SETERRQ(PETSC_ERR_SUP,"Cannot change drop tolerance after using PC"); 649b54502bSHong Zhang } 65075768bcSBarry Smith ((PC_Factor*)ilu)->info.dt = dt; 66075768bcSBarry Smith ((PC_Factor*)ilu)->info.dtcol = dtcol; 67075768bcSBarry Smith ((PC_Factor*)ilu)->info.dtcount = dtcount; 684c9036c7SBarry Smith ((PC_Factor*)ilu)->info.usedt = 1.0; 699b54502bSHong Zhang PetscFunctionReturn(0); 709b54502bSHong Zhang } 719b54502bSHong Zhang EXTERN_C_END 729b54502bSHong Zhang 739b54502bSHong Zhang EXTERN_C_BEGIN 749b54502bSHong Zhang #undef __FUNCT__ 752401956bSBarry Smith #define __FUNCT__ "PCFactorSetReuseOrdering_ILU" 762401956bSBarry Smith PetscErrorCode PETSCKSP_DLLEXPORT PCFactorSetReuseOrdering_ILU(PC pc,PetscTruth flag) 779b54502bSHong Zhang { 78075768bcSBarry Smith PC_ILU *ilu = (PC_ILU*)pc->data; 799b54502bSHong Zhang 809b54502bSHong Zhang PetscFunctionBegin; 819b54502bSHong Zhang ilu->reuseordering = flag; 829b54502bSHong Zhang PetscFunctionReturn(0); 839b54502bSHong Zhang } 849b54502bSHong Zhang EXTERN_C_END 859b54502bSHong Zhang 869b54502bSHong Zhang EXTERN_C_BEGIN 879b54502bSHong Zhang #undef __FUNCT__ 882401956bSBarry Smith #define __FUNCT__ "PCFactorSetUseInPlace_ILU" 892401956bSBarry Smith PetscErrorCode PETSCKSP_DLLEXPORT PCFactorSetUseInPlace_ILU(PC pc) 909b54502bSHong Zhang { 91075768bcSBarry Smith PC_ILU *dir = (PC_ILU*)pc->data; 929b54502bSHong Zhang 939b54502bSHong Zhang PetscFunctionBegin; 949b54502bSHong Zhang dir->inplace = PETSC_TRUE; 959b54502bSHong Zhang PetscFunctionReturn(0); 969b54502bSHong Zhang } 979b54502bSHong Zhang EXTERN_C_END 989b54502bSHong Zhang 999b54502bSHong Zhang #undef __FUNCT__ 1009b54502bSHong Zhang #define __FUNCT__ "PCSetFromOptions_ILU" 1019b54502bSHong Zhang static PetscErrorCode PCSetFromOptions_ILU(PC pc) 1029b54502bSHong Zhang { 1039b54502bSHong Zhang PetscErrorCode ierr; 1049b54502bSHong Zhang PetscInt dtmax = 3,itmp; 1058ff23777SHong Zhang PetscTruth flg; 1069b54502bSHong Zhang PetscReal dt[3]; 1079b54502bSHong Zhang PC_ILU *ilu = (PC_ILU*)pc->data; 1089b54502bSHong Zhang PetscReal tol; 1099b54502bSHong Zhang 1109b54502bSHong Zhang PetscFunctionBegin; 1119b54502bSHong Zhang ierr = PetscOptionsHead("ILU Options");CHKERRQ(ierr); 1128ff23777SHong Zhang ierr = PCSetFromOptions_Factor(pc);CHKERRQ(ierr); 1138ff23777SHong Zhang 114075768bcSBarry Smith ierr = PetscOptionsInt("-pc_factor_levels","levels of fill","PCFactorSetLevels",(PetscInt)((PC_Factor*)ilu)->info.levels,&itmp,&flg);CHKERRQ(ierr); 115075768bcSBarry Smith if (flg) ((PC_Factor*)ilu)->info.levels = itmp; 11690d69ab7SBarry Smith flg = PETSC_FALSE; 11790d69ab7SBarry Smith ierr = PetscOptionsTruth("-pc_factor_diagonal_fill","Allow fill into empty diagonal entry","PCFactorSetAllowDiagonalFill",flg,&flg,PETSC_NULL);CHKERRQ(ierr); 118075768bcSBarry Smith ((PC_Factor*)ilu)->info.diagonal_fill = (double) flg; 1199b54502bSHong Zhang 120075768bcSBarry Smith dt[0] = ((PC_Factor*)ilu)->info.dt; 121075768bcSBarry Smith dt[1] = ((PC_Factor*)ilu)->info.dtcol; 122075768bcSBarry Smith dt[2] = ((PC_Factor*)ilu)->info.dtcount; 123b7c853c4SBarry Smith ierr = PetscOptionsRealArray("-pc_factor_drop_tolerance","<dt,dtcol,maxrowcount>","PCFactorSetDropTolerance",dt,&dtmax,&flg);CHKERRQ(ierr); 1249b54502bSHong Zhang if (flg) { 125b7c853c4SBarry Smith ierr = PCFactorSetDropTolerance(pc,dt[0],dt[1],(PetscInt)dt[2]);CHKERRQ(ierr); 1269b54502bSHong Zhang } 1278ff23777SHong Zhang 1282401956bSBarry Smith ierr = PetscOptionsName("-pc_factor_nonzeros_along_diagonal","Reorder to remove zeros from diagonal","PCFactorReorderForNonzeroDiagonal",&flg);CHKERRQ(ierr); 1299b54502bSHong Zhang if (flg) { 1309b54502bSHong Zhang tol = PETSC_DECIDE; 1312401956bSBarry Smith ierr = PetscOptionsReal("-pc_factor_nonzeros_along_diagonal","Reorder to remove zeros from diagonal","PCFactorReorderForNonzeroDiagonal",ilu->nonzerosalongdiagonaltol,&tol,0);CHKERRQ(ierr); 1322401956bSBarry Smith ierr = PCFactorReorderForNonzeroDiagonal(pc,tol);CHKERRQ(ierr); 1339b54502bSHong Zhang } 1349b54502bSHong Zhang 1359b54502bSHong Zhang ierr = PetscOptionsTail();CHKERRQ(ierr); 1369b54502bSHong Zhang PetscFunctionReturn(0); 1379b54502bSHong Zhang } 1389b54502bSHong Zhang 1399b54502bSHong Zhang #undef __FUNCT__ 1409b54502bSHong Zhang #define __FUNCT__ "PCView_ILU" 1419b54502bSHong Zhang static PetscErrorCode PCView_ILU(PC pc,PetscViewer viewer) 1429b54502bSHong Zhang { 1439b54502bSHong Zhang PC_ILU *ilu = (PC_ILU*)pc->data; 1449b54502bSHong Zhang PetscErrorCode ierr; 1459b54502bSHong Zhang PetscTruth isstring,iascii; 1469b54502bSHong Zhang 1479b54502bSHong Zhang PetscFunctionBegin; 1489b54502bSHong Zhang ierr = PetscTypeCompare((PetscObject)viewer,PETSC_VIEWER_STRING,&isstring);CHKERRQ(ierr); 1499b54502bSHong Zhang ierr = PetscTypeCompare((PetscObject)viewer,PETSC_VIEWER_ASCII,&iascii);CHKERRQ(ierr); 1509b54502bSHong Zhang if (iascii) { 1514c9036c7SBarry Smith if (((PC_Factor*)ilu)->info.dt > 0) { 152075768bcSBarry Smith ierr = PetscViewerASCIIPrintf(viewer," ILU: drop tolerance %G\n",((PC_Factor*)ilu)->info.dt);CHKERRQ(ierr); 153075768bcSBarry Smith ierr = PetscViewerASCIIPrintf(viewer," ILU: max nonzeros per row %D\n",(PetscInt)((PC_Factor*)ilu)->info.dtcount);CHKERRQ(ierr); 154075768bcSBarry Smith ierr = PetscViewerASCIIPrintf(viewer," ILU: column permutation tolerance %G\n",((PC_Factor*)ilu)->info.dtcol);CHKERRQ(ierr); 155075768bcSBarry Smith } else if (((PC_Factor*)ilu)->info.levels == 1) { 156075768bcSBarry Smith ierr = PetscViewerASCIIPrintf(viewer," ILU: %D level of fill\n",(PetscInt)((PC_Factor*)ilu)->info.levels);CHKERRQ(ierr); 1579b54502bSHong Zhang } else { 158075768bcSBarry Smith ierr = PetscViewerASCIIPrintf(viewer," ILU: %D levels of fill\n",(PetscInt)((PC_Factor*)ilu)->info.levels);CHKERRQ(ierr); 1599b54502bSHong Zhang } 160075768bcSBarry Smith ierr = PetscViewerASCIIPrintf(viewer," ILU: factor fill ratio allocated %G\n",((PC_Factor*)ilu)->info.fill);CHKERRQ(ierr); 161075768bcSBarry Smith ierr = PetscViewerASCIIPrintf(viewer," ILU: tolerance for zero pivot %G\n",((PC_Factor*)ilu)->info.zeropivot);CHKERRQ(ierr); 162*145b9266SHong Zhang 163*145b9266SHong Zhang if (((PC_Factor*)ilu)->info.shifttype==MAT_SHIFT_POSITIVE_DEFINITE) { 164*145b9266SHong Zhang ierr = PetscViewerASCIIPrintf(viewer," ILU: using Manteuffel shift\n");CHKERRQ(ierr); 165*145b9266SHong Zhang } 166*145b9266SHong Zhang if (((PC_Factor*)ilu)->info.shifttype==MAT_SHIFT_NONZERO) { 167*145b9266SHong Zhang ierr = PetscViewerASCIIPrintf(viewer," ILU: using diagonal shift to prevent zero pivot\n");CHKERRQ(ierr); 168*145b9266SHong Zhang } 169*145b9266SHong Zhang if (((PC_Factor*)ilu)->info.shifttype==MAT_SHIFT_INBLOCKS) { 170*145b9266SHong Zhang ierr = PetscViewerASCIIPrintf(viewer," ILU: using diagonal shift on blocks to prevent zero pivot\n");CHKERRQ(ierr); 171*145b9266SHong Zhang } 172*145b9266SHong Zhang 1739b54502bSHong Zhang if (ilu->inplace) {ierr = PetscViewerASCIIPrintf(viewer," in-place factorization\n");CHKERRQ(ierr);} 1749b54502bSHong Zhang else {ierr = PetscViewerASCIIPrintf(viewer," out-of-place factorization\n");CHKERRQ(ierr);} 175075768bcSBarry Smith ierr = PetscViewerASCIIPrintf(viewer," matrix ordering: %s\n",((PC_Factor*)ilu)->ordering);CHKERRQ(ierr); 1769b54502bSHong Zhang if (ilu->reusefill) {ierr = PetscViewerASCIIPrintf(viewer," Reusing fill from past factorization\n");CHKERRQ(ierr);} 1779b54502bSHong Zhang if (ilu->reuseordering) {ierr = PetscViewerASCIIPrintf(viewer," Reusing reordering from past factorization\n");CHKERRQ(ierr);} 178075768bcSBarry Smith if (((PC_Factor*)ilu)->fact) { 179f3a39becSBarry Smith ierr = PetscViewerASCIIPrintf(viewer," ILU: factor fill ratio needed %G\n",ilu->actualfill);CHKERRQ(ierr); 1809b54502bSHong Zhang ierr = PetscViewerASCIIPrintf(viewer," Factored matrix follows\n");CHKERRQ(ierr); 1819b54502bSHong Zhang ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 182f3a39becSBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 183f3a39becSBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 1849b54502bSHong Zhang ierr = PetscViewerPushFormat(viewer,PETSC_VIEWER_ASCII_INFO);CHKERRQ(ierr); 185075768bcSBarry Smith ierr = MatView(((PC_Factor*)ilu)->fact,viewer);CHKERRQ(ierr); 1869b54502bSHong Zhang ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr); 1879b54502bSHong Zhang ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 188f3a39becSBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 189f3a39becSBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 1909b54502bSHong Zhang } 1919b54502bSHong Zhang } else if (isstring) { 192075768bcSBarry Smith ierr = PetscViewerStringSPrintf(viewer," lvls=%D,order=%s",(PetscInt)((PC_Factor*)ilu)->info.levels,((PC_Factor*)ilu)->ordering);CHKERRQ(ierr);CHKERRQ(ierr); 1939b54502bSHong Zhang } else { 1949b54502bSHong Zhang SETERRQ1(PETSC_ERR_SUP,"Viewer type %s not supported for PCILU",((PetscObject)viewer)->type_name); 1959b54502bSHong Zhang } 1969b54502bSHong Zhang PetscFunctionReturn(0); 1979b54502bSHong Zhang } 1989b54502bSHong Zhang 1999b54502bSHong Zhang #undef __FUNCT__ 2009b54502bSHong Zhang #define __FUNCT__ "PCSetUp_ILU" 2019b54502bSHong Zhang static PetscErrorCode PCSetUp_ILU(PC pc) 2029b54502bSHong Zhang { 2039b54502bSHong Zhang PetscErrorCode ierr; 2049b54502bSHong Zhang PC_ILU *ilu = (PC_ILU*)pc->data; 205f3a39becSBarry Smith MatInfo info; 2069b54502bSHong Zhang 2079b54502bSHong Zhang PetscFunctionBegin; 2089b54502bSHong Zhang if (ilu->inplace) { 209075768bcSBarry Smith CHKMEMQ; 2109b54502bSHong Zhang if (!pc->setupcalled) { 2119b54502bSHong Zhang 2129b54502bSHong Zhang /* In-place factorization only makes sense with the natural ordering, 2139b54502bSHong Zhang so we only need to get the ordering once, even if nonzero structure changes */ 214075768bcSBarry Smith ierr = MatGetOrdering(pc->pmat,((PC_Factor*)ilu)->ordering,&ilu->row,&ilu->col);CHKERRQ(ierr); 215efee365bSSatish Balay if (ilu->row) {ierr = PetscLogObjectParent(pc,ilu->row);CHKERRQ(ierr);} 216efee365bSSatish Balay if (ilu->col) {ierr = PetscLogObjectParent(pc,ilu->col);CHKERRQ(ierr);} 2179b54502bSHong Zhang } 2189b54502bSHong Zhang 2199b54502bSHong Zhang /* In place ILU only makes sense with fill factor of 1.0 because 2209b54502bSHong Zhang cannot have levels of fill */ 221075768bcSBarry Smith ((PC_Factor*)ilu)->info.fill = 1.0; 22275567043SBarry Smith ((PC_Factor*)ilu)->info.diagonal_fill = 0.0; 223fe97e370SBarry Smith ierr = MatILUFactor(pc->pmat,ilu->row,ilu->col,&((PC_Factor*)ilu)->info);CHKERRQ(ierr);CHKMEMQ; 224075768bcSBarry Smith ((PC_Factor*)ilu)->fact = pc->pmat; 2259b54502bSHong Zhang } else { 2269b54502bSHong Zhang if (!pc->setupcalled) { 2279b54502bSHong Zhang /* first time in so compute reordering and symbolic factorization */ 228075768bcSBarry Smith ierr = MatGetOrdering(pc->pmat,((PC_Factor*)ilu)->ordering,&ilu->row,&ilu->col);CHKERRQ(ierr); 229efee365bSSatish Balay if (ilu->row) {ierr = PetscLogObjectParent(pc,ilu->row);CHKERRQ(ierr);} 230efee365bSSatish Balay if (ilu->col) {ierr = PetscLogObjectParent(pc,ilu->col);CHKERRQ(ierr);} 2319b54502bSHong Zhang /* Remove zeros along diagonal? */ 2329b54502bSHong Zhang if (ilu->nonzerosalongdiagonal) { 2339b54502bSHong Zhang ierr = MatReorderForNonzeroDiagonal(pc->pmat,ilu->nonzerosalongdiagonaltol,ilu->row,ilu->col);CHKERRQ(ierr); 2349b54502bSHong Zhang } 235075768bcSBarry Smith CHKMEMQ; 23611bfe483SHong Zhang ierr = MatGetFactor(pc->pmat,((PC_Factor*)ilu)->solvertype,MAT_FACTOR_ILU,&((PC_Factor*)ilu)->fact);CHKERRQ(ierr); 237075768bcSBarry Smith CHKMEMQ; 238075768bcSBarry Smith ierr = MatILUFactorSymbolic(((PC_Factor*)ilu)->fact,pc->pmat,ilu->row,ilu->col,&((PC_Factor*)ilu)->info);CHKERRQ(ierr); 239075768bcSBarry Smith ierr = MatGetInfo(((PC_Factor*)ilu)->fact,MAT_LOCAL,&info);CHKERRQ(ierr); 240f3a39becSBarry Smith ilu->actualfill = info.fill_ratio_needed; 241075768bcSBarry Smith ierr = PetscLogObjectParent(pc,((PC_Factor*)ilu)->fact);CHKERRQ(ierr); 2429b54502bSHong Zhang } else if (pc->flag != SAME_NONZERO_PATTERN) { 2439b54502bSHong Zhang if (!ilu->reuseordering) { 2449b54502bSHong Zhang /* compute a new ordering for the ILU */ 2459b54502bSHong Zhang ierr = ISDestroy(ilu->row);CHKERRQ(ierr); 2469b54502bSHong Zhang ierr = ISDestroy(ilu->col);CHKERRQ(ierr); 247075768bcSBarry Smith ierr = MatGetOrdering(pc->pmat,((PC_Factor*)ilu)->ordering,&ilu->row,&ilu->col);CHKERRQ(ierr); 248efee365bSSatish Balay if (ilu->row) {ierr = PetscLogObjectParent(pc,ilu->row);CHKERRQ(ierr);} 249efee365bSSatish Balay if (ilu->col) {ierr = PetscLogObjectParent(pc,ilu->col);CHKERRQ(ierr);} 2509b54502bSHong Zhang /* Remove zeros along diagonal? */ 2519b54502bSHong Zhang if (ilu->nonzerosalongdiagonal) { 2529b54502bSHong Zhang ierr = MatReorderForNonzeroDiagonal(pc->pmat,ilu->nonzerosalongdiagonaltol,ilu->row,ilu->col);CHKERRQ(ierr); 2539b54502bSHong Zhang } 2549b54502bSHong Zhang } 255075768bcSBarry Smith ierr = MatDestroy(((PC_Factor*)ilu)->fact);CHKERRQ(ierr); 256075768bcSBarry Smith ierr = MatGetFactor(pc->pmat,MAT_SOLVER_PETSC,MAT_FACTOR_ILU,&((PC_Factor*)ilu)->fact);CHKERRQ(ierr); 257075768bcSBarry Smith ierr = MatILUFactorSymbolic(((PC_Factor*)ilu)->fact,pc->pmat,ilu->row,ilu->col,&((PC_Factor*)ilu)->info);CHKERRQ(ierr); 258075768bcSBarry Smith ierr = MatGetInfo(((PC_Factor*)ilu)->fact,MAT_LOCAL,&info);CHKERRQ(ierr); 259f3a39becSBarry Smith ilu->actualfill = info.fill_ratio_needed; 260075768bcSBarry Smith ierr = PetscLogObjectParent(pc,((PC_Factor*)ilu)->fact);CHKERRQ(ierr); 2619b54502bSHong Zhang } 262075768bcSBarry Smith CHKMEMQ; 263075768bcSBarry Smith ierr = MatLUFactorNumeric(((PC_Factor*)ilu)->fact,pc->pmat,&((PC_Factor*)ilu)->info);CHKERRQ(ierr); 264075768bcSBarry Smith CHKMEMQ; 2659b54502bSHong Zhang } 2669b54502bSHong Zhang PetscFunctionReturn(0); 2679b54502bSHong Zhang } 2689b54502bSHong Zhang 2699b54502bSHong Zhang #undef __FUNCT__ 2709b54502bSHong Zhang #define __FUNCT__ "PCDestroy_ILU" 2719b54502bSHong Zhang static PetscErrorCode PCDestroy_ILU(PC pc) 2729b54502bSHong Zhang { 2739b54502bSHong Zhang PC_ILU *ilu = (PC_ILU*)pc->data; 2749b54502bSHong Zhang PetscErrorCode ierr; 2759b54502bSHong Zhang 2769b54502bSHong Zhang PetscFunctionBegin; 2779b54502bSHong Zhang ierr = PCDestroy_ILU_Internal(pc);CHKERRQ(ierr); 27862ba1fd3SLisandro Dalcin ierr = PetscStrfree(((PC_Factor*)ilu)->solvertype);CHKERRQ(ierr); 279075768bcSBarry Smith ierr = PetscStrfree(((PC_Factor*)ilu)->ordering);CHKERRQ(ierr); 2809b54502bSHong Zhang ierr = PetscFree(ilu);CHKERRQ(ierr); 2819b54502bSHong Zhang PetscFunctionReturn(0); 2829b54502bSHong Zhang } 2839b54502bSHong Zhang 2849b54502bSHong Zhang #undef __FUNCT__ 2859b54502bSHong Zhang #define __FUNCT__ "PCApply_ILU" 2869b54502bSHong Zhang static PetscErrorCode PCApply_ILU(PC pc,Vec x,Vec y) 2879b54502bSHong Zhang { 2889b54502bSHong Zhang PC_ILU *ilu = (PC_ILU*)pc->data; 2899b54502bSHong Zhang PetscErrorCode ierr; 2909b54502bSHong Zhang 2919b54502bSHong Zhang PetscFunctionBegin; 292075768bcSBarry Smith ierr = MatSolve(((PC_Factor*)ilu)->fact,x,y);CHKERRQ(ierr); 2939b54502bSHong Zhang PetscFunctionReturn(0); 2949b54502bSHong Zhang } 2959b54502bSHong Zhang 2969b54502bSHong Zhang #undef __FUNCT__ 2979b54502bSHong Zhang #define __FUNCT__ "PCApplyTranspose_ILU" 2989b54502bSHong Zhang static PetscErrorCode PCApplyTranspose_ILU(PC pc,Vec x,Vec y) 2999b54502bSHong Zhang { 3009b54502bSHong Zhang PC_ILU *ilu = (PC_ILU*)pc->data; 3019b54502bSHong Zhang PetscErrorCode ierr; 3029b54502bSHong Zhang 3039b54502bSHong Zhang PetscFunctionBegin; 304075768bcSBarry Smith ierr = MatSolveTranspose(((PC_Factor*)ilu)->fact,x,y);CHKERRQ(ierr); 3059b54502bSHong Zhang PetscFunctionReturn(0); 3069b54502bSHong Zhang } 3079b54502bSHong Zhang 3089b54502bSHong Zhang /*MC 3099b54502bSHong Zhang PCILU - Incomplete factorization preconditioners. 3109b54502bSHong Zhang 3119b54502bSHong Zhang Options Database Keys: 3122401956bSBarry Smith + -pc_factor_levels <k> - number of levels of fill for ILU(k) 3132401956bSBarry Smith . -pc_factor_in_place - only for ILU(0) with natural ordering, reuses the space of the matrix for 3149b54502bSHong Zhang its factorization (overwrites original matrix) 3152401956bSBarry Smith . -pc_factor_diagonal_fill - fill in a zero diagonal even if levels of fill indicate it wouldn't be fill 3162401956bSBarry Smith . -pc_factor_reuse_ordering - reuse ordering of factorized matrix from previous factorization 317b7c853c4SBarry Smith . -pc_factor_drop_tolerance <dt,dtcol,maxrowcount> - use drop tolerance factorization 31855ba2a51SBarry Smith . -pc_factor_fill <nfill> - expected amount of fill in factored matrix compared to original matrix, nfill > 1 3192401956bSBarry Smith . -pc_factor_nonzeros_along_diagonal - reorder the matrix before factorization to remove zeros from the diagonal, 3209b54502bSHong Zhang this decreases the chance of getting a zero pivot 3212401956bSBarry Smith . -pc_factor_mat_ordering_type <natural,nd,1wd,rcm,qmd> - set the row/column ordering of the factored matrix 3222401956bSBarry Smith . -pc_factor_pivot_in_blocks - for block ILU(k) factorization, i.e. with BAIJ matrices with block size larger 3239b54502bSHong Zhang than 1 the diagonal blocks are factored with partial pivoting (this increases the 3249b54502bSHong Zhang stability of the ILU factorization 3259b54502bSHong Zhang 3269b54502bSHong Zhang Level: beginner 3279b54502bSHong Zhang 3289b54502bSHong Zhang Concepts: incomplete factorization 3299b54502bSHong Zhang 330d9ba8547SBarry Smith Notes: Only implemented for some matrix formats. (for parallel see PCHYPRE for hypre's ILU) 3319b54502bSHong Zhang 3329b54502bSHong Zhang For BAIJ matrices this implements a point block ILU 3339b54502bSHong Zhang 334c582cd25SBarry Smith References: 335c582cd25SBarry Smith T. Dupont, R. Kendall, and H. Rachford. An approximate factorization procedure for solving 336c582cd25SBarry Smith self-adjoint elliptic difference equations. SIAM J. Numer. Anal., 5:559--573, 1968. 337c582cd25SBarry Smith 338c582cd25SBarry Smith T.A. Oliphant. An implicit numerical method for solving two-dimensional time-dependent dif- 339c582cd25SBarry Smith fusion problems. Quart. Appl. Math., 19:221--229, 1961. 340c582cd25SBarry Smith 341c582cd25SBarry Smith Review article: APPROXIMATE AND INCOMPLETE FACTORIZATIONS, TONY F. CHAN AND HENK A. VAN DER VORST 342c582cd25SBarry Smith http://igitur-archive.library.uu.nl/math/2001-0621-115821/proc.pdf chapter in Parallel Numerical 343c582cd25SBarry Smith Algorithms, edited by D. Keyes, A. Semah, V. Venkatakrishnan, ICASE/LaRC Interdisciplinary Series in 344c582cd25SBarry Smith Science and Engineering, Kluwer, pp. 167--202. 345c582cd25SBarry Smith 346c582cd25SBarry Smith 3479b54502bSHong Zhang .seealso: PCCreate(), PCSetType(), PCType (for list of available types), PC, PCSOR, MatOrderingType, 348*145b9266SHong Zhang PCFactorSetZeroPivot(), PCFactorSetShiftSetType(), PCFactorSetAmount(), 349b7c853c4SBarry Smith PCFactorSetDropTolerance(),PCFactorSetFill(), PCFactorSetMatOrderingType(), PCFactorSetReuseOrdering(), 3508ff23777SHong Zhang PCFactorSetLevels(), PCFactorSetUseInPlace(), PCFactorSetAllowDiagonalFill(), PCFactorSetPivotInBlocks() 3519b54502bSHong Zhang 3529b54502bSHong Zhang M*/ 3539b54502bSHong Zhang 3549b54502bSHong Zhang EXTERN_C_BEGIN 3559b54502bSHong Zhang #undef __FUNCT__ 3569b54502bSHong Zhang #define __FUNCT__ "PCCreate_ILU" 357dba47a55SKris Buschelman PetscErrorCode PETSCKSP_DLLEXPORT PCCreate_ILU(PC pc) 3589b54502bSHong Zhang { 3599b54502bSHong Zhang PetscErrorCode ierr; 3609b54502bSHong Zhang PC_ILU *ilu; 3619b54502bSHong Zhang 3629b54502bSHong Zhang PetscFunctionBegin; 36338f2d2fdSLisandro Dalcin ierr = PetscNewLog(pc,PC_ILU,&ilu);CHKERRQ(ierr); 3649b54502bSHong Zhang 365075768bcSBarry Smith ((PC_Factor*)ilu)->fact = 0; 366075768bcSBarry Smith ierr = MatFactorInfoInitialize(&((PC_Factor*)ilu)->info);CHKERRQ(ierr); 36775567043SBarry Smith ((PC_Factor*)ilu)->info.levels = 0.; 368075768bcSBarry Smith ((PC_Factor*)ilu)->info.fill = 1.0; 3699b54502bSHong Zhang ilu->col = 0; 3709b54502bSHong Zhang ilu->row = 0; 3719b54502bSHong Zhang ilu->inplace = PETSC_FALSE; 37211bfe483SHong Zhang ierr = PetscStrallocpy(MAT_SOLVER_PETSC,&((PC_Factor*)ilu)->solvertype);CHKERRQ(ierr); 373075768bcSBarry Smith ierr = PetscStrallocpy(MATORDERING_NATURAL,&((PC_Factor*)ilu)->ordering);CHKERRQ(ierr); 3749b54502bSHong Zhang ilu->reuseordering = PETSC_FALSE; 375075768bcSBarry Smith ((PC_Factor*)ilu)->info.dt = PETSC_DEFAULT; 376075768bcSBarry Smith ((PC_Factor*)ilu)->info.dtcount = PETSC_DEFAULT; 377075768bcSBarry Smith ((PC_Factor*)ilu)->info.dtcol = PETSC_DEFAULT; 378915743fcSHong Zhang ((PC_Factor*)ilu)->info.shifttype = MAT_SHIFT_NONZERO; 379915743fcSHong Zhang ((PC_Factor*)ilu)->info.shiftamount = 1.e-12; 380075768bcSBarry Smith ((PC_Factor*)ilu)->info.zeropivot = 1.e-12; 381075768bcSBarry Smith ((PC_Factor*)ilu)->info.pivotinblocks = 1.0; 3829b54502bSHong Zhang ilu->reusefill = PETSC_FALSE; 38375567043SBarry Smith ((PC_Factor*)ilu)->info.diagonal_fill = 0.; 3849b54502bSHong Zhang pc->data = (void*)ilu; 3859b54502bSHong Zhang 3869b54502bSHong Zhang pc->ops->destroy = PCDestroy_ILU; 3879b54502bSHong Zhang pc->ops->apply = PCApply_ILU; 3889b54502bSHong Zhang pc->ops->applytranspose = PCApplyTranspose_ILU; 3899b54502bSHong Zhang pc->ops->setup = PCSetUp_ILU; 3909b54502bSHong Zhang pc->ops->setfromoptions = PCSetFromOptions_ILU; 39185317021SBarry Smith pc->ops->getfactoredmatrix = PCFactorGetMatrix_Factor; 3929b54502bSHong Zhang pc->ops->view = PCView_ILU; 3939b54502bSHong Zhang pc->ops->applyrichardson = 0; 3949b54502bSHong Zhang 39585317021SBarry Smith ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFactorSetZeroPivot_C","PCFactorSetZeroPivot_Factor", 39685317021SBarry Smith PCFactorSetZeroPivot_Factor);CHKERRQ(ierr); 397d90ac83dSHong Zhang ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFactorSetShiftType_C","PCFactorSetShiftType_Factor", 398d90ac83dSHong Zhang PCFactorSetShiftType_Factor);CHKERRQ(ierr); 399d90ac83dSHong Zhang ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFactorSetShiftAmount_C","PCFactorSetShiftAmount_Factor", 400d90ac83dSHong Zhang PCFactorSetShiftAmount_Factor);CHKERRQ(ierr); 4017112b564SBarry Smith ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFactorGetMatSolverPackage_C","PCFactorGetMatSolverPackage_Factor", 4027112b564SBarry Smith PCFactorGetMatSolverPackage_Factor);CHKERRQ(ierr); 40311bfe483SHong Zhang ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFactorSetMatSolverPackage_C","PCFactorSetMatSolverPackage_Factor", 40411bfe483SHong Zhang PCFactorSetMatSolverPackage_Factor);CHKERRQ(ierr); 405b7c853c4SBarry Smith ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFactorSetDropTolerance_C","PCFactorSetDropTolerance_ILU", 406b7c853c4SBarry Smith PCFactorSetDropTolerance_ILU);CHKERRQ(ierr); 40785317021SBarry Smith ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFactorSetFill_C","PCFactorSetFill_Factor", 40885317021SBarry Smith PCFactorSetFill_Factor);CHKERRQ(ierr); 40985317021SBarry Smith ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFactorSetMatOrderingType_C","PCFactorSetMatOrderingType_Factor", 41085317021SBarry Smith PCFactorSetMatOrderingType_Factor);CHKERRQ(ierr); 4112401956bSBarry Smith ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFactorSetReuseOrdering_C","PCFactorSetReuseOrdering_ILU", 4122401956bSBarry Smith PCFactorSetReuseOrdering_ILU);CHKERRQ(ierr); 4132401956bSBarry Smith ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFactorSetReuseFill_C","PCFactorSetReuseFill_ILU", 4142401956bSBarry Smith PCFactorSetReuseFill_ILU);CHKERRQ(ierr); 41585317021SBarry Smith ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFactorSetLevels_C","PCFactorSetLevels_Factor", 41685317021SBarry Smith PCFactorSetLevels_Factor);CHKERRQ(ierr); 4172401956bSBarry Smith ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFactorSetUseInPlace_C","PCFactorSetUseInPlace_ILU", 4182401956bSBarry Smith PCFactorSetUseInPlace_ILU);CHKERRQ(ierr); 41985317021SBarry Smith ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFactorSetAllowDiagonalFill_C","PCFactorSetAllowDiagonalFill_Factor", 42085317021SBarry Smith PCFactorSetAllowDiagonalFill_Factor);CHKERRQ(ierr); 42185317021SBarry Smith ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFactorSetPivotInBlocks_C","PCFactorSetPivotInBlocks_Factor", 42285317021SBarry Smith PCFactorSetPivotInBlocks_Factor);CHKERRQ(ierr); 4232401956bSBarry Smith ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCFactorReorderForNonzeroDiagonal_C","PCFactorReorderForNonzeroDiagonal_ILU", 4242401956bSBarry Smith PCFactorReorderForNonzeroDiagonal_ILU);CHKERRQ(ierr); 4259b54502bSHong Zhang PetscFunctionReturn(0); 4269b54502bSHong Zhang } 4279b54502bSHong Zhang EXTERN_C_END 428