All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Pages
LinearSolverInterface.hpp
1 /*
2  Copyright 2012 SINTEF ICT, Applied Mathematics.
3 
4  This file is part of the Open Porous Media project (OPM).
5 
6  OPM is free software: you can redistribute it and/or modify
7  it under the terms of the GNU General Public License as published by
8  the Free Software Foundation, either version 3 of the License, or
9  (at your option) any later version.
10 
11  OPM is distributed in the hope that it will be useful,
12  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  GNU General Public License for more details.
15 
16  You should have received a copy of the GNU General Public License
17  along with OPM. If not, see <http://www.gnu.org/licenses/>.
18 */
19 
20 #ifndef OPM_LINEARSOLVERINTERFACE_HEADER_INCLUDED
21 #define OPM_LINEARSOLVERINTERFACE_HEADER_INCLUDED
22 
23 #include<boost/any.hpp>
24 
25 struct CSRMatrix;
26 
27 namespace Opm
28 {
29 
30 
33  {
34  public:
36  virtual ~LinearSolverInterface();
37 
42  {
43  bool converged;
44  int iterations;
45  double residual_reduction;
46  };
47 
55  const double* rhs,
56  double* solution) const;
57 
67  virtual LinearSolverReport solve(const int size,
68  const int nonzeros,
69  const int* ia,
70  const int* ja,
71  const double* sa,
72  const double* rhs,
73  double* solution,
74  const boost::any& add=boost::any()) const = 0;
75 
78  virtual void setTolerance(const double tol) = 0;
79 
82  virtual double getTolerance() const = 0;
83 
84  };
85 
86 
87 } // namespace Opm
88 
89 
90 
91 #endif // OPM_LINEARSOLVERINTERFACE_HEADER_INCLUDED
Basic compressed-sparse row (CSR) matrix data structure.
Definition: sparse_sys.h:38
Struct for reporting data about the solution process back to the caller.
Definition: LinearSolverInterface.hpp:41
virtual double getTolerance() const =0
Get tolerance for the linear solver.
Abstract interface for linear solvers.
Definition: LinearSolverInterface.hpp:32
virtual void setTolerance(const double tol)=0
Set tolerance for the linear solver.
LinearSolverReport solve(const CSRMatrix *A, const double *rhs, double *solution) const
Solve a linear system, with a matrix given in compressed sparse row format.
Definition: LinearSolverInterface.cpp:37
virtual ~LinearSolverInterface()
Virtual destructor.
Definition: LinearSolverInterface.cpp:29