Classes | Public Types | Public Member Functions | Protected Attributes | Static Private Member Functions

ArpackSolver Class Reference

Inheritance diagram for ArpackSolver:
Inheritance graph
[legend]

List of all members.

Classes

struct  AdditionalData

Public Types

enum  WhichEigenvalues

Public Member Functions

SolverControlcontrol () const
 ArpackSolver (SolverControl &control, const AdditionalData &data=AdditionalData())
template<typename VECTOR , typename MATRIX1 , typename MATRIX2 , typename INVERSE >
void solve (const MATRIX1 &A, const MATRIX2 &B, const INVERSE &inverse, std::vector< std::complex< double > > &eigenvalues, std::vector< VECTOR > &eigenvectors, const unsigned int n_eigenvalues)

Protected Attributes

SolverControlsolver_control
const AdditionalData additional_data

Static Private Member Functions

::ExceptionBaseExcInvalidNumberofEigenvalues (int arg1, int arg2) throw (errortext << "Number of wanted eigenvalues " << arg1 << " is larger that the size of the matrix " << arg2 )

Detailed Description

Class to interface with the ARPACK routines.

Definition at line 76 of file arpack_solver.h.


Member Enumeration Documentation

An enum that lists the possible choices for which eigenvalues to compute in the solve() function.

Definition at line 84 of file arpack_solver.h.


Constructor & Destructor Documentation

ArpackSolver::ArpackSolver ( SolverControl control,
const AdditionalData data = AdditionalData() 
)

Constructor.

Definition at line 203 of file arpack_solver.h.


Member Function Documentation

SolverControl & ArpackSolver::control ( ) const

Access to the object that controls convergence.

Definition at line 500 of file arpack_solver.h.

References solver_control.

Referenced by solve().

template<typename VECTOR , typename MATRIX1 , typename MATRIX2 , typename INVERSE >
void ArpackSolver::solve ( const MATRIX1 &  A,
const MATRIX2 &  B,
const INVERSE &  inverse,
std::vector< std::complex< double > > &  eigenvalues,
std::vector< VECTOR > &  eigenvectors,
const unsigned int  n_eigenvalues 
)

Solve the generalized eigensprectrum problem $A x=\lambda B x$ by calling dneupd and dnaupd of ARPACK.

'G' generalized eigenvalue problem 'I' standard eigenvalue problem

Specify the eigenvalues of interest, possible parameters "LA" algebraically largest "SA" algebraically smallest "LM" largest magnitude "SM" smallest magnitude "LR" largest real part "SR" smallest real part "LI" largest imaginary part "SI" smallest imaginary part "BE" both ends of spectrum simultaneous

Sets the mode of dsaupd. 1 is exact shifting, 2 is user-supplied shifts, 3 is shift-invert mode, 4 is buckling mode, 5 is Cayley mode.

1 - compute eigenvectors, 0 - only eigenvalues

Definition at line 213 of file arpack_solver.h.

References additional_data, Assert, AssertDimension, control(), ExcInvalidNumberofEigenvalues(), SolverControl::max_steps(), and SolverControl::tolerance().

::ExceptionBase& ArpackSolver::ExcInvalidNumberofEigenvalues ( int  arg1,
int  arg2 
) throw (errortext << "Number of wanted eigenvalues " << arg1 << " is larger that the size of the matrix " << arg2 ) [static, private]

Exceptions.

Referenced by solve().


Member Data Documentation

Reference to the object that controls convergence of the iterative solver.

Definition at line 145 of file arpack_solver.h.

Referenced by control().

Store a copy of the flags for this particular solver.

Definition at line 151 of file arpack_solver.h.

Referenced by solve().


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

deal.II documentation generated on Thu May 17 2012 20:05:29 by doxygen 1.7.3