Spectra::SearchSpace< Scalar > Class Template Reference

#include <RitzPairs.h>

Public Member Functions
const Matrix &	basis_vectors () const
	Returns the basis vectors. More...
void	extend_basis (const Matrix &new_vect)
void	initialize_search_space (const Eigen::Ref< const Matrix > &initial_vectors)
const Matrix &	operator_basis_product () const
	Returns the operator applied to basis vector. More...
void	restart (const RitzPairs< Scalar > &ritz_pairs, Index size)
	SearchSpace ()=default
Index	size () const
	Returns the current size of the search space. More...
template<typename OpType >
void	update_operator_basis_product (OpType &op)

Private Types
using	Index = Eigen::Index
using	Matrix = Eigen::Matrix< Scalar, Eigen::Dynamic, Eigen::Dynamic >

Private Member Functions
void	append_new_vectors_to_basis (const Matrix &new_vect)

Private Attributes
Matrix	m_basis_vectors
Matrix	m_op_basis_product

Detailed Description

template<typename Scalar>
class Spectra::SearchSpace< Scalar >

This class handles the creation and manipulation of the search space for iterative eigensolvers such as Davidson, Jacobi-Davidson, etc.

Definition at line 18 of file RitzPairs.h.

Member Typedef Documentation

Index

template<typename Scalar >

using Spectra::SearchSpace< Scalar >::Index = Eigen::Index

private

Definition at line 23 of file SearchSpace.h.

Matrix

template<typename Scalar >

using Spectra::SearchSpace< Scalar >::Matrix = Eigen::Matrix<Scalar, Eigen::Dynamic, Eigen::Dynamic>

private

Definition at line 24 of file SearchSpace.h.

Constructor & Destructor Documentation

SearchSpace()

template<typename Scalar >

Spectra::SearchSpace< Scalar >::SearchSpace ( )

default

Member Function Documentation

append_new_vectors_to_basis()

template<typename Scalar >

void Spectra::SearchSpace< Scalar >::append_new_vectors_to_basis ( const Matrix &  new_vect )

inlineprivate

Append new vector to the basis

Parameters

new_vect

Matrix of new correction vectors

Definition at line 32 of file SearchSpace.h.

basis_vectors()

template<typename Scalar >

const Matrix& Spectra::SearchSpace< Scalar >::basis_vectors ( ) const

inline

Returns the basis vectors.

Definition at line 88 of file SearchSpace.h.

extend_basis()

template<typename Scalar >

void Spectra::SearchSpace< Scalar >::extend_basis ( const Matrix &  new_vect )

inline

Append new vectors to the search space and orthogonalize the resulting matrix

Parameters

new_vect

Matrix of new correction vectors

Definition at line 80 of file SearchSpace.h.

initialize_search_space()

template<typename Scalar >

void Spectra::SearchSpace< Scalar >::initialize_search_space ( const Eigen::Ref< const Matrix > &  initial_vectors )

inline

Definition at line 45 of file SearchSpace.h.

operator_basis_product()

template<typename Scalar >

const Matrix& Spectra::SearchSpace< Scalar >::operator_basis_product ( ) const

inline

Returns the operator applied to basis vector.

Definition at line 91 of file SearchSpace.h.

restart()

template<typename Scalar >

void Spectra::SearchSpace< Scalar >::restart ( const RitzPairs< Scalar > &  ritz_pairs, Index  size  )

inline

Restart the search space by reducing the basis vector to the last Ritz eigenvector

Parameters

ritz_pair	Instance of a RitzPair class
size	Size of the restart

Definition at line 70 of file SearchSpace.h.

size()

template<typename Scalar >

Index Spectra::SearchSpace< Scalar >::size ( ) const

inline

Returns the current size of the search space.

Definition at line 43 of file SearchSpace.h.

update_operator_basis_product()

template<typename Scalar >

template<typename OpType >

void Spectra::SearchSpace< Scalar >::update_operator_basis_product ( OpType &  op )

inline

Updates the matrix formed by the operator applied to the search space after the addition of new vectors in the search space. Only the product of the operator with the new vectors is computed and the result is appended to the op_basis_product member variable

Parameters

OpType

Operator representing the matrix

Definition at line 58 of file SearchSpace.h.

Member Data Documentation

m_basis_vectors

template<typename Scalar >

Matrix Spectra::SearchSpace< Scalar >::m_basis_vectors

private

Definition at line 26 of file SearchSpace.h.

m_op_basis_product

template<typename Scalar >

Matrix Spectra::SearchSpace< Scalar >::m_op_basis_product

private

Definition at line 27 of file SearchSpace.h.

---

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

• RitzPairs.h
• SearchSpace.h