Actual source code: slepceps.h

slepc-3.7.0 2016-05-16
Report Typos and Errors
  1: /*
  2:    User interface for the SLEPC eigenproblem solvers.

  4:    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  5:    SLEPc - Scalable Library for Eigenvalue Problem Computations
  6:    Copyright (c) 2002-2016, Universitat Politecnica de Valencia, Spain

  8:    This file is part of SLEPc.

 10:    SLEPc is free software: you can redistribute it and/or modify it under  the
 11:    terms of version 3 of the GNU Lesser General Public License as published by
 12:    the Free Software Foundation.

 14:    SLEPc  is  distributed in the hope that it will be useful, but WITHOUT  ANY
 15:    WARRANTY;  without even the implied warranty of MERCHANTABILITY or  FITNESS
 16:    FOR  A  PARTICULAR PURPOSE. See the GNU Lesser General Public  License  for
 17:    more details.

 19:    You  should have received a copy of the GNU Lesser General  Public  License
 20:    along with SLEPc. If not, see <http://www.gnu.org/licenses/>.
 21:    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 22: */

 26: #include <slepcst.h>
 27: #include <slepcbv.h>
 28: #include <slepcds.h>
 29: #include <slepcrg.h>

 31: PETSC_EXTERN PetscErrorCode EPSInitializePackage(void);

 33: /*S
 34:     EPS - Abstract SLEPc object that manages all the eigenvalue
 35:     problem solvers.

 37:     Level: beginner

 39: .seealso:  EPSCreate(), ST
 40: S*/
 41: typedef struct _p_EPS* EPS;

 43: /*J
 44:     EPSType - String with the name of a SLEPc eigensolver

 46:     Level: beginner

 48: .seealso: EPSSetType(), EPS
 49: J*/
 50: typedef const char* EPSType;
 51: #define EPSPOWER       "power"
 52: #define EPSSUBSPACE    "subspace"
 53: #define EPSARNOLDI     "arnoldi"
 54: #define EPSLANCZOS     "lanczos"
 55: #define EPSKRYLOVSCHUR "krylovschur"
 56: #define EPSGD          "gd"
 57: #define EPSJD          "jd"
 58: #define EPSRQCG        "rqcg"
 59: #define EPSLOBPCG      "lobpcg"
 60: #define EPSCISS        "ciss"
 61: #define EPSLAPACK      "lapack"
 62: #define EPSARPACK      "arpack"
 63: #define EPSBLZPACK     "blzpack"
 64: #define EPSTRLAN       "trlan"
 65: #define EPSBLOPEX      "blopex"
 66: #define EPSPRIMME      "primme"
 67: #define EPSFEAST       "feast"

 69: /* Logging support */
 70: PETSC_EXTERN PetscClassId EPS_CLASSID;

 72: /*E
 73:     EPSProblemType - Determines the type of eigenvalue problem

 75:     Level: beginner

 77: .seealso: EPSSetProblemType(), EPSGetProblemType()
 78: E*/
 79: typedef enum { EPS_HEP=1,
 80:                EPS_GHEP,
 81:                EPS_NHEP,
 82:                EPS_GNHEP,
 83:                EPS_PGNHEP,
 84:                EPS_GHIEP } EPSProblemType;

 86: /*E
 87:     EPSExtraction - Determines the type of extraction technique employed
 88:     by the eigensolver

 90:     Level: advanced

 92: .seealso: EPSSetExtraction(), EPSGetExtraction()
 93: E*/
 94: typedef enum { EPS_RITZ,
 95:                EPS_HARMONIC,
 96:                EPS_HARMONIC_RELATIVE,
 97:                EPS_HARMONIC_RIGHT,
 98:                EPS_HARMONIC_LARGEST,
 99:                EPS_REFINED,
100:                EPS_REFINED_HARMONIC } EPSExtraction;

