problem.hpp
Go to the documentation of this file.
1 
5 /* Copyright (c) 2005-2010 Taneli Kalvas. All rights reserved.
6  *
7  * You can redistribute this software and/or modify it under the terms
8  * of the GNU General Public License as published by the Free Software
9  * Foundation; either version 2 of the License, or (at your option)
10  * any later version.
11  *
12  * This library is distributed in the hope that it will be useful, but
13  * WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15  * General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this library (file "COPYING" included in the package);
19  * if not, write to the Free Software Foundation, Inc., 51 Franklin
20  * Street, Fifth Floor, Boston, MA 02110-1301 USA
21  *
22  * If you have questions about your rights to use or distribute this
23  * software, please contact Berkeley Lab's Technology Transfer
24  * Department at TTD@lbl.gov. Other questions, comments and bug
25  * reports should be sent directly to the author via email at
26  * taneli.kalvas@jyu.fi.
27  *
28  * NOTICE. This software was developed under partial funding from the
29  * U.S. Department of Energy. As such, the U.S. Government has been
30  * granted for itself and others acting on its behalf a paid-up,
31  * nonexclusive, irrevocable, worldwide license in the Software to
32  * reproduce, prepare derivative works, and perform publicly and
33  * display publicly. Beginning five (5) years after the date
34  * permission to assert copyright is obtained from the U.S. Department
35  * of Energy, and subject to any subsequent five (5) year renewals,
36  * the U.S. Government is granted for itself and others acting on its
37  * behalf a paid-up, nonexclusive, irrevocable, worldwide license in
38  * the Software to reproduce, prepare derivative works, distribute
39  * copies to the public, perform publicly and display publicly, and to
40  * permit others to do so.
41  */
42 
43 #ifndef PROBLEM_HPP
44 #define PROBLEM_HPP 1
45 
46 
47 #include "crowmatrix.hpp"
48 #include "mvector.hpp"
49 
50 
54 class Problem {
55 
56 public:
57 
60  virtual ~Problem() {}
61 
65  virtual void get_vecmat( const Matrix **A, const Vector **B ) const = 0;
66 
70  virtual void get_resjac( const Matrix **J, const Vector **R, const Vector &X ) const = 0;
71 
74  virtual bool linear( void ) const = 0;
75 
76 };
77 
78 
79 #endif
80 
81 
82 
83 
84 
85 
86 
87 
88 
89 
90 
91 
92 
93 
94 
95 
96 
97 
98 
99 
Dense math vector class.
Definition: mvector.hpp:68
virtual bool linear(void) const =0
Return true if problem is linear.
Abstract base class for linear/non-linear problem, which can be described by a non-linear system of e...
Definition: problem.hpp:54
virtual ~Problem()
Virtual destructor.
Definition: problem.hpp:60
Compressed row sparse matrix algebra.
Base matrix class.
Definition: matrix.hpp:76
virtual void get_vecmat(const Matrix **A, const Vector **B) const =0
Return const pointers to the matrix A and vector B of the linear problem.
virtual void get_resjac(const Matrix **J, const Vector **R, const Vector &X) const =0
Return const pointers to jacobian matrix and residual vector of the problem to J and R at X...
N-dimensional vector.