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