xref: /petsc/src/mat/tests/ex62.c (revision 4e8afd12df985612b40e26aef947da2f566aee4e)
1 
2 static char help[] = "Test Matrix products for AIJ matrices\n\
3 Input arguments are:\n\
4   -fA <input_file> -fB <input_file> -fC <input_file>: file to load\n\n";
5 /* Example of usage:
6    ./ex62 -fA <A_binary> -fB <B_binary>
7    mpiexec -n 3 ./ex62 -fA medium -fB medium
8 */
9 
10 #include <petscmat.h>
11 
12 /*
13      B = A - B
14      norm = norm(B)
15 */
16 PetscErrorCode MatNormDifference(Mat A,Mat B,PetscReal *norm)
17 {
18   PetscErrorCode ierr;
19 
20   PetscFunctionBegin;
21   ierr = MatAXPY(B,-1.0,A,DIFFERENT_NONZERO_PATTERN);CHKERRQ(ierr);
22   ierr = MatNorm(B,NORM_FROBENIUS,norm);CHKERRQ(ierr);
23   PetscFunctionReturn(0);
24 }
25 
26 int main(int argc,char **args)
27 {
28   Mat            A,A_save,B,C,P,C1,R;
29   PetscViewer    viewer;
30   PetscErrorCode ierr;
31   PetscMPIInt    size,rank;
32   PetscInt       i,j,*idxn,M,N,nzp,PN,rstart,rend;
33   PetscReal      norm;
34   PetscRandom    rdm;
35   char           file[2][128];
36   PetscScalar    *a,rval,alpha;
37   PetscBool      Test_MatMatMult=PETSC_TRUE,Test_MatTrMat=PETSC_TRUE,Test_MatMatTr=PETSC_TRUE;
38   PetscBool      Test_MatPtAP=PETSC_TRUE,Test_MatRARt=PETSC_TRUE,flg,seqaij;
39   MatInfo        info;
40   MatType        mattype;
41 
42   ierr = PetscInitialize(&argc,&args,(char*)0,help);if (ierr) return ierr;
43   ierr = MPI_Comm_size(PETSC_COMM_WORLD,&size);CHKERRQ(ierr);
44   ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
45 
46   /*  Load the matrices A_save and B */
47   ierr = PetscOptionsGetString(NULL,NULL,"-fA",file[0],sizeof(file[0]),&flg);CHKERRQ(ierr);
48   if (!flg) SETERRQ(PETSC_COMM_WORLD,1,"Must indicate a file name for small matrix A with the -fA option.");
49   ierr = PetscOptionsGetString(NULL,NULL,"-fB",file[1],sizeof(file[1]),&flg);CHKERRQ(ierr);
50   if (!flg) SETERRQ(PETSC_COMM_WORLD,1,"Must indicate a file name for small matrix B with the -fB option.");
51 
52   ierr = PetscViewerBinaryOpen(PETSC_COMM_WORLD,file[0],FILE_MODE_READ,&viewer);CHKERRQ(ierr);
53   ierr = MatCreate(PETSC_COMM_WORLD,&A_save);CHKERRQ(ierr);
54   ierr = MatSetFromOptions(A_save);CHKERRQ(ierr);
55   ierr = MatLoad(A_save,viewer);CHKERRQ(ierr);
56   ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
57 
58   ierr = PetscViewerBinaryOpen(PETSC_COMM_WORLD,file[1],FILE_MODE_READ,&viewer);CHKERRQ(ierr);
59   ierr = MatCreate(PETSC_COMM_WORLD,&B);CHKERRQ(ierr);
60   ierr = MatSetFromOptions(B);CHKERRQ(ierr);
61   ierr = MatLoad(B,viewer);CHKERRQ(ierr);
62   ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
63 
64   ierr = MatGetType(B,&mattype);CHKERRQ(ierr);
65 
66   ierr = MatGetSize(B,&M,&N);CHKERRQ(ierr);
67   nzp  = PetscMax((PetscInt)(0.1*M),5);
68   ierr = PetscMalloc((nzp+1)*(sizeof(PetscInt)+sizeof(PetscScalar)),&idxn);CHKERRQ(ierr);
69   a    = (PetscScalar*)(idxn + nzp);
70 
71   ierr = PetscRandomCreate(PETSC_COMM_WORLD,&rdm);CHKERRQ(ierr);
72   ierr = PetscRandomSetFromOptions(rdm);CHKERRQ(ierr);
73 
74   /* 1) MatMatMult() */
75   /* ----------------*/
76   if (Test_MatMatMult) {
77     ierr = MatDuplicate(A_save,MAT_COPY_VALUES,&A);CHKERRQ(ierr);
78 
79     /* (1.1) Test developer API */
80     ierr = MatProductCreate(A,B,NULL,&C);CHKERRQ(ierr);
81     ierr = MatProductSetType(C,MATPRODUCT_AB);CHKERRQ(ierr);
82     ierr = MatProductSetAlgorithm(C,"default");CHKERRQ(ierr);
83     ierr = MatProductSetFill(C,PETSC_DEFAULT);CHKERRQ(ierr);
84     ierr = MatProductSetFromOptions(C);CHKERRQ(ierr);
85     ierr = MatProductSymbolic(C);CHKERRQ(ierr);
86     ierr = MatProductNumeric(C);CHKERRQ(ierr);
87 
88     /* Test reuse symbolic C */
89     alpha = 0.9;
90     ierr = MatScale(A,alpha);CHKERRQ(ierr);
91     ierr = MatProductNumeric(C);CHKERRQ(ierr);
92 
93     ierr = MatMatMultEqual(A,B,C,10,&flg);CHKERRQ(ierr);
94     if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_PLIB,"Error in C=A*B");
95     ierr = MatDestroy(&C);CHKERRQ(ierr);
96 
97     /* (1.2) Test user driver */
98     ierr = MatMatMult(A,B,MAT_INITIAL_MATRIX,PETSC_DEFAULT,&C);CHKERRQ(ierr);
99 
100     /* Test MAT_REUSE_MATRIX - reuse symbolic C */
101     alpha = 1.0;
102     for (i=0; i<2; i++) {
103       alpha -= 0.1;
104       ierr   = MatScale(A,alpha);CHKERRQ(ierr);
105       ierr   = MatMatMult(A,B,MAT_REUSE_MATRIX,PETSC_DEFAULT,&C);CHKERRQ(ierr);
106     }
107     ierr = MatMatMultEqual(A,B,C,10,&flg);CHKERRQ(ierr);
108     if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_PLIB,"Error: MatMatMult()");
109     ierr = MatDestroy(&A);CHKERRQ(ierr);
110 
111     /* Test MatProductClear() */
112     ierr = MatProductClear(C);CHKERRQ(ierr);
113     ierr = MatDestroy(&C);CHKERRQ(ierr);
114 
115     /* Test MatMatMult() for dense and aij matrices */
116     ierr = MatConvert(A_save,MATDENSE,MAT_INITIAL_MATRIX,&A);CHKERRQ(ierr);
117     ierr = MatMatMult(A,B,MAT_INITIAL_MATRIX,PETSC_DEFAULT,&C);CHKERRQ(ierr);
118     ierr = MatDestroy(&C);CHKERRQ(ierr);
119     ierr = MatDestroy(&A);CHKERRQ(ierr);
120 
121   }
122 
123   /* Create P and R = P^T  */
124   /* --------------------- */
125   PN   = M/2;
126   nzp  = 5; /* num of nonzeros in each row of P */
127   ierr = MatCreate(PETSC_COMM_WORLD,&P);CHKERRQ(ierr);
128   ierr = MatSetSizes(P,PETSC_DECIDE,PETSC_DECIDE,M,PN);CHKERRQ(ierr);
129   ierr = MatSetType(P,mattype);CHKERRQ(ierr);
130   ierr = MatSeqAIJSetPreallocation(P,nzp,NULL);CHKERRQ(ierr);
131   ierr = MatMPIAIJSetPreallocation(P,nzp,NULL,nzp,NULL);CHKERRQ(ierr);
132   ierr = MatGetOwnershipRange(P,&rstart,&rend);CHKERRQ(ierr);
133   for (i=0; i<nzp; i++) {
134     ierr = PetscRandomGetValue(rdm,&a[i]);CHKERRQ(ierr);
135   }
136   for (i=rstart; i<rend; i++) {
137     for (j=0; j<nzp; j++) {
138       ierr    = PetscRandomGetValue(rdm,&rval);CHKERRQ(ierr);
139       idxn[j] = (PetscInt)(PetscRealPart(rval)*PN);
140     }
141     ierr = MatSetValues(P,1,&i,nzp,idxn,a,ADD_VALUES);CHKERRQ(ierr);
142   }
143   ierr = MatAssemblyBegin(P,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
144   ierr = MatAssemblyEnd(P,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
145 
146   ierr = MatTranspose(P,MAT_INITIAL_MATRIX,&R);CHKERRQ(ierr);
147 
148   /* 2) MatTransposeMatMult() */
149   /* ------------------------ */
150   if (Test_MatTrMat) {
151     /* (2.1) Test developer driver C = P^T*B */
152     ierr = MatProductCreate(P,B,NULL,&C);CHKERRQ(ierr);
153     ierr = MatProductSetType(C,MATPRODUCT_AtB);CHKERRQ(ierr);
154     ierr = MatProductSetAlgorithm(C,"default");CHKERRQ(ierr);
155     ierr = MatProductSetFill(C,PETSC_DEFAULT);CHKERRQ(ierr);
156     ierr = MatProductSetFromOptions(C);CHKERRQ(ierr);
157     ierr = MatProductSymbolic(C);CHKERRQ(ierr); /* equivalent to MatSetUp() */
158     ierr = MatSetOption(C,MAT_USE_INODES,PETSC_FALSE);CHKERRQ(ierr); /* illustrate how to call MatSetOption() */
159     ierr = MatProductNumeric(C);CHKERRQ(ierr);
160     ierr = MatProductNumeric(C);CHKERRQ(ierr);
161     ierr = MatTransposeMatMultEqual(P,B,C,10,&flg);CHKERRQ(ierr);
162     if (!flg) SETERRQ(PETSC_COMM_WORLD,PETSC_ERR_PLIB,"Error: developer driver C = P^T*B");
163     ierr = MatDestroy(&C);CHKERRQ(ierr);
164 
165     /* (2.2) Test user driver C = P^T*B */
166     ierr = MatTransposeMatMult(P,B,MAT_INITIAL_MATRIX,PETSC_DEFAULT,&C);CHKERRQ(ierr);
167     ierr = MatTransposeMatMult(P,B,MAT_REUSE_MATRIX,PETSC_DEFAULT,&C);CHKERRQ(ierr);
168     ierr = MatGetInfo(C,MAT_GLOBAL_SUM,&info);CHKERRQ(ierr);
169     ierr = MatFreeIntermediateDataStructures(C);CHKERRQ(ierr);
170 
171     /* Compare P^T*B and R*B */
172     ierr = MatMatMult(R,B,MAT_INITIAL_MATRIX,PETSC_DEFAULT,&C1);CHKERRQ(ierr);
173     ierr = MatNormDifference(C,C1,&norm);CHKERRQ(ierr);
174     if (norm > PETSC_SMALL) SETERRQ1(PETSC_COMM_WORLD,PETSC_ERR_PLIB,"Error in MatTransposeMatMult(): %g",(double)norm);
175     ierr = MatDestroy(&C1);CHKERRQ(ierr);
176 
177     /* Test MatDuplicate() of C=P^T*B */
178     ierr = MatDuplicate(C,MAT_COPY_VALUES,&C1);CHKERRQ(ierr);
179     ierr = MatDestroy(&C1);CHKERRQ(ierr);
180     ierr = MatDestroy(&C);CHKERRQ(ierr);
181   }
182 
183   /* 3) MatTransposeMatMult() */
184   /* ------------------------ */
185   if (Test_MatMatTr) {
186     /* C = B*R^T */
187     ierr = PetscObjectTypeCompare((PetscObject)B,MATSEQAIJ,&seqaij);CHKERRQ(ierr);
188     if (size == 1 && seqaij) {
189       ierr = MatMatTransposeMult(B,R,MAT_INITIAL_MATRIX,PETSC_DEFAULT,&C);CHKERRQ(ierr);
190       ierr = MatSetOptionsPrefix(C,"matmatmulttr_");CHKERRQ(ierr); /* enable '-matmatmulttr_' for matrix C */
191       ierr = MatGetInfo(C,MAT_GLOBAL_SUM,&info);CHKERRQ(ierr);
192 
193       /* Test MAT_REUSE_MATRIX - reuse symbolic C */
194       ierr = MatMatTransposeMult(B,R,MAT_REUSE_MATRIX,PETSC_DEFAULT,&C);CHKERRQ(ierr);
195 
196       /* Check */
197       ierr = MatMatMult(B,P,MAT_INITIAL_MATRIX,PETSC_DEFAULT,&C1);CHKERRQ(ierr);
198       ierr = MatNormDifference(C,C1,&norm);CHKERRQ(ierr);
199       if (norm > PETSC_SMALL) SETERRQ1(PETSC_COMM_WORLD,PETSC_ERR_PLIB,"Error in MatMatTransposeMult() %g",(double)norm);
200       ierr = MatDestroy(&C1);CHKERRQ(ierr);
201       ierr = MatDestroy(&C);CHKERRQ(ierr);
202     }
203   }
204 
205   /* 4) Test MatPtAP() */
206   /*-------------------*/
207   if (Test_MatPtAP) {
208     ierr = MatDuplicate(A_save,MAT_COPY_VALUES,&A);CHKERRQ(ierr);
209 
210     /* (4.1) Test developer API */
211     ierr = MatProductCreate(A,P,NULL,&C);CHKERRQ(ierr);
212     ierr = MatProductSetType(C,MATPRODUCT_PtAP);CHKERRQ(ierr);
213     ierr = MatProductSetAlgorithm(C,"default");CHKERRQ(ierr);
214     ierr = MatProductSetFill(C,PETSC_DEFAULT);CHKERRQ(ierr);
215     ierr = MatProductSetFromOptions(C);CHKERRQ(ierr);
216     ierr = MatProductSymbolic(C);CHKERRQ(ierr);
217     ierr = MatProductNumeric(C);CHKERRQ(ierr);
218     ierr = MatProductNumeric(C);CHKERRQ(ierr); /* reuse symbolic C */
219 
220     ierr = MatPtAPMultEqual(A,P,C,10,&flg);CHKERRQ(ierr);
221     if (!flg) SETERRQ(PETSC_COMM_WORLD,PETSC_ERR_PLIB,"Error in MatProduct_PtAP");
222     ierr = MatDestroy(&C);CHKERRQ(ierr);
223 
224     /* (4.2) Test user driver */
225     ierr = MatPtAP(A,P,MAT_INITIAL_MATRIX,PETSC_DEFAULT,&C);CHKERRQ(ierr);
226 
227     /* Test MAT_REUSE_MATRIX - reuse symbolic C */
228     alpha=1.0;
229     for (i=0; i<2; i++) {
230       alpha -= 0.1;
231       ierr   = MatScale(A,alpha);CHKERRQ(ierr);
232       ierr   = MatPtAP(A,P,MAT_REUSE_MATRIX,PETSC_DEFAULT,&C);CHKERRQ(ierr);
233     }
234 
235     ierr = MatPtAPMultEqual(A,P,C,10,&flg);CHKERRQ(ierr);
236     if (!flg) SETERRQ(PETSC_COMM_WORLD,PETSC_ERR_PLIB,"Error in MatPtAP");
237 
238     /* 5) Test MatRARt() */
239     /* ----------------- */
240     if (Test_MatRARt) {
241       Mat RARt;
242       ierr = MatTranspose(P,MAT_REUSE_MATRIX,&R);CHKERRQ(ierr);
243       ierr = MatRARt(A,R,MAT_INITIAL_MATRIX,2.0,&RARt);CHKERRQ(ierr);
244       ierr = MatRARt(A,R,MAT_REUSE_MATRIX,2.0,&RARt);CHKERRQ(ierr);
245       ierr = MatNormDifference(C,RARt,&norm);CHKERRQ(ierr);
246       if (norm > PETSC_SMALL) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_PLIB,"|PtAP - RARt| = %g",(double)norm);
247       ierr = MatDestroy(&RARt);CHKERRQ(ierr);
248     }
249 
250     ierr = MatDestroy(&A);CHKERRQ(ierr);
251     ierr = MatDestroy(&C);CHKERRQ(ierr);
252   }
253 
254   /* Destroy objects */
255   ierr = PetscRandomDestroy(&rdm);CHKERRQ(ierr);
256   ierr = PetscFree(idxn);CHKERRQ(ierr);
257 
258   ierr = MatDestroy(&A_save);CHKERRQ(ierr);
259   ierr = MatDestroy(&B);CHKERRQ(ierr);
260   ierr = MatDestroy(&P);CHKERRQ(ierr);
261   ierr = MatDestroy(&R);CHKERRQ(ierr);
262 
263   PetscFinalize();
264   return ierr;
265 }
266 
267 /*TEST
268    test:
269      suffix: 1
270      requires: datafilespath !complex double !define(PETSC_USE_64BIT_INDICES)
271      args: -fA ${DATAFILESPATH}/matrices/medium -fB ${DATAFILESPATH}/matrices/medium
272      output_file: output/ex62_1.out
273 
274    test:
275      suffix: 2_ab_scalable
276      requires: datafilespath !complex double !define(PETSC_USE_64BIT_INDICES)
277      args: -fA ${DATAFILESPATH}/matrices/medium -fB ${DATAFILESPATH}/matrices/medium -matproduct_ab_via scalable -matmatmult_via scalable -matproduct_atb_via outerproduct -mattransposematmult_via outerproduct
278      output_file: output/ex62_1.out
279 
280    test:
281      suffix: 3_ab_scalable_fast
282      requires: datafilespath !complex double !define(PETSC_USE_64BIT_INDICES)
283      args: -fA ${DATAFILESPATH}/matrices/medium -fB ${DATAFILESPATH}/matrices/medium -matproduct_ab_via scalable_fast -matmatmult_via scalable_fast -matmattransmult_via color
284      output_file: output/ex62_1.out
285 
286    test:
287      suffix: 4_ab_heap
288      requires: datafilespath !complex double !define(PETSC_USE_64BIT_INDICES)
289      args: -fA ${DATAFILESPATH}/matrices/medium -fB ${DATAFILESPATH}/matrices/medium -matproduct_ab_via heap -matmatmult_via heap -matproduct_ptap_via rap -matptap_via rap
290      output_file: output/ex62_1.out
291 
292    test:
293      suffix: 5_ab_btheap
294      requires: datafilespath !complex double !define(PETSC_USE_64BIT_INDICES)
295      args: -fA ${DATAFILESPATH}/matrices/medium -fB ${DATAFILESPATH}/matrices/medium -matproduct_ab_via btheap -matmatmult_via btheap -matrart_via r*art
296      output_file: output/ex62_1.out
297 
298    test:
299      suffix: 6_ab_llcondensed
300      requires: datafilespath !complex double !define(PETSC_USE_64BIT_INDICES)
301      args: -fA ${DATAFILESPATH}/matrices/medium -fB ${DATAFILESPATH}/matrices/medium -matproduct_ab_via llcondensed -matmatmult_via llcondensed -matrart_via coloring_rart
302      output_file: output/ex62_1.out
303 
304    test:
305      suffix: 7_ab_rowmerge
306      requires: datafilespath !complex double !define(PETSC_USE_64BIT_INDICES)
307      args: -fA ${DATAFILESPATH}/matrices/medium -fB ${DATAFILESPATH}/matrices/medium -matproduct_ab_via rowmerge -matmatmult_via rowmerge
308      output_file: output/ex62_1.out
309 
310    test:
311      suffix: 8_ab_hypre
312      requires: hypre datafilespath !complex double !define(PETSC_USE_64BIT_INDICES)
313      args: -fA ${DATAFILESPATH}/matrices/medium -fB ${DATAFILESPATH}/matrices/medium -matproduct_ab_via hypre -matmatmult_via hypre -matproduct_ptap_via hypre -matptap_via hypre
314      output_file: output/ex62_1.out
315 
316    test:
317      suffix: 10
318      requires: datafilespath !complex double !define(PETSC_USE_64BIT_INDICES)
319      nsize: 3
320      args: -fA ${DATAFILESPATH}/matrices/medium -fB ${DATAFILESPATH}/matrices/medium
321      output_file: output/ex62_1.out
322 
323    test:
324      suffix: 11_ab_scalable
325      requires: datafilespath !complex double !define(PETSC_USE_64BIT_INDICES)
326      nsize: 3
327      args: -fA ${DATAFILESPATH}/matrices/medium -fB ${DATAFILESPATH}/matrices/medium -matproduct_ab_via scalable -matmatmult_via scalable -matproduct_atb_via scalable -mattransposematmult_via scalable
328      output_file: output/ex62_1.out
329 
330    test:
331      suffix: 12_ab_seqmpi
332      requires: datafilespath !complex double !define(PETSC_USE_64BIT_INDICES)
333      nsize: 3
334      args: -fA ${DATAFILESPATH}/matrices/medium -fB ${DATAFILESPATH}/matrices/medium -matproduct_ab_via seqmpi -matmatmult_via seqmpi -matproduct_atb_via at*b -mattransposematmult_via at*b
335      output_file: output/ex62_1.out
336 
337    test:
338      suffix: 13_ab_hypre
339      requires: hypre datafilespath !complex double !define(PETSC_USE_64BIT_INDICES)
340      nsize: 3
341      args: -fA ${DATAFILESPATH}/matrices/medium -fB ${DATAFILESPATH}/matrices/medium -matproduct_ab_via hypre -matmatmult_via hypre -matproduct_ptap_via hypre -matptap_via hypre
342      output_file: output/ex62_1.out
343 
344 TEST*/
345