Actual source code: slepceps.h
slepc-3.10.1 2018-10-23
Report Typos and Errors

      1: /*
      2:    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      3:    SLEPc - Scalable Library for Eigenvalue Problem Computations
      4:    Copyright (c) 2002-2018, 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: */

     16:  #include <slepcst.h>
     17:  #include <slepcbv.h>
     18:  #include <slepcds.h>
     19:  #include <slepcrg.h>
     20: #include <petscsnes.h>

     22: PETSC_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: PETSC_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: PETSC_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: PETSC_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: PETSC_EXTERN const char *const*EPSConvergedReasons;

    177: PETSC_EXTERN PetscErrorCode EPSCreate(MPI_Comm,EPS*);
    178: PETSC_EXTERN PetscErrorCode EPSDestroy(EPS*);
    179: PETSC_EXTERN PetscErrorCode EPSReset(EPS);
    180: PETSC_EXTERN PetscErrorCode EPSSetType(EPS,EPSType);
    181: PETSC_EXTERN PetscErrorCode EPSGetType(EPS,EPSType*);
    182: PETSC_EXTERN PetscErrorCode EPSSetProblemType(EPS,EPSProblemType);
    183: PETSC_EXTERN PetscErrorCode EPSGetProblemType(EPS,EPSProblemType*);
    184: PETSC_EXTERN PetscErrorCode EPSSetExtraction(EPS,EPSExtraction);
    185: PETSC_EXTERN PetscErrorCode EPSGetExtraction(EPS,EPSExtraction*);
    186: PETSC_EXTERN PetscErrorCode EPSSetBalance(EPS,EPSBalance,PetscInt,PetscReal);
    187: PETSC_EXTERN PetscErrorCode EPSGetBalance(EPS,EPSBalance*,PetscInt*,PetscReal*);
    188: PETSC_EXTERN PetscErrorCode EPSSetOperators(EPS,Mat,Mat);
    189: PETSC_EXTERN PetscErrorCode EPSGetOperators(EPS,Mat*,Mat*);
    190: PETSC_EXTERN PetscErrorCode EPSSetFromOptions(EPS);
    191: PETSC_EXTERN PetscErrorCode EPSSetUp(EPS);
    192: PETSC_EXTERN PetscErrorCode EPSSolve(EPS);
    193: PETSC_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: PETSC_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: PETSC_EXTERN PetscErrorCode EPSErrorViewFromOptions(EPS);
    198: PETSC_EXTERN PetscErrorCode EPSReasonView(EPS,PetscViewer);
    199: PETSC_EXTERN PetscErrorCode EPSReasonViewFromOptions(EPS);
    200: PETSC_EXTERN PetscErrorCode EPSValuesView(EPS,PetscViewer);
    201: PETSC_EXTERN PetscErrorCode EPSValuesViewFromOptions(EPS);
    202: PETSC_EXTERN PetscErrorCode EPSVectorsView(EPS,PetscViewer);
    203: PETSC_EXTERN PetscErrorCode EPSVectorsViewFromOptions(EPS);

    205: PETSC_EXTERN PetscErrorCode EPSSetTarget(EPS,PetscScalar);
    206: PETSC_EXTERN PetscErrorCode EPSGetTarget(EPS,PetscScalar*);
    207: PETSC_EXTERN PetscErrorCode EPSSetInterval(EPS,PetscReal,PetscReal);
    208: PETSC_EXTERN PetscErrorCode EPSGetInterval(EPS,PetscReal*,PetscReal*);
    209: PETSC_EXTERN PetscErrorCode EPSSetST(EPS,ST);
    210: PETSC_EXTERN PetscErrorCode EPSGetST(EPS,ST*);
    211: PETSC_EXTERN PetscErrorCode EPSSetBV(EPS,BV);
    212: PETSC_EXTERN PetscErrorCode EPSGetBV(EPS,BV*);
    213: PETSC_EXTERN PetscErrorCode EPSSetRG(EPS,RG);
    214: PETSC_EXTERN PetscErrorCode EPSGetRG(EPS,RG*);
    215: PETSC_EXTERN PetscErrorCode EPSSetDS(EPS,DS);
    216: PETSC_EXTERN PetscErrorCode EPSGetDS(EPS,DS*);
    217: PETSC_EXTERN PetscErrorCode EPSSetTolerances(EPS,PetscReal,PetscInt);
    218: PETSC_EXTERN PetscErrorCode EPSGetTolerances(EPS,PetscReal*,PetscInt*);
    219: PETSC_EXTERN PetscErrorCode EPSSetConvergenceTestFunction(EPS,PetscErrorCode (*)(EPS,PetscScalar,PetscScalar,PetscReal,PetscReal*,void*),void*,PetscErrorCode (*)(void*));
    220: PETSC_EXTERN PetscErrorCode EPSSetConvergenceTest(EPS,EPSConv);
    221: PETSC_EXTERN PetscErrorCode EPSGetConvergenceTest(EPS,EPSConv*);
    222: PETSC_EXTERN PetscErrorCode EPSConvergedAbsolute(EPS,PetscScalar,PetscScalar,PetscReal,PetscReal*,void*);
    223: PETSC_EXTERN PetscErrorCode EPSConvergedRelative(EPS,PetscScalar,PetscScalar,PetscReal,PetscReal*,void*);
    224: PETSC_EXTERN PetscErrorCode EPSConvergedNorm(EPS,PetscScalar,PetscScalar,PetscReal,PetscReal*,void*);
    225: PETSC_EXTERN PetscErrorCode EPSSetStoppingTestFunction(EPS,PetscErrorCode (*)(EPS,PetscInt,PetscInt,PetscInt,PetscInt,EPSConvergedReason*,void*),void*,PetscErrorCode (*)(void*));
    226: PETSC_EXTERN PetscErrorCode EPSSetStoppingTest(EPS,EPSStop);
    227: PETSC_EXTERN PetscErrorCode EPSGetStoppingTest(EPS,EPSStop*);
    228: PETSC_EXTERN PetscErrorCode EPSStoppingBasic(EPS,PetscInt,PetscInt,PetscInt,PetscInt,EPSConvergedReason*,void*);
    229: PETSC_EXTERN PetscErrorCode EPSGetConvergedReason(EPS,EPSConvergedReason*);

    231: PETSC_EXTERN PetscErrorCode EPSSetDimensions(EPS,PetscInt,PetscInt,PetscInt);
    232: PETSC_EXTERN PetscErrorCode EPSGetDimensions(EPS,PetscInt*,PetscInt*,PetscInt*);

    234: PETSC_EXTERN PetscErrorCode EPSGetConverged(EPS,PetscInt*);
    235: PETSC_EXTERN PetscErrorCode EPSGetEigenpair(EPS,PetscInt,PetscScalar*,PetscScalar*,Vec,Vec);
    236: PETSC_EXTERN PetscErrorCode EPSGetEigenvalue(EPS,PetscInt,PetscScalar*,PetscScalar*);
    237: PETSC_EXTERN PetscErrorCode EPSGetEigenvector(EPS,PetscInt,Vec,Vec);

    239: PETSC_EXTERN PetscErrorCode EPSComputeError(EPS,PetscInt,EPSErrorType,PetscReal*);
    240: PETSC_DEPRECATED("Use EPSComputeError()") PETSC_STATIC_INLINE PetscErrorCode EPSComputeRelativeError(EPS eps,PetscInt i,PetscReal *r) {return EPSComputeError(eps,i,EPS_ERROR_RELATIVE,r);}
    241: 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);}
    242: PETSC_EXTERN PetscErrorCode EPSGetInvariantSubspace(EPS,Vec*);
    243: PETSC_EXTERN PetscErrorCode EPSGetErrorEstimate(EPS,PetscInt,PetscReal*);

    245: PETSC_EXTERN PetscErrorCode EPSMonitor(EPS,PetscInt,PetscInt,PetscScalar*,PetscScalar*,PetscReal*,PetscInt);
    246: PETSC_EXTERN PetscErrorCode EPSMonitorSet(EPS,PetscErrorCode (*)(EPS,PetscInt,PetscInt,PetscScalar*,PetscScalar*,PetscReal*,PetscInt,void*),void*,PetscErrorCode (*)(void**));
    247: PETSC_EXTERN PetscErrorCode EPSMonitorSetFromOptions(EPS,const char*,const char*,const char*,PetscErrorCode (*)(EPS,PetscInt,PetscInt,PetscScalar*,PetscScalar*,PetscReal*,PetscInt,PetscViewerAndFormat*),PetscBool);
    248: PETSC_EXTERN PetscErrorCode EPSConvMonitorSetFromOptions(EPS,const char*,const char*,const char*,PetscErrorCode (*)(EPS,PetscInt,PetscInt,PetscScalar*,PetscScalar*,PetscReal*,PetscInt,SlepcConvMonitor));
    249: PETSC_EXTERN PetscErrorCode EPSMonitorCancel(EPS);
    250: PETSC_EXTERN PetscErrorCode EPSGetMonitorContext(EPS,void**);
    251: PETSC_EXTERN PetscErrorCode EPSGetIterationNumber(EPS,PetscInt*);

    253: PETSC_EXTERN PetscErrorCode EPSSetWhichEigenpairs(EPS,EPSWhich);
    254: PETSC_EXTERN PetscErrorCode EPSGetWhichEigenpairs(EPS,EPSWhich*);
    255: PETSC_EXTERN PetscErrorCode EPSSetTrueResidual(EPS,PetscBool);
    256: PETSC_EXTERN PetscErrorCode EPSGetTrueResidual(EPS,PetscBool*);
    257: PETSC_EXTERN PetscErrorCode EPSSetPurify(EPS,PetscBool);
    258: PETSC_EXTERN PetscErrorCode EPSGetPurify(EPS,PetscBool*);
    259: PETSC_EXTERN PetscErrorCode EPSSetEigenvalueComparison(EPS,PetscErrorCode (*func)(PetscScalar,PetscScalar,PetscScalar,PetscScalar,PetscInt*,void*),void*);
    260: PETSC_EXTERN PetscErrorCode EPSSetArbitrarySelection(EPS,PetscErrorCode (*func)(PetscScalar,PetscScalar,Vec,Vec,PetscScalar*,PetscScalar*,void*),void*);
    261: PETSC_EXTERN PetscErrorCode EPSIsGeneralized(EPS,PetscBool*);
    262: PETSC_EXTERN PetscErrorCode EPSIsHermitian(EPS,PetscBool*);
    263: PETSC_EXTERN PetscErrorCode EPSIsPositive(EPS,PetscBool*);

    265: PETSC_EXTERN PetscErrorCode EPSMonitorFirst(EPS,PetscInt,PetscInt,PetscScalar*,PetscScalar*,PetscReal*,PetscInt,PetscViewerAndFormat*);
    266: PETSC_EXTERN PetscErrorCode EPSMonitorAll(EPS,PetscInt,PetscInt,PetscScalar*,PetscScalar*,PetscReal*,PetscInt,PetscViewerAndFormat*);
    267: PETSC_EXTERN PetscErrorCode EPSMonitorConverged(EPS,PetscInt,PetscInt,PetscScalar*,PetscScalar*,PetscReal*,PetscInt,SlepcConvMonitor);
    268: PETSC_EXTERN PetscErrorCode EPSMonitorLGCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscDrawLG*);
    269: PETSC_EXTERN PetscErrorCode EPSMonitorLG(EPS,PetscInt,PetscInt,PetscScalar*,PetscScalar*,PetscReal*,PetscInt,void*);
    270: PETSC_EXTERN PetscErrorCode EPSMonitorLGAll(EPS,PetscInt,PetscInt,PetscScalar*,PetscScalar*,PetscReal*,PetscInt,void*);

    272: PETSC_EXTERN PetscErrorCode EPSSetTrackAll(EPS,PetscBool);
    273: PETSC_EXTERN PetscErrorCode EPSGetTrackAll(EPS,PetscBool*);

    275: PETSC_EXTERN PetscErrorCode EPSSetDeflationSpace(EPS,PetscInt,Vec*);
    276: PETSC_EXTERN PetscErrorCode EPSSetInitialSpace(EPS,PetscInt,Vec*);

    278: PETSC_EXTERN PetscErrorCode EPSSetOptionsPrefix(EPS,const char*);
    279: PETSC_EXTERN PetscErrorCode EPSAppendOptionsPrefix(EPS,const char*);
    280: PETSC_EXTERN PetscErrorCode EPSGetOptionsPrefix(EPS,const char*[]);

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

    285: PETSC_EXTERN PetscErrorCode EPSSetWorkVecs(EPS,PetscInt);
    286: PETSC_EXTERN PetscErrorCode EPSAllocateSolution(EPS,PetscInt);

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

    290: /*E
    291:     EPSPowerShiftType - determines the type of shift used in the Power iteration

    293:     Level: advanced

    295: .seealso: EPSPowerSetShiftType(), EPSPowerGetShiftType()
    296: E*/
    297: typedef enum { EPS_POWER_SHIFT_CONSTANT,
    298:                EPS_POWER_SHIFT_RAYLEIGH,
    299:                EPS_POWER_SHIFT_WILKINSON } EPSPowerShiftType;
    300: PETSC_EXTERN const char *EPSPowerShiftTypes[];

    302: PETSC_EXTERN PetscErrorCode EPSPowerSetShiftType(EPS,EPSPowerShiftType);
    303: PETSC_EXTERN PetscErrorCode EPSPowerGetShiftType(EPS,EPSPowerShiftType*);
    304: PETSC_EXTERN PetscErrorCode EPSPowerSetNonlinear(EPS,PetscBool);
    305: PETSC_EXTERN PetscErrorCode EPSPowerGetNonlinear(EPS,PetscBool*);
    306: PETSC_EXTERN PetscErrorCode EPSPowerSetUpdate(EPS,PetscBool);
    307: PETSC_EXTERN PetscErrorCode EPSPowerGetUpdate(EPS,PetscBool*);
    308: PETSC_EXTERN PetscErrorCode EPSPowerSetSNES(EPS,SNES);
    309: PETSC_EXTERN PetscErrorCode EPSPowerGetSNES(EPS,SNES*);

    311: PETSC_EXTERN PetscErrorCode EPSArnoldiSetDelayed(EPS,PetscBool);
    312: PETSC_EXTERN PetscErrorCode EPSArnoldiGetDelayed(EPS,PetscBool*);

    314: PETSC_EXTERN PetscErrorCode EPSKrylovSchurSetRestart(EPS,PetscReal);
    315: PETSC_EXTERN PetscErrorCode EPSKrylovSchurGetRestart(EPS,PetscReal*);
    316: PETSC_EXTERN PetscErrorCode EPSKrylovSchurSetLocking(EPS,PetscBool);
    317: PETSC_EXTERN PetscErrorCode EPSKrylovSchurGetLocking(EPS,PetscBool*);
    318: PETSC_EXTERN PetscErrorCode EPSKrylovSchurSetPartitions(EPS,PetscInt);
    319: PETSC_EXTERN PetscErrorCode EPSKrylovSchurGetPartitions(EPS,PetscInt*);
    320: PETSC_EXTERN PetscErrorCode EPSKrylovSchurSetDetectZeros(EPS,PetscBool);
    321: PETSC_EXTERN PetscErrorCode EPSKrylovSchurGetDetectZeros(EPS,PetscBool*);
    322: PETSC_EXTERN PetscErrorCode EPSKrylovSchurSetDimensions(EPS,PetscInt,PetscInt,PetscInt);
    323: PETSC_EXTERN PetscErrorCode EPSKrylovSchurGetDimensions(EPS,PetscInt*,PetscInt*,PetscInt*);
    324: PETSC_EXTERN PetscErrorCode EPSKrylovSchurSetSubintervals(EPS,PetscReal*);
    325: PETSC_EXTERN PetscErrorCode EPSKrylovSchurGetSubintervals(EPS,PetscReal**);
    326: PETSC_EXTERN PetscErrorCode EPSKrylovSchurGetInertias(EPS,PetscInt*,PetscReal**,PetscInt**);
    327: PETSC_EXTERN PetscErrorCode EPSKrylovSchurGetSubcommInfo(EPS,PetscInt*,PetscInt*,Vec*);
    328: PETSC_EXTERN PetscErrorCode EPSKrylovSchurGetSubcommPairs(EPS,PetscInt,PetscScalar*,Vec);
    329: PETSC_EXTERN PetscErrorCode EPSKrylovSchurGetSubcommMats(EPS,Mat*,Mat*);
    330: PETSC_EXTERN PetscErrorCode EPSKrylovSchurUpdateSubcommMats(EPS,PetscScalar,PetscScalar,Mat,PetscScalar,PetscScalar, Mat,MatStructure,PetscBool);

    332: /*E
    333:     EPSLanczosReorthogType - determines the type of reorthogonalization
    334:     used in the Lanczos method

    336:     Level: advanced

    338: .seealso: EPSLanczosSetReorthog(), EPSLanczosGetReorthog()
    339: E*/
    340: typedef enum { EPS_LANCZOS_REORTHOG_LOCAL,
    341:                EPS_LANCZOS_REORTHOG_FULL,
    342:                EPS_LANCZOS_REORTHOG_SELECTIVE,
    343:                EPS_LANCZOS_REORTHOG_PERIODIC,
    344:                EPS_LANCZOS_REORTHOG_PARTIAL,
    345:                EPS_LANCZOS_REORTHOG_DELAYED } EPSLanczosReorthogType;
    346: PETSC_EXTERN const char *EPSLanczosReorthogTypes[];

    348: PETSC_EXTERN PetscErrorCode EPSLanczosSetReorthog(EPS,EPSLanczosReorthogType);
    349: PETSC_EXTERN PetscErrorCode EPSLanczosGetReorthog(EPS,EPSLanczosReorthogType*);

    351: PETSC_EXTERN PetscErrorCode EPSBlzpackSetBlockSize(EPS,PetscInt);
    352: PETSC_EXTERN PetscErrorCode EPSBlzpackSetNSteps(EPS,PetscInt);

    354: /*E
    355:     EPSPRIMMEMethod - determines the method selected in the PRIMME library

    357:     Level: advanced

    359: .seealso: EPSPRIMMESetMethod(), EPSPRIMMEGetMethod()
    360: E*/
    361: typedef enum { EPS_PRIMME_DYNAMIC=1,
    362:                EPS_PRIMME_DEFAULT_MIN_TIME,
    363:                EPS_PRIMME_DEFAULT_MIN_MATVECS,
    364:                EPS_PRIMME_ARNOLDI,
    365:                EPS_PRIMME_GD,
    366:                EPS_PRIMME_GD_PLUSK,
    367:                EPS_PRIMME_GD_OLSEN_PLUSK,
    368:                EPS_PRIMME_JD_OLSEN_PLUSK,
    369:                EPS_PRIMME_RQI,
    370:                EPS_PRIMME_JDQR,
    371:                EPS_PRIMME_JDQMR,
    372:                EPS_PRIMME_JDQMR_ETOL,
    373:                EPS_PRIMME_SUBSPACE_ITERATION,
    374:                EPS_PRIMME_LOBPCG_ORTHOBASIS,
    375:                EPS_PRIMME_LOBPCG_ORTHOBASISW } EPSPRIMMEMethod;
    376: PETSC_EXTERN const char *EPSPRIMMEMethods[];

    378: PETSC_EXTERN PetscErrorCode EPSPRIMMESetBlockSize(EPS,PetscInt);
    379: PETSC_EXTERN PetscErrorCode EPSPRIMMEGetBlockSize(EPS,PetscInt*);
    380: PETSC_EXTERN PetscErrorCode EPSPRIMMESetMethod(EPS,EPSPRIMMEMethod);
    381: PETSC_EXTERN PetscErrorCode EPSPRIMMEGetMethod(EPS,EPSPRIMMEMethod*);

    383: PETSC_EXTERN PetscErrorCode EPSGDSetKrylovStart(EPS,PetscBool);
    384: PETSC_EXTERN PetscErrorCode EPSGDGetKrylovStart(EPS,PetscBool*);
    385: PETSC_EXTERN PetscErrorCode EPSGDSetBlockSize(EPS,PetscInt);
    386: PETSC_EXTERN PetscErrorCode EPSGDGetBlockSize(EPS,PetscInt*);
    387: PETSC_EXTERN PetscErrorCode EPSGDSetRestart(EPS,PetscInt,PetscInt);
    388: PETSC_EXTERN PetscErrorCode EPSGDGetRestart(EPS,PetscInt*,PetscInt*);
    389: PETSC_EXTERN PetscErrorCode EPSGDSetInitialSize(EPS,PetscInt);
    390: PETSC_EXTERN PetscErrorCode EPSGDGetInitialSize(EPS,PetscInt*);
    391: PETSC_EXTERN PetscErrorCode EPSGDSetBOrth(EPS,PetscBool);
    392: PETSC_EXTERN PetscErrorCode EPSGDGetBOrth(EPS,PetscBool*);
    393: PETSC_EXTERN PetscErrorCode EPSGDSetDoubleExpansion(EPS,PetscBool);
    394: PETSC_EXTERN PetscErrorCode EPSGDGetDoubleExpansion(EPS,PetscBool*);

    396: PETSC_EXTERN PetscErrorCode EPSJDSetKrylovStart(EPS,PetscBool);
    397: PETSC_EXTERN PetscErrorCode EPSJDGetKrylovStart(EPS,PetscBool*);
    398: PETSC_EXTERN PetscErrorCode EPSJDSetBlockSize(EPS,PetscInt);
    399: PETSC_EXTERN PetscErrorCode EPSJDGetBlockSize(EPS,PetscInt*);
    400: PETSC_EXTERN PetscErrorCode EPSJDSetRestart(EPS,PetscInt,PetscInt);
    401: PETSC_EXTERN PetscErrorCode EPSJDGetRestart(EPS,PetscInt*,PetscInt*);
    402: PETSC_EXTERN PetscErrorCode EPSJDSetInitialSize(EPS,PetscInt);
    403: PETSC_EXTERN PetscErrorCode EPSJDGetInitialSize(EPS,PetscInt*);
    404: PETSC_EXTERN PetscErrorCode EPSJDSetFix(EPS,PetscReal);
    405: PETSC_EXTERN PetscErrorCode EPSJDGetFix(EPS,PetscReal*);
    406: PETSC_EXTERN PetscErrorCode EPSJDSetConstCorrectionTol(EPS,PetscBool);
    407: PETSC_EXTERN PetscErrorCode EPSJDGetConstCorrectionTol(EPS,PetscBool*);
    408: PETSC_EXTERN PetscErrorCode EPSJDSetBOrth(EPS,PetscBool);
    409: PETSC_EXTERN PetscErrorCode EPSJDGetBOrth(EPS,PetscBool*);

    411: PETSC_EXTERN PetscErrorCode EPSRQCGSetReset(EPS,PetscInt);
    412: PETSC_EXTERN PetscErrorCode EPSRQCGGetReset(EPS,PetscInt*);

    414: PETSC_EXTERN PetscErrorCode EPSLOBPCGSetBlockSize(EPS,PetscInt);
    415: PETSC_EXTERN PetscErrorCode EPSLOBPCGGetBlockSize(EPS,PetscInt*);
    416: PETSC_EXTERN PetscErrorCode EPSLOBPCGSetRestart(EPS,PetscReal);
    417: PETSC_EXTERN PetscErrorCode EPSLOBPCGGetRestart(EPS,PetscReal*);
    418: PETSC_EXTERN PetscErrorCode EPSLOBPCGSetLocking(EPS,PetscBool);
    419: PETSC_EXTERN PetscErrorCode EPSLOBPCGGetLocking(EPS,PetscBool*);

    421: /*E
    422:     EPSCISSQuadRule - determines the quadrature rule in the CISS solver

    424:     Level: advanced

    426: .seealso: EPSCISSSetQuadRule(), EPSCISSGetQuadRule()
    427: E*/
    428: typedef enum { EPS_CISS_QUADRULE_TRAPEZOIDAL=1,
    429:                EPS_CISS_QUADRULE_CHEBYSHEV } EPSCISSQuadRule;
    430: PETSC_EXTERN const char *EPSCISSQuadRules[];

    432: /*E
    433:     EPSCISSExtraction - determines the extraction technique in the CISS solver

    435:     Level: advanced

    437: .seealso: EPSCISSSetExtraction(), EPSCISSGetExtraction()
    438: E*/
    439: typedef enum { EPS_CISS_EXTRACTION_RITZ,
    440:                EPS_CISS_EXTRACTION_HANKEL } EPSCISSExtraction;
    441: PETSC_EXTERN const char *EPSCISSExtractions[];

    443: PETSC_EXTERN PetscErrorCode EPSCISSSetExtraction(EPS,EPSCISSExtraction);
    444: PETSC_EXTERN PetscErrorCode EPSCISSGetExtraction(EPS,EPSCISSExtraction*);
    445: PETSC_EXTERN PetscErrorCode EPSCISSSetQuadRule(EPS,EPSCISSQuadRule);
    446: PETSC_EXTERN PetscErrorCode EPSCISSGetQuadRule(EPS,EPSCISSQuadRule*);
    447: PETSC_EXTERN PetscErrorCode EPSCISSSetRegion(EPS,PetscScalar,PetscReal,PetscReal);
    448: PETSC_EXTERN PetscErrorCode EPSCISSGetRegion(EPS,PetscScalar*,PetscReal*,PetscReal*);
    449: PETSC_EXTERN PetscErrorCode EPSCISSSetSizes(EPS,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscBool);
    450: PETSC_EXTERN PetscErrorCode EPSCISSGetSizes(EPS,PetscInt*,PetscInt*,PetscInt*,PetscInt*,PetscInt*,PetscBool*);
    451: PETSC_EXTERN PetscErrorCode EPSCISSSetThreshold(EPS,PetscReal,PetscReal);
    452: PETSC_EXTERN PetscErrorCode EPSCISSGetThreshold(EPS,PetscReal*,PetscReal*);
    453: PETSC_EXTERN PetscErrorCode EPSCISSSetRefinement(EPS,PetscInt,PetscInt);
    454: PETSC_EXTERN PetscErrorCode EPSCISSGetRefinement(EPS,PetscInt*,PetscInt*);
    455: PETSC_EXTERN PetscErrorCode EPSCISSSetUseST(EPS,PetscBool);
    456: PETSC_EXTERN PetscErrorCode EPSCISSGetUseST(EPS,PetscBool*);
    457: PETSC_EXTERN PetscErrorCode EPSCISSGetKSPs(EPS,PetscInt*,KSP**);

    459: PETSC_EXTERN PetscErrorCode EPSBLOPEXSetBlockSize(EPS,PetscInt);
    460: PETSC_EXTERN PetscErrorCode EPSBLOPEXGetBlockSize(EPS,PetscInt*);

    462: PETSC_EXTERN PetscErrorCode EPSFEASTSetNumPoints(EPS,PetscInt);
    463: PETSC_EXTERN PetscErrorCode EPSFEASTGetNumPoints(EPS,PetscInt*);

    465: #endif