xref: /petsc/src/ksp/pc/impls/factor/cholesky/cholesky.c (revision ee45ca4afdde1af4d1deda7cd4dc1a4a63a3ea97)
19b54502bSHong Zhang 
29b54502bSHong Zhang /*
39b54502bSHong Zhang    Defines a direct factorization preconditioner for any Mat implementation
49b54502bSHong Zhang    Note: this need not be consided a preconditioner since it supplies
59b54502bSHong Zhang          a direct solver.
69b54502bSHong Zhang */
79b54502bSHong Zhang #include "src/ksp/pc/pcimpl.h"                /*I "petscpc.h" I*/
89b54502bSHong Zhang 
99b54502bSHong Zhang typedef struct {
109b54502bSHong Zhang   Mat             fact;             /* factored matrix */
119b54502bSHong Zhang   PetscReal       actualfill;       /* actual fill in factor */
129b54502bSHong Zhang   PetscTruth      inplace;          /* flag indicating in-place factorization */
139b54502bSHong Zhang   IS              row,col;          /* index sets used for reordering */
149b54502bSHong Zhang   MatOrderingType ordering;         /* matrix ordering */
159b54502bSHong Zhang   PetscTruth      reuseordering;    /* reuses previous reordering computed */
169b54502bSHong Zhang   PetscTruth      reusefill;        /* reuse fill from previous Cholesky */
179b54502bSHong Zhang   MatFactorInfo   info;
189b54502bSHong Zhang } PC_Cholesky;
199b54502bSHong Zhang 
209b54502bSHong Zhang EXTERN_C_BEGIN
219b54502bSHong Zhang #undef __FUNCT__
229b54502bSHong Zhang #define __FUNCT__ "PCCholeskySetReuseOrdering_Cholesky"
239b54502bSHong Zhang PetscErrorCode PCCholeskySetReuseOrdering_Cholesky(PC pc,PetscTruth flag)
249b54502bSHong Zhang {
259b54502bSHong Zhang   PC_Cholesky *lu;
269b54502bSHong Zhang 
279b54502bSHong Zhang   PetscFunctionBegin;
289b54502bSHong Zhang   lu               = (PC_Cholesky*)pc->data;
299b54502bSHong Zhang   lu->reuseordering = flag;
309b54502bSHong Zhang   PetscFunctionReturn(0);
319b54502bSHong Zhang }
329b54502bSHong Zhang EXTERN_C_END
339b54502bSHong Zhang 
349b54502bSHong Zhang EXTERN_C_BEGIN
359b54502bSHong Zhang #undef __FUNCT__
369b54502bSHong Zhang #define __FUNCT__ "PCCholeskySetReuseFill_Cholesky"
379b54502bSHong Zhang PetscErrorCode PCCholeskySetReuseFill_Cholesky(PC pc,PetscTruth flag)
389b54502bSHong Zhang {
399b54502bSHong Zhang   PC_Cholesky *lu;
409b54502bSHong Zhang 
419b54502bSHong Zhang   PetscFunctionBegin;
429b54502bSHong Zhang   lu = (PC_Cholesky*)pc->data;
439b54502bSHong Zhang   lu->reusefill = flag;
449b54502bSHong Zhang   PetscFunctionReturn(0);
459b54502bSHong Zhang }
469b54502bSHong Zhang EXTERN_C_END
479b54502bSHong Zhang 
489b54502bSHong Zhang #undef __FUNCT__
499b54502bSHong Zhang #define __FUNCT__ "PCSetFromOptions_Cholesky"
509b54502bSHong Zhang static PetscErrorCode PCSetFromOptions_Cholesky(PC pc)
519b54502bSHong Zhang {
529b54502bSHong Zhang   PC_Cholesky    *lu = (PC_Cholesky*)pc->data;
539b54502bSHong Zhang   PetscErrorCode ierr;
549b54502bSHong Zhang   PetscTruth     flg;
559b54502bSHong Zhang   char           tname[256];
569b54502bSHong Zhang   PetscFList     ordlist;
579b54502bSHong Zhang 
589b54502bSHong Zhang   PetscFunctionBegin;
599b54502bSHong Zhang   ierr = MatOrderingRegisterAll(PETSC_NULL);CHKERRQ(ierr);
609b54502bSHong Zhang   ierr = PetscOptionsHead("Cholesky options");CHKERRQ(ierr);
619b54502bSHong Zhang   ierr = PetscOptionsName("-pc_cholesky_in_place","Form Cholesky in the same memory as the matrix","PCCholeskySetUseInPlace",&flg);CHKERRQ(ierr);
629b54502bSHong Zhang   if (flg) {
639b54502bSHong Zhang     ierr = PCCholeskySetUseInPlace(pc);CHKERRQ(ierr);
649b54502bSHong Zhang   }
659b54502bSHong Zhang   ierr = PetscOptionsReal("-pc_cholesky_fill","Expected non-zeros in Cholesky/non-zeros in matrix","PCCholeskySetFill",lu->info.fill,&lu->info.fill,0);CHKERRQ(ierr);
669b54502bSHong Zhang 
679b54502bSHong Zhang   ierr = PetscOptionsName("-pc_cholesky_reuse_fill","Use fill from previous factorization","PCCholeskySetReuseFill",&flg);CHKERRQ(ierr);
689b54502bSHong Zhang   if (flg) {
699b54502bSHong Zhang     ierr = PCCholeskySetReuseFill(pc,PETSC_TRUE);CHKERRQ(ierr);
709b54502bSHong Zhang   }
719b54502bSHong Zhang   ierr = PetscOptionsName("-pc_cholesky_reuse_ordering","Reuse ordering from previous factorization","PCCholeskySetReuseOrdering",&flg);CHKERRQ(ierr);
729b54502bSHong Zhang   if (flg) {
739b54502bSHong Zhang     ierr = PCCholeskySetReuseOrdering(pc,PETSC_TRUE);CHKERRQ(ierr);
749b54502bSHong Zhang   }
759b54502bSHong Zhang 
769b54502bSHong Zhang   ierr = MatGetOrderingList(&ordlist);CHKERRQ(ierr);
779b54502bSHong Zhang   ierr = PetscOptionsList("-pc_cholesky_mat_ordering_type","Reordering to reduce nonzeros in Cholesky","PCCholeskySetMatOrdering",ordlist,lu->ordering,tname,256,&flg);CHKERRQ(ierr);
789b54502bSHong Zhang   if (flg) {
799b54502bSHong Zhang     ierr = PCCholeskySetMatOrdering(pc,tname);CHKERRQ(ierr);
809b54502bSHong Zhang   }
810a29876aSHong Zhang   ierr = PetscOptionsName("-pc_factor_shiftnonzero","Shift added to diagonal","PCFactorSetShiftNonzero",&flg);CHKERRQ(ierr);
829b54502bSHong Zhang   if (flg) {
830a29876aSHong Zhang     ierr = PCFactorSetShiftNonzero((PetscReal) PETSC_DECIDE,&lu->info);CHKERRQ(ierr);
849b54502bSHong Zhang   }
850a29876aSHong Zhang   ierr = PetscOptionsReal("-pc_factor_shiftnonzero","Shift added to diagonal","PCFactorSetShiftNonzero",lu->info.shiftnz,&lu->info.shiftnz,0);CHKERRQ(ierr);
860a29876aSHong Zhang   ierr = PetscOptionsName("-pc_factor_shiftpd","Manteuffel shift applied to diagonal","PCFactorSetShiftPd",&flg);CHKERRQ(ierr);
879b54502bSHong Zhang   if (flg) {
88*ee45ca4aSHong Zhang     ierr = PCFactorSetShiftPd(PETSC_TRUE,&lu->info);CHKERRQ(ierr);
899b54502bSHong Zhang   }
90*ee45ca4aSHong Zhang   ierr = PetscOptionsReal("-pc_factor_zeropivot","Pivot is considered zero if less than","PCFactorSetZeroPivot",lu->info.zeropivot,&lu->info.zeropivot,0);CHKERRQ(ierr);
919b54502bSHong Zhang 
929b54502bSHong Zhang   ierr = PetscOptionsTail();CHKERRQ(ierr);
939b54502bSHong Zhang   PetscFunctionReturn(0);
949b54502bSHong Zhang }
959b54502bSHong Zhang 
969b54502bSHong Zhang #undef __FUNCT__
979b54502bSHong Zhang #define __FUNCT__ "PCView_Cholesky"
989b54502bSHong Zhang static PetscErrorCode PCView_Cholesky(PC pc,PetscViewer viewer)
999b54502bSHong Zhang {
1009b54502bSHong Zhang   PC_Cholesky    *lu = (PC_Cholesky*)pc->data;
1019b54502bSHong Zhang   PetscErrorCode ierr;
1029b54502bSHong Zhang   PetscTruth     iascii,isstring;
1039b54502bSHong Zhang 
1049b54502bSHong Zhang   PetscFunctionBegin;
1059b54502bSHong Zhang   ierr = PetscTypeCompare((PetscObject)viewer,PETSC_VIEWER_ASCII,&iascii);CHKERRQ(ierr);
1069b54502bSHong Zhang   ierr = PetscTypeCompare((PetscObject)viewer,PETSC_VIEWER_STRING,&isstring);CHKERRQ(ierr);
1079b54502bSHong Zhang   if (iascii) {
1089b54502bSHong Zhang     MatInfo info;
1099b54502bSHong Zhang 
1109b54502bSHong Zhang     if (lu->inplace) {ierr = PetscViewerASCIIPrintf(viewer,"  Cholesky: in-place factorization\n");CHKERRQ(ierr);}
1119b54502bSHong Zhang     else             {ierr = PetscViewerASCIIPrintf(viewer,"  Cholesky: out-of-place factorization\n");CHKERRQ(ierr);}
1129b54502bSHong Zhang     ierr = PetscViewerASCIIPrintf(viewer,"    matrix ordering: %s\n",lu->ordering);CHKERRQ(ierr);
1139b54502bSHong Zhang     if (lu->fact) {
1149b54502bSHong Zhang       ierr = MatGetInfo(lu->fact,MAT_LOCAL,&info);CHKERRQ(ierr);
1159b54502bSHong Zhang       ierr = PetscViewerASCIIPrintf(viewer,"    Cholesky nonzeros %g\n",info.nz_used);CHKERRQ(ierr);
1169b54502bSHong Zhang       ierr = PetscViewerPushFormat(viewer,PETSC_VIEWER_ASCII_FACTOR_INFO);CHKERRQ(ierr);
1179b54502bSHong Zhang       ierr = MatView(lu->fact,viewer);CHKERRQ(ierr);
1189b54502bSHong Zhang       ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr);
1199b54502bSHong Zhang     }
1209b54502bSHong Zhang     if (lu->reusefill)    {ierr = PetscViewerASCIIPrintf(viewer,"       Reusing fill from past factorization\n");CHKERRQ(ierr);}
1219b54502bSHong Zhang     if (lu->reuseordering) {ierr = PetscViewerASCIIPrintf(viewer,"       Reusing reordering from past factorization\n");CHKERRQ(ierr);}
1229b54502bSHong Zhang   } else if (isstring) {
1239b54502bSHong Zhang     ierr = PetscViewerStringSPrintf(viewer," order=%s",lu->ordering);CHKERRQ(ierr);CHKERRQ(ierr);
1249b54502bSHong Zhang   } else {
1259b54502bSHong Zhang     SETERRQ1(PETSC_ERR_SUP,"Viewer type %s not supported for PCCholesky",((PetscObject)viewer)->type_name);
1269b54502bSHong Zhang   }
1279b54502bSHong Zhang   PetscFunctionReturn(0);
1289b54502bSHong Zhang }
1299b54502bSHong Zhang 
1309b54502bSHong Zhang #undef __FUNCT__
1319b54502bSHong Zhang #define __FUNCT__ "PCGetFactoredMatrix_Cholesky"
1329b54502bSHong Zhang static PetscErrorCode PCGetFactoredMatrix_Cholesky(PC pc,Mat *mat)
1339b54502bSHong Zhang {
1349b54502bSHong Zhang   PC_Cholesky *dir = (PC_Cholesky*)pc->data;
1359b54502bSHong Zhang 
1369b54502bSHong Zhang   PetscFunctionBegin;
1379b54502bSHong Zhang   if (!dir->fact) SETERRQ(PETSC_ERR_ORDER,"Matrix not yet factored; call after KSPSetUp() or PCSetUp()");
1389b54502bSHong Zhang   *mat = dir->fact;
1399b54502bSHong Zhang   PetscFunctionReturn(0);
1409b54502bSHong Zhang }
1419b54502bSHong Zhang 
1429b54502bSHong Zhang #undef __FUNCT__
1439b54502bSHong Zhang #define __FUNCT__ "PCSetUp_Cholesky"
1449b54502bSHong Zhang static PetscErrorCode PCSetUp_Cholesky(PC pc)
1459b54502bSHong Zhang {
1469b54502bSHong Zhang   PetscErrorCode ierr;
1479b54502bSHong Zhang   PetscTruth     flg;
1489b54502bSHong Zhang   PC_Cholesky    *dir = (PC_Cholesky*)pc->data;
1499b54502bSHong Zhang 
1509b54502bSHong Zhang   PetscFunctionBegin;
1519b54502bSHong Zhang   if (dir->reusefill && pc->setupcalled) dir->info.fill = dir->actualfill;
1529b54502bSHong Zhang 
1539b54502bSHong Zhang   if (dir->inplace) {
1549b54502bSHong Zhang     if (dir->row && dir->col && (dir->row != dir->col)) {
1559b54502bSHong Zhang       ierr = ISDestroy(dir->row);CHKERRQ(ierr);
1569b54502bSHong Zhang       dir->row = 0;
1579b54502bSHong Zhang     }
1589b54502bSHong Zhang     if (dir->col) {
1599b54502bSHong Zhang       ierr = ISDestroy(dir->col);CHKERRQ(ierr);
1609b54502bSHong Zhang       dir->col = 0;
1619b54502bSHong Zhang     }
1629b54502bSHong Zhang     ierr = MatGetOrdering(pc->pmat,dir->ordering,&dir->row,&dir->col);CHKERRQ(ierr);
1639b54502bSHong Zhang     if (dir->col && (dir->row != dir->col)) {  /* only use row ordering for SBAIJ */
1649b54502bSHong Zhang       ierr = ISDestroy(dir->col);CHKERRQ(ierr);
1659b54502bSHong Zhang       dir->col=0;
1669b54502bSHong Zhang     }
1679b54502bSHong Zhang     if (dir->row) {PetscLogObjectParent(pc,dir->row);}
1689b54502bSHong Zhang     ierr = MatCholeskyFactor(pc->pmat,dir->row,&dir->info);CHKERRQ(ierr);
1699b54502bSHong Zhang     dir->fact = pc->pmat;
1709b54502bSHong Zhang   } else {
1719b54502bSHong Zhang     MatInfo info;
1729b54502bSHong Zhang     if (!pc->setupcalled) {
1739b54502bSHong Zhang       ierr = MatGetOrdering(pc->pmat,dir->ordering,&dir->row,&dir->col);CHKERRQ(ierr);
1749b54502bSHong Zhang       if (dir->col && (dir->row != dir->col)) {  /* only use row ordering for SBAIJ */
1759b54502bSHong Zhang         ierr = ISDestroy(dir->col);CHKERRQ(ierr);
1769b54502bSHong Zhang         dir->col=0;
1779b54502bSHong Zhang       }
1789b54502bSHong Zhang       ierr = PetscOptionsHasName(pc->prefix,"-pc_cholesky_nonzeros_along_diagonal",&flg);CHKERRQ(ierr);
1799b54502bSHong Zhang       if (flg) {
1809b54502bSHong Zhang         PetscReal tol = 1.e-10;
1819b54502bSHong Zhang         ierr = PetscOptionsGetReal(pc->prefix,"-pc_cholesky_nonzeros_along_diagonal",&tol,PETSC_NULL);CHKERRQ(ierr);
1829b54502bSHong Zhang         ierr = MatReorderForNonzeroDiagonal(pc->pmat,tol,dir->row,dir->row);CHKERRQ(ierr);
1839b54502bSHong Zhang       }
1849b54502bSHong Zhang       if (dir->row) {PetscLogObjectParent(pc,dir->row);}
1859b54502bSHong Zhang       ierr = MatCholeskyFactorSymbolic(pc->pmat,dir->row,&dir->info,&dir->fact);CHKERRQ(ierr);
1869b54502bSHong Zhang       ierr = MatGetInfo(dir->fact,MAT_LOCAL,&info);CHKERRQ(ierr);
1879b54502bSHong Zhang       dir->actualfill = info.fill_ratio_needed;
1889b54502bSHong Zhang       PetscLogObjectParent(pc,dir->fact);
1899b54502bSHong Zhang     } else if (pc->flag != SAME_NONZERO_PATTERN) {
1909b54502bSHong Zhang       if (!dir->reuseordering) {
1919b54502bSHong Zhang         if (dir->row && dir->col && (dir->row != dir->col)) {
1929b54502bSHong Zhang           ierr = ISDestroy(dir->row);CHKERRQ(ierr);
1939b54502bSHong Zhang           dir->row = 0;
1949b54502bSHong Zhang         }
1959b54502bSHong Zhang         if (dir->col) {
1969b54502bSHong Zhang           ierr = ISDestroy(dir->col);CHKERRQ(ierr);
1979b54502bSHong Zhang           dir->col =0;
1989b54502bSHong Zhang         }
1999b54502bSHong Zhang         ierr = MatGetOrdering(pc->pmat,dir->ordering,&dir->row,&dir->col);CHKERRQ(ierr);
2009b54502bSHong Zhang         if (dir->col && (dir->row != dir->col)) {  /* only use row ordering for SBAIJ */
2019b54502bSHong Zhang           ierr = ISDestroy(dir->col);CHKERRQ(ierr);
2029b54502bSHong Zhang           dir->col=0;
2039b54502bSHong Zhang         }
2049b54502bSHong Zhang         ierr = PetscOptionsHasName(pc->prefix,"-pc_cholesky_nonzeros_along_diagonal",&flg);CHKERRQ(ierr);
2059b54502bSHong Zhang         if (flg) {
2069b54502bSHong Zhang           PetscReal tol = 1.e-10;
2079b54502bSHong Zhang           ierr = PetscOptionsGetReal(pc->prefix,"-pc_cholesky_nonzeros_along_diagonal",&tol,PETSC_NULL);CHKERRQ(ierr);
2089b54502bSHong Zhang           ierr = MatReorderForNonzeroDiagonal(pc->pmat,tol,dir->row,dir->row);CHKERRQ(ierr);
2099b54502bSHong Zhang         }
2109b54502bSHong Zhang         if (dir->row) {PetscLogObjectParent(pc,dir->row);}
2119b54502bSHong Zhang       }
2129b54502bSHong Zhang       ierr = MatDestroy(dir->fact);CHKERRQ(ierr);
2139b54502bSHong Zhang       ierr = MatCholeskyFactorSymbolic(pc->pmat,dir->row,&dir->info,&dir->fact);CHKERRQ(ierr);
2149b54502bSHong Zhang       ierr = MatGetInfo(dir->fact,MAT_LOCAL,&info);CHKERRQ(ierr);
2159b54502bSHong Zhang       dir->actualfill = info.fill_ratio_needed;
2169b54502bSHong Zhang       PetscLogObjectParent(pc,dir->fact);
2179b54502bSHong Zhang     }
2189b54502bSHong Zhang     ierr = MatCholeskyFactorNumeric(pc->pmat,&dir->info,&dir->fact);CHKERRQ(ierr);
2199b54502bSHong Zhang   }
2209b54502bSHong Zhang   PetscFunctionReturn(0);
2219b54502bSHong Zhang }
2229b54502bSHong Zhang 
2239b54502bSHong Zhang #undef __FUNCT__
2249b54502bSHong Zhang #define __FUNCT__ "PCDestroy_Cholesky"
2259b54502bSHong Zhang static PetscErrorCode PCDestroy_Cholesky(PC pc)
2269b54502bSHong Zhang {
2279b54502bSHong Zhang   PC_Cholesky    *dir = (PC_Cholesky*)pc->data;
2289b54502bSHong Zhang   PetscErrorCode ierr;
2299b54502bSHong Zhang 
2309b54502bSHong Zhang   PetscFunctionBegin;
2319b54502bSHong Zhang   if (!dir->inplace && dir->fact) {ierr = MatDestroy(dir->fact);CHKERRQ(ierr);}
2329b54502bSHong Zhang   if (dir->row) {ierr = ISDestroy(dir->row);CHKERRQ(ierr);}
2339b54502bSHong Zhang   if (dir->col) {ierr = ISDestroy(dir->col);CHKERRQ(ierr);}
2349b54502bSHong Zhang   ierr = PetscStrfree(dir->ordering);CHKERRQ(ierr);
2359b54502bSHong Zhang   ierr = PetscFree(dir);CHKERRQ(ierr);
2369b54502bSHong Zhang   PetscFunctionReturn(0);
2379b54502bSHong Zhang }
2389b54502bSHong Zhang 
2399b54502bSHong Zhang #undef __FUNCT__
2409b54502bSHong Zhang #define __FUNCT__ "PCApply_Cholesky"
2419b54502bSHong Zhang static PetscErrorCode PCApply_Cholesky(PC pc,Vec x,Vec y)
2429b54502bSHong Zhang {
2439b54502bSHong Zhang   PC_Cholesky    *dir = (PC_Cholesky*)pc->data;
2449b54502bSHong Zhang   PetscErrorCode ierr;
2459b54502bSHong Zhang 
2469b54502bSHong Zhang   PetscFunctionBegin;
2479b54502bSHong Zhang   if (dir->inplace) {ierr = MatSolve(pc->pmat,x,y);CHKERRQ(ierr);}
2489b54502bSHong Zhang   else              {ierr = MatSolve(dir->fact,x,y);CHKERRQ(ierr);}
2499b54502bSHong Zhang   PetscFunctionReturn(0);
2509b54502bSHong Zhang }
2519b54502bSHong Zhang 
2529b54502bSHong Zhang #undef __FUNCT__
2539b54502bSHong Zhang #define __FUNCT__ "PCApplyTranspose_Cholesky"
2549b54502bSHong Zhang static PetscErrorCode PCApplyTranspose_Cholesky(PC pc,Vec x,Vec y)
2559b54502bSHong Zhang {
2569b54502bSHong Zhang   PC_Cholesky    *dir = (PC_Cholesky*)pc->data;
2579b54502bSHong Zhang   PetscErrorCode ierr;
2589b54502bSHong Zhang 
2599b54502bSHong Zhang   PetscFunctionBegin;
2609b54502bSHong Zhang   if (dir->inplace) {ierr = MatSolveTranspose(pc->pmat,x,y);CHKERRQ(ierr);}
2619b54502bSHong Zhang   else              {ierr = MatSolveTranspose(dir->fact,x,y);CHKERRQ(ierr);}
2629b54502bSHong Zhang   PetscFunctionReturn(0);
2639b54502bSHong Zhang }
2649b54502bSHong Zhang 
2659b54502bSHong Zhang /* -----------------------------------------------------------------------------------*/
2669b54502bSHong Zhang 
2679b54502bSHong Zhang EXTERN_C_BEGIN
2689b54502bSHong Zhang #undef __FUNCT__
2699b54502bSHong Zhang #define __FUNCT__ "PCCholeskySetFill_Cholesky"
2709b54502bSHong Zhang PetscErrorCode PCCholeskySetFill_Cholesky(PC pc,PetscReal fill)
2719b54502bSHong Zhang {
2729b54502bSHong Zhang   PC_Cholesky *dir;
2739b54502bSHong Zhang 
2749b54502bSHong Zhang   PetscFunctionBegin;
2759b54502bSHong Zhang   dir = (PC_Cholesky*)pc->data;
2769b54502bSHong Zhang   dir->info.fill = fill;
2779b54502bSHong Zhang   PetscFunctionReturn(0);
2789b54502bSHong Zhang }
2799b54502bSHong Zhang EXTERN_C_END
2809b54502bSHong Zhang 
2819b54502bSHong Zhang EXTERN_C_BEGIN
2829b54502bSHong Zhang #undef __FUNCT__
2839b54502bSHong Zhang #define __FUNCT__ "PCCholeskySetUseInPlace_Cholesky"
2849b54502bSHong Zhang PetscErrorCode PCCholeskySetUseInPlace_Cholesky(PC pc)
2859b54502bSHong Zhang {
2869b54502bSHong Zhang   PC_Cholesky *dir;
2879b54502bSHong Zhang 
2889b54502bSHong Zhang   PetscFunctionBegin;
2899b54502bSHong Zhang   dir = (PC_Cholesky*)pc->data;
2909b54502bSHong Zhang   dir->inplace = PETSC_TRUE;
2919b54502bSHong Zhang   PetscFunctionReturn(0);
2929b54502bSHong Zhang }
2939b54502bSHong Zhang EXTERN_C_END
2949b54502bSHong Zhang 
2959b54502bSHong Zhang EXTERN_C_BEGIN
2969b54502bSHong Zhang #undef __FUNCT__
2979b54502bSHong Zhang #define __FUNCT__ "PCCholeskySetMatOrdering_Cholesky"
2989b54502bSHong Zhang PetscErrorCode PCCholeskySetMatOrdering_Cholesky(PC pc,MatOrderingType ordering)
2999b54502bSHong Zhang {
3009b54502bSHong Zhang   PC_Cholesky    *dir = (PC_Cholesky*)pc->data;
3019b54502bSHong Zhang   PetscErrorCode ierr;
3029b54502bSHong Zhang 
3039b54502bSHong Zhang   PetscFunctionBegin;
3049b54502bSHong Zhang   ierr = PetscStrfree(dir->ordering);CHKERRQ(ierr);
3059b54502bSHong Zhang   ierr = PetscStrallocpy(ordering,&dir->ordering);CHKERRQ(ierr);
3069b54502bSHong Zhang   PetscFunctionReturn(0);
3079b54502bSHong Zhang }
3089b54502bSHong Zhang EXTERN_C_END
3099b54502bSHong Zhang 
3109b54502bSHong Zhang /* -----------------------------------------------------------------------------------*/
3119b54502bSHong Zhang 
3129b54502bSHong Zhang #undef __FUNCT__
3139b54502bSHong Zhang #define __FUNCT__ "PCCholeskySetReuseOrdering"
3149b54502bSHong Zhang /*@
3159b54502bSHong Zhang    PCCholeskySetReuseOrdering - When similar matrices are factored, this
3169b54502bSHong Zhang    causes the ordering computed in the first factor to be used for all
3179b54502bSHong Zhang    following factors.
3189b54502bSHong Zhang 
3199b54502bSHong Zhang    Collective on PC
3209b54502bSHong Zhang 
3219b54502bSHong Zhang    Input Parameters:
3229b54502bSHong Zhang +  pc - the preconditioner context
3239b54502bSHong Zhang -  flag - PETSC_TRUE to reuse else PETSC_FALSE
3249b54502bSHong Zhang 
3259b54502bSHong Zhang    Options Database Key:
3269b54502bSHong Zhang .  -pc_cholesky_reuse_ordering - Activate PCCholeskySetReuseOrdering()
3279b54502bSHong Zhang 
3289b54502bSHong Zhang    Level: intermediate
3299b54502bSHong Zhang 
3309b54502bSHong Zhang .keywords: PC, levels, reordering, factorization, incomplete, LU
3319b54502bSHong Zhang 
3329b54502bSHong Zhang .seealso: PCCholeskySetReuseFill(), PCICholeskySetReuseOrdering(), PCICholeskyDTSetReuseFill()
3339b54502bSHong Zhang @*/
3349b54502bSHong Zhang PetscErrorCode PCCholeskySetReuseOrdering(PC pc,PetscTruth flag)
3359b54502bSHong Zhang {
3369b54502bSHong Zhang   PetscErrorCode ierr,(*f)(PC,PetscTruth);
3379b54502bSHong Zhang 
3389b54502bSHong Zhang   PetscFunctionBegin;
3399b54502bSHong Zhang   PetscValidHeaderSpecific(pc,PC_COOKIE,1);
3409b54502bSHong Zhang   ierr = PetscObjectQueryFunction((PetscObject)pc,"PCCholeskySetReuseOrdering_C",(void (**)(void))&f);CHKERRQ(ierr);
3419b54502bSHong Zhang   if (f) {
3429b54502bSHong Zhang     ierr = (*f)(pc,flag);CHKERRQ(ierr);
3439b54502bSHong Zhang   }
3449b54502bSHong Zhang   PetscFunctionReturn(0);
3459b54502bSHong Zhang }
3469b54502bSHong Zhang 
3479b54502bSHong Zhang #undef __FUNCT__
3489b54502bSHong Zhang #define __FUNCT__ "PCCholeskySetReuseFill"
3499b54502bSHong Zhang /*@
3509b54502bSHong Zhang    PCCholeskySetReuseFill - When matrices with same nonzero structure are Cholesky factored,
3519b54502bSHong Zhang    this causes later ones to use the fill computed in the initial factorization.
3529b54502bSHong Zhang 
3539b54502bSHong Zhang    Collective on PC
3549b54502bSHong Zhang 
3559b54502bSHong Zhang    Input Parameters:
3569b54502bSHong Zhang +  pc - the preconditioner context
3579b54502bSHong Zhang -  flag - PETSC_TRUE to reuse else PETSC_FALSE
3589b54502bSHong Zhang 
3599b54502bSHong Zhang    Options Database Key:
3609b54502bSHong Zhang .  -pc_cholesky_reuse_fill - Activates PCCholeskySetReuseFill()
3619b54502bSHong Zhang 
3629b54502bSHong Zhang    Level: intermediate
3639b54502bSHong Zhang 
3649b54502bSHong Zhang .keywords: PC, levels, reordering, factorization, incomplete, Cholesky
3659b54502bSHong Zhang 
3669b54502bSHong Zhang .seealso: PCICholeskySetReuseOrdering(), PCCholeskySetReuseOrdering(), PCICholeskyDTSetReuseFill()
3679b54502bSHong Zhang @*/
3689b54502bSHong Zhang PetscErrorCode PCCholeskySetReuseFill(PC pc,PetscTruth flag)
3699b54502bSHong Zhang {
3709b54502bSHong Zhang   PetscErrorCode ierr,(*f)(PC,PetscTruth);
3719b54502bSHong Zhang 
3729b54502bSHong Zhang   PetscFunctionBegin;
3739b54502bSHong Zhang   PetscValidHeaderSpecific(pc,PC_COOKIE,2);
3749b54502bSHong Zhang   ierr = PetscObjectQueryFunction((PetscObject)pc,"PCCholeskySetReuseFill_C",(void (**)(void))&f);CHKERRQ(ierr);
3759b54502bSHong Zhang   if (f) {
3769b54502bSHong Zhang     ierr = (*f)(pc,flag);CHKERRQ(ierr);
3779b54502bSHong Zhang   }
3789b54502bSHong Zhang   PetscFunctionReturn(0);
3799b54502bSHong Zhang }
3809b54502bSHong Zhang 
3819b54502bSHong Zhang #undef __FUNCT__
3829b54502bSHong Zhang #define __FUNCT__ "PCCholeskySetFill"
3839b54502bSHong Zhang /*@
3849b54502bSHong Zhang    PCCholeskySetFill - Indicates the amount of fill you expect in the factored matrix,
3859b54502bSHong Zhang    fill = number nonzeros in factor/number nonzeros in original matrix.
3869b54502bSHong Zhang 
3879b54502bSHong Zhang    Collective on PC
3889b54502bSHong Zhang 
3899b54502bSHong Zhang    Input Parameters:
3909b54502bSHong Zhang +  pc - the preconditioner context
3919b54502bSHong Zhang -  fill - amount of expected fill
3929b54502bSHong Zhang 
3939b54502bSHong Zhang    Options Database Key:
3949b54502bSHong Zhang .  -pc_cholesky_fill <fill> - Sets fill amount
3959b54502bSHong Zhang 
3969b54502bSHong Zhang    Level: intermediate
3979b54502bSHong Zhang 
3989b54502bSHong Zhang    Note:
3999b54502bSHong Zhang    For sparse matrix factorizations it is difficult to predict how much
4009b54502bSHong Zhang    fill to expect. By running with the option -log_info PETSc will print the
4019b54502bSHong Zhang    actual amount of fill used; allowing you to set the value accurately for
4029b54502bSHong Zhang    future runs. Default PETSc uses a value of 5.0
4039b54502bSHong Zhang 
4049b54502bSHong Zhang .keywords: PC, set, factorization, direct, fill
4059b54502bSHong Zhang 
4069b54502bSHong Zhang .seealso: PCILUSetFill()
4079b54502bSHong Zhang @*/
4089b54502bSHong Zhang PetscErrorCode PCCholeskySetFill(PC pc,PetscReal fill)
4099b54502bSHong Zhang {
4109b54502bSHong Zhang   PetscErrorCode ierr,(*f)(PC,PetscReal);
4119b54502bSHong Zhang 
4129b54502bSHong Zhang   PetscFunctionBegin;
4139b54502bSHong Zhang   PetscValidHeaderSpecific(pc,PC_COOKIE,1);
4149b54502bSHong Zhang   if (fill < 1.0) SETERRQ(PETSC_ERR_ARG_OUTOFRANGE,"Fill factor cannot be less then 1.0");
4159b54502bSHong Zhang   ierr = PetscObjectQueryFunction((PetscObject)pc,"PCCholeskySetFill_C",(void (**)(void))&f);CHKERRQ(ierr);
4169b54502bSHong Zhang   if (f) {
4179b54502bSHong Zhang     ierr = (*f)(pc,fill);CHKERRQ(ierr);
4189b54502bSHong Zhang   }
4199b54502bSHong Zhang   PetscFunctionReturn(0);
4209b54502bSHong Zhang }
4219b54502bSHong Zhang 
4229b54502bSHong Zhang #undef __FUNCT__
4239b54502bSHong Zhang #define __FUNCT__ "PCCholeskySetUseInPlace"
4249b54502bSHong Zhang /*@
4259b54502bSHong Zhang    PCCholeskySetUseInPlace - Tells the system to do an in-place factorization.
4269b54502bSHong Zhang    For dense matrices, this enables the solution of much larger problems.
4279b54502bSHong Zhang    For sparse matrices the factorization cannot be done truly in-place
4289b54502bSHong Zhang    so this does not save memory during the factorization, but after the matrix
4299b54502bSHong Zhang    is factored, the original unfactored matrix is freed, thus recovering that
4309b54502bSHong Zhang    space.
4319b54502bSHong Zhang 
4329b54502bSHong Zhang    Collective on PC
4339b54502bSHong Zhang 
4349b54502bSHong Zhang    Input Parameters:
4359b54502bSHong Zhang .  pc - the preconditioner context
4369b54502bSHong Zhang 
4379b54502bSHong Zhang    Options Database Key:
4389b54502bSHong Zhang .  -pc_cholesky_in_place - Activates in-place factorization
4399b54502bSHong Zhang 
4409b54502bSHong Zhang    Notes:
4419b54502bSHong Zhang    PCCholeskySetUseInplace() can only be used with the KSP method KSPPREONLY or when
4429b54502bSHong Zhang    a different matrix is provided for the multiply and the preconditioner in
4439b54502bSHong Zhang    a call to KSPSetOperators().
4449b54502bSHong Zhang    This is because the Krylov space methods require an application of the
4459b54502bSHong Zhang    matrix multiplication, which is not possible here because the matrix has
4469b54502bSHong Zhang    been factored in-place, replacing the original matrix.
4479b54502bSHong Zhang 
4489b54502bSHong Zhang    Level: intermediate
4499b54502bSHong Zhang 
4509b54502bSHong Zhang .keywords: PC, set, factorization, direct, inplace, in-place, Cholesky
4519b54502bSHong Zhang 
4529b54502bSHong Zhang .seealso: PCICholeskySetUseInPlace()
4539b54502bSHong Zhang @*/
4549b54502bSHong Zhang PetscErrorCode PCCholeskySetUseInPlace(PC pc)
4559b54502bSHong Zhang {
4569b54502bSHong Zhang   PetscErrorCode ierr,(*f)(PC);
4579b54502bSHong Zhang 
4589b54502bSHong Zhang   PetscFunctionBegin;
4599b54502bSHong Zhang   PetscValidHeaderSpecific(pc,PC_COOKIE,1);
4609b54502bSHong Zhang   ierr = PetscObjectQueryFunction((PetscObject)pc,"PCCholeskySetUseInPlace_C",(void (**)(void))&f);CHKERRQ(ierr);
4619b54502bSHong Zhang   if (f) {
4629b54502bSHong Zhang     ierr = (*f)(pc);CHKERRQ(ierr);
4639b54502bSHong Zhang   }
4649b54502bSHong Zhang   PetscFunctionReturn(0);
4659b54502bSHong Zhang }
4669b54502bSHong Zhang 
4679b54502bSHong Zhang #undef __FUNCT__
4689b54502bSHong Zhang #define __FUNCT__ "PCCholeskySetMatOrdering"
4699b54502bSHong Zhang /*@
4709b54502bSHong Zhang     PCCholeskySetMatOrdering - Sets the ordering routine (to reduce fill) to
4719b54502bSHong Zhang     be used it the Cholesky factorization.
4729b54502bSHong Zhang 
4739b54502bSHong Zhang     Collective on PC
4749b54502bSHong Zhang 
4759b54502bSHong Zhang     Input Parameters:
4769b54502bSHong Zhang +   pc - the preconditioner context
4779b54502bSHong Zhang -   ordering - the matrix ordering name, for example, MATORDERING_ND or MATORDERING_RCM
4789b54502bSHong Zhang 
4799b54502bSHong Zhang     Options Database Key:
4809b54502bSHong Zhang .   -pc_cholesky_mat_ordering_type <nd,rcm,...> - Sets ordering routine
4819b54502bSHong Zhang 
4829b54502bSHong Zhang     Level: intermediate
4839b54502bSHong Zhang 
4849b54502bSHong Zhang .seealso: PCICholeskySetMatOrdering()
4859b54502bSHong Zhang @*/
4869b54502bSHong Zhang PetscErrorCode PCCholeskySetMatOrdering(PC pc,MatOrderingType ordering)
4879b54502bSHong Zhang {
4889b54502bSHong Zhang   PetscErrorCode ierr,(*f)(PC,MatOrderingType);
4899b54502bSHong Zhang 
4909b54502bSHong Zhang   PetscFunctionBegin;
4919b54502bSHong Zhang   ierr = PetscObjectQueryFunction((PetscObject)pc,"PCCholeskySetMatOrdering_C",(void (**)(void))&f);CHKERRQ(ierr);
4929b54502bSHong Zhang   if (f) {
4939b54502bSHong Zhang     ierr = (*f)(pc,ordering);CHKERRQ(ierr);
4949b54502bSHong Zhang   }
4959b54502bSHong Zhang   PetscFunctionReturn(0);
4969b54502bSHong Zhang }
4979b54502bSHong Zhang 
4989b54502bSHong Zhang /*MC
4999b54502bSHong Zhang    PCCholesky - Uses a direct solver, based on Cholesky factorization, as a preconditioner
5009b54502bSHong Zhang 
5019b54502bSHong Zhang    Options Database Keys:
5029b54502bSHong Zhang +  -pc_cholesky_reuse_ordering - Activate PCLUSetReuseOrdering()
5039b54502bSHong Zhang .  -pc_cholesky_reuse_fill - Activates PCLUSetReuseFill()
5049b54502bSHong Zhang .  -pc_cholesky_fill <fill> - Sets fill amount
5059b54502bSHong Zhang .  -pc_cholesky_in_place - Activates in-place factorization
5069b54502bSHong Zhang -  -pc_cholesky_mat_ordering_type <nd,rcm,...> - Sets ordering routine
5079b54502bSHong Zhang 
5089b54502bSHong Zhang    Notes: Not all options work for all matrix formats
5099b54502bSHong Zhang 
5109b54502bSHong Zhang    Level: beginner
5119b54502bSHong Zhang 
5129b54502bSHong Zhang    Concepts: Cholesky factorization, direct solver
5139b54502bSHong Zhang 
5149b54502bSHong Zhang    Notes: Usually this will compute an "exact" solution in one iteration and does
5159b54502bSHong Zhang           not need a Krylov method (i.e. you can use -ksp_type preonly, or
5169b54502bSHong Zhang           KSPSetType(ksp,KSPPREONLY) for the Krylov method
5179b54502bSHong Zhang 
5189b54502bSHong Zhang .seealso:  PCCreate(), PCSetType(), PCType (for list of available types), PC,
5199b54502bSHong Zhang            PCILU, PCLU, PCICC, PCCholeskySetReuseOrdering(), PCCholeskySetReuseFill(), PCGetFactoredMatrix(),
520*ee45ca4aSHong Zhang            PCCholeskySetFill(), PCFactorSetShiftNonzero(), PCFactorSetShiftPd(),
5219b54502bSHong Zhang 	   PCCholeskySetUseInPlace(), PCCholeskySetMatOrdering()
5229b54502bSHong Zhang 
5239b54502bSHong Zhang M*/
5249b54502bSHong Zhang 
5259b54502bSHong Zhang EXTERN_C_BEGIN
5269b54502bSHong Zhang #undef __FUNCT__
5279b54502bSHong Zhang #define __FUNCT__ "PCCreate_Cholesky"
5289b54502bSHong Zhang PetscErrorCode PCCreate_Cholesky(PC pc)
5299b54502bSHong Zhang {
5309b54502bSHong Zhang   PetscErrorCode ierr;
5319b54502bSHong Zhang   PC_Cholesky    *dir;
5329b54502bSHong Zhang 
5339b54502bSHong Zhang   PetscFunctionBegin;
5349b54502bSHong Zhang   ierr = PetscNew(PC_Cholesky,&dir);CHKERRQ(ierr);
5359b54502bSHong Zhang   PetscLogObjectMemory(pc,sizeof(PC_Cholesky));
5369b54502bSHong Zhang 
5379b54502bSHong Zhang   dir->fact                   = 0;
5389b54502bSHong Zhang   dir->inplace                = PETSC_FALSE;
5399b54502bSHong Zhang   ierr = MatFactorInfoInitialize(&dir->info);CHKERRQ(ierr);
5409b54502bSHong Zhang   dir->info.fill              = 5.0;
5410a29876aSHong Zhang   dir->info.shiftnz           = 0.0;
5420a29876aSHong Zhang   dir->info.shiftpd           = PETSC_FALSE;
5439b54502bSHong Zhang   dir->info.shift_fraction    = 0.0;
5449b54502bSHong Zhang   dir->info.pivotinblocks     = 1.0;
5459b54502bSHong Zhang   dir->col                    = 0;
5469b54502bSHong Zhang   dir->row                    = 0;
5479b54502bSHong Zhang   ierr = PetscStrallocpy(MATORDERING_NATURAL,&dir->ordering);CHKERRQ(ierr);
5489b54502bSHong Zhang   dir->reusefill        = PETSC_FALSE;
5499b54502bSHong Zhang   dir->reuseordering    = PETSC_FALSE;
5509b54502bSHong Zhang   pc->data              = (void*)dir;
5519b54502bSHong Zhang 
5529b54502bSHong Zhang   pc->ops->destroy           = PCDestroy_Cholesky;
5539b54502bSHong Zhang   pc->ops->apply             = PCApply_Cholesky;
5549b54502bSHong Zhang   pc->ops->applytranspose    = PCApplyTranspose_Cholesky;
5559b54502bSHong Zhang   pc->ops->setup             = PCSetUp_Cholesky;
5569b54502bSHong Zhang   pc->ops->setfromoptions    = PCSetFromOptions_Cholesky;
5579b54502bSHong Zhang   pc->ops->view              = PCView_Cholesky;
5589b54502bSHong Zhang   pc->ops->applyrichardson   = 0;
5599b54502bSHong Zhang   pc->ops->getfactoredmatrix = PCGetFactoredMatrix_Cholesky;
5609b54502bSHong Zhang 
5619b54502bSHong Zhang   ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCCholeskySetFill_C","PCCholeskySetFill_Cholesky",
5629b54502bSHong Zhang                     PCCholeskySetFill_Cholesky);CHKERRQ(ierr);
5639b54502bSHong Zhang   ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCCholeskySetUseInPlace_C","PCCholeskySetUseInPlace_Cholesky",
5649b54502bSHong Zhang                     PCCholeskySetUseInPlace_Cholesky);CHKERRQ(ierr);
5659b54502bSHong Zhang   ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCCholeskySetMatOrdering_C","PCCholeskySetMatOrdering_Cholesky",
5669b54502bSHong Zhang                     PCCholeskySetMatOrdering_Cholesky);CHKERRQ(ierr);
5679b54502bSHong Zhang   ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCCholeskySetReuseOrdering_C","PCCholeskySetReuseOrdering_Cholesky",
5689b54502bSHong Zhang                     PCCholeskySetReuseOrdering_Cholesky);CHKERRQ(ierr);
5699b54502bSHong Zhang   ierr = PetscObjectComposeFunctionDynamic((PetscObject)pc,"PCCholeskySetReuseFill_C","PCCholeskySetReuseFill_Cholesky",
5709b54502bSHong Zhang                     PCCholeskySetReuseFill_Cholesky);CHKERRQ(ierr);
5719b54502bSHong Zhang   PetscFunctionReturn(0);
5729b54502bSHong Zhang }
5739b54502bSHong Zhang EXTERN_C_END
574