This class provides an interface to the SLEPc eigenvalue solver library from http://slepc.upv.es/. More...

#include <slepc_eigen_solver.h>

Inheritance diagram for libMesh::SlepcEigenSolver< T >:

Public Member Functions
	SlepcEigenSolver (const Parallel::Communicator &comm_in)
	Constructor. More...

	~SlepcEigenSolver ()
	Destructor. More...

virtual void	clear () override
	Release all memory and clear data structures. More...

virtual void	init () override
	Initialize data structures if not done so already. More...

virtual std::pair< unsigned int, unsigned int >	solve_standard (SparseMatrix< T > &matrix_A, int nev, int ncv, const double tol, const unsigned int m_its) override
	This function calls the SLEPc solver to compute the eigenpairs of the SparseMatrix matrix_A. More...

virtual std::pair< unsigned int, unsigned int >	solve_standard (ShellMatrix< T > &shell_matrix, int nev, int ncv, const double tol, const unsigned int m_its) override
	Same as above except that matrix_A is a ShellMatrix in this case. More...

virtual std::pair< unsigned int, unsigned int >	solve_generalized (SparseMatrix< T > &matrix_A, SparseMatrix< T > &matrix_B, int nev, int ncv, const double tol, const unsigned int m_its) override
	This function calls the SLEPc solver to compute the eigenpairs for the generalized eigenproblem defined by the matrix_A and matrix_B, which are of type SparseMatrix. More...

virtual std::pair< unsigned int, unsigned int >	solve_generalized (ShellMatrix< T > &matrix_A, SparseMatrix< T > &matrix_B, int nev, int ncv, const double tol, const unsigned int m_its) override
	Solve generalized eigenproblem when matrix_A is of type ShellMatrix, matrix_B is of type SparseMatrix. More...

virtual std::pair< unsigned int, unsigned int >	solve_generalized (SparseMatrix< T > &matrix_A, ShellMatrix< T > &matrix_B, int nev, int ncv, const double tol, const unsigned int m_its) override
	Solve generalized eigenproblem when matrix_A is of type SparseMatrix, matrix_B is of type ShellMatrix. More...

virtual std::pair< unsigned int, unsigned int >	solve_generalized (ShellMatrix< T > &matrix_A, ShellMatrix< T > &matrix_B, int nev, int ncv, const double tol, const unsigned int m_its) override
	Solve generalized eigenproblem when both matrix_A and matrix_B are of type ShellMatrix. More...

virtual std::pair< Real, Real >	get_eigenpair (dof_id_type i, NumericVector< T > &solution_in) override

virtual std::pair< Real, Real >	get_eigenvalue (dof_id_type i) override
	Same as above, but does not copy the eigenvector. More...

Real	get_relative_error (unsigned int i)

virtual void	attach_deflation_space (NumericVector< T > &deflation_vector) override
	Attach a deflation space defined by a single vector. More...

virtual void	set_initial_space (NumericVector< T > &initial_space_in) override
	Use `initial_space_in` as the initial guess. More...

EPS	eps ()

bool	initialized () const

bool	get_close_matrix_before_solve () const

void	set_close_matrix_before_solve (bool val)
	Set the flag which controls whether libmesh closes the eigenproblem matrices before solving. More...

EigenSolverType	eigen_solver_type () const

EigenProblemType	eigen_problem_type () const

PositionOfSpectrum	position_of_spectrum () const

void	set_eigensolver_type (const EigenSolverType est)
	Sets the type of eigensolver to use. More...

void	set_eigenproblem_type (EigenProblemType ept)
	Sets the type of the eigenproblem. More...

void	set_position_of_spectrum (PositionOfSpectrum pos)
	Sets the position of the spectrum. More...

void	set_position_of_spectrum (Real pos)

void	set_position_of_spectrum (Real pos, PositionOfSpectrum target)

void	set_solver_configuration (SolverConfiguration &solver_configuration)
	Set the solver configuration object. More...

const Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

processor_id_type	processor_id () const

Static Public Member Functions
static std::unique_ptr< EigenSolver< T > >	build (const Parallel::Communicator &comm_in, const SolverPackage solver_package=SLEPC_SOLVERS)
	Builds an `EigenSolver` using the linear solver package specified by `solver_package`. More...

