Actual source code: slepceps.h
slepc-3.11.2 2019-07-30
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"
58: #define EPSFEAST "feast"
60: /* Logging support */
61: SLEPC_EXTERN PetscClassId EPS_CLASSID;
63: /*E
64: EPSProblemType - Determines the type of eigenvalue problem
66: Level: beginner
68: .seealso: EPSSetProblemType(), EPSGetProblemType()
69: E*/
70: typedef enum { EPS_HEP=1,
71: EPS_GHEP,
72: EPS_NHEP,
73: EPS_GNHEP,
74: EPS_PGNHEP,
75: EPS_GHIEP } EPSProblemType;
77: /*E
78: EPSExtraction - Determines the type of extraction technique employed
79: by the eigensolver
81: Level: advanced
83: .seealso: EPSSetExtraction(), EPSGetExtraction()
84: E*/
85: typedef enum { EPS_RITZ,
86: EPS_HARMONIC,
87: EPS_HARMONIC_RELATIVE,
88: EPS_HARMONIC_RIGHT,
89: EPS_HARMONIC_LARGEST,
90: EPS_REFINED,
91: EPS_REFINED_HARMONIC } EPSExtraction;
93: /*E
94: EPSWhich - Determines which part of the spectrum is requested
96: Level: intermediate
98: .seealso: EPSSetWhichEigenpairs(), EPSGetWhichEigenpairs()
99: E*/
100: typedef enum { EPS_LARGEST_MAGNITUDE=1,
101: EPS_SMALLEST_MAGNITUDE,
102: EPS_LARGEST_REAL,
103: EPS_SMALLEST_REAL,
104: EPS_LARGEST_IMAGINARY,
105: EPS_SMALLEST_IMAGINARY,
106: EPS_TARGET_MAGNITUDE,
107: EPS_TARGET_REAL,
108: EPS_TARGET_IMAGINARY,
109: EPS_ALL,
110: EPS_WHICH_USER } EPSWhich;
112: /*E
113: EPSBalance - The type of balancing used for non-Hermitian problems
115: Level: intermediate
117: .seealso: EPSSetBalance()
118: E*/
119: typedef enum { EPS_BALANCE_NONE,
120: EPS_BALANCE_ONESIDE,
121: EPS_BALANCE_TWOSIDE,
122: EPS_BALANCE_USER } EPSBalance;
123: SLEPC_EXTERN const char *EPSBalanceTypes[];
125: /*E
126: EPSErrorType - The error type used to assess accuracy of computed solutions
128: Level: intermediate
130: .seealso: EPSComputeError()
131: E*/
132: typedef enum { EPS_ERROR_ABSOLUTE,
133: EPS_ERROR_RELATIVE,
134: EPS_ERROR_BACKWARD } EPSErrorType;
135: SLEPC_EXTERN const char *EPSErrorTypes[];
137: /*E
138: EPSConv - Determines the convergence test
140: Level: intermediate
142: .seealso: EPSSetConvergenceTest(), EPSSetConvergenceTestFunction()
143: E*/
144: typedef enum { EPS_CONV_ABS,
145: EPS_CONV_REL,
146: EPS_CONV_NORM,
147: EPS_CONV_USER } EPSConv;
149: /*E
150: EPSStop - Determines the stopping test
152: Level: advanced
154: .seealso: EPSSetStoppingTest(), EPSSetStoppingTestFunction()
155: E*/
156: typedef enum { EPS_STOP_BASIC,
157: EPS_STOP_USER } EPSStop;
159: /*E
160: EPSConvergedReason - Reason an eigensolver was said to
161: have converged or diverged
163: Level: intermediate
165: .seealso: EPSSolve(), EPSGetConvergedReason(), EPSSetTolerances()
166: E*/
167: typedef enum {/* converged */
168: EPS_CONVERGED_TOL = 1,
169: EPS_CONVERGED_USER = 2,
170: /* diverged */
171: EPS_DIVERGED_ITS = -1,
172: EPS_DIVERGED_BREAKDOWN = -2,
173: EPS_DIVERGED_SYMMETRY_LOST = -3,
174: EPS_CONVERGED_ITERATING = 0} EPSConvergedReason;
175: SLEPC_EXTERN const char *const*EPSConvergedReasons;
177: SLEPC_EXTERN PetscErrorCode EPSCreate(MPI_Comm,EPS*);
178: SLEPC_EXTERN PetscErrorCode EPSDestroy(EPS*);
179: SLEPC_EXTERN PetscErrorCode EPSReset(EPS);
180: SLEPC_EXTERN PetscErrorCode EPSSetType(EPS,EPSType);
181: SLEPC_EXTERN PetscErrorCode EPSGetType(EPS,EPSType*);
182: SLEPC_EXTERN PetscErrorCode EPSSetProblemType(EPS,EPSProblemType);
183: SLEPC_EXTERN PetscErrorCode EPSGetProblemType(EPS,EPSProblemType*);
184: SLEPC_EXTERN PetscErrorCode EPSSetExtraction(EPS,EPSExtraction);
185: SLEPC_EXTERN PetscErrorCode EPSGetExtraction(EPS,EPSExtraction*);
186: SLEPC_EXTERN PetscErrorCode EPSSetBalance(EPS,EPSBalance,PetscInt,PetscReal);
187: SLEPC_EXTERN PetscErrorCode EPSGetBalance(EPS,EPSBalance*,PetscInt*,PetscReal*);
188: SLEPC_EXTERN PetscErrorCode EPSSetOperators(EPS,Mat,Mat);
189: SLEPC_EXTERN PetscErrorCode EPSGetOperators(EPS,Mat*,Mat*);
190: SLEPC_EXTERN PetscErrorCode EPSSetFromOptions(EPS);
191: SLEPC_EXTERN PetscErrorCode EPSSetUp(EPS);
192: SLEPC_EXTERN PetscErrorCode EPSSolve(EPS);
193: SLEPC_EXTERN PetscErrorCode EPSView(EPS,PetscViewer);
194: PETSC_STATIC_INLINE PetscErrorCode EPSViewFromOptions(EPS eps,PetscObject obj,const char name[]) {return PetscObjectViewFromOptions((PetscObject)eps,obj,name);}
195: SLEPC_EXTERN PetscErrorCode EPSErrorView(EPS,EPSErrorType,PetscViewer);
196: PETSC_DEPRECATED("Use EPSErrorView()") PETSC_STATIC_INLINE PetscErrorCode EPSPrintSolution(EPS eps,PetscViewer v) {return EPSErrorView(eps,EPS_ERROR_RELATIVE,v);}
197: SLEPC_EXTERN PetscErrorCode EPSErrorViewFromOptions(EPS);
198: SLEPC_EXTERN PetscErrorCode EPSReasonView(EPS,PetscViewer);
199: SLEPC_EXTERN PetscErrorCode EPSReasonViewFromOptions(EPS);
200: SLEPC_EXTERN PetscErrorCode EPSValuesView(EPS,PetscViewer);
201: SLEPC_EXTERN PetscErrorCode EPSValuesViewFromOptions(EPS);
202: SLEPC_EXTERN PetscErrorCode EPSVectorsView(EPS,PetscViewer);
203: SLEPC_EXTERN PetscErrorCode EPSVectorsViewFromOptions(EPS);
205: SLEPC_EXTERN PetscErrorCode EPSSetTarget(EPS,PetscScalar);
206: SLEPC_EXTERN PetscErrorCode EPSGetTarget(EPS,PetscScalar*);
207: SLEPC_EXTERN PetscErrorCode EPSSetInterval(EPS,PetscReal,PetscReal);
208: SLEPC_EXTERN PetscErrorCode EPSGetInterval(EPS,PetscReal*,PetscReal*);
209: SLEPC_EXTERN PetscErrorCode EPSSetST(EPS,ST);
210: SLEPC_EXTERN PetscErrorCode EPSGetST(EPS,ST*);
211: SLEPC_EXTERN PetscErrorCode EPSSetBV(EPS,BV);
212: SLEPC_EXTERN PetscErrorCode EPSGetBV(EPS,BV*);
213: SLEPC_EXTERN PetscErrorCode EPSSetRG(EPS,RG);
214: SLEPC_EXTERN PetscErrorCode EPSGetRG(EPS,RG*);
215: SLEPC_EXTERN PetscErrorCode EPSSetDS(EPS,DS);
216: SLEPC_EXTERN PetscErrorCode EPSGetDS(EPS,DS*);
217: SLEPC_EXTERN PetscErrorCode EPSSetTolerances(EPS,PetscReal,PetscInt);
218: SLEPC_EXTERN PetscErrorCode EPSGetTolerances(EPS,PetscReal*,PetscInt*);
219: SLEPC_EXTERN PetscErrorCode EPSSetConvergenceTestFunction(EPS,PetscErrorCode (*)(EPS,PetscScalar,PetscScalar,PetscReal,PetscReal*,void*),void*,PetscErrorCode (*)(void*));
220: SLEPC_EXTERN PetscErrorCode EPSSetConvergenceTest(EPS,EPSConv);
221: SLEPC_EXTERN PetscErrorCode EPSGetConvergenceTest(EPS,EPSConv*);
222: SLEPC_EXTERN PetscErrorCode EPSConvergedAbsolute(EPS,PetscScalar,PetscScalar,PetscReal,PetscReal*,void*);
223: SLEPC_EXTERN PetscErrorCode EPSConvergedRelative(EPS,PetscScalar,PetscScalar,PetscReal,PetscReal*,void*);
224: SLEPC_EXTERN PetscErrorCode EPSConvergedNorm(EPS,PetscScalar,PetscScalar,PetscReal,PetscReal*,void*);
225: SLEPC_EXTERN PetscErrorCode EPSSetStoppingTestFunction(EPS,PetscErrorCode (*)(EPS,PetscInt,PetscInt,PetscInt,PetscInt,EPSConvergedReason*,void*),void*,PetscErrorCode (*)(void*));
226: SLEPC_EXTERN PetscErrorCode EPSSetStoppingTest(EPS,EPSStop);
227: SLEPC_EXTERN PetscErrorCode EPSGetStoppingTest(EPS,EPSStop*);
228: SLEPC_EXTERN PetscErrorCode EPSStoppingBasic(EPS,PetscInt,PetscInt,PetscInt,PetscInt,EPSConvergedReason*,void*);
229: SLEPC_EXTERN PetscErrorCode EPSGetConvergedReason(EPS,EPSConvergedReason*);
231: SLEPC_EXTERN PetscErrorCode EPSSetDimensions(EPS,PetscInt,PetscInt,PetscInt);
232: SLEPC_EXTERN PetscErrorCode EPSGetDimensions(EPS,PetscInt*,PetscInt*,PetscInt*);
234: SLEPC_EXTERN PetscErrorCode EPSGetConverged(EPS,PetscInt*);
235: SLEPC_EXTERN PetscErrorCode EPSGetEigenpair(EPS,PetscInt,PetscScalar*,PetscScalar*,Vec,Vec);
236: SLEPC_EXTERN PetscErrorCode EPSGetEigenvalue(EPS,PetscInt,PetscScalar*,PetscScalar*);
237: SLEPC_EXTERN PetscErrorCode EPSGetEigenvector(EPS,PetscInt,Vec,Vec);
238: SLEPC_EXTERN PetscErrorCode EPSGetLeftEigenvector(EPS,PetscInt,Vec,Vec);
240: SLEPC_EXTERN PetscErrorCode EPSComputeError(EPS,PetscInt,EPSErrorType,PetscReal*);
241: PETSC_DEPRECATED("Use EPSComputeError()") PETSC_STATIC_INLINE PetscErrorCode EPSComputeRelativeError(EPS eps,PetscInt i,PetscReal *r) {return EPSComputeError(eps,i,EPS_ERROR_RELATIVE,r);}
242: PETSC_DEPRECATED("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);}
243: SLEPC_EXTERN PetscErrorCode EPSGetInvariantSubspace(EPS,Vec*);
244: SLEPC_EXTERN PetscErrorCode EPSGetErrorEstimate(EPS,PetscInt,PetscReal*);
246: SLEPC_EXTERN PetscErrorCode EPSMonitor(EPS,PetscInt,PetscInt,PetscScalar*,PetscScalar*,PetscReal*,PetscInt);
247: SLEPC_EXTERN PetscErrorCode EPSMonitorSet(EPS,PetscErrorCode (*)(EPS,PetscInt,PetscInt,PetscScalar*,PetscScalar*,PetscReal*,PetscInt,void*),void*,PetscErrorCode (*)(void**));
248: SLEPC_EXTERN PetscErrorCode EPSMonitorSetFromOptions(EPS,const char*,const char*,const char*,PetscErrorCode (*)(EPS,PetscInt,PetscInt,PetscScalar*,PetscScalar*,PetscReal*,PetscInt,PetscViewerAndFormat*),PetscBool);
249: SLEPC_EXTERN PetscErrorCode EPSConvMonitorSetFromOptions(EPS,const char*,const char*,const char*,PetscErrorCode (*)(EPS,PetscInt,PetscInt,PetscScalar*,PetscScalar*,PetscReal*,PetscInt,SlepcConvMonitor));
250: SLEPC_EXTERN PetscErrorCode EPSMonitorCancel(EPS);
251: SLEPC_EXTERN PetscErrorCode EPSGetMonitorContext(EPS,void**);
252: SLEPC_EXTERN PetscErrorCode EPSGetIterationNumber(EPS,PetscInt*);
254: SLEPC_EXTERN PetscErrorCode EPSSetWhichEigenpairs(EPS,EPSWhich);
255: SLEPC_EXTERN PetscErrorCode EPSGetWhichEigenpairs(EPS,EPSWhich*);
256: SLEPC_EXTERN PetscErrorCode EPSSetTwoSided(EPS,PetscBool);
257: SLEPC_EXTERN PetscErrorCode EPSGetTwoSided(EPS,PetscBool*);
258: SLEPC_EXTERN PetscErrorCode EPSSetTrueResidual(EPS,PetscBool);
259: SLEPC_EXTERN PetscErrorCode EPSGetTrueResidual(EPS,PetscBool*);
260: SLEPC_EXTERN PetscErrorCode EPSSetPurify(EPS,PetscBool);
261: SLEPC_EXTERN PetscErrorCode EPSGetPurify(EPS,PetscBool*);
262: SLEPC_EXTERN PetscErrorCode EPSSetEigenvalueComparison(EPS,PetscErrorCode (*func)(PetscScalar,PetscScalar,PetscScalar,PetscScalar,PetscInt*,void*),void*);
263: SLEPC_EXTERN PetscErrorCode EPSSetArbitrarySelection(EPS,PetscErrorCode (*func)(PetscScalar,PetscScalar,Vec,Vec,PetscScalar*,PetscScalar*,void*),void*);
264: SLEPC_EXTERN PetscErrorCode EPSIsGeneralized(EPS,PetscBool*);
265: SLEPC_EXTERN PetscErrorCode EPSIsHermitian(EPS,PetscBool*);
266: SLEPC_EXTERN PetscErrorCode EPSIsPositive(EPS,PetscBool*);
268: SLEPC_EXTERN PetscErrorCode EPSMonitorFirst(EPS,PetscInt,PetscInt,PetscScalar*,PetscScalar*,PetscReal*,PetscInt,PetscViewerAndFormat*);
269: SLEPC_EXTERN PetscErrorCode EPSMonitorAll(EPS,PetscInt,PetscInt,PetscScalar*,PetscScalar*,PetscReal*,PetscInt,PetscViewerAndFormat*);
270: SLEPC_EXTERN PetscErrorCode EPSMonitorConverged(EPS,PetscInt,PetscInt,PetscScalar*,PetscScalar*,PetscReal*,PetscInt,SlepcConvMonitor);
271: SLEPC_EXTERN PetscErrorCode EPSMonitorLGCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscDrawLG*);
272: SLEPC_EXTERN PetscErrorCode EPSMonitorLG(EPS,PetscInt,PetscInt,PetscScalar*,PetscScalar*,PetscReal*,PetscInt,void*);
273: SLEPC_EXTERN PetscErrorCode EPSMonitorLGAll(EPS,PetscInt,PetscInt,PetscScalar*,PetscScalar*,PetscReal*,PetscInt,void*);
275: SLEPC_EXTERN PetscErrorCode EPSSetTrackAll(EPS,PetscBool);
276: SLEPC_EXTERN PetscErrorCode EPSGetTrackAll(EPS,PetscBool*);
278: SLEPC_EXTERN PetscErrorCode EPSSetDeflationSpace(EPS,PetscInt,Vec*);
279: SLEPC_EXTERN PetscErrorCode EPSSetInitialSpace(EPS,PetscInt,Vec*);
281: SLEPC_EXTERN PetscErrorCode EPSSetOptionsPrefix(EPS,const char*);
282: SLEPC_EXTERN PetscErrorCode EPSAppendOptionsPrefix(EPS,const char*);
283: SLEPC_EXTERN PetscErrorCode EPSGetOptionsPrefix(EPS,const char*[]);
285: SLEPC_EXTERN PetscFunctionList EPSList;
286: SLEPC_EXTERN PetscErrorCode EPSRegister(const char[],PetscErrorCode(*)(EPS));
288: SLEPC_EXTERN PetscErrorCode EPSSetWorkVecs(EPS,PetscInt);
289: SLEPC_EXTERN PetscErrorCode EPSAllocateSolution(EPS,PetscInt);
291: /* --------- options specific to particular eigensolvers -------- */
293: /*E
294: EPSPowerShiftType - determines the type of shift used in the Power iteration
296: Level: advanced
298: .seealso: EPSPowerSetShiftType(), EPSPowerGetShiftType()
299: E*/
300: typedef enum { EPS_POWER_SHIFT_CONSTANT,
301: EPS_POWER_SHIFT_RAYLEIGH,
302: EPS_POWER_SHIFT_WILKINSON } EPSPowerShiftType;
303: SLEPC_EXTERN const char *EPSPowerShiftTypes[];
305: SLEPC_EXTERN PetscErrorCode EPSPowerSetShiftType(EPS,EPSPowerShiftType);
306: SLEPC_EXTERN PetscErrorCode EPSPowerGetShiftType(EPS,EPSPowerShiftType*);
307: SLEPC_EXTERN PetscErrorCode EPSPowerSetNonlinear(EPS,PetscBool);
308: SLEPC_EXTERN PetscErrorCode EPSPowerGetNonlinear(EPS,PetscBool*);
309: SLEPC_EXTERN PetscErrorCode EPSPowerSetUpdate(EPS,PetscBool);
310: SLEPC_EXTERN PetscErrorCode EPSPowerGetUpdate(EPS,PetscBool*);
311: SLEPC_EXTERN PetscErrorCode EPSPowerSetSNES(EPS,SNES);
312: SLEPC_EXTERN PetscErrorCode EPSPowerGetSNES(EPS,SNES*);
314: SLEPC_EXTERN PetscErrorCode EPSArnoldiSetDelayed(EPS,PetscBool);
315: SLEPC_EXTERN PetscErrorCode EPSArnoldiGetDelayed(EPS,PetscBool*);
317: SLEPC_EXTERN PetscErrorCode EPSKrylovSchurSetRestart(EPS,PetscReal);
318: SLEPC_EXTERN PetscErrorCode EPSKrylovSchurGetRestart(EPS,PetscReal*);
319: SLEPC_EXTERN PetscErrorCode EPSKrylovSchurSetLocking(EPS,PetscBool);
320: SLEPC_EXTERN PetscErrorCode EPSKrylovSchurGetLocking(EPS,PetscBool*);
321: SLEPC_EXTERN PetscErrorCode EPSKrylovSchurSetPartitions(EPS,PetscInt);
322: SLEPC_EXTERN PetscErrorCode EPSKrylovSchurGetPartitions(EPS,PetscInt*);
323: SLEPC_EXTERN PetscErrorCode EPSKrylovSchurSetDetectZeros(EPS,PetscBool);
324: SLEPC_EXTERN PetscErrorCode EPSKrylovSchurGetDetectZeros(EPS,PetscBool*);
325: SLEPC_EXTERN PetscErrorCode EPSKrylovSchurSetDimensions(EPS,PetscInt,PetscInt,PetscInt);
326: SLEPC_EXTERN PetscErrorCode EPSKrylovSchurGetDimensions(EPS,PetscInt*,PetscInt*,PetscInt*);
327: SLEPC_EXTERN PetscErrorCode EPSKrylovSchurSetSubintervals(EPS,PetscReal*);
328: SLEPC_EXTERN PetscErrorCode EPSKrylovSchurGetSubintervals(EPS,PetscReal**);
329: SLEPC_EXTERN PetscErrorCode EPSKrylovSchurGetInertias(EPS,PetscInt*,PetscReal**,PetscInt**);
330: SLEPC_EXTERN PetscErrorCode EPSKrylovSchurGetSubcommInfo(EPS,PetscInt*,PetscInt*,Vec*);
331: SLEPC_EXTERN PetscErrorCode EPSKrylovSchurGetSubcommPairs(EPS,PetscInt,PetscScalar*,Vec);
332: SLEPC_EXTERN PetscErrorCode EPSKrylovSchurGetSubcommMats(EPS,Mat*,Mat*);
333: SLEPC_EXTERN PetscErrorCode EPSKrylovSchurUpdateSubcommMats(EPS,PetscScalar,PetscScalar,Mat,PetscScalar,PetscScalar, Mat,MatStructure,PetscBool);
335: /*E
336: EPSLanczosReorthogType - determines the type of reorthogonalization
337: used in the Lanczos method
339: Level: advanced
341: .seealso: EPSLanczosSetReorthog(), EPSLanczosGetReorthog()
342: E*/
343: typedef enum { EPS_LANCZOS_REORTHOG_LOCAL,
344: EPS_LANCZOS_REORTHOG_FULL,
345: EPS_LANCZOS_REORTHOG_SELECTIVE,
346: EPS_LANCZOS_REORTHOG_PERIODIC,
347: EPS_LANCZOS_REORTHOG_PARTIAL,
348: EPS_LANCZOS_REORTHOG_DELAYED } EPSLanczosReorthogType;
349: SLEPC_EXTERN const char *EPSLanczosReorthogTypes[];
351: SLEPC_EXTERN PetscErrorCode EPSLanczosSetReorthog(EPS,EPSLanczosReorthogType);
352: SLEPC_EXTERN PetscErrorCode EPSLanczosGetReorthog(EPS,EPSLanczosReorthogType*);
354: SLEPC_EXTERN PetscErrorCode EPSBlzpackSetBlockSize(EPS,PetscInt);
355: SLEPC_EXTERN PetscErrorCode EPSBlzpackSetNSteps(EPS,PetscInt);
357: /*E
358: EPSPRIMMEMethod - determines the method selected in the PRIMME library
360: Level: advanced
362: .seealso: EPSPRIMMESetMethod(), EPSPRIMMEGetMethod()
363: E*/
364: typedef enum { EPS_PRIMME_DYNAMIC=1,
365: EPS_PRIMME_DEFAULT_MIN_TIME,
366: EPS_PRIMME_DEFAULT_MIN_MATVECS,
367: EPS_PRIMME_ARNOLDI,
368: EPS_PRIMME_GD,
369: EPS_PRIMME_GD_PLUSK,
370: EPS_PRIMME_GD_OLSEN_PLUSK,
371: EPS_PRIMME_JD_OLSEN_PLUSK,
372: EPS_PRIMME_RQI,
373: EPS_PRIMME_JDQR,
374: EPS_PRIMME_JDQMR,
375: EPS_PRIMME_JDQMR_ETOL,
376: EPS_PRIMME_SUBSPACE_ITERATION,
377: EPS_PRIMME_LOBPCG_ORTHOBASIS,
378: EPS_PRIMME_LOBPCG_ORTHOBASISW } EPSPRIMMEMethod;
379: SLEPC_EXTERN const char *EPSPRIMMEMethods[];
381: SLEPC_EXTERN PetscErrorCode EPSPRIMMESetBlockSize(EPS,PetscInt);
382: SLEPC_EXTERN PetscErrorCode EPSPRIMMEGetBlockSize(EPS,PetscInt*);
383: SLEPC_EXTERN PetscErrorCode EPSPRIMMESetMethod(EPS,EPSPRIMMEMethod);
384: SLEPC_EXTERN PetscErrorCode EPSPRIMMEGetMethod(EPS,EPSPRIMMEMethod*);
386: SLEPC_EXTERN PetscErrorCode EPSGDSetKrylovStart(EPS,PetscBool);
387: SLEPC_EXTERN PetscErrorCode EPSGDGetKrylovStart(EPS,PetscBool*);
388: SLEPC_EXTERN PetscErrorCode EPSGDSetBlockSize(EPS,PetscInt);
389: SLEPC_EXTERN PetscErrorCode EPSGDGetBlockSize(EPS,PetscInt*);
390: SLEPC_EXTERN PetscErrorCode EPSGDSetRestart(EPS,PetscInt,PetscInt);
391: SLEPC_EXTERN PetscErrorCode EPSGDGetRestart(EPS,PetscInt*,PetscInt*);
392: SLEPC_EXTERN PetscErrorCode EPSGDSetInitialSize(EPS,PetscInt);
393: SLEPC_EXTERN PetscErrorCode EPSGDGetInitialSize(EPS,PetscInt*);
394: SLEPC_EXTERN PetscErrorCode EPSGDSetBOrth(EPS,PetscBool);
395: SLEPC_EXTERN PetscErrorCode EPSGDGetBOrth(EPS,PetscBool*);
396: SLEPC_EXTERN PetscErrorCode EPSGDSetDoubleExpansion(EPS,PetscBool);
397: SLEPC_EXTERN PetscErrorCode EPSGDGetDoubleExpansion(EPS,PetscBool*);
399: SLEPC_EXTERN PetscErrorCode EPSJDSetKrylovStart(EPS,PetscBool);
400: SLEPC_EXTERN PetscErrorCode EPSJDGetKrylovStart(EPS,PetscBool*);
401: SLEPC_EXTERN PetscErrorCode EPSJDSetBlockSize(EPS,PetscInt);
402: SLEPC_EXTERN PetscErrorCode EPSJDGetBlockSize(EPS,PetscInt*);
403: SLEPC_EXTERN PetscErrorCode EPSJDSetRestart(EPS,PetscInt,PetscInt);
404: SLEPC_EXTERN PetscErrorCode EPSJDGetRestart(EPS,PetscInt*,PetscInt*);
405: SLEPC_EXTERN PetscErrorCode EPSJDSetInitialSize(EPS,PetscInt);
406: SLEPC_EXTERN PetscErrorCode EPSJDGetInitialSize(EPS,PetscInt*);
407: SLEPC_EXTERN PetscErrorCode EPSJDSetFix(EPS,PetscReal);
408: SLEPC_EXTERN PetscErrorCode EPSJDGetFix(EPS,PetscReal*);
409: SLEPC_EXTERN PetscErrorCode EPSJDSetConstCorrectionTol(EPS,PetscBool);
410: SLEPC_EXTERN PetscErrorCode EPSJDGetConstCorrectionTol(EPS,PetscBool*);
411: SLEPC_EXTERN PetscErrorCode EPSJDSetBOrth(EPS,PetscBool);
412: SLEPC_EXTERN PetscErrorCode EPSJDGetBOrth(EPS,PetscBool*);
414: SLEPC_EXTERN PetscErrorCode EPSRQCGSetReset(EPS,PetscInt);
415: SLEPC_EXTERN PetscErrorCode EPSRQCGGetReset(EPS,PetscInt*);
417: SLEPC_EXTERN PetscErrorCode EPSLOBPCGSetBlockSize(EPS,PetscInt);
418: SLEPC_EXTERN PetscErrorCode EPSLOBPCGGetBlockSize(EPS,PetscInt*);
419: SLEPC_EXTERN PetscErrorCode EPSLOBPCGSetRestart(EPS,PetscReal);
420: SLEPC_EXTERN PetscErrorCode EPSLOBPCGGetRestart(EPS,PetscReal*);
421: SLEPC_EXTERN PetscErrorCode EPSLOBPCGSetLocking(EPS,PetscBool);
422: SLEPC_EXTERN PetscErrorCode EPSLOBPCGGetLocking(EPS,PetscBool*);
424: /*E
425: EPSCISSQuadRule - determines the quadrature rule in the CISS solver
427: Level: advanced
429: .seealso: EPSCISSSetQuadRule(), EPSCISSGetQuadRule()
430: E*/
431: typedef enum { EPS_CISS_QUADRULE_TRAPEZOIDAL=1,
432: EPS_CISS_QUADRULE_CHEBYSHEV } EPSCISSQuadRule;
433: SLEPC_EXTERN const char *EPSCISSQuadRules[];
435: /*E
436: EPSCISSExtraction - determines the extraction technique in the CISS solver
438: Level: advanced
440: .seealso: EPSCISSSetExtraction(), EPSCISSGetExtraction()
441: E*/
442: typedef enum { EPS_CISS_EXTRACTION_RITZ,
443: EPS_CISS_EXTRACTION_HANKEL } EPSCISSExtraction;
444: SLEPC_EXTERN const char *EPSCISSExtractions[];
446: SLEPC_EXTERN PetscErrorCode EPSCISSSetExtraction(EPS,EPSCISSExtraction);
447: SLEPC_EXTERN PetscErrorCode EPSCISSGetExtraction(EPS,EPSCISSExtraction*);
448: SLEPC_EXTERN PetscErrorCode EPSCISSSetQuadRule(EPS,EPSCISSQuadRule);
449: SLEPC_EXTERN PetscErrorCode EPSCISSGetQuadRule(EPS,EPSCISSQuadRule*);
450: SLEPC_EXTERN PetscErrorCode EPSCISSSetSizes(EPS,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscBool);
451: SLEPC_EXTERN PetscErrorCode EPSCISSGetSizes(EPS,PetscInt*,PetscInt*,PetscInt*,PetscInt*,PetscInt*,PetscBool*);
452: SLEPC_EXTERN PetscErrorCode EPSCISSSetThreshold(EPS,PetscReal,PetscReal);
453: SLEPC_EXTERN PetscErrorCode EPSCISSGetThreshold(EPS,PetscReal*,PetscReal*);
454: SLEPC_EXTERN PetscErrorCode EPSCISSSetRefinement(EPS,PetscInt,PetscInt);
455: SLEPC_EXTERN PetscErrorCode EPSCISSGetRefinement(EPS,PetscInt*,PetscInt*);
456: SLEPC_EXTERN PetscErrorCode EPSCISSSetUseST(EPS,PetscBool);
457: SLEPC_EXTERN PetscErrorCode EPSCISSGetUseST(EPS,PetscBool*);
458: SLEPC_EXTERN PetscErrorCode EPSCISSGetKSPs(EPS,PetscInt*,KSP**);
460: SLEPC_EXTERN PetscErrorCode EPSBLOPEXSetBlockSize(EPS,PetscInt);
461: SLEPC_EXTERN PetscErrorCode EPSBLOPEXGetBlockSize(EPS,PetscInt*);
463: SLEPC_EXTERN PetscErrorCode EPSFEASTSetNumPoints(EPS,PetscInt);
464: SLEPC_EXTERN PetscErrorCode EPSFEASTGetNumPoints(EPS,PetscInt*);
466: #endif