102: /*E
103:     EPSWhich - Determines which part of the spectrum is requested

105:     Level: intermediate

107: .seealso: EPSSetWhichEigenpairs(), EPSGetWhichEigenpairs()
108: E*/
109: typedef enum { EPS_LARGEST_MAGNITUDE=1,
110:                EPS_SMALLEST_MAGNITUDE,
111:                EPS_LARGEST_REAL,
112:                EPS_SMALLEST_REAL,
113:                EPS_LARGEST_IMAGINARY,
114:                EPS_SMALLEST_IMAGINARY,
115:                EPS_TARGET_MAGNITUDE,
116:                EPS_TARGET_REAL,
117:                EPS_TARGET_IMAGINARY,
118:                EPS_ALL,
119:                EPS_WHICH_USER } EPSWhich;

121: /*E
122:     EPSBalance - The type of balancing used for non-Hermitian problems

124:     Level: intermediate

126: .seealso: EPSSetBalance()
127: E*/
128: typedef enum { EPS_BALANCE_NONE,
129:                EPS_BALANCE_ONESIDE,
130:                EPS_BALANCE_TWOSIDE,
131:                EPS_BALANCE_USER } EPSBalance;
132: PETSC_EXTERN const char *EPSBalanceTypes[];

134: /*E
135:     EPSErrorType - The error type used to assess accuracy of computed solutions

137:     Level: intermediate

139: .seealso: EPSComputeError()
140: E*/
141: typedef enum { EPS_ERROR_ABSOLUTE,
142:                EPS_ERROR_RELATIVE,
143:                EPS_ERROR_BACKWARD } EPSErrorType;
144: PETSC_EXTERN const char *EPSErrorTypes[];

146: /*E
147:     EPSConv - Determines the convergence test

149:     Level: intermediate

151: .seealso: EPSSetConvergenceTest(), EPSSetConvergenceTestFunction()
152: E*/
153: typedef enum { EPS_CONV_ABS,
154:                EPS_CONV_REL,
155:                EPS_CONV_NORM,
156:                EPS_CONV_USER } EPSConv;

158: /*E
159:     EPSStop - Determines the stopping test

161:     Level: advanced

163: .seealso: EPSSetStoppingTest(), EPSSetStoppingTestFunction()
164: E*/
165: typedef enum { EPS_STOP_BASIC,
166:                EPS_STOP_USER } EPSStop;

168: /*E
169:     EPSConvergedReason - Reason an eigensolver was said to
170:          have converged or diverged

172:     Level: intermediate

174: .seealso: EPSSolve(), EPSGetConvergedReason(), EPSSetTolerances()
175: E*/
176: typedef enum {/* converged */
177:               EPS_CONVERGED_TOL                =  1,
178:               EPS_CONVERGED_USER               =  2,
179:               /* diverged */
180:               EPS_DIVERGED_ITS                 = -1,
181:               EPS_DIVERGED_BREAKDOWN           = -2,
182:               EPS_DIVERGED_SYMMETRY_LOST       = -3,
183:               EPS_CONVERGED_ITERATING          =  0} EPSConvergedReason;
184: PETSC_EXTERN const char *const*EPSConvergedReasons;

