dftfe::eigenSolverClass Class Reference

Base class for non-linear algebraic solver. More...

#include <eigenSolver.h>

Inheritance diagram for dftfe::eigenSolverClass:

Public Types
enum class	ReturnValueType { SUCCESS = 0 , FAILURE , MAX_ITER_REACHED }

Public Member Functions
virtual	~eigenSolverClass ()=0
	Destructor.
virtual void	solve (operatorDFTClass< dftfe::utils::MemorySpace::HOST > &operatorMatrix, std::vector< distributedCPUVec< double > > &eigenVectors, std::vector< double > &eigenValues, std::vector< double > &residuals)=0
	Solve eigen problem.

Protected Member Functions
	eigenSolverClass ()
	Constructor.

Detailed Description

Base class for non-linear algebraic solver.

Author

Phani Motamarri

Member Enumeration Documentation

ReturnValueType

enum class dftfe::eigenSolverClass::ReturnValueType

strong

Enumerator
SUCCESS
FAILURE
MAX_ITER_REACHED

Constructor & Destructor Documentation

~eigenSolverClass()

virtual dftfe::eigenSolverClass::~eigenSolverClass ( )

pure virtual

Destructor.

eigenSolverClass()

dftfe::eigenSolverClass::eigenSolverClass ( )

protected

Constructor.

Member Function Documentation

solve()

virtual void dftfe::eigenSolverClass::solve ( operatorDFTClass< dftfe::utils::MemorySpace::HOST > & operatorMatrix, std::vector< distributedCPUVec< double > > & eigenVectors, std::vector< double > & eigenValues, std::vector< double > & residuals )

pure virtual

Solve eigen problem.

Returns

Return value indicating success or failure.

Implemented in dftfe::chebyshevOrthogonalizedSubspaceIterationSolver.

---

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

• workspace/include/eigenSolver.h