Date: 2023-01-26T12:19:46+00:00

Actual source code: slepceps.h
slepc-3.18.2 2023-01-26
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

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

     24: /* SUBMANSEC = EPS */

     26: SLEPC_EXTERN PetscErrorCode EPSInitializePackage(void);

     28: /*S
     29:     EPS - Abstract SLEPc object that manages all the eigenvalue
     30:     problem solvers.

     32:     Level: beginner

     34: .seealso:  EPSCreate(), ST
     35: S*/
     36: typedef struct _p_EPS* EPS;

     38: /*J
     39:     EPSType - String with the name of a SLEPc eigensolver

     41:     Level: beginner

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

     68: /* Logging support */
     69: SLEPC_EXTERN PetscClassId EPS_CLASSID;

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

     74:     Level: beginner

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

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

     89:     Level: advanced

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

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

    104:     Level: intermediate

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

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

    123:     Level: intermediate

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

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

    136:     Level: intermediate

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

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

    148:     Level: intermediate

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

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

    160:     Level: advanced

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

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

    171:     Level: intermediate

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

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

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

    241: SLEPC_EXTERN PetscErrorCode EPSSetDimensions(EPS,PetscInt,PetscInt,PetscInt);
    242: SLEPC_EXTERN PetscErrorCode EPSGetDimensions(EPS,PetscInt*,PetscInt*,PetscInt*);

    244: SLEPC_EXTERN PetscErrorCode EPSGetConverged(EPS,PetscInt*);
    245: SLEPC_EXTERN PetscErrorCode EPSGetEigenpair(EPS,PetscInt,PetscScalar*,PetscScalar*,Vec,Vec);
    246: SLEPC_EXTERN PetscErrorCode EPSGetEigenvalue(EPS,PetscInt,PetscScalar*,PetscScalar*);
    247: SLEPC_EXTERN PetscErrorCode EPSGetEigenvector(EPS,PetscInt,Vec,Vec);
    248: SLEPC_EXTERN PetscErrorCode EPSGetLeftEigenvector(EPS,PetscInt,Vec,Vec);

    250: SLEPC_EXTERN PetscErrorCode EPSComputeError(EPS,PetscInt,EPSErrorType,PetscReal*);
    251: PETSC_DEPRECATED_FUNCTION("Use EPSComputeError()") static inline PetscErrorCode EPSComputeRelativeError(EPS eps,PetscInt i,PetscReal *r) {return EPSComputeError(eps,i,EPS_ERROR_RELATIVE,r);}
    252: 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);}
    253: SLEPC_EXTERN PetscErrorCode EPSGetInvariantSubspace(EPS,Vec[]);
    254: SLEPC_EXTERN PetscErrorCode EPSGetErrorEstimate(EPS,PetscInt,PetscReal*);
    255: SLEPC_EXTERN PetscErrorCode EPSGetIterationNumber(EPS,PetscInt*);

    257: SLEPC_EXTERN PetscErrorCode EPSSetWhichEigenpairs(EPS,EPSWhich);
    258: SLEPC_EXTERN PetscErrorCode EPSGetWhichEigenpairs(EPS,EPSWhich*);
    259: SLEPC_EXTERN PetscErrorCode EPSSetTwoSided(EPS,PetscBool);
    260: SLEPC_EXTERN PetscErrorCode EPSGetTwoSided(EPS,PetscBool*);
    261: SLEPC_EXTERN PetscErrorCode EPSSetTrueResidual(EPS,PetscBool);
    262: SLEPC_EXTERN PetscErrorCode EPSGetTrueResidual(EPS,PetscBool*);
    263: SLEPC_EXTERN PetscErrorCode EPSSetPurify(EPS,PetscBool);
    264: SLEPC_EXTERN PetscErrorCode EPSGetPurify(EPS,PetscBool*);
    265: SLEPC_EXTERN PetscErrorCode EPSSetEigenvalueComparison(EPS,PetscErrorCode (*func)(PetscScalar,PetscScalar,PetscScalar,PetscScalar,PetscInt*,void*),void*);
    266: SLEPC_EXTERN PetscErrorCode EPSSetArbitrarySelection(EPS,PetscErrorCode (*func)(PetscScalar,PetscScalar,Vec,Vec,PetscScalar*,PetscScalar*,void*),void*);
    267: SLEPC_EXTERN PetscErrorCode EPSIsGeneralized(EPS,PetscBool*);
    268: SLEPC_EXTERN PetscErrorCode EPSIsHermitian(EPS,PetscBool*);
    269: SLEPC_EXTERN PetscErrorCode EPSIsPositive(EPS,PetscBool*);

    271: SLEPC_EXTERN PetscErrorCode EPSSetTrackAll(EPS,PetscBool);
    272: SLEPC_EXTERN PetscErrorCode EPSGetTrackAll(EPS,PetscBool*);

    274: SLEPC_EXTERN PetscErrorCode EPSSetDeflationSpace(EPS,PetscInt,Vec[]);
    275: SLEPC_EXTERN PetscErrorCode EPSSetInitialSpace(EPS,PetscInt,Vec[]);
    276: SLEPC_EXTERN PetscErrorCode EPSSetLeftInitialSpace(EPS,PetscInt,Vec[]);

    278: SLEPC_EXTERN PetscErrorCode EPSMonitor(EPS,PetscInt,PetscInt,PetscScalar*,PetscScalar*,PetscReal*,PetscInt);
    279: SLEPC_EXTERN PetscErrorCode EPSMonitorSet(EPS,PetscErrorCode (*)(EPS,PetscInt,PetscInt,PetscScalar*,PetscScalar*,PetscReal*,PetscInt,void*),void*,PetscErrorCode (*)(void**));
    280: SLEPC_EXTERN PetscErrorCode EPSMonitorCancel(EPS);
    281: SLEPC_EXTERN PetscErrorCode EPSGetMonitorContext(EPS,void*);

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

    297: SLEPC_EXTERN PetscErrorCode EPSSetOptionsPrefix(EPS,const char*);
    298: SLEPC_EXTERN PetscErrorCode EPSAppendOptionsPrefix(EPS,const char*);
    299: SLEPC_EXTERN PetscErrorCode EPSGetOptionsPrefix(EPS,const char*[]);

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

    308: SLEPC_EXTERN PetscErrorCode EPSSetWorkVecs(EPS,PetscInt);
    309: SLEPC_EXTERN PetscErrorCode EPSAllocateSolution(EPS,PetscInt);

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

    313: /*E
    314:     EPSPowerShiftType - determines the type of shift used in the Power iteration

    316:     Level: advanced

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

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

    334: SLEPC_EXTERN PetscErrorCode EPSArnoldiSetDelayed(EPS,PetscBool);
    335: SLEPC_EXTERN PetscErrorCode EPSArnoldiGetDelayed(EPS,PetscBool*);

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

    356: /*E
    357:     EPSLanczosReorthogType - determines the type of reorthogonalization
    358:     used in the Lanczos method

    360:     Level: advanced

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

    372: SLEPC_EXTERN PetscErrorCode EPSLanczosSetReorthog(EPS,EPSLanczosReorthogType);
    373: SLEPC_EXTERN PetscErrorCode EPSLanczosGetReorthog(EPS,EPSLanczosReorthogType*);

    375: /*E
    376:     EPSPRIMMEMethod - determines the method selected in the PRIMME library

    378:     Level: advanced

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

    399: SLEPC_EXTERN PetscErrorCode EPSPRIMMESetBlockSize(EPS,PetscInt);
    400: SLEPC_EXTERN PetscErrorCode EPSPRIMMEGetBlockSize(EPS,PetscInt*);
    401: SLEPC_EXTERN PetscErrorCode EPSPRIMMESetMethod(EPS,EPSPRIMMEMethod);
    402: SLEPC_EXTERN PetscErrorCode EPSPRIMMEGetMethod(EPS,EPSPRIMMEMethod*);

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

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

    432: SLEPC_EXTERN PetscErrorCode EPSRQCGSetReset(EPS,PetscInt);
    433: SLEPC_EXTERN PetscErrorCode EPSRQCGGetReset(EPS,PetscInt*);

    435: SLEPC_EXTERN PetscErrorCode EPSLOBPCGSetBlockSize(EPS,PetscInt);
    436: SLEPC_EXTERN PetscErrorCode EPSLOBPCGGetBlockSize(EPS,PetscInt*);
    437: SLEPC_EXTERN PetscErrorCode EPSLOBPCGSetRestart(EPS,PetscReal);
    438: SLEPC_EXTERN PetscErrorCode EPSLOBPCGGetRestart(EPS,PetscReal*);
    439: SLEPC_EXTERN PetscErrorCode EPSLOBPCGSetLocking(EPS,PetscBool);
    440: SLEPC_EXTERN PetscErrorCode EPSLOBPCGGetLocking(EPS,PetscBool*);

    442: /*E
    443:     EPSCISSQuadRule - determines the quadrature rule in the CISS solver

    445:     Level: advanced

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

    453: /*E
    454:     EPSCISSExtraction - determines the extraction technique in the CISS solver

    456:     Level: advanced

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

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

    478: SLEPC_EXTERN PetscErrorCode EPSLyapIISetLME(EPS,LME);
    479: SLEPC_EXTERN PetscErrorCode EPSLyapIIGetLME(EPS,LME*);
    480: SLEPC_EXTERN PetscErrorCode EPSLyapIISetRanks(EPS,PetscInt,PetscInt);
    481: SLEPC_EXTERN PetscErrorCode EPSLyapIIGetRanks(EPS,PetscInt*,PetscInt*);

    483: SLEPC_EXTERN PetscErrorCode EPSBLOPEXSetBlockSize(EPS,PetscInt);
    484: SLEPC_EXTERN PetscErrorCode EPSBLOPEXGetBlockSize(EPS,PetscInt*);

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

    489:     Level: advanced

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

    497: /*E
    498:     EPSEVSLDamping - the damping type used in the EVSL solver

    500:     Level: advanced

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

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

    520: SLEPC_EXTERN PetscErrorCode EPSFEASTSetNumPoints(EPS,PetscInt);
    521: SLEPC_EXTERN PetscErrorCode EPSFEASTGetNumPoints(EPS,PetscInt*);

    523: #endif