186: PETSC_EXTERN PetscErrorCode EPSCreate(MPI_Comm,EPS*);
187: PETSC_EXTERN PetscErrorCode EPSDestroy(EPS*);
188: PETSC_EXTERN PetscErrorCode EPSReset(EPS);
189: PETSC_EXTERN PetscErrorCode EPSSetType(EPS,EPSType);
190: PETSC_EXTERN PetscErrorCode EPSGetType(EPS,EPSType*);
191: PETSC_EXTERN PetscErrorCode EPSSetProblemType(EPS,EPSProblemType);
192: PETSC_EXTERN PetscErrorCode EPSGetProblemType(EPS,EPSProblemType*);
193: PETSC_EXTERN PetscErrorCode EPSSetExtraction(EPS,EPSExtraction);
194: PETSC_EXTERN PetscErrorCode EPSGetExtraction(EPS,EPSExtraction*);
195: PETSC_EXTERN PetscErrorCode EPSSetBalance(EPS,EPSBalance,PetscInt,PetscReal);
196: PETSC_EXTERN PetscErrorCode EPSGetBalance(EPS,EPSBalance*,PetscInt*,PetscReal*);
197: PETSC_EXTERN PetscErrorCode EPSSetOperators(EPS,Mat,Mat);
198: PETSC_EXTERN PetscErrorCode EPSGetOperators(EPS,Mat*,Mat*);
199: PETSC_EXTERN PetscErrorCode EPSSetFromOptions(EPS);
200: PETSC_EXTERN PetscErrorCode EPSSetUp(EPS);
201: PETSC_EXTERN PetscErrorCode EPSSolve(EPS);
202: PETSC_EXTERN PetscErrorCode EPSView(EPS,PetscViewer);
203: PETSC_STATIC_INLINE PetscErrorCode EPSViewFromOptions(EPS eps,PetscObject obj,const char name[]) {return PetscObjectViewFromOptions((PetscObject)eps,obj,name);}
204: PETSC_EXTERN PetscErrorCode EPSErrorView(EPS,EPSErrorType,PetscViewer);
205: PETSC_DEPRECATED("Use EPSErrorView()") PETSC_STATIC_INLINE PetscErrorCode EPSPrintSolution(EPS eps,PetscViewer v) {return EPSErrorView(eps,EPS_ERROR_RELATIVE,v);}
206: PETSC_EXTERN PetscErrorCode EPSErrorViewFromOptions(EPS);
207: PETSC_EXTERN PetscErrorCode EPSReasonView(EPS,PetscViewer);
208: PETSC_EXTERN PetscErrorCode EPSReasonViewFromOptions(EPS);
209: PETSC_EXTERN PetscErrorCode EPSValuesView(EPS,PetscViewer);
210: PETSC_EXTERN PetscErrorCode EPSValuesViewFromOptions(EPS);
211: PETSC_EXTERN PetscErrorCode EPSVectorsView(EPS,PetscViewer);
212: PETSC_EXTERN PetscErrorCode EPSVectorsViewFromOptions(EPS);

