Actual source code: slepcnep.h

slepc-3.8.2 2017-12-01
Report Typos and Errors
  1: /*
  2:    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  3:    SLEPc - Scalable Library for Eigenvalue Problem Computations
  4:    Copyright (c) 2002-2017, 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 SLEPc's nonlinear eigenvalue solvers
 12: */

 16:  #include <slepceps.h>
 17:  #include <slepcpep.h>
 18:  #include <slepcfn.h>

 20: PETSC_EXTERN PetscErrorCode NEPInitializePackage(void);

 22: /*S
 23:      NEP - Abstract SLEPc object that manages all solvers for
 24:      nonlinear eigenvalue problems.

 26:    Level: beginner

 28: .seealso:  NEPCreate()
 29: S*/
 30: typedef struct _p_NEP* NEP;

 32: /*J
 33:     NEPType - String with the name of a nonlinear eigensolver

 35:    Level: beginner

 37: .seealso: NEPSetType(), NEP
 38: J*/
 39: typedef const char* NEPType;
 40: #define NEPRII       "rii"
 41: #define NEPSLP       "slp"
 42: #define NEPNARNOLDI  "narnoldi"
 43: #define NEPCISS      "ciss"
 44: #define NEPINTERPOL  "interpol"
 45: #define NEPNLEIGS    "nleigs"

 47: /* Logging support */
 48: PETSC_EXTERN PetscClassId NEP_CLASSID;

 50: /*E
 51:     NEPProblemType - Determines the type of the nonlinear eigenproblem

 53:     Level: intermediate

 55: .seealso: NEPSetProblemType(), NEPGetProblemType()
 56: E*/
 57: typedef enum { NEP_GENERAL=1,
 58:                NEP_RATIONAL     /* NEP defined in split form with all f_i rational */
 59:              } NEPProblemType;

 61: /*E
 62:     NEPWhich - Determines which part of the spectrum is requested

 64:     Level: intermediate

 66: .seealso: NEPSetWhichEigenpairs(), NEPGetWhichEigenpairs()
 67: E*/
 68: typedef enum { NEP_LARGEST_MAGNITUDE=1,
 69:                NEP_SMALLEST_MAGNITUDE,
 70:                NEP_LARGEST_REAL,
 71:                NEP_SMALLEST_REAL,
 72:                NEP_LARGEST_IMAGINARY,
 73:                NEP_SMALLEST_IMAGINARY,
 74:                NEP_TARGET_MAGNITUDE,
 75:                NEP_TARGET_REAL,
 76:                NEP_TARGET_IMAGINARY,
 77:                NEP_ALL,
 78:                NEP_WHICH_USER } NEPWhich;

 80: /*E
 81:     NEPErrorType - The error type used to assess accuracy of computed solutions

 83:     Level: intermediate

 85: .seealso: NEPComputeError()
 86: E*/
 87: typedef enum { NEP_ERROR_ABSOLUTE,
 88:                NEP_ERROR_RELATIVE,
 89:                NEP_ERROR_BACKWARD } NEPErrorType;
 90: PETSC_EXTERN const char *NEPErrorTypes[];

 92: /*E
 93:     NEPRefine - The refinement type

 95:     Level: intermediate

 97: .seealso: NEPSetRefine()
 98: E*/
 99: typedef enum { NEP_REFINE_NONE,
100:                NEP_REFINE_SIMPLE,
101:                NEP_REFINE_MULTIPLE } NEPRefine;
102: PETSC_EXTERN const char *NEPRefineTypes[];

104: /*E
105:     NEPRefineScheme - The scheme used for solving linear systems during iterative refinement

107:     Level: intermediate

109: .seealso: NEPSetRefine()
110: E*/
111: typedef enum { NEP_REFINE_SCHEME_SCHUR=1,
112:                NEP_REFINE_SCHEME_MBE,
113:                NEP_REFINE_SCHEME_EXPLICIT } NEPRefineScheme;
114: PETSC_EXTERN const char *NEPRefineSchemes[];

116: /*E
117:     NEPConv - Determines the convergence test

119:     Level: intermediate

121: .seealso: NEPSetConvergenceTest(), NEPSetConvergenceTestFunction()
122: E*/
123: typedef enum { NEP_CONV_ABS,
124:                NEP_CONV_REL,
125:                NEP_CONV_NORM,
126:                NEP_CONV_USER } NEPConv;

128: /*E
129:     NEPStop - Determines the stopping test

131:     Level: advanced

133: .seealso: NEPSetStoppingTest(), NEPSetStoppingTestFunction()
134: E*/
135: typedef enum { NEP_STOP_BASIC,
136:                NEP_STOP_USER } NEPStop;

