xref: /petsc/src/mat/impls/elemental/matelem.cxx (revision ed36708ce3596f1a0f05ed6542a7d7dd55df83ce)
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()){
101         SETERRQ4(PETSC_COMM_SELF,PETSC_ERR_SUP,"No support for setting off-process entry (%D,%D), Elemental (%D,%D)",rows[i],cols[j],erow,ecol);
102       }
103       elrow = erow / grid.MCSize();
104       elcol = ecol / grid.MRSize();
105       switch (imode) {
106       case INSERT_VALUES: a->emat->SetLocal(elrow,elcol,vals[i*nc+j]); break;
107       case ADD_VALUES: a->emat->UpdateLocal(elrow,elcol,vals[i*nc+j]); break;
108       default: SETERRQ1(((PetscObject)A)->comm,PETSC_ERR_SUP,"No support for InsertMode %d",(int)imode);
109       }
110     }
111   }
112   PetscFunctionReturn(0);
113 }
114 
115 #undef __FUNCT__
116 #define __FUNCT__ "MatMult_Elemental"
117 static PetscErrorCode MatMult_Elemental(Mat A,Vec X,Vec Y)
118 {
119   Mat_Elemental  *a = (Mat_Elemental*)A->data;
120   PetscErrorCode ierr;
121   const PetscScalar *x;
122   PetscScalar *y;
123   PetscScalar one = 1,zero = 0;
124 
125   PetscFunctionBegin;
126   ierr = VecGetArrayRead(X,&x);CHKERRQ(ierr);
127   ierr = VecGetArray(Y,&y);CHKERRQ(ierr);
128   {                             /* Scoping so that constructor is called before pointer is returned */
129     elem::DistMatrix<PetscScalar,elem::VC,elem::STAR> xe(A->cmap->N,1,0,x,A->cmap->n,*a->grid);
130     elem::DistMatrix<PetscScalar,elem::VC,elem::STAR> ye(A->rmap->N,1,0,y,A->rmap->n,*a->grid);
131     elem::Gemv(elem::NORMAL,one,*a->emat,xe,zero,ye);
132   }
133   ierr = VecRestoreArrayRead(X,&x);CHKERRQ(ierr);
134   ierr = VecRestoreArray(Y,&y);CHKERRQ(ierr);
135   PetscFunctionReturn(0);
136 }
137 
138 #undef __FUNCT__
139 #define __FUNCT__ "MatMultAdd_Elemental"
140 static PetscErrorCode MatMultAdd_Elemental(Mat A,Vec X,Vec Y,Vec Z)
141 {
142   Mat_Elemental  *a = (Mat_Elemental*)A->data;
143   PetscErrorCode ierr;
144   const PetscScalar *x;
145   PetscScalar *z;
146   PetscScalar one = 1;
147 
148   PetscFunctionBegin;
149   if (Y != Z) {ierr = VecCopy(Y,Z);CHKERRQ(ierr);}
150   ierr = VecGetArrayRead(X,&x);CHKERRQ(ierr);
151   ierr = VecGetArray(Z,&z);CHKERRQ(ierr);
152   {                             /* Scoping so that constructor is called before pointer is returned */
153     elem::DistMatrix<PetscScalar,elem::VC,elem::STAR> xe(A->cmap->N,1,0,x,A->cmap->n,*a->grid);
154     elem::DistMatrix<PetscScalar,elem::VC,elem::STAR> ze(A->rmap->N,1,0,z,A->rmap->n,*a->grid);
155     elem::Gemv(elem::NORMAL,one,*a->emat,xe,one,ze);
156   }
157   ierr = VecRestoreArrayRead(X,&x);CHKERRQ(ierr);
158   ierr = VecRestoreArray(Z,&z);CHKERRQ(ierr);
159   PetscFunctionReturn(0);
160 }
161 
162 #undef __FUNCT__
163 #define __FUNCT__ "MatGetOwnershipIS_Elemental"
164 static PetscErrorCode MatGetOwnershipIS_Elemental(Mat A,IS *rows,IS *cols)
165 {
166   Mat_Elemental  *a = (Mat_Elemental*)A->data;
167   PetscErrorCode ierr;
168   PetscInt i,m,shift,stride,*idx;
169 
170   PetscFunctionBegin;
171   if (rows) {
172     m = a->emat->LocalHeight();
173     shift = a->emat->ColShift();
174     stride = a->emat->ColStride();
175     ierr = PetscMalloc(m*sizeof(PetscInt),&idx);CHKERRQ(ierr);
176     for (i=0; i<m; i++) {
177       PetscInt rank,offset;
178       E2RO(A,0,shift+i*stride,&rank,&offset);
179       RO2P(A,0,rank,offset,&idx[i]);
180     }
181     ierr = ISCreateGeneral(PETSC_COMM_SELF,m,idx,PETSC_OWN_POINTER,rows);CHKERRQ(ierr);
182   }
183   if (cols) {
184     m = a->emat->LocalWidth();
185     shift = a->emat->RowShift();
186     stride = a->emat->RowStride();
187     ierr = PetscMalloc(m*sizeof(PetscInt),&idx);CHKERRQ(ierr);
188     for (i=0; i<m; i++) {
189       PetscInt rank,offset;
190       E2RO(A,1,shift+i*stride,&rank,&offset);
191       RO2P(A,1,rank,offset,&idx[i]);
192     }
193     ierr = ISCreateGeneral(PETSC_COMM_SELF,m,idx,PETSC_OWN_POINTER,cols);CHKERRQ(ierr);
194   }
195   PetscFunctionReturn(0);
196 }
197 
198 #undef __FUNCT__
199 #define __FUNCT__ "MatDestroy_Elemental"
200 static PetscErrorCode MatDestroy_Elemental(Mat A)
201 {
202   Mat_Elemental  *a = (Mat_Elemental*)A->data;
203   PetscErrorCode ierr;
204 
205   PetscFunctionBegin;
206   delete a->emat;
207   delete a->grid;
208   ierr = MatStashDestroy_Private(&A->stash);CHKERRQ(ierr);
209   ierr = PetscObjectComposeFunctionDynamic((PetscObject)A,"MatGetOwnershipIS_C","",PETSC_NULL);CHKERRQ(ierr);
210   ierr = PetscFree(A->data);CHKERRQ(ierr);
211   PetscFunctionReturn(0);
212 }
213 
214 #undef __FUNCT__
215 #define __FUNCT__ "MatSetUp_Elemental"
216 PetscErrorCode MatSetUp_Elemental(Mat A)
217 {
218   Mat_Elemental  *a = (Mat_Elemental*)A->data;
219   PetscErrorCode ierr;
220   PetscMPIInt rsize,csize;
221 
222   PetscFunctionBegin;
223   ierr = PetscLayoutSetUp(A->rmap);CHKERRQ(ierr);
224   ierr = PetscLayoutSetUp(A->cmap);CHKERRQ(ierr);
225 
226   a->emat->ResizeTo(A->rmap->N,A->cmap->N);CHKERRQ(ierr);
227   elem::Zero(*a->emat);
228 
229   ierr = MPI_Comm_size(A->rmap->comm,&rsize);CHKERRQ(ierr);
230   ierr = MPI_Comm_size(A->cmap->comm,&csize);CHKERRQ(ierr);
231   if (csize != rsize) SETERRQ(((PetscObject)A)->comm,PETSC_ERR_ARG_INCOMP,"Cannot use row and column communicators of different sizes");
232   a->commsize = rsize;
233   a->mr[0] = A->rmap->N % rsize; if (!a->mr[0]) a->mr[0] = rsize;
234   a->mr[1] = A->cmap->N % csize; if (!a->mr[1]) a->mr[1] = csize;
235   a->m[0] = A->rmap->N / rsize + (a->mr[0] != rsize);
236   a->m[1] = A->cmap->N / csize + (a->mr[1] != csize);
237   PetscFunctionReturn(0);
238 }
239 
240 /*MC
241    MATELEMENTAL = "elemental" - A matrix type for dense matrices using the Elemental package
242 
243    Options Database Keys:
244 . -mat_type elemental - sets the matrix type to "elemental" during a call to MatSetFromOptions()
245 
246   Level: beginner
247 
248 .seealso: MATDENSE,MatCreateElemental()
249 M*/
250 EXTERN_C_BEGIN
251 #undef __FUNCT__
252 #define __FUNCT__ "MatCreate_Elemental"
253 PETSC_EXTERN_C PetscErrorCode MatCreate_Elemental(Mat A)
254 {
255   Mat_Elemental  *a;
256   PetscErrorCode ierr;
257 
258   PetscFunctionBegin;
259   ierr = PetscElementalInitializePackage(PETSC_NULL);CHKERRQ(ierr);
260 
261   ierr = PetscNewLog(A,Mat_Elemental,&a);CHKERRQ(ierr);
262   A->data = (void*)a;
263 
264   A->ops->view      = MatView_Elemental;
265   A->ops->destroy   = MatDestroy_Elemental;
266   A->ops->setup     = MatSetUp_Elemental;
267   A->ops->setvalues = MatSetValues_Elemental;
268   A->ops->mult      = MatMult_Elemental;
269   A->ops->multadd   = MatMultAdd_Elemental;
270 
271   A->insertmode = NOT_SET_VALUES;
272 
273   /* Set up the elemental matrix */
274   elem::mpi::Comm cxxcomm(((PetscObject)A)->comm);
275   a->grid = new elem::Grid(cxxcomm);
276   a->emat = new elem::DistMatrix<PetscScalar>(*a->grid);
277 
278   /* build cache for off array entries formed */
279   ierr = MatStashCreate_Private(((PetscObject)A)->comm,1,&A->stash);CHKERRQ(ierr);
280   ierr = PetscObjectComposeFunctionDynamic((PetscObject)A,"MatGetOwnershipIS_C","MatGetOwnershipIS_Elemental",MatGetOwnershipIS_Elemental);CHKERRQ(ierr);
281 
282   ierr = PetscObjectChangeTypeName((PetscObject)A,MATELEMENTAL);CHKERRQ(ierr);
283   PetscFunctionReturn(0);
284 }
285 EXTERN_C_END
286