Namespace ae108::cppslepc

Namespace List > ae108 > cppslepc

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

Classes

Type	Name
class	Context <class Policy>
struct	EigenPair <class Policy>
struct	EigenvalueProblemSolverDivergedException
struct	InvalidEigenvalueIndexException
struct	InvalidProblemTypeException
class	LinearEigenvalueProblemSolver <class Policy>
struct	NoOperatorsSetException

Public Functions

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

Detailed Description

Library for finding eigenvalues.

Public Functions Documentation

function computeEigenvalues

Returns the detected eigenvalues of A.

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

Exception:

• EigenvalueProblemSolverDivergedException if the solver failed to find a solution.

---

function computeEigenvalues

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

---

function computeEigenvalues

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

---

function computeEigenvalues

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

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

Exception:

• EigenvalueProblemSolverDivergedException if the solver failed to find a solution.

---

function computeEigenvalues

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

---

function computeEigenvalues

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

---

function computeSmallestEigenvalues

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

template<class Policy>
std::vector< std::complex< typename LinearEigenvalueProblemSolver < Policy >::real_type > > ae108::cppslepc::computeSmallestEigenvalues (
    const cpppetsc::Matrix < Policy > & 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

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

---

function computeSmallestEigenvalues

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

---

function computeSmallestEigenvalues

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

template<class Policy>
std::vector< std::complex< typename LinearEigenvalueProblemSolver < Policy >::real_type > > ae108::cppslepc::computeSmallestEigenvalues (
    const cpppetsc::Matrix < Policy > & A,
    const cpppetsc::Matrix < Policy > & 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.

---

function computeSmallestEigenvalues

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

---

function computeSmallestEigenvalues

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

---

---

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