xref: /petsc/src/mat/tests/ex37.c (revision ebead697dbf761eb322f829370bbe90b3bd93fa3)
1 
2 static char help[] = "Tests MatCopy() and MatStore/RetrieveValues().\n\n";
3 
4 #include <petscmat.h>
5 
6 int main(int argc,char **args)
7 {
8   Mat            C,A;
9   PetscInt       i, n = 10,midx[3],bs=1;
10   PetscScalar    v[3];
11   PetscBool      flg,isAIJ;
12   MatType        type;
13   PetscMPIInt    size;
14 
15   PetscFunctionBeginUser;
16   PetscCall(PetscInitialize(&argc,&args,(char*)0,help));
17   PetscCallMPI(MPI_Comm_size(PETSC_COMM_WORLD,&size));
18   PetscCall(PetscOptionsGetInt(NULL,NULL,"-n",&n,NULL));
19   PetscCall(PetscOptionsGetInt(NULL,NULL,"-mat_block_size",&bs,NULL));
20 
21   PetscCall(MatCreate(PETSC_COMM_WORLD,&C));
22   PetscCall(MatSetSizes(C,PETSC_DECIDE,PETSC_DECIDE,n,n));
23   PetscCall(MatSetType(C,MATAIJ));
24   PetscCall(MatSetFromOptions(C));
25   PetscCall(PetscObjectSetName((PetscObject)C,"initial"));
26 
27   PetscCall(MatGetType(C,&type));
28   if (size == 1) {
29     PetscCall(PetscObjectTypeCompare((PetscObject)C,MATSEQAIJ,&isAIJ));
30   } else {
31     PetscCall(PetscObjectTypeCompare((PetscObject)C,MATMPIAIJ,&isAIJ));
32   }
33   PetscCall(MatSeqAIJSetPreallocation(C,3,NULL));
34   PetscCall(MatMPIAIJSetPreallocation(C,3,NULL,3,NULL));
35   PetscCall(MatSeqBAIJSetPreallocation(C,bs,3,NULL));
36   PetscCall(MatMPIBAIJSetPreallocation(C,bs,3,NULL,3,NULL));
37   PetscCall(MatSeqSBAIJSetPreallocation(C,bs,3,NULL));
38   PetscCall(MatMPISBAIJSetPreallocation(C,bs,3,NULL,3,NULL));
39 
40   v[0] = -1.; v[1] = 2.; v[2] = -1.;
41   for (i=1; i<n-1; i++) {
42     midx[2] = i-1; midx[1] = i; midx[0] = i+1;
43     PetscCall(MatSetValues(C,1,&i,3,midx,v,INSERT_VALUES));
44   }
45   i    = 0; midx[0] = 0; midx[1] = 1;
46   v[0] = 2.0; v[1] = -1.;
47   PetscCall(MatSetValues(C,1,&i,2,midx,v,INSERT_VALUES));
48   i    = n-1; midx[0] = n-2; midx[1] = n-1;
49   v[0] = -1.0; v[1] = 2.;
50   PetscCall(MatSetValues(C,1,&i,2,midx,v,INSERT_VALUES));
51 
52   PetscCall(MatAssemblyBegin(C,MAT_FINAL_ASSEMBLY));
53   PetscCall(MatAssemblyEnd(C,MAT_FINAL_ASSEMBLY));
54   PetscCall(MatView(C,NULL));
55   PetscCall(MatViewFromOptions(C,NULL,"-view"));
56 
57   /* test matduplicate */
58   PetscCall(MatDuplicate(C,MAT_COPY_VALUES,&A));
59   PetscCall(PetscObjectSetName((PetscObject)A,"duplicate_copy"));
60   PetscCall(MatViewFromOptions(A,NULL,"-view"));
61   PetscCall(MatEqual(A,C,&flg));
62   PetscCheck(flg,PETSC_COMM_SELF,PETSC_ERR_SUP,"MatDuplicate(C,MAT_COPY_VALUES,): Matrices are NOT equal");
63   PetscCall(MatDestroy(&A));
64 
65   /* test matrices with different nonzero patterns - Note: A is created with different nonzero pattern of C! */
66   PetscCall(MatCreate(PETSC_COMM_WORLD,&A));
67   PetscCall(MatSetSizes(A,PETSC_DECIDE,PETSC_DECIDE,n,n));
68   PetscCall(MatSetFromOptions(A));
69   PetscCall(MatSetUp(A));
70   PetscCall(MatAssemblyBegin(A,MAT_FINAL_ASSEMBLY));
71   PetscCall(MatAssemblyEnd(A,MAT_FINAL_ASSEMBLY));
72 
73   PetscCall(MatCopy(C,A,DIFFERENT_NONZERO_PATTERN));
74   PetscCall(PetscObjectSetName((PetscObject)A,"copy_diffnnz"));
75   PetscCall(MatViewFromOptions(A,NULL,"-view"));
76   PetscCall(MatEqual(A,C,&flg));
77   PetscCheck(flg,PETSC_COMM_SELF,PETSC_ERR_SUP,"MatCopy(C,A,DIFFERENT_NONZERO_PATTERN): Matrices are NOT equal");
78 
79   /* test matrices with same nonzero pattern */
80   PetscCall(MatDestroy(&A));
81   PetscCall(MatDuplicate(C,MAT_DO_NOT_COPY_VALUES,&A));
82   PetscCall(MatCopy(C,A,SAME_NONZERO_PATTERN));
83   PetscCall(PetscObjectSetName((PetscObject)A,"copy_samennz"));
84   PetscCall(MatViewFromOptions(A,NULL,"-view"));
85   PetscCall(MatEqual(A,C,&flg));
86   PetscCheck(flg,PETSC_COMM_SELF,PETSC_ERR_SUP,"MatCopy(C,A,SAME_NONZERO_PATTERN): Matrices are NOT equal");
87 
88   /* test subset nonzero pattern */
89   PetscCall(MatCopy(C,A,SUBSET_NONZERO_PATTERN));
90   PetscCall(PetscObjectSetName((PetscObject)A,"copy_subnnz"));
91   PetscCall(MatViewFromOptions(A,NULL,"-view"));
92   PetscCall(MatEqual(A,C,&flg));
93   PetscCheck(flg,PETSC_COMM_SELF,PETSC_ERR_SUP,"MatCopy(C,A,SUBSET_NONZERO_PATTERN): Matrices are NOT equal");
94 
95   /* Test MatCopy on a matrix obtained after MatConvert from AIJ
96      see https://lists.mcs.anl.gov/pipermail/petsc-dev/2019-April/024289.html */
97   PetscCall(MatHasCongruentLayouts(C,&flg));
98   if (flg) {
99     Mat     Cs,Cse;
100     MatType Ctype,Cstype;
101 
102     PetscCall(MatGetType(C,&Ctype));
103     PetscCall(MatTranspose(C,MAT_INITIAL_MATRIX,&Cs));
104     PetscCall(MatAXPY(Cs,1.0,C,DIFFERENT_NONZERO_PATTERN));
105     PetscCall(MatConvert(Cs,MATAIJ,MAT_INPLACE_MATRIX,&Cs));
106     PetscCall(MatSetOption(Cs,MAT_SYMMETRIC,PETSC_TRUE));
107     PetscCall(MatGetType(Cs,&Cstype));
108 
109     PetscCall(PetscObjectSetName((PetscObject)Cs,"symm_initial"));
110     PetscCall(MatViewFromOptions(Cs,NULL,"-view"));
111 
112     PetscCall(MatConvert(Cs,Ctype,MAT_INITIAL_MATRIX,&Cse));
113     PetscCall(PetscObjectSetName((PetscObject)Cse,"symm_conv_init"));
114     PetscCall(MatViewFromOptions(Cse,NULL,"-view"));
115     PetscCall(MatMultEqual(Cs,Cse,5,&flg));
116     PetscCheck(flg,PETSC_COMM_SELF,PETSC_ERR_PLIB,"MatConvert MAT_INITIAL_MATRIX %s -> %s: Matrices are NOT multequal",Ctype,Cstype);
117 
118     PetscCall(MatConvert(Cs,Ctype,MAT_REUSE_MATRIX,&Cse));
119     PetscCall(PetscObjectSetName((PetscObject)Cse,"symm_conv_reuse"));
120     PetscCall(MatViewFromOptions(Cse,NULL,"-view"));
121     PetscCall(MatMultEqual(Cs,Cse,5,&flg));
122     PetscCheck(flg,PETSC_COMM_SELF,PETSC_ERR_PLIB,"MatConvert MAT_REUSE_MATRIX %s -> %s: Matrices are NOT multequal",Ctype,Cstype);
123 
124     PetscCall(MatCopy(Cs,Cse,SAME_NONZERO_PATTERN));
125     PetscCall(PetscObjectSetName((PetscObject)Cse,"symm_conv_copy_samennz"));
126     PetscCall(MatViewFromOptions(Cse,NULL,"-view"));
127     PetscCall(MatMultEqual(Cs,Cse,5,&flg));
128     PetscCheck(flg,PETSC_COMM_SELF,PETSC_ERR_PLIB,"MatCopy(...SAME_NONZERO_PATTERN) %s -> %s: Matrices are NOT multequal",Ctype,Cstype);
129 
130     PetscCall(MatCopy(Cs,Cse,SUBSET_NONZERO_PATTERN));
131     PetscCall(PetscObjectSetName((PetscObject)Cse,"symm_conv_copy_subnnz"));
132     PetscCall(MatViewFromOptions(Cse,NULL,"-view"));
133     PetscCall(MatMultEqual(Cs,Cse,5,&flg));
134     PetscCheck(flg,PETSC_COMM_SELF,PETSC_ERR_PLIB,"MatCopy(...SUBSET_NONZERO_PATTERN) %s -> %s: Matrices are NOT multequal",Ctype,Cstype);
135 
136     PetscCall(MatCopy(Cs,Cse,DIFFERENT_NONZERO_PATTERN));
137     PetscCall(PetscObjectSetName((PetscObject)Cse,"symm_conv_copy_diffnnz"));
138     PetscCall(MatViewFromOptions(Cse,NULL,"-view"));
139     PetscCall(MatMultEqual(Cs,Cse,5,&flg));
140     PetscCheck(flg,PETSC_COMM_SELF,PETSC_ERR_PLIB,"MatCopy(...DIFFERENT_NONZERO_PATTERN) %s -> %s: Matrices are NOT multequal",Ctype,Cstype);
141 
142     PetscCall(MatDestroy(&Cse));
143     PetscCall(MatDestroy(&Cs));
144   }
145 
146   /* test MatStore/RetrieveValues() */
147   if (isAIJ) {
148     PetscCall(MatSetOption(A,MAT_NEW_NONZERO_LOCATIONS,PETSC_FALSE));
149     PetscCall(MatStoreValues(A));
150     PetscCall(MatZeroEntries(A));
151     PetscCall(MatRetrieveValues(A));
152   }
153 
154   PetscCall(MatDestroy(&C));
155   PetscCall(MatDestroy(&A));
156   PetscCall(PetscFinalize());
157   return 0;
158 }
159 
160 /*TEST
161 
162    testset:
163       nsize: {{1 2}separate output}
164       args: -view ::ascii_info -mat_type {{aij baij sbaij mpiaij mpibaij mpisbaij}separate output} -mat_block_size {{1 2}separate output}
165 
166 TEST*/
167