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