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