Actual source code: svec.c

slepc-3.13.2 2020-05-12
Report Typos and Errors
  1: /*
  2:    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  3:    SLEPc - Scalable Library for Eigenvalue Problem Computations
  4:    Copyright (c) 2002-2020, Universitat Politecnica de Valencia, Spain

  6:    This file is part of SLEPc.
  7:    SLEPc is distributed under a 2-clause BSD license (see LICENSE).
  8:    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  9: */
 10: /*
 11:    BV implemented as a single Vec
 12: */

 14:  #include <slepc/private/bvimpl.h>
 15: #include "svec.h"

 17: PetscErrorCode BVMult_Svec(BV Y,PetscScalar alpha,PetscScalar beta,BV X,Mat Q)
 18: {
 19:   PetscErrorCode    ierr;
 20:   BV_SVEC           *y = (BV_SVEC*)Y->data,*x = (BV_SVEC*)X->data;
 21:   const PetscScalar *px;
 22:   PetscScalar       *py,*q;
 23:   PetscInt          ldq;

 26:   VecGetArrayRead(x->v,&px);
 27:   VecGetArray(y->v,&py);
 28:   if (Q) {
 29:     MatGetSize(Q,&ldq,NULL);
 30:     MatDenseGetArray(Q,&q);
 31:     BVMult_BLAS_Private(Y,Y->n,Y->k-Y->l,X->k-X->l,ldq,alpha,px+(X->nc+X->l)*X->n,q+Y->l*ldq+X->l,beta,py+(Y->nc+Y->l)*Y->n);
 32:     MatDenseRestoreArray(Q,&q);
 33:   } else {
 34:     BVAXPY_BLAS_Private(Y,Y->n,Y->k-Y->l,alpha,px+(X->nc+X->l)*X->n,beta,py+(Y->nc+Y->l)*Y->n);
 35:   }
 36:   VecRestoreArrayRead(x->v,&px);
 37:   VecRestoreArray(y->v,&py);
 38:   return(0);
 39: }

 41: PetscErrorCode BVMultVec_Svec(BV X,PetscScalar alpha,PetscScalar beta,Vec y,PetscScalar *q)
 42: {
 44:   BV_SVEC        *x = (BV_SVEC*)X->data;
 45:   PetscScalar    *px,*py,*qq=q;

 48:   VecGetArray(x->v,&px);
 49:   VecGetArray(y,&py);
 50:   if (!q) { VecGetArray(X->buffer,&qq); }
 51:   BVMultVec_BLAS_Private(X,X->n,X->k-X->l,alpha,px+(X->nc+X->l)*X->n,qq,beta,py);
 52:   if (!q) { VecRestoreArray(X->buffer,&qq); }
 53:   VecRestoreArray(x->v,&px);
 54:   VecRestoreArray(y,&py);
 55:   return(0);
 56: }

 58: PetscErrorCode BVMultInPlace_Svec(BV V,Mat Q,PetscInt s,PetscInt e)
 59: {
 61:   BV_SVEC        *ctx = (BV_SVEC*)V->data;
 62:   PetscScalar    *pv,*q;
 63:   PetscInt       ldq;

 66:   MatGetSize(Q,&ldq,NULL);
 67:   VecGetArray(ctx->v,&pv);
 68:   MatDenseGetArray(Q,&q);
 69:   BVMultInPlace_BLAS_Private(V,V->n,V->k-V->l,ldq,s-V->l,e-V->l,pv+(V->nc+V->l)*V->n,q+V->l*ldq+V->l,PETSC_FALSE);
 70:   MatDenseRestoreArray(Q,&q);
 71:   VecRestoreArray(ctx->v,&pv);
 72:   return(0);
 73: }

 75: PetscErrorCode BVMultInPlaceTranspose_Svec(BV V,Mat Q,PetscInt s,PetscInt e)
 76: {
 78:   BV_SVEC        *ctx = (BV_SVEC*)V->data;
 79:   PetscScalar    *pv,*q;
 80:   PetscInt       ldq;

 83:   MatGetSize(Q,&ldq,NULL);
 84:   VecGetArray(ctx->v,&pv);
 85:   MatDenseGetArray(Q,&q);
 86:   BVMultInPlace_BLAS_Private(V,V->n,V->k-V->l,ldq,s-V->l,e-V->l,pv+(V->nc+V->l)*V->n,q+V->l*ldq+V->l,PETSC_TRUE);
 87:   MatDenseRestoreArray(Q,&q);
 88:   VecRestoreArray(ctx->v,&pv);
 89:   return(0);
 90: }

 92: PetscErrorCode BVDot_Svec(BV X,BV Y,Mat M)
 93: {
 94:   PetscErrorCode    ierr;
 95:   BV_SVEC           *x = (BV_SVEC*)X->data,*y = (BV_SVEC*)Y->data;
 96:   const PetscScalar *px,*py;
 97:   PetscScalar       *m;
 98:   PetscInt          ldm;

101:   MatGetSize(M,&ldm,NULL);
102:   VecGetArrayRead(x->v,&px);
103:   VecGetArrayRead(y->v,&py);
104:   MatDenseGetArray(M,&m);
105:   BVDot_BLAS_Private(X,Y->k-Y->l,X->k-X->l,X->n,ldm,py+(Y->nc+Y->l)*Y->n,px+(X->nc+X->l)*X->n,m+X->l*ldm+Y->l,x->mpi);
106:   MatDenseRestoreArray(M,&m);
107:   VecRestoreArrayRead(x->v,&px);
108:   VecRestoreArrayRead(y->v,&py);
109:   return(0);
110: }

