A derived class of OperatorContext to encapsulate the action of a discrete operator on vectors, matrices, etc. More...

#include <ChebyshevFilteredEigenSolver.h>

Inheritance diagram for dftefe::linearAlgebra::ChebyshevFilteredEigenSolver< ValueTypeOperator, ValueTypeOperand, memorySpace >:

[legend]

Collaboration diagram for dftefe::linearAlgebra::ChebyshevFilteredEigenSolver< ValueTypeOperator, ValueTypeOperand, memorySpace >:

[legend]

Public Types
using	ValueType = blasLapack::scalar_type< ValueTypeOperator, ValueTypeOperand >
	define ValueType as the superior (bigger set) of the ValueTypeOperator and ValueTypeOperand (e.g., between double and complex<double>, complex<double> is the bigger set) More...

using	RealType = blasLapack::real_type< ValueType >

using	OpContext = typename HermitianIterativeEigenSolver< ValueTypeOperator, ValueTypeOperand, memorySpace >::OpContext

Public Member Functions
	ChebyshevFilteredEigenSolver (const double wantedSpectrumLowerBound, const double wantedSpectrumUpperBound, const double unWantedSpectrumUpperBound, const double polynomialDegree, const double illConditionTolerance, MultiVector< ValueTypeOperand, memorySpace > &eigenSubspaceGuess, const size_type eigenVectorBlockSize=0)
	Constructor. More...

	~ChebyshevFilteredEigenSolver ()=default
	Destructor. More...

void	reinit (const double wantedSpectrumLowerBound, const double wantedSpectrumUpperBound, const double unWantedSpectrumUpperBound, const double polynomialDegree, const double illConditionTolerance, MultiVector< ValueTypeOperand, memorySpace > &eigenSubspaceGuess, const size_type eigenVectorBlockSize)

EigenSolverError	solve (const OpContext &A, std::vector< RealType > &eigenValues, MultiVector< ValueType, memorySpace > &eigenVectors, bool computeEigenVectors=false, const OpContext &B=IdentityOperatorContext< ValueTypeOperator, ValueTypeOperand, memorySpace >(), const OpContext &BInv=IdentityOperatorContext< ValueTypeOperator, ValueTypeOperand, memorySpace >()) override

MultiVector< ValueType, memorySpace > &	getFilteredSubspace ()

MultiVector< ValueType, memorySpace > &	getOrthogonalizedFilteredSubspace ()

Private Attributes
double	d_wantedSpectrumLowerBound

double	d_wantedSpectrumUpperBound

double	d_unWantedSpectrumUpperBound

double	d_polynomialDegree

double	d_illConditionTolerance

MultiVector< ValueTypeOperand, memorySpace > *	d_eigenSubspaceGuess

size_type	d_eigenVectorBlockSize

std::shared_ptr< MultiVector< ValueType, memorySpace > >	d_filteredSubspaceOrtho

std::shared_ptr< MultiVector< ValueType, memorySpace > >	d_filteredSubspace

std::shared_ptr< RayleighRitzEigenSolver< ValueTypeOperator, ValueType, memorySpace > >	d_rr

Detailed Description

template<typename ValueTypeOperator, typename ValueTypeOperand, utils::MemorySpace memorySpace>
class dftefe::linearAlgebra::ChebyshevFilteredEigenSolver< ValueTypeOperator, ValueTypeOperand, memorySpace >

A derived class of OperatorContext to encapsulate the action of a discrete operator on vectors, matrices, etc.

Template Parameters

ValueTypeOperator	The datatype (float, double, complex<double>, etc.) for the underlying operator
ValueTypeOperand	The datatype (float, double, complex<double>, etc.) of the vector, matrices, etc. on which the operator will act
memorySpace	The meory sapce (HOST, DEVICE, HOST_PINNED, etc.) in which the data of the operator and its operands reside

Member Typedef Documentation

◆ OpContext

template<typename ValueTypeOperator , typename ValueTypeOperand , utils::MemorySpace memorySpace>

using dftefe::linearAlgebra::ChebyshevFilteredEigenSolver< ValueTypeOperator, ValueTypeOperand, memorySpace >::OpContext = typename HermitianIterativeEigenSolver<ValueTypeOperator, ValueTypeOperand, memorySpace>::OpContext

◆ RealType

template<typename ValueTypeOperator , typename ValueTypeOperand , utils::MemorySpace memorySpace>

