xref: /petsc/src/mat/tests/ex109.c (revision ffa8c5705e8ab2cf85ee1d14dbe507a6e2eb5283)
1 static char help[] = "Test MatMatMult() for AIJ and Dense matrices.\n\n";
2 
3 #include <petscmat.h>
4 
5 int main(int argc,char **argv)
6 {
7   Mat            A,B,C,D,AT;
8   PetscInt       i,M,N,Istart,Iend,n=7,j,J,Ii,m=8,am,an;
9   PetscScalar    v;
10   PetscRandom    r;
11   PetscBool      equal=PETSC_FALSE,flg;
12   PetscReal      fill = 1.0,norm;
13   PetscMPIInt    size;
14 
15   PetscCall(PetscInitialize(&argc,&argv,(char*)0,help));
16   PetscCall(PetscOptionsGetInt(NULL,NULL,"-m",&m,NULL));
17   PetscCall(PetscOptionsGetInt(NULL,NULL,"-n",&n,NULL));
18   PetscCall(PetscOptionsGetReal(NULL,NULL,"-fill",&fill,NULL));
19 
20   PetscCall(PetscRandomCreate(PETSC_COMM_WORLD,&r));
21   PetscCall(PetscRandomSetFromOptions(r));
22 
23   /* Create a aij matrix A */
24   M    = N = m*n;
25   PetscCall(MatCreate(PETSC_COMM_WORLD,&A));
26   PetscCall(MatSetSizes(A,PETSC_DECIDE,PETSC_DECIDE,M,N));
27   PetscCall(MatSetType(A,MATAIJ));
28   PetscCall(MatSetFromOptions(A));
29   PetscCall(MatMPIAIJSetPreallocation(A,5,NULL,5,NULL));
30   PetscCall(MatSeqAIJSetPreallocation(A,5,NULL));
31 
32   PetscCall(MatGetOwnershipRange(A,&Istart,&Iend));
33   am   = Iend - Istart;
34   for (Ii=Istart; Ii<Iend; Ii++) {
35     v = -1.0; i = Ii/n; j = Ii - i*n;
36     if (i>0)   {J = Ii - n; PetscCall(MatSetValues(A,1,&Ii,1,&J,&v,INSERT_VALUES));}
37     if (i<m-1) {J = Ii + n; PetscCall(MatSetValues(A,1,&Ii,1,&J,&v,INSERT_VALUES));}
38     if (j>0)   {J = Ii - 1; PetscCall(MatSetValues(A,1,&Ii,1,&J,&v,INSERT_VALUES));}
39     if (j<n-1) {J = Ii + 1; PetscCall(MatSetValues(A,1,&Ii,1,&J,&v,INSERT_VALUES));}
40     v = 4.0; PetscCall(MatSetValues(A,1,&Ii,1,&Ii,&v,INSERT_VALUES));
41   }
42   PetscCall(MatAssemblyBegin(A,MAT_FINAL_ASSEMBLY));
43   PetscCall(MatAssemblyEnd(A,MAT_FINAL_ASSEMBLY));
44 
45   /* Create a dense matrix B */
46   PetscCall(MatGetLocalSize(A,&am,&an));
47   PetscCall(MatCreate(PETSC_COMM_WORLD,&B));
48   PetscCall(MatSetSizes(B,an,PETSC_DECIDE,PETSC_DECIDE,M));
49   PetscCall(MatSetType(B,MATDENSE));
50   PetscCall(MatSeqDenseSetPreallocation(B,NULL));
51   PetscCall(MatMPIDenseSetPreallocation(B,NULL));
52   PetscCall(MatSetFromOptions(B));
53   PetscCall(MatSetRandom(B,r));
54   PetscCall(PetscRandomDestroy(&r));
55   PetscCall(MatAssemblyBegin(B,MAT_FINAL_ASSEMBLY));
56   PetscCall(MatAssemblyEnd(B,MAT_FINAL_ASSEMBLY));
57 
58   /* Test reuse of user-provided dense C (unassembled) -- not recommended usage */
59   PetscCall(MatCreate(PETSC_COMM_WORLD,&C));
60   PetscCall(MatSetType(C,MATDENSE));
61   PetscCall(MatSetSizes(C,am,PETSC_DECIDE,PETSC_DECIDE,N));
62   PetscCall(MatSetFromOptions(C));
63   PetscCall(MatSetUp(C));
64   PetscCall(MatZeroEntries(C));
65   PetscCall(MatMatMult(A,B,MAT_REUSE_MATRIX,fill,&C));
66   PetscCall(MatNorm(C,NORM_INFINITY,&norm));
67   PetscCall(MatDestroy(&C));
68 
69   /* Test C = A*B (aij*dense) */
70   PetscCall(MatMatMult(A,B,MAT_INITIAL_MATRIX,fill,&C));
71   PetscCall(MatMatMult(A,B,MAT_REUSE_MATRIX,fill,&C));
72 
73   /* Test developer API */
74   PetscCall(MatProductCreate(A,B,NULL,&D));
75   PetscCall(MatProductSetType(D,MATPRODUCT_AB));
76   PetscCall(MatProductSetAlgorithm(D,"default"));
77   PetscCall(MatProductSetFill(D,fill));
78   PetscCall(MatProductSetFromOptions(D));
79   PetscCall(MatProductSymbolic(D));
80   for (i=0; i<2; i++) {
81     PetscCall(MatProductNumeric(D));
82   }
83   PetscCall(MatEqual(C,D,&equal));
84   PetscCheck(equal,PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"C != D");
85   PetscCall(MatDestroy(&D));
86 
87   /* Test D = AT*B (transpose(aij)*dense) */
88   PetscCall(MatCreateTranspose(A,&AT));
89   PetscCall(MatMatMult(AT,B,MAT_INITIAL_MATRIX,fill,&D));
90   PetscCall(MatMatMultEqual(AT,B,D,10,&equal));
91   PetscCheck(equal,PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"D != AT*B (transpose(aij)*dense)");
92   PetscCall(MatDestroy(&D));
93   PetscCall(MatDestroy(&AT));
94 
95   /* Test D = C*A (dense*aij) */
96   PetscCall(MatMatMult(C,A,MAT_INITIAL_MATRIX,fill,&D));
97   PetscCall(MatMatMult(C,A,MAT_REUSE_MATRIX,fill,&D));
98   PetscCall(MatMatMultEqual(C,A,D,10,&equal));
99   PetscCheck(equal,PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"D != C*A (dense*aij)");
100   PetscCall(MatDestroy(&D));
101 
102   /* Test D = A*C (aij*dense) */
103   PetscCall(MatMatMult(A,C,MAT_INITIAL_MATRIX,fill,&D));
104   PetscCall(MatMatMult(A,C,MAT_REUSE_MATRIX,fill,&D));
105   PetscCall(MatMatMultEqual(A,C,D,10,&equal));
106   PetscCheck(equal,PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"D != A*C (aij*dense)");
107   PetscCall(MatDestroy(&D));
108 
109   /* Test D = B*C (dense*dense) */
110   PetscCallMPI(MPI_Comm_size(PETSC_COMM_WORLD,&size));
111   if (size == 1) {
112     PetscCall(MatMatMult(B,C,MAT_INITIAL_MATRIX,fill,&D));
113     PetscCall(MatMatMult(B,C,MAT_REUSE_MATRIX,fill,&D));
114     PetscCall(MatMatMultEqual(B,C,D,10,&equal));
115     PetscCheck(equal,PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"D != B*C (dense*dense)");
116     PetscCall(MatDestroy(&D));
117   }
118 
119   /* Test D = B*C^T (dense*dense) */
120   PetscCall(MatMatTransposeMult(B,C,MAT_INITIAL_MATRIX,fill,&D));
121   PetscCall(MatMatTransposeMult(B,C,MAT_REUSE_MATRIX,fill,&D));
122   PetscCall(MatMatTransposeMultEqual(B,C,D,10,&equal));
123   PetscCheck(equal,PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"D != B*C^T (dense*dense)");
124   PetscCall(MatDestroy(&D));
125 
126   /* Test MatProductCreateWithMat() and reuse C and B for B = A*C */
127   flg = PETSC_FALSE;
128   PetscCall(PetscOptionsHasName(NULL,NULL,"-test_userAPI",&flg));
129   if (flg) {
130     /* user driver */
131     PetscCall(MatMatMult(A,C,MAT_REUSE_MATRIX,fill,&B));
132   } else {
133     /* clear internal data structures related with previous products to avoid circular references */
134     PetscCall(MatProductClear(A));
135     PetscCall(MatProductClear(B));
136     PetscCall(MatProductClear(C));
137     PetscCall(MatProductCreateWithMat(A,C,NULL,B));
138     PetscCall(MatProductSetType(B,MATPRODUCT_AB));
139     PetscCall(MatProductSetFromOptions(B));
140     PetscCall(MatProductSymbolic(B));
141     PetscCall(MatProductNumeric(B));
142   }
143 
144   PetscCall(MatDestroy(&C));
145   PetscCall(MatDestroy(&B));
146   PetscCall(MatDestroy(&A));
147   PetscCall(PetscFinalize());
148   return 0;
149 }
150 
151 /*TEST
152 
153    test:
154       args: -M 10 -N 10
155       output_file: output/ex109.out
156 
157    test:
158       suffix: 2
159       nsize: 3
160       output_file: output/ex109.out
161 
162    test:
163       suffix: 3
164       nsize: 2
165       args: -matmattransmult_mpidense_mpidense_via cyclic
166       output_file: output/ex109.out
167 
168    test:
169       suffix: 4
170       args: -test_userAPI
171       output_file: output/ex109.out
172 
173    test:
174       suffix: 5
175       nsize: 3
176       args: -test_userAPI
177       output_file: output/ex109.out
178 
179 TEST*/
180