11677d0b8SKris Buschelman 21677d0b8SKris Buschelman /* 32d4e2982SHong Zhang Provides an interface to the UMFPACKv5.1 sparse solver 42d4e2982SHong Zhang 58592901bSBarry Smith When build with PETSC_USE_64BIT_INDICES this will use UF_Long as the 68592901bSBarry Smith integer type in UMFPACK, otherwise it will use int. This means 78592901bSBarry Smith all integers in this file as simply declared as PetscInt. Also it means 88592901bSBarry Smith that UMFPACK UL_Long version MUST be built with 64 bit integers when used. 92d4e2982SHong Zhang 101677d0b8SKris Buschelman */ 11c6db04a5SJed Brown #include <../src/mat/impls/aij/seq/aij.h> 121677d0b8SKris Buschelman 138592901bSBarry Smith #if defined(PETSC_USE_64BIT_INDICES) 148592901bSBarry Smith #if defined(PETSC_USE_COMPLEX) 158592901bSBarry Smith #define umfpack_UMF_free_symbolic umfpack_zl_free_symbolic 168592901bSBarry Smith #define umfpack_UMF_free_numeric umfpack_zl_free_numeric 178592901bSBarry Smith #define umfpack_UMF_wsolve umfpack_zl_wsolve 188592901bSBarry Smith #define umfpack_UMF_numeric umfpack_zl_numeric 198592901bSBarry Smith #define umfpack_UMF_report_numeric umfpack_zl_report_numeric 208592901bSBarry Smith #define umfpack_UMF_report_control umfpack_zl_report_control 218592901bSBarry Smith #define umfpack_UMF_report_status umfpack_zl_report_status 228592901bSBarry Smith #define umfpack_UMF_report_info umfpack_zl_report_info 238592901bSBarry Smith #define umfpack_UMF_report_symbolic umfpack_zl_report_symbolic 248592901bSBarry Smith #define umfpack_UMF_qsymbolic umfpack_zl_qsymbolic 258592901bSBarry Smith #define umfpack_UMF_symbolic umfpack_zl_symbolic 268592901bSBarry Smith #define umfpack_UMF_defaults umfpack_zl_defaults 278592901bSBarry Smith 288592901bSBarry Smith #else 298592901bSBarry Smith #define umfpack_UMF_free_symbolic umfpack_dl_free_symbolic 308592901bSBarry Smith #define umfpack_UMF_free_numeric umfpack_dl_free_numeric 318592901bSBarry Smith #define umfpack_UMF_wsolve umfpack_dl_wsolve 328592901bSBarry Smith #define umfpack_UMF_numeric umfpack_dl_numeric 338592901bSBarry Smith #define umfpack_UMF_report_numeric umfpack_dl_report_numeric 348592901bSBarry Smith #define umfpack_UMF_report_control umfpack_dl_report_control 358592901bSBarry Smith #define umfpack_UMF_report_status umfpack_dl_report_status 368592901bSBarry Smith #define umfpack_UMF_report_info umfpack_dl_report_info 378592901bSBarry Smith #define umfpack_UMF_report_symbolic umfpack_dl_report_symbolic 388592901bSBarry Smith #define umfpack_UMF_qsymbolic umfpack_dl_qsymbolic 398592901bSBarry Smith #define umfpack_UMF_symbolic umfpack_dl_symbolic 408592901bSBarry Smith #define umfpack_UMF_defaults umfpack_dl_defaults 418592901bSBarry Smith #endif 428592901bSBarry Smith 438592901bSBarry Smith #else 448592901bSBarry Smith #if defined(PETSC_USE_COMPLEX) 458592901bSBarry Smith #define umfpack_UMF_free_symbolic umfpack_zi_free_symbolic 468592901bSBarry Smith #define umfpack_UMF_free_numeric umfpack_zi_free_numeric 478592901bSBarry Smith #define umfpack_UMF_wsolve umfpack_zi_wsolve 488592901bSBarry Smith #define umfpack_UMF_numeric umfpack_zi_numeric 498592901bSBarry Smith #define umfpack_UMF_report_numeric umfpack_zi_report_numeric 508592901bSBarry Smith #define umfpack_UMF_report_control umfpack_zi_report_control 518592901bSBarry Smith #define umfpack_UMF_report_status umfpack_zi_report_status 528592901bSBarry Smith #define umfpack_UMF_report_info umfpack_zi_report_info 538592901bSBarry Smith #define umfpack_UMF_report_symbolic umfpack_zi_report_symbolic 548592901bSBarry Smith #define umfpack_UMF_qsymbolic umfpack_zi_qsymbolic 558592901bSBarry Smith #define umfpack_UMF_symbolic umfpack_zi_symbolic 568592901bSBarry Smith #define umfpack_UMF_defaults umfpack_zi_defaults 578592901bSBarry Smith 588592901bSBarry Smith #else 598592901bSBarry Smith #define umfpack_UMF_free_symbolic umfpack_di_free_symbolic 608592901bSBarry Smith #define umfpack_UMF_free_numeric umfpack_di_free_numeric 618592901bSBarry Smith #define umfpack_UMF_wsolve umfpack_di_wsolve 628592901bSBarry Smith #define umfpack_UMF_numeric umfpack_di_numeric 638592901bSBarry Smith #define umfpack_UMF_report_numeric umfpack_di_report_numeric 648592901bSBarry Smith #define umfpack_UMF_report_control umfpack_di_report_control 658592901bSBarry Smith #define umfpack_UMF_report_status umfpack_di_report_status 668592901bSBarry Smith #define umfpack_UMF_report_info umfpack_di_report_info 678592901bSBarry Smith #define umfpack_UMF_report_symbolic umfpack_di_report_symbolic 688592901bSBarry Smith #define umfpack_UMF_qsymbolic umfpack_di_qsymbolic 698592901bSBarry Smith #define umfpack_UMF_symbolic umfpack_di_symbolic 708592901bSBarry Smith #define umfpack_UMF_defaults umfpack_di_defaults 718592901bSBarry Smith #endif 728592901bSBarry Smith #endif 738592901bSBarry Smith 748592901bSBarry Smith 758592901bSBarry Smith #define UF_long long long 768592901bSBarry Smith #define UF_long_max LONG_LONG_MAX 778592901bSBarry Smith #define UF_long_id "%lld" 788592901bSBarry Smith 791677d0b8SKris Buschelman EXTERN_C_BEGIN 80c6db04a5SJed Brown #include <umfpack.h> 811677d0b8SKris Buschelman EXTERN_C_END 821677d0b8SKris Buschelman 83fcfd50ebSBarry Smith static const char *const UmfpackOrderingTypes[] = {"CHOLMOD","AMD","GIVEN","METIS","BEST","NONE","USER","UmfpackOrderingTypes","UMFPACK_ORDERING_",0}; 84fcfd50ebSBarry Smith 851677d0b8SKris Buschelman typedef struct { 861677d0b8SKris Buschelman void *Symbolic, *Numeric; 871677d0b8SKris Buschelman double Info[UMFPACK_INFO], Control[UMFPACK_CONTROL],*W; 88ae26a541SJed Brown PetscInt *Wi,*perm_c; 89ae26a541SJed Brown Mat A; /* Matrix used for factorization */ 901677d0b8SKris Buschelman MatStructure flg; 91fcfd50ebSBarry Smith PetscBool PetscMatOrdering; 921677d0b8SKris Buschelman 931677d0b8SKris Buschelman /* Flag to clean up UMFPACK objects during Destroy */ 94ace3abfcSBarry Smith PetscBool CleanUpUMFPACK; 95f0c56d0fSKris Buschelman } Mat_UMFPACK; 96f0c56d0fSKris Buschelman 971677d0b8SKris Buschelman #undef __FUNCT__ 98f0c56d0fSKris Buschelman #define __FUNCT__ "MatDestroy_UMFPACK" 994b019bd2SJed Brown static PetscErrorCode MatDestroy_UMFPACK(Mat A) 100dfbe8321SBarry Smith { 101dfbe8321SBarry Smith PetscErrorCode ierr; 102f0c56d0fSKris Buschelman Mat_UMFPACK *lu=(Mat_UMFPACK*)A->spptr; 1031677d0b8SKris Buschelman 1041677d0b8SKris Buschelman PetscFunctionBegin; 105bf0cc555SLisandro Dalcin if (lu && lu->CleanUpUMFPACK) { 1068592901bSBarry Smith umfpack_UMF_free_symbolic(&lu->Symbolic); 1078592901bSBarry Smith umfpack_UMF_free_numeric(&lu->Numeric); 1081677d0b8SKris Buschelman ierr = PetscFree(lu->Wi);CHKERRQ(ierr); 1091677d0b8SKris Buschelman ierr = PetscFree(lu->W);CHKERRQ(ierr); 1101677d0b8SKris Buschelman ierr = PetscFree(lu->perm_c);CHKERRQ(ierr); 1111677d0b8SKris Buschelman } 112ae26a541SJed Brown ierr = MatDestroy(&lu->A);CHKERRQ(ierr); 113da0e1c47SShri Abhyankar ierr = PetscFree(A->spptr);CHKERRQ(ierr); 114b24902e0SBarry Smith ierr = MatDestroy_SeqAIJ(A);CHKERRQ(ierr); 1151677d0b8SKris Buschelman PetscFunctionReturn(0); 1161677d0b8SKris Buschelman } 1171677d0b8SKris Buschelman 1181677d0b8SKris Buschelman #undef __FUNCT__ 1194b019bd2SJed Brown #define __FUNCT__ "MatSolve_UMFPACK_Private" 1204b019bd2SJed Brown static PetscErrorCode MatSolve_UMFPACK_Private(Mat A,Vec b,Vec x,int uflag) 1216849ba73SBarry Smith { 122f0c56d0fSKris Buschelman Mat_UMFPACK *lu = (Mat_UMFPACK*)A->spptr; 123ae26a541SJed Brown Mat_SeqAIJ *a = (Mat_SeqAIJ*)lu->A->data; 124ae26a541SJed Brown PetscScalar *av = a->a,*ba,*xa; 125dfbe8321SBarry Smith PetscErrorCode ierr; 126ae26a541SJed Brown PetscInt *ai = a->i,*aj = a->j,status; 1271677d0b8SKris Buschelman 1281677d0b8SKris Buschelman PetscFunctionBegin; 1292d4e2982SHong Zhang /* solve Ax = b by umfpack_*_wsolve */ 1301677d0b8SKris Buschelman /* ----------------------------------*/ 1312d4e2982SHong Zhang 132ae26a541SJed Brown if (!lu->Wi) { /* first time, allocate working space for wsolve */ 133ae26a541SJed Brown ierr = PetscMalloc(A->rmap->n*sizeof(PetscInt),&lu->Wi);CHKERRQ(ierr); 134ae26a541SJed Brown ierr = PetscMalloc(5*A->rmap->n*sizeof(PetscScalar),&lu->W);CHKERRQ(ierr); 135ae26a541SJed Brown } 136ae26a541SJed Brown 1371677d0b8SKris Buschelman ierr = VecGetArray(b,&ba); 1381677d0b8SKris Buschelman ierr = VecGetArray(x,&xa); 13979c34000SHong Zhang #if defined(PETSC_USE_COMPLEX) 1404b019bd2SJed Brown status = umfpack_UMF_wsolve(uflag,ai,aj,(PetscReal*)av,NULL,(PetscReal*)xa,NULL,(PetscReal*)ba,NULL, 14179c34000SHong Zhang lu->Numeric,lu->Control,lu->Info,lu->Wi,lu->W); 14279c34000SHong Zhang #else 1434b019bd2SJed Brown status = umfpack_UMF_wsolve(uflag,ai,aj,av,xa,ba,lu->Numeric,lu->Control,lu->Info,lu->Wi,lu->W); 14479c34000SHong Zhang #endif 1458592901bSBarry Smith umfpack_UMF_report_info(lu->Control, lu->Info); 1461677d0b8SKris Buschelman if (status < 0){ 1478592901bSBarry Smith umfpack_UMF_report_status(lu->Control, status); 148e32f2f54SBarry Smith SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"umfpack_UMF_wsolve failed"); 1491677d0b8SKris Buschelman } 1501677d0b8SKris Buschelman 151057dcbc9SJed Brown ierr = VecRestoreArray(b,&ba);CHKERRQ(ierr); 152057dcbc9SJed Brown ierr = VecRestoreArray(x,&xa);CHKERRQ(ierr); 1534b019bd2SJed Brown PetscFunctionReturn(0); 1544b019bd2SJed Brown } 1552a325a84SHong Zhang 1564b019bd2SJed Brown #undef __FUNCT__ 1574b019bd2SJed Brown #define __FUNCT__ "MatSolve_UMFPACK" 1584b019bd2SJed Brown static PetscErrorCode MatSolve_UMFPACK(Mat A,Vec b,Vec x) 1594b019bd2SJed Brown { 1604b019bd2SJed Brown PetscErrorCode ierr; 1614b019bd2SJed Brown 1624b019bd2SJed Brown PetscFunctionBegin; 1634b019bd2SJed Brown /* We gave UMFPACK the algebraic transpose (because it assumes column alignment) */ 1644b019bd2SJed Brown ierr = MatSolve_UMFPACK_Private(A,b,x,UMFPACK_Aat);CHKERRQ(ierr); 1654b019bd2SJed Brown PetscFunctionReturn(0); 1664b019bd2SJed Brown } 1674b019bd2SJed Brown 1684b019bd2SJed Brown #undef __FUNCT__ 1694b019bd2SJed Brown #define __FUNCT__ "MatSolveTranspose_UMFPACK" 1704b019bd2SJed Brown static PetscErrorCode MatSolveTranspose_UMFPACK(Mat A,Vec b,Vec x) 1714b019bd2SJed Brown { 1724b019bd2SJed Brown PetscErrorCode ierr; 1734b019bd2SJed Brown 1744b019bd2SJed Brown PetscFunctionBegin; 1754b019bd2SJed Brown /* We gave UMFPACK the algebraic transpose (because it assumes column alignment) */ 1764b019bd2SJed Brown ierr = MatSolve_UMFPACK_Private(A,b,x,UMFPACK_A);CHKERRQ(ierr); 1771677d0b8SKris Buschelman PetscFunctionReturn(0); 1781677d0b8SKris Buschelman } 1791677d0b8SKris Buschelman 1801677d0b8SKris Buschelman #undef __FUNCT__ 181f0c56d0fSKris Buschelman #define __FUNCT__ "MatLUFactorNumeric_UMFPACK" 1824b019bd2SJed Brown static PetscErrorCode MatLUFactorNumeric_UMFPACK(Mat F,Mat A,const MatFactorInfo *info) 1836849ba73SBarry Smith { 184719d5645SBarry Smith Mat_UMFPACK *lu = (Mat_UMFPACK*)(F)->spptr; 185ae26a541SJed Brown Mat_SeqAIJ *a = (Mat_SeqAIJ*)A->data; 186ae26a541SJed Brown PetscInt *ai = a->i,*aj=a->j,status; 187ae26a541SJed Brown PetscScalar *av = a->a; 1886849ba73SBarry Smith PetscErrorCode ierr; 1891677d0b8SKris Buschelman 1901677d0b8SKris Buschelman PetscFunctionBegin; 1911677d0b8SKris Buschelman /* numeric factorization of A' */ 1921677d0b8SKris Buschelman /* ----------------------------*/ 1932d4e2982SHong Zhang 1948592901bSBarry Smith if (lu->flg == SAME_NONZERO_PATTERN && lu->Numeric){ 1958592901bSBarry Smith umfpack_UMF_free_numeric(&lu->Numeric); 1968592901bSBarry Smith } 1972d4e2982SHong Zhang #if defined(PETSC_USE_COMPLEX) 1988592901bSBarry Smith status = umfpack_UMF_numeric(ai,aj,(double*)av,NULL,lu->Symbolic,&lu->Numeric,lu->Control,lu->Info); 1992d4e2982SHong Zhang #else 2008592901bSBarry Smith status = umfpack_UMF_numeric(ai,aj,av,lu->Symbolic,&lu->Numeric,lu->Control,lu->Info); 2018592901bSBarry Smith #endif 2029f42a82aSMatthew Knepley if (status < 0) { 2038592901bSBarry Smith umfpack_UMF_report_status(lu->Control, status); 204e32f2f54SBarry Smith SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"umfpack_UMF_numeric failed"); 2059f42a82aSMatthew Knepley } 2062d4e2982SHong Zhang /* report numeric factorization of A' when Control[PRL] > 3 */ 2078592901bSBarry Smith (void) umfpack_UMF_report_numeric(lu->Numeric, lu->Control); 2081677d0b8SKris Buschelman 209ae26a541SJed Brown ierr = PetscObjectReference((PetscObject)A);CHKERRQ(ierr); 210ae26a541SJed Brown ierr = MatDestroy(&lu->A);CHKERRQ(ierr); 211ae26a541SJed Brown lu->A = A; 2122a325a84SHong Zhang lu->flg = SAME_NONZERO_PATTERN; 2132a325a84SHong Zhang lu->CleanUpUMFPACK = PETSC_TRUE; 2144b019bd2SJed Brown F->ops->solve = MatSolve_UMFPACK; 2154b019bd2SJed Brown F->ops->solvetranspose = MatSolveTranspose_UMFPACK; 2161677d0b8SKris Buschelman PetscFunctionReturn(0); 2171677d0b8SKris Buschelman } 2181677d0b8SKris Buschelman 2191677d0b8SKris Buschelman /* 2201677d0b8SKris Buschelman Note the r permutation is ignored 2211677d0b8SKris Buschelman */ 2221677d0b8SKris Buschelman #undef __FUNCT__ 223f0c56d0fSKris Buschelman #define __FUNCT__ "MatLUFactorSymbolic_UMFPACK" 2244b019bd2SJed Brown static PetscErrorCode MatLUFactorSymbolic_UMFPACK(Mat F,Mat A,IS r,IS c,const MatFactorInfo *info) 2256849ba73SBarry Smith { 226ae26a541SJed Brown Mat_SeqAIJ *a = (Mat_SeqAIJ*)A->data; 227719d5645SBarry Smith Mat_UMFPACK *lu = (Mat_UMFPACK*)(F->spptr); 228dfbe8321SBarry Smith PetscErrorCode ierr; 229ae26a541SJed Brown PetscInt i,*ai = a->i,*aj = a->j,m=A->rmap->n,n=A->cmap->n; 230ae26a541SJed Brown PetscScalar *av = a->a; 2315d0c19d7SBarry Smith const PetscInt *ra; 2328592901bSBarry Smith PetscInt status; 2331677d0b8SKris Buschelman 2341677d0b8SKris Buschelman PetscFunctionBegin; 235fcfd50ebSBarry Smith if (lu->PetscMatOrdering) { 2360f6efc10SHong Zhang ierr = ISGetIndices(r,&ra);CHKERRQ(ierr); 2378592901bSBarry Smith ierr = PetscMalloc(m*sizeof(PetscInt),&lu->perm_c);CHKERRQ(ierr); 2382d4e2982SHong Zhang /* we cannot simply memcpy on 64 bit archs */ 2392d4e2982SHong Zhang for(i = 0; i < m; i++) lu->perm_c[i] = ra[i]; 2400f6efc10SHong Zhang ierr = ISRestoreIndices(r,&ra);CHKERRQ(ierr); 2411677d0b8SKris Buschelman } 2421677d0b8SKris Buschelman 2431677d0b8SKris Buschelman /* print the control parameters */ 2448592901bSBarry Smith if(lu->Control[UMFPACK_PRL] > 1) umfpack_UMF_report_control(lu->Control); 2451677d0b8SKris Buschelman 2461677d0b8SKris Buschelman /* symbolic factorization of A' */ 2471677d0b8SKris Buschelman /* ---------------------------------------------------------------------- */ 248fcfd50ebSBarry Smith if (lu->PetscMatOrdering) { /* use Petsc row ordering */ 2498592901bSBarry Smith #if !defined(PETSC_USE_COMPLEX) 250ae26a541SJed Brown status = umfpack_UMF_qsymbolic(n,m,ai,aj,av,lu->perm_c,&lu->Symbolic,lu->Control,lu->Info); 2512d4e2982SHong Zhang #else 252ae26a541SJed Brown status = umfpack_UMF_qsymbolic(n,m,ai,aj,NULL,NULL, 25379c34000SHong Zhang lu->perm_c,&lu->Symbolic,lu->Control,lu->Info); 2548592901bSBarry Smith #endif 2552d4e2982SHong Zhang } else { /* use Umfpack col ordering */ 2568592901bSBarry Smith #if !defined(PETSC_USE_COMPLEX) 257ae26a541SJed Brown status = umfpack_UMF_symbolic(n,m,ai,aj,av,&lu->Symbolic,lu->Control,lu->Info); 2588592901bSBarry Smith #else 259ae26a541SJed Brown status = umfpack_UMF_symbolic(n,m,ai,aj,NULL,NULL,&lu->Symbolic,lu->Control,lu->Info); 2608592901bSBarry Smith #endif 2612d4e2982SHong Zhang } 2622d4e2982SHong Zhang if (status < 0){ 2638592901bSBarry Smith umfpack_UMF_report_info(lu->Control, lu->Info); 2648592901bSBarry Smith umfpack_UMF_report_status(lu->Control, status); 265e32f2f54SBarry Smith SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"umfpack_UMF_symbolic failed"); 2662d4e2982SHong Zhang } 2672d4e2982SHong Zhang /* report sumbolic factorization of A' when Control[PRL] > 3 */ 2688592901bSBarry Smith (void) umfpack_UMF_report_symbolic(lu->Symbolic, lu->Control); 2691677d0b8SKris Buschelman 2701677d0b8SKris Buschelman lu->flg = DIFFERENT_NONZERO_PATTERN; 271e1b4c3a1SKris Buschelman lu->CleanUpUMFPACK = PETSC_TRUE; 272719d5645SBarry Smith (F)->ops->lufactornumeric = MatLUFactorNumeric_UMFPACK; 2731677d0b8SKris Buschelman PetscFunctionReturn(0); 2741677d0b8SKris Buschelman } 2751677d0b8SKris Buschelman 2761677d0b8SKris Buschelman #undef __FUNCT__ 277f0c56d0fSKris Buschelman #define __FUNCT__ "MatFactorInfo_UMFPACK" 2784b019bd2SJed Brown static PetscErrorCode MatFactorInfo_UMFPACK(Mat A,PetscViewer viewer) 2796849ba73SBarry Smith { 280f0c56d0fSKris Buschelman Mat_UMFPACK *lu= (Mat_UMFPACK*)A->spptr; 281dfbe8321SBarry Smith PetscErrorCode ierr; 282f0c56d0fSKris Buschelman 2831677d0b8SKris Buschelman PetscFunctionBegin; 2841677d0b8SKris Buschelman /* check if matrix is UMFPACK type */ 285f0c56d0fSKris Buschelman if (A->ops->solve != MatSolve_UMFPACK) PetscFunctionReturn(0); 2861677d0b8SKris Buschelman 2871677d0b8SKris Buschelman ierr = PetscViewerASCIIPrintf(viewer,"UMFPACK run parameters:\n");CHKERRQ(ierr); 2881677d0b8SKris Buschelman /* Control parameters used by reporting routiones */ 2891677d0b8SKris Buschelman ierr = PetscViewerASCIIPrintf(viewer," Control[UMFPACK_PRL]: %g\n",lu->Control[UMFPACK_PRL]);CHKERRQ(ierr); 2901677d0b8SKris Buschelman 2911677d0b8SKris Buschelman /* Control parameters used by symbolic factorization */ 2920f6efc10SHong Zhang ierr = PetscViewerASCIIPrintf(viewer," Control[UMFPACK_STRATEGY]: %g\n",lu->Control[UMFPACK_STRATEGY]);CHKERRQ(ierr); 2931677d0b8SKris Buschelman ierr = PetscViewerASCIIPrintf(viewer," Control[UMFPACK_DENSE_COL]: %g\n",lu->Control[UMFPACK_DENSE_COL]);CHKERRQ(ierr); 2941677d0b8SKris Buschelman ierr = PetscViewerASCIIPrintf(viewer," Control[UMFPACK_DENSE_ROW]: %g\n",lu->Control[UMFPACK_DENSE_ROW]);CHKERRQ(ierr); 2950f6efc10SHong Zhang ierr = PetscViewerASCIIPrintf(viewer," Control[UMFPACK_AMD_DENSE]: %g\n",lu->Control[UMFPACK_AMD_DENSE]);CHKERRQ(ierr); 2961677d0b8SKris Buschelman ierr = PetscViewerASCIIPrintf(viewer," Control[UMFPACK_BLOCK_SIZE]: %g\n",lu->Control[UMFPACK_BLOCK_SIZE]);CHKERRQ(ierr); 2970f6efc10SHong Zhang ierr = PetscViewerASCIIPrintf(viewer," Control[UMFPACK_FIXQ]: %g\n",lu->Control[UMFPACK_FIXQ]);CHKERRQ(ierr); 2980f6efc10SHong Zhang ierr = PetscViewerASCIIPrintf(viewer," Control[UMFPACK_AGGRESSIVE]: %g\n",lu->Control[UMFPACK_AGGRESSIVE]);CHKERRQ(ierr); 2991677d0b8SKris Buschelman 3001677d0b8SKris Buschelman /* Control parameters used by numeric factorization */ 3011677d0b8SKris Buschelman ierr = PetscViewerASCIIPrintf(viewer," Control[UMFPACK_PIVOT_TOLERANCE]: %g\n",lu->Control[UMFPACK_PIVOT_TOLERANCE]);CHKERRQ(ierr); 3020f6efc10SHong Zhang ierr = PetscViewerASCIIPrintf(viewer," Control[UMFPACK_SYM_PIVOT_TOLERANCE]: %g\n",lu->Control[UMFPACK_SYM_PIVOT_TOLERANCE]);CHKERRQ(ierr); 3030f6efc10SHong Zhang ierr = PetscViewerASCIIPrintf(viewer," Control[UMFPACK_SCALE]: %g\n",lu->Control[UMFPACK_SCALE]);CHKERRQ(ierr); 3041677d0b8SKris Buschelman ierr = PetscViewerASCIIPrintf(viewer," Control[UMFPACK_ALLOC_INIT]: %g\n",lu->Control[UMFPACK_ALLOC_INIT]);CHKERRQ(ierr); 3050f6efc10SHong Zhang ierr = PetscViewerASCIIPrintf(viewer," Control[UMFPACK_DROPTOL]: %g\n",lu->Control[UMFPACK_DROPTOL]);CHKERRQ(ierr); 3061677d0b8SKris Buschelman 3071677d0b8SKris Buschelman /* Control parameters used by solve */ 3081677d0b8SKris Buschelman ierr = PetscViewerASCIIPrintf(viewer," Control[UMFPACK_IRSTEP]: %g\n",lu->Control[UMFPACK_IRSTEP]);CHKERRQ(ierr); 3091677d0b8SKris Buschelman 3101677d0b8SKris Buschelman /* mat ordering */ 311fcfd50ebSBarry Smith if (!lu->PetscMatOrdering) { 312fcfd50ebSBarry Smith ierr = PetscViewerASCIIPrintf(viewer," Control[UMFPACK_ORDERING]: %s (not using the PETSc ordering)\n",UmfpackOrderingTypes[(int)lu->Control[UMFPACK_ORDERING]]);CHKERRQ(ierr); 313fcfd50ebSBarry Smith } 3141677d0b8SKris Buschelman 3151677d0b8SKris Buschelman PetscFunctionReturn(0); 3161677d0b8SKris Buschelman } 3171677d0b8SKris Buschelman 318d844382dSKris Buschelman #undef __FUNCT__ 319f0c56d0fSKris Buschelman #define __FUNCT__ "MatView_UMFPACK" 3204b019bd2SJed Brown static PetscErrorCode MatView_UMFPACK(Mat A,PetscViewer viewer) 3216849ba73SBarry Smith { 322dfbe8321SBarry Smith PetscErrorCode ierr; 323ace3abfcSBarry Smith PetscBool iascii; 324d844382dSKris Buschelman PetscViewerFormat format; 325d844382dSKris Buschelman 326d844382dSKris Buschelman PetscFunctionBegin; 327b24902e0SBarry Smith ierr = MatView_SeqAIJ(A,viewer);CHKERRQ(ierr); 328d844382dSKris Buschelman 329251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr); 33032077d6dSBarry Smith if (iascii) { 331d844382dSKris Buschelman ierr = PetscViewerGetFormat(viewer,&format);CHKERRQ(ierr); 3322f59403fSHong Zhang if (format == PETSC_VIEWER_ASCII_INFO) { 333f0c56d0fSKris Buschelman ierr = MatFactorInfo_UMFPACK(A,viewer);CHKERRQ(ierr); 334d844382dSKris Buschelman } 335d844382dSKris Buschelman } 336d844382dSKris Buschelman PetscFunctionReturn(0); 337d844382dSKris Buschelman } 338d844382dSKris Buschelman 33935bd34faSBarry Smith EXTERN_C_BEGIN 34035bd34faSBarry Smith #undef __FUNCT__ 34135bd34faSBarry Smith #define __FUNCT__ "MatFactorGetSolverPackage_seqaij_umfpack" 34235bd34faSBarry Smith PetscErrorCode MatFactorGetSolverPackage_seqaij_umfpack(Mat A,const MatSolverPackage *type) 34335bd34faSBarry Smith { 34435bd34faSBarry Smith PetscFunctionBegin; 3452692d6eeSBarry Smith *type = MATSOLVERUMFPACK; 34635bd34faSBarry Smith PetscFunctionReturn(0); 34735bd34faSBarry Smith } 34835bd34faSBarry Smith EXTERN_C_END 34935bd34faSBarry Smith 35035bd34faSBarry Smith 3512f71e704SKris Buschelman /*MC 3522692d6eeSBarry Smith MATSOLVERUMFPACK = "umfpack" - A matrix type providing direct solvers (LU) for sequential matrices 3532f71e704SKris Buschelman via the external package UMFPACK. 3542f71e704SKris Buschelman 355e2e64c6bSBarry Smith ./configure --download-umfpack to install PETSc to use UMFPACK 3562f71e704SKris Buschelman 3572f71e704SKris Buschelman Consult UMFPACK documentation for more information about the Control parameters 3582f71e704SKris Buschelman which correspond to the options database keys below. 3592f71e704SKris Buschelman 3602f71e704SKris Buschelman Options Database Keys: 3615c9eb25fSBarry Smith + -mat_umfpack_prl - UMFPACK print level: Control[UMFPACK_PRL] 362e08999f5SMatthew G Knepley . -mat_umfpack_strategy <AUTO> - (choose one of) AUTO UNSYMMETRIC SYMMETRIC 2BY2 3632f71e704SKris Buschelman . -mat_umfpack_dense_col <alpha_c> - UMFPACK dense column threshold: Control[UMFPACK_DENSE_COL] 364e08999f5SMatthew G Knepley . -mat_umfpack_dense_row <0.2> - Control[UMFPACK_DENSE_ROW] 365e08999f5SMatthew G Knepley . -mat_umfpack_amd_dense <10> - Control[UMFPACK_AMD_DENSE] 3662f71e704SKris Buschelman . -mat_umfpack_block_size <bs> - UMFPACK block size for BLAS-Level 3 calls: Control[UMFPACK_BLOCK_SIZE] 367e08999f5SMatthew G Knepley . -mat_umfpack_2by2_tolerance <0.01> - Control[UMFPACK_2BY2_TOLERANCE] 368e08999f5SMatthew G Knepley . -mat_umfpack_fixq <0> - Control[UMFPACK_FIXQ] 369e08999f5SMatthew G Knepley . -mat_umfpack_aggressive <1> - Control[UMFPACK_AGGRESSIVE] 3702f71e704SKris Buschelman . -mat_umfpack_pivot_tolerance <delta> - UMFPACK partial pivot tolerance: Control[UMFPACK_PIVOT_TOLERANCE] 371e08999f5SMatthew G Knepley . -mat_umfpack_sym_pivot_tolerance <0.001> - Control[UMFPACK_SYM_PIVOT_TOLERANCE] 372e08999f5SMatthew G Knepley . -mat_umfpack_scale <NONE> - (choose one of) NONE SUM MAX 3732f71e704SKris Buschelman . -mat_umfpack_alloc_init <delta> - UMFPACK factorized matrix allocation modifier: Control[UMFPACK_ALLOC_INIT] 374e08999f5SMatthew G Knepley . -mat_umfpack_droptol <0> - Control[UMFPACK_DROPTOL] 3752f71e704SKris Buschelman - -mat_umfpack_irstep <maxit> - UMFPACK maximum number of iterative refinement steps: Control[UMFPACK_IRSTEP] 3762f71e704SKris Buschelman 3772f71e704SKris Buschelman Level: beginner 3782f71e704SKris Buschelman 379*d45987f3SHong Zhang .seealso: PCLU, MATSOLVERSUPERLU, MATSOLVERMUMPS, PCFactorSetMatSolverPackage(), MatSolverPackage 3802f71e704SKris Buschelman M*/ 3813519fcdcSHong Zhang EXTERN_C_BEGIN 3823519fcdcSHong Zhang #undef __FUNCT__ 3833519fcdcSHong Zhang #define __FUNCT__ "MatGetFactor_seqaij_umfpack" 3843519fcdcSHong Zhang PetscErrorCode MatGetFactor_seqaij_umfpack(Mat A,MatFactorType ftype,Mat *F) 3853519fcdcSHong Zhang { 3863519fcdcSHong Zhang Mat B; 3873519fcdcSHong Zhang Mat_UMFPACK *lu; 3883519fcdcSHong Zhang PetscErrorCode ierr; 3898592901bSBarry Smith PetscInt m=A->rmap->n,n=A->cmap->n,idx; 3902f71e704SKris Buschelman 391fcfd50ebSBarry Smith const char *strategy[]={"AUTO","UNSYMMETRIC","SYMMETRIC"}, 3923519fcdcSHong Zhang *scale[]={"NONE","SUM","MAX"}; 393ace3abfcSBarry Smith PetscBool flg; 3942d4e2982SHong Zhang 3953519fcdcSHong Zhang PetscFunctionBegin; 3963519fcdcSHong Zhang /* Create the factorization matrix F */ 3973519fcdcSHong Zhang ierr = MatCreate(((PetscObject)A)->comm,&B);CHKERRQ(ierr); 3983519fcdcSHong Zhang ierr = MatSetSizes(B,PETSC_DECIDE,PETSC_DECIDE,m,n);CHKERRQ(ierr); 3993519fcdcSHong Zhang ierr = MatSetType(B,((PetscObject)A)->type_name);CHKERRQ(ierr); 4003519fcdcSHong Zhang ierr = MatSeqAIJSetPreallocation(B,0,PETSC_NULL);CHKERRQ(ierr); 4013519fcdcSHong Zhang ierr = PetscNewLog(B,Mat_UMFPACK,&lu);CHKERRQ(ierr); 4023519fcdcSHong Zhang B->spptr = lu; 4033519fcdcSHong Zhang B->ops->lufactorsymbolic = MatLUFactorSymbolic_UMFPACK; 4043519fcdcSHong Zhang B->ops->destroy = MatDestroy_UMFPACK; 4053519fcdcSHong Zhang B->ops->view = MatView_UMFPACK; 40635bd34faSBarry Smith ierr = PetscObjectComposeFunctionDynamic((PetscObject)B,"MatFactorGetSolverPackage_C","MatFactorGetSolverPackage_seqaij_umfpack",MatFactorGetSolverPackage_seqaij_umfpack);CHKERRQ(ierr); 407d5f3da31SBarry Smith B->factortype = MAT_FACTOR_LU; 4083519fcdcSHong Zhang B->assembled = PETSC_TRUE; /* required by -ksp_view */ 4093519fcdcSHong Zhang B->preallocated = PETSC_TRUE; 4103519fcdcSHong Zhang 4113519fcdcSHong Zhang /* initializations */ 4123519fcdcSHong Zhang /* ------------------------------------------------*/ 4133519fcdcSHong Zhang /* get the default control parameters */ 4148592901bSBarry Smith umfpack_UMF_defaults(lu->Control); 4153519fcdcSHong Zhang lu->perm_c = PETSC_NULL; /* use defaul UMFPACK col permutation */ 4163519fcdcSHong Zhang lu->Control[UMFPACK_IRSTEP] = 0; /* max num of iterative refinement steps to attempt */ 4173519fcdcSHong Zhang 4183519fcdcSHong Zhang ierr = PetscOptionsBegin(((PetscObject)A)->comm,((PetscObject)A)->prefix,"UMFPACK Options","Mat");CHKERRQ(ierr); 4193519fcdcSHong Zhang /* Control parameters used by reporting routiones */ 4203519fcdcSHong Zhang ierr = PetscOptionsReal("-mat_umfpack_prl","Control[UMFPACK_PRL]","None",lu->Control[UMFPACK_PRL],&lu->Control[UMFPACK_PRL],PETSC_NULL);CHKERRQ(ierr); 4213519fcdcSHong Zhang 4223519fcdcSHong Zhang /* Control parameters for symbolic factorization */ 423fcfd50ebSBarry Smith ierr = PetscOptionsEList("-mat_umfpack_strategy","ordering and pivoting strategy","None",strategy,3,strategy[0],&idx,&flg);CHKERRQ(ierr); 4243519fcdcSHong Zhang if (flg) { 4253519fcdcSHong Zhang switch (idx){ 4263519fcdcSHong Zhang case 0: lu->Control[UMFPACK_STRATEGY] = UMFPACK_STRATEGY_AUTO; break; 4273519fcdcSHong Zhang case 1: lu->Control[UMFPACK_STRATEGY] = UMFPACK_STRATEGY_UNSYMMETRIC; break; 4283519fcdcSHong Zhang case 2: lu->Control[UMFPACK_STRATEGY] = UMFPACK_STRATEGY_SYMMETRIC; break; 4293519fcdcSHong Zhang } 4303519fcdcSHong Zhang } 431fcfd50ebSBarry Smith ierr = PetscOptionsEList("-mat_umfpack_ordering","Internal ordering method","None",UmfpackOrderingTypes,sizeof UmfpackOrderingTypes/sizeof UmfpackOrderingTypes[0],UmfpackOrderingTypes[(int)lu->Control[UMFPACK_ORDERING]],&idx,&flg);CHKERRQ(ierr); 432fcfd50ebSBarry Smith if (flg) lu->Control[UMFPACK_ORDERING] = (int)idx; 4333519fcdcSHong Zhang ierr = PetscOptionsReal("-mat_umfpack_dense_col","Control[UMFPACK_DENSE_COL]","None",lu->Control[UMFPACK_DENSE_COL],&lu->Control[UMFPACK_DENSE_COL],PETSC_NULL);CHKERRQ(ierr); 4343519fcdcSHong Zhang ierr = PetscOptionsReal("-mat_umfpack_dense_row","Control[UMFPACK_DENSE_ROW]","None",lu->Control[UMFPACK_DENSE_ROW],&lu->Control[UMFPACK_DENSE_ROW],PETSC_NULL);CHKERRQ(ierr); 4353519fcdcSHong Zhang ierr = PetscOptionsReal("-mat_umfpack_amd_dense","Control[UMFPACK_AMD_DENSE]","None",lu->Control[UMFPACK_AMD_DENSE],&lu->Control[UMFPACK_AMD_DENSE],PETSC_NULL);CHKERRQ(ierr); 4363519fcdcSHong Zhang ierr = PetscOptionsReal("-mat_umfpack_block_size","Control[UMFPACK_BLOCK_SIZE]","None",lu->Control[UMFPACK_BLOCK_SIZE],&lu->Control[UMFPACK_BLOCK_SIZE],PETSC_NULL);CHKERRQ(ierr); 4373519fcdcSHong Zhang ierr = PetscOptionsReal("-mat_umfpack_fixq","Control[UMFPACK_FIXQ]","None",lu->Control[UMFPACK_FIXQ],&lu->Control[UMFPACK_FIXQ],PETSC_NULL);CHKERRQ(ierr); 4383519fcdcSHong Zhang ierr = PetscOptionsReal("-mat_umfpack_aggressive","Control[UMFPACK_AGGRESSIVE]","None",lu->Control[UMFPACK_AGGRESSIVE],&lu->Control[UMFPACK_AGGRESSIVE],PETSC_NULL);CHKERRQ(ierr); 4393519fcdcSHong Zhang 4403519fcdcSHong Zhang /* Control parameters used by numeric factorization */ 4413519fcdcSHong Zhang ierr = PetscOptionsReal("-mat_umfpack_pivot_tolerance","Control[UMFPACK_PIVOT_TOLERANCE]","None",lu->Control[UMFPACK_PIVOT_TOLERANCE],&lu->Control[UMFPACK_PIVOT_TOLERANCE],PETSC_NULL);CHKERRQ(ierr); 4423519fcdcSHong Zhang ierr = PetscOptionsReal("-mat_umfpack_sym_pivot_tolerance","Control[UMFPACK_SYM_PIVOT_TOLERANCE]","None",lu->Control[UMFPACK_SYM_PIVOT_TOLERANCE],&lu->Control[UMFPACK_SYM_PIVOT_TOLERANCE],PETSC_NULL);CHKERRQ(ierr); 4433519fcdcSHong Zhang ierr = PetscOptionsEList("-mat_umfpack_scale","Control[UMFPACK_SCALE]","None",scale,3,scale[0],&idx,&flg);CHKERRQ(ierr); 4443519fcdcSHong Zhang if (flg) { 4453519fcdcSHong Zhang switch (idx){ 4463519fcdcSHong Zhang case 0: lu->Control[UMFPACK_SCALE] = UMFPACK_SCALE_NONE; break; 4473519fcdcSHong Zhang case 1: lu->Control[UMFPACK_SCALE] = UMFPACK_SCALE_SUM; break; 4483519fcdcSHong Zhang case 2: lu->Control[UMFPACK_SCALE] = UMFPACK_SCALE_MAX; break; 4493519fcdcSHong Zhang } 4503519fcdcSHong Zhang } 4513519fcdcSHong Zhang ierr = PetscOptionsReal("-mat_umfpack_alloc_init","Control[UMFPACK_ALLOC_INIT]","None",lu->Control[UMFPACK_ALLOC_INIT],&lu->Control[UMFPACK_ALLOC_INIT],PETSC_NULL);CHKERRQ(ierr); 4523519fcdcSHong Zhang ierr = PetscOptionsReal("-mat_umfpack_front_alloc_init","Control[UMFPACK_FRONT_ALLOC_INIT]","None",lu->Control[UMFPACK_FRONT_ALLOC_INIT],&lu->Control[UMFPACK_ALLOC_INIT],PETSC_NULL);CHKERRQ(ierr); 4533519fcdcSHong Zhang ierr = PetscOptionsReal("-mat_umfpack_droptol","Control[UMFPACK_DROPTOL]","None",lu->Control[UMFPACK_DROPTOL],&lu->Control[UMFPACK_DROPTOL],PETSC_NULL);CHKERRQ(ierr); 4543519fcdcSHong Zhang 4553519fcdcSHong Zhang /* Control parameters used by solve */ 4563519fcdcSHong Zhang ierr = PetscOptionsReal("-mat_umfpack_irstep","Control[UMFPACK_IRSTEP]","None",lu->Control[UMFPACK_IRSTEP],&lu->Control[UMFPACK_IRSTEP],PETSC_NULL);CHKERRQ(ierr); 4573519fcdcSHong Zhang 4583519fcdcSHong Zhang /* use Petsc mat ordering (note: size is for the transpose, and PETSc r = Umfpack perm_c) */ 459fcfd50ebSBarry Smith ierr = PetscOptionsHasName(PETSC_NULL,"-pc_factor_mat_ordering_type",&lu->PetscMatOrdering);CHKERRQ(ierr); 4603519fcdcSHong Zhang PetscOptionsEnd(); 4613519fcdcSHong Zhang *F = B; 4623519fcdcSHong Zhang PetscFunctionReturn(0); 4633519fcdcSHong Zhang } 4643519fcdcSHong Zhang EXTERN_C_END 4652d4e2982SHong Zhang 466