1 static char help[] = "Tests MatSolve() and MatMatSolve() (interface to superlu_dist, mumps and mkl_pardiso).\n\ 2 Example: mpiexec -n <np> ./ex125 -f <matrix binary file> -nrhs 4 \n\n"; 3 4 #include <petscmat.h> 5 6 int main(int argc,char **args) 7 { 8 Mat A,RHS,C,F,X; 9 Vec u,x,b; 10 PetscErrorCode ierr; 11 PetscMPIInt size; 12 PetscInt m,n,nfact,nsolve,nrhs,ipack=0; 13 PetscReal norm,tol=1.e-10; 14 IS perm,iperm; 15 MatFactorInfo info; 16 PetscRandom rand; 17 PetscBool flg,testMatSolve=PETSC_TRUE,testMatMatSolve=PETSC_TRUE; 18 PetscBool chol=PETSC_FALSE,view=PETSC_FALSE,matsolvexx = PETSC_FALSE; 19 #if defined(PETSC_HAVE_MUMPS) 20 PetscBool test_mumps_opts=PETSC_FALSE; 21 #endif 22 PetscViewer fd; /* viewer */ 23 char file[PETSC_MAX_PATH_LEN]; /* input file name */ 24 25 ierr = PetscInitialize(&argc,&args,(char*)0,help);if (ierr) return ierr; 26 ierr = MPI_Comm_size(PETSC_COMM_WORLD, &size);CHKERRMPI(ierr); 27 28 /* Determine file from which we read the matrix A */ 29 ierr = PetscOptionsGetString(NULL,NULL,"-f",file,sizeof(file),&flg);CHKERRQ(ierr); 30 if (flg) { /* Load matrix A */ 31 ierr = PetscViewerBinaryOpen(PETSC_COMM_WORLD,file,FILE_MODE_READ,&fd);CHKERRQ(ierr); 32 ierr = MatCreate(PETSC_COMM_WORLD,&A);CHKERRQ(ierr); 33 ierr = MatSetFromOptions(A);CHKERRQ(ierr); 34 ierr = MatLoad(A,fd);CHKERRQ(ierr); 35 ierr = PetscViewerDestroy(&fd);CHKERRQ(ierr); 36 } else { 37 n = 13; 38 ierr = PetscOptionsGetInt(NULL,NULL,"-n",&n,NULL);CHKERRQ(ierr); 39 ierr = MatCreate(PETSC_COMM_WORLD,&A);CHKERRQ(ierr); 40 ierr = MatSetType(A,MATAIJ);CHKERRQ(ierr); 41 ierr = MatSetFromOptions(A);CHKERRQ(ierr); 42 ierr = MatSetSizes(A,PETSC_DECIDE,PETSC_DECIDE,n,n);CHKERRQ(ierr); 43 ierr = MatSetUp(A);CHKERRQ(ierr); 44 ierr = MatAssemblyBegin(A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 45 ierr = MatAssemblyEnd(A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 46 ierr = MatShift(A,1.0);CHKERRQ(ierr); 47 } 48 ierr = MatGetLocalSize(A,&m,&n);CHKERRQ(ierr); 49 PetscCheckFalse(m != n,PETSC_COMM_SELF,PETSC_ERR_ARG_SIZ, "This example is not intended for rectangular matrices (%" PetscInt_FMT ", %" PetscInt_FMT ")", m, n); 50 51 /* if A is symmetric, set its flag -- required by MatGetInertia() */ 52 ierr = MatIsSymmetric(A,0.0,&flg);CHKERRQ(ierr); 53 54 ierr = MatViewFromOptions(A,NULL,"-A_view");CHKERRQ(ierr); 55 56 /* Create dense matrix C and X; C holds true solution with identical columns */ 57 nrhs = 2; 58 ierr = PetscOptionsGetInt(NULL,NULL,"-nrhs",&nrhs,NULL);CHKERRQ(ierr); 59 ierr = PetscPrintf(PETSC_COMM_WORLD,"ex125: nrhs %" PetscInt_FMT "\n",nrhs);CHKERRQ(ierr); 60 ierr = MatCreate(PETSC_COMM_WORLD,&C);CHKERRQ(ierr); 61 ierr = MatSetOptionsPrefix(C,"rhs_");CHKERRQ(ierr); 62 ierr = MatSetSizes(C,m,PETSC_DECIDE,PETSC_DECIDE,nrhs);CHKERRQ(ierr); 63 ierr = MatSetType(C,MATDENSE);CHKERRQ(ierr); 64 ierr = MatSetFromOptions(C);CHKERRQ(ierr); 65 ierr = MatSetUp(C);CHKERRQ(ierr); 66 67 ierr = PetscOptionsGetBool(NULL,NULL,"-view_factor",&view,NULL);CHKERRQ(ierr); 68 ierr = PetscOptionsGetBool(NULL,NULL,"-test_matmatsolve",&testMatMatSolve,NULL);CHKERRQ(ierr); 69 ierr = PetscOptionsGetBool(NULL,NULL,"-cholesky",&chol,NULL);CHKERRQ(ierr); 70 #if defined(PETSC_HAVE_MUMPS) 71 ierr = PetscOptionsGetBool(NULL,NULL,"-test_mumps_opts",&test_mumps_opts,NULL);CHKERRQ(ierr); 72 #endif 73 74 ierr = PetscRandomCreate(PETSC_COMM_WORLD,&rand);CHKERRQ(ierr); 75 ierr = PetscRandomSetFromOptions(rand);CHKERRQ(ierr); 76 ierr = MatSetRandom(C,rand);CHKERRQ(ierr); 77 ierr = MatDuplicate(C,MAT_DO_NOT_COPY_VALUES,&X);CHKERRQ(ierr); 78 79 /* Create vectors */ 80 ierr = MatCreateVecs(A,&x,&b);CHKERRQ(ierr); 81 ierr = VecDuplicate(x,&u);CHKERRQ(ierr); /* save the true solution */ 82 83 /* Test Factorization */ 84 ierr = MatGetOrdering(A,MATORDERINGND,&perm,&iperm);CHKERRQ(ierr); 85 86 ierr = PetscOptionsGetInt(NULL,NULL,"-mat_solver_type",&ipack,NULL);CHKERRQ(ierr); 87 switch (ipack) { 88 #if defined(PETSC_HAVE_SUPERLU) 89 case 0: 90 PetscCheckFalse(chol,PETSC_COMM_WORLD,PETSC_ERR_SUP,"SuperLU does not provide Cholesky!"); 91 ierr = PetscPrintf(PETSC_COMM_WORLD," SUPERLU LU:\n");CHKERRQ(ierr); 92 ierr = MatGetFactor(A,MATSOLVERSUPERLU,MAT_FACTOR_LU,&F);CHKERRQ(ierr); 93 matsolvexx = PETSC_TRUE; 94 break; 95 #endif 96 #if defined(PETSC_HAVE_SUPERLU_DIST) 97 case 1: 98 PetscCheckFalse(chol,PETSC_COMM_WORLD,PETSC_ERR_SUP,"SuperLU does not provide Cholesky!"); 99 ierr = PetscPrintf(PETSC_COMM_WORLD," SUPERLU_DIST LU:\n");CHKERRQ(ierr); 100 ierr = MatGetFactor(A,MATSOLVERSUPERLU_DIST,MAT_FACTOR_LU,&F);CHKERRQ(ierr); 101 matsolvexx = PETSC_TRUE; 102 break; 103 #endif 104 #if defined(PETSC_HAVE_MUMPS) 105 case 2: 106 if (chol) { 107 ierr = PetscPrintf(PETSC_COMM_WORLD," MUMPS CHOLESKY:\n");CHKERRQ(ierr); 108 ierr = MatGetFactor(A,MATSOLVERMUMPS,MAT_FACTOR_CHOLESKY,&F);CHKERRQ(ierr); 109 } else { 110 ierr = PetscPrintf(PETSC_COMM_WORLD," MUMPS LU:\n");CHKERRQ(ierr); 111 ierr = MatGetFactor(A,MATSOLVERMUMPS,MAT_FACTOR_LU,&F);CHKERRQ(ierr); 112 } 113 matsolvexx = PETSC_TRUE; 114 if (test_mumps_opts) { 115 /* test mumps options */ 116 PetscInt icntl; 117 PetscReal cntl; 118 119 icntl = 2; /* sequential matrix ordering */ 120 ierr = MatMumpsSetIcntl(F,7,icntl);CHKERRQ(ierr); 121 122 cntl = 1.e-6; /* threshold for row pivot detection */ 123 ierr = MatMumpsSetIcntl(F,24,1);CHKERRQ(ierr); 124 ierr = MatMumpsSetCntl(F,3,cntl);CHKERRQ(ierr); 125 } 126 break; 127 #endif 128 #if defined(PETSC_HAVE_MKL_PARDISO) 129 case 3: 130 if (chol) { 131 ierr = PetscPrintf(PETSC_COMM_WORLD," MKL_PARDISO CHOLESKY:\n");CHKERRQ(ierr); 132 ierr = MatGetFactor(A,MATSOLVERMKL_PARDISO,MAT_FACTOR_CHOLESKY,&F);CHKERRQ(ierr); 133 } else { 134 ierr = PetscPrintf(PETSC_COMM_WORLD," MKL_PARDISO LU:\n");CHKERRQ(ierr); 135 ierr = MatGetFactor(A,MATSOLVERMKL_PARDISO,MAT_FACTOR_LU,&F);CHKERRQ(ierr); 136 } 137 break; 138 #endif 139 #if defined(PETSC_HAVE_CUDA) 140 case 4: 141 if (chol) { 142 ierr = PetscPrintf(PETSC_COMM_WORLD," CUSPARSE CHOLESKY:\n");CHKERRQ(ierr); 143 ierr = MatGetFactor(A,MATSOLVERCUSPARSE,MAT_FACTOR_CHOLESKY,&F);CHKERRQ(ierr); 144 } else { 145 ierr = PetscPrintf(PETSC_COMM_WORLD," CUSPARSE LU:\n");CHKERRQ(ierr); 146 ierr = MatGetFactor(A,MATSOLVERCUSPARSE,MAT_FACTOR_LU,&F);CHKERRQ(ierr); 147 } 148 break; 149 #endif 150 default: 151 if (chol) { 152 ierr = PetscPrintf(PETSC_COMM_WORLD," PETSC CHOLESKY:\n");CHKERRQ(ierr); 153 ierr = MatGetFactor(A,MATSOLVERPETSC,MAT_FACTOR_CHOLESKY,&F);CHKERRQ(ierr); 154 } else { 155 ierr = PetscPrintf(PETSC_COMM_WORLD," PETSC LU:\n");CHKERRQ(ierr); 156 ierr = MatGetFactor(A,MATSOLVERPETSC,MAT_FACTOR_LU,&F);CHKERRQ(ierr); 157 } 158 matsolvexx = PETSC_TRUE; 159 } 160 161 ierr = MatFactorInfoInitialize(&info);CHKERRQ(ierr); 162 info.fill = 5.0; 163 info.shifttype = (PetscReal) MAT_SHIFT_NONE; 164 if (chol) { 165 ierr = MatCholeskyFactorSymbolic(F,A,perm,&info);CHKERRQ(ierr); 166 } else { 167 ierr = MatLUFactorSymbolic(F,A,perm,iperm,&info);CHKERRQ(ierr); 168 } 169 170 for (nfact = 0; nfact < 2; nfact++) { 171 if (chol) { 172 ierr = PetscPrintf(PETSC_COMM_WORLD," %" PetscInt_FMT "-the CHOLESKY numfactorization \n",nfact);CHKERRQ(ierr); 173 ierr = MatCholeskyFactorNumeric(F,A,&info);CHKERRQ(ierr); 174 } else { 175 ierr = PetscPrintf(PETSC_COMM_WORLD," %" PetscInt_FMT "-the LU numfactorization \n",nfact);CHKERRQ(ierr); 176 ierr = MatLUFactorNumeric(F,A,&info);CHKERRQ(ierr); 177 } 178 if (view) { 179 ierr = PetscViewerPushFormat(PETSC_VIEWER_STDOUT_WORLD,PETSC_VIEWER_ASCII_INFO);CHKERRQ(ierr); 180 ierr = MatView(F,PETSC_VIEWER_STDOUT_WORLD);CHKERRQ(ierr); 181 ierr = PetscViewerPopFormat(PETSC_VIEWER_STDOUT_WORLD);CHKERRQ(ierr); 182 view = PETSC_FALSE; 183 } 184 185 #if defined(PETSC_HAVE_SUPERLU_DIST) 186 if (ipack == 1) { /* Test MatSuperluDistGetDiagU() 187 -- input: matrix factor F; output: main diagonal of matrix U on all processes */ 188 PetscInt M; 189 PetscScalar *diag; 190 #if !defined(PETSC_USE_COMPLEX) 191 PetscInt nneg,nzero,npos; 192 #endif 193 194 ierr = MatGetSize(F,&M,NULL);CHKERRQ(ierr); 195 ierr = PetscMalloc1(M,&diag);CHKERRQ(ierr); 196 ierr = MatSuperluDistGetDiagU(F,diag);CHKERRQ(ierr); 197 ierr = PetscFree(diag);CHKERRQ(ierr); 198 199 #if !defined(PETSC_USE_COMPLEX) 200 /* Test MatGetInertia() */ 201 ierr = MatGetInertia(F,&nneg,&nzero,&npos);CHKERRQ(ierr); 202 ierr = PetscViewerASCIIPrintf(PETSC_VIEWER_STDOUT_WORLD," MatInertia: nneg: %" PetscInt_FMT ", nzero: %" PetscInt_FMT ", npos: %" PetscInt_FMT "\n",nneg,nzero,npos);CHKERRQ(ierr); 203 #endif 204 } 205 #endif 206 207 #if defined(PETSC_HAVE_MUMPS) 208 /* mumps interface allows repeated call of MatCholeskyFactorSymbolic(), while the succession calls do nothing */ 209 if (ipack == 2) { 210 if (chol) { 211 ierr = MatCholeskyFactorSymbolic(F,A,perm,&info);CHKERRQ(ierr); 212 ierr = MatCholeskyFactorNumeric(F,A,&info);CHKERRQ(ierr); 213 } else { 214 ierr = MatLUFactorSymbolic(F,A,perm,iperm,&info);CHKERRQ(ierr); 215 ierr = MatLUFactorNumeric(F,A,&info);CHKERRQ(ierr); 216 } 217 } 218 #endif 219 220 /* Test MatMatSolve() */ 221 if (testMatMatSolve) { 222 if (!nfact) { 223 ierr = MatMatMult(A,C,MAT_INITIAL_MATRIX,2.0,&RHS);CHKERRQ(ierr); 224 } else { 225 ierr = MatMatMult(A,C,MAT_REUSE_MATRIX,2.0,&RHS);CHKERRQ(ierr); 226 } 227 for (nsolve = 0; nsolve < 2; nsolve++) { 228 ierr = PetscPrintf(PETSC_COMM_WORLD," %" PetscInt_FMT "-the MatMatSolve \n",nsolve);CHKERRQ(ierr); 229 ierr = MatMatSolve(F,RHS,X);CHKERRQ(ierr); 230 231 /* Check the error */ 232 ierr = MatAXPY(X,-1.0,C,SAME_NONZERO_PATTERN);CHKERRQ(ierr); 233 ierr = MatNorm(X,NORM_FROBENIUS,&norm);CHKERRQ(ierr); 234 if (norm > tol) { 235 ierr = PetscPrintf(PETSC_COMM_WORLD,"%" PetscInt_FMT "-the MatMatSolve: Norm of error %g, nsolve %" PetscInt_FMT "\n",nsolve,(double)norm,nsolve);CHKERRQ(ierr); 236 } 237 } 238 if (matsolvexx) { 239 /* Test MatMatSolve(F,RHS,RHS), RHS is a dense matrix */ 240 ierr = MatCopy(RHS,X,SAME_NONZERO_PATTERN);CHKERRQ(ierr); 241 ierr = MatMatSolve(F,X,X);CHKERRQ(ierr); 242 /* Check the error */ 243 ierr = MatAXPY(X,-1.0,C,SAME_NONZERO_PATTERN);CHKERRQ(ierr); 244 ierr = MatNorm(X,NORM_FROBENIUS,&norm);CHKERRQ(ierr); 245 if (norm > tol) { 246 ierr = PetscPrintf(PETSC_COMM_WORLD,"MatMatSolve(F,RHS,RHS): Norm of error %g\n",(double)norm);CHKERRQ(ierr); 247 } 248 } 249 250 if (ipack == 2 && size == 1) { 251 Mat spRHS,spRHST,RHST; 252 253 ierr = MatTranspose(RHS,MAT_INITIAL_MATRIX,&RHST);CHKERRQ(ierr); 254 ierr = MatConvert(RHST,MATAIJ,MAT_INITIAL_MATRIX,&spRHST);CHKERRQ(ierr); 255 ierr = MatCreateTranspose(spRHST,&spRHS);CHKERRQ(ierr); 256 for (nsolve = 0; nsolve < 2; nsolve++) { 257 ierr = PetscPrintf(PETSC_COMM_WORLD," %" PetscInt_FMT "-the sparse MatMatSolve \n",nsolve);CHKERRQ(ierr); 258 ierr = MatMatSolve(F,spRHS,X);CHKERRQ(ierr); 259 260 /* Check the error */ 261 ierr = MatAXPY(X,-1.0,C,SAME_NONZERO_PATTERN);CHKERRQ(ierr); 262 ierr = MatNorm(X,NORM_FROBENIUS,&norm);CHKERRQ(ierr); 263 if (norm > tol) { 264 ierr = PetscPrintf(PETSC_COMM_WORLD,"%" PetscInt_FMT "-the sparse MatMatSolve: Norm of error %g, nsolve %" PetscInt_FMT "\n",nsolve,(double)norm,nsolve);CHKERRQ(ierr); 265 } 266 } 267 ierr = MatDestroy(&spRHST);CHKERRQ(ierr); 268 ierr = MatDestroy(&spRHS);CHKERRQ(ierr); 269 ierr = MatDestroy(&RHST);CHKERRQ(ierr); 270 } 271 } 272 273 /* Test MatSolve() */ 274 if (testMatSolve) { 275 for (nsolve = 0; nsolve < 2; nsolve++) { 276 ierr = VecSetRandom(x,rand);CHKERRQ(ierr); 277 ierr = VecCopy(x,u);CHKERRQ(ierr); 278 ierr = MatMult(A,x,b);CHKERRQ(ierr); 279 280 ierr = PetscPrintf(PETSC_COMM_WORLD," %" PetscInt_FMT "-the MatSolve \n",nsolve);CHKERRQ(ierr); 281 ierr = MatSolve(F,b,x);CHKERRQ(ierr); 282 283 /* Check the error */ 284 ierr = VecAXPY(u,-1.0,x);CHKERRQ(ierr); /* u <- (-1.0)x + u */ 285 ierr = VecNorm(u,NORM_2,&norm);CHKERRQ(ierr); 286 if (norm > tol) { 287 PetscReal resi; 288 ierr = MatMult(A,x,u);CHKERRQ(ierr); /* u = A*x */ 289 ierr = VecAXPY(u,-1.0,b);CHKERRQ(ierr); /* u <- (-1.0)b + u */ 290 ierr = VecNorm(u,NORM_2,&resi);CHKERRQ(ierr); 291 ierr = PetscPrintf(PETSC_COMM_WORLD,"MatSolve: Norm of error %g, resi %g, numfact %" PetscInt_FMT "\n",(double)norm,(double)resi,nfact);CHKERRQ(ierr); 292 } 293 } 294 } 295 } 296 297 /* Free data structures */ 298 ierr = MatDestroy(&A);CHKERRQ(ierr); 299 ierr = MatDestroy(&C);CHKERRQ(ierr); 300 ierr = MatDestroy(&F);CHKERRQ(ierr); 301 ierr = MatDestroy(&X);CHKERRQ(ierr); 302 if (testMatMatSolve) { 303 ierr = MatDestroy(&RHS);CHKERRQ(ierr); 304 } 305 306 ierr = PetscRandomDestroy(&rand);CHKERRQ(ierr); 307 ierr = ISDestroy(&perm);CHKERRQ(ierr); 308 ierr = ISDestroy(&iperm);CHKERRQ(ierr); 309 ierr = VecDestroy(&x);CHKERRQ(ierr); 310 ierr = VecDestroy(&b);CHKERRQ(ierr); 311 ierr = VecDestroy(&u);CHKERRQ(ierr); 312 ierr = PetscFinalize(); 313 return ierr; 314 } 315 316 /*TEST 317 318 test: 319 requires: datafilespath !complex double !defined(PETSC_USE_64BIT_INDICES) 320 args: -f ${DATAFILESPATH}/matrices/small -mat_solver_type 10 321 output_file: output/ex125.out 322 323 test: 324 suffix: 2 325 args: -mat_solver_type 10 326 output_file: output/ex125.out 327 328 test: 329 suffix: mkl_pardiso 330 requires: mkl_pardiso datafilespath !complex double !defined(PETSC_USE_64BIT_INDICES) 331 args: -f ${DATAFILESPATH}/matrices/small -mat_solver_type 3 332 333 test: 334 suffix: mkl_pardiso_2 335 requires: mkl_pardiso 336 args: -mat_solver_type 3 337 output_file: output/ex125_mkl_pardiso.out 338 339 test: 340 suffix: mumps 341 requires: mumps datafilespath !complex double !defined(PETSC_USE_64BIT_INDICES) 342 args: -f ${DATAFILESPATH}/matrices/small -mat_solver_type 2 343 output_file: output/ex125_mumps_seq.out 344 345 test: 346 suffix: mumps_2 347 nsize: 3 348 requires: mumps datafilespath !complex double !defined(PETSC_USE_64BIT_INDICES) 349 args: -f ${DATAFILESPATH}/matrices/small -mat_solver_type 2 350 output_file: output/ex125_mumps_par.out 351 352 test: 353 suffix: mumps_3 354 requires: mumps 355 args: -mat_solver_type 2 356 output_file: output/ex125_mumps_seq.out 357 358 test: 359 suffix: mumps_4 360 nsize: 3 361 requires: mumps 362 args: -mat_solver_type 2 363 output_file: output/ex125_mumps_par.out 364 365 test: 366 suffix: mumps_5 367 nsize: 3 368 requires: mumps 369 args: -mat_solver_type 2 -cholesky 370 output_file: output/ex125_mumps_par_cholesky.out 371 372 test: 373 suffix: superlu_dist 374 nsize: {{1 3}} 375 requires: datafilespath !complex double !defined(PETSC_USE_64BIT_INDICES) superlu_dist 376 args: -f ${DATAFILESPATH}/matrices/small -mat_solver_type 1 -mat_superlu_dist_rowperm NOROWPERM 377 378 test: 379 suffix: superlu_dist_2 380 nsize: {{1 3}} 381 requires: superlu_dist !complex 382 args: -n 36 -mat_solver_type 1 -mat_superlu_dist_rowperm NOROWPERM 383 output_file: output/ex125_superlu_dist.out 384 385 test: 386 suffix: superlu_dist_complex 387 nsize: 3 388 requires: datafilespath superlu_dist complex double !defined(PETSC_USE_64BIT_INDICES) 389 args: -f ${DATAFILESPATH}/matrices/farzad_B_rhs -mat_solver_type 1 390 output_file: output/ex125_superlu_dist_complex.out 391 392 test: 393 suffix: superlu_dist_complex_2 394 nsize: 3 395 requires: superlu_dist complex 396 args: -mat_solver_type 1 397 output_file: output/ex125_superlu_dist_complex.out 398 399 test: 400 suffix: cusparse 401 requires: cuda datafilespath !complex double !defined(PETSC_USE_64BIT_INDICES) 402 args: -mat_type aijcusparse -f ${DATAFILESPATH}/matrices/small -mat_solver_type 4 -cholesky {{0 1}separate output} 403 404 test: 405 suffix: cusparse_2 406 requires: cuda 407 args: -mat_type aijcusparse -mat_solver_type 4 -cholesky {{0 1}separate output} 408 409 TEST*/ 410