static std::string	get_info ()
	Gets a string containing the reference information. More...

static void	print_info (std::ostream &out=libMesh::out)
	Prints the reference information, by default to `libMesh::out`. More...

static unsigned int	n_objects ()
	Prints the number of outstanding (created, but not yet destroyed) objects. More...

static void	enable_print_counter_info ()
	Methods to enable/disable the reference counter output from print_info() More...

static void	disable_print_counter_info ()

Protected Types
typedef std::map< std::string, std::pair< unsigned int, unsigned int > >	Counts
	Data structure to log the information. More...

Protected Member Functions
void	increment_constructor_count (const std::string &name)
	Increments the construction counter. More...

void	increment_destructor_count (const std::string &name)
	Increments the destruction counter. More...

Protected Attributes
EigenSolverType	_eigen_solver_type
	Enum stating which type of eigensolver to use. More...

EigenProblemType	_eigen_problem_type
	Enum stating which type of eigen problem we deal with. More...

PositionOfSpectrum	_position_of_spectrum
	Enum stating where to evaluate the spectrum. More...

bool	_is_initialized
	Flag indicating if the data structures have been initialized. More...

SolverConfiguration *	_solver_configuration
	Optionally store a SolverOptions object that can be used to set parameters like solver type, tolerances and iteration limits. More...

Real	_target_val

bool	_close_matrix_before_solve

const Parallel::Communicator &	_communicator

Static Protected Attributes
static Counts	_counts
	Actually holds the data. More...

static Threads::atomic< unsigned int >	_n_objects
	The number of objects. More...

static Threads::spin_mutex	_mutex
	Mutual exclusion object to enable thread-safe reference counting. More...

static bool	_enable_print_counter
	Flag to control whether reference count information is printed when print_info is called. More...

Private Member Functions
std::pair< unsigned int, unsigned int >	_solve_standard_helper (Mat mat, int nev, int ncv, const double tol, const unsigned int m_its)
	Helper function that actually performs the standard eigensolve. More...

std::pair< unsigned int, unsigned int >	_solve_generalized_helper (Mat mat_A, Mat mat_B, int nev, int ncv, const double tol, const unsigned int m_its)
	Helper function that actually performs the generalized eigensolve. More...

void	set_slepc_solver_type ()
	Tells Slepc to use the user-specified solver stored in `_eigen_solver_type`. More...

void	set_slepc_problem_type ()
	Tells Slepc to deal with the type of problem stored in `_eigen_problem_type`. More...

void	set_slepc_position_of_spectrum ()
	Tells Slepc to compute the spectrum at the position stored in `_position_of_spectrum`. More...

Static Private Member Functions
static PetscErrorCode	_petsc_shell_matrix_mult (Mat mat, Vec arg, Vec dest)
	Internal function if shell matrix mode is used, this just calls the shell matrix's matrix multiplication function. More...

static PetscErrorCode	_petsc_shell_matrix_get_diagonal (Mat mat, Vec dest)
	Internal function if shell matrix mode is used, this just calls the shell matrix's get_diagonal function. More...

Private Attributes
EPS	_eps
	Eigenproblem solver context. More...

Detailed Description

template<typename T>
class libMesh::SlepcEigenSolver< T >

This class provides an interface to the SLEPc eigenvalue solver library from http://slepc.upv.es/.

Author: Steffen Peterson

Date: 2005 EigenSolver implementation based on SLEPc.

Definition at line 50 of file slepc_eigen_solver.h.

Member Typedef Documentation

◆ Counts

typedef std::map<std::string, std::pair<unsigned int, unsigned int> > libMesh::ReferenceCounter::Counts

protectedinherited

Data structure to log the information.

The log is identified by the class name.

Definition at line 117 of file reference_counter.h.

Constructor & Destructor Documentation

◆ SlepcEigenSolver()

template<typename T >

libMesh::SlepcEigenSolver< T >::SlepcEigenSolver ( const Parallel::Communicator & comm_in )

Constructor.

Initializes Petsc data structures

◆ ~SlepcEigenSolver()

template<typename T >

libMesh::SlepcEigenSolver< T >::~SlepcEigenSolver ( )

Destructor.