138: /*E
139:     NEPConvergedReason - Reason a nonlinear eigensolver was said to
140:          have converged or diverged

142:     Level: intermediate

144: .seealso: NEPSolve(), NEPGetConvergedReason(), NEPSetTolerances()
145: E*/
146: typedef enum {/* converged */
147:               NEP_CONVERGED_TOL                =  1,
148:               NEP_CONVERGED_USER               =  2,
149:               /* diverged */
150:               NEP_DIVERGED_ITS                 = -1,
151:               NEP_DIVERGED_BREAKDOWN           = -2,
152:                     /* unused                  = -3 */
153:               NEP_DIVERGED_LINEAR_SOLVE        = -4,
154:               NEP_CONVERGED_ITERATING          =  0} NEPConvergedReason;
155: PETSC_EXTERN const char *const*NEPConvergedReasons;

157: PETSC_EXTERN PetscErrorCode NEPCreate(MPI_Comm,NEP*);
158: PETSC_EXTERN PetscErrorCode NEPDestroy(NEP*);
159: PETSC_EXTERN PetscErrorCode NEPReset(NEP);
160: PETSC_EXTERN PetscErrorCode NEPSetType(NEP,NEPType);
161: PETSC_EXTERN PetscErrorCode NEPGetType(NEP,NEPType*);
162: PETSC_EXTERN PetscErrorCode NEPSetProblemType(NEP,NEPProblemType);
163: PETSC_EXTERN PetscErrorCode NEPGetProblemType(NEP,NEPProblemType*);
164: PETSC_EXTERN PetscErrorCode NEPSetTarget(NEP,PetscScalar);
165: PETSC_EXTERN PetscErrorCode NEPGetTarget(NEP,PetscScalar*);
166: PETSC_EXTERN PetscErrorCode NEPSetFromOptions(NEP);
167: PETSC_EXTERN PetscErrorCode NEPSetUp(NEP);
168: PETSC_EXTERN PetscErrorCode NEPSolve(NEP);
169: PETSC_EXTERN PetscErrorCode NEPView(NEP,PetscViewer);
170: PETSC_STATIC_INLINE PetscErrorCode NEPViewFromOptions(NEP nep,PetscObject obj,const char name[]) {return PetscObjectViewFromOptions((PetscObject)nep,obj,name);}
171: PETSC_EXTERN PetscErrorCode NEPErrorView(NEP,NEPErrorType,PetscViewer);
172: PETSC_EXTERN PetscErrorCode NEPErrorViewFromOptions(NEP);
173: PETSC_EXTERN PetscErrorCode NEPReasonView(NEP,PetscViewer);
174: PETSC_EXTERN PetscErrorCode NEPReasonViewFromOptions(NEP);
175: PETSC_EXTERN PetscErrorCode NEPValuesView(NEP,PetscViewer);
176: PETSC_EXTERN PetscErrorCode NEPValuesViewFromOptions(NEP);
177: PETSC_EXTERN PetscErrorCode NEPVectorsView(NEP,PetscViewer);
178: PETSC_EXTERN PetscErrorCode NEPVectorsViewFromOptions(NEP);

180: PETSC_EXTERN PetscErrorCode NEPSetFunction(NEP,Mat,Mat,PetscErrorCode (*)(NEP,PetscScalar,Mat,Mat,void*),void*);
181: PETSC_EXTERN PetscErrorCode NEPGetFunction(NEP,Mat*,Mat*,PetscErrorCode (**)(NEP,PetscScalar,Mat,Mat,void*),void**);
182: PETSC_EXTERN PetscErrorCode NEPSetJacobian(NEP,Mat,PetscErrorCode (*)(NEP,PetscScalar,Mat,void*),void*);
183: PETSC_EXTERN PetscErrorCode NEPGetJacobian(NEP,Mat*,PetscErrorCode (**)(NEP,PetscScalar,Mat,void*),void**);
184: PETSC_EXTERN PetscErrorCode NEPSetDerivatives(NEP,Mat,PetscErrorCode (*)(NEP,PetscScalar,PetscInt,Mat,void*),void*);
185: PETSC_EXTERN PetscErrorCode NEPGetDerivatives(NEP,Mat*,PetscErrorCode (**)(NEP,PetscScalar,PetscInt,Mat,void*),void**);
186: PETSC_EXTERN PetscErrorCode NEPSetSplitOperator(NEP,PetscInt,Mat*,FN*,MatStructure);
187: PETSC_EXTERN PetscErrorCode NEPGetSplitOperatorTerm(NEP,PetscInt,Mat*,FN*);
188: PETSC_EXTERN PetscErrorCode NEPGetSplitOperatorInfo(NEP,PetscInt*,MatStructure*);

