Namespace ae108::cppslepc

Namespace List > ae108 > cppslepc

C++ wrapper around the eigenvalue solving functionality of slepc. More...

Classes

Type	Name
class	Context
struct	EigenPair
struct	EigenvalueProblemSolverDivergedException
struct	InvalidEigenvalueIndexException
struct	InvalidProblemTypeException
class	LinearEigenvalueProblemSolver
struct	NoOperatorsSetException

Public Functions

Type	Name
std::vector< std::complex< typename LinearEigenvalueProblemSolver::real_type > >	computeEigenvalues (const cpppetsc::Matrix & A) Returns the detected eigenvalues of A.
std::vector< std::complex< typename LinearEigenvalueProblemSolver::real_type > >	computeEigenvalues (const cpppetsc::Matrix & A, const cpppetsc::Matrix & B) Returns the detected eigenvalues of the generalized eigenvalue problem A x = lambda * B x.
std::vector< std::complex< typename LinearEigenvalueProblemSolver::real_type > >	computeSmallestEigenvalues (const cpppetsc::Matrix & A, const std::size_t numberOfEigenvalues) Returns the n smallest found eigenvalues (by magnitude) of the eigenvalue problem A x = lambda * x.
std::vector< std::complex< typename LinearEigenvalueProblemSolver::real_type > >	computeSmallestEigenvalues (const cpppetsc::Matrix & A, const cpppetsc::Matrix & B, const std::size_t numberOfEigenvalues) Returns the n smallest found eigenvalues (by magnitude) of the generalized eigenvalue problem A x = lambda * B x.

Detailed Description

Library for finding eigenvalues.

Public Functions Documentation

function computeEigenvalues

Returns the detected eigenvalues of A.

std::vector< std::complex< typename LinearEigenvalueProblemSolver::real_type > > ae108::cppslepc::computeEigenvalues (
    const cpppetsc::Matrix & A
) 

Exception:

• EigenvalueProblemSolverDivergedException if the solver failed to find a solution.

---

function computeEigenvalues

Returns the detected eigenvalues of the generalized eigenvalue problem A x = lambda * B x.

std::vector< std::complex< typename LinearEigenvalueProblemSolver::real_type > > ae108::cppslepc::computeEigenvalues (
    const cpppetsc::Matrix & A,
    const cpppetsc::Matrix & B
) 

Exception:

• EigenvalueProblemSolverDivergedException if the solver failed to find a solution.

---

function computeSmallestEigenvalues

Returns the n smallest found eigenvalues (by magnitude) of the eigenvalue problem A x = lambda * x.

std::vector< std::complex< typename LinearEigenvalueProblemSolver::real_type > > ae108::cppslepc::computeSmallestEigenvalues (
    const cpppetsc::Matrix & A,
    const std::size_t numberOfEigenvalues
) 

Remark:

The selection of returned eigenvalues may depend on the numberOfEigenvalues parameter.

Exception:

• EigenvalueProblemSolverDivergedException if the solver failed to find a solution.

---

function computeSmallestEigenvalues

Returns the n smallest found eigenvalues (by magnitude) of the generalized eigenvalue problem A x = lambda * B x.

std::vector< std::complex< typename LinearEigenvalueProblemSolver::real_type > > ae108::cppslepc::computeSmallestEigenvalues (
    const cpppetsc::Matrix & A,
    const cpppetsc::Matrix & B,
    const std::size_t numberOfEigenvalues
) 

Remark:

The selection of returned eigenvalues may depend on the numberOfEigenvalues parameter.

Exception:

• EigenvalueProblemSolverDivergedException if the solver failed to find a solution.

---

---

The documentation for this class was generated from the following file cppslepc/src/include/ae108/cppslepc/computeEigenvalues.h