Actual source code: stimpl.h
slepc-3.15.1 2021-05-28
1: /*
2: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
3: SLEPc - Scalable Library for Eigenvalue Problem Computations
4: Copyright (c) 2002-2021, 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(SLEPCSTIMPL_H)
12: #define SLEPCSTIMPL_H
14: #include <slepcst.h>
15: #include <slepc/private/slepcimpl.h>
17: SLEPC_EXTERN PetscBool STRegisterAllCalled;
18: SLEPC_EXTERN PetscErrorCode STRegisterAll(void);
19: SLEPC_EXTERN PetscLogEvent ST_SetUp,ST_ComputeOperator,ST_Apply,ST_ApplyTranspose,ST_MatSetUp,ST_MatMult,ST_MatMultTranspose,ST_MatSolve,ST_MatSolveTranspose;
21: typedef struct _STOps *STOps;
23: struct _STOps {
24: PetscErrorCode (*apply)(ST,Vec,Vec);
25: PetscErrorCode (*applymat)(ST,Mat,Mat);
26: PetscErrorCode (*applytrans)(ST,Vec,Vec);
27: PetscErrorCode (*backtransform)(ST,PetscInt,PetscScalar*,PetscScalar*);
28: PetscErrorCode (*setshift)(ST,PetscScalar);
29: PetscErrorCode (*getbilinearform)(ST,Mat*);
30: PetscErrorCode (*setup)(ST);
31: PetscErrorCode (*computeoperator)(ST);
32: PetscErrorCode (*setfromoptions)(PetscOptionItems*,ST);
33: PetscErrorCode (*postsolve)(ST);
34: PetscErrorCode (*destroy)(ST);
35: PetscErrorCode (*reset)(ST);
36: PetscErrorCode (*view)(ST,PetscViewer);
37: PetscErrorCode (*checknullspace)(ST,BV);
38: PetscErrorCode (*setdefaultksp)(ST);
39: };
41: /*
42: 'Updated' state means STSetUp must be called because matrices have been
43: modified, but the pattern is the same (hence reuse symbolic factorization)
44: */
45: typedef enum { ST_STATE_INITIAL,
46: ST_STATE_SETUP,
47: ST_STATE_UPDATED } STStateType;
49: struct _p_ST {
50: PETSCHEADER(struct _STOps);
51: /*------------------------- User parameters --------------------------*/
52: Mat *A; /* matrices that define the eigensystem */
53: PetscInt nmat; /* number of user-provided matrices */
54: PetscScalar sigma; /* value of the shift */
55: PetscScalar defsigma; /* default value of the shift */
56: STMatMode matmode; /* how the transformation matrix is handled */
57: MatStructure str; /* whether matrices have the same pattern or not */
58: PetscBool transform; /* whether transformed matrices are computed */
59: Vec D; /* diagonal matrix for balancing */
60: Mat Pmat; /* user-provided preconditioner matrix */
62: /*------------------------- Misc data --------------------------*/
63: KSP ksp; /* linear solver used in some ST's */
64: PetscBool usesksp; /* whether the KSP object is used or not */
65: PetscInt nwork; /* number of work vectors */
66: Vec *work; /* work vectors */
67: Vec wb; /* balancing requires an extra work vector */
68: Vec wht; /* extra work vector for hermitian transpose apply */
69: STStateType state; /* initial -> setup -> with updated matrices */
70: PetscObjectState *Astate; /* matrix state (to identify the original matrices) */
71: Mat *T; /* matrices resulting from transformation */
72: Mat Op; /* shell matrix for operator = alpha*D*inv(P)*M*inv(D) */
73: PetscBool opseized; /* whether Op has been seized by user */
74: PetscBool opready; /* whether Op is up-to-date or need be computed */
75: Mat P; /* matrix from which preconditioner is built */
76: Mat M; /* matrix corresponding to the non-inverted part of the operator */
77: PetscBool sigma_set; /* whether the user provided the shift or not */
78: PetscBool asymm; /* the user matrices are all symmetric */
79: PetscBool aherm; /* the user matrices are all hermitian */
80: void *data;
81: };
83: /*
84: Macros to test valid ST arguments
85: */
86: #if !defined(PETSC_USE_DEBUG)
88: #define STCheckMatrices(h,arg) do {(void)(h);} while (0)
89: #define STCheckNotSeized(h,arg) do {(void)(h);} while (0)
91: #else
93: #define STCheckMatrices(h,arg) \
94: do { \
95: if (!(h)->A) SETERRQ1(PetscObjectComm((PetscObject)(h)),PETSC_ERR_ARG_WRONGSTATE,"ST matrices have not been set: Parameter #%d",arg); \
96: } while (0)
97: #define STCheckNotSeized(h,arg) \
98: do { \
99: if (h->opseized) SETERRQ1(PetscObjectComm((PetscObject)h),PETSC_ERR_ARG_WRONGSTATE,"Must call STRestoreOperator() first: Parameter #%d",arg); \
100: } while (0)
102: #endif
104: SLEPC_INTERN PetscErrorCode STGetBilinearForm_Default(ST,Mat*);
105: SLEPC_INTERN PetscErrorCode STCheckNullSpace_Default(ST,BV);
106: SLEPC_INTERN PetscErrorCode STMatShellCreate(ST,PetscScalar,PetscInt,PetscInt*,PetscScalar*,Mat*);
107: SLEPC_INTERN PetscErrorCode STMatShellShift(Mat,PetscScalar);
108: SLEPC_INTERN PetscErrorCode STCheckFactorPackage(ST);
109: SLEPC_INTERN PetscErrorCode STMatMAXPY_Private(ST,PetscScalar,PetscScalar,PetscInt,PetscScalar*,PetscBool,Mat*);
110: SLEPC_INTERN PetscErrorCode STCoeffs_Monomial(ST,PetscScalar*);
111: SLEPC_INTERN PetscErrorCode STSetDefaultKSP(ST);
112: SLEPC_INTERN PetscErrorCode STSetDefaultKSP_Default(ST);
113: SLEPC_INTERN PetscErrorCode STIsInjective_Shell(ST,PetscBool*);
114: SLEPC_INTERN PetscErrorCode STComputeOperator(ST);
115: SLEPC_INTERN PetscErrorCode STGetOperator_Private(ST,Mat*);
116: SLEPC_INTERN PetscErrorCode STApply_Generic(ST,Vec,Vec);
117: SLEPC_INTERN PetscErrorCode STApplyMat_Generic(ST,Mat,Mat);
118: SLEPC_INTERN PetscErrorCode STApplyTranspose_Generic(ST,Vec,Vec);
120: /*
121: STKSPSetOperators - Sets the KSP matrices
122: */
123: PETSC_STATIC_INLINE PetscErrorCode STKSPSetOperators(ST st,Mat A,Mat B)
124: {
126: const char *prefix;
129: if (!st->ksp) { STGetKSP(st,&st->ksp); }
130: STCheckFactorPackage(st);
131: KSPSetOperators(st->ksp,A,B);
132: MatGetOptionsPrefix(B,&prefix);
133: if (!prefix) {
134: /* set Mat prefix to be the same as KSP to enable setting command-line options (e.g. MUMPS)
135: only applies if the Mat has no user-defined prefix */
136: KSPGetOptionsPrefix(st->ksp,&prefix);
137: MatSetOptionsPrefix(B,prefix);
138: }
139: return(0);
140: }
142: #endif