112: PetscErrorCode BVDotVec_Svec(BV X,Vec y,PetscScalar *q)
113: {
114:   PetscErrorCode    ierr;
115:   BV_SVEC           *x = (BV_SVEC*)X->data;
116:   const PetscScalar *px,*py;
117:   PetscScalar       *qq=q;
118:   Vec               z = y;

121:   if (X->matrix) {
122:     BV_IPMatMult(X,y);
123:     z = X->Bx;
124:   }
125:   VecGetArrayRead(x->v,&px);
126:   VecGetArrayRead(z,&py);
127:   if (!q) { VecGetArray(X->buffer,&qq); }
128:   BVDotVec_BLAS_Private(X,X->n,X->k-X->l,px+(X->nc+X->l)*X->n,py,qq,x->mpi);
129:   if (!q) { VecRestoreArray(X->buffer,&qq); }
130:   VecRestoreArrayRead(z,&py);
131:   VecRestoreArrayRead(x->v,&px);
132:   return(0);
133: }

135: PetscErrorCode BVDotVec_Local_Svec(BV X,Vec y,PetscScalar *m)
136: {
138:   BV_SVEC        *x = (BV_SVEC*)X->data;
139:   PetscScalar    *px,*py;
140:   Vec            z = y;

143:   if (X->matrix) {
144:     BV_IPMatMult(X,y);
145:     z = X->Bx;
146:   }
147:   VecGetArray(x->v,&px);
148:   VecGetArray(z,&py);
149:   BVDotVec_BLAS_Private(X,X->n,X->k-X->l,px+(X->nc+X->l)*X->n,py,m,PETSC_FALSE);
150:   VecRestoreArray(z,&py);
151:   VecRestoreArray(x->v,&px);
152:   return(0);
153: }

155: PetscErrorCode BVScale_Svec(BV bv,PetscInt j,PetscScalar alpha)
156: {
158:   BV_SVEC        *ctx = (BV_SVEC*)bv->data;
159:   PetscScalar    *array;

162:   VecGetArray(ctx->v,&array);
163:   if (j<0) {
164:     BVScale_BLAS_Private(bv,(bv->k-bv->l)*bv->n,array+(bv->nc+bv->l)*bv->n,alpha);
165:   } else {
166:     BVScale_BLAS_Private(bv,bv->n,array+(bv->nc+j)*bv->n,alpha);
167:   }
168:   VecRestoreArray(ctx->v,&array);
169:   return(0);
170: }

172: PetscErrorCode BVNorm_Svec(BV bv,PetscInt j,NormType type,PetscReal *val)
173: {
175:   BV_SVEC        *ctx = (BV_SVEC*)bv->data;
176:   PetscScalar    *array;

179:   VecGetArray(ctx->v,&array);
180:   if (j<0) {
181:     BVNorm_LAPACK_Private(bv,bv->n,bv->k-bv->l,array+(bv->nc+bv->l)*bv->n,type,val,ctx->mpi);
182:   } else {
183:     BVNorm_LAPACK_Private(bv,bv->n,1,array+(bv->nc+j)*bv->n,type,val,ctx->mpi);
184:   }
185:   VecRestoreArray(ctx->v,&array);
186:   return(0);
187: }

