Actual source code: vecimplslepc.h

slepc-3.14.1 2020-12-08
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: */

 11: #if !defined(SLEPCVECIMPL_H)
 12: #define SLEPCVECIMPL_H

 14: #include <slepcvec.h>
 15: #include <slepc/private/slepcimpl.h>

 17: #if !defined(PETSC_USE_DEBUG)

 19: #define SlepcValidVecComp(y,arg) do {} while (0)

 21: #else

 23: #define SlepcValidVecComp(y,arg) \
 24:   do { \
 25:     if (((Vec_Comp*)(y)->data)->nx < ((Vec_Comp*)(y)->data)->n->n) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Invalid number of subvectors required: Parameter #%d",arg); \
 26:   } while (0)

 28: #endif

 30: /* Contexts for VecComp */
 31: typedef struct {
 32:   PetscInt      n;        /* number of active subvectors */
 33:   PetscInt      N;        /* virtual global size */
 34:   PetscInt      lN;       /* virtual local size */
 35:   PetscInt      friends;  /* number of vectors sharing this structure */
 36: } Vec_Comp_N;

 38: typedef struct {
 39:   Vec           *x;       /* the vectors */
 40:   PetscInt      nx;       /* number of available subvectors */
 41:   Vec_Comp_N    *n;       /* structure shared by friend vectors */
 42: } Vec_Comp;

 44: /* Operations implemented in VecComp */
 45: SLEPC_INTERN PetscErrorCode VecDuplicateVecs_Comp(Vec,PetscInt,Vec*[]);
 46: SLEPC_INTERN PetscErrorCode VecDestroyVecs_Comp(PetscInt,Vec[]);
 47: SLEPC_INTERN PetscErrorCode VecDuplicate_Comp(Vec,Vec*);
 48: SLEPC_INTERN PetscErrorCode VecDestroy_Comp(Vec);
 49: SLEPC_INTERN PetscErrorCode VecSet_Comp(Vec,PetscScalar);
 50: SLEPC_INTERN PetscErrorCode VecView_Comp(Vec,PetscViewer);
 51: SLEPC_INTERN PetscErrorCode VecScale_Comp(Vec,PetscScalar);
 52: SLEPC_INTERN PetscErrorCode VecCopy_Comp(Vec,Vec);
 53: SLEPC_INTERN PetscErrorCode VecSwap_Comp(Vec,Vec);
 54: SLEPC_INTERN PetscErrorCode VecAXPY_Comp(Vec,PetscScalar,Vec);
 55: SLEPC_INTERN PetscErrorCode VecAYPX_Comp(Vec,PetscScalar,Vec);
 56: SLEPC_INTERN PetscErrorCode VecAXPBY_Comp(Vec,PetscScalar,PetscScalar,Vec);
 57: SLEPC_INTERN PetscErrorCode VecMAXPY_Comp(Vec,PetscInt,const PetscScalar*,Vec*);
 58: SLEPC_INTERN PetscErrorCode VecWAXPY_Comp(Vec,PetscScalar,Vec,Vec);
 59: SLEPC_INTERN PetscErrorCode VecAXPBYPCZ_Comp(Vec,PetscScalar,PetscScalar,PetscScalar,Vec,Vec);
 60: SLEPC_INTERN PetscErrorCode VecPointwiseMult_Comp(Vec,Vec,Vec);
 61: SLEPC_INTERN PetscErrorCode VecPointwiseDivide_Comp(Vec,Vec,Vec);
 62: SLEPC_INTERN PetscErrorCode VecGetSize_Comp(Vec,PetscInt*);
 63: SLEPC_INTERN PetscErrorCode VecGetLocalSize_Comp(Vec,PetscInt*);
 64: SLEPC_INTERN PetscErrorCode VecMax_Comp(Vec,PetscInt*,PetscReal*);
 65: SLEPC_INTERN PetscErrorCode VecMin_Comp(Vec,PetscInt*,PetscReal*);
 66: SLEPC_INTERN PetscErrorCode VecSetRandom_Comp(Vec,PetscRandom);
 67: SLEPC_INTERN PetscErrorCode VecConjugate_Comp(Vec);
 68: SLEPC_INTERN PetscErrorCode VecReciprocal_Comp(Vec);
 69: SLEPC_INTERN PetscErrorCode VecMaxPointwiseDivide_Comp(Vec,Vec,PetscReal*);
 70: SLEPC_INTERN PetscErrorCode VecPointwiseMax_Comp(Vec,Vec,Vec);
 71: SLEPC_INTERN PetscErrorCode VecPointwiseMaxAbs_Comp(Vec,Vec,Vec);
 72: SLEPC_INTERN PetscErrorCode VecPointwiseMin_Comp(Vec,Vec,Vec);
 73: SLEPC_INTERN PetscErrorCode VecDotNorm2_Comp_Seq(Vec,Vec,PetscScalar*,PetscScalar*);
 74: SLEPC_INTERN PetscErrorCode VecDotNorm2_Comp_MPI(Vec,Vec,PetscScalar*,PetscScalar*);
 75: SLEPC_INTERN PetscErrorCode VecSqrtAbs_Comp(Vec);
 76: SLEPC_INTERN PetscErrorCode VecAbs_Comp(Vec);
 77: SLEPC_INTERN PetscErrorCode VecExp_Comp(Vec);
 78: SLEPC_INTERN PetscErrorCode VecLog_Comp(Vec);
 79: SLEPC_INTERN PetscErrorCode VecShift_Comp(Vec,PetscScalar);
 80: SLEPC_EXTERN PetscErrorCode VecCreate_Comp(Vec);

 82: /* VecPool */
 83: typedef struct VecPool_ {
 84:   Vec      v;              /* template vector */
 85:   Vec      *vecs;          /* pool of vectors */
 86:   PetscInt n;              /* size of vecs */
 87:   PetscInt used;           /* number of already used vectors */
 88:   PetscInt guess;          /* expected maximum number of vectors */
 89:   struct VecPool_ *next;   /* list of pool of vectors */
 90: } VecPool_;
 91: typedef VecPool_* VecPool;

 93: SLEPC_EXTERN PetscErrorCode SlepcVecPoolCreate(Vec,PetscInt,VecPool*);
 94: SLEPC_EXTERN PetscErrorCode SlepcVecPoolDestroy(VecPool*);
 95: SLEPC_EXTERN PetscErrorCode SlepcVecPoolGetVecs(VecPool,PetscInt,Vec**);
 96: SLEPC_EXTERN PetscErrorCode SlepcVecPoolRestoreVecs(VecPool,PetscInt,Vec**);
 97: #endif