Date: 2022-08-09T09:06:01+00:00

Actual source code: slepceps.h
slepc-3.17.2 2022-08-09
Report Typos and Errors

      1: /*
      2:    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      3:    SLEPc - Scalable Library for Eigenvalue Problem Computations
      4:    Copyright (c) 2002-, 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 <slepclme.h>
     21: #include <petscsnes.h>

     23: SLEPC_EXTERN PetscErrorCode EPSInitializePackage(void);

     25: /*S
     26:     EPS - Abstract SLEPc object that manages all the eigenvalue
     27:     problem solvers.

     29:     Level: beginner

     31: .seealso:  EPSCreate(), ST
     32: S*/
     33: typedef struct _p_EPS* EPS;

     35: /*J
     36:     EPSType - String with the name of a SLEPc eigensolver

     38:     Level: beginner

     40: .seealso: EPSSetType(), EPS
     41: J*/
     42: typedef const char* EPSType;
     43: #define EPSPOWER       "power"
     44: #define EPSSUBSPACE    "subspace"
     45: #define EPSARNOLDI     "arnoldi"
     46: #define EPSLANCZOS     "lanczos"
     47: #define EPSKRYLOVSCHUR "krylovschur"
     48: #define EPSGD          "gd"
     49: #define EPSJD          "jd"
     50: #define EPSRQCG        "rqcg"
     51: #define EPSLOBPCG      "lobpcg"
     52: #define EPSCISS        "ciss"
     53: #define EPSLYAPII      "lyapii"
     54: #define EPSLAPACK      "lapack"
     55: #define EPSARPACK      "arpack"
     56: #define EPSTRLAN       "trlan"
     57: #define EPSBLOPEX      "blopex"
     58: #define EPSPRIMME      "primme"
     59: #define EPSFEAST       "feast"
     60: #define EPSSCALAPACK   "scalapack"
     61: #define EPSELPA        "elpa"
     62: #define EPSELEMENTAL   "elemental"
     63: #define EPSEVSL        "evsl"

     65: /* Logging support */
     66: SLEPC_EXTERN PetscClassId EPS_CLASSID;

     68: /*E
     69:     EPSProblemType - Determines the type of eigenvalue problem

     71:     Level: beginner

     73: .seealso: EPSSetProblemType(), EPSGetProblemType()
     74: E*/
     75: typedef enum { EPS_HEP=1,
     76:                EPS_GHEP,
     77:                EPS_NHEP,
     78:                EPS_GNHEP,
     79:                EPS_PGNHEP,
     80:                EPS_GHIEP } EPSProblemType;

     82: /*E
     83:     EPSExtraction - Determines the type of extraction technique employed
     84:     by the eigensolver

     86:     Level: advanced

     88: .seealso: EPSSetExtraction(), EPSGetExtraction()
     89: E*/
     90: typedef enum { EPS_RITZ,
     91:                EPS_HARMONIC,
     92:                EPS_HARMONIC_RELATIVE,
     93:                EPS_HARMONIC_RIGHT,
     94:                EPS_HARMONIC_LARGEST,
     95:                EPS_REFINED,
     96:                EPS_REFINED_HARMONIC } EPSExtraction;

     98: /*E
     99:     EPSWhich - Determines which part of the spectrum is requested

    101:     Level: intermediate

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

    117: /*E
    118:     EPSBalance - The type of balancing used for non-Hermitian problems

    120:     Level: intermediate

    122: .seealso: EPSSetBalance()
    123: E*/
    124: typedef enum { EPS_BALANCE_NONE,
    125:                EPS_BALANCE_ONESIDE,
    126:                EPS_BALANCE_TWOSIDE,
    127:                EPS_BALANCE_USER } EPSBalance;
    128: SLEPC_EXTERN const char *EPSBalanceTypes[];

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

    133:     Level: intermediate

    135: .seealso: EPSComputeError()
    136: E*/
    137: typedef enum { EPS_ERROR_ABSOLUTE,
    138:                EPS_ERROR_RELATIVE,
    139:                EPS_ERROR_BACKWARD } EPSErrorType;
    140: SLEPC_EXTERN const char *EPSErrorTypes[];

    142: /*E
    143:     EPSConv - Determines the convergence test

    145:     Level: intermediate

    147: .seealso: EPSSetConvergenceTest(), EPSSetConvergenceTestFunction()
    148: E*/
    149: typedef enum { EPS_CONV_ABS,
    150:                EPS_CONV_REL,
    151:                EPS_CONV_NORM,
    152:                EPS_CONV_USER } EPSConv;

    154: /*E
    155:     EPSStop - Determines the stopping test

    157:     Level: advanced

    159: .seealso: EPSSetStoppingTest(), EPSSetStoppingTestFunction()
    160: E*/
    161: typedef enum { EPS_STOP_BASIC,
    162:                EPS_STOP_USER } EPSStop;

    164: /*E
    165:     EPSConvergedReason - Reason an eigensolver was said to
    166:          have converged or diverged

    168:     Level: intermediate

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

    182: SLEPC_EXTERN PetscErrorCode EPSCreate(MPI_Comm,EPS*);
    183: SLEPC_EXTERN PetscErrorCode EPSDestroy(EPS*);
    184: SLEPC_EXTERN PetscErrorCode EPSReset(EPS);
    185: SLEPC_EXTERN PetscErrorCode EPSSetType(EPS,EPSType);
    186: SLEPC_EXTERN PetscErrorCode EPSGetType(EPS,EPSType*);
    187: SLEPC_EXTERN PetscErrorCode EPSSetProblemType(EPS,EPSProblemType);
    188: SLEPC_EXTERN PetscErrorCode EPSGetProblemType(EPS,EPSProblemType*);
    189: SLEPC_EXTERN PetscErrorCode EPSSetExtraction(EPS,EPSExtraction);
    190: SLEPC_EXTERN PetscErrorCode EPSGetExtraction(EPS,EPSExtraction*);
    191: SLEPC_EXTERN PetscErrorCode EPSSetBalance(EPS,EPSBalance,PetscInt,PetscReal);
    192: SLEPC_EXTERN PetscErrorCode EPSGetBalance(EPS,EPSBalance*,PetscInt*,PetscReal*);
    193: SLEPC_EXTERN PetscErrorCode EPSSetOperators(EPS,Mat,Mat);
    194: SLEPC_EXTERN PetscErrorCode EPSGetOperators(EPS,Mat*,Mat*);
    195: SLEPC_EXTERN PetscErrorCode EPSSetFromOptions(EPS);
    196: SLEPC_EXTERN PetscErrorCode EPSSetUp(EPS);
    197: SLEPC_EXTERN PetscErrorCode EPSSolve(EPS);
    198: SLEPC_EXTERN PetscErrorCode EPSView(EPS,PetscViewer);
    199: SLEPC_EXTERN PetscErrorCode EPSViewFromOptions(EPS,PetscObject,const char[]);
    200: SLEPC_EXTERN PetscErrorCode EPSErrorView(EPS,EPSErrorType,PetscViewer);
    201: PETSC_DEPRECATED_FUNCTION("Use EPSErrorView()") static inline PetscErrorCode EPSPrintSolution(EPS eps,PetscViewer v) {return EPSErrorView(eps,EPS_ERROR_RELATIVE,v);}
    202: SLEPC_EXTERN PetscErrorCode EPSErrorViewFromOptions(EPS);
    203: SLEPC_EXTERN PetscErrorCode EPSConvergedReasonView(EPS,PetscViewer);
    204: SLEPC_EXTERN PetscErrorCode EPSConvergedReasonViewFromOptions(EPS);
    205: PETSC_DEPRECATED_FUNCTION("Use EPSConvergedReasonView() (since version 3.14)") static inline PetscErrorCode EPSReasonView(EPS eps,PetscViewer v) {return EPSConvergedReasonView(eps,v);}
    206: PETSC_DEPRECATED_FUNCTION("Use EPSConvergedReasonViewFromOptions() (since version 3.14)") static inline PetscErrorCode EPSReasonViewFromOptions(EPS eps) {return EPSConvergedReasonViewFromOptions(eps);}
    207: SLEPC_EXTERN PetscErrorCode EPSValuesView(EPS,PetscViewer);
    208: SLEPC_EXTERN PetscErrorCode EPSValuesViewFromOptions(EPS);
    209: SLEPC_EXTERN PetscErrorCode EPSVectorsView(EPS,PetscViewer);
    210: SLEPC_EXTERN PetscErrorCode EPSVectorsViewFromOptions(EPS);

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

    238: SLEPC_EXTERN PetscErrorCode EPSSetDimensions(EPS,PetscInt,PetscInt,PetscInt);
    239: SLEPC_EXTERN PetscErrorCode EPSGetDimensions(EPS,PetscInt*,PetscInt*,PetscInt*);

    241: SLEPC_EXTERN PetscErrorCode EPSGetConverged(EPS,PetscInt*);
    242: SLEPC_EXTERN PetscErrorCode EPSGetEigenpair(EPS,PetscInt,PetscScalar*,PetscScalar*,Vec,Vec);
    243: SLEPC_EXTERN PetscErrorCode EPSGetEigenvalue(EPS,PetscInt,PetscScalar*,PetscScalar*);
    244: SLEPC_EXTERN PetscErrorCode EPSGetEigenvector(EPS,PetscInt,Vec,Vec);
    245: SLEPC_EXTERN PetscErrorCode EPSGetLeftEigenvector(EPS,PetscInt,Vec,Vec);

    247: SLEPC_EXTERN PetscErrorCode EPSComputeError(EPS,PetscInt,EPSErrorType,PetscReal*);
    248: PETSC_DEPRECATED_FUNCTION("Use EPSComputeError()") static inline PetscErrorCode EPSComputeRelativeError(EPS eps,PetscInt i,PetscReal *r) {return EPSComputeError(eps,i,EPS_ERROR_RELATIVE,r);}
    249: PETSC_DEPRECATED_FUNCTION("Use EPSComputeError() with EPS_ERROR_ABSOLUTE") static inline PetscErrorCode EPSComputeResidualNorm(EPS eps,PetscInt i,PetscReal *r) {return EPSComputeError(eps,i,EPS_ERROR_ABSOLUTE,r);}
    250: SLEPC_EXTERN PetscErrorCode EPSGetInvariantSubspace(EPS,Vec[]);
    251: SLEPC_EXTERN PetscErrorCode EPSGetErrorEstimate(EPS,PetscInt,PetscReal*);
    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 EPSSetTrackAll(EPS,PetscBool);
    269: SLEPC_EXTERN PetscErrorCode EPSGetTrackAll(EPS,PetscBool*);

    271: SLEPC_EXTERN PetscErrorCode EPSSetDeflationSpace(EPS,PetscInt,Vec[]);
    272: SLEPC_EXTERN PetscErrorCode EPSSetInitialSpace(EPS,PetscInt,Vec[]);
    273: SLEPC_EXTERN PetscErrorCode EPSSetLeftInitialSpace(EPS,PetscInt,Vec[]);

    275: SLEPC_EXTERN PetscErrorCode EPSMonitor(EPS,PetscInt,PetscInt,PetscScalar*,PetscScalar*,PetscReal*,PetscInt);
    276: SLEPC_EXTERN PetscErrorCode EPSMonitorSet(EPS,PetscErrorCode (*)(EPS,PetscInt,PetscInt,PetscScalar*,PetscScalar*,PetscReal*,PetscInt,void*),void*,PetscErrorCode (*)(void**));
    277: SLEPC_EXTERN PetscErrorCode EPSMonitorCancel(EPS);
    278: SLEPC_EXTERN PetscErrorCode EPSGetMonitorContext(EPS,void*);

    280: SLEPC_EXTERN PetscErrorCode EPSMonitorSetFromOptions(EPS,const char[],const char[],void*,PetscBool);
    281: SLEPC_EXTERN PetscErrorCode EPSMonitorLGCreate(MPI_Comm,const char[],const char[],const char[],PetscInt,const char*[],int,int,int,int,PetscDrawLG*);
    282: SLEPC_EXTERN PetscErrorCode EPSMonitorFirst(EPS,PetscInt,PetscInt,PetscScalar*,PetscScalar*,PetscReal*,PetscInt,PetscViewerAndFormat*);
    283: SLEPC_EXTERN PetscErrorCode EPSMonitorFirstDrawLG(EPS,PetscInt,PetscInt,PetscScalar*,PetscScalar*,PetscReal*,PetscInt,PetscViewerAndFormat*);
    284: SLEPC_EXTERN PetscErrorCode EPSMonitorFirstDrawLGCreate(PetscViewer,PetscViewerFormat,void *,PetscViewerAndFormat**);
    285: SLEPC_EXTERN PetscErrorCode EPSMonitorAll(EPS,PetscInt,PetscInt,PetscScalar*,PetscScalar*,PetscReal*,PetscInt,PetscViewerAndFormat*);
    286: SLEPC_EXTERN PetscErrorCode EPSMonitorAllDrawLG(EPS,PetscInt,PetscInt,PetscScalar*,PetscScalar*,PetscReal*,PetscInt,PetscViewerAndFormat*);
    287: SLEPC_EXTERN PetscErrorCode EPSMonitorAllDrawLGCreate(PetscViewer,PetscViewerFormat,void *,PetscViewerAndFormat**);
    288: SLEPC_EXTERN PetscErrorCode EPSMonitorConverged(EPS,PetscInt,PetscInt,PetscScalar*,PetscScalar*,PetscReal*,PetscInt,PetscViewerAndFormat*);
    289: SLEPC_EXTERN PetscErrorCode EPSMonitorConvergedCreate(PetscViewer,PetscViewerFormat,void *,PetscViewerAndFormat**);
    290: SLEPC_EXTERN PetscErrorCode EPSMonitorConvergedDrawLG(EPS,PetscInt,PetscInt,PetscScalar*,PetscScalar*,PetscReal*,PetscInt,PetscViewerAndFormat*);
    291: SLEPC_EXTERN PetscErrorCode EPSMonitorConvergedDrawLGCreate(PetscViewer,PetscViewerFormat,void *,PetscViewerAndFormat**);
    292: SLEPC_EXTERN PetscErrorCode EPSMonitorConvergedDestroy(PetscViewerAndFormat**);

    294: SLEPC_EXTERN PetscErrorCode EPSSetOptionsPrefix(EPS,const char*);
    295: SLEPC_EXTERN PetscErrorCode EPSAppendOptionsPrefix(EPS,const char*);
    296: SLEPC_EXTERN PetscErrorCode EPSGetOptionsPrefix(EPS,const char*[]);

    298: SLEPC_EXTERN PetscFunctionList EPSList;
    299: SLEPC_EXTERN PetscFunctionList EPSMonitorList;
    300: SLEPC_EXTERN PetscFunctionList EPSMonitorCreateList;
    301: SLEPC_EXTERN PetscFunctionList EPSMonitorDestroyList;
    302: SLEPC_EXTERN PetscErrorCode EPSRegister(const char[],PetscErrorCode(*)(EPS));
    303: SLEPC_EXTERN PetscErrorCode EPSMonitorRegister(const char[],PetscViewerType,PetscViewerFormat,PetscErrorCode(*)(EPS,PetscInt,PetscInt,PetscScalar*,PetscScalar*,PetscReal*,PetscInt,PetscViewerAndFormat*),PetscErrorCode(*)(PetscViewer,PetscViewerFormat,void*,PetscViewerAndFormat**),PetscErrorCode(*)(PetscViewerAndFormat**));

    305: SLEPC_EXTERN PetscErrorCode EPSSetWorkVecs(EPS,PetscInt);
    306: SLEPC_EXTERN PetscErrorCode EPSAllocateSolution(EPS,PetscInt);

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

    310: /*E
    311:     EPSPowerShiftType - determines the type of shift used in the Power iteration

    313:     Level: advanced

    315: .seealso: EPSPowerSetShiftType(), EPSPowerGetShiftType()
    316: E*/
    317: typedef enum { EPS_POWER_SHIFT_CONSTANT,
    318:                EPS_POWER_SHIFT_RAYLEIGH,
    319:                EPS_POWER_SHIFT_WILKINSON } EPSPowerShiftType;
    320: SLEPC_EXTERN const char *EPSPowerShiftTypes[];

    322: SLEPC_EXTERN PetscErrorCode EPSPowerSetShiftType(EPS,EPSPowerShiftType);
    323: SLEPC_EXTERN PetscErrorCode EPSPowerGetShiftType(EPS,EPSPowerShiftType*);
    324: SLEPC_EXTERN PetscErrorCode EPSPowerSetNonlinear(EPS,PetscBool);
    325: SLEPC_EXTERN PetscErrorCode EPSPowerGetNonlinear(EPS,PetscBool*);
    326: SLEPC_EXTERN PetscErrorCode EPSPowerSetUpdate(EPS,PetscBool);
    327: SLEPC_EXTERN PetscErrorCode EPSPowerGetUpdate(EPS,PetscBool*);
    328: SLEPC_EXTERN PetscErrorCode EPSPowerSetSNES(EPS,SNES);
    329: SLEPC_EXTERN PetscErrorCode EPSPowerGetSNES(EPS,SNES*);

    331: SLEPC_EXTERN PetscErrorCode EPSArnoldiSetDelayed(EPS,PetscBool);
    332: SLEPC_EXTERN PetscErrorCode EPSArnoldiGetDelayed(EPS,PetscBool*);

    334: SLEPC_EXTERN PetscErrorCode EPSKrylovSchurSetRestart(EPS,PetscReal);
    335: SLEPC_EXTERN PetscErrorCode EPSKrylovSchurGetRestart(EPS,PetscReal*);
    336: SLEPC_EXTERN PetscErrorCode EPSKrylovSchurSetLocking(EPS,PetscBool);
    337: SLEPC_EXTERN PetscErrorCode EPSKrylovSchurGetLocking(EPS,PetscBool*);
    338: SLEPC_EXTERN PetscErrorCode EPSKrylovSchurSetPartitions(EPS,PetscInt);
    339: SLEPC_EXTERN PetscErrorCode EPSKrylovSchurGetPartitions(EPS,PetscInt*);
    340: SLEPC_EXTERN PetscErrorCode EPSKrylovSchurSetDetectZeros(EPS,PetscBool);
    341: SLEPC_EXTERN PetscErrorCode EPSKrylovSchurGetDetectZeros(EPS,PetscBool*);
    342: SLEPC_EXTERN PetscErrorCode EPSKrylovSchurSetDimensions(EPS,PetscInt,PetscInt,PetscInt);
    343: SLEPC_EXTERN PetscErrorCode EPSKrylovSchurGetDimensions(EPS,PetscInt*,PetscInt*,PetscInt*);
    344: SLEPC_EXTERN PetscErrorCode EPSKrylovSchurSetSubintervals(EPS,PetscReal*);
    345: SLEPC_EXTERN PetscErrorCode EPSKrylovSchurGetSubintervals(EPS,PetscReal**);
    346: SLEPC_EXTERN PetscErrorCode EPSKrylovSchurGetInertias(EPS,PetscInt*,PetscReal**,PetscInt**);
    347: SLEPC_EXTERN PetscErrorCode EPSKrylovSchurGetSubcommInfo(EPS,PetscInt*,PetscInt*,Vec*);
    348: SLEPC_EXTERN PetscErrorCode EPSKrylovSchurGetSubcommPairs(EPS,PetscInt,PetscScalar*,Vec);
    349: SLEPC_EXTERN PetscErrorCode EPSKrylovSchurGetSubcommMats(EPS,Mat*,Mat*);
    350: SLEPC_EXTERN PetscErrorCode EPSKrylovSchurUpdateSubcommMats(EPS,PetscScalar,PetscScalar,Mat,PetscScalar,PetscScalar, Mat,MatStructure,PetscBool);
    351: SLEPC_EXTERN PetscErrorCode EPSKrylovSchurGetKSP(EPS,KSP*);

    353: /*E
    354:     EPSLanczosReorthogType - determines the type of reorthogonalization
    355:     used in the Lanczos method

    357:     Level: advanced

    359: .seealso: EPSLanczosSetReorthog(), EPSLanczosGetReorthog()
    360: E*/
    361: typedef enum { EPS_LANCZOS_REORTHOG_LOCAL,
    362:                EPS_LANCZOS_REORTHOG_FULL,
    363:                EPS_LANCZOS_REORTHOG_SELECTIVE,
    364:                EPS_LANCZOS_REORTHOG_PERIODIC,
    365:                EPS_LANCZOS_REORTHOG_PARTIAL,
    366:                EPS_LANCZOS_REORTHOG_DELAYED } EPSLanczosReorthogType;
    367: SLEPC_EXTERN const char *EPSLanczosReorthogTypes[];

    369: SLEPC_EXTERN PetscErrorCode EPSLanczosSetReorthog(EPS,EPSLanczosReorthogType);
    370: SLEPC_EXTERN PetscErrorCode EPSLanczosGetReorthog(EPS,EPSLanczosReorthogType*);

    372: /*E
    373:     EPSPRIMMEMethod - determines the method selected in the PRIMME library

    375:     Level: advanced

    377: .seealso: EPSPRIMMESetMethod(), EPSPRIMMEGetMethod()
    378: E*/
    379: typedef enum { EPS_PRIMME_DYNAMIC=1,
    380:                EPS_PRIMME_DEFAULT_MIN_TIME,
    381:                EPS_PRIMME_DEFAULT_MIN_MATVECS,
    382:                EPS_PRIMME_ARNOLDI,
    383:                EPS_PRIMME_GD,
    384:                EPS_PRIMME_GD_PLUSK,
    385:                EPS_PRIMME_GD_OLSEN_PLUSK,
    386:                EPS_PRIMME_JD_OLSEN_PLUSK,
    387:                EPS_PRIMME_RQI,
    388:                EPS_PRIMME_JDQR,
    389:                EPS_PRIMME_JDQMR,
    390:                EPS_PRIMME_JDQMR_ETOL,
    391:                EPS_PRIMME_SUBSPACE_ITERATION,
    392:                EPS_PRIMME_LOBPCG_ORTHOBASIS,
    393:                EPS_PRIMME_LOBPCG_ORTHOBASISW } EPSPRIMMEMethod;
    394: SLEPC_EXTERN const char *EPSPRIMMEMethods[];

    396: SLEPC_EXTERN PetscErrorCode EPSPRIMMESetBlockSize(EPS,PetscInt);
    397: SLEPC_EXTERN PetscErrorCode EPSPRIMMEGetBlockSize(EPS,PetscInt*);
    398: SLEPC_EXTERN PetscErrorCode EPSPRIMMESetMethod(EPS,EPSPRIMMEMethod);
    399: SLEPC_EXTERN PetscErrorCode EPSPRIMMEGetMethod(EPS,EPSPRIMMEMethod*);

    401: SLEPC_EXTERN PetscErrorCode EPSGDSetKrylovStart(EPS,PetscBool);
    402: SLEPC_EXTERN PetscErrorCode EPSGDGetKrylovStart(EPS,PetscBool*);
    403: SLEPC_EXTERN PetscErrorCode EPSGDSetBlockSize(EPS,PetscInt);
    404: SLEPC_EXTERN PetscErrorCode EPSGDGetBlockSize(EPS,PetscInt*);
    405: SLEPC_EXTERN PetscErrorCode EPSGDSetRestart(EPS,PetscInt,PetscInt);
    406: SLEPC_EXTERN PetscErrorCode EPSGDGetRestart(EPS,PetscInt*,PetscInt*);
    407: SLEPC_EXTERN PetscErrorCode EPSGDSetInitialSize(EPS,PetscInt);
    408: SLEPC_EXTERN PetscErrorCode EPSGDGetInitialSize(EPS,PetscInt*);
    409: SLEPC_EXTERN PetscErrorCode EPSGDSetBOrth(EPS,PetscBool);
    410: SLEPC_EXTERN PetscErrorCode EPSGDGetBOrth(EPS,PetscBool*);
    411: SLEPC_EXTERN PetscErrorCode EPSGDSetDoubleExpansion(EPS,PetscBool);
    412: SLEPC_EXTERN PetscErrorCode EPSGDGetDoubleExpansion(EPS,PetscBool*);

    414: SLEPC_EXTERN PetscErrorCode EPSJDSetKrylovStart(EPS,PetscBool);
    415: SLEPC_EXTERN PetscErrorCode EPSJDGetKrylovStart(EPS,PetscBool*);
    416: SLEPC_EXTERN PetscErrorCode EPSJDSetBlockSize(EPS,PetscInt);
    417: SLEPC_EXTERN PetscErrorCode EPSJDGetBlockSize(EPS,PetscInt*);
    418: SLEPC_EXTERN PetscErrorCode EPSJDSetRestart(EPS,PetscInt,PetscInt);
    419: SLEPC_EXTERN PetscErrorCode EPSJDGetRestart(EPS,PetscInt*,PetscInt*);
    420: SLEPC_EXTERN PetscErrorCode EPSJDSetInitialSize(EPS,PetscInt);
    421: SLEPC_EXTERN PetscErrorCode EPSJDGetInitialSize(EPS,PetscInt*);
    422: SLEPC_EXTERN PetscErrorCode EPSJDSetFix(EPS,PetscReal);
    423: SLEPC_EXTERN PetscErrorCode EPSJDGetFix(EPS,PetscReal*);
    424: SLEPC_EXTERN PetscErrorCode EPSJDSetConstCorrectionTol(EPS,PetscBool);
    425: SLEPC_EXTERN PetscErrorCode EPSJDGetConstCorrectionTol(EPS,PetscBool*);
    426: SLEPC_EXTERN PetscErrorCode EPSJDSetBOrth(EPS,PetscBool);
    427: SLEPC_EXTERN PetscErrorCode EPSJDGetBOrth(EPS,PetscBool*);

    429: SLEPC_EXTERN PetscErrorCode EPSRQCGSetReset(EPS,PetscInt);
    430: SLEPC_EXTERN PetscErrorCode EPSRQCGGetReset(EPS,PetscInt*);

    432: SLEPC_EXTERN PetscErrorCode EPSLOBPCGSetBlockSize(EPS,PetscInt);
    433: SLEPC_EXTERN PetscErrorCode EPSLOBPCGGetBlockSize(EPS,PetscInt*);
    434: SLEPC_EXTERN PetscErrorCode EPSLOBPCGSetRestart(EPS,PetscReal);
    435: SLEPC_EXTERN PetscErrorCode EPSLOBPCGGetRestart(EPS,PetscReal*);
    436: SLEPC_EXTERN PetscErrorCode EPSLOBPCGSetLocking(EPS,PetscBool);
    437: SLEPC_EXTERN PetscErrorCode EPSLOBPCGGetLocking(EPS,PetscBool*);

    439: /*E
    440:     EPSCISSQuadRule - determines the quadrature rule in the CISS solver

    442:     Level: advanced

    444: .seealso: EPSCISSSetQuadRule(), EPSCISSGetQuadRule()
    445: E*/
    446: typedef enum { EPS_CISS_QUADRULE_TRAPEZOIDAL=1,
    447:                EPS_CISS_QUADRULE_CHEBYSHEV } EPSCISSQuadRule;
    448: SLEPC_EXTERN const char *EPSCISSQuadRules[];

    450: /*E
    451:     EPSCISSExtraction - determines the extraction technique in the CISS solver

    453:     Level: advanced

    455: .seealso: EPSCISSSetExtraction(), EPSCISSGetExtraction()
    456: E*/
    457: typedef enum { EPS_CISS_EXTRACTION_RITZ,
    458:                EPS_CISS_EXTRACTION_HANKEL } EPSCISSExtraction;
    459: SLEPC_EXTERN const char *EPSCISSExtractions[];

    461: SLEPC_EXTERN PetscErrorCode EPSCISSSetExtraction(EPS,EPSCISSExtraction);
    462: SLEPC_EXTERN PetscErrorCode EPSCISSGetExtraction(EPS,EPSCISSExtraction*);
    463: SLEPC_EXTERN PetscErrorCode EPSCISSSetQuadRule(EPS,EPSCISSQuadRule);
    464: SLEPC_EXTERN PetscErrorCode EPSCISSGetQuadRule(EPS,EPSCISSQuadRule*);
    465: SLEPC_EXTERN PetscErrorCode EPSCISSSetSizes(EPS,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscBool);
    466: SLEPC_EXTERN PetscErrorCode EPSCISSGetSizes(EPS,PetscInt*,PetscInt*,PetscInt*,PetscInt*,PetscInt*,PetscBool*);
    467: SLEPC_EXTERN PetscErrorCode EPSCISSSetThreshold(EPS,PetscReal,PetscReal);
    468: SLEPC_EXTERN PetscErrorCode EPSCISSGetThreshold(EPS,PetscReal*,PetscReal*);
    469: SLEPC_EXTERN PetscErrorCode EPSCISSSetRefinement(EPS,PetscInt,PetscInt);
    470: SLEPC_EXTERN PetscErrorCode EPSCISSGetRefinement(EPS,PetscInt*,PetscInt*);
    471: SLEPC_EXTERN PetscErrorCode EPSCISSSetUseST(EPS,PetscBool);
    472: SLEPC_EXTERN PetscErrorCode EPSCISSGetUseST(EPS,PetscBool*);
    473: SLEPC_EXTERN PetscErrorCode EPSCISSGetKSPs(EPS,PetscInt*,KSP**);

    475: SLEPC_EXTERN PetscErrorCode EPSLyapIISetLME(EPS,LME);
    476: SLEPC_EXTERN PetscErrorCode EPSLyapIIGetLME(EPS,LME*);
    477: SLEPC_EXTERN PetscErrorCode EPSLyapIISetRanks(EPS,PetscInt,PetscInt);
    478: SLEPC_EXTERN PetscErrorCode EPSLyapIIGetRanks(EPS,PetscInt*,PetscInt*);

    480: SLEPC_EXTERN PetscErrorCode EPSBLOPEXSetBlockSize(EPS,PetscInt);
    481: SLEPC_EXTERN PetscErrorCode EPSBLOPEXGetBlockSize(EPS,PetscInt*);

    483: /*E
    484:     EPSEVSLDOSMethod - the method to approximate the density of states (DOS) in the EVSL solver

    486:     Level: advanced

    488: .seealso: EPSEVSLSetDOSParameters(), EPSEVSLGetDOSParameters()
    489: E*/
    490: typedef enum { EPS_EVSL_DOS_KPM,
    491:                EPS_EVSL_DOS_LANCZOS } EPSEVSLDOSMethod;
    492: SLEPC_EXTERN const char *EPSEVSLDOSMethods[];

    494: /*E
    495:     EPSEVSLDamping - the damping type used in the EVSL solver

    497:     Level: advanced

    499: .seealso: EPSEVSLSetDOSParameters(), EPSEVSLGetDOSParameters()
    500: E*/
    501: typedef enum { EPS_EVSL_DAMPING_NONE,
    502:                EPS_EVSL_DAMPING_JACKSON,
    503:                EPS_EVSL_DAMPING_SIGMA } EPSEVSLDamping;
    504: SLEPC_EXTERN const char *EPSEVSLDampings[];

    506: SLEPC_EXTERN PetscErrorCode EPSEVSLSetRange(EPS,PetscReal,PetscReal);
    507: SLEPC_EXTERN PetscErrorCode EPSEVSLGetRange(EPS,PetscReal*,PetscReal*);
    508: SLEPC_EXTERN PetscErrorCode EPSEVSLSetSlices(EPS,PetscInt);
    509: SLEPC_EXTERN PetscErrorCode EPSEVSLGetSlices(EPS,PetscInt*);
    510: SLEPC_EXTERN PetscErrorCode EPSEVSLSetDOSParameters(EPS,EPSEVSLDOSMethod,PetscInt,PetscInt,PetscInt,PetscInt);
    511: SLEPC_EXTERN PetscErrorCode EPSEVSLGetDOSParameters(EPS,EPSEVSLDOSMethod*,PetscInt*,PetscInt*,PetscInt*,PetscInt*);
    512: SLEPC_EXTERN PetscErrorCode EPSEVSLSetPolParameters(EPS,PetscInt,PetscReal);
    513: SLEPC_EXTERN PetscErrorCode EPSEVSLGetPolParameters(EPS,PetscInt*,PetscReal*);
    514: SLEPC_EXTERN PetscErrorCode EPSEVSLSetDamping(EPS,EPSEVSLDamping);
    515: SLEPC_EXTERN PetscErrorCode EPSEVSLGetDamping(EPS,EPSEVSLDamping*);

    517: SLEPC_EXTERN PetscErrorCode EPSFEASTSetNumPoints(EPS,PetscInt);
    518: SLEPC_EXTERN PetscErrorCode EPSFEASTGetNumPoints(EPS,PetscInt*);

    520: #endif