189: PetscErrorCode BVNorm_Local_Svec(BV bv,PetscInt j,NormType type,PetscReal *val)
190: {
192:   BV_SVEC        *ctx = (BV_SVEC*)bv->data;
193:   PetscScalar    *array;

196:   VecGetArray(ctx->v,&array);
197:   if (j<0) {
198:     BVNorm_LAPACK_Private(bv,bv->n,bv->k-bv->l,array+(bv->nc+bv->l)*bv->n,type,val,PETSC_FALSE);
199:   } else {
200:     BVNorm_LAPACK_Private(bv,bv->n,1,array+(bv->nc+j)*bv->n,type,val,PETSC_FALSE);
201:   }
202:   VecRestoreArray(ctx->v,&array);
203:   return(0);
204: }

206: PetscErrorCode BVMatMult_Svec(BV V,Mat A,BV W)
207: {
209:   PetscInt       j;
210:   PetscBool      flg;
211:   Mat            Vmat,Wmat;
212:   Vec            vv,ww;

215:   MatHasOperation(A,MATOP_MAT_MULT,&flg);
216:   if (V->vmm && flg) {
217:     BVGetMat(V,&Vmat);
218:     BVGetMat(W,&Wmat);
219:     MatProductCreateWithMat(A,Vmat,NULL,Wmat);
220:     MatProductSetType(Wmat,MATPRODUCT_AB);
221:     MatProductSetFromOptions(Wmat);
222:     MatProductSymbolic(Wmat);
223:     MatProductNumeric(Wmat);
224:     MatProductClear(Wmat);
225:     BVRestoreMat(V,&Vmat);
226:     BVRestoreMat(W,&Wmat);
227:   } else {
228:     for (j=0;j<V->k-V->l;j++) {
229:       BVGetColumn(V,V->l+j,&vv);
230:       BVGetColumn(W,W->l+j,&ww);
231:       MatMult(A,vv,ww);
232:       BVRestoreColumn(V,V->l+j,&vv);
233:       BVRestoreColumn(W,W->l+j,&ww);
234:     }
235:   }
236:   return(0);
237: }

239: PetscErrorCode BVCopy_Svec(BV V,BV W)
240: {
242:   BV_SVEC        *v = (BV_SVEC*)V->data,*w = (BV_SVEC*)W->data;
243:   PetscScalar    *pv,*pw,*pvc,*pwc;

246:   VecGetArray(v->v,&pv);
247:   VecGetArray(w->v,&pw);
248:   pvc = pv+(V->nc+V->l)*V->n;
249:   pwc = pw+(W->nc+W->l)*W->n;
250:   PetscArraycpy(pwc,pvc,(V->k-V->l)*V->n);
251:   VecRestoreArray(v->v,&pv);
252:   VecRestoreArray(w->v,&pw);
253:   return(0);
254: }

256: PetscErrorCode BVCopyColumn_Svec(BV V,PetscInt j,PetscInt i)
257: {
259:   BV_SVEC        *v = (BV_SVEC*)V->data;
260:   PetscScalar    *pv;

263:   VecGetArray(v->v,&pv);
264:   PetscArraycpy(pv+(V->nc+i)*V->n,pv+(V->nc+j)*V->n,V->n);
265:   VecRestoreArray(v->v,&pv);
266:   return(0);
267: }