Member Function Documentation

◆ _petsc_shell_matrix_get_diagonal()

template<typename T >

static PetscErrorCode libMesh::SlepcEigenSolver< T >::_petsc_shell_matrix_get_diagonal	(	Mat	mat,
		Vec	dest
	)

staticprivate

Internal function if shell matrix mode is used, this just calls the shell matrix's get_diagonal function.

Required in order to use Jacobi preconditioning.

◆ _petsc_shell_matrix_mult()

template<typename T >

static PetscErrorCode libMesh::SlepcEigenSolver< T >::_petsc_shell_matrix_mult	(	Mat	mat,
		Vec	arg,
		Vec	dest
	)

staticprivate

Internal function if shell matrix mode is used, this just calls the shell matrix's matrix multiplication function.

See PetscLinearSolver for a similar implementation.

◆ _solve_generalized_helper()

template<typename T >

std::pair<unsigned int, unsigned int> libMesh::SlepcEigenSolver< T >::_solve_generalized_helper	(	Mat	mat_A,
		Mat	mat_B,
		int	nev,
		int	ncv,
		const double	tol,
		const unsigned int	m_its
	)

private

Helper function that actually performs the generalized eigensolve.

◆ _solve_standard_helper()

template<typename T >

std::pair<unsigned int, unsigned int> libMesh::SlepcEigenSolver< T >::_solve_standard_helper	(	Mat	mat,
		int	nev,
		int	ncv,
		const double	tol,
		const unsigned int	m_its
	)

private

Helper function that actually performs the standard eigensolve.

◆ attach_deflation_space()

template<typename T >

virtual void libMesh::SlepcEigenSolver< T >::attach_deflation_space ( NumericVector< T > & deflation_vector )

overridevirtual

Attach a deflation space defined by a single vector.

Implements libMesh::EigenSolver< T >.

◆ build()

template<typename T >

static std::unique_ptr<EigenSolver<T> > libMesh::EigenSolver< T >::build	(	const Parallel::Communicator &	comm_in,
		const SolverPackage	solver_package = `SLEPC_SOLVERS`
	)

staticinherited

Builds an EigenSolver using the linear solver package specified by solver_package.

◆ clear()

template<typename T >

virtual void libMesh::SlepcEigenSolver< T >::clear ( )

overridevirtual

Release all memory and clear data structures.

Reimplemented from libMesh::EigenSolver< T >.

◆ comm()

const Parallel::Communicator& libMesh::ParallelObject::comm ( ) const

inherited

Returns: A reference to the Parallel::Communicator object used by this mesh.

Definition at line 87 of file parallel_object.h.

References libMesh::ParallelObject::_communicator.

Referenced by libMesh::EpetraVector< T >::EpetraVector(), libMesh::Parallel::sync_element_data_by_parent_id(), libMesh::Parallel::sync_node_data_by_element_id(), and libMesh::Parallel::sync_node_data_by_element_id_once().

88 { return _communicator; }

libMesh::ParallelObject::_communicator

const Parallel::Communicator & _communicator

Definition: parallel_object.h:105

◆ disable_print_counter_info()

static void libMesh::ReferenceCounter::disable_print_counter_info ( )

staticinherited

◆ eigen_problem_type()

template<typename T >

EigenProblemType libMesh::EigenSolver< T >::eigen_problem_type ( ) const

inherited

Returns: The type of the eigen problem.

Definition at line 135 of file eigen_solver.h.

References libMesh::EigenSolver< T >::_eigen_problem_type.

135 { return _eigen_problem_type;}

libMesh::EigenSolver::_eigen_problem_type

EigenProblemType _eigen_problem_type

Enum stating which type of eigen problem we deal with.

Definition: eigen_solver.h:285

◆ eigen_solver_type()

template<typename T >

EigenSolverType libMesh::EigenSolver< T >::eigen_solver_type ( ) const

inherited

Returns: The type of eigensolver to use.

Definition at line 130 of file eigen_solver.h.

References libMesh::EigenSolver< T >::_eigen_solver_type.

130 { return _eigen_solver_type; }

libMesh::EigenSolver::_eigen_solver_type

EigenSolverType _eigen_solver_type

Enum stating which type of eigensolver to use.

