/usr/lib/slepcdir/3.7.3/x86_64-linux-gnu-complex/include/slepc/private/bvimpl.h is in libslepc-complex-3.7.3-dev 3.7.3+dfsg1-5.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 | /*
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
SLEPc - Scalable Library for Eigenvalue Problem Computations
Copyright (c) , Universitat Politecnica de Valencia, Spain
This file is part of SLEPc.
SLEPc is free software: you can redistribute it and/or modify it under the
terms of version 3 of the GNU Lesser General Public License as published by
the Free Software Foundation.
SLEPc is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for
more details.
You should have received a copy of the GNU Lesser General Public License
along with SLEPc. If not, see <http://www.gnu.org/licenses/>.
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
*/
#if !defined(_BVIMPL)
#define _BVIMPL
#include <slepcbv.h>
#include <slepc/private/slepcimpl.h>
PETSC_EXTERN PetscBool BVRegisterAllCalled;
PETSC_EXTERN PetscErrorCode BVRegisterAll(void);
PETSC_EXTERN PetscLogEvent BV_Create,BV_Copy,BV_Mult,BV_MultVec,BV_MultInPlace,BV_Dot,BV_DotVec,BV_Orthogonalize,BV_OrthogonalizeVec,BV_Scale,BV_Norm,BV_NormVec,BV_SetRandom,BV_MatMult,BV_MatMultVec,BV_MatProject;
typedef struct _BVOps *BVOps;
struct _BVOps {
PetscErrorCode (*mult)(BV,PetscScalar,PetscScalar,BV,Mat);
PetscErrorCode (*multvec)(BV,PetscScalar,PetscScalar,Vec,PetscScalar*);
PetscErrorCode (*multinplace)(BV,Mat,PetscInt,PetscInt);
PetscErrorCode (*multinplacetrans)(BV,Mat,PetscInt,PetscInt);
PetscErrorCode (*dot)(BV,BV,Mat);
PetscErrorCode (*dotvec)(BV,Vec,PetscScalar*);
PetscErrorCode (*dotvec_local)(BV,Vec,PetscScalar*);
PetscErrorCode (*dotvec_begin)(BV,Vec,PetscScalar*);
PetscErrorCode (*dotvec_end)(BV,Vec,PetscScalar*);
PetscErrorCode (*scale)(BV,PetscInt,PetscScalar);
PetscErrorCode (*norm)(BV,PetscInt,NormType,PetscReal*);
PetscErrorCode (*norm_local)(BV,PetscInt,NormType,PetscReal*);
PetscErrorCode (*norm_begin)(BV,PetscInt,NormType,PetscReal*);
PetscErrorCode (*norm_end)(BV,PetscInt,NormType,PetscReal*);
PetscErrorCode (*orthogonalize)(BV,Mat);
PetscErrorCode (*matmult)(BV,Mat,BV);
PetscErrorCode (*copy)(BV,BV);
PetscErrorCode (*resize)(BV,PetscInt,PetscBool);
PetscErrorCode (*getcolumn)(BV,PetscInt,Vec*);
PetscErrorCode (*restorecolumn)(BV,PetscInt,Vec*);
PetscErrorCode (*getarray)(BV,PetscScalar**);
PetscErrorCode (*restorearray)(BV,PetscScalar**);
PetscErrorCode (*getarrayread)(BV,const PetscScalar**);
PetscErrorCode (*restorearrayread)(BV,const PetscScalar**);
PetscErrorCode (*duplicate)(BV,BV*);
PetscErrorCode (*create)(BV);
PetscErrorCode (*setfromoptions)(PetscOptionItems*,BV);
PetscErrorCode (*view)(BV,PetscViewer);
PetscErrorCode (*destroy)(BV);
};
struct _p_BV {
PETSCHEADER(struct _BVOps);
/*------------------------- User parameters --------------------------*/
Vec t; /* template vector */
PetscInt n,N; /* dimensions of vectors (local, global) */
PetscInt m; /* number of vectors */
PetscInt l; /* number of leading columns */
PetscInt k; /* number of active columns */
PetscInt nc; /* number of constraints */
BVOrthogType orthog_type; /* the method of vector orthogonalization */
BVOrthogRefineType orthog_ref; /* refinement method */
PetscReal orthog_eta; /* refinement threshold */
BVOrthogBlockType orthog_block; /* the method of block orthogonalization */
Mat matrix; /* inner product matrix */
PetscBool indef; /* matrix is indefinite */
BVMatMultType vmm; /* version of matmult operation */
/*---------------------- Cached data and workspace -------------------*/
Vec Bx; /* result of matrix times a vector x */
PetscObjectId xid; /* object id of vector x */
PetscObjectState xstate; /* state of vector x */
Vec cv[2]; /* column vectors obtained with BVGetColumn() */
PetscInt ci[2]; /* column indices of obtained vectors */
PetscObjectState st[2]; /* state of obtained vectors */
PetscObjectId id[2]; /* object id of obtained vectors */
PetscScalar *h,*c; /* orthogonalization coefficients */
PetscReal *omega; /* signature matrix values for indefinite case */
Mat B,C; /* auxiliary dense matrices for matmult operation */
PetscObjectId Aid; /* object id of matrix A of matmult operation */
PetscBool defersfo; /* deferred call to setfromoptions */
BV cached; /* cached BV to store result of matrix times BV */
PetscObjectState bvstate; /* state of BV when BVApplyMatrixBV() was called */
PetscRandom rand; /* random number generator */
PetscBool rrandom; /* reproducible random vectors */
PetscScalar *work;
PetscInt lwork;
void *data;
};
#undef __FUNCT__
#define __FUNCT__ "BV_SafeSqrt"
/*
BV_SafeSqrt - Computes the square root of a scalar value alpha, which is
assumed to be z'*B*z. The result is
if definite inner product: res = sqrt(alpha)
if indefinite inner product: res = sgn(alpha)*sqrt(abs(alpha))
*/
PETSC_STATIC_INLINE PetscErrorCode BV_SafeSqrt(BV bv,PetscScalar alpha,PetscReal *res)
{
PetscErrorCode ierr;
PetscReal absal,realp;
PetscFunctionBegin;
absal = PetscAbsScalar(alpha);
realp = PetscRealPart(alpha);
if (absal<PETSC_MACHINE_EPSILON) {
ierr = PetscInfo(bv,"Zero norm, either the vector is zero or a semi-inner product is being used\n");CHKERRQ(ierr);
}
#if defined(PETSC_USE_COMPLEX)
if (PetscAbsReal(PetscImaginaryPart(alpha))/absal>PETSC_MACHINE_EPSILON) SETERRQ(PetscObjectComm((PetscObject)bv),1,"The inner product is not well defined: nonzero imaginary part");
#endif
if (bv->indef) {
*res = (realp<0.0)? -PetscSqrtReal(-realp): PetscSqrtReal(realp);
} else {
if (realp<0.0) SETERRQ(PetscObjectComm((PetscObject)bv),1,"The inner product is not well defined: indefinite matrix");
*res = PetscSqrtReal(realp);
}
PetscFunctionReturn(0);
}
#undef __FUNCT__
#define __FUNCT__ "BV_IPMatMult"
/*
BV_IPMatMult - Multiply a vector x by the inner-product matrix, cache the
result in Bx.
*/
PETSC_STATIC_INLINE PetscErrorCode BV_IPMatMult(BV bv,Vec x)
{
PetscErrorCode ierr;
PetscFunctionBegin;
if (((PetscObject)x)->id != bv->xid || ((PetscObject)x)->state != bv->xstate) {
ierr = MatMult(bv->matrix,x,bv->Bx);CHKERRQ(ierr);
bv->xid = ((PetscObject)x)->id;
bv->xstate = ((PetscObject)x)->state;
}
PetscFunctionReturn(0);
}
#undef __FUNCT__
#define __FUNCT__ "BV_AllocateCachedBV"
/*
BV_AllocateCachedBV - Allocate auxiliary BV required for BVApplyMatrixBV if not available.
*/
PETSC_STATIC_INLINE PetscErrorCode BV_AllocateCachedBV(BV V)
{
PetscErrorCode ierr;
PetscFunctionBegin;
if (!V->cached) {
ierr = BVCreate(PetscObjectComm((PetscObject)V),&V->cached);CHKERRQ(ierr);
ierr = BVSetSizesFromVec(V->cached,V->t,V->m);CHKERRQ(ierr);
ierr = BVSetType(V->cached,((PetscObject)V)->type_name);CHKERRQ(ierr);
ierr = BVSetOrthogonalization(V->cached,V->orthog_type,V->orthog_ref,V->orthog_eta,V->orthog_block);CHKERRQ(ierr);
}
PetscFunctionReturn(0);
}
#undef __FUNCT__
#define __FUNCT__ "BV_IPMatMultBV"
/*
BV_IPMatMultBV - Multiply BV by the inner-product matrix, cache the
result internally in bv->cached.
*/
PETSC_STATIC_INLINE PetscErrorCode BV_IPMatMultBV(BV bv)
{
PetscErrorCode ierr;
PetscFunctionBegin;
ierr = BV_AllocateCachedBV(bv);CHKERRQ(ierr);
ierr = BVSetActiveColumns(bv->cached,bv->l,bv->k);CHKERRQ(ierr);
if (((PetscObject)bv)->state != bv->bvstate) {
if (bv->matrix) {
ierr = BVMatMult(bv,bv->matrix,bv->cached);CHKERRQ(ierr);
} else {
ierr = BVCopy(bv,bv->cached);CHKERRQ(ierr);
}
bv->bvstate = ((PetscObject)bv)->state;
}
PetscFunctionReturn(0);
}
#undef __FUNCT__
#define __FUNCT__ "BV_AllocateCoeffs"
/*
BV_AllocateCoeffs - Allocate orthogonalization coefficients if not done already.
*/
PETSC_STATIC_INLINE PetscErrorCode BV_AllocateCoeffs(BV bv)
{
PetscErrorCode ierr;
PetscFunctionBegin;
if (!bv->h) {
ierr = PetscMalloc2(bv->nc+bv->m,&bv->h,bv->nc+bv->m,&bv->c);CHKERRQ(ierr);
ierr = PetscLogObjectMemory((PetscObject)bv,2*bv->m*sizeof(PetscScalar));CHKERRQ(ierr);
}
PetscFunctionReturn(0);
}
#undef __FUNCT__
#define __FUNCT__ "BV_AllocateSignature"
/*
BV_AllocateSignature - Allocate signature coefficients if not done already.
*/
PETSC_STATIC_INLINE PetscErrorCode BV_AllocateSignature(BV bv)
{
PetscErrorCode ierr;
PetscInt i;
PetscFunctionBegin;
if (bv->indef && !bv->omega) {
ierr = PetscMalloc1(bv->nc+bv->m,&bv->omega);CHKERRQ(ierr);
ierr = PetscLogObjectMemory((PetscObject)bv,bv->m*sizeof(PetscReal));CHKERRQ(ierr);
for (i=-bv->nc;i<bv->m;i++) bv->omega[i] = 1.0;
}
PetscFunctionReturn(0);
}
#undef __FUNCT__
#define __FUNCT__ "BV_AllocateMatMult"
/*
BV_AllocateMatMult - Allocate auxiliary matrices required for BVMatMult if not available.
*/
PETSC_STATIC_INLINE PetscErrorCode BV_AllocateMatMult(BV bv,Mat A,PetscInt m)
{
PetscErrorCode ierr;
PetscObjectId Aid;
PetscBool create=PETSC_FALSE;
PetscInt cols;
PetscFunctionBegin;
if (!bv->B) create=PETSC_TRUE;
else {
ierr = MatGetSize(bv->B,NULL,&cols);CHKERRQ(ierr);
ierr = PetscObjectGetId((PetscObject)A,&Aid);CHKERRQ(ierr);
if (cols!=m || bv->Aid!=Aid) {
ierr = MatDestroy(&bv->B);CHKERRQ(ierr);
ierr = MatDestroy(&bv->C);CHKERRQ(ierr);
create=PETSC_TRUE;
}
}
if (create) {
ierr = MatCreateDense(PetscObjectComm((PetscObject)bv),bv->n,PETSC_DECIDE,bv->N,m,NULL,&bv->B);CHKERRQ(ierr);
ierr = PetscLogObjectParent((PetscObject)bv,(PetscObject)bv->B);CHKERRQ(ierr);
ierr = MatAssemblyBegin(bv->B,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
ierr = MatAssemblyEnd(bv->B,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
}
PetscFunctionReturn(0);
}
/*
BVAvailableVec: First (0) or second (1) vector available for
getcolumn operation (or -1 if both vectors already fetched).
*/
#define BVAvailableVec (((bv->ci[0]==-bv->nc-1)? 0: (bv->ci[1]==-bv->nc-1)? 1: -1))
/*
Macros to test valid BV arguments
*/
#if !defined(PETSC_USE_DEBUG)
#define BVCheckSizes(h,arg) do {} while (0)
#else
#define BVCheckSizes(h,arg) \
do { \
if (!h->m) SETERRQ1(PetscObjectComm((PetscObject)h),PETSC_ERR_ARG_WRONGSTATE,"BV sizes have not been defined: Parameter #%d",arg); \
} while (0)
#endif
PETSC_INTERN PetscErrorCode BVView_Vecs(BV,PetscViewer);
PETSC_INTERN PetscErrorCode BVAllocateWork_Private(BV,PetscInt);
PETSC_INTERN PetscErrorCode BVMult_BLAS_Private(BV,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar,const PetscScalar*,const PetscScalar*,PetscScalar,PetscScalar*);
PETSC_INTERN PetscErrorCode BVMultVec_BLAS_Private(BV,PetscInt,PetscInt,PetscScalar,const PetscScalar*,const PetscScalar*,PetscScalar,PetscScalar*);
PETSC_INTERN PetscErrorCode BVMultInPlace_BLAS_Private(BV,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar*,const PetscScalar*,PetscBool);
PETSC_INTERN PetscErrorCode BVMultInPlace_Vecs_Private(BV,PetscInt,PetscInt,PetscInt,Vec*,const PetscScalar*,PetscBool);
PETSC_INTERN PetscErrorCode BVAXPY_BLAS_Private(BV,PetscInt,PetscInt,PetscScalar,const PetscScalar*,PetscScalar,PetscScalar*);
PETSC_INTERN PetscErrorCode BVDot_BLAS_Private(BV,PetscInt,PetscInt,PetscInt,PetscInt,const PetscScalar*,const PetscScalar*,PetscScalar*,PetscBool);
PETSC_INTERN PetscErrorCode BVDotVec_BLAS_Private(BV,PetscInt,PetscInt,const PetscScalar*,const PetscScalar*,PetscScalar*,PetscBool);
PETSC_INTERN PetscErrorCode BVScale_BLAS_Private(BV,PetscInt,PetscScalar*,PetscScalar);
PETSC_INTERN PetscErrorCode BVNorm_LAPACK_Private(BV,PetscInt,PetscInt,const PetscScalar*,NormType,PetscReal*,PetscBool);
PETSC_INTERN PetscErrorCode BVOrthogonalize_LAPACK_Private(BV,PetscInt,PetscInt,PetscScalar*,PetscScalar*,PetscBool);
#endif
|