214: PETSC_EXTERN PetscErrorCode EPSSetTarget(EPS,PetscScalar);
215: PETSC_EXTERN PetscErrorCode EPSGetTarget(EPS,PetscScalar*);
216: PETSC_EXTERN PetscErrorCode EPSSetInterval(EPS,PetscReal,PetscReal);
217: PETSC_EXTERN PetscErrorCode EPSGetInterval(EPS,PetscReal*,PetscReal*);
218: PETSC_EXTERN PetscErrorCode EPSSetST(EPS,ST);
219: PETSC_EXTERN PetscErrorCode EPSGetST(EPS,ST*);
220: PETSC_EXTERN PetscErrorCode EPSSetBV(EPS,BV);
221: PETSC_EXTERN PetscErrorCode EPSGetBV(EPS,BV*);
222: PETSC_EXTERN PetscErrorCode EPSSetRG(EPS,RG);
223: PETSC_EXTERN PetscErrorCode EPSGetRG(EPS,RG*);
224: PETSC_EXTERN PetscErrorCode EPSSetDS(EPS,DS);
225: PETSC_EXTERN PetscErrorCode EPSGetDS(EPS,DS*);
226: PETSC_EXTERN PetscErrorCode EPSSetTolerances(EPS,PetscReal,PetscInt);
227: PETSC_EXTERN PetscErrorCode EPSGetTolerances(EPS,PetscReal*,PetscInt*);
228: PETSC_EXTERN PetscErrorCode EPSSetConvergenceTestFunction(EPS,PetscErrorCode (*)(EPS,PetscScalar,PetscScalar,PetscReal,PetscReal*,void*),void*,PetscErrorCode (*)(void*));
229: PETSC_EXTERN PetscErrorCode EPSSetConvergenceTest(EPS,EPSConv);
230: PETSC_EXTERN PetscErrorCode EPSGetConvergenceTest(EPS,EPSConv*);
231: PETSC_EXTERN PetscErrorCode EPSConvergedAbsolute(EPS,PetscScalar,PetscScalar,PetscReal,PetscReal*,void*);
232: PETSC_EXTERN PetscErrorCode EPSConvergedRelative(EPS,PetscScalar,PetscScalar,PetscReal,PetscReal*,void*);
233: PETSC_EXTERN PetscErrorCode EPSConvergedNorm(EPS,PetscScalar,PetscScalar,PetscReal,PetscReal*,void*);
234: PETSC_EXTERN PetscErrorCode EPSSetStoppingTestFunction(EPS,PetscErrorCode (*)(EPS,PetscInt,PetscInt,PetscInt,PetscInt,EPSConvergedReason*,void*),void*,PetscErrorCode (*)(void*));
235: PETSC_EXTERN PetscErrorCode EPSSetStoppingTest(EPS,EPSStop);
236: PETSC_EXTERN PetscErrorCode EPSGetStoppingTest(EPS,EPSStop*);
237: PETSC_EXTERN PetscErrorCode EPSStoppingBasic(EPS,PetscInt,PetscInt,PetscInt,PetscInt,EPSConvergedReason*,void*);
238: PETSC_EXTERN PetscErrorCode EPSGetConvergedReason(EPS,EPSConvergedReason*);

240: PETSC_EXTERN PetscErrorCode EPSSetDimensions(EPS,PetscInt,PetscInt,PetscInt);
241: PETSC_EXTERN PetscErrorCode EPSGetDimensions(EPS,PetscInt*,PetscInt*,PetscInt*);

243: PETSC_EXTERN PetscErrorCode EPSGetConverged(EPS,PetscInt*);
244: PETSC_EXTERN PetscErrorCode EPSGetEigenpair(EPS,PetscInt,PetscScalar*,PetscScalar*,Vec,Vec);
245: PETSC_EXTERN PetscErrorCode EPSGetEigenvalue(EPS,PetscInt,PetscScalar*,PetscScalar*);
246: PETSC_EXTERN PetscErrorCode EPSGetEigenvector(EPS,PetscInt,Vec,Vec);

248: PETSC_EXTERN PetscErrorCode EPSComputeError(EPS,PetscInt,EPSErrorType,PetscReal*);
249: PETSC_DEPRECATED("Use EPSComputeError()") PETSC_STATIC_INLINE PetscErrorCode EPSComputeRelativeError(EPS eps,PetscInt i,PetscReal *r) {return EPSComputeError(eps,i,EPS_ERROR_RELATIVE,r);}
250: 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);}
251: PETSC_EXTERN PetscErrorCode EPSGetInvariantSubspace(EPS,Vec*);
252: PETSC_EXTERN PetscErrorCode EPSGetErrorEstimate(EPS,PetscInt,PetscReal*);

254: PETSC_EXTERN PetscErrorCode EPSMonitor(EPS,PetscInt,PetscInt,PetscScalar*,PetscScalar*,PetscReal*,PetscInt);
255: PETSC_EXTERN PetscErrorCode EPSMonitorSet(EPS,PetscErrorCode (*)(EPS,PetscInt,PetscInt,PetscScalar*,PetscScalar*,PetscReal*,PetscInt,void*),void*,PetscErrorCode (*)(void**));
256: PETSC_EXTERN PetscErrorCode EPSMonitorSetFromOptions(EPS,const char*,const char*,const char*,PetscErrorCode (*)(EPS,PetscInt,PetscInt,PetscScalar*,PetscScalar*,PetscReal*,PetscInt,PetscViewerAndFormat*),PetscBool);
257: PETSC_EXTERN PetscErrorCode EPSConvMonitorSetFromOptions(EPS,const char*,const char*,const char*,PetscErrorCode (*)(EPS,PetscInt,PetscInt,PetscScalar*,PetscScalar*,PetscReal*,PetscInt,SlepcConvMonitor));
258: PETSC_EXTERN PetscErrorCode EPSMonitorCancel(EPS);
259: PETSC_EXTERN PetscErrorCode EPSGetMonitorContext(EPS,void**);
260: PETSC_EXTERN PetscErrorCode EPSGetIterationNumber(EPS,PetscInt*);