Definition: eigen_solver.h:280

◆ enable_print_counter_info()

static void libMesh::ReferenceCounter::enable_print_counter_info ( )

staticinherited

Methods to enable/disable the reference counter output from print_info()

◆ eps()

template<typename T >

EPS libMesh::SlepcEigenSolver< T >::eps ( )

Returns: The raw SLEPc EPS pointer.

Definition at line 214 of file slepc_eigen_solver.h.

References libMesh::SlepcEigenSolver< T >::_eps, and libMesh::SlepcEigenSolver< T >::init().

214 { this->init(); return _eps; }

libMesh::SlepcEigenSolver::init

virtual void init() override

Initialize data structures if not done so already.

libMesh::SlepcEigenSolver::_eps

EPS _eps

Eigenproblem solver context.

Definition: slepc_eigen_solver.h:272

◆ get_close_matrix_before_solve()

template<typename T >

bool libMesh::EigenSolver< T >::get_close_matrix_before_solve ( ) const

inherited

Returns: The value of the flag which controls whether libmesh closes the eigenproblem matrices before solving. true by default.

Definition at line 101 of file eigen_solver.h.

References libMesh::EigenSolver< T >::_close_matrix_before_solve.

   {
     libmesh_experimental();
     return _close_matrix_before_solve;
   }

◆ get_eigenpair()

template<typename T >

virtual std::pair<Real, Real> libMesh::SlepcEigenSolver< T >::get_eigenpair	(	dof_id_type	i,
		NumericVector< T > &	solution_in
	)

overridevirtual

Returns: The real and imaginary part of the ith eigenvalue and copies the respective eigenvector to the solution vector.

Note: The eigenpair may be complex even for real-valued matrices.

Implements libMesh::EigenSolver< T >.

◆ get_eigenvalue()

template<typename T >

virtual std::pair<Real, Real> libMesh::SlepcEigenSolver< T >::get_eigenvalue ( dof_id_type i )

overridevirtual

Same as above, but does not copy the eigenvector.

Implements libMesh::EigenSolver< T >.

◆ get_info()

static std::string libMesh::ReferenceCounter::get_info ( )

staticinherited

Gets a string containing the reference information.

◆ get_relative_error()

template<typename T >

Real libMesh::SlepcEigenSolver< T >::get_relative_error ( unsigned int i )

Returns: The relative error $||A x - \lambda x|| / |\lambda x|$ of the ith eigenpair (or the equivalent for a general eigenvalue problem).

◆ increment_constructor_count()

void libMesh::ReferenceCounter::increment_constructor_count ( const std::string & name )

protectedinherited

Increments the construction counter.

Should be called in the constructor of any derived class that will be reference counted.

Definition at line 181 of file reference_counter.h.

References libMesh::ReferenceCounter::_counts, libMesh::Quality::name(), and libMesh::Threads::spin_mtx.

Referenced by libMesh::ReferenceCountedObject< RBParametrized >::ReferenceCountedObject().

 {
   Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
   std::pair<unsigned int, unsigned int> & p = _counts[name];
 
   p.first++;
 }

◆ increment_destructor_count()

void libMesh::ReferenceCounter::increment_destructor_count ( const std::string & name )

protectedinherited

Increments the destruction counter.

Should be called in the destructor of any derived class that will be reference counted.

Definition at line 194 of file reference_counter.h.

References libMesh::ReferenceCounter::_counts, libMesh::Quality::name(), and libMesh::Threads::spin_mtx.

Referenced by libMesh::ReferenceCountedObject< RBParametrized >::~ReferenceCountedObject().

 {
   Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
   std::pair<unsigned int, unsigned int> & p = _counts[name];
 
   p.second++;
 }

◆ init()

template<typename T >

virtual void libMesh::SlepcEigenSolver< T >::init ( )

overridevirtual

Initialize data structures if not done so already.

Implements libMesh::EigenSolver< T >.

Referenced by libMesh::SlepcEigenSolver< T >::eps().

◆ initialized()

template<typename T >

bool libMesh::EigenSolver< T >::initialized ( ) const

inherited

Returns: true if the data structures are initialized, false otherwise.

Definition at line 94 of file eigen_solver.h.

