mfem::SlepcEigenSolver Class Reference

#include <slepc.hpp>

Public Types
enum	Which {   LARGEST_MAGNITUDE, SMALLEST_MAGNITUDE, LARGEST_REAL, SMALLEST_REAL,   LARGEST_IMAGINARY, SMALLEST_IMAGINARY, TARGET_MAGNITUDE, TARGET_REAL }
enum	SpectralTransformation { SHIFT, SHIFT_INVERT }

Public Member Functions
	SlepcEigenSolver (MPI_Comm comm, const std::string &prefix=std::string())
	Constructors. More...
virtual	~SlepcEigenSolver ()
void	SetTol (double tol)
	Set solver tolerance. More...
void	SetMaxIter (int max_iter)
	Set maximum number of iterations. More...
void	SetNumModes (int num_eigs)
	Set the number of required eigenmodes. More...
void	SetOperator (const PetscParMatrix &op)
	Set operator for standard eigenvalue problem. More...
void	SetOperators (const PetscParMatrix &op, const PetscParMatrix &opB)
	Set operator for generalized eigenvalue problem. More...
void	Customize (bool customize=true) const
	Customize object with options set. More...
void	Solve ()
	Solve the eigenvalue problem for the specified number of eigenvalues. More...
int	GetNumConverged ()
	Get the number of converged eigenvalues. More...
void	GetEigenvalue (unsigned int i, double &lr) const
	Get the corresponding eigenvalue. More...
void	GetEigenvalue (unsigned int i, double &lr, double &lc) const
void	GetEigenvector (unsigned int i, Vector &vr) const
	Get the corresponding eigenvector. More...
void	GetEigenvector (unsigned int i, Vector &vr, Vector &vc) const
void	SetWhichEigenpairs (Which which)
void	SetTarget (double target)
void	SetSpectralTransformation (SpectralTransformation transformation)
	operator EPS () const
	Conversion function to SLEPc's EPS type. More...
	operator PetscObject () const
	Conversion function to PetscObject. More...

Detailed Description

Definition at line 33 of file slepc.hpp.

Member Enumeration Documentation

enum mfem::SlepcEigenSolver::SpectralTransformation

Enumerator
SHIFT
SHIFT_INVERT

Definition at line 94 of file slepc.hpp.

enum mfem::SlepcEigenSolver::Which

Target spectrum for the eigensolver. Target imaginary is not supported without complex support in SLEPc, and intervals are not implemented.

Enumerator
LARGEST_MAGNITUDE
SMALLEST_MAGNITUDE
LARGEST_REAL
SMALLEST_REAL
LARGEST_IMAGINARY
SMALLEST_IMAGINARY
TARGET_MAGNITUDE
TARGET_REAL

Definition at line 82 of file slepc.hpp.

Constructor & Destructor Documentation

mfem::SlepcEigenSolver::SlepcEigenSolver	(	MPI_Comm	comm,
		const std::string &	prefix = std::string()
	)

Constructors.

Definition at line 53 of file slepc.cpp.

mfem::SlepcEigenSolver::~SlepcEigenSolver ( )

virtual

Definition at line 63 of file slepc.cpp.

Member Function Documentation

void mfem::SlepcEigenSolver::Customize

(

bool

customize = true

)

const

Customize object with options set.

Definition at line 131 of file slepc.cpp.

void mfem::SlepcEigenSolver::GetEigenvalue	(	unsigned int	i,
		double &	lr
	)		const

Get the corresponding eigenvalue.

Definition at line 141 of file slepc.cpp.

void mfem::SlepcEigenSolver::GetEigenvalue	(	unsigned int	i,
		double &	lr,
		double &	lc
	)		const

Definition at line 146 of file slepc.cpp.

void mfem::SlepcEigenSolver::GetEigenvector	(	unsigned int	i,
		Vector &	vr
	)		const

Get the corresponding eigenvector.

Definition at line 152 of file slepc.cpp.

void mfem::SlepcEigenSolver::GetEigenvector	(	unsigned int	i,
		Vector &	vr,
		Vector &	vc
	)		const

Definition at line 165 of file slepc.cpp.

int mfem::SlepcEigenSolver::GetNumConverged

(

)

Get the number of converged eigenvalues.

Definition at line 182 of file slepc.cpp.

mfem::SlepcEigenSolver::operator EPS ( ) const

inline

Conversion function to SLEPc's EPS type.

Definition at line 105 of file slepc.hpp.

mfem::SlepcEigenSolver::operator PetscObject ( ) const

inline

Conversion function to PetscObject.

Definition at line 108 of file slepc.hpp.

void mfem::SlepcEigenSolver::SetMaxIter

(

int

max_iter

)

Set maximum number of iterations.

Definition at line 110 of file slepc.cpp.

void mfem::SlepcEigenSolver::SetNumModes

(

int

num_eigs

)

Set the number of required eigenmodes.

Definition at line 118 of file slepc.cpp.

void mfem::SlepcEigenSolver::SetOperator

(

const PetscParMatrix &

op

)

Set operator for standard eigenvalue problem.

Definition at line 74 of file slepc.cpp.

void mfem::SlepcEigenSolver::SetOperators	(	const PetscParMatrix &	op,
		const PetscParMatrix &	opB
	)

Set operator for generalized eigenvalue problem.

Definition at line 87 of file slepc.cpp.

void mfem::SlepcEigenSolver::SetSpectralTransformation

(

SlepcEigenSolver::SpectralTransformation

transformation

)

Definition at line 228 of file slepc.cpp.

void mfem::SlepcEigenSolver::SetTarget

(

double

target

)

Definition at line 223 of file slepc.cpp.

void mfem::SlepcEigenSolver::SetTol

(

double

tol

)

Set solver tolerance.

Definition at line 100 of file slepc.cpp.

void mfem::SlepcEigenSolver::SetWhichEigenpairs

(

SlepcEigenSolver::Which

which

)

Definition at line 189 of file slepc.cpp.

void mfem::SlepcEigenSolver::Solve

(

)

Solve the eigenvalue problem for the specified number of eigenvalues.

Definition at line 124 of file slepc.cpp.

---

The documentation for this class was generated from the following files:

• linalg/slepc.hpp
• linalg/slepc.cpp