262: PETSC_EXTERN PetscErrorCode EPSSetWhichEigenpairs(EPS,EPSWhich);
263: PETSC_EXTERN PetscErrorCode EPSGetWhichEigenpairs(EPS,EPSWhich*);
264: PETSC_EXTERN PetscErrorCode EPSSetTrueResidual(EPS,PetscBool);
265: PETSC_EXTERN PetscErrorCode EPSGetTrueResidual(EPS,PetscBool*);
266: PETSC_EXTERN PetscErrorCode EPSSetPurify(EPS,PetscBool);
267: PETSC_EXTERN PetscErrorCode EPSGetPurify(EPS,PetscBool*);
268: PETSC_EXTERN PetscErrorCode EPSSetEigenvalueComparison(EPS,PetscErrorCode (*func)(PetscScalar,PetscScalar,PetscScalar,PetscScalar,PetscInt*,void*),void*);
269: PETSC_EXTERN PetscErrorCode EPSSetArbitrarySelection(EPS,PetscErrorCode (*func)(PetscScalar,PetscScalar,Vec,Vec,PetscScalar*,PetscScalar*,void*),void*);
270: PETSC_EXTERN PetscErrorCode EPSIsGeneralized(EPS,PetscBool*);
271: PETSC_EXTERN PetscErrorCode EPSIsHermitian(EPS,PetscBool*);
272: PETSC_EXTERN PetscErrorCode EPSIsPositive(EPS,PetscBool*);

274: PETSC_EXTERN PetscErrorCode EPSMonitorFirst(EPS,PetscInt,PetscInt,PetscScalar*,PetscScalar*,PetscReal*,PetscInt,PetscViewerAndFormat*);
275: PETSC_EXTERN PetscErrorCode EPSMonitorAll(EPS,PetscInt,PetscInt,PetscScalar*,PetscScalar*,PetscReal*,PetscInt,PetscViewerAndFormat*);
276: PETSC_EXTERN PetscErrorCode EPSMonitorConverged(EPS,PetscInt,PetscInt,PetscScalar*,PetscScalar*,PetscReal*,PetscInt,SlepcConvMonitor);
277: PETSC_EXTERN PetscErrorCode EPSMonitorLGCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscDrawLG*);
278: PETSC_EXTERN PetscErrorCode EPSMonitorLG(EPS,PetscInt,PetscInt,PetscScalar*,PetscScalar*,PetscReal*,PetscInt,void*);
279: PETSC_EXTERN PetscErrorCode EPSMonitorLGAll(EPS,PetscInt,PetscInt,PetscScalar*,PetscScalar*,PetscReal*,PetscInt,void*);

281: PETSC_EXTERN PetscErrorCode EPSSetTrackAll(EPS,PetscBool);
282: PETSC_EXTERN PetscErrorCode EPSGetTrackAll(EPS,PetscBool*);

284: PETSC_EXTERN PetscErrorCode EPSSetDeflationSpace(EPS,PetscInt,Vec*);
285: PETSC_EXTERN PetscErrorCode EPSSetInitialSpace(EPS,PetscInt,Vec*);

