Actual source code: slepceps.h
slepc-3.13.1 2020-04-12
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: User interface for the SLEPc linear eigenvalue solvers
12: */
14: #if !defined(SLEPCEPS_H)
15: #define SLEPCEPS_H
16: #include <slepcst.h>
17: #include <slepcbv.h>
18: #include <slepcds.h>
19: #include <slepcrg.h>
20: #include <slepclme.h>
21: #include <petscsnes.h>
23: SLEPC_EXTERN PetscErrorCode EPSInitializePackage(void);
25: /*S
26: EPS - Abstract SLEPc object that manages all the eigenvalue
27: problem solvers.
29: Level: beginner
31: .seealso: EPSCreate(), ST
32: S*/
33: typedef struct _p_EPS* EPS;
35: /*J
36: EPSType - String with the name of a SLEPc eigensolver
38: Level: beginner
40: .seealso: EPSSetType(), EPS
41: J*/
42: typedef const char* EPSType;
43: #define EPSPOWER "power"
44: #define EPSSUBSPACE "subspace"
45: #define EPSARNOLDI "arnoldi"
46: #define EPSLANCZOS "lanczos"
47: #define EPSKRYLOVSCHUR "krylovschur"
48: #define EPSGD "gd"
49: #define EPSJD "jd"
50: #define EPSRQCG "rqcg"
51: #define EPSLOBPCG "lobpcg"
52: #define EPSCISS "ciss"
53: #define EPSLYAPII "lyapii"
54: #define EPSLAPACK "lapack"
55: #define EPSARPACK "arpack"
56: #define EPSBLZPACK "blzpack"
57: #define EPSTRLAN "trlan"
58: #define EPSBLOPEX "blopex"
59: #define EPSPRIMME "primme"
61: /* Logging support */
62: SLEPC_EXTERN PetscClassId EPS_CLASSID;
64: /*E
65: EPSProblemType - Determines the type of eigenvalue problem
67: Level: beginner
69: .seealso: EPSSetProblemType(), EPSGetProblemType()
70: E*/
71: typedef enum { EPS_HEP=1,
72: EPS_GHEP,
73: EPS_NHEP,
74: EPS_GNHEP,
75: EPS_PGNHEP,
76: EPS_GHIEP } EPSProblemType;
78: /*E
79: EPSExtraction - Determines the type of extraction technique employed
80: by the eigensolver
82: Level: advanced
84: .seealso: EPSSetExtraction(), EPSGetExtraction()
85: E*/
86: typedef enum { EPS_RITZ,
87: EPS_HARMONIC,
88: EPS_HARMONIC_RELATIVE,
89: EPS_HARMONIC_RIGHT,
90: EPS_HARMONIC_LARGEST,
91: EPS_REFINED,
92: EPS_REFINED_HARMONIC } EPSExtraction;
94: /*E
95: EPSWhich - Determines which part of the spectrum is requested
97: Level: intermediate
99: .seealso: EPSSetWhichEigenpairs(), EPSGetWhichEigenpairs()
100: E*/
101: typedef enum { EPS_LARGEST_MAGNITUDE=1,
102: EPS_SMALLEST_MAGNITUDE,
103: EPS_LARGEST_REAL,
104: EPS_SMALLEST_REAL,
105: EPS_LARGEST_IMAGINARY,
106: EPS_SMALLEST_IMAGINARY,
107: EPS_TARGET_MAGNITUDE,
108: EPS_TARGET_REAL,
109: EPS_TARGET_IMAGINARY,
110: EPS_ALL,
111: EPS_WHICH_USER } EPSWhich;
113: /*E
114: EPSBalance - The type of balancing used for non-Hermitian problems
116: Level: intermediate
118: .seealso: EPSSetBalance()
119: E*/
120: typedef enum { EPS_BALANCE_NONE,
121: EPS_BALANCE_ONESIDE,
122: EPS_BALANCE_TWOSIDE,
123: EPS_BALANCE_USER } EPSBalance;
124: SLEPC_EXTERN const char *EPSBalanceTypes[];
126: /*E
127: EPSErrorType - The error type used to assess accuracy of computed solutions
129: Level: intermediate
131: .seealso: EPSComputeError()
132: E*/
133: typedef enum { EPS_ERROR_ABSOLUTE,
134: EPS_ERROR_RELATIVE,
135: EPS_ERROR_BACKWARD } EPSErrorType;
136: SLEPC_EXTERN const char *EPSErrorTypes[];
138: /*E
139: EPSConv - Determines the convergence test
141: Level: intermediate
143: .seealso: EPSSetConvergenceTest(), EPSSetConvergenceTestFunction()
144: E*/
145: typedef enum { EPS_CONV_ABS,
146: EPS_CONV_REL,
147: EPS_CONV_NORM,
148: EPS_CONV_USER } EPSConv;
150: /*E
151: EPSStop - Determines the stopping test
153: Level: advanced
155: .seealso: EPSSetStoppingTest(), EPSSetStoppingTestFunction()
156: E*/
157: typedef enum { EPS_STOP_BASIC,
158: EPS_STOP_USER } EPSStop;
160: /*E
161: EPSConvergedReason - Reason an eigensolver was said to
162: have converged or diverged
164: Level: intermediate
166: .seealso: EPSSolve(), EPSGetConvergedReason(), EPSSetTolerances()
167: E*/
168: typedef enum {/* converged */
169: EPS_CONVERGED_TOL = 1,
170: EPS_CONVERGED_USER = 2,
171: /* diverged */
172: EPS_DIVERGED_ITS = -1,
173: EPS_DIVERGED_BREAKDOWN = -2,
174: EPS_DIVERGED_SYMMETRY_LOST = -3,
175: EPS_CONVERGED_ITERATING = 0} EPSConvergedReason;
176: SLEPC_EXTERN const char *const*EPSConvergedReasons;
178: SLEPC_EXTERN PetscErrorCode EPSCreate(MPI_Comm,EPS*);
179: SLEPC_EXTERN PetscErrorCode EPSDestroy(EPS*);
180: SLEPC_EXTERN PetscErrorCode EPSReset(EPS);
181: SLEPC_EXTERN PetscErrorCode EPSSetType(EPS,EPSType);
182: SLEPC_EXTERN PetscErrorCode EPSGetType(EPS,EPSType*);
183: SLEPC_EXTERN PetscErrorCode EPSSetProblemType(EPS,EPSProblemType);
184: SLEPC_EXTERN PetscErrorCode EPSGetProblemType(EPS,EPSProblemType*);
185: SLEPC_EXTERN PetscErrorCode EPSSetExtraction(EPS,EPSExtraction);
186: SLEPC_EXTERN PetscErrorCode EPSGetExtraction(EPS,EPSExtraction*);
187: SLEPC_EXTERN PetscErrorCode EPSSetBalance(EPS,EPSBalance,PetscInt,PetscReal);
188: SLEPC_EXTERN PetscErrorCode EPSGetBalance(EPS,EPSBalance*,PetscInt*,PetscReal*);
189: SLEPC_EXTERN PetscErrorCode EPSSetOperators(EPS,Mat,Mat);
190: SLEPC_EXTERN PetscErrorCode EPSGetOperators(EPS,Mat*,Mat*);
191: SLEPC_EXTERN PetscErrorCode EPSSetFromOptions(EPS);
192: SLEPC_EXTERN PetscErrorCode EPSSetUp(EPS);
193: SLEPC_EXTERN PetscErrorCode EPSSolve(EPS);
194: SLEPC_EXTERN PetscErrorCode EPSView(EPS,PetscViewer);
195: SLEPC_EXTERN PetscErrorCode EPSViewFromOptions(EPS,PetscObject,const char[]);
196: SLEPC_EXTERN PetscErrorCode EPSErrorView(EPS,EPSErrorType,PetscViewer);
197: PETSC_DEPRECATED_FUNCTION("Use EPSErrorView()") PETSC_STATIC_INLINE PetscErrorCode EPSPrintSolution(EPS eps,PetscViewer v) {return EPSErrorView(eps,EPS_ERROR_RELATIVE,v);}
198: SLEPC_EXTERN PetscErrorCode EPSErrorViewFromOptions(EPS);
199: SLEPC_EXTERN PetscErrorCode EPSReasonView(EPS,PetscViewer);
200: SLEPC_EXTERN PetscErrorCode EPSReasonViewFromOptions(EPS);
201: SLEPC_EXTERN PetscErrorCode EPSValuesView(EPS,PetscViewer);
202: SLEPC_EXTERN PetscErrorCode EPSValuesViewFromOptions(EPS);
203: SLEPC_EXTERN PetscErrorCode EPSVectorsView(EPS,PetscViewer);
204: SLEPC_EXTERN PetscErrorCode EPSVectorsViewFromOptions(EPS);
206: SLEPC_EXTERN PetscErrorCode EPSSetTarget(EPS,PetscScalar);
207: SLEPC_EXTERN PetscErrorCode EPSGetTarget(EPS,PetscScalar*);
208: SLEPC_EXTERN PetscErrorCode EPSSetInterval(EPS,PetscReal,PetscReal);
209: SLEPC_EXTERN PetscErrorCode EPSGetInterval(EPS,PetscReal*,PetscReal*);
210: SLEPC_EXTERN PetscErrorCode EPSSetST(EPS,ST);
211: SLEPC_EXTERN PetscErrorCode EPSGetST(EPS,ST*);
212: SLEPC_EXTERN PetscErrorCode EPSSetBV(EPS,BV);
213: SLEPC_EXTERN PetscErrorCode EPSGetBV(EPS,BV*);
214: SLEPC_EXTERN PetscErrorCode EPSSetRG(EPS,RG);
215: SLEPC_EXTERN PetscErrorCode EPSGetRG(EPS,RG*);
216: SLEPC_EXTERN PetscErrorCode EPSSetDS(EPS,DS);
217: SLEPC_EXTERN PetscErrorCode EPSGetDS(EPS,DS*);
218: SLEPC_EXTERN PetscErrorCode EPSSetTolerances(EPS,PetscReal,PetscInt);
219: SLEPC_EXTERN PetscErrorCode EPSGetTolerances(EPS,PetscReal*,PetscInt*);
220: SLEPC_EXTERN PetscErrorCode EPSSetConvergenceTestFunction(EPS,PetscErrorCode (*)(EPS,PetscScalar,PetscScalar,PetscReal,PetscReal*,void*),void*,PetscErrorCode (*)(void*));
221: SLEPC_EXTERN PetscErrorCode EPSSetConvergenceTest(EPS,EPSConv);
222: SLEPC_EXTERN PetscErrorCode EPSGetConvergenceTest(EPS,EPSConv*);
223: SLEPC_EXTERN PetscErrorCode EPSConvergedAbsolute(EPS,PetscScalar,PetscScalar,PetscReal,PetscReal*,void*);
224: SLEPC_EXTERN PetscErrorCode EPSConvergedRelative(EPS,PetscScalar,PetscScalar,PetscReal,PetscReal*,void*);
225: SLEPC_EXTERN PetscErrorCode EPSConvergedNorm(EPS,PetscScalar,PetscScalar,PetscReal,PetscReal*,void*);
226: SLEPC_EXTERN PetscErrorCode EPSSetStoppingTestFunction(EPS,PetscErrorCode (*)(EPS,PetscInt,PetscInt,PetscInt,PetscInt,EPSConvergedReason*,void*),void*,PetscErrorCode (*)(void*));
227: SLEPC_EXTERN PetscErrorCode EPSSetStoppingTest(EPS,EPSStop);
228: SLEPC_EXTERN PetscErrorCode EPSGetStoppingTest(EPS,EPSStop*);
229: SLEPC_EXTERN PetscErrorCode EPSStoppingBasic(EPS,PetscInt,PetscInt,PetscInt,PetscInt,EPSConvergedReason*,void*);
230: SLEPC_EXTERN PetscErrorCode EPSGetConvergedReason(EPS,EPSConvergedReason*);
232: SLEPC_EXTERN PetscErrorCode EPSSetDimensions(EPS,PetscInt,PetscInt,PetscInt);
233: SLEPC_EXTERN PetscErrorCode EPSGetDimensions(EPS,PetscInt*,PetscInt*,PetscInt*);
235: SLEPC_EXTERN PetscErrorCode EPSGetConverged(EPS,PetscInt*);
236: SLEPC_EXTERN PetscErrorCode EPSGetEigenpair(EPS,PetscInt,PetscScalar*,PetscScalar*,Vec,Vec);
237: SLEPC_EXTERN PetscErrorCode EPSGetEigenvalue(EPS,PetscInt,PetscScalar*,PetscScalar*);
238: SLEPC_EXTERN PetscErrorCode EPSGetEigenvector(EPS,PetscInt,Vec,Vec);
239: SLEPC_EXTERN PetscErrorCode EPSGetLeftEigenvector(EPS,PetscInt,Vec,Vec);
241: SLEPC_EXTERN PetscErrorCode EPSComputeError(EPS,PetscInt,EPSErrorType,PetscReal*);
242: PETSC_DEPRECATED_FUNCTION("Use EPSComputeError()") PETSC_STATIC_INLINE PetscErrorCode EPSComputeRelativeError(EPS eps,PetscInt i,PetscReal *r) {return EPSComputeError(eps,i,EPS_ERROR_RELATIVE,r);}
243: PETSC_DEPRECATED_FUNCTION("Use EPSComputeError() with EPS_ERROR_ABSOLUTE") PETSC_STATIC_INLINE PetscErrorCode EPSComputeResidualNorm(EPS eps,PetscInt i,PetscReal *r) {return EPSComputeError(eps,i,EPS_ERROR_ABSOLUTE,r);}
244: SLEPC_EXTERN PetscErrorCode EPSGetInvariantSubspace(EPS,Vec[]);
245: SLEPC_EXTERN PetscErrorCode EPSGetErrorEstimate(EPS,PetscInt,PetscReal*);
247: SLEPC_EXTERN PetscErrorCode EPSMonitor(EPS,PetscInt,PetscInt,PetscScalar*,PetscScalar*,PetscReal*,PetscInt);
248: SLEPC_EXTERN PetscErrorCode EPSMonitorSet(EPS,PetscErrorCode (*)(EPS,PetscInt,PetscInt,PetscScalar*,PetscScalar*,PetscReal*,PetscInt,void*),void*,PetscErrorCode (*)(void**));
249: SLEPC_EXTERN PetscErrorCode EPSMonitorSetFromOptions(EPS,const char*,const char*,const char*,PetscErrorCode (*)(EPS,PetscInt,PetscInt,PetscScalar*,PetscScalar*,PetscReal*,PetscInt,PetscViewerAndFormat*),PetscBool);
250: SLEPC_EXTERN PetscErrorCode EPSConvMonitorSetFromOptions(EPS,const char*,const char*,const char*,PetscErrorCode (*)(EPS,PetscInt,PetscInt,PetscScalar*,PetscScalar*,PetscReal*,PetscInt,SlepcConvMonitor));
251: SLEPC_EXTERN PetscErrorCode EPSMonitorCancel(EPS);
252: SLEPC_EXTERN PetscErrorCode EPSGetMonitorContext(EPS,void**);
253: SLEPC_EXTERN PetscErrorCode EPSGetIterationNumber(EPS,PetscInt*);
255: SLEPC_EXTERN PetscErrorCode EPSSetWhichEigenpairs(EPS,EPSWhich);
256: SLEPC_EXTERN PetscErrorCode EPSGetWhichEigenpairs(EPS,EPSWhich*);
257: SLEPC_EXTERN PetscErrorCode EPSSetTwoSided(EPS,PetscBool);
258: SLEPC_EXTERN PetscErrorCode EPSGetTwoSided(EPS,PetscBool*);
259: SLEPC_EXTERN PetscErrorCode EPSSetTrueResidual(EPS,PetscBool);
260: SLEPC_EXTERN PetscErrorCode EPSGetTrueResidual(EPS,PetscBool*);
261: SLEPC_EXTERN PetscErrorCode EPSSetPurify(EPS,PetscBool);
262: SLEPC_EXTERN PetscErrorCode EPSGetPurify(EPS,PetscBool*);
263: SLEPC_EXTERN PetscErrorCode EPSSetEigenvalueComparison(EPS,PetscErrorCode (*func)(PetscScalar,PetscScalar,PetscScalar,PetscScalar,PetscInt*,void*),void*);
264: SLEPC_EXTERN PetscErrorCode EPSSetArbitrarySelection(EPS,PetscErrorCode (*func)(PetscScalar,PetscScalar,Vec,Vec,PetscScalar*,PetscScalar*,void*),void*);
265: SLEPC_EXTERN PetscErrorCode EPSIsGeneralized(EPS,PetscBool*);
266: SLEPC_EXTERN PetscErrorCode EPSIsHermitian(EPS,PetscBool*);
267: SLEPC_EXTERN PetscErrorCode EPSIsPositive(EPS,PetscBool*);
269: SLEPC_EXTERN PetscErrorCode EPSMonitorFirst(EPS,PetscInt,PetscInt,PetscScalar*,PetscScalar*,PetscReal*,PetscInt,PetscViewerAndFormat*);
270: SLEPC_EXTERN PetscErrorCode EPSMonitorAll(EPS,PetscInt,PetscInt,PetscScalar*,PetscScalar*,PetscReal*,PetscInt,PetscViewerAndFormat*);
271: SLEPC_EXTERN PetscErrorCode EPSMonitorConverged(EPS,PetscInt,PetscInt,PetscScalar*,PetscScalar*,PetscReal*,PetscInt,SlepcConvMonitor);
272: SLEPC_EXTERN PetscErrorCode EPSMonitorLGCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscDrawLG*);
273: SLEPC_EXTERN PetscErrorCode EPSMonitorLG(EPS,PetscInt,PetscInt,PetscScalar*,PetscScalar*,PetscReal*,PetscInt,void*);
274: SLEPC_EXTERN PetscErrorCode EPSMonitorLGAll(EPS,PetscInt,PetscInt,PetscScalar*,PetscScalar*,PetscReal*,PetscInt,void*);
276: SLEPC_EXTERN PetscErrorCode EPSSetTrackAll(EPS,PetscBool);
277: SLEPC_EXTERN PetscErrorCode EPSGetTrackAll(EPS,PetscBool*);
279: SLEPC_EXTERN PetscErrorCode EPSSetDeflationSpace(EPS,PetscInt,Vec[]);
280: SLEPC_EXTERN PetscErrorCode EPSSetInitialSpace(EPS,PetscInt,Vec[]);
281: SLEPC_EXTERN PetscErrorCode EPSSetLeftInitialSpace(EPS,PetscInt,Vec[]);
283: SLEPC_EXTERN PetscErrorCode EPSSetOptionsPrefix(EPS,const char*);
284: SLEPC_EXTERN PetscErrorCode EPSAppendOptionsPrefix(EPS,const char*);
285: SLEPC_EXTERN PetscErrorCode EPSGetOptionsPrefix(EPS,const char*[]);
287: SLEPC_EXTERN PetscFunctionList EPSList;
288: SLEPC_EXTERN PetscErrorCode EPSRegister(const char[],PetscErrorCode(*)(EPS));
290: SLEPC_EXTERN PetscErrorCode EPSSetWorkVecs(EPS,PetscInt);
291: SLEPC_EXTERN PetscErrorCode EPSAllocateSolution(EPS,PetscInt);
293: /* --------- options specific to particular eigensolvers -------- */
295: /*E
296: EPSPowerShiftType - determines the type of shift used in the Power iteration
298: Level: advanced
300: .seealso: EPSPowerSetShiftType(), EPSPowerGetShiftType()
301: E*/
302: typedef enum { EPS_POWER_SHIFT_CONSTANT,
303: EPS_POWER_SHIFT_RAYLEIGH,
304: EPS_POWER_SHIFT_WILKINSON } EPSPowerShiftType;
305: SLEPC_EXTERN const char *EPSPowerShiftTypes[];
307: SLEPC_EXTERN PetscErrorCode EPSPowerSetShiftType(EPS,EPSPowerShiftType);
308: SLEPC_EXTERN PetscErrorCode EPSPowerGetShiftType(EPS,EPSPowerShiftType*);
309: SLEPC_EXTERN PetscErrorCode EPSPowerSetNonlinear(EPS,PetscBool);
310: SLEPC_EXTERN PetscErrorCode EPSPowerGetNonlinear(EPS,PetscBool*);
311: SLEPC_EXTERN PetscErrorCode EPSPowerSetUpdate(EPS,PetscBool);
312: SLEPC_EXTERN PetscErrorCode EPSPowerGetUpdate(EPS,PetscBool*);
313: SLEPC_EXTERN PetscErrorCode EPSPowerSetSNES(EPS,SNES);
314: SLEPC_EXTERN PetscErrorCode EPSPowerGetSNES(EPS,SNES*);
316: SLEPC_EXTERN PetscErrorCode EPSArnoldiSetDelayed(EPS,PetscBool);
317: SLEPC_EXTERN PetscErrorCode EPSArnoldiGetDelayed(EPS,PetscBool*);
319: SLEPC_EXTERN PetscErrorCode EPSKrylovSchurSetRestart(EPS,PetscReal);
320: SLEPC_EXTERN PetscErrorCode EPSKrylovSchurGetRestart(EPS,PetscReal*);
321: SLEPC_EXTERN PetscErrorCode EPSKrylovSchurSetLocking(EPS,PetscBool);
322: SLEPC_EXTERN PetscErrorCode EPSKrylovSchurGetLocking(EPS,PetscBool*);
323: SLEPC_EXTERN PetscErrorCode EPSKrylovSchurSetPartitions(EPS,PetscInt);
324: SLEPC_EXTERN PetscErrorCode EPSKrylovSchurGetPartitions(EPS,PetscInt*);
325: SLEPC_EXTERN PetscErrorCode EPSKrylovSchurSetDetectZeros(EPS,PetscBool);
326: SLEPC_EXTERN PetscErrorCode EPSKrylovSchurGetDetectZeros(EPS,PetscBool*);
327: SLEPC_EXTERN PetscErrorCode EPSKrylovSchurSetDimensions(EPS,PetscInt,PetscInt,PetscInt);
328: SLEPC_EXTERN PetscErrorCode EPSKrylovSchurGetDimensions(EPS,PetscInt*,PetscInt*,PetscInt*);
329: SLEPC_EXTERN PetscErrorCode EPSKrylovSchurSetSubintervals(EPS,PetscReal*);
330: SLEPC_EXTERN PetscErrorCode EPSKrylovSchurGetSubintervals(EPS,PetscReal**);
331: SLEPC_EXTERN PetscErrorCode EPSKrylovSchurGetInertias(EPS,PetscInt*,PetscReal**,PetscInt**);
332: SLEPC_EXTERN PetscErrorCode EPSKrylovSchurGetSubcommInfo(EPS,PetscInt*,PetscInt*,Vec*);
333: SLEPC_EXTERN PetscErrorCode EPSKrylovSchurGetSubcommPairs(EPS,PetscInt,PetscScalar*,Vec);
334: SLEPC_EXTERN PetscErrorCode EPSKrylovSchurGetSubcommMats(EPS,Mat*,Mat*);
335: SLEPC_EXTERN PetscErrorCode EPSKrylovSchurUpdateSubcommMats(EPS,PetscScalar,PetscScalar,Mat,PetscScalar,PetscScalar, Mat,MatStructure,PetscBool);
337: /*E
338: EPSLanczosReorthogType - determines the type of reorthogonalization
339: used in the Lanczos method
341: Level: advanced
343: .seealso: EPSLanczosSetReorthog(), EPSLanczosGetReorthog()
344: E*/
345: typedef enum { EPS_LANCZOS_REORTHOG_LOCAL,
346: EPS_LANCZOS_REORTHOG_FULL,
347: EPS_LANCZOS_REORTHOG_SELECTIVE,
348: EPS_LANCZOS_REORTHOG_PERIODIC,
349: EPS_LANCZOS_REORTHOG_PARTIAL,
350: EPS_LANCZOS_REORTHOG_DELAYED } EPSLanczosReorthogType;
351: SLEPC_EXTERN const char *EPSLanczosReorthogTypes[];
353: SLEPC_EXTERN PetscErrorCode EPSLanczosSetReorthog(EPS,EPSLanczosReorthogType);
354: SLEPC_EXTERN PetscErrorCode EPSLanczosGetReorthog(EPS,EPSLanczosReorthogType*);
356: SLEPC_EXTERN PetscErrorCode EPSBlzpackSetBlockSize(EPS,PetscInt);
357: SLEPC_EXTERN PetscErrorCode EPSBlzpackGetBlockSize(EPS,PetscInt*);
358: SLEPC_EXTERN PetscErrorCode EPSBlzpackSetNSteps(EPS,PetscInt);
359: SLEPC_EXTERN PetscErrorCode EPSBlzpackGetNSteps(EPS,PetscInt*);
361: /*E
362: EPSPRIMMEMethod - determines the method selected in the PRIMME library
364: Level: advanced
366: .seealso: EPSPRIMMESetMethod(), EPSPRIMMEGetMethod()
367: E*/
368: typedef enum { EPS_PRIMME_DYNAMIC=1,
369: EPS_PRIMME_DEFAULT_MIN_TIME,
370: EPS_PRIMME_DEFAULT_MIN_MATVECS,
371: EPS_PRIMME_ARNOLDI,
372: EPS_PRIMME_GD,
373: EPS_PRIMME_GD_PLUSK,
374: EPS_PRIMME_GD_OLSEN_PLUSK,
375: EPS_PRIMME_JD_OLSEN_PLUSK,
376: EPS_PRIMME_RQI,
377: EPS_PRIMME_JDQR,
378: EPS_PRIMME_JDQMR,
379: EPS_PRIMME_JDQMR_ETOL,
380: EPS_PRIMME_SUBSPACE_ITERATION,
381: EPS_PRIMME_LOBPCG_ORTHOBASIS,
382: EPS_PRIMME_LOBPCG_ORTHOBASISW } EPSPRIMMEMethod;
383: SLEPC_EXTERN const char *EPSPRIMMEMethods[];
385: SLEPC_EXTERN PetscErrorCode EPSPRIMMESetBlockSize(EPS,PetscInt);
386: SLEPC_EXTERN PetscErrorCode EPSPRIMMEGetBlockSize(EPS,PetscInt*);
387: SLEPC_EXTERN PetscErrorCode EPSPRIMMESetMethod(EPS,EPSPRIMMEMethod);
388: SLEPC_EXTERN PetscErrorCode EPSPRIMMEGetMethod(EPS,EPSPRIMMEMethod*);
390: SLEPC_EXTERN PetscErrorCode EPSGDSetKrylovStart(EPS,PetscBool);
391: SLEPC_EXTERN PetscErrorCode EPSGDGetKrylovStart(EPS,PetscBool*);
392: SLEPC_EXTERN PetscErrorCode EPSGDSetBlockSize(EPS,PetscInt);
393: SLEPC_EXTERN PetscErrorCode EPSGDGetBlockSize(EPS,PetscInt*);
394: SLEPC_EXTERN PetscErrorCode EPSGDSetRestart(EPS,PetscInt,PetscInt);
395: SLEPC_EXTERN PetscErrorCode EPSGDGetRestart(EPS,PetscInt*,PetscInt*);
396: SLEPC_EXTERN PetscErrorCode EPSGDSetInitialSize(EPS,PetscInt);
397: SLEPC_EXTERN PetscErrorCode EPSGDGetInitialSize(EPS,PetscInt*);
398: SLEPC_EXTERN PetscErrorCode EPSGDSetBOrth(EPS,PetscBool);
399: SLEPC_EXTERN PetscErrorCode EPSGDGetBOrth(EPS,PetscBool*);
400: SLEPC_EXTERN PetscErrorCode EPSGDSetDoubleExpansion(EPS,PetscBool);
401: SLEPC_EXTERN PetscErrorCode EPSGDGetDoubleExpansion(EPS,PetscBool*);
403: SLEPC_EXTERN PetscErrorCode EPSJDSetKrylovStart(EPS,PetscBool);
404: SLEPC_EXTERN PetscErrorCode EPSJDGetKrylovStart(EPS,PetscBool*);
405: SLEPC_EXTERN PetscErrorCode EPSJDSetBlockSize(EPS,PetscInt);
406: SLEPC_EXTERN PetscErrorCode EPSJDGetBlockSize(EPS,PetscInt*);
407: SLEPC_EXTERN PetscErrorCode EPSJDSetRestart(EPS,PetscInt,PetscInt);
408: SLEPC_EXTERN PetscErrorCode EPSJDGetRestart(EPS,PetscInt*,PetscInt*);
409: SLEPC_EXTERN PetscErrorCode EPSJDSetInitialSize(EPS,PetscInt);
410: SLEPC_EXTERN PetscErrorCode EPSJDGetInitialSize(EPS,PetscInt*);
411: SLEPC_EXTERN PetscErrorCode EPSJDSetFix(EPS,PetscReal);
412: SLEPC_EXTERN PetscErrorCode EPSJDGetFix(EPS,PetscReal*);
413: SLEPC_EXTERN PetscErrorCode EPSJDSetConstCorrectionTol(EPS,PetscBool);
414: SLEPC_EXTERN PetscErrorCode EPSJDGetConstCorrectionTol(EPS,PetscBool*);
415: SLEPC_EXTERN PetscErrorCode EPSJDSetBOrth(EPS,PetscBool);
416: SLEPC_EXTERN PetscErrorCode EPSJDGetBOrth(EPS,PetscBool*);
418: SLEPC_EXTERN PetscErrorCode EPSRQCGSetReset(EPS,PetscInt);
419: SLEPC_EXTERN PetscErrorCode EPSRQCGGetReset(EPS,PetscInt*);
421: SLEPC_EXTERN PetscErrorCode EPSLOBPCGSetBlockSize(EPS,PetscInt);
422: SLEPC_EXTERN PetscErrorCode EPSLOBPCGGetBlockSize(EPS,PetscInt*);
423: SLEPC_EXTERN PetscErrorCode EPSLOBPCGSetRestart(EPS,PetscReal);
424: SLEPC_EXTERN PetscErrorCode EPSLOBPCGGetRestart(EPS,PetscReal*);
425: SLEPC_EXTERN PetscErrorCode EPSLOBPCGSetLocking(EPS,PetscBool);
426: SLEPC_EXTERN PetscErrorCode EPSLOBPCGGetLocking(EPS,PetscBool*);
428: /*E
429: EPSCISSQuadRule - determines the quadrature rule in the CISS solver
431: Level: advanced
433: .seealso: EPSCISSSetQuadRule(), EPSCISSGetQuadRule()
434: E*/
435: typedef enum { EPS_CISS_QUADRULE_TRAPEZOIDAL=1,
436: EPS_CISS_QUADRULE_CHEBYSHEV } EPSCISSQuadRule;
437: SLEPC_EXTERN const char *EPSCISSQuadRules[];
439: /*E
440: EPSCISSExtraction - determines the extraction technique in the CISS solver
442: Level: advanced
444: .seealso: EPSCISSSetExtraction(), EPSCISSGetExtraction()
445: E*/
446: typedef enum { EPS_CISS_EXTRACTION_RITZ,
447: EPS_CISS_EXTRACTION_HANKEL } EPSCISSExtraction;
448: SLEPC_EXTERN const char *EPSCISSExtractions[];
450: SLEPC_EXTERN PetscErrorCode EPSCISSSetExtraction(EPS,EPSCISSExtraction);
451: SLEPC_EXTERN PetscErrorCode EPSCISSGetExtraction(EPS,EPSCISSExtraction*);
452: SLEPC_EXTERN PetscErrorCode EPSCISSSetQuadRule(EPS,EPSCISSQuadRule);
453: SLEPC_EXTERN PetscErrorCode EPSCISSGetQuadRule(EPS,EPSCISSQuadRule*);
454: SLEPC_EXTERN PetscErrorCode EPSCISSSetSizes(EPS,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscBool);
455: SLEPC_EXTERN PetscErrorCode EPSCISSGetSizes(EPS,PetscInt*,PetscInt*,PetscInt*,PetscInt*,PetscInt*,PetscBool*);
456: SLEPC_EXTERN PetscErrorCode EPSCISSSetThreshold(EPS,PetscReal,PetscReal);
457: SLEPC_EXTERN PetscErrorCode EPSCISSGetThreshold(EPS,PetscReal*,PetscReal*);
458: SLEPC_EXTERN PetscErrorCode EPSCISSSetRefinement(EPS,PetscInt,PetscInt);
459: SLEPC_EXTERN PetscErrorCode EPSCISSGetRefinement(EPS,PetscInt*,PetscInt*);
460: SLEPC_EXTERN PetscErrorCode EPSCISSSetUseST(EPS,PetscBool);
461: SLEPC_EXTERN PetscErrorCode EPSCISSGetUseST(EPS,PetscBool*);
462: SLEPC_EXTERN PetscErrorCode EPSCISSGetKSPs(EPS,PetscInt*,KSP**);
464: PETSC_EXTERN PetscErrorCode EPSLyapIISetLME(EPS,LME);
465: PETSC_EXTERN PetscErrorCode EPSLyapIIGetLME(EPS,LME*);
466: PETSC_EXTERN PetscErrorCode EPSLyapIISetRanks(EPS,PetscInt,PetscInt);
467: PETSC_EXTERN PetscErrorCode EPSLyapIIGetRanks(EPS,PetscInt*,PetscInt*);
469: SLEPC_EXTERN PetscErrorCode EPSBLOPEXSetBlockSize(EPS,PetscInt);
470: SLEPC_EXTERN PetscErrorCode EPSBLOPEXGetBlockSize(EPS,PetscInt*);
472: #endif