References libMesh::EigenSolver< T >::_is_initialized.

94 { return _is_initialized; }

libMesh::EigenSolver::_is_initialized

bool _is_initialized

Flag indicating if the data structures have been initialized.

Definition: eigen_solver.h:295

◆ n_objects()

static unsigned int libMesh::ReferenceCounter::n_objects ( )

staticinherited

Prints the number of outstanding (created, but not yet destroyed) objects.

Definition at line 83 of file reference_counter.h.

References libMesh::ReferenceCounter::_n_objects.

84 { return _n_objects; }

libMesh::ReferenceCounter::_n_objects

static Threads::atomic< unsigned int > _n_objects

The number of objects.

Definition: reference_counter.h:130

◆ n_processors()

processor_id_type libMesh::ParallelObject::n_processors ( ) const

inherited

Returns: The number of processors in the group.

Definition at line 93 of file parallel_object.h.

References libMesh::ParallelObject::_communicator, and libMesh::Parallel::Communicator::size().

Referenced by libMesh::MeshBase::partition().

94 { return cast_int<processor_id_type>(_communicator.size()); }

libMesh::Parallel::Communicator::size

processor_id_type size() const

Definition: communicator.h:175

libMesh::ParallelObject::_communicator

const Parallel::Communicator & _communicator

Definition: parallel_object.h:105

◆ position_of_spectrum()

template<typename T >

PositionOfSpectrum libMesh::EigenSolver< T >::position_of_spectrum ( ) const

inherited

Returns: The position of the spectrum to compute.

Definition at line 140 of file eigen_solver.h.

References libMesh::EigenSolver< T >::_position_of_spectrum.

141 { return _position_of_spectrum;}

libMesh::EigenSolver::_position_of_spectrum

PositionOfSpectrum _position_of_spectrum

Enum stating where to evaluate the spectrum.

Definition: eigen_solver.h:290

◆ print_info()

static void libMesh::ReferenceCounter::print_info ( std::ostream & out = libMesh::out )

staticinherited

Prints the reference information, by default to libMesh::out.

◆ processor_id()

processor_id_type libMesh::ParallelObject::processor_id ( ) const

inherited

Returns: The rank of this processor in the group.

Definition at line 99 of file parallel_object.h.

References libMesh::ParallelObject::_communicator, and libMesh::Parallel::Communicator::rank().

Referenced by libMesh::DofMap::end_dof(), libMesh::DofMap::end_old_dof(), libMesh::DofMap::first_dof(), libMesh::DofMap::first_old_dof(), libMesh::DofMap::last_dof(), libMesh::MeshBase::n_active_local_elem(), libMesh::DofMap::n_local_dofs(), libMesh::MeshBase::n_local_elem(), libMesh::MeshBase::n_local_nodes(), and libMesh::MeshTools::weight().

100 { return cast_int<processor_id_type>(_communicator.rank()); }

libMesh::ParallelObject::_communicator

const Parallel::Communicator & _communicator

Definition: parallel_object.h:105

libMesh::Parallel::Communicator::rank

processor_id_type rank() const

Definition: communicator.h:173

◆ set_close_matrix_before_solve()

template<typename T >

void libMesh::EigenSolver< T >::set_close_matrix_before_solve ( bool val )

inherited

Set the flag which controls whether libmesh closes the eigenproblem matrices before solving.

Definition at line 111 of file eigen_solver.h.

References libMesh::EigenSolver< T >::_close_matrix_before_solve.

   {
     libmesh_experimental();
     _close_matrix_before_solve = val;
   }

◆ set_eigenproblem_type()

template<typename T >

void libMesh::EigenSolver< T >::set_eigenproblem_type ( EigenProblemType ept )

inherited

Sets the type of the eigenproblem.

Definition at line 152 of file eigen_solver.h.

References libMesh::EigenSolver< T >::_eigen_problem_type.

153 {_eigen_problem_type = ept;}

libMesh::EigenSolver::_eigen_problem_type

EigenProblemType _eigen_problem_type

Enum stating which type of eigen problem we deal with.

Definition: eigen_solver.h:285

◆ set_eigensolver_type()

template<typename T >

void libMesh::EigenSolver< T >::set_eigensolver_type ( const EigenSolverType est )

