xref: /petsc/src/mat/impls/elemental/matelem.cxx (revision 0f55b88d1ac75fa99e70a53aff055236a607e7f1)
1 #include <../src/mat/impls/elemental/matelemimpl.h> /*I "petscmat.h" I*/
2 
3 #undef __FUNCT__
4 #define __FUNCT__ "PetscElementalInitializePackage"
5 /*@C
6    PetscElementalInitializePackage - Initialize Elemental package
7 
8    Logically Collective
9 
10    Input Arguments:
11 .  path - the dynamic library path or PETSC_NULL
12 
13    Level: developer
14 
15 .seealso: MATELEMENTAL, PetscElementalFinalizePackage()
16 @*/
17 PetscErrorCode PetscElementalInitializePackage(const char *path)
18 {
19   PetscErrorCode ierr;
20 
21   PetscFunctionBegin;
22   if (elem::Initialized()) PetscFunctionReturn(0);
23   { /* We have already initialized MPI, so this song and dance is just to pass these variables (which won't be used by Elemental) through the interface that needs references */
24     int zero = 0;
25     char **nothing = 0;
26     elem::Initialize(zero,nothing);
27   }
28   ierr = PetscRegisterFinalize(PetscElementalFinalizePackage);CHKERRQ(ierr);
29   PetscFunctionReturn(0);
30 }
31 
32 #undef __FUNCT__
33 #define __FUNCT__ "PetscElementalFinalizePackage"
34 /*@C
35    PetscElementalFinalizePackage - Finalize Elemental package
36 
37    Logically Collective
38 
39    Level: developer
40 
41 .seealso: MATELEMENTAL, PetscElementalInitializePackage()
42 @*/
43 PetscErrorCode PetscElementalFinalizePackage(void)
44 {
45 
46   PetscFunctionBegin;
47   elem::Finalize();
48   PetscFunctionReturn(0);
49 }
50 
51 #undef __FUNCT__
52 #define __FUNCT__ "MatView_Elemental"
53 static PetscErrorCode MatView_Elemental(Mat A,PetscViewer viewer)
54 {
55   PetscErrorCode ierr;
56   Mat_Elemental  *a = (Mat_Elemental*)A->data;
57   PetscBool      iascii;
58 
59   PetscFunctionBegin;
60   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
61   if (iascii) {
62     PetscViewerFormat format;
63     ierr = PetscViewerGetFormat(viewer,&format);CHKERRQ(ierr);
64     if (format == PETSC_VIEWER_ASCII_INFO) {
65       SETERRQ(((PetscObject)viewer)->comm,PETSC_ERR_SUP,"Info viewer not implemented yet");
66     } else if (format == PETSC_VIEWER_DEFAULT) {
67       ierr = PetscViewerASCIIUseTabs(viewer,PETSC_FALSE);CHKERRQ(ierr);
68       ierr = PetscObjectPrintClassNamePrefixType((PetscObject)A,viewer,"Matrix Object");CHKERRQ(ierr);
69       a->emat->Print("Elemental matrix (cyclic ordering)");
70       ierr = PetscViewerASCIIUseTabs(viewer,PETSC_TRUE);CHKERRQ(ierr);
71     } else SETERRQ(((PetscObject)viewer)->comm,PETSC_ERR_SUP,"Format");
72   } else SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Viewer type %s not supported by Elemental matrices",((PetscObject)viewer)->type_name);
73   PetscFunctionReturn(0);
74 }
75 
76 #undef __FUNCT__
77 #define __FUNCT__ "MatSetValues_Elemental"
78 static PetscErrorCode MatSetValues_Elemental(Mat A,PetscInt nr,const PetscInt *rows,PetscInt nc,const PetscInt *cols,const PetscScalar *vals,InsertMode imode)
79 {
80   PetscErrorCode ierr;
81   Mat_Elemental  *a = (Mat_Elemental*)A->data;
82   PetscMPIInt    rank;
83   PetscInt       i,j,rrank,ridx,crank,cidx;
84 
85   PetscFunctionBegin;
86   ierr = MPI_Comm_rank(((PetscObject)A)->comm,&rank);CHKERRQ(ierr);
87 
88   const elem::Grid &grid = a->emat->Grid();
89   for (i=0; i<nr; i++) {
90     PetscInt erow,ecol,elrow,elcol;
91     if (rows[i] < 0) continue;
92     P2RO(A,0,rows[i],&rrank,&ridx);
93     RO2E(A,0,rrank,ridx,&erow);
94     if (rrank < 0 || ridx < 0 || erow < 0) SETERRQ(((PetscObject)A)->comm,PETSC_ERR_PLIB,"Incorrect row translation");
95     for (j=0; j<nc; j++) {
96       if (cols[j] < 0) continue;
97       P2RO(A,1,cols[j],&crank,&cidx);
98       RO2E(A,1,crank,cidx,&ecol);
99       if (crank < 0 || cidx < 0 || ecol < 0) SETERRQ(((PetscObject)A)->comm,PETSC_ERR_PLIB,"Incorrect col translation");
100       if (erow % grid.MCSize() != grid.MCRank() || ecol % grid.MRSize() != grid.MRRank()){ /* off-proc entry */
101         if (imode != ADD_VALUES) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"Only ADD_VALUES to off-processor entry is supported");
102         /* PetscPrintf(PETSC_COMM_SELF,"[%D] add off-proc entry (%D,%D, %g) (%D %D)\n",rank,rows[i],cols[j],*(vals+i*nc),erow,ecol); */
103         a->esubmat->Set(0,0, vals[i*nc+j]);
104         a->interface->Axpy(1.0,*(a->esubmat),erow,ecol);
105         continue;
106       }
107       elrow = erow / grid.MCSize();
108       elcol = ecol / grid.MRSize();
109       switch (imode) {
110       case INSERT_VALUES: a->emat->SetLocal(elrow,elcol,vals[i*nc+j]); break;
111       case ADD_VALUES: a->emat->UpdateLocal(elrow,elcol,vals[i*nc+j]); break;
112       default: SETERRQ1(((PetscObject)A)->comm,PETSC_ERR_SUP,"No support for InsertMode %d",(int)imode);
113       }
114     }
115   }
116   PetscFunctionReturn(0);
117 }
118 
119 #undef __FUNCT__
120 #define __FUNCT__ "MatMult_Elemental"
121 static PetscErrorCode MatMult_Elemental(Mat A,Vec X,Vec Y)
122 {
123   Mat_Elemental     *a = (Mat_Elemental*)A->data;
124   PetscErrorCode    ierr;
125   const PetscScalar *x;
126   PetscScalar       *y;
127   PetscScalar       one = 1,zero = 0;
128 
129   PetscFunctionBegin;
130   ierr = VecGetArrayRead(X,&x);CHKERRQ(ierr);
131   ierr = VecGetArray(Y,&y);CHKERRQ(ierr);
132   { /* Scoping so that constructor is called before pointer is returned */
133     elem::DistMatrix<PetscScalar,elem::VC,elem::STAR> xe(A->cmap->N,1,0,x,A->cmap->n,*a->grid);
134     elem::DistMatrix<PetscScalar,elem::VC,elem::STAR> ye(A->rmap->N,1,0,y,A->rmap->n,*a->grid);
135     elem::Gemv(elem::NORMAL,one,*a->emat,xe,zero,ye);
136   }
137   ierr = VecRestoreArrayRead(X,&x);CHKERRQ(ierr);
138   ierr = VecRestoreArray(Y,&y);CHKERRQ(ierr);
139   PetscFunctionReturn(0);
140 }
141 
142 #undef __FUNCT__
143 #define __FUNCT__ "MatMultAdd_Elemental"
144 static PetscErrorCode MatMultAdd_Elemental(Mat A,Vec X,Vec Y,Vec Z)
145 {
146   Mat_Elemental     *a = (Mat_Elemental*)A->data;
147   PetscErrorCode    ierr;
148   const PetscScalar *x;
149   PetscScalar       *z;
150   PetscScalar       one = 1.0;
151 
152   PetscFunctionBegin;
153   if (Y != Z) {ierr = VecCopy(Y,Z);CHKERRQ(ierr);}
154   ierr = VecGetArrayRead(X,&x);CHKERRQ(ierr);
155   ierr = VecGetArray(Z,&z);CHKERRQ(ierr);
156   { /* Scoping so that constructor is called before pointer is returned */
157     elem::DistMatrix<PetscScalar,elem::VC,elem::STAR> xe(A->cmap->N,1,0,x,A->cmap->n,*a->grid);
158     elem::DistMatrix<PetscScalar,elem::VC,elem::STAR> ze(A->rmap->N,1,0,z,A->rmap->n,*a->grid);
159     elem::Gemv(elem::NORMAL,one,*a->emat,xe,one,ze);
160   }
161   ierr = VecRestoreArrayRead(X,&x);CHKERRQ(ierr);
162   ierr = VecRestoreArray(Z,&z);CHKERRQ(ierr);
163   PetscFunctionReturn(0);
164 }
165 
166 #undef __FUNCT__
167 #define __FUNCT__ "MatMatMultNumeric_Elemental"
168 static PetscErrorCode MatMatMultNumeric_Elemental(Mat A,Mat B,Mat C)
169 {
170   Mat_Elemental  *a = (Mat_Elemental*)A->data;
171   Mat_Elemental  *b = (Mat_Elemental*)B->data;
172   Mat_Elemental  *c = (Mat_Elemental*)C->data;
173   PetscScalar    one = 1.0,zero = 0.0;
174 
175   PetscFunctionBegin;
176   { /* Scoping so that constructor is called before pointer is returned */
177     elem::Gemm(elem::NORMAL,elem::NORMAL,one,*a->emat,*b->emat,zero,*c->emat);
178   }
179   C->assembled = PETSC_TRUE;
180   PetscFunctionReturn(0);
181 }
182 
183 #undef __FUNCT__
184 #define __FUNCT__ "MatMatMultSymbolic_Elemental"
185 static PetscErrorCode MatMatMultSymbolic_Elemental(Mat A,Mat B,PetscReal fill,Mat *C)
186 {
187   PetscErrorCode ierr;
188   Mat            Ce;
189   MPI_Comm       comm=((PetscObject)A)->comm;
190 
191   PetscFunctionBegin;
192   ierr = MatCreate(comm,&Ce);CHKERRQ(ierr);
193   ierr = MatSetSizes(Ce,A->rmap->n,B->cmap->n,PETSC_DECIDE,PETSC_DECIDE);CHKERRQ(ierr);
194   ierr = MatSetType(Ce,MATELEMENTAL);CHKERRQ(ierr);
195   ierr = MatSetUp(Ce);CHKERRQ(ierr);
196   *C = Ce;
197   PetscFunctionReturn(0);
198 }
199 
200 #undef __FUNCT__
201 #define __FUNCT__ "MatMatMult_Elemental"
202 static PetscErrorCode MatMatMult_Elemental(Mat A,Mat B,MatReuse scall,PetscReal fill,Mat *C)
203 {
204   PetscErrorCode ierr;
205 
206   PetscFunctionBegin;
207   if (scall == MAT_INITIAL_MATRIX){
208     ierr = PetscLogEventBegin(MAT_MatMultSymbolic,A,B,0,0);CHKERRQ(ierr);
209     ierr = MatMatMultSymbolic_Elemental(A,B,1.0,C);CHKERRQ(ierr);
210     ierr = PetscLogEventEnd(MAT_MatMultSymbolic,A,B,0,0);CHKERRQ(ierr);
211   }
212   ierr = PetscLogEventBegin(MAT_MatMultNumeric,A,B,0,0);CHKERRQ(ierr);
213   ierr = MatMatMultNumeric_Elemental(A,B,*C);CHKERRQ(ierr);
214   ierr = PetscLogEventEnd(MAT_MatMultNumeric,A,B,0,0);CHKERRQ(ierr);
215   PetscFunctionReturn(0);
216 }
217 
218 #undef __FUNCT__
219 #define __FUNCT__ "MatScale_Elemental"
220 static PetscErrorCode MatScale_Elemental(Mat X,PetscScalar a)
221 {
222   Mat_Elemental  *x = (Mat_Elemental*)X->data;
223 
224   PetscFunctionBegin;
225   { /* Scoping so that constructor is called before pointer is returned */
226     elem::Scal(a,*x->emat);
227   }
228   PetscFunctionReturn(0);
229 }
230 
231 #undef __FUNCT__
232 #define __FUNCT__ "MatAXPY_Elemental"
233 static PetscErrorCode MatAXPY_Elemental(Mat Y,PetscScalar a,Mat X,MatStructure str)
234 {
235   Mat_Elemental  *x = (Mat_Elemental*)X->data;
236   Mat_Elemental  *y = (Mat_Elemental*)Y->data;
237 
238   PetscFunctionBegin;
239   { /* Scoping so that constructor is called before pointer is returned */
240     elem::Axpy(a,*x->emat,*y->emat);
241   }
242   PetscFunctionReturn(0);
243 }
244 
245 #undef __FUNCT__
246 #define __FUNCT__ "MatMatSolve_Elemental"
247 static PetscErrorCode MatMatSolve_Elemental(Mat A,Mat B,Mat X)
248 {
249   PetscFunctionBegin;
250   printf("MatMatSolve_Elemental is called...\n");
251   if (X != B) SETERRQ(((PetscObject)A)->comm,PETSC_ERR_ARG_IDN,"X and B must be same matrices");
252   // elem::GuassianElimination
253   PetscFunctionReturn(0);
254 }
255 
256 #undef __FUNCT__
257 #define __FUNCT__ "MatLUFactor_Elemental"
258 static PetscErrorCode MatLUFactor_Elemental(Mat A,IS row,IS col,const MatFactorInfo *info)
259 {
260   Mat_Elemental  *a = (Mat_Elemental*)A->data;
261 
262   PetscFunctionBegin;
263   printf("MatLUFactor_Elemental is called...\n");
264   elem::LU(*a->emat,*a->pivot);
265   PetscFunctionReturn(0);
266 }
267 
268 
269 #undef __FUNCT__
270 #define __FUNCT__ "MatGetOwnershipIS_Elemental"
271 static PetscErrorCode MatGetOwnershipIS_Elemental(Mat A,IS *rows,IS *cols)
272 {
273   Mat_Elemental  *a = (Mat_Elemental*)A->data;
274   PetscErrorCode ierr;
275   PetscInt       i,m,shift,stride,*idx;
276 
277   PetscFunctionBegin;
278   if (rows) {
279     m = a->emat->LocalHeight();
280     shift = a->emat->ColShift();
281     stride = a->emat->ColStride();
282     ierr = PetscMalloc(m*sizeof(PetscInt),&idx);CHKERRQ(ierr);
283     for (i=0; i<m; i++) {
284       PetscInt rank,offset;
285       E2RO(A,0,shift+i*stride,&rank,&offset);
286       RO2P(A,0,rank,offset,&idx[i]);
287     }
288     ierr = ISCreateGeneral(PETSC_COMM_SELF,m,idx,PETSC_OWN_POINTER,rows);CHKERRQ(ierr);
289   }
290   if (cols) {
291     m = a->emat->LocalWidth();
292     shift = a->emat->RowShift();
293     stride = a->emat->RowStride();
294     ierr = PetscMalloc(m*sizeof(PetscInt),&idx);CHKERRQ(ierr);
295     for (i=0; i<m; i++) {
296       PetscInt rank,offset;
297       E2RO(A,1,shift+i*stride,&rank,&offset);
298       RO2P(A,1,rank,offset,&idx[i]);
299     }
300     ierr = ISCreateGeneral(PETSC_COMM_SELF,m,idx,PETSC_OWN_POINTER,cols);CHKERRQ(ierr);
301   }
302   PetscFunctionReturn(0);
303 }
304 
305 #undef __FUNCT__
306 #define __FUNCT__ "MatDestroy_Elemental"
307 static PetscErrorCode MatDestroy_Elemental(Mat A)
308 {
309   Mat_Elemental  *a = (Mat_Elemental*)A->data;
310   PetscErrorCode ierr;
311 
312   PetscFunctionBegin;
313   delete a->interface;
314   delete a->esubmat;
315   delete a->emat;
316   delete a->grid;
317   /* ierr = MatStashDestroy_Private(&A->stash);CHKERRQ(ierr); */
318   ierr = PetscObjectComposeFunctionDynamic((PetscObject)A,"MatGetOwnershipIS_C","",PETSC_NULL);CHKERRQ(ierr);
319   ierr = PetscFree(A->data);CHKERRQ(ierr);
320   PetscFunctionReturn(0);
321 }
322 
323 #undef __FUNCT__
324 #define __FUNCT__ "MatSetUp_Elemental"
325 PetscErrorCode MatSetUp_Elemental(Mat A)
326 {
327   Mat_Elemental  *a = (Mat_Elemental*)A->data;
328   PetscErrorCode ierr;
329   PetscMPIInt    rsize,csize;
330 
331   PetscFunctionBegin;
332   ierr = PetscLayoutSetUp(A->rmap);CHKERRQ(ierr);
333   ierr = PetscLayoutSetUp(A->cmap);CHKERRQ(ierr);
334 
335   a->emat->ResizeTo(A->rmap->N,A->cmap->N);CHKERRQ(ierr);
336   elem::Zero(*a->emat);
337 
338   ierr = MPI_Comm_size(A->rmap->comm,&rsize);CHKERRQ(ierr);
339   ierr = MPI_Comm_size(A->cmap->comm,&csize);CHKERRQ(ierr);
340   if (csize != rsize) SETERRQ(((PetscObject)A)->comm,PETSC_ERR_ARG_INCOMP,"Cannot use row and column communicators of different sizes");
341   a->commsize = rsize;
342   a->mr[0] = A->rmap->N % rsize; if (!a->mr[0]) a->mr[0] = rsize;
343   a->mr[1] = A->cmap->N % csize; if (!a->mr[1]) a->mr[1] = csize;
344   a->m[0] = A->rmap->N / rsize + (a->mr[0] != rsize);
345   a->m[1] = A->cmap->N / csize + (a->mr[1] != csize);
346   PetscFunctionReturn(0);
347 }
348 
349 #undef __FUNCT__
350 #define __FUNCT__ "MatAssemblyBegin_Elemental"
351 PetscErrorCode MatAssemblyBegin_Elemental(Mat A, MatAssemblyType type)
352 {
353   Mat_Elemental  *a = (Mat_Elemental*)A->data;
354 
355   PetscFunctionBegin;
356   a->interface->Detach();
357   a->interface->Attach(elem::LOCAL_TO_GLOBAL,*(a->emat));
358   PetscFunctionReturn(0);
359 }
360 
361 #undef __FUNCT__
362 #define __FUNCT__ "MatAssemblyEnd_Elemental"
363 PetscErrorCode MatAssemblyEnd_Elemental(Mat A, MatAssemblyType type)
364 {
365   PetscFunctionBegin;
366   /* Currently does nothing */
367   PetscFunctionReturn(0);
368 }
369 
370 /*MC
371    MATELEMENTAL = "elemental" - A matrix type for dense matrices using the Elemental package
372 
373    Options Database Keys:
374 . -mat_type elemental - sets the matrix type to "elemental" during a call to MatSetFromOptions()
375 
376   Level: beginner
377 
378 .seealso: MATDENSE,MatCreateElemental()
379 M*/
380 EXTERN_C_BEGIN
381 #undef __FUNCT__
382 #define __FUNCT__ "MatCreate_Elemental"
383 PETSC_EXTERN_C PetscErrorCode MatCreate_Elemental(Mat A)
384 {
385   Mat_Elemental  *a;
386   PetscErrorCode ierr;
387 
388   PetscFunctionBegin;
389   ierr = PetscElementalInitializePackage(PETSC_NULL);CHKERRQ(ierr);
390 
391   ierr = PetscNewLog(A,Mat_Elemental,&a);CHKERRQ(ierr);
392   A->data = (void*)a;
393 
394   A->ops->view            = MatView_Elemental;
395   A->ops->destroy         = MatDestroy_Elemental;
396   A->ops->setup           = MatSetUp_Elemental;
397   A->ops->setvalues       = MatSetValues_Elemental;
398   A->ops->mult            = MatMult_Elemental;
399   A->ops->multadd         = MatMultAdd_Elemental;
400   A->ops->matmult         = MatMatMult_Elemental;
401   A->ops->matmultsymbolic = MatMatMultSymbolic_Elemental;
402   A->ops->matmultnumeric  = MatMatMultNumeric_Elemental;
403   A->ops->assemblybegin   = MatAssemblyBegin_Elemental;
404   A->ops->assemblyend     = MatAssemblyEnd_Elemental;
405   A->ops->scale           = MatScale_Elemental;
406   A->ops->axpy            = MatAXPY_Elemental;
407   A->ops->lufactor        = MatLUFactor_Elemental;
408   A->ops->matsolve        = MatMatSolve_Elemental;
409 
410   A->insertmode = NOT_SET_VALUES;
411 
412   /* Set up the elemental matrix */
413   elem::mpi::Comm cxxcomm(((PetscObject)A)->comm);
414   a->grid      = new elem::Grid(cxxcomm);
415   a->emat      = new elem::DistMatrix<PetscScalar>(*a->grid);
416   a->esubmat   = new elem::Matrix<PetscScalar>(1,1);
417   a->interface = new elem::AxpyInterface<PetscScalar>;
418   a->pivot     = new elem::DistMatrix<PetscInt,elem::VC,elem::STAR>;
419 
420   /* build cache for off array entries formed */
421   a->interface->Attach(elem::LOCAL_TO_GLOBAL,*(a->emat));
422   /* ierr = MatStashCreate_Private(((PetscObject)A)->comm,1,&A->stash);CHKERRQ(ierr); */
423   ierr = PetscObjectComposeFunctionDynamic((PetscObject)A,"MatGetOwnershipIS_C","MatGetOwnershipIS_Elemental",MatGetOwnershipIS_Elemental);CHKERRQ(ierr);
424 
425   ierr = PetscObjectChangeTypeName((PetscObject)A,MATELEMENTAL);CHKERRQ(ierr);
426   PetscFunctionReturn(0);
427 }
428 EXTERN_C_END
429