190: PETSC_EXTERN PetscErrorCode NEPSetBV(NEP,BV);
191: PETSC_EXTERN PetscErrorCode NEPGetBV(NEP,BV*);
192: PETSC_EXTERN PetscErrorCode NEPSetRG(NEP,RG);
193: PETSC_EXTERN PetscErrorCode NEPGetRG(NEP,RG*);
194: PETSC_EXTERN PetscErrorCode NEPSetDS(NEP,DS);
195: PETSC_EXTERN PetscErrorCode NEPGetDS(NEP,DS*);
196: PETSC_EXTERN PetscErrorCode NEPRefineGetKSP(NEP,KSP*);
197: PETSC_EXTERN PetscErrorCode NEPSetTolerances(NEP,PetscReal,PetscInt);
198: PETSC_EXTERN PetscErrorCode NEPGetTolerances(NEP,PetscReal*,PetscInt*);
199: PETSC_EXTERN PetscErrorCode NEPSetConvergenceTestFunction(NEP,PetscErrorCode (*)(NEP,PetscScalar,PetscScalar,PetscReal,PetscReal*,void*),void*,PetscErrorCode (*)(void*));
200: PETSC_EXTERN PetscErrorCode NEPSetConvergenceTest(NEP,NEPConv);
201: PETSC_EXTERN PetscErrorCode NEPGetConvergenceTest(NEP,NEPConv*);
202: PETSC_EXTERN PetscErrorCode NEPConvergedAbsolute(NEP,PetscScalar,PetscScalar,PetscReal,PetscReal*,void*);
203: PETSC_EXTERN PetscErrorCode NEPConvergedRelative(NEP,PetscScalar,PetscScalar,PetscReal,PetscReal*,void*);
204: PETSC_EXTERN PetscErrorCode NEPConvergedNorm(NEP,PetscScalar,PetscScalar,PetscReal,PetscReal*,void*);
205: PETSC_EXTERN PetscErrorCode NEPSetStoppingTestFunction(NEP,PetscErrorCode (*)(NEP,PetscInt,PetscInt,PetscInt,PetscInt,NEPConvergedReason*,void*),void*,PetscErrorCode (*)(void*));
206: PETSC_EXTERN PetscErrorCode NEPSetStoppingTest(NEP,NEPStop);
207: PETSC_EXTERN PetscErrorCode NEPGetStoppingTest(NEP,NEPStop*);
208: PETSC_EXTERN PetscErrorCode NEPStoppingBasic(NEP,PetscInt,PetscInt,PetscInt,PetscInt,NEPConvergedReason*,void*);
209: PETSC_EXTERN PetscErrorCode NEPSetDimensions(NEP,PetscInt,PetscInt,PetscInt);
210: PETSC_EXTERN PetscErrorCode NEPGetDimensions(NEP,PetscInt*,PetscInt*,PetscInt*);
211: PETSC_EXTERN PetscErrorCode NEPSetRefine(NEP,NEPRefine,PetscInt,PetscReal,PetscInt,NEPRefineScheme);
212: PETSC_EXTERN PetscErrorCode NEPGetRefine(NEP,NEPRefine*,PetscInt*,PetscReal*,PetscInt*,NEPRefineScheme*);

214: PETSC_EXTERN PetscErrorCode NEPGetConverged(NEP,PetscInt*);
215: PETSC_EXTERN PetscErrorCode NEPGetEigenpair(NEP,PetscInt,PetscScalar*,PetscScalar*,Vec,Vec);

217: PETSC_EXTERN PetscErrorCode NEPComputeError(NEP,PetscInt,NEPErrorType,PetscReal*);
218: PETSC_DEPRECATED("Use NEPComputeError()") PETSC_STATIC_INLINE PetscErrorCode NEPComputeRelativeError(NEP nep,PetscInt i,PetscReal *r) {return NEPComputeError(nep,i,NEP_ERROR_RELATIVE,r);}
219: PETSC_DEPRECATED("Use NEPComputeError() with NEP_ERROR_ABSOLUTE") PETSC_STATIC_INLINE PetscErrorCode NEPComputeResidualNorm(NEP nep,PetscInt i,PetscReal *r) {return NEPComputeError(nep,i,NEP_ERROR_ABSOLUTE,r);}
220: PETSC_EXTERN PetscErrorCode NEPGetErrorEstimate(NEP,PetscInt,PetscReal*);

