forked from dftfeDevelopers/dftfe
-
Notifications
You must be signed in to change notification settings - Fork 0
/
eigenSolver.h
70 lines (60 loc) · 1.66 KB
/
eigenSolver.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
// ---------------------------------------------------------------------
//
// Copyright (c) 2017-2022 The Regents of the University of Michigan and DFT-FE
// authors.
//
// This file is part of the DFT-FE code.
//
// The DFT-FE code is free software; you can use it, redistribute
// it, and/or modify it under the terms of the GNU Lesser General
// Public License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
// The full text of the license can be found in the file LICENSE at
// the top level of the DFT-FE distribution.
//
// ---------------------------------------------------------------------
//
#ifndef eigenSolver_h
#define eigenSolver_h
#include "headers.h"
#include "operator.h"
namespace dftfe
{
/**
* @brief Base class for non-linear algebraic solver.
*
* @author Phani Motamarri
*/
class eigenSolverClass
{
public:
enum class ReturnValueType
{
SUCCESS = 0,
FAILURE,
MAX_ITER_REACHED
};
public:
/**
* @brief Destructor.
*/
virtual ~eigenSolverClass() = 0;
/**
* @brief Solve eigen problem.
*
* @return Return value indicating success or failure.
*/
virtual void
solve(operatorDFTClass<dftfe::utils::MemorySpace::HOST> &operatorMatrix,
std::vector<distributedCPUVec<double>> & eigenVectors,
std::vector<double> & eigenValues,
std::vector<double> & residuals) = 0;
protected:
/**
* @brief Constructor.
*
*/
eigenSolverClass();
};
} // namespace dftfe
#endif // dft_eigenSolver_h