xref: /petsc/src/mat/tests/ex62.c (revision cdb0f33d09c128f365fdb48a6f07c56e211b6a43) !
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 = MatSetOptionsPrefix(C,"AB_");CHKERRQ(ierr);
82     ierr = MatProductSetType(C,MATPRODUCT_AB);CHKERRQ(ierr);
83     ierr = MatProductSetAlgorithm(C,"default");CHKERRQ(ierr);
84     ierr = MatProductSetFill(C,PETSC_DEFAULT);CHKERRQ(ierr);
85     ierr = MatProductSetFromOptions(C);CHKERRQ(ierr);
86     ierr = MatProductSymbolic(C);CHKERRQ(ierr);
87     ierr = MatProductNumeric(C);CHKERRQ(ierr);
88 
89     /* Test reuse symbolic C */
90     alpha = 0.9;
91     ierr = MatScale(A,alpha);CHKERRQ(ierr);
92     ierr = MatProductNumeric(C);CHKERRQ(ierr);
93 
94     ierr = MatMatMultEqual(A,B,C,10,&flg);CHKERRQ(ierr);
95     if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_PLIB,"Error in C=A*B");
96     ierr = MatDestroy(&C);CHKERRQ(ierr);
97 
98     /* (1.2) Test user driver */
99     ierr = MatMatMult(A,B,MAT_INITIAL_MATRIX,PETSC_DEFAULT,&C);CHKERRQ(ierr);
100 
101     /* Test MAT_REUSE_MATRIX - reuse symbolic C */
102     alpha = 1.0;
103     for (i=0; i<2; i++) {
104       alpha -= 0.1;
105       ierr   = MatScale(A,alpha);CHKERRQ(ierr);
106       ierr   = MatMatMult(A,B,MAT_REUSE_MATRIX,PETSC_DEFAULT,&C);CHKERRQ(ierr);
107     }
108     ierr = MatMatMultEqual(A,B,C,10,&flg);CHKERRQ(ierr);
109     if (!flg) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_PLIB,"Error: MatMatMult()");
110     ierr = MatDestroy(&A);CHKERRQ(ierr);
111 
112     /* Test MatProductClear() */
113     ierr = MatProductClear(C);CHKERRQ(ierr);
114     ierr = MatDestroy(&C);CHKERRQ(ierr);
115 
116     /* Test MatMatMult() for dense and aij matrices */
117     ierr = MatConvert(A_save,MATDENSE,MAT_INITIAL_MATRIX,&A);CHKERRQ(ierr);
118     ierr = MatMatMult(A,B,MAT_INITIAL_MATRIX,PETSC_DEFAULT,&C);CHKERRQ(ierr);
119     ierr = MatDestroy(&C);CHKERRQ(ierr);
120     ierr = MatDestroy(&A);CHKERRQ(ierr);
121 
122   }
123 
124   /* Create P and R = P^T  */
125   /* --------------------- */
126   PN   = M/2;
127   nzp  = 5; /* num of nonzeros in each row of P */
128   ierr = MatCreate(PETSC_COMM_WORLD,&P);CHKERRQ(ierr);
129   ierr = MatSetSizes(P,PETSC_DECIDE,PETSC_DECIDE,M,PN);CHKERRQ(ierr);
130   ierr = MatSetType(P,mattype);CHKERRQ(ierr);
131   ierr = MatSeqAIJSetPreallocation(P,nzp,NULL);CHKERRQ(ierr);
132   ierr = MatMPIAIJSetPreallocation(P,nzp,NULL,nzp,NULL);CHKERRQ(ierr);
133   ierr = MatGetOwnershipRange(P,&rstart,&rend);CHKERRQ(ierr);
134   for (i=0; i<nzp; i++) {
135     ierr = PetscRandomGetValue(rdm,&a[i]);CHKERRQ(ierr);
136   }
137   for (i=rstart; i<rend; i++) {
138     for (j=0; j<nzp; j++) {
139       ierr    = PetscRandomGetValue(rdm,&rval);CHKERRQ(ierr);
140       idxn[j] = (PetscInt)(PetscRealPart(rval)*PN);
141     }
142     ierr = MatSetValues(P,1,&i,nzp,idxn,a,ADD_VALUES);CHKERRQ(ierr);
143   }
144   ierr = MatAssemblyBegin(P,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
145   ierr = MatAssemblyEnd(P,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
146 
147   ierr = MatTranspose(P,MAT_INITIAL_MATRIX,&R);CHKERRQ(ierr);
148 
149   /* 2) MatTransposeMatMult() */
150   /* ------------------------ */
151   if (Test_MatTrMat) {
152     /* (2.1) Test developer driver C = P^T*B */
153     ierr = MatProductCreate(P,B,NULL,&C);CHKERRQ(ierr);
154     ierr = MatSetOptionsPrefix(C,"AtB_");CHKERRQ(ierr);
155     ierr = MatProductSetType(C,MATPRODUCT_AtB);CHKERRQ(ierr);
156     ierr = MatProductSetAlgorithm(C,"default");CHKERRQ(ierr);
157     ierr = MatProductSetFill(C,PETSC_DEFAULT);CHKERRQ(ierr);
158     ierr = MatProductSetFromOptions(C);CHKERRQ(ierr);
159     ierr = MatProductSymbolic(C);CHKERRQ(ierr); /* equivalent to MatSetUp() */
160     ierr = MatSetOption(C,MAT_USE_INODES,PETSC_FALSE);CHKERRQ(ierr); /* illustrate how to call MatSetOption() */
161     ierr = MatProductNumeric(C);CHKERRQ(ierr);
162     ierr = MatProductNumeric(C);CHKERRQ(ierr); /* test reuse symbolic C */
163 
164     ierr = MatTransposeMatMultEqual(P,B,C,10,&flg);CHKERRQ(ierr);
165     if (!flg) SETERRQ(PETSC_COMM_WORLD,PETSC_ERR_PLIB,"Error: developer driver C = P^T*B");
166     ierr = MatDestroy(&C);CHKERRQ(ierr);
167 
168     /* (2.2) Test user driver C = P^T*B */
169     ierr = MatTransposeMatMult(P,B,MAT_INITIAL_MATRIX,PETSC_DEFAULT,&C);CHKERRQ(ierr);
170     ierr = MatTransposeMatMult(P,B,MAT_REUSE_MATRIX,PETSC_DEFAULT,&C);CHKERRQ(ierr);
171     ierr = MatGetInfo(C,MAT_GLOBAL_SUM,&info);CHKERRQ(ierr);
172     ierr = MatFreeIntermediateDataStructures(C);CHKERRQ(ierr);
173 
174     /* Compare P^T*B and R*B */
175     ierr = MatMatMult(R,B,MAT_INITIAL_MATRIX,PETSC_DEFAULT,&C1);CHKERRQ(ierr);
176     ierr = MatNormDifference(C,C1,&norm);CHKERRQ(ierr);
177     if (norm > PETSC_SMALL) SETERRQ1(PETSC_COMM_WORLD,PETSC_ERR_PLIB,"Error in MatTransposeMatMult(): %g",(double)norm);
178     ierr = MatDestroy(&C1);CHKERRQ(ierr);
179 
180     /* Test MatDuplicate() of C=P^T*B */
181     ierr = MatDuplicate(C,MAT_COPY_VALUES,&C1);CHKERRQ(ierr);
182     ierr = MatDestroy(&C1);CHKERRQ(ierr);
183     ierr = MatDestroy(&C);CHKERRQ(ierr);
184   }
185 
186   /* 3) MatMatTransposeMult() */
187   /* ------------------------ */
188   if (Test_MatMatTr) {
189     /* C = B*R^T */
190     ierr = PetscObjectTypeCompare((PetscObject)B,MATSEQAIJ,&seqaij);CHKERRQ(ierr);
191     if (size == 1 && seqaij) {
192       ierr = MatMatTransposeMult(B,R,MAT_INITIAL_MATRIX,PETSC_DEFAULT,&C);CHKERRQ(ierr);
193       ierr = MatSetOptionsPrefix(C,"ABt_");CHKERRQ(ierr); /* enable '-ABt_' for matrix C */
194       ierr = MatGetInfo(C,MAT_GLOBAL_SUM,&info);CHKERRQ(ierr);
195 
196       /* Test MAT_REUSE_MATRIX - reuse symbolic C */
197       ierr = MatMatTransposeMult(B,R,MAT_REUSE_MATRIX,PETSC_DEFAULT,&C);CHKERRQ(ierr);
198 
199       /* Check */
200       ierr = MatMatMult(B,P,MAT_INITIAL_MATRIX,PETSC_DEFAULT,&C1);CHKERRQ(ierr);
201       ierr = MatNormDifference(C,C1,&norm);CHKERRQ(ierr);
202       if (norm > PETSC_SMALL) SETERRQ1(PETSC_COMM_WORLD,PETSC_ERR_PLIB,"Error in MatMatTransposeMult() %g",(double)norm);
203       ierr = MatDestroy(&C1);CHKERRQ(ierr);
204       ierr = MatDestroy(&C);CHKERRQ(ierr);
205     }
206   }
207 
208   /* 4) Test MatPtAP() */
209   /*-------------------*/
210   if (Test_MatPtAP) {
211     ierr = MatDuplicate(A_save,MAT_COPY_VALUES,&A);CHKERRQ(ierr);
212 
213     /* (4.1) Test developer API */
214     ierr = MatProductCreate(A,P,NULL,&C);CHKERRQ(ierr);
215     ierr = MatSetOptionsPrefix(C,"PtAP_");CHKERRQ(ierr);
216     ierr = MatProductSetType(C,MATPRODUCT_PtAP);CHKERRQ(ierr);
217     ierr = MatProductSetAlgorithm(C,"default");CHKERRQ(ierr);
218     ierr = MatProductSetFill(C,PETSC_DEFAULT);CHKERRQ(ierr);
219     ierr = MatProductSetFromOptions(C);CHKERRQ(ierr);
220     ierr = MatProductSymbolic(C);CHKERRQ(ierr);
221     ierr = MatProductNumeric(C);CHKERRQ(ierr);
222     ierr = MatProductNumeric(C);CHKERRQ(ierr); /* reuse symbolic C */
223 
224     ierr = MatPtAPMultEqual(A,P,C,10,&flg);CHKERRQ(ierr);
225     if (!flg) SETERRQ(PETSC_COMM_WORLD,PETSC_ERR_PLIB,"Error in MatProduct_PtAP");
226     ierr = MatDestroy(&C);CHKERRQ(ierr);
227 
228     /* (4.2) Test user driver */
229     ierr = MatPtAP(A,P,MAT_INITIAL_MATRIX,PETSC_DEFAULT,&C);CHKERRQ(ierr);
230 
231     /* Test MAT_REUSE_MATRIX - reuse symbolic C */
232     alpha=1.0;
233     for (i=0; i<2; i++) {
234       alpha -= 0.1;
235       ierr   = MatScale(A,alpha);CHKERRQ(ierr);
236       ierr   = MatPtAP(A,P,MAT_REUSE_MATRIX,PETSC_DEFAULT,&C);CHKERRQ(ierr);
237     }
238 
239     ierr = MatPtAPMultEqual(A,P,C,10,&flg);CHKERRQ(ierr);
240     if (!flg) SETERRQ(PETSC_COMM_WORLD,PETSC_ERR_PLIB,"Error in MatPtAP");
241 
242     /* 5) Test MatRARt() */
243     /* ----------------- */
244     if (Test_MatRARt) {
245       Mat RARt;
246       ierr = MatTranspose(P,MAT_REUSE_MATRIX,&R);CHKERRQ(ierr);
247 
248       /* (5.1) Test developer driver RARt = R*A*Rt */
249       ierr = MatProductCreate(A,R,NULL,&RARt);CHKERRQ(ierr);
250       ierr = MatSetOptionsPrefix(RARt,"RARt_");CHKERRQ(ierr);
251       ierr = MatProductSetType(RARt,MATPRODUCT_RARt);CHKERRQ(ierr);
252       ierr = MatProductSetAlgorithm(RARt,"default");CHKERRQ(ierr);
253       ierr = MatProductSetFill(RARt,PETSC_DEFAULT);CHKERRQ(ierr);
254       ierr = MatProductSetFromOptions(RARt);CHKERRQ(ierr);
255       ierr = MatProductSymbolic(RARt);CHKERRQ(ierr); /* equivalent to MatSetUp() */
256       ierr = MatSetOption(RARt,MAT_USE_INODES,PETSC_FALSE);CHKERRQ(ierr); /* illustrate how to call MatSetOption() */
257       ierr = MatProductNumeric(RARt);CHKERRQ(ierr);
258       ierr = MatProductNumeric(RARt);CHKERRQ(ierr); /* test reuse symbolic RARt */
259       ierr = MatDestroy(&RARt);CHKERRQ(ierr);
260 
261       /* (2.2) Test user driver RARt = R*A*Rt */
262       ierr = MatRARt(A,R,MAT_INITIAL_MATRIX,2.0,&RARt);CHKERRQ(ierr);
263       ierr = MatRARt(A,R,MAT_REUSE_MATRIX,2.0,&RARt);CHKERRQ(ierr);
264 
265       ierr = MatNormDifference(C,RARt,&norm);CHKERRQ(ierr);
266       if (norm > PETSC_SMALL) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_PLIB,"|PtAP - RARt| = %g",(double)norm);
267       ierr = MatDestroy(&RARt);CHKERRQ(ierr);
268     }
269 
270     ierr = MatDestroy(&A);CHKERRQ(ierr);
271     ierr = MatDestroy(&C);CHKERRQ(ierr);
272   }
273 
274   /* Destroy objects */
275   ierr = PetscRandomDestroy(&rdm);CHKERRQ(ierr);
276   ierr = PetscFree(idxn);CHKERRQ(ierr);
277 
278   ierr = MatDestroy(&A_save);CHKERRQ(ierr);
279   ierr = MatDestroy(&B);CHKERRQ(ierr);
280   ierr = MatDestroy(&P);CHKERRQ(ierr);
281   ierr = MatDestroy(&R);CHKERRQ(ierr);
282 
283   PetscFinalize();
284   return ierr;
285 }
286 
287 /*TEST
288    test:
289      suffix: 1
290      requires: datafilespath !complex double !define(PETSC_USE_64BIT_INDICES)
291      args: -fA ${DATAFILESPATH}/matrices/medium -fB ${DATAFILESPATH}/matrices/medium
292      output_file: output/ex62_1.out
293 
294    test:
295      suffix: 2_ab_scalable
296      requires: datafilespath !complex double !define(PETSC_USE_64BIT_INDICES)
297      args: -fA ${DATAFILESPATH}/matrices/medium -fB ${DATAFILESPATH}/matrices/medium -AB_matproduct_ab_via scalable -matmatmult_via scalable -AtB_matproduct_atb_via outerproduct -mattransposematmult_via outerproduct
298      output_file: output/ex62_1.out
299 
300    test:
301      suffix: 3_ab_scalable_fast
302      requires: datafilespath !complex double !define(PETSC_USE_64BIT_INDICES)
303      args: -fA ${DATAFILESPATH}/matrices/medium -fB ${DATAFILESPATH}/matrices/medium -AB_matproduct_ab_via scalable_fast -matmatmult_via scalable_fast -matmattransmult_via color
304      output_file: output/ex62_1.out
305 
306    test:
307      suffix: 4_ab_heap
308      requires: datafilespath !complex double !define(PETSC_USE_64BIT_INDICES)
309      args: -fA ${DATAFILESPATH}/matrices/medium -fB ${DATAFILESPATH}/matrices/medium -AB_matproduct_ab_via heap -matmatmult_via heap -PtAP_matproduct_ptap_via rap -matptap_via rap
310      output_file: output/ex62_1.out
311 
312    test:
313      suffix: 5_ab_btheap
314      requires: datafilespath !complex double !define(PETSC_USE_64BIT_INDICES)
315      args: -fA ${DATAFILESPATH}/matrices/medium -fB ${DATAFILESPATH}/matrices/medium -AB_matproduct_ab_via btheap -matmatmult_via btheap -matrart_via r*art
316      output_file: output/ex62_1.out
317 
318    test:
319      suffix: 6_ab_llcondensed
320      requires: datafilespath !complex double !define(PETSC_USE_64BIT_INDICES)
321      args: -fA ${DATAFILESPATH}/matrices/medium -fB ${DATAFILESPATH}/matrices/medium -AB_matproduct_ab_via llcondensed -matmatmult_via llcondensed -matrart_via coloring_rart
322      output_file: output/ex62_1.out
323 
324    test:
325      suffix: 7_ab_rowmerge
326      requires: datafilespath !complex double !define(PETSC_USE_64BIT_INDICES)
327      args: -fA ${DATAFILESPATH}/matrices/medium -fB ${DATAFILESPATH}/matrices/medium -AB_matproduct_ab_via rowmerge -matmatmult_via rowmerge
328      output_file: output/ex62_1.out
329 
330    test:
331      suffix: 8_ab_hypre
332      requires: hypre datafilespath !complex double !define(PETSC_USE_64BIT_INDICES)
333      args: -fA ${DATAFILESPATH}/matrices/medium -fB ${DATAFILESPATH}/matrices/medium -AB_matproduct_ab_via hypre -matmatmult_via hypre -PtAP_matproduct_ptap_via hypre -matptap_via hypre
334      output_file: output/ex62_1.out
335 
336    test:
337      suffix: 10
338      requires: datafilespath !complex double !define(PETSC_USE_64BIT_INDICES)
339      nsize: 3
340      args: -fA ${DATAFILESPATH}/matrices/medium -fB ${DATAFILESPATH}/matrices/medium
341      output_file: output/ex62_1.out
342 
343    test:
344      suffix: 11_ab_scalable
345      requires: datafilespath !complex double !define(PETSC_USE_64BIT_INDICES)
346      nsize: 3
347      args: -fA ${DATAFILESPATH}/matrices/medium -fB ${DATAFILESPATH}/matrices/medium -AB_matproduct_ab_via scalable -matmatmult_via scalable -AtB_matproduct_atb_via scalable -mattransposematmult_via scalable
348      output_file: output/ex62_1.out
349 
350    test:
351      suffix: 12_ab_seqmpi
352      requires: datafilespath !complex double !define(PETSC_USE_64BIT_INDICES)
353      nsize: 3
354      args: -fA ${DATAFILESPATH}/matrices/medium -fB ${DATAFILESPATH}/matrices/medium -AB_matproduct_ab_via seqmpi -matmatmult_via seqmpi -AtB_matproduct_atb_via at*b -mattransposematmult_via at*b
355      output_file: output/ex62_1.out
356 
357    test:
358      suffix: 13_ab_hypre
359      requires: hypre datafilespath !complex double !define(PETSC_USE_64BIT_INDICES)
360      nsize: 3
361      args: -fA ${DATAFILESPATH}/matrices/medium -fB ${DATAFILESPATH}/matrices/medium -AB_matproduct_ab_via hypre -matmatmult_via hypre -PtAP_matproduct_ptap_via hypre -matptap_via hypre
362      output_file: output/ex62_1.out
363 
364 TEST*/
365