222: PETSC_EXTERN PetscErrorCode NEPComputeFunction(NEP,PetscScalar,Mat,Mat);
223: PETSC_EXTERN PetscErrorCode NEPComputeJacobian(NEP,PetscScalar,Mat);
224: PETSC_EXTERN PetscErrorCode NEPApplyFunction(NEP,PetscScalar,Vec,Vec,Vec,Mat,Mat);
225: PETSC_EXTERN PetscErrorCode NEPApplyJacobian(NEP,PetscScalar,Vec,Vec,Vec,Mat);
226: PETSC_EXTERN PetscErrorCode NEPProjectOperator(NEP,PetscInt,PetscInt);

228: PETSC_EXTERN PetscErrorCode NEPMonitor(NEP,PetscInt,PetscInt,PetscScalar*,PetscScalar*,PetscReal*,PetscInt);
229: PETSC_EXTERN PetscErrorCode NEPMonitorSet(NEP,PetscErrorCode (*)(NEP,PetscInt,PetscInt,PetscScalar*,PetscScalar*,PetscReal*,PetscInt,void*),void*,PetscErrorCode (*)(void**));
230: PETSC_EXTERN PetscErrorCode NEPMonitorSetFromOptions(NEP,const char*,const char*,const char*,PetscErrorCode (*)(NEP,PetscInt,PetscInt,PetscScalar*,PetscScalar*,PetscReal*,PetscInt,PetscViewerAndFormat*),PetscBool);
231: PETSC_EXTERN PetscErrorCode NEPConvMonitorSetFromOptions(NEP,const char*,const char*,const char*,PetscErrorCode (*)(NEP,PetscInt,PetscInt,PetscScalar*,PetscScalar*,PetscReal*,PetscInt,SlepcConvMonitor));
232: PETSC_EXTERN PetscErrorCode NEPMonitorCancel(NEP);
233: PETSC_EXTERN PetscErrorCode NEPGetMonitorContext(NEP,void **);
234: PETSC_EXTERN PetscErrorCode NEPGetIterationNumber(NEP,PetscInt*);

236: PETSC_EXTERN PetscErrorCode NEPSetInitialSpace(NEP,PetscInt,Vec*);
237: PETSC_EXTERN PetscErrorCode NEPSetWhichEigenpairs(NEP,NEPWhich);
238: PETSC_EXTERN PetscErrorCode NEPGetWhichEigenpairs(NEP,NEPWhich*);
239: PETSC_EXTERN PetscErrorCode NEPSetEigenvalueComparison(NEP,PetscErrorCode (*func)(PetscScalar,PetscScalar,PetscScalar,PetscScalar,PetscInt*,void*),void*);

241: PETSC_EXTERN PetscErrorCode NEPMonitorAll(NEP,PetscInt,PetscInt,PetscScalar*,PetscScalar*,PetscReal*,PetscInt,PetscViewerAndFormat*);
242: PETSC_EXTERN PetscErrorCode NEPMonitorFirst(NEP,PetscInt,PetscInt,PetscScalar*,PetscScalar*,PetscReal*,PetscInt,PetscViewerAndFormat*);
243: PETSC_EXTERN PetscErrorCode NEPMonitorConverged(NEP,PetscInt,PetscInt,PetscScalar*,PetscScalar*,PetscReal*,PetscInt,SlepcConvMonitor);
244: PETSC_EXTERN PetscErrorCode NEPMonitorLGCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscDrawLG*);
245: PETSC_EXTERN PetscErrorCode NEPMonitorLG(NEP,PetscInt,PetscInt,PetscScalar*,PetscScalar*,PetscReal*,PetscInt,void*);
246: PETSC_EXTERN PetscErrorCode NEPMonitorLGAll(NEP,PetscInt,PetscInt,PetscScalar*,PetscScalar*,PetscReal*,PetscInt,void*);

248: PETSC_EXTERN PetscErrorCode NEPSetTrackAll(NEP,PetscBool);
249: PETSC_EXTERN PetscErrorCode NEPGetTrackAll(NEP,PetscBool*);

251: PETSC_EXTERN PetscErrorCode NEPSetOptionsPrefix(NEP,const char*);
252: PETSC_EXTERN PetscErrorCode NEPAppendOptionsPrefix(NEP,const char*);
253: PETSC_EXTERN PetscErrorCode NEPGetOptionsPrefix(NEP,const char*[]);

255: PETSC_EXTERN PetscErrorCode NEPGetConvergedReason(NEP,NEPConvergedReason *);