269: PetscErrorCode BVResize_Svec(BV bv,PetscInt m,PetscBool copy)
270: {
271:   PetscErrorCode    ierr;
272:   BV_SVEC           *ctx = (BV_SVEC*)bv->data;
273:   PetscScalar       *pnew;
274:   const PetscScalar *pv;
275:   PetscInt          bs,lsplit;
276:   Vec               vnew,vpar;
277:   char              str[50];
278:   BV                parent;

281:   if (bv->issplit==2) {
282:     parent = bv->splitparent;
283:     lsplit = parent->lsplit;
284:     vpar = ((BV_SVEC*)parent->data)->v;
285:     VecGetArrayRead(vpar,&pv);
286:     VecResetArray(ctx->v);
287:     VecPlaceArray(ctx->v,pv+lsplit*bv->n);
288:     VecRestoreArrayRead(vpar,&pv);
289:   } else if (!bv->issplit) {
290:     VecGetBlockSize(bv->t,&bs);
291:     VecCreate(PetscObjectComm((PetscObject)bv->t),&vnew);
292:     VecSetType(vnew,((PetscObject)bv->t)->type_name);
293:     VecSetSizes(vnew,m*bv->n,PETSC_DECIDE);
294:     VecSetBlockSize(vnew,bs);
295:     PetscLogObjectParent((PetscObject)bv,(PetscObject)vnew);
296:     if (((PetscObject)bv)->name) {
297:       PetscSNPrintf(str,50,"%s_0",((PetscObject)bv)->name);
298:       PetscObjectSetName((PetscObject)vnew,str);
299:     }
300:     if (copy) {
301:       VecGetArrayRead(ctx->v,&pv);
302:       VecGetArray(vnew,&pnew);
303:       PetscArraycpy(pnew,pv,PetscMin(m,bv->m)*bv->n);
304:       VecRestoreArrayRead(ctx->v,&pv);
305:       VecRestoreArray(vnew,&pnew);
306:     }
307:     VecDestroy(&ctx->v);
308:     ctx->v = vnew;
309:   }
310:   return(0);
311: }

313: PetscErrorCode BVGetColumn_Svec(BV bv,PetscInt j,Vec *v)
314: {
316:   BV_SVEC        *ctx = (BV_SVEC*)bv->data;
317:   PetscScalar    *pv;
318:   PetscInt       l;

321:   l = BVAvailableVec;
322:   VecGetArray(ctx->v,&pv);
323:   VecPlaceArray(bv->cv[l],pv+(bv->nc+j)*bv->n);
324:   return(0);
325: }

327: PetscErrorCode BVRestoreColumn_Svec(BV bv,PetscInt j,Vec *v)
328: {
330:   BV_SVEC        *ctx = (BV_SVEC*)bv->data;
331:   PetscInt       l;

334:   l = (j==bv->ci[0])? 0: 1;
335:   VecResetArray(bv->cv[l]);
336:   VecRestoreArray(ctx->v,NULL);
337:   return(0);
338: }

340: PetscErrorCode BVGetArray_Svec(BV bv,PetscScalar **a)
341: {
343:   BV_SVEC        *ctx = (BV_SVEC*)bv->data;

346:   VecGetArray(ctx->v,a);
347:   return(0);
348: }

350: PetscErrorCode BVRestoreArray_Svec(BV bv,PetscScalar **a)
351: {
353:   BV_SVEC        *ctx = (BV_SVEC*)bv->data;

356:   VecRestoreArray(ctx->v,a);
357:   return(0);
358: }

360: PetscErrorCode BVGetArrayRead_Svec(BV bv,const PetscScalar **a)
361: {
363:   BV_SVEC        *ctx = (BV_SVEC*)bv->data;

366:   VecGetArrayRead(ctx->v,a);
367:   return(0);
368: }

370: PetscErrorCode BVRestoreArrayRead_Svec(BV bv,const PetscScalar **a)
371: {
373:   BV_SVEC        *ctx = (BV_SVEC*)bv->data;

376:   VecRestoreArrayRead(ctx->v,a);
377:   return(0);
378: }

380: PetscErrorCode BVView_Svec(BV bv,PetscViewer viewer)
381: {
382:   PetscErrorCode    ierr;
383:   BV_SVEC           *ctx = (BV_SVEC*)bv->data;
384:   PetscViewerFormat format;
385:   PetscBool         isascii;
386:   const char        *bvname,*name;

389:   PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&isascii);
390:   if (isascii) {
391:     PetscViewerGetFormat(viewer,&format);
392:     if (format == PETSC_VIEWER_ASCII_INFO || format == PETSC_VIEWER_ASCII_INFO_DETAIL) return(0);
393:     VecView(ctx->v,viewer);
394:     if (format == PETSC_VIEWER_ASCII_MATLAB) {
395:       PetscObjectGetName((PetscObject)bv,&bvname);
396:       PetscObjectGetName((PetscObject)ctx->v,&name);
397:       PetscViewerASCIIPrintf(viewer,"%s=reshape(%s,%D,%D);clear %s\n",bvname,name,bv->N,bv->nc+bv->m,name);
398:       if (bv->nc) {
399:         PetscViewerASCIIPrintf(viewer,"%s=%s(:,%D:end);\n",bvname,bvname,bv->nc+1);
400:       }
401:     }
402:   } else {
403:     VecView(ctx->v,viewer);
404:   }
405:   return(0);
406: }