inherited

Sets the type of eigensolver to use.

Definition at line 146 of file eigen_solver.h.

References libMesh::EigenSolver< T >::_eigen_solver_type.

147 { _eigen_solver_type = est; }

libMesh::EigenSolver::_eigen_solver_type

EigenSolverType _eigen_solver_type

Enum stating which type of eigensolver to use.

Definition: eigen_solver.h:280

◆ set_initial_space()

template<typename T >

virtual void libMesh::SlepcEigenSolver< T >::set_initial_space ( NumericVector< T > & initial_space_in )

overridevirtual

Use initial_space_in as the initial guess.

Implements libMesh::EigenSolver< T >.

◆ set_position_of_spectrum() [1/3]

template<typename T >

void libMesh::EigenSolver< T >::set_position_of_spectrum ( PositionOfSpectrum pos )

inherited

Sets the position of the spectrum.

Definition at line 158 of file eigen_solver.h.

References libMesh::EigenSolver< T >::_position_of_spectrum.

159 {_position_of_spectrum= pos;}

libMesh::EigenSolver::_position_of_spectrum

PositionOfSpectrum _position_of_spectrum

Enum stating where to evaluate the spectrum.

Definition: eigen_solver.h:290

◆ set_position_of_spectrum() [2/3]

template<typename T >

void libMesh::EigenSolver< T >::set_position_of_spectrum ( Real pos )

inherited

◆ set_position_of_spectrum() [3/3]

template<typename T >

void libMesh::EigenSolver< T >::set_position_of_spectrum	(	Real	pos,
		PositionOfSpectrum	target
	)

inherited

◆ set_slepc_position_of_spectrum()

template<typename T >

void libMesh::SlepcEigenSolver< T >::set_slepc_position_of_spectrum ( )

private

Tells Slepc to compute the spectrum at the position stored in _position_of_spectrum.

◆ set_slepc_problem_type()

template<typename T >

void libMesh::SlepcEigenSolver< T >::set_slepc_problem_type ( )

private

Tells Slepc to deal with the type of problem stored in _eigen_problem_type.

◆ set_slepc_solver_type()

template<typename T >

void libMesh::SlepcEigenSolver< T >::set_slepc_solver_type ( )

private

Tells Slepc to use the user-specified solver stored in _eigen_solver_type.

◆ set_solver_configuration()

template<typename T >

void libMesh::EigenSolver< T >::set_solver_configuration ( SolverConfiguration & solver_configuration )

inherited

Set the solver configuration object.

◆ solve_generalized() [1/4]

template<typename T >

virtual std::pair<unsigned int, unsigned int> libMesh::SlepcEigenSolver< T >::solve_generalized	(	SparseMatrix< T > &	matrix_A,
		SparseMatrix< T > &	matrix_B,
		int	nev,
		int	ncv,
		const double	tol,
		const unsigned int	m_its
	)

overridevirtual

This function calls the SLEPc solver to compute the eigenpairs for the generalized eigenproblem defined by the matrix_A and matrix_B, which are of type SparseMatrix.

The argument nev is the number of eigenpairs to be computed and ncv is the number of basis vectors to be used in the solution procedure. Return values are the number of converged eigen values and the number of the iterations carried out by the eigen solver.

Implements libMesh::EigenSolver< T >.

◆ solve_generalized() [2/4]

template<typename T >

virtual std::pair<unsigned int, unsigned int> libMesh::SlepcEigenSolver< T >::solve_generalized	(	ShellMatrix< T > &	matrix_A,
		SparseMatrix< T > &	matrix_B,
		int	nev,
		int	ncv,
		const double	tol,
		const unsigned int	m_its
	)

overridevirtual

Solve generalized eigenproblem when matrix_A is of type ShellMatrix, matrix_B is of type SparseMatrix.

Implements libMesh::EigenSolver< T >.

◆ solve_generalized() [3/4]

template<typename T >

virtual std::pair<unsigned int, unsigned int> libMesh::SlepcEigenSolver< T >::solve_generalized	(	SparseMatrix< T > &	matrix_A,
		ShellMatrix< T > &	matrix_B,
		int	nev,
		int	ncv,
		const double	tol,
		const unsigned int	m_its
	)

