xref: /petsc/src/mat/impls/elemental/matelem.cxx (revision aae2c449111df2ee20d5b6cfea43965edeaff6d5)
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__ "MatMatMult_Elemental"
168 static PetscErrorCode MatMatMult_Elemental(Mat A,Mat B,MatReuse scall,PetscReal fill,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   PetscFunctionReturn(0);
180 }
181 
182 #undef __FUNCT__
183 #define __FUNCT__ "MatGetOwnershipIS_Elemental"
184 static PetscErrorCode MatGetOwnershipIS_Elemental(Mat A,IS *rows,IS *cols)
185 {
186   Mat_Elemental  *a = (Mat_Elemental*)A->data;
187   PetscErrorCode ierr;
188   PetscInt       i,m,shift,stride,*idx;
189 
190   PetscFunctionBegin;
191   if (rows) {
192     m = a->emat->LocalHeight();
193     shift = a->emat->ColShift();
194     stride = a->emat->ColStride();
195     ierr = PetscMalloc(m*sizeof(PetscInt),&idx);CHKERRQ(ierr);
196     for (i=0; i<m; i++) {
197       PetscInt rank,offset;
198       E2RO(A,0,shift+i*stride,&rank,&offset);
199       RO2P(A,0,rank,offset,&idx[i]);
200     }
201     ierr = ISCreateGeneral(PETSC_COMM_SELF,m,idx,PETSC_OWN_POINTER,rows);CHKERRQ(ierr);
202   }
203   if (cols) {
204     m = a->emat->LocalWidth();
205     shift = a->emat->RowShift();
206     stride = a->emat->RowStride();
207     ierr = PetscMalloc(m*sizeof(PetscInt),&idx);CHKERRQ(ierr);
208     for (i=0; i<m; i++) {
209       PetscInt rank,offset;
210       E2RO(A,1,shift+i*stride,&rank,&offset);
211       RO2P(A,1,rank,offset,&idx[i]);
212     }
213     ierr = ISCreateGeneral(PETSC_COMM_SELF,m,idx,PETSC_OWN_POINTER,cols);CHKERRQ(ierr);
214   }
215   PetscFunctionReturn(0);
216 }
217 
218 #undef __FUNCT__
219 #define __FUNCT__ "MatDestroy_Elemental"
220 static PetscErrorCode MatDestroy_Elemental(Mat A)
221 {
222   Mat_Elemental  *a = (Mat_Elemental*)A->data;
223   PetscErrorCode ierr;
224 
225   PetscFunctionBegin;
226   delete a->interface;
227   delete a->esubmat;
228   delete a->emat;
229   delete a->grid;
230   /* ierr = MatStashDestroy_Private(&A->stash);CHKERRQ(ierr); */
231   ierr = PetscObjectComposeFunctionDynamic((PetscObject)A,"MatGetOwnershipIS_C","",PETSC_NULL);CHKERRQ(ierr);
232   ierr = PetscFree(A->data);CHKERRQ(ierr);
233   PetscFunctionReturn(0);
234 }
235 
236 #undef __FUNCT__
237 #define __FUNCT__ "MatSetUp_Elemental"
238 PetscErrorCode MatSetUp_Elemental(Mat A)
239 {
240   Mat_Elemental  *a = (Mat_Elemental*)A->data;
241   PetscErrorCode ierr;
242   PetscMPIInt    rsize,csize;
243 
244   PetscFunctionBegin;
245   ierr = PetscLayoutSetUp(A->rmap);CHKERRQ(ierr);
246   ierr = PetscLayoutSetUp(A->cmap);CHKERRQ(ierr);
247 
248   a->emat->ResizeTo(A->rmap->N,A->cmap->N);CHKERRQ(ierr);
249   elem::Zero(*a->emat);
250 
251   ierr = MPI_Comm_size(A->rmap->comm,&rsize);CHKERRQ(ierr);
252   ierr = MPI_Comm_size(A->cmap->comm,&csize);CHKERRQ(ierr);
253   if (csize != rsize) SETERRQ(((PetscObject)A)->comm,PETSC_ERR_ARG_INCOMP,"Cannot use row and column communicators of different sizes");
254   a->commsize = rsize;
255   a->mr[0] = A->rmap->N % rsize; if (!a->mr[0]) a->mr[0] = rsize;
256   a->mr[1] = A->cmap->N % csize; if (!a->mr[1]) a->mr[1] = csize;
257   a->m[0] = A->rmap->N / rsize + (a->mr[0] != rsize);
258   a->m[1] = A->cmap->N / csize + (a->mr[1] != csize);
259   PetscFunctionReturn(0);
260 }
261 
262 #undef __FUNCT__
263 #define __FUNCT__ "MatAssemblyBegin_Elemental"
264 PetscErrorCode MatAssemblyBegin_Elemental(Mat A, MatAssemblyType type)
265 {
266   Mat_Elemental  *a = (Mat_Elemental*)A->data;
267 
268   PetscFunctionBegin;
269   a->interface->Detach();
270   a->interface->Attach(elem::LOCAL_TO_GLOBAL,*(a->emat));
271   PetscFunctionReturn(0);
272 }
273 
274 #undef __FUNCT__
275 #define __FUNCT__ "MatAssemblyEnd_Elemental"
276 PetscErrorCode MatAssemblyEnd_Elemental(Mat A, MatAssemblyType type)
277 {
278   PetscFunctionBegin;
279   /* Currently does nothing */
280   PetscFunctionReturn(0);
281 }
282 
283 /*MC
284    MATELEMENTAL = "elemental" - A matrix type for dense matrices using the Elemental package
285 
286    Options Database Keys:
287 . -mat_type elemental - sets the matrix type to "elemental" during a call to MatSetFromOptions()
288 
289   Level: beginner
290 
291 .seealso: MATDENSE,MatCreateElemental()
292 M*/
293 EXTERN_C_BEGIN
294 #undef __FUNCT__
295 #define __FUNCT__ "MatCreate_Elemental"
296 PETSC_EXTERN_C PetscErrorCode MatCreate_Elemental(Mat A)
297 {
298   Mat_Elemental  *a;
299   PetscErrorCode ierr;
300 
301   PetscFunctionBegin;
302   ierr = PetscElementalInitializePackage(PETSC_NULL);CHKERRQ(ierr);
303 
304   ierr = PetscNewLog(A,Mat_Elemental,&a);CHKERRQ(ierr);
305   A->data = (void*)a;
306 
307   A->ops->view          = MatView_Elemental;
308   A->ops->destroy       = MatDestroy_Elemental;
309   A->ops->setup         = MatSetUp_Elemental;
310   A->ops->setvalues     = MatSetValues_Elemental;
311   A->ops->mult          = MatMult_Elemental;
312   A->ops->multadd       = MatMultAdd_Elemental;
313   A->ops->matmult       = MatMatMult_Elemental;
314   A->ops->assemblybegin = MatAssemblyBegin_Elemental;
315   A->ops->assemblyend   = MatAssemblyEnd_Elemental;
316 
317   A->insertmode = NOT_SET_VALUES;
318 
319   /* Set up the elemental matrix */
320   elem::mpi::Comm cxxcomm(((PetscObject)A)->comm);
321   a->grid      = new elem::Grid(cxxcomm);
322   a->emat      = new elem::DistMatrix<PetscScalar>(*a->grid);
323   a->esubmat   = new elem::Matrix<PetscScalar>(1,1);
324   a->interface = new elem::AxpyInterface<PetscScalar>;
325 
326   /* build cache for off array entries formed */
327   a->interface->Attach(elem::LOCAL_TO_GLOBAL,*(a->emat));
328   /* ierr = MatStashCreate_Private(((PetscObject)A)->comm,1,&A->stash);CHKERRQ(ierr); */
329   ierr = PetscObjectComposeFunctionDynamic((PetscObject)A,"MatGetOwnershipIS_C","MatGetOwnershipIS_Elemental",MatGetOwnershipIS_Elemental);CHKERRQ(ierr);
330 
331   ierr = PetscObjectChangeTypeName((PetscObject)A,MATELEMENTAL);CHKERRQ(ierr);
332   PetscFunctionReturn(0);
333 }
334 EXTERN_C_END
335