using dftefe::linearAlgebra::ChebyshevFilteredEigenSolver< ValueTypeOperator, ValueTypeOperand, memorySpace >::RealType = blasLapack::real_type<ValueType>

◆ ValueType

template<typename ValueTypeOperator , typename ValueTypeOperand , utils::MemorySpace memorySpace>

using dftefe::linearAlgebra::ChebyshevFilteredEigenSolver< ValueTypeOperator, ValueTypeOperand, memorySpace >::ValueType = blasLapack::scalar_type<ValueTypeOperator, ValueTypeOperand>

define ValueType as the superior (bigger set) of the ValueTypeOperator and ValueTypeOperand (e.g., between double and complex<double>, complex<double> is the bigger set)

Constructor & Destructor Documentation

◆ ChebyshevFilteredEigenSolver()

template<typename ValueTypeOperator , typename ValueTypeOperand , utils::MemorySpace memorySpace>

dftefe::linearAlgebra::ChebyshevFilteredEigenSolver< ValueTypeOperator, ValueTypeOperand, memorySpace >::ChebyshevFilteredEigenSolver	(	const double	wantedSpectrumLowerBound,
		const double	wantedSpectrumUpperBound,
		const double	unWantedSpectrumUpperBound,
		const double	polynomialDegree,
		const double	illConditionTolerance,
		MultiVector< ValueTypeOperand, memorySpace > &	eigenSubspaceGuess,
		const size_type	eigenVectorBlockSize = `0`
	)

Constructor.

◆ ~ChebyshevFilteredEigenSolver()

template<typename ValueTypeOperator , typename ValueTypeOperand , utils::MemorySpace memorySpace>

dftefe::linearAlgebra::ChebyshevFilteredEigenSolver< ValueTypeOperator, ValueTypeOperand, memorySpace >::~ChebyshevFilteredEigenSolver ( )

default

Destructor.

Member Function Documentation

◆ getFilteredSubspace()

template<typename ValueTypeOperator , typename ValueTypeOperand , utils::MemorySpace memorySpace>

MultiVector< blasLapack::scalar_type< ValueTypeOperator, ValueTypeOperand >, memorySpace > & dftefe::linearAlgebra::ChebyshevFilteredEigenSolver< ValueTypeOperator, ValueTypeOperand, memorySpace >::getFilteredSubspace

◆ getOrthogonalizedFilteredSubspace()

template<typename ValueTypeOperator , typename ValueTypeOperand , utils::MemorySpace memorySpace>

MultiVector< blasLapack::scalar_type< ValueTypeOperator, ValueTypeOperand >, memorySpace > & dftefe::linearAlgebra::ChebyshevFilteredEigenSolver< ValueTypeOperator, ValueTypeOperand, memorySpace >::getOrthogonalizedFilteredSubspace

◆ reinit()

template<typename ValueTypeOperator , typename ValueTypeOperand , utils::MemorySpace memorySpace>

void dftefe::linearAlgebra::ChebyshevFilteredEigenSolver< ValueTypeOperator, ValueTypeOperand, memorySpace >::reinit	(	const double	wantedSpectrumLowerBound,
		const double	wantedSpectrumUpperBound,
		const double	unWantedSpectrumUpperBound,
		const double	polynomialDegree,
		const double	illConditionTolerance,
		MultiVector< ValueTypeOperand, memorySpace > &	eigenSubspaceGuess,
		const size_type	eigenVectorBlockSize
	)

◆ solve()

template<typename ValueTypeOperator , typename ValueTypeOperand , utils::MemorySpace memorySpace>

EigenSolverError dftefe::linearAlgebra::ChebyshevFilteredEigenSolver< ValueTypeOperator, ValueTypeOperand, memorySpace >::solve	(	const OpContext &	A,
		std::vector< RealType > &	eigenValues,
		MultiVector< ValueType, memorySpace > &	eigenVectors,
		bool	computeEigenVectors = `false`,
		const OpContext &	B = `IdentityOperatorContext<ValueTypeOperator, ValueTypeOperand, memorySpace>()`,
		const OpContext &	BInv = `IdentityOperatorContext<ValueTypeOperator, ValueTypeOperand, memorySpace>()`
	)

override

Here is the call graph for this function:

Member Data Documentation

◆ d_eigenSubspaceGuess

template<typename ValueTypeOperator , typename ValueTypeOperand , utils::MemorySpace memorySpace>