287: PETSC_EXTERN PetscErrorCode EPSSetOptionsPrefix(EPS,const char*);
288: PETSC_EXTERN PetscErrorCode EPSAppendOptionsPrefix(EPS,const char*);
289: PETSC_EXTERN PetscErrorCode EPSGetOptionsPrefix(EPS,const char*[]);

291: PETSC_EXTERN PetscFunctionList EPSList;
292: PETSC_EXTERN PetscErrorCode EPSRegister(const char[],PetscErrorCode(*)(EPS));

294: PETSC_EXTERN PetscErrorCode EPSSetWorkVecs(EPS,PetscInt);
295: PETSC_EXTERN PetscErrorCode EPSAllocateSolution(EPS,PetscInt);

297: /* --------- options specific to particular eigensolvers -------- */

299: /*E
300:     EPSPowerShiftType - determines the type of shift used in the Power iteration

302:     Level: advanced

304: .seealso: EPSPowerSetShiftType(), EPSPowerGetShiftType()
305: E*/
306: typedef enum { EPS_POWER_SHIFT_CONSTANT,
307:                EPS_POWER_SHIFT_RAYLEIGH,
308:                EPS_POWER_SHIFT_WILKINSON } EPSPowerShiftType;
309: PETSC_EXTERN const char *EPSPowerShiftTypes[];

311: PETSC_EXTERN PetscErrorCode EPSPowerSetShiftType(EPS,EPSPowerShiftType);
312: PETSC_EXTERN PetscErrorCode EPSPowerGetShiftType(EPS,EPSPowerShiftType*);

314: PETSC_EXTERN PetscErrorCode EPSArnoldiSetDelayed(EPS,PetscBool);
315: PETSC_EXTERN PetscErrorCode EPSArnoldiGetDelayed(EPS,PetscBool*);

317: PETSC_EXTERN PetscErrorCode EPSKrylovSchurSetRestart(EPS,PetscReal);
318: PETSC_EXTERN PetscErrorCode EPSKrylovSchurGetRestart(EPS,PetscReal*);
319: PETSC_EXTERN PetscErrorCode EPSKrylovSchurSetLocking(EPS,PetscBool);
320: PETSC_EXTERN PetscErrorCode EPSKrylovSchurGetLocking(EPS,PetscBool*);
321: PETSC_EXTERN PetscErrorCode EPSKrylovSchurSetPartitions(EPS,PetscInt);
322: PETSC_EXTERN PetscErrorCode EPSKrylovSchurGetPartitions(EPS,PetscInt*);
323: PETSC_EXTERN PetscErrorCode EPSKrylovSchurSetDetectZeros(EPS,PetscBool);
324: PETSC_EXTERN PetscErrorCode EPSKrylovSchurGetDetectZeros(EPS,PetscBool*);
325: PETSC_EXTERN PetscErrorCode EPSKrylovSchurSetDimensions(EPS,PetscInt,PetscInt,PetscInt);
326: PETSC_EXTERN PetscErrorCode EPSKrylovSchurGetDimensions(EPS,PetscInt*,PetscInt*,PetscInt*);
327: PETSC_EXTERN PetscErrorCode EPSKrylovSchurSetSubintervals(EPS,PetscReal*);
328: PETSC_EXTERN PetscErrorCode EPSKrylovSchurGetSubintervals(EPS,PetscReal**);
329: PETSC_EXTERN PetscErrorCode EPSKrylovSchurGetInertias(EPS,PetscInt*,PetscReal**,PetscInt**);
330: PETSC_EXTERN PetscErrorCode EPSKrylovSchurGetSubcommInfo(EPS,PetscInt*,PetscInt*,Vec*);
331: PETSC_EXTERN PetscErrorCode EPSKrylovSchurGetSubcommPairs(EPS,PetscInt,PetscScalar*,Vec);
332: PETSC_EXTERN PetscErrorCode EPSKrylovSchurGetSubcommMats(EPS,Mat*,Mat*);
333: PETSC_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: PETSC_EXTERN const char *EPSLanczosReorthogTypes[];