overridevirtual

Solve generalized eigenproblem when matrix_A is of type SparseMatrix, matrix_B is of type ShellMatrix.

When using this function, one should use the command line options: -st_ksp_type gmres -st_pc_type none or -st_ksp_type gmres -st_pc_type jacobi or similar.

Implements libMesh::EigenSolver< T >.

◆ solve_generalized() [4/4]

template<typename T >

virtual std::pair<unsigned int, unsigned int> libMesh::SlepcEigenSolver< T >::solve_generalized	(	ShellMatrix< T > &	matrix_A,
		ShellMatrix< T > &	matrix_B,
		int	nev,
		int	ncv,
		const double	tol,
		const unsigned int	m_its
	)

overridevirtual

Solve generalized eigenproblem when both matrix_A and matrix_B are of type ShellMatrix.

When using this function, one should use the command line options: -st_ksp_type gmres -st_pc_type none or -st_ksp_type gmres -st_pc_type jacobi or similar.

Implements libMesh::EigenSolver< T >.

◆ solve_standard() [1/2]

template<typename T >

virtual std::pair<unsigned int, unsigned int> libMesh::SlepcEigenSolver< T >::solve_standard	(	SparseMatrix< T > &	matrix_A,
		int	nev,
		int	ncv,
		const double	tol,
		const unsigned int	m_its
	)

overridevirtual

This function calls the SLEPc solver to compute the eigenpairs of the SparseMatrix matrix_A.

nev is the number of eigenpairs to be computed and ncv is the number of basis vectors to be used in the solution procedure. Return values are the number of converged eigen values and the number of the iterations carried out by the eigen solver.

Implements libMesh::EigenSolver< T >.

◆ solve_standard() [2/2]

template<typename T >

virtual std::pair<unsigned int, unsigned int> libMesh::SlepcEigenSolver< T >::solve_standard	(	ShellMatrix< T > &	shell_matrix,
		int	nev,
		int	ncv,
		const double	tol,
		const unsigned int	m_its
	)

overridevirtual

Same as above except that matrix_A is a ShellMatrix in this case.

Implements libMesh::EigenSolver< T >.

Member Data Documentation

◆ _close_matrix_before_solve

template<typename T >

bool libMesh::EigenSolver< T >::_close_matrix_before_solve

protectedinherited

Definition at line 305 of file eigen_solver.h.

Referenced by libMesh::EigenSolver< T >::get_close_matrix_before_solve(), and libMesh::EigenSolver< T >::set_close_matrix_before_solve().

◆ _communicator

const Parallel::Communicator& libMesh::ParallelObject::_communicator

protectedinherited

Definition at line 105 of file parallel_object.h.

Referenced by libMesh::ParallelObject::comm(), libMesh::ParallelObject::n_processors(), libMesh::ParallelObject::operator=(), and libMesh::ParallelObject::processor_id().

◆ _counts

Counts libMesh::ReferenceCounter::_counts

staticprotectedinherited

Actually holds the data.

Definition at line 122 of file reference_counter.h.

Referenced by libMesh::ReferenceCounter::increment_constructor_count(), and libMesh::ReferenceCounter::increment_destructor_count().

◆ _eigen_problem_type

template<typename T >

EigenProblemType libMesh::EigenSolver< T >::_eigen_problem_type

protectedinherited

Enum stating which type of eigen problem we deal with.

Definition at line 285 of file eigen_solver.h.

Referenced by libMesh::EigenSolver< T >::eigen_problem_type(), and libMesh::EigenSolver< T >::set_eigenproblem_type().

◆ _eigen_solver_type

template<typename T >

EigenSolverType libMesh::EigenSolver< T >::_eigen_solver_type

protectedinherited

Enum stating which type of eigensolver to use.

Definition at line 280 of file eigen_solver.h.

Referenced by libMesh::EigenSolver< T >::eigen_solver_type(), and libMesh::EigenSolver< T >::set_eigensolver_type().

◆ _enable_print_counter

bool libMesh::ReferenceCounter::_enable_print_counter

staticprotectedinherited

Flag to control whether reference count information is printed when print_info is called.

Definition at line 141 of file reference_counter.h.

◆ _eps

template<typename T >