MultiVector<ValueTypeOperand, memorySpace>* dftefe::linearAlgebra::ChebyshevFilteredEigenSolver< ValueTypeOperator, ValueTypeOperand, memorySpace >::d_eigenSubspaceGuess

private

◆ d_eigenVectorBlockSize

template<typename ValueTypeOperator , typename ValueTypeOperand , utils::MemorySpace memorySpace>

size_type dftefe::linearAlgebra::ChebyshevFilteredEigenSolver< ValueTypeOperator, ValueTypeOperand, memorySpace >::d_eigenVectorBlockSize

private

◆ d_filteredSubspace

template<typename ValueTypeOperator , typename ValueTypeOperand , utils::MemorySpace memorySpace>

std::shared_ptr<MultiVector<ValueType, memorySpace> > dftefe::linearAlgebra::ChebyshevFilteredEigenSolver< ValueTypeOperator, ValueTypeOperand, memorySpace >::d_filteredSubspace

private

◆ d_filteredSubspaceOrtho

template<typename ValueTypeOperator , typename ValueTypeOperand , utils::MemorySpace memorySpace>

std::shared_ptr<MultiVector<ValueType, memorySpace> > dftefe::linearAlgebra::ChebyshevFilteredEigenSolver< ValueTypeOperator, ValueTypeOperand, memorySpace >::d_filteredSubspaceOrtho

private

◆ d_illConditionTolerance

template<typename ValueTypeOperator , typename ValueTypeOperand , utils::MemorySpace memorySpace>

double dftefe::linearAlgebra::ChebyshevFilteredEigenSolver< ValueTypeOperator, ValueTypeOperand, memorySpace >::d_illConditionTolerance

private

◆ d_polynomialDegree

template<typename ValueTypeOperator , typename ValueTypeOperand , utils::MemorySpace memorySpace>

double dftefe::linearAlgebra::ChebyshevFilteredEigenSolver< ValueTypeOperator, ValueTypeOperand, memorySpace >::d_polynomialDegree

private

◆ d_rr

template<typename ValueTypeOperator , typename ValueTypeOperand , utils::MemorySpace memorySpace>

std::shared_ptr< RayleighRitzEigenSolver<ValueTypeOperator, ValueType, memorySpace> > dftefe::linearAlgebra::ChebyshevFilteredEigenSolver< ValueTypeOperator, ValueTypeOperand, memorySpace >::d_rr

private

◆ d_unWantedSpectrumUpperBound

template<typename ValueTypeOperator , typename ValueTypeOperand , utils::MemorySpace memorySpace>

double dftefe::linearAlgebra::ChebyshevFilteredEigenSolver< ValueTypeOperator, ValueTypeOperand, memorySpace >::d_unWantedSpectrumUpperBound

private

◆ d_wantedSpectrumLowerBound

template<typename ValueTypeOperator , typename ValueTypeOperand , utils::MemorySpace memorySpace>

double dftefe::linearAlgebra::ChebyshevFilteredEigenSolver< ValueTypeOperator, ValueTypeOperand, memorySpace >::d_wantedSpectrumLowerBound

private

◆ d_wantedSpectrumUpperBound

template<typename ValueTypeOperator , typename ValueTypeOperand , utils::MemorySpace memorySpace>

double dftefe::linearAlgebra::ChebyshevFilteredEigenSolver< ValueTypeOperator, ValueTypeOperand, memorySpace >::d_wantedSpectrumUpperBound

private

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

src/linearAlgebra/ChebyshevFilteredEigenSolver.h
src/linearAlgebra/ChebyshevFilteredEigenSolver.t.cpp

Public Types

Public Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ OpContext

◆ RealType

◆ ValueType

Constructor & Destructor Documentation

◆ ChebyshevFilteredEigenSolver()

◆ ~ChebyshevFilteredEigenSolver()

Member Function Documentation

◆ getFilteredSubspace()

◆ getOrthogonalizedFilteredSubspace()

◆ reinit()

◆ solve()

Member Data Documentation

◆ d_eigenSubspaceGuess

◆ d_eigenVectorBlockSize

◆ d_filteredSubspace

◆ d_filteredSubspaceOrtho

◆ d_illConditionTolerance

◆ d_polynomialDegree

◆ d_rr

◆ d_unWantedSpectrumUpperBound

◆ d_wantedSpectrumLowerBound

◆ d_wantedSpectrumUpperBound