351: PETSC_EXTERN PetscErrorCode EPSLanczosSetReorthog(EPS,EPSLanczosReorthogType);
352: PETSC_EXTERN PetscErrorCode EPSLanczosGetReorthog(EPS,EPSLanczosReorthogType*);

354: PETSC_EXTERN PetscErrorCode EPSBlzpackSetBlockSize(EPS,PetscInt);
355: PETSC_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,
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: PETSC_EXTERN const char *EPSPRIMMEMethods[];

381: PETSC_EXTERN PetscErrorCode EPSPRIMMESetBlockSize(EPS,PetscInt);
382: PETSC_EXTERN PetscErrorCode EPSPRIMMESetMethod(EPS,EPSPRIMMEMethod);
383: PETSC_EXTERN PetscErrorCode EPSPRIMMEGetBlockSize(EPS,PetscInt*);
384: PETSC_EXTERN PetscErrorCode EPSPRIMMEGetMethod(EPS,EPSPRIMMEMethod*);

386: PETSC_EXTERN PetscErrorCode EPSGDSetKrylovStart(EPS,PetscBool);
387: PETSC_EXTERN PetscErrorCode EPSGDGetKrylovStart(EPS,PetscBool*);
388: PETSC_EXTERN PetscErrorCode EPSGDSetBlockSize(EPS,PetscInt);
389: PETSC_EXTERN PetscErrorCode EPSGDGetBlockSize(EPS,PetscInt*);
390: PETSC_EXTERN PetscErrorCode EPSGDSetRestart(EPS,PetscInt,PetscInt);
391: PETSC_EXTERN PetscErrorCode EPSGDGetRestart(EPS,PetscInt*,PetscInt*);
392: PETSC_EXTERN PetscErrorCode EPSGDSetInitialSize(EPS,PetscInt);
393: PETSC_EXTERN PetscErrorCode EPSGDGetInitialSize(EPS,PetscInt*);
394: PETSC_EXTERN PetscErrorCode EPSGDSetBOrth(EPS,PetscBool);
395: PETSC_EXTERN PetscErrorCode EPSGDGetBOrth(EPS,PetscBool*);
396: PETSC_EXTERN PetscErrorCode EPSGDGetWindowSizes(EPS,PetscInt*,PetscInt*);
397: PETSC_EXTERN PetscErrorCode EPSGDSetWindowSizes(EPS,PetscInt,PetscInt);
398: PETSC_EXTERN PetscErrorCode EPSGDSetDoubleExpansion(EPS,PetscBool);
399: PETSC_EXTERN PetscErrorCode EPSGDGetDoubleExpansion(EPS,PetscBool*);

401: PETSC_EXTERN PetscErrorCode EPSJDSetKrylovStart(EPS,PetscBool);
402: PETSC_EXTERN PetscErrorCode EPSJDGetKrylovStart(EPS,PetscBool*);
403: PETSC_EXTERN PetscErrorCode EPSJDSetBlockSize(EPS,PetscInt);
404: PETSC_EXTERN PetscErrorCode EPSJDGetBlockSize(EPS,PetscInt*);
405: PETSC_EXTERN PetscErrorCode EPSJDSetRestart(EPS,PetscInt,PetscInt);
406: PETSC_EXTERN PetscErrorCode EPSJDGetRestart(EPS,PetscInt*,PetscInt*);
407: PETSC_EXTERN PetscErrorCode EPSJDSetInitialSize(EPS,PetscInt);
408: PETSC_EXTERN PetscErrorCode EPSJDGetInitialSize(EPS,PetscInt*);
409: PETSC_EXTERN PetscErrorCode EPSJDSetFix(EPS,PetscReal);
410: PETSC_EXTERN PetscErrorCode EPSJDGetFix(EPS,PetscReal*);
411: PETSC_EXTERN PetscErrorCode EPSJDSetConstCorrectionTol(EPS,PetscBool);
412: PETSC_EXTERN PetscErrorCode EPSJDGetConstCorrectionTol(EPS,PetscBool*);
413: PETSC_EXTERN PetscErrorCode EPSJDSetBOrth(EPS,PetscBool);
414: PETSC_EXTERN PetscErrorCode EPSJDGetBOrth(EPS,PetscBool*);
415: PETSC_EXTERN PetscErrorCode EPSJDGetWindowSizes(EPS,PetscInt*,PetscInt*);
416: PETSC_EXTERN PetscErrorCode EPSJDSetWindowSizes(EPS,PetscInt,PetscInt);