408: PetscErrorCode BVDestroy_Svec(BV bv)
409: {
411:   BV_SVEC        *ctx = (BV_SVEC*)bv->data;

414:   VecDestroy(&ctx->v);
415:   VecDestroy(&bv->cv[0]);
416:   VecDestroy(&bv->cv[1]);
417:   PetscFree(bv->data);
418:   bv->cuda = PETSC_FALSE;
419:   return(0);
420: }

422: SLEPC_EXTERN PetscErrorCode BVCreate_Svec(BV bv)
423: {
424:   PetscErrorCode    ierr;
425:   BV_SVEC           *ctx;
426:   PetscInt          nloc,N,bs,tglobal=0,tlocal,lsplit;
427:   PetscBool         seq;
428:   PetscScalar       *aa,*vv;
429:   const PetscScalar *array,*ptr;
430:   char              str[50];
431:   BV                parent;
432:   Vec               vpar;
433: #if defined(PETSC_HAVE_CUDA)
434:   PetscScalar       *gpuarray,*gptr;
435: #endif

438:   PetscNewLog(bv,&ctx);
439:   bv->data = (void*)ctx;

441:   PetscObjectTypeCompareAny((PetscObject)bv->t,&bv->cuda,VECSEQCUDA,VECMPICUDA,"");
442:   PetscObjectTypeCompareAny((PetscObject)bv->t,&ctx->mpi,VECMPI,VECMPICUDA,"");

444:   PetscObjectTypeCompare((PetscObject)bv->t,VECSEQ,&seq);
445:   if (!seq && !ctx->mpi && !bv->cuda) SETERRQ(PetscObjectComm((PetscObject)bv),PETSC_ERR_SUP,"BVSVEC does not support the type of the provided template vector");

447:   VecGetLocalSize(bv->t,&nloc);
448:   VecGetSize(bv->t,&N);
449:   VecGetBlockSize(bv->t,&bs);
450:   tlocal  = bv->m*nloc;
451:   PetscIntMultError(bv->m,N,&tglobal);

453:   if (bv->issplit) {
454:     /* split BV: create Vec sharing the memory of the parent BV */
455:     parent = bv->splitparent;
456:     lsplit = parent->lsplit;
457:     vpar = ((BV_SVEC*)parent->data)->v;
458:     if (bv->cuda) {
459: #if defined(PETSC_HAVE_CUDA)
460:       VecCUDAGetArray(vpar,&gpuarray);
461:       gptr = (bv->issplit==1)? gpuarray: gpuarray+lsplit*nloc;
462:       VecCUDARestoreArray(vpar,&gpuarray);
463:       if (ctx->mpi) {
464:         VecCreateMPICUDAWithArray(PetscObjectComm((PetscObject)bv->t),bs,tlocal,bv->m*N,NULL,&ctx->v);
465:       } else {
466:         VecCreateSeqCUDAWithArray(PetscObjectComm((PetscObject)bv->t),bs,tlocal,NULL,&ctx->v);
467:       }
468:       VecCUDAPlaceArray(ctx->v,gptr);
469: #endif
470:     } else {
471:       VecGetArrayRead(vpar,&array);
472:       ptr = (bv->issplit==1)? array: array+lsplit*nloc;
473:       VecRestoreArrayRead(vpar,&array);
474:       if (ctx->mpi) {
475:         VecCreateMPIWithArray(PetscObjectComm((PetscObject)bv->t),bs,tlocal,bv->m*N,NULL,&ctx->v);
476:       } else {
477:         VecCreateSeqWithArray(PetscObjectComm((PetscObject)bv->t),bs,tlocal,NULL,&ctx->v);
478:       }
479:       VecPlaceArray(ctx->v,ptr);
480:     }
481:   } else {
482:     /* regular BV: create Vec to store the BV entries */
483:     VecCreate(PetscObjectComm((PetscObject)bv->t),&ctx->v);
484:     VecSetType(ctx->v,((PetscObject)bv->t)->type_name);
485:     VecSetSizes(ctx->v,tlocal,tglobal);
486:     VecSetBlockSize(ctx->v,bs);
487:   }
488:   PetscLogObjectParent((PetscObject)bv,(PetscObject)ctx->v);
489:   if (((PetscObject)bv)->name) {
490:     PetscSNPrintf(str,50,"%s_0",((PetscObject)bv)->name);
491:     PetscObjectSetName((PetscObject)ctx->v,str);
492:   }

494:   if (bv->Acreate) {
495:     MatDenseGetArray(bv->Acreate,&aa);
496:     VecGetArray(ctx->v,&vv);
497:     PetscArraycpy(vv,aa,tlocal);
498:     VecRestoreArray(ctx->v,&vv);
499:     MatDenseRestoreArray(bv->Acreate,&aa);
500:     MatDestroy(&bv->Acreate);
501:   }

503:   VecDuplicateEmpty(bv->t,&bv->cv[0]);
504:   VecDuplicateEmpty(bv->t,&bv->cv[1]);

506:   if (bv->cuda) {
507: #if defined(PETSC_HAVE_CUDA)
508:     bv->ops->mult             = BVMult_Svec_CUDA;
509:     bv->ops->multvec          = BVMultVec_Svec_CUDA;
510:     bv->ops->multinplace      = BVMultInPlace_Svec_CUDA;
511:     bv->ops->multinplacetrans = BVMultInPlaceTranspose_Svec_CUDA;
512:     bv->ops->dot              = BVDot_Svec_CUDA;
513:     bv->ops->dotvec           = BVDotVec_Svec_CUDA;
514:     bv->ops->dotvec_local     = BVDotVec_Local_Svec_CUDA;
515:     bv->ops->scale            = BVScale_Svec_CUDA;
516:     bv->ops->matmult          = BVMatMult_Svec_CUDA;
517:     bv->ops->copy             = BVCopy_Svec_CUDA;
518:     bv->ops->copycolumn       = BVCopyColumn_Svec_CUDA;
519:     bv->ops->resize           = BVResize_Svec_CUDA;
520:     bv->ops->getcolumn        = BVGetColumn_Svec_CUDA;
521:     bv->ops->restorecolumn    = BVRestoreColumn_Svec_CUDA;
522:     bv->ops->restoresplit     = BVRestoreSplit_Svec_CUDA;
523: #endif
524:   } else {
525:     bv->ops->mult             = BVMult_Svec;
526:     bv->ops->multvec          = BVMultVec_Svec;
527:     bv->ops->multinplace      = BVMultInPlace_Svec;
528:     bv->ops->multinplacetrans = BVMultInPlaceTranspose_Svec;
529:     bv->ops->dot              = BVDot_Svec;
530:     bv->ops->dotvec           = BVDotVec_Svec;
531:     bv->ops->dotvec_local     = BVDotVec_Local_Svec;
532:     bv->ops->scale            = BVScale_Svec;
533:     bv->ops->matmult          = BVMatMult_Svec;
534:     bv->ops->copy             = BVCopy_Svec;
535:     bv->ops->copycolumn       = BVCopyColumn_Svec;
536:     bv->ops->resize           = BVResize_Svec;
537:     bv->ops->getcolumn        = BVGetColumn_Svec;
538:     bv->ops->restorecolumn    = BVRestoreColumn_Svec;
539:   }
540:   bv->ops->norm             = BVNorm_Svec;
541:   bv->ops->norm_local       = BVNorm_Local_Svec;
542:   bv->ops->getarray         = BVGetArray_Svec;
543:   bv->ops->restorearray     = BVRestoreArray_Svec;
544:   bv->ops->getarrayread     = BVGetArrayRead_Svec;
545:   bv->ops->restorearrayread = BVRestoreArrayRead_Svec;
546:   bv->ops->destroy          = BVDestroy_Svec;
547:   if (!ctx->mpi) bv->ops->view = BVView_Svec;
548:   return(0);
549: }