From: Denis Davydov Date: Sat, 22 Nov 2014 06:42:42 +0000 (+0100) Subject: modified the documentation of the Arpack solver X-Git-Tag: v8.2.0-rc1~48^2~2 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=b26f6ec9ddb5aa5d1562fc521e078fe54de56f6e;p=dealii.git modified the documentation of the Arpack solver --- diff --git a/include/deal.II/lac/arpack_solver.h b/include/deal.II/lac/arpack_solver.h index daaddfd76a..21983c0283 100644 --- a/include/deal.II/lac/arpack_solver.h +++ b/include/deal.II/lac/arpack_solver.h @@ -55,20 +55,21 @@ extern "C" void dneupd_(int *rvec, char *howmany, int *select, double *d, * and $\lambda, x$ are a set of eigenvalues and eigenvectors * respectively. * - * The ArpackSolver can be used in application codes in the - * following way: + * The ArpackSolver can be used in application codes + * with serial objects in the following way: @code SolverControl solver_control (1000, 1e-9); ArpackSolver (solver_control); - system.solve (A, B, P, lambda, x, size_of_spectrum); + system.solve (A, B, OP, lambda, x, size_of_spectrum); @endcode * for the generalized eigenvalue problem $Ax=B\lambda x$, where * the variable size_of_spectrum * tells ARPACK the number of eigenvector/eigenvalue pairs to * solve for. Here, lambda is a vector that will contain * the eigenvalues computed, x a vector that will - * contain the eigenvectors computed, and P is - * a preconditioner for the matrix A. + * contain the eigenvectors computed, and OP is + * an inverse operation for the matrix A. + * Shift and invert transformation around zero is applied. * * Through the AdditionalData the user can specify some of the * parameters to be set.