418: PETSC_EXTERN PetscErrorCode EPSRQCGSetReset(EPS,PetscInt);
419: PETSC_EXTERN PetscErrorCode EPSRQCGGetReset(EPS,PetscInt*);

421: PETSC_EXTERN PetscErrorCode EPSLOBPCGSetBlockSize(EPS,PetscInt);
422: PETSC_EXTERN PetscErrorCode EPSLOBPCGGetBlockSize(EPS,PetscInt*);
423: PETSC_EXTERN PetscErrorCode EPSLOBPCGSetRestart(EPS,PetscReal);
424: PETSC_EXTERN PetscErrorCode EPSLOBPCGGetRestart(EPS,PetscReal*);
425: PETSC_EXTERN PetscErrorCode EPSLOBPCGSetLocking(EPS,PetscBool);
426: PETSC_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: PETSC_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: PETSC_EXTERN const char *EPSCISSExtractions[];

450: PETSC_EXTERN PetscErrorCode EPSCISSSetExtraction(EPS,EPSCISSExtraction);
451: PETSC_EXTERN PetscErrorCode EPSCISSGetExtraction(EPS,EPSCISSExtraction*);
452: PETSC_EXTERN PetscErrorCode EPSCISSSetQuadRule(EPS,EPSCISSQuadRule);
453: PETSC_EXTERN PetscErrorCode EPSCISSGetQuadRule(EPS,EPSCISSQuadRule*);
454: PETSC_EXTERN PetscErrorCode EPSCISSSetRegion(EPS,PetscScalar,PetscReal,PetscReal);
455: PETSC_EXTERN PetscErrorCode EPSCISSGetRegion(EPS,PetscScalar*,PetscReal*,PetscReal*);
456: PETSC_EXTERN PetscErrorCode EPSCISSSetSizes(EPS,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscBool);
457: PETSC_EXTERN PetscErrorCode EPSCISSGetSizes(EPS,PetscInt*,PetscInt*,PetscInt*,PetscInt*,PetscInt*,PetscBool*);
458: PETSC_EXTERN PetscErrorCode EPSCISSSetThreshold(EPS,PetscReal,PetscReal);
459: PETSC_EXTERN PetscErrorCode EPSCISSGetThreshold(EPS,PetscReal*,PetscReal*);
460: PETSC_EXTERN PetscErrorCode EPSCISSSetRefinement(EPS,PetscInt,PetscInt);
461: PETSC_EXTERN PetscErrorCode EPSCISSGetRefinement(EPS,PetscInt*,PetscInt*);
462: PETSC_EXTERN PetscErrorCode EPSCISSSetUseST(EPS,PetscBool);
463: PETSC_EXTERN PetscErrorCode EPSCISSGetUseST(EPS,PetscBool*);

465: PETSC_EXTERN PetscErrorCode EPSBLOPEXSetBlockSize(EPS,PetscInt);
466: PETSC_EXTERN PetscErrorCode EPSBLOPEXGetBlockSize(EPS,PetscInt*);

468: PETSC_EXTERN PetscErrorCode EPSFEASTSetNumPoints(EPS,PetscInt);
469: PETSC_EXTERN PetscErrorCode EPSFEASTGetNumPoints(EPS,PetscInt*);

471: #endif