EPS libMesh::SlepcEigenSolver< T >::_eps

private

Eigenproblem solver context.

Definition at line 272 of file slepc_eigen_solver.h.

Referenced by libMesh::SlepcEigenSolver< T >::eps().

◆ _is_initialized

template<typename T >

bool libMesh::EigenSolver< T >::_is_initialized

protectedinherited

Flag indicating if the data structures have been initialized.

Definition at line 295 of file eigen_solver.h.

Referenced by libMesh::EigenSolver< T >::initialized().

◆ _mutex

Threads::spin_mutex libMesh::ReferenceCounter::_mutex

staticprotectedinherited

Mutual exclusion object to enable thread-safe reference counting.

Definition at line 135 of file reference_counter.h.

◆ _n_objects

Threads::atomic<unsigned int> libMesh::ReferenceCounter::_n_objects

staticprotectedinherited

The number of objects.

Print the reference count information when the number returns to 0.

Definition at line 130 of file reference_counter.h.

Referenced by libMesh::ReferenceCounter::n_objects(), libMesh::ReferenceCounter::ReferenceCounter(), and libMesh::ReferenceCounter::~ReferenceCounter().

◆ _position_of_spectrum

template<typename T >

PositionOfSpectrum libMesh::EigenSolver< T >::_position_of_spectrum

protectedinherited

Enum stating where to evaluate the spectrum.

Definition at line 290 of file eigen_solver.h.

Referenced by libMesh::EigenSolver< T >::position_of_spectrum(), and libMesh::EigenSolver< T >::set_position_of_spectrum().

◆ _solver_configuration

template<typename T >

SolverConfiguration* libMesh::EigenSolver< T >::_solver_configuration

protectedinherited

Optionally store a SolverOptions object that can be used to set parameters like solver type, tolerances and iteration limits.

Definition at line 301 of file eigen_solver.h.

◆ _target_val

template<typename T >

Real libMesh::EigenSolver< T >::_target_val

protectedinherited

Definition at line 303 of file eigen_solver.h.

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

include/solvers/slepc_eigen_solver.h

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

template<typename T> class libMesh::SlepcEigenSolver< T >

Member Typedef Documentation

◆ Counts

Constructor & Destructor Documentation

◆ SlepcEigenSolver()

◆ ~SlepcEigenSolver()

Member Function Documentation

◆ _petsc_shell_matrix_get_diagonal()

◆ _petsc_shell_matrix_mult()

◆ _solve_generalized_helper()

◆ _solve_standard_helper()

◆ attach_deflation_space()

◆ build()

◆ clear()

◆ comm()

◆ disable_print_counter_info()

◆ eigen_problem_type()

◆ eigen_solver_type()

◆ enable_print_counter_info()

◆ eps()

◆ get_close_matrix_before_solve()

◆ get_eigenpair()

◆ get_eigenvalue()

◆ get_info()

◆ get_relative_error()

◆ increment_constructor_count()

◆ increment_destructor_count()

◆ init()

◆ initialized()

◆ n_objects()

◆ n_processors()

◆ position_of_spectrum()

◆ print_info()

◆ processor_id()

◆ set_close_matrix_before_solve()

◆ set_eigenproblem_type()

◆ set_eigensolver_type()

◆ set_initial_space()

◆ set_position_of_spectrum() [1/3]

◆ set_position_of_spectrum() [2/3]

◆ set_position_of_spectrum() [3/3]

◆ set_slepc_position_of_spectrum()

◆ set_slepc_problem_type()

◆ set_slepc_solver_type()

◆ set_solver_configuration()

◆ solve_generalized() [1/4]

◆ solve_generalized() [2/4]

◆ solve_generalized() [3/4]

◆ solve_generalized() [4/4]

◆ solve_standard() [1/2]

◆ solve_standard() [2/2]

Member Data Documentation

◆ _close_matrix_before_solve

◆ _communicator

◆ _counts

◆ _eigen_problem_type

◆ _eigen_solver_type

◆ _enable_print_counter

◆ _eps

◆ _is_initialized

◆ _mutex

◆ _n_objects

◆ _position_of_spectrum

◆ _solver_configuration

◆ _target_val

template<typename T>
class libMesh::SlepcEigenSolver< T >