From 81845377aa786978264cfa6d617cd114795f086c Mon Sep 17 00:00:00 2001 From: "Toby D. Young" Date: Sat, 20 Apr 2013 11:41:15 +0000 Subject: [PATCH] Exemplify solver options in documentation. git-svn-id: https://svn.dealii.org/trunk@29348 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/include/deal.II/lac/slepc_solver.h | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/deal.II/include/deal.II/lac/slepc_solver.h b/deal.II/include/deal.II/lac/slepc_solver.h index 5554e5ffe6..3d1eb2ff10 100644 --- a/deal.II/include/deal.II/lac/slepc_solver.h +++ b/deal.II/include/deal.II/lac/slepc_solver.h @@ -57,8 +57,20 @@ DEAL_II_NAMESPACE_OPEN * @endcode * for the generalized eigenvalue problem $Ax=B\lambda x$, where the * variable const unsigned int size_of_spectrum tells - * SLEPc the number of eigenvector/eigenvalue pairs to solve for: See - * also step-36 for a hands-on example. + + * SLEPc the number of eigenvector/eigenvalue pairs to solve + * for. Additional options and solver parameters can be passed to the + * SLEPc solvers before calling solve(). For example, if + * the matrices of the general eigenspectrum problem are not hermitian + * and the lower eigenvalues are wanted only, the following code can + * be implemented: + * @code + * system.set_problem_type (EPS_NHEP); + * system.set_which_eigenpairs (EPS_SMALLEST_REAL); + * @endcode + * These options can also be set at the commandline. + * + * See also step-36 for a hands-on example. * * An alternative implementation to the one above is to use the API * internals directly within the application code. In this way the -- 2.39.5