257: PETSC_EXTERN PetscFunctionList NEPList;
258: PETSC_EXTERN PetscErrorCode NEPRegister(const char[],PetscErrorCode(*)(NEP));

260: PETSC_EXTERN PetscErrorCode NEPSetWorkVecs(NEP,PetscInt);
261: PETSC_EXTERN PetscErrorCode NEPAllocateSolution(NEP,PetscInt);

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

265: PETSC_EXTERN PetscErrorCode NEPRIISetMaximumIterations(NEP,PetscInt);
266: PETSC_EXTERN PetscErrorCode NEPRIIGetMaximumIterations(NEP,PetscInt*);
267: PETSC_EXTERN PetscErrorCode NEPRIISetLagPreconditioner(NEP,PetscInt);
268: PETSC_EXTERN PetscErrorCode NEPRIIGetLagPreconditioner(NEP,PetscInt*);
269: PETSC_EXTERN PetscErrorCode NEPRIISetConstCorrectionTol(NEP,PetscBool);
270: PETSC_EXTERN PetscErrorCode NEPRIIGetConstCorrectionTol(NEP,PetscBool*);
271: PETSC_EXTERN PetscErrorCode NEPRIISetKSP(NEP,KSP);
272: PETSC_EXTERN PetscErrorCode NEPRIIGetKSP(NEP,KSP*);

274: PETSC_EXTERN PetscErrorCode NEPSLPSetEPS(NEP,EPS);
275: PETSC_EXTERN PetscErrorCode NEPSLPGetEPS(NEP,EPS*);

277: PETSC_EXTERN PetscErrorCode NEPNArnoldiSetKSP(NEP,KSP);
278: PETSC_EXTERN PetscErrorCode NEPNArnoldiGetKSP(NEP,KSP*);

280: PETSC_EXTERN PetscErrorCode NEPCISSSetSizes(NEP,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscBool);
281: PETSC_EXTERN PetscErrorCode NEPCISSGetSizes(NEP,PetscInt*,PetscInt*,PetscInt*,PetscInt*,PetscInt*,PetscBool*);
282: PETSC_EXTERN PetscErrorCode NEPCISSSetThreshold(NEP,PetscReal,PetscReal);
283: PETSC_EXTERN PetscErrorCode NEPCISSGetThreshold(NEP,PetscReal*,PetscReal*);
284: PETSC_EXTERN PetscErrorCode NEPCISSSetRefinement(NEP,PetscInt,PetscInt);
285: PETSC_EXTERN PetscErrorCode NEPCISSGetRefinement(NEP,PetscInt*,PetscInt*);

287: PETSC_EXTERN PetscErrorCode NEPInterpolSetPEP(NEP,PEP);
288: PETSC_EXTERN PetscErrorCode NEPInterpolGetPEP(NEP,PEP*);
289: PETSC_EXTERN PetscErrorCode NEPInterpolSetInterpolation(NEP,PetscReal,PetscInt);
290: PETSC_EXTERN PetscErrorCode NEPInterpolGetInterpolation(NEP,PetscReal*,PetscInt*);

292: PETSC_EXTERN PetscErrorCode NEPNLEIGSSetSingularitiesFunction(NEP,PetscErrorCode (*)(NEP,PetscInt*,PetscScalar*,void*),void*);
293: PETSC_EXTERN PetscErrorCode NEPNLEIGSGetSingularitiesFunction(NEP,PetscErrorCode (**)(NEP,PetscInt*,PetscScalar*,void*),void **);
294: PETSC_EXTERN PetscErrorCode NEPNLEIGSSetRestart(NEP,PetscReal);
295: PETSC_EXTERN PetscErrorCode NEPNLEIGSGetRestart(NEP,PetscReal*);
296: PETSC_EXTERN PetscErrorCode NEPNLEIGSSetLocking(NEP,PetscBool);
297: PETSC_EXTERN PetscErrorCode NEPNLEIGSGetLocking(NEP,PetscBool*);
298: PETSC_EXTERN PetscErrorCode NEPNLEIGSSetInterpolation(NEP,PetscReal,PetscInt);
299: PETSC_EXTERN PetscErrorCode NEPNLEIGSGetInterpolation(NEP,PetscReal*,PetscInt*);
300: PETSC_EXTERN PetscErrorCode NEPNLEIGSSetRKShifts(NEP,PetscInt,PetscScalar*);
301: PETSC_EXTERN PetscErrorCode NEPNLEIGSGetRKShifts(NEP,PetscInt*,PetscScalar**);
302: PETSC_EXTERN PetscErrorCode NEPNLEIGSGetKSPs(NEP,KSP**);

304: #endif