xref: /petsc/src/mat/impls/elemental/matelem.cxx (revision 2e7729f58b5451bb0bf4b49a70efaee73a32b7c6)
1 #include <../src/mat/impls/elemental/matelemimpl.h> /*I "petscmat.h" I*/
2 
3 /*
4     The variable Petsc_Elemental_keyval is used to indicate an MPI attribute that
5   is attached to a communicator, in this case the attribute is a Mat_Elemental_Grid
6 */
7 static PetscMPIInt Petsc_Elemental_keyval = MPI_KEYVAL_INVALID;
8 
9 #undef __FUNCT__
10 #define __FUNCT__ "PetscElementalInitializePackage"
11 /*@C
12    PetscElementalInitializePackage - Initialize Elemental package
13 
14    Logically Collective
15 
16    Input Arguments:
17 .  path - the dynamic library path or PETSC_NULL
18 
19    Level: developer
20 
21 .seealso: MATELEMENTAL, PetscElementalFinalizePackage()
22 @*/
23 PetscErrorCode PetscElementalInitializePackage(const char *path)
24 {
25   PetscErrorCode ierr;
26 
27   PetscFunctionBegin;
28   if (elem::Initialized()) PetscFunctionReturn(0);
29   { /* 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 */
30     int zero = 0;
31     char **nothing = 0;
32     elem::Initialize(zero,nothing);
33   }
34   ierr = PetscRegisterFinalize(PetscElementalFinalizePackage);CHKERRQ(ierr);
35   PetscFunctionReturn(0);
36 }
37 
38 #undef __FUNCT__
39 #define __FUNCT__ "PetscElementalFinalizePackage"
40 /*@C
41    PetscElementalFinalizePackage - Finalize Elemental package
42 
43    Logically Collective
44 
45    Level: developer
46 
47 .seealso: MATELEMENTAL, PetscElementalInitializePackage()
48 @*/
49 PetscErrorCode PetscElementalFinalizePackage(void)
50 {
51 
52   PetscFunctionBegin;
53   elem::Finalize();
54   PetscFunctionReturn(0);
55 }
56 
57 #undef __FUNCT__
58 #define __FUNCT__ "MatView_Elemental"
59 static PetscErrorCode MatView_Elemental(Mat A,PetscViewer viewer)
60 {
61   PetscErrorCode ierr;
62   Mat_Elemental  *a = (Mat_Elemental*)A->data;
63   PetscBool      iascii;
64 
65   PetscFunctionBegin;
66   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
67   if (iascii) {
68     PetscViewerFormat format;
69     ierr = PetscViewerGetFormat(viewer,&format);CHKERRQ(ierr);
70     if (format == PETSC_VIEWER_ASCII_INFO) {
71       /* call elemental viewing function */
72       ierr = PetscPrintf(((PetscObject)viewer)->comm,"allocated entries=%d\n",(*a->emat).AllocatedMemory());CHKERRQ(ierr);
73       ierr = PetscPrintf(((PetscObject)viewer)->comm,"grid height=%d, grid width=%d\n",(*a->emat).Grid().Height(),(*a->emat).Grid().Width());CHKERRQ(ierr);
74       if (format == PETSC_VIEWER_ASCII_FACTOR_INFO) {
75         /* call elemental viewing function */
76         ierr = PetscPrintf(((PetscObject)viewer)->comm,"test matview_elemental 2\n");CHKERRQ(ierr);
77       }
78 
79     } else if (format == PETSC_VIEWER_DEFAULT) {
80       Mat Aaij;
81       ierr = PetscViewerASCIIUseTabs(viewer,PETSC_FALSE);CHKERRQ(ierr);
82       ierr = PetscObjectPrintClassNamePrefixType((PetscObject)A,viewer,"Matrix Object");CHKERRQ(ierr);
83       a->emat->Print("Elemental matrix (cyclic ordering)");
84       ierr = PetscViewerASCIIUseTabs(viewer,PETSC_TRUE);CHKERRQ(ierr);
85       if (A->factortype == MAT_FACTOR_NONE){
86         ierr = PetscPrintf(((PetscObject)viewer)->comm,"Elemental matrix (explicit ordering)\n");CHKERRQ(ierr);
87         ierr = MatComputeExplicitOperator(A,&Aaij);CHKERRQ(ierr);
88         ierr = MatView(Aaij,PETSC_VIEWER_STDOUT_WORLD);CHKERRQ(ierr);
89         ierr = MatDestroy(&Aaij);CHKERRQ(ierr);
90       }
91     } else SETERRQ(((PetscObject)viewer)->comm,PETSC_ERR_SUP,"Format");
92   } else SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Viewer type %s not supported by Elemental matrices",((PetscObject)viewer)->type_name);
93   PetscFunctionReturn(0);
94 }
95 
96 #undef __FUNCT__
97 #define __FUNCT__ "MatGetInfo_Elemental"
98 static PetscErrorCode MatGetInfo_Elemental(Mat F,MatInfoType flag,MatInfo *info)
99 {
100   PetscFunctionBegin;
101   /* this routine is called by PCSetUp_LU(). It does nothing yet. */
102   PetscFunctionReturn(0);
103 }
104 
105 #undef __FUNCT__
106 #define __FUNCT__ "MatSetValues_Elemental"
107 static PetscErrorCode MatSetValues_Elemental(Mat A,PetscInt nr,const PetscInt *rows,PetscInt nc,const PetscInt *cols,const PetscScalar *vals,InsertMode imode)
108 {
109   PetscErrorCode ierr;
110   Mat_Elemental  *a = (Mat_Elemental*)A->data;
111   PetscMPIInt    rank;
112   PetscInt       i,j,rrank,ridx,crank,cidx;
113 
114   PetscFunctionBegin;
115   ierr = MPI_Comm_rank(((PetscObject)A)->comm,&rank);CHKERRQ(ierr);
116 
117   const elem::Grid &grid = a->emat->Grid();
118   for (i=0; i<nr; i++) {
119     PetscInt erow,ecol,elrow,elcol;
120     if (rows[i] < 0) continue;
121     P2RO(A,0,rows[i],&rrank,&ridx);
122     RO2E(A,0,rrank,ridx,&erow);
123     if (rrank < 0 || ridx < 0 || erow < 0) SETERRQ(((PetscObject)A)->comm,PETSC_ERR_PLIB,"Incorrect row translation");
124     for (j=0; j<nc; j++) {
125       if (cols[j] < 0) continue;
126       P2RO(A,1,cols[j],&crank,&cidx);
127       RO2E(A,1,crank,cidx,&ecol);
128       if (crank < 0 || cidx < 0 || ecol < 0) SETERRQ(((PetscObject)A)->comm,PETSC_ERR_PLIB,"Incorrect col translation");
129       if (erow % grid.MCSize() != grid.MCRank() || ecol % grid.MRSize() != grid.MRRank()){ /* off-proc entry */
130         if (imode != ADD_VALUES) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"Only ADD_VALUES to off-processor entry is supported");
131         /* 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); */
132         a->esubmat->Set(0,0, vals[i*nc+j]);
133         a->interface->Axpy(1.0,*(a->esubmat),erow,ecol);
134         continue;
135       }
136       elrow = erow / grid.MCSize();
137       elcol = ecol / grid.MRSize();
138       switch (imode) {
139       case INSERT_VALUES: a->emat->SetLocal(elrow,elcol,vals[i*nc+j]); break;
140       case ADD_VALUES: a->emat->UpdateLocal(elrow,elcol,vals[i*nc+j]); break;
141       default: SETERRQ1(((PetscObject)A)->comm,PETSC_ERR_SUP,"No support for InsertMode %d",(int)imode);
142       }
143     }
144   }
145   PetscFunctionReturn(0);
146 }
147 
148 #undef __FUNCT__
149 #define __FUNCT__ "MatMult_Elemental"
150 static PetscErrorCode MatMult_Elemental(Mat A,Vec X,Vec Y)
151 {
152   Mat_Elemental     *a = (Mat_Elemental*)A->data;
153   PetscErrorCode    ierr;
154   const PetscScalar *x;
155   PetscScalar       *y;
156   PetscScalar       one = 1,zero = 0;
157 
158   PetscFunctionBegin;
159   ierr = VecGetArrayRead(X,&x);CHKERRQ(ierr);
160   ierr = VecGetArray(Y,&y);CHKERRQ(ierr);
161   { /* Scoping so that constructor is called before pointer is returned */
162     elem::DistMatrix<PetscScalar,elem::VC,elem::STAR> xe(A->cmap->N,1,0,x,A->cmap->n,*a->grid);
163     elem::DistMatrix<PetscScalar,elem::VC,elem::STAR> ye(A->rmap->N,1,0,y,A->rmap->n,*a->grid);
164     elem::Gemv(elem::NORMAL,one,*a->emat,xe,zero,ye);
165   }
166   ierr = VecRestoreArrayRead(X,&x);CHKERRQ(ierr);
167   ierr = VecRestoreArray(Y,&y);CHKERRQ(ierr);
168   PetscFunctionReturn(0);
169 }
170 
171 #undef __FUNCT__
172 #define __FUNCT__ "MatMultAdd_Elemental"
173 static PetscErrorCode MatMultAdd_Elemental(Mat A,Vec X,Vec Y,Vec Z)
174 {
175   Mat_Elemental     *a = (Mat_Elemental*)A->data;
176   PetscErrorCode    ierr;
177   const PetscScalar *x;
178   PetscScalar       *z;
179   PetscScalar       one = 1.0;
180 
181   PetscFunctionBegin;
182   if (Y != Z) {ierr = VecCopy(Y,Z);CHKERRQ(ierr);}
183   ierr = VecGetArrayRead(X,&x);CHKERRQ(ierr);
184   ierr = VecGetArray(Z,&z);CHKERRQ(ierr);
185   { /* Scoping so that constructor is called before pointer is returned */
186     elem::DistMatrix<PetscScalar,elem::VC,elem::STAR> xe(A->cmap->N,1,0,x,A->cmap->n,*a->grid);
187     elem::DistMatrix<PetscScalar,elem::VC,elem::STAR> ze(A->rmap->N,1,0,z,A->rmap->n,*a->grid);
188     elem::Gemv(elem::NORMAL,one,*a->emat,xe,one,ze);
189   }
190   ierr = VecRestoreArrayRead(X,&x);CHKERRQ(ierr);
191   ierr = VecRestoreArray(Z,&z);CHKERRQ(ierr);
192   PetscFunctionReturn(0);
193 }
194 
195 #undef __FUNCT__
196 #define __FUNCT__ "MatMatMultNumeric_Elemental"
197 static PetscErrorCode MatMatMultNumeric_Elemental(Mat A,Mat B,Mat C)
198 {
199   Mat_Elemental  *a = (Mat_Elemental*)A->data;
200   Mat_Elemental  *b = (Mat_Elemental*)B->data;
201   Mat_Elemental  *c = (Mat_Elemental*)C->data;
202   PetscScalar    one = 1.0,zero = 0.0;
203 
204   PetscFunctionBegin;
205   { /* Scoping so that constructor is called before pointer is returned */
206     elem::Gemm(elem::NORMAL,elem::NORMAL,one,*a->emat,*b->emat,zero,*c->emat);
207   }
208   C->assembled = PETSC_TRUE;
209   PetscFunctionReturn(0);
210 }
211 
212 #undef __FUNCT__
213 #define __FUNCT__ "MatMatMultSymbolic_Elemental"
214 static PetscErrorCode MatMatMultSymbolic_Elemental(Mat A,Mat B,PetscReal fill,Mat *C)
215 {
216   PetscErrorCode ierr;
217   Mat            Ce;
218   MPI_Comm       comm=((PetscObject)A)->comm;
219 
220   PetscFunctionBegin;
221   ierr = MatCreate(comm,&Ce);CHKERRQ(ierr);
222   ierr = MatSetSizes(Ce,A->rmap->n,B->cmap->n,PETSC_DECIDE,PETSC_DECIDE);CHKERRQ(ierr);
223   ierr = MatSetType(Ce,MATELEMENTAL);CHKERRQ(ierr);
224   ierr = MatSetUp(Ce);CHKERRQ(ierr);
225   *C = Ce;
226   PetscFunctionReturn(0);
227 }
228 
229 #undef __FUNCT__
230 #define __FUNCT__ "MatMatMult_Elemental"
231 static PetscErrorCode MatMatMult_Elemental(Mat A,Mat B,MatReuse scall,PetscReal fill,Mat *C)
232 {
233   PetscErrorCode ierr;
234 
235   PetscFunctionBegin;
236   if (scall == MAT_INITIAL_MATRIX){
237     ierr = PetscLogEventBegin(MAT_MatMultSymbolic,A,B,0,0);CHKERRQ(ierr);
238     ierr = MatMatMultSymbolic_Elemental(A,B,1.0,C);CHKERRQ(ierr);
239     ierr = PetscLogEventEnd(MAT_MatMultSymbolic,A,B,0,0);CHKERRQ(ierr);
240   }
241   ierr = PetscLogEventBegin(MAT_MatMultNumeric,A,B,0,0);CHKERRQ(ierr);
242   ierr = MatMatMultNumeric_Elemental(A,B,*C);CHKERRQ(ierr);
243   ierr = PetscLogEventEnd(MAT_MatMultNumeric,A,B,0,0);CHKERRQ(ierr);
244   PetscFunctionReturn(0);
245 }
246 
247 #undef __FUNCT__
248 #define __FUNCT__ "MatScale_Elemental"
249 static PetscErrorCode MatScale_Elemental(Mat X,PetscScalar a)
250 {
251   Mat_Elemental  *x = (Mat_Elemental*)X->data;
252 
253   PetscFunctionBegin;
254   elem::Scal(a,*x->emat);
255   PetscFunctionReturn(0);
256 }
257 
258 #undef __FUNCT__
259 #define __FUNCT__ "MatAXPY_Elemental"
260 static PetscErrorCode MatAXPY_Elemental(Mat Y,PetscScalar a,Mat X,MatStructure str)
261 {
262   Mat_Elemental  *x = (Mat_Elemental*)X->data;
263   Mat_Elemental  *y = (Mat_Elemental*)Y->data;
264 
265   PetscFunctionBegin;
266   elem::Axpy(a,*x->emat,*y->emat);
267   PetscFunctionReturn(0);
268 }
269 
270 #undef __FUNCT__
271 #define __FUNCT__ "MatCopy_Elemental"
272 static PetscErrorCode MatCopy_Elemental(Mat A,Mat B,MatStructure str)
273 {
274   Mat_Elemental *a=(Mat_Elemental*)A->data;
275   Mat_Elemental *b=(Mat_Elemental*)B->data;
276 
277   PetscFunctionBegin;
278   elem::Copy(*a->emat,*b->emat);
279   PetscFunctionReturn(0);
280 }
281 
282 #undef __FUNCT__
283 #define __FUNCT__ "MatTranspose_Elemental"
284 static PetscErrorCode MatTranspose_Elemental(Mat A,MatReuse reuse,Mat *B)
285 {
286   /* Only out-of-place supported */
287   Mat            Be;
288   PetscErrorCode ierr;
289   MPI_Comm       comm=((PetscObject)A)->comm;
290   Mat_Elemental  *a = (Mat_Elemental*)A->data, *b;
291 
292   PetscFunctionBegin;
293   if (reuse == MAT_INITIAL_MATRIX){
294     ierr = MatCreate(comm,&Be);CHKERRQ(ierr);
295     ierr = MatSetSizes(Be,A->cmap->n,A->rmap->n,PETSC_DECIDE,PETSC_DECIDE);CHKERRQ(ierr);
296     ierr = MatSetType(Be,MATELEMENTAL);CHKERRQ(ierr);
297     ierr = MatSetUp(Be);CHKERRQ(ierr);
298     *B = Be;
299   }
300   b = (Mat_Elemental*)Be->data;
301   elem::Transpose(*a->emat,*b->emat);
302   Be->assembled = PETSC_TRUE;
303   PetscFunctionReturn(0);
304 }
305 
306 #undef __FUNCT__
307 #define __FUNCT__ "MatSolve_Elemental"
308 static PetscErrorCode MatSolve_Elemental(Mat A,Vec B,Vec X)
309 {
310   Mat_Elemental     *a = (Mat_Elemental*)A->data;
311   PetscErrorCode    ierr;
312   PetscScalar       *x;
313 
314   PetscFunctionBegin;
315   ierr = VecCopy(B,X);CHKERRQ(ierr);
316   ierr = VecGetArray(X,&x);CHKERRQ(ierr);
317   elem::DistMatrix<PetscScalar,elem::VC,elem::STAR> xe(A->rmap->N,1,0,x,A->rmap->n,*a->grid);
318   elem::DistMatrix<PetscScalar,elem::MC,elem::MR> xer = xe;
319   switch (A->factortype) {
320   case MAT_FACTOR_LU:
321     if ((*a->pivot).AllocatedMemory()) {
322       elem::SolveAfterLU(elem::NORMAL,*a->emat,*a->pivot,xer);
323       elem::Copy(xer,xe);
324     } else {
325       elem::SolveAfterLU(elem::NORMAL,*a->emat,xer);
326       elem::Copy(xer,xe);
327     }
328     break;
329   case MAT_FACTOR_CHOLESKY:
330     elem::SolveAfterCholesky(elem::UPPER,elem::NORMAL,*a->emat,xer);
331     elem::Copy(xer,xe);
332     break;
333   default:
334     SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"Unfactored Matrix or Unsupported MatFactorType");
335     break;
336   }
337   ierr = VecRestoreArray(X,&x);CHKERRQ(ierr);
338   PetscFunctionReturn(0);
339 }
340 
341 #undef __FUNCT__
342 #define __FUNCT__ "MatMatSolve_Elemental"
343 static PetscErrorCode MatMatSolve_Elemental(Mat A,Mat B,Mat X)
344 {
345   Mat_Elemental *a=(Mat_Elemental*)A->data;
346   Mat_Elemental *b=(Mat_Elemental*)B->data;
347   Mat_Elemental *x=(Mat_Elemental*)X->data;
348 
349   PetscFunctionBegin;
350   elem::Copy(*b->emat,*x->emat);
351   switch (A->factortype) {
352   case MAT_FACTOR_LU:
353     if ((*a->pivot).AllocatedMemory()) {
354       elem::SolveAfterLU(elem::NORMAL,*a->emat,*a->pivot,*x->emat);
355     } else {
356       elem::SolveAfterLU(elem::NORMAL,*a->emat,*x->emat);
357     }
358     break;
359   case MAT_FACTOR_CHOLESKY:
360     elem::SolveAfterCholesky(elem::UPPER,elem::NORMAL,*a->emat,*x->emat);
361     break;
362   default:
363     SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"Unfactored Matrix or Unsupported MatFactorType");
364     break;
365   }
366   PetscFunctionReturn(0);
367 }
368 
369 #undef __FUNCT__
370 #define __FUNCT__ "MatLUFactor_Elemental"
371 static PetscErrorCode MatLUFactor_Elemental(Mat A,IS row,IS col,const MatFactorInfo *info)
372 {
373   Mat_Elemental  *a = (Mat_Elemental*)A->data;
374 
375   PetscFunctionBegin;
376   if (info->dtcol){
377     elem::LU(*a->emat,*a->pivot);
378   } else {
379     elem::LU(*a->emat);
380   }
381   A->factortype = MAT_FACTOR_LU;
382   A->assembled  = PETSC_TRUE;
383   PetscFunctionReturn(0);
384 }
385 
386 #undef __FUNCT__
387 #define __FUNCT__ "MatLUFactorNumeric_Elemental"
388 static PetscErrorCode  MatLUFactorNumeric_Elemental(Mat F,Mat A,const MatFactorInfo *info)
389 {
390   PetscErrorCode ierr;
391 
392   PetscFunctionBegin;
393   ierr = MatCopy(A,F,SAME_NONZERO_PATTERN);CHKERRQ(ierr);
394   ierr = MatLUFactor_Elemental(F,0,0,info);CHKERRQ(ierr);
395   PetscFunctionReturn(0);
396 }
397 
398 #undef __FUNCT__
399 #define __FUNCT__ "MatLUFactorSymbolic_Elemental"
400 static PetscErrorCode  MatLUFactorSymbolic_Elemental(Mat F,Mat A,IS r,IS c,const MatFactorInfo *info)
401 {
402   PetscFunctionBegin;
403   /* F is create and allocated by MatGetFactor_elemental_petsc(), skip this routine. */
404   PetscFunctionReturn(0);
405 }
406 
407 #undef __FUNCT__
408 #define __FUNCT__ "MatCholeskyFactor_Elemental"
409 static PetscErrorCode MatCholeskyFactor_Elemental(Mat A,IS perm,const MatFactorInfo *info)
410 {
411   Mat_Elemental  *a = (Mat_Elemental*)A->data;
412   elem::DistMatrix<PetscScalar,elem::MC,elem::STAR> d;
413 
414   PetscFunctionBegin;
415   elem::Cholesky(elem::UPPER,*a->emat);
416   // if (info->dtcol){
417   //   /* A = U^T * U for SPD Matrix A */
418   //   printf("Cholesky Factorization for SPD Matrices...\n");
419   //   elem::Cholesky(elem::UPPER,*a->emat);
420   // } else {
421   //   /* A = U^T * D * U * for Symmetric Matrix A */
422   //   printf("LDL^T Factorization for Symmetric Matrices.\n");
423   //   printf("This routine does not pivot. Use with caution.\n");
424   //   elem::LDLT(*a->emat,d);
425   // }
426   A->factortype = MAT_FACTOR_CHOLESKY;
427   A->assembled  = PETSC_TRUE;
428   PetscFunctionReturn(0);
429 }
430 
431 #undef __FUNCT__
432 #define __FUNCT__ "MatCholeskyFactorNumeric_Elemental"
433 static PetscErrorCode MatCholeskyFactorNumeric_Elemental(Mat F,Mat A,const MatFactorInfo *info)
434 {
435   PetscErrorCode ierr;
436 
437   PetscFunctionBegin;
438   ierr = MatCopy(A,F,SAME_NONZERO_PATTERN);CHKERRQ(ierr);
439   ierr = MatCholeskyFactor_Elemental(F,0,info);CHKERRQ(ierr);
440   PetscFunctionReturn(0);
441 }
442 
443 #undef __FUNCT__
444 #define __FUNCT__ "MatCholeskyFactorSymbolic_Elemental"
445 static PetscErrorCode MatCholeskyFactorSymbolic_Elemental(Mat F,Mat A,IS perm,const MatFactorInfo *info)
446 {
447   PetscFunctionBegin;
448   /* F is create and allocated by MatGetFactor_elemental_petsc(), skip this routine. */
449   PetscFunctionReturn(0);
450 }
451 
452 EXTERN_C_BEGIN
453 #undef __FUNCT__
454 #define __FUNCT__ "MatGetFactor_elemental_petsc"
455 static PetscErrorCode MatGetFactor_elemental_petsc(Mat A,MatFactorType ftype,Mat *F)
456 {
457   Mat            B;
458   PetscErrorCode ierr;
459 
460   PetscFunctionBegin;
461   /* Create the factorization matrix */
462   ierr = MatCreate(((PetscObject)A)->comm,&B);CHKERRQ(ierr);
463   ierr = MatSetSizes(B,A->rmap->n,A->cmap->n,PETSC_DECIDE,PETSC_DECIDE);CHKERRQ(ierr);
464   ierr = MatSetType(B,MATELEMENTAL);CHKERRQ(ierr);
465   ierr = MatSetUp(B);CHKERRQ(ierr);
466   B->factortype = ftype;
467   *F            = B;
468   PetscFunctionReturn(0);
469 }
470 EXTERN_C_END
471 
472 #undef __FUNCT__
473 #define __FUNCT__ "MatNorm_Elemental"
474 static PetscErrorCode MatNorm_Elemental(Mat A,NormType type,PetscReal *nrm)
475 {
476   Mat_Elemental *a=(Mat_Elemental*)A->data;
477 
478   PetscFunctionBegin;
479   switch (type){
480   case NORM_1:
481     *nrm = elem::Norm(*a->emat,elem::ONE_NORM);
482     break;
483   case NORM_FROBENIUS:
484     *nrm = elem::Norm(*a->emat,elem::FROBENIUS_NORM);
485     break;
486   case NORM_INFINITY:
487     *nrm = elem::Norm(*a->emat,elem::INFINITY_NORM);
488     break;
489   default:
490     printf("Error: unsupported norm type!\n");
491   }
492   PetscFunctionReturn(0);
493 }
494 
495 #undef __FUNCT__
496 #define __FUNCT__ "MatZeroEntries_Elemental"
497 static PetscErrorCode MatZeroEntries_Elemental(Mat A)
498 {
499   Mat_Elemental *a=(Mat_Elemental*)A->data;
500 
501   PetscFunctionBegin;
502   elem::Zero(*a->emat);
503   PetscFunctionReturn(0);
504 }
505 
506 EXTERN_C_BEGIN
507 #undef __FUNCT__
508 #define __FUNCT__ "MatGetOwnershipIS_Elemental"
509 static PetscErrorCode MatGetOwnershipIS_Elemental(Mat A,IS *rows,IS *cols)
510 {
511   Mat_Elemental  *a = (Mat_Elemental*)A->data;
512   PetscErrorCode ierr;
513   PetscInt       i,m,shift,stride,*idx;
514 
515   PetscFunctionBegin;
516   if (rows) {
517     m = a->emat->LocalHeight();
518     shift = a->emat->ColShift();
519     stride = a->emat->ColStride();
520     ierr = PetscMalloc(m*sizeof(PetscInt),&idx);CHKERRQ(ierr);
521     for (i=0; i<m; i++) {
522       PetscInt rank,offset;
523       E2RO(A,0,shift+i*stride,&rank,&offset);
524       RO2P(A,0,rank,offset,&idx[i]);
525     }
526     ierr = ISCreateGeneral(PETSC_COMM_SELF,m,idx,PETSC_OWN_POINTER,rows);CHKERRQ(ierr);
527   }
528   if (cols) {
529     m = a->emat->LocalWidth();
530     shift = a->emat->RowShift();
531     stride = a->emat->RowStride();
532     ierr = PetscMalloc(m*sizeof(PetscInt),&idx);CHKERRQ(ierr);
533     for (i=0; i<m; i++) {
534       PetscInt rank,offset;
535       E2RO(A,1,shift+i*stride,&rank,&offset);
536       RO2P(A,1,rank,offset,&idx[i]);
537     }
538     ierr = ISCreateGeneral(PETSC_COMM_SELF,m,idx,PETSC_OWN_POINTER,cols);CHKERRQ(ierr);
539   }
540   PetscFunctionReturn(0);
541 }
542 EXTERN_C_END
543 
544 #undef __FUNCT__
545 #define __FUNCT__ "MatDestroy_Elemental"
546 static PetscErrorCode MatDestroy_Elemental(Mat A)
547 {
548   Mat_Elemental      *a = (Mat_Elemental*)A->data;
549   PetscErrorCode     ierr;
550   Mat_Elemental_Grid *commgrid;
551   PetscBool          flg;
552   MPI_Comm           icomm;
553 
554   PetscFunctionBegin;
555   delete a->interface;
556   delete a->esubmat;
557   delete a->emat;
558 
559   elem::mpi::Comm cxxcomm(((PetscObject)A)->comm);
560   ierr = PetscCommDuplicate(cxxcomm,&icomm,PETSC_NULL);CHKERRQ(ierr);
561   ierr = MPI_Attr_get(icomm,Petsc_Elemental_keyval,(void**)&commgrid,(int*)&flg);CHKERRQ(ierr);
562   if (--commgrid->grid_refct == 0) {
563     delete commgrid->grid;
564     ierr = PetscFree(commgrid);CHKERRQ(ierr);
565   }
566   ierr = PetscCommDestroy(&icomm);CHKERRQ(ierr);
567   ierr = PetscObjectComposeFunctionDynamic((PetscObject)A,"MatGetOwnershipIS_C","",PETSC_NULL);CHKERRQ(ierr);
568   ierr = PetscObjectComposeFunctionDynamic((PetscObject)A,"MatGetFactor_petsc_C","",PETSC_NULL);CHKERRQ(ierr);
569   ierr = PetscFree(A->data);CHKERRQ(ierr);
570   PetscFunctionReturn(0);
571 }
572 
573 #undef __FUNCT__
574 #define __FUNCT__ "MatSetUp_Elemental"
575 PetscErrorCode MatSetUp_Elemental(Mat A)
576 {
577   Mat_Elemental  *a = (Mat_Elemental*)A->data;
578   PetscErrorCode ierr;
579   PetscMPIInt    rsize,csize;
580 
581   PetscFunctionBegin;
582   ierr = PetscLayoutSetUp(A->rmap);CHKERRQ(ierr);
583   ierr = PetscLayoutSetUp(A->cmap);CHKERRQ(ierr);
584 
585   a->emat->ResizeTo(A->rmap->N,A->cmap->N);CHKERRQ(ierr);
586   elem::Zero(*a->emat);
587 
588   ierr = MPI_Comm_size(A->rmap->comm,&rsize);CHKERRQ(ierr);
589   ierr = MPI_Comm_size(A->cmap->comm,&csize);CHKERRQ(ierr);
590   if (csize != rsize) SETERRQ(((PetscObject)A)->comm,PETSC_ERR_ARG_INCOMP,"Cannot use row and column communicators of different sizes");
591   a->commsize = rsize;
592   a->mr[0] = A->rmap->N % rsize; if (!a->mr[0]) a->mr[0] = rsize;
593   a->mr[1] = A->cmap->N % csize; if (!a->mr[1]) a->mr[1] = csize;
594   a->m[0] = A->rmap->N / rsize + (a->mr[0] != rsize);
595   a->m[1] = A->cmap->N / csize + (a->mr[1] != csize);
596   PetscFunctionReturn(0);
597 }
598 
599 #undef __FUNCT__
600 #define __FUNCT__ "MatAssemblyBegin_Elemental"
601 PetscErrorCode MatAssemblyBegin_Elemental(Mat A, MatAssemblyType type)
602 {
603   Mat_Elemental  *a = (Mat_Elemental*)A->data;
604 
605   PetscFunctionBegin;
606   a->interface->Detach();
607   a->interface->Attach(elem::LOCAL_TO_GLOBAL,*(a->emat));
608   PetscFunctionReturn(0);
609 }
610 
611 #undef __FUNCT__
612 #define __FUNCT__ "MatAssemblyEnd_Elemental"
613 PetscErrorCode MatAssemblyEnd_Elemental(Mat A, MatAssemblyType type)
614 {
615   PetscFunctionBegin;
616   /* Currently does nothing */
617   PetscFunctionReturn(0);
618 }
619 
620 /*MC
621    MATELEMENTAL = "elemental" - A matrix type for dense matrices using the Elemental package
622 
623    Options Database Keys:
624 . -mat_type elemental - sets the matrix type to "elemental" during a call to MatSetFromOptions()
625 
626   Level: beginner
627 
628 .seealso: MATDENSE,MatCreateElemental()
629 M*/
630 EXTERN_C_BEGIN
631 #undef __FUNCT__
632 #define __FUNCT__ "MatCreate_Elemental"
633 PETSC_EXTERN_C PetscErrorCode MatCreate_Elemental(Mat A)
634 {
635   Mat_Elemental      *a;
636   PetscErrorCode     ierr;
637   PetscBool          flg;
638   Mat_Elemental_Grid *commgrid;
639   MPI_Comm           icomm;
640 
641   PetscFunctionBegin;
642   ierr = PetscElementalInitializePackage(PETSC_NULL);CHKERRQ(ierr);
643 
644   ierr = PetscNewLog(A,Mat_Elemental,&a);CHKERRQ(ierr);
645   A->data = (void*)a;
646 
647   A->ops->getinfo         = MatGetInfo_Elemental;
648   A->ops->view            = MatView_Elemental;
649   A->ops->destroy         = MatDestroy_Elemental;
650   A->ops->setup           = MatSetUp_Elemental;
651   A->ops->setvalues       = MatSetValues_Elemental;
652   A->ops->mult            = MatMult_Elemental;
653   A->ops->multadd         = MatMultAdd_Elemental;
654   A->ops->matmult         = MatMatMult_Elemental;
655   A->ops->matmultsymbolic = MatMatMultSymbolic_Elemental;
656   A->ops->matmultnumeric  = MatMatMultNumeric_Elemental;
657   A->ops->assemblybegin   = MatAssemblyBegin_Elemental;
658   A->ops->assemblyend     = MatAssemblyEnd_Elemental;
659   A->ops->scale           = MatScale_Elemental;
660   A->ops->axpy            = MatAXPY_Elemental;
661   A->ops->lufactor        = MatLUFactor_Elemental;
662   A->ops->lufactorsymbolic = MatLUFactorSymbolic_Elemental;
663   A->ops->lufactornumeric  = MatLUFactorNumeric_Elemental;
664   A->ops->matsolve        = MatMatSolve_Elemental;
665   A->ops->copy            = MatCopy_Elemental;
666   A->ops->transpose       = MatTranspose_Elemental;
667   A->ops->norm            = MatNorm_Elemental;
668   A->ops->solve           = MatSolve_Elemental;
669   A->ops->zeroentries     = MatZeroEntries_Elemental;
670   A->ops->choleskyfactor  = MatCholeskyFactor_Elemental;
671   A->ops->choleskyfactorsymbolic = MatCholeskyFactorSymbolic_Elemental;
672   A->ops->choleskyfactornumeric  = MatCholeskyFactorNumeric_Elemental;
673 
674   A->insertmode = NOT_SET_VALUES;
675 
676   /* Set up the elemental matrix */
677   elem::mpi::Comm cxxcomm(((PetscObject)A)->comm);
678 
679   /* Grid needs to be shared between multiple Mats on the same communicator, implement by attribute caching on the MPI_Comm */
680   if (Petsc_Elemental_keyval == MPI_KEYVAL_INVALID) {
681     ierr = MPI_Keyval_create(MPI_NULL_COPY_FN,MPI_NULL_DELETE_FN,&Petsc_Elemental_keyval,(void*)0);
682   }
683   ierr = PetscCommDuplicate(cxxcomm,&icomm,PETSC_NULL);CHKERRQ(ierr);
684   ierr = MPI_Attr_get(icomm,Petsc_Elemental_keyval,(void**)&commgrid,(int*)&flg);CHKERRQ(ierr);
685   if (!flg) {
686     ierr = PetscNewLog(A,Mat_Elemental_Grid,&commgrid);CHKERRQ(ierr);
687     commgrid->grid       = new elem::Grid(cxxcomm);
688     commgrid->grid_refct = 1;
689     ierr = MPI_Attr_put(icomm,Petsc_Elemental_keyval,(void*)commgrid);CHKERRQ(ierr);
690   } else {
691     commgrid->grid_refct++;
692   }
693   ierr = PetscCommDestroy(&icomm);CHKERRQ(ierr);
694   a->grid      = commgrid->grid;
695   a->emat      = new elem::DistMatrix<PetscScalar>(*a->grid);
696   a->esubmat   = new elem::Matrix<PetscScalar>(1,1);
697   a->interface = new elem::AxpyInterface<PetscScalar>;
698   a->pivot     = new elem::DistMatrix<PetscInt,elem::VC,elem::STAR>;
699 
700   /* build cache for off array entries formed */
701   a->interface->Attach(elem::LOCAL_TO_GLOBAL,*(a->emat));
702 
703   ierr = PetscObjectComposeFunctionDynamic((PetscObject)A,"MatGetOwnershipIS_C","MatGetOwnershipIS_Elemental",MatGetOwnershipIS_Elemental);CHKERRQ(ierr);
704   ierr = PetscObjectComposeFunctionDynamic((PetscObject)A,"MatGetFactor_petsc_C","MatGetFactor_elemental_petsc",MatGetFactor_elemental_petsc);CHKERRQ(ierr);
705 
706   ierr = PetscObjectChangeTypeName((PetscObject)A,MATELEMENTAL);CHKERRQ(ierr);
707   PetscFunctionReturn(0);
708 }
709 EXTERN_C_END
710