xref: /petsc/src/mat/tests/ex128.c (revision ebead697dbf761eb322f829370bbe90b3bd93fa3)
1 
2 static char help[] = "Tests ILU and ICC factorization with and without matrix ordering on seqsbaij format. Modified from ex30.c\n\
3   Input parameters are:\n\
4   -lf <level> : level of fill for ILU (default is 0)\n\
5   -lu : use full LU or Cholesky factorization\n\
6   -m <value>,-n <value> : grid dimensions\n\
7 Note that most users should employ the KSP interface to the\n\
8 linear solvers instead of using the factorization routines\n\
9 directly.\n\n";
10 
11 #include <petscmat.h>
12 
13 int main(int argc,char **args)
14 {
15   Mat            C,sC,sA;
16   PetscInt       i,j,m = 5,n = 5,Ii,J,lf = 0;
17   PetscBool      CHOLESKY=PETSC_FALSE,TRIANGULAR=PETSC_FALSE,flg;
18   PetscScalar    v;
19   IS             row,col;
20   MatFactorInfo  info;
21   Vec            x,y,b,ytmp;
22   PetscReal      norm2,tol = 100*PETSC_MACHINE_EPSILON;
23   PetscRandom    rdm;
24   PetscMPIInt    size;
25 
26   PetscFunctionBeginUser;
27   PetscCall(PetscInitialize(&argc,&args,(char*)0,help));
28   PetscCallMPI(MPI_Comm_size(PETSC_COMM_WORLD,&size));
29   PetscCheck(size == 1,PETSC_COMM_WORLD,PETSC_ERR_WRONG_MPI_SIZE,"This is a uniprocessor example only!");
30   PetscCall(PetscOptionsGetInt(NULL,NULL,"-m",&m,NULL));
31   PetscCall(PetscOptionsGetInt(NULL,NULL,"-n",&n,NULL));
32   PetscCall(PetscOptionsGetInt(NULL,NULL,"-lf",&lf,NULL));
33 
34   PetscCall(MatCreate(PETSC_COMM_SELF,&C));
35   PetscCall(MatSetSizes(C,m*n,m*n,m*n,m*n));
36   PetscCall(MatSetFromOptions(C));
37   PetscCall(MatSetUp(C));
38 
39   /* Create matrix C in seqaij format and sC in seqsbaij. (This is five-point stencil with some extra elements) */
40   for (i=0; i<m; i++) {
41     for (j=0; j<n; j++) {
42       v = -1.0;  Ii = j + n*i;
43       J = Ii - n; if (J>=0)  PetscCall(MatSetValues(C,1,&Ii,1,&J,&v,INSERT_VALUES));
44       J = Ii + n; if (J<m*n) PetscCall(MatSetValues(C,1,&Ii,1,&J,&v,INSERT_VALUES));
45       J = Ii - 1; if (J>=0)  PetscCall(MatSetValues(C,1,&Ii,1,&J,&v,INSERT_VALUES));
46       J = Ii + 1; if (J<m*n) PetscCall(MatSetValues(C,1,&Ii,1,&J,&v,INSERT_VALUES));
47       v = 4.0; PetscCall(MatSetValues(C,1,&Ii,1,&Ii,&v,INSERT_VALUES));
48     }
49   }
50   PetscCall(MatAssemblyBegin(C,MAT_FINAL_ASSEMBLY));
51   PetscCall(MatAssemblyEnd(C,MAT_FINAL_ASSEMBLY));
52 
53   PetscCall(MatIsSymmetric(C,0.0,&flg));
54   PetscCheck(flg,PETSC_COMM_SELF,PETSC_ERR_SUP,"C is non-symmetric");
55   PetscCall(MatConvert(C,MATSEQSBAIJ,MAT_INITIAL_MATRIX,&sC));
56 
57   /* Create vectors for error checking */
58   PetscCall(MatCreateVecs(C,&x,&b));
59   PetscCall(VecDuplicate(x,&y));
60   PetscCall(VecDuplicate(x,&ytmp));
61   PetscCall(PetscRandomCreate(PETSC_COMM_SELF,&rdm));
62   PetscCall(PetscRandomSetFromOptions(rdm));
63   PetscCall(VecSetRandom(x,rdm));
64   PetscCall(MatMult(C,x,b));
65 
66   PetscCall(MatGetOrdering(C,MATORDERINGNATURAL,&row,&col));
67 
68   /* Compute CHOLESKY or ICC factor sA */
69   PetscCall(MatFactorInfoInitialize(&info));
70 
71   info.fill          = 1.0;
72   info.diagonal_fill = 0;
73   info.zeropivot     = 0.0;
74 
75   PetscCall(PetscOptionsHasName(NULL,NULL,"-cholesky",&CHOLESKY));
76   if (CHOLESKY) {
77     PetscCall(PetscPrintf(PETSC_COMM_SELF,"Test CHOLESKY...\n"));
78     PetscCall(MatGetFactor(sC,MATSOLVERPETSC,MAT_FACTOR_CHOLESKY,&sA));
79     PetscCall(MatCholeskyFactorSymbolic(sA,sC,row,&info));
80   } else {
81     PetscCall(PetscPrintf(PETSC_COMM_SELF,"Test ICC...\n"));
82     info.levels = lf;
83 
84     PetscCall(MatGetFactor(sC,MATSOLVERPETSC,MAT_FACTOR_ICC,&sA));
85     PetscCall(MatICCFactorSymbolic(sA,sC,row,&info));
86   }
87   PetscCall(MatCholeskyFactorNumeric(sA,sC,&info));
88 
89   /* test MatForwardSolve() and MatBackwardSolve() with matrix reordering on aij matrix C */
90   if (CHOLESKY) {
91     PetscCall(PetscOptionsHasName(NULL,NULL,"-triangular_solve",&TRIANGULAR));
92     if (TRIANGULAR) {
93       PetscCall(PetscPrintf(PETSC_COMM_SELF,"Test MatForwardSolve...\n"));
94       PetscCall(MatForwardSolve(sA,b,ytmp));
95       PetscCall(PetscPrintf(PETSC_COMM_SELF,"Test MatBackwardSolve...\n"));
96       PetscCall(MatBackwardSolve(sA,ytmp,y));
97       PetscCall(VecAXPY(y,-1.0,x));
98       PetscCall(VecNorm(y,NORM_2,&norm2));
99       if (norm2 > tol) {
100         PetscCall(PetscPrintf(PETSC_COMM_SELF,"MatForwardSolve and BackwardSolve: Norm of error=%g\n",(double)norm2));
101       }
102     }
103   }
104 
105   PetscCall(MatSolve(sA,b,y));
106   PetscCall(MatDestroy(&sC));
107   PetscCall(MatDestroy(&sA));
108   PetscCall(VecAXPY(y,-1.0,x));
109   PetscCall(VecNorm(y,NORM_2,&norm2));
110   if (lf == -1 && norm2 > tol) {
111     PetscCall(PetscPrintf(PETSC_COMM_SELF, " reordered SEQAIJ:   Cholesky/ICC levels %" PetscInt_FMT ", residual %g\n",lf,(double)norm2));
112   }
113 
114   /* Free data structures */
115   PetscCall(MatDestroy(&C));
116   PetscCall(ISDestroy(&row));
117   PetscCall(ISDestroy(&col));
118   PetscCall(PetscRandomDestroy(&rdm));
119   PetscCall(VecDestroy(&x));
120   PetscCall(VecDestroy(&y));
121   PetscCall(VecDestroy(&ytmp));
122   PetscCall(VecDestroy(&b));
123   PetscCall(PetscFinalize());
124   return 0;
125 }
126 
127 /*TEST
128 
129    test:
130       output_file: output/ex128.out
131 
132    test:
133       suffix: 2
134       args: -cholesky -triangular_solve
135 
136 TEST*/
137