xref: /petsc/src/mat/impls/aij/mpi/crl/mcrl.c (revision b06ca6b09b3ae4e8a93ed49db16f4412dd6db9d8)
1 #define PETSCMAT_DLL
2 
3 /*
4   Defines a matrix-vector product for the MATMPIAIJCRL matrix class.
5   This class is derived from the MATMPIAIJ class and retains the
6   compressed row storage (aka Yale sparse matrix format) but augments
7   it with a column oriented storage that is more efficient for
8   matrix vector products on Vector machines.
9 
10   CRL stands for constant row length (that is the same number of columns
11   is kept (padded with zeros) for each row of the sparse matrix.
12 
13    See src/mat/impls/aij/seq/crl/crl.c for the sequential version
14 */
15 
16 #include "../src/mat/impls/aij/mpi/mpiaij.h"
17 #include "../src/mat/impls/aij/seq/crl/crl.h"
18 
19 extern PetscErrorCode MatDestroy_MPIAIJ(Mat);
20 
21 #undef __FUNCT__
22 #define __FUNCT__ "MatDestroy_MPICRL"
23 PetscErrorCode MatDestroy_MPICRL(Mat A)
24 {
25   PetscErrorCode ierr;
26   Mat_CRL        *crl = (Mat_CRL *) A->spptr;
27 
28   /* Free everything in the Mat_CRL data structure. */
29   ierr = PetscFree2(crl->acols,crl->icols);CHKERRQ(ierr);
30   if (crl->fwork) {
31     ierr = VecDestroy(crl->fwork);CHKERRQ(ierr);
32   }
33   if (crl->xwork) {
34     ierr = VecDestroy(crl->xwork);CHKERRQ(ierr);
35   }
36   ierr = PetscFree(crl->array);CHKERRQ(ierr);
37   ierr = PetscFree(crl);CHKERRQ(ierr);
38   A->spptr = 0;
39 
40   ierr = PetscObjectChangeTypeName( (PetscObject)A, MATMPIAIJ);CHKERRQ(ierr);
41   ierr = MatDestroy_MPIAIJ(A);CHKERRQ(ierr);
42   PetscFunctionReturn(0);
43 }
44 
45 #undef __FUNCT__
46 #define __FUNCT__ "MPICRL_create_crl"
47 PetscErrorCode MPICRL_create_crl(Mat A)
48 {
49   Mat_MPIAIJ     *a = (Mat_MPIAIJ *)(A)->data;
50   Mat_SeqAIJ     *Aij = (Mat_SeqAIJ*)(a->A->data), *Bij = (Mat_SeqAIJ*)(a->B->data);
51   Mat_CRL        *crl = (Mat_CRL*) A->spptr;
52   PetscInt       m = A->rmap->n;  /* Number of rows in the matrix. */
53   PetscInt       nd = a->A->cmap->n; /* number of columns in diagonal portion */
54   PetscInt       *aj = Aij->j,*bj = Bij->j;  /* From the CSR representation; points to the beginning  of each row. */
55   PetscInt       i, j,rmax = 0,*icols, *ailen = Aij->ilen, *bilen = Bij->ilen;
56   PetscScalar    *aa = Aij->a,*ba = Bij->a,*acols,*array;
57   PetscErrorCode ierr;
58 
59   PetscFunctionBegin;
60   /* determine the row with the most columns */
61   for (i=0; i<m; i++) {
62     rmax = PetscMax(rmax,ailen[i]+bilen[i]);
63   }
64   crl->nz   = Aij->nz+Bij->nz;
65   crl->m    = A->rmap->n;
66   crl->rmax = rmax;
67   ierr  = PetscMalloc2(rmax*m,PetscScalar,&crl->acols,rmax*m,PetscInt,&crl->icols);CHKERRQ(ierr);
68   acols = crl->acols;
69   icols = crl->icols;
70   for (i=0; i<m; i++) {
71     for (j=0; j<ailen[i]; j++) {
72       acols[j*m+i] = *aa++;
73       icols[j*m+i] = *aj++;
74     }
75     for (;j<ailen[i]+bilen[i]; j++) {
76       acols[j*m+i] = *ba++;
77       icols[j*m+i] = nd + *bj++;
78     }
79     for (;j<rmax; j++) { /* empty column entries */
80       acols[j*m+i] = 0.0;
81       icols[j*m+i] = (j) ? icols[(j-1)*m+i] : 0;  /* handle case where row is EMPTY */
82     }
83   }
84   ierr = PetscInfo1(A,"Percentage of 0's introduced for vectorized multiply %g\n",1.0-((double)(crl->nz))/((double)(rmax*m)));
85 
86   ierr = PetscMalloc((a->B->cmap->n+nd)*sizeof(PetscScalar),&array);CHKERRQ(ierr);
87   /* xwork array is actually B->n+nd long, but we define xwork this length so can copy into it */
88   ierr = VecCreateMPIWithArray(((PetscObject)A)->comm,nd,PETSC_DECIDE,array,&crl->xwork);CHKERRQ(ierr);
89   ierr = VecCreateSeqWithArray(PETSC_COMM_SELF,a->B->cmap->n,array+nd,&crl->fwork);CHKERRQ(ierr);
90   crl->array = array;
91   crl->xscat = a->Mvctx;
92   PetscFunctionReturn(0);
93 }
94 
95 extern PetscErrorCode MatAssemblyEnd_MPIAIJ(Mat,MatAssemblyType);
96 
97 #undef __FUNCT__
98 #define __FUNCT__ "MatAssemblyEnd_MPICRL"
99 PetscErrorCode MatAssemblyEnd_MPICRL(Mat A, MatAssemblyType mode)
100 {
101   PetscErrorCode ierr;
102   Mat_MPIAIJ     *a = (Mat_MPIAIJ*)A->data;
103   Mat_SeqAIJ     *Aij = (Mat_SeqAIJ*)(a->A->data), *Bij = (Mat_SeqAIJ*)(a->A->data);
104 
105   PetscFunctionBegin;
106   Aij->inode.use = PETSC_FALSE;
107   Bij->inode.use = PETSC_FALSE;
108   ierr = MatAssemblyEnd_MPIAIJ(A,mode);CHKERRQ(ierr);
109   if (mode == MAT_FLUSH_ASSEMBLY) PetscFunctionReturn(0);
110 
111   /* Now calculate the permutation and grouping information. */
112   ierr = MPICRL_create_crl(A);CHKERRQ(ierr);
113   PetscFunctionReturn(0);
114 }
115 
116 extern PetscErrorCode MatMult_CRL(Mat,Vec,Vec);
117 extern PetscErrorCode MatDuplicate_CRL(Mat,MatDuplicateOption,Mat*);
118 
119 /* MatConvert_MPIAIJ_MPICRL converts a MPIAIJ matrix into a
120  * MPICRL matrix.  This routine is called by the MatCreate_MPICRL()
121  * routine, but can also be used to convert an assembled MPIAIJ matrix
122  * into a MPICRL one. */
123 EXTERN_C_BEGIN
124 #undef __FUNCT__
125 #define __FUNCT__ "MatConvert_MPIAIJ_MPICRL"
126 PetscErrorCode PETSCMAT_DLLEXPORT MatConvert_MPIAIJ_MPICRL(Mat A,const MatType type,MatReuse reuse,Mat *newmat)
127 {
128   PetscErrorCode ierr;
129   Mat            B = *newmat;
130   Mat_CRL        *crl;
131 
132   PetscFunctionBegin;
133   if (reuse == MAT_INITIAL_MATRIX) {
134     ierr = MatDuplicate(A,MAT_COPY_VALUES,&B);CHKERRQ(ierr);
135   }
136 
137   ierr = PetscNewLog(B,Mat_CRL,&crl);CHKERRQ(ierr);
138   B->spptr = (void *) crl;
139 
140   /* Set function pointers for methods that we inherit from AIJ but override. */
141   B->ops->duplicate   = MatDuplicate_CRL;
142   B->ops->assemblyend = MatAssemblyEnd_MPICRL;
143   B->ops->destroy     = MatDestroy_MPICRL;
144   B->ops->mult        = MatMult_CRL;
145 
146   /* If A has already been assembled, compute the permutation. */
147   if (A->assembled) {
148     ierr = MPICRL_create_crl(B);CHKERRQ(ierr);
149   }
150   ierr = PetscObjectChangeTypeName((PetscObject)B,MATMPICRL);CHKERRQ(ierr);
151   *newmat = B;
152   PetscFunctionReturn(0);
153 }
154 EXTERN_C_END
155 
156 
157 #undef __FUNCT__
158 #define __FUNCT__ "MatCreateMPICRL"
159 /*@C
160    MatCreateMPICRL - Creates a sparse matrix of type MPICRL.
161    This type inherits from AIJ, but stores some additional
162    information that is used to allow better vectorization of
163    the matrix-vector product. At the cost of increased storage, the AIJ formatted
164    matrix can be copied to a format in which pieces of the matrix are
165    stored in ELLPACK format, allowing the vectorized matrix multiply
166    routine to use stride-1 memory accesses.  As with the AIJ type, it is
167    important to preallocate matrix storage in order to get good assembly
168    performance.
169 
170    Collective on MPI_Comm
171 
172    Input Parameters:
173 +  comm - MPI communicator, set to PETSC_COMM_SELF
174 .  m - number of rows
175 .  n - number of columns
176 .  nz - number of nonzeros per row (same for all rows)
177 -  nnz - array containing the number of nonzeros in the various rows
178          (possibly different for each row) or PETSC_NULL
179 
180    Output Parameter:
181 .  A - the matrix
182 
183    Notes:
184    If nnz is given then nz is ignored
185 
186    Level: intermediate
187 
188 .keywords: matrix, cray, sparse, parallel
189 
190 .seealso: MatCreate(), MatCreateMPICSRPERM(), MatSetValues()
191 @*/
192 PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPICRL(MPI_Comm comm,PetscInt m,PetscInt n,PetscInt nz,const PetscInt nnz[],PetscInt onz,const PetscInt onnz[],Mat *A)
193 {
194   PetscErrorCode ierr;
195 
196   PetscFunctionBegin;
197   ierr = MatCreate(comm,A);CHKERRQ(ierr);
198   ierr = MatSetSizes(*A,m,n,m,n);CHKERRQ(ierr);
199   ierr = MatSetType(*A,MATMPICRL);CHKERRQ(ierr);
200   ierr = MatMPIAIJSetPreallocation_MPIAIJ(*A,nz,(PetscInt*)nnz,onz,(PetscInt*)onnz);CHKERRQ(ierr);
201   PetscFunctionReturn(0);
202 }
203 
204 
205 EXTERN_C_BEGIN
206 #undef __FUNCT__
207 #define __FUNCT__ "MatCreate_MPICRL"
208 PetscErrorCode PETSCMAT_DLLEXPORT MatCreate_MPICRL(Mat A)
209 {
210   PetscErrorCode ierr;
211 
212   PetscFunctionBegin;
213   ierr = MatSetType(A,MATMPIAIJ);CHKERRQ(ierr);
214   ierr = MatConvert_MPIAIJ_MPICRL(A,MATMPICRL,MAT_REUSE_MATRIX,&A);CHKERRQ(ierr);
215   PetscFunctionReturn(0);
216 }
217 EXTERN_C_END
218 
219