Home | Trees | Indices | Help |
|
---|
|
|
|||
Balance EPS type of balancing used for non-Hermitian problems |
|||
Conv EPS convergence test |
|||
ConvergedReason EPS convergence reasons |
|||
ErrorType EPS error type to assess accuracy of computed solutions |
|||
Extraction EPS extraction technique |
|||
LanczosReorthogType EPS Lanczos reorthogonalization type |
|||
PowerShiftType EPS Power shift type. |
|||
ProblemType EPS problem type |
|||
Type EPS type |
|||
Which EPS desired piece of spectrum |
|
|||
a new object with type S, a subtype of T |
|
||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
Inherited from |
|
|||
bv | |||
extraction | |||
max_it | |||
problem_type | |||
st | |||
target | |||
tol | |||
which | |||
Inherited from |
|
|
Appends to the prefix used for searching for all EPS options in the database. Parameters
|
Computes the error (based on the residual norm) associated with the i-th computed eigenpair. Parameters
Returns
NotesThe index i should be a value between 0 and nconv-1 (see getConverged()). |
Creates the EPS object. Parameters
|
|
Displays the errors associated with the computed solution (as well as the eigenvalues). Parameters
NotesBy default, this function checks the error of all eigenpairs and prints the eigenvalues if all of them are below the requested tolerance. If the viewer has format ASCII_INFO_DETAIL then a table with eigenvalues and corresponding errors is printed. |
Gets the type of reorthogonalization used during the Arnoldi iteration. Returns
|
Obtain the basis vector objects associated to the eigensolver. Returns
|
Gets the balancing type used by the EPS object, and the associated parameters. Returns
|
Gets the number of converged eigenpairs. Returns
NotesThis function should be called after solve() has finished. |
Gets the reason why the solve() iteration was stopped. Returns
|
Return the method used to compute the error estimate used in the convergence test. Returns
|
Obtain the direct solver associated to the eigensolver. Returns
|
Gets the number of eigenvalues to compute and the dimension of the subspace. Returns
|
Gets the i-th solution of the eigenproblem as computed by solve(). The solution consists of both the eigenvalue and the eigenvector. Parameters
Returns
NotesThe index i should be a value between 0 and nconv-1 (see getConverged()). Eigenpairs are indexed according to the ordering criterion established with setWhichEigenpairs(). |
Gets the i-th eigenvalue as computed by solve(). Parameters
Returns
NotesThe index i should be a value between 0 and nconv-1 (see getConverged()). Eigenpairs are indexed according to the ordering criterion established with setWhichEigenpairs(). |
Gets the i-th eigenvector as computed by solve(). Parameters
NotesThe index i should be a value between 0 and nconv-1 (see getConverged()). Eigenpairs are indexed according to the ordering criterion established with setWhichEigenpairs(). |
Returns the error estimate associated to the i-th computed eigenpair. Parameters
Returns
NotesThis is the error estimate used internally by the eigensolver. The actual error bound can be computed with computeError(). |
Gets the extraction type used by the EPS object. Returns
|
Gets the computational interval for spectrum slicing. Returns
NotesIf the interval was not set by the user, then zeros are returned. |
Gets an orthonormal basis of the computed invariant subspace. Returns
NotesThis function should be called after solve() has finished. The returned vectors span an invariant subspace associated with the computed eigenvalues. An invariant subspace X of A` satisfies ``A x in X for all x in X (a similar definition applies for generalized eigenproblems). |
Gets the current iteration number. If the call to solve() is complete, then it returns the number of iterations carried out by the solution method. Returns
|
Gets the flag that enforces zero detection in spectrum slicing. Returns
|
Gets the dimensions used for each subsolve step in case of doing spectrum slicing for a computational interval. Returns
|
Gets the locking flag used in the Krylov-Schur method. Returns
|
Gets the number of partitions of the communicator in case of spectrum slicing. Returns
|
Gets the restart parameter used in the Krylov-Schur method. Returns
|
Gets information related to the case of doing spectrum slicing for a computational interval with multiple communicators. Returns
NotesThis function is only available for spectrum slicing runs. The returned Vec should be destroyed by the user. |
Gets the eigenproblem matrices stored internally in the subcommunicator to which the calling process belongs. Returns
NotesThis is the analog of getOperators(), but returns the matrices distributed differently (in the subcommunicator rather than in the parent communicator). These matrices should not be modified by the user. |
Gets the i-th eigenpair stored internally in the multi-communicator to which the calling process belongs. Parameters
Returns
NotesThe index i should be a value between 0 and n-1, where n is the number of vectors in the local subinterval, see getKrylovSchurSubcommInfo(). |
Gets the type of reorthogonalization used during the Lanczos iteration. Returns
|
Gets the i-th left eigenvector as computed by solve(). Parameters
NotesThe index i should be a value between 0 and nconv-1 (see getConverged()). Eigensolutions are indexed according to the ordering criterion established with setWhichEigenpairs(). Left eigenvectors are available only if the twosided flag was set with setTwoSided(). |
Gets the matrices associated with the eigenvalue problem. Returns
|
Gets the prefix used for searching for all EPS options in the database. Returns
|
Gets the type of shifts used during the power iteration. Returns
|
Gets the problem type from the EPS object. Returns
|
Obtain the region object associated to the eigensolver. Returns
|
Gets the reset parameter used in the RQCG method. Returns
|
Obtain the spectral transformation (ST) object associated to the eigensolver object. Returns
|
Gets the value of the target. Returns
NotesIf the target was not set by the user, then zero is returned. |
Gets the tolerance and maximum iteration count used by the default EPS convergence tests. Returns
|
Returns the flag indicating whether all residual norms must be computed or not. Returns
|
Returns the flag indicating whether true residual must be computed explicitly or not. Returns
|
Returns the flag indicating whether a two-sided variant of the algorithm is being used or not. Returns
|
Gets the EPS type of this object. Returns
|
Returns which portion of the spectrum is to be sought. Returns
|
Tells whether the EPS object corresponds to a generalized eigenvalue problem. Returns
|
Tells whether the EPS object corresponds to a Hermitian eigenvalue problem. Returns
|
Tells whether the EPS object corresponds to an eigenvalue problem type that requires a positive (semi-) definite matrix B. Returns
|
Activates or deactivates delayed reorthogonalization in the Arnoldi iteration. Parameters
NotesThis call is only relevant if the type was set to EPS.Type.ARNOLDI with setType(). Delayed reorthogonalization is an aggressive optimization for the Arnoldi eigensolver than may provide better scalability, but sometimes makes the solver converge less than the default algorithm. |
Associates a basis vectors object to the eigensolver. Parameters
|
Specifies the balancing technique to be employed by the eigensolver, and some parameters associated to it. Parameters
|
Specifies how to compute the error estimate used in the convergence test. Parameters
|
Associates a direct solver object to the eigensolver. Parameters
|
Add vectors to the basis of the deflation space. Parameters
NotesWhen a deflation space is given, the eigensolver seeks the eigensolution in the restriction of the problem to the orthogonal complement of this space. This can be used for instance in the case that an invariant subspace is known beforehand (such as the nullspace of the matrix). The vectors do not need to be mutually orthonormal, since they are explicitly orthonormalized internally. These vectors do not persist from one solve() call to the other, so the deflation space should be set every time. |
Sets the number of eigenvalues to compute and the dimension of the subspace. Parameters
NotesUse DECIDE for The parameters
The value of |
Sets the extraction type used by the EPS object. Parameters
NotesNot all eigensolvers support all types of extraction. See the SLEPc documentation for details. By default, a standard Rayleigh-Ritz extraction is used. Other extractions may be useful when computing interior eigenvalues. Harmonic-type extractions are used in combination with a target. See setTarget(). |
Sets EPS options from the options database. This routine must be called before setUp() if the user is to be allowed to set the solver type. NotesTo see all options, run your program with the -help option.
|
Sets the initial space from which the eigensolver starts to iterate. Parameters
NotesSome solvers start to iterate on a single vector (initial vector). In that case, the other vectors are ignored. In contrast to setDeflationSpace(), these vectors do not persist from one solve() call to the other, so the initial space should be set every time. The vectors do not need to be mutually orthonormal, since they are explicitly orthonormalized internally. Common usage of this function is when the user can provide a rough approximation of the wanted eigenspace. Then, convergence may be faster. |
Defines the computational interval for spectrum slicing. Parameters
NotesSpectrum slicing is a technique employed for computing all eigenvalues of symmetric eigenproblems in a given interval. This function provides the interval to be considered. It must be used in combination with EPS.Which.ALL, see setWhichEigenpairs(). |
Sets a flag to enforce detection of zeros during the factorizations throughout the spectrum slicing computation. Parameters
NotesA zero in the factorization indicates that a shift coincides with an eigenvalue. This flag is turned off by default, and may be necessary in some cases, especially when several partitions are being used. This feature currently requires an external package for factorizations with support for zero detection, e.g. MUMPS. |
Sets the dimensions used for each subsolve step in case of doing spectrum slicing for a computational interval. The meaning of the parameters is the same as in setDimensions(). Parameters
|
Choose between locking and non-locking variants of the Krylov-Schur method. Parameters
NotesThe default is to lock converged eigenpairs when the method restarts. This behaviour can be changed so that all directions are kept in the working subspace even if already converged to working accuracy (the non-locking variant). |
Sets the number of partitions for the case of doing spectrum slicing for a computational interval with the communicator split in several sub-communicators. Parameters
NotesBy default, npart=1 so all processes in the communicator participate in the processing of the whole interval. If npart>1 then the interval is divided into npart subintervals, each of them being processed by a subset of processes. |
Sets the restart parameter for the Krylov-Schur method, in particular the proportion of basis vectors that must be kept after restart. Parameters
NotesAllowed values are in the range [0.1,0.9]. The default is 0.5. |
Sets the subinterval boundaries for spectrum slicing with a computational interval. Parameterssubint: list of real values specifying subintervals NotesLogically Collective on EPS This function must be called after setKrylovSchurPartitions(). For npart partitions, the argument subint must contain npart+1 real values sorted in ascending order: subint_0, subint_1, ..., subint_npart, where the first and last values must coincide with the interval endpoints set with EPSSetInterval(). The subintervals are then defined by two consecutive points: [subint_0,subint_1], [subint_1,subint_2], and so on. |
Sets the type of reorthogonalization used during the Lanczos iteration. Parameters
NotesThis call is only relevant if the type was set to EPS.Type.LANCZOS with setType(). |
Sets the matrices associated with the eigenvalue problem. Parameters
|
Sets the prefix used for searching for all EPS options in the database. Parameters
NotesA hyphen (-) must NOT be given at the beginning of the prefix name. The first character of all runtime options is AUTOMATICALLY the hyphen. For example, to distinguish between the runtime options for two different EPS contexts, one could call: E1.setOptionsPrefix("eig1_") E2.setOptionsPrefix("eig2_")
|
Sets the type of shifts used during the power iteration. This can be used to emulate the Rayleigh Quotient Iteration (RQI) method. Parameters
NotesThis call is only relevant if the type was set to EPS.Type.POWER with setType(). By default, shifts are constant (EPS.PowerShiftType.CONSTANT) and the iteration is the simple power method (or inverse iteration if a shift-and-invert transformation is being used). A variable shift can be specified (EPS.PowerShiftType.RAYLEIGH or EPS.PowerShiftType.WILKINSON). In this case, the iteration behaves rather like a cubic converging method as RQI. |
Specifies the type of the eigenvalue problem. Parameters
NotesAllowed values are: Hermitian (HEP), non-Hermitian (NHEP), generalized Hermitian (GHEP), generalized non-Hermitian (GNHEP), and generalized non-Hermitian with positive semi-definite B (PGNHEP). This function must be used to instruct SLEPc to exploit symmetry. If no problem type is specified, by default a non-Hermitian problem is assumed (either standard or generalized). If the user knows that the problem is Hermitian (i.e. A=A^H) or generalized Hermitian (i.e. A=A^H, B=B^H, and B positive definite) then it is recommended to set the problem type so that eigensolver can exploit these properties. |
Associates a region object to the eigensolver. Parameters
|
Sets the reset parameter of the RQCG iteration. Every nrest iterations, the solver performs a Rayleigh-Ritz projection step. Parameters
|
Associates a spectral transformation object to the eigensolver. Parameters
|
Sets the value of the target. Parameters
NotesThe target is a scalar value used to determine the portion of the spectrum of interest. It is used in combination with setWhichEigenpairs(). |
Sets the tolerance and maximum iteration count used by the default EPS convergence tests. Parameters
NotesUse DECIDE for maxits to assign a reasonably good value, which is dependent on the solution method. |
Specifies if the solver must compute the residual of all approximate eigenpairs or not. Parameters
|
Specifies if the solver must compute the true residual explicitly or not. Parameters
|
Sets the solver to use a two-sided variant so that left eigenvectors are also computed. Parameters
|
Selects the particular solver to be used in the EPS object. Parameters
NotesSee EPS.Type for available methods. The default is EPS.Type.KRYLOVSCHUR. Normally, it is best to use setFromOptions() and then set the EPS type from the options database rather than by using this routine. Using the options database provides the user with maximum flexibility in evaluating the different available methods. |
Sets up all the internal data structures necessary for the execution of the eigensolver. NotesThis function need not be called explicitly in most cases, since solve() calls it. It can be useful when one wants to measure the set-up time separately from the solve time. |
Specifies which portion of the spectrum is to be sought. Parameters
NotesNot all eigensolvers implemented in EPS account for all the possible values. Also, some values make sense only for certain types of problems. If SLEPc is compiled for real numbers EPS.Which.LARGEST\_IMAGINARY and EPS.Which.SMALLEST\_IMAGINARY use the absolute value of the imaginary part for eigenvalue selection. |
Update the eigenproblem matrices stored internally in the subcommunicator to which the calling process belongs. Parameters
NotesThis function modifies the eigenproblem matrices at subcommunicator level, and optionally updates the global matrices in the parent communicator. The updates are expressed as A <-- s*A + a*Au, B <-- t*B + b*Bu. It is possible to update one of the matrices, or both. The matrices The If |
Prints the EPS data structure. Parameters
|
Home | Trees | Indices | Help |
|
---|
Generated by Epydoc 3.0.1 | http://epydoc.sourceforge.net |