gs_solver.hpp
Go to the documentation of this file.
1 
5 /* Copyright (c) 2005-2011 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 GS_SOLVER_HPP
44 #define GS_SOLVER_HPP 1
45 
46 
47 #include <iostream>
48 #include "solver.hpp"
49 #include "geometry.hpp"
50 #include "problem.hpp"
51 #include "matrix.hpp"
52 #include "crowmatrix.hpp"
53 #include "mvector.hpp"
54 
55 
68 class GSSolver : public Solver {
69  double _eps;
70  uint32_t _imax;
71  double _w;
72 
73  double _newton_Reps;
74  double _newton_dXeps;
75  double _newton_imax;
77  static void gauss_seidel_error( const std::string func, int status );
78 
79 public:
80 
83  GSSolver( double w = 1.66,
84  double eps = 1.0e-6,
85  uint32_t imax = 10000,
86  double newton_Reps = 1.0e-5,
87  double newton_dXeps = 1.0e-6,
88  uint32_t newton_imax = 10 );
89 
92  ~GSSolver() {}
93 
97  virtual void solve( const Problem &p, Vector &X );
98 
105  virtual void reset( void );
106 
109  void set_newton_imax( uint32_t newton_imax ) {
110  _newton_imax = newton_imax;
111  }
112 
115  void set_newton_residual_eps( double newton_Reps ) {
116  _newton_Reps = newton_Reps;
117  }
118 
121  void set_newton_step_eps( double newton_dXeps ) {
122  _newton_dXeps = newton_dXeps;
123  }
124 
131  static bool gauss_seidel( const CRowMatrix &mat, const Vector &rhs, Vector &sol,
132  uint32_t &imax, double &eps, double w );
133 };
134 
135 
136 #endif
137 
138 
139 
140 
141 
142 
Base for solvers.
Geometry definition
Compressed row sparse matrix class.
Definition: crowmatrix.hpp:76
Basis for matrix implementations.
Base for problems.
Dense math vector class.
Definition: mvector.hpp:68
Abstract base class for linear/non-linear problem, which can be described by a non-linear system of e...
Definition: problem.hpp:54
void set_newton_imax(uint32_t newton_imax)
Sets maximum iteration count for Newton-Raphson steps.
Definition: gs_solver.hpp:109
Compressed row sparse matrix algebra.
Gauss-Seidel based solver implementation.
Definition: gs_solver.hpp:68
static bool gauss_seidel(const CRowMatrix &mat, const Vector &rhs, Vector &sol, uint32_t &imax, double &eps, double w)
Direct interface to gauss_seidel matrix solver.
void set_newton_residual_eps(double newton_Reps)
Sets the accuracy request for Newton-Raphson residual.
Definition: gs_solver.hpp:115
void set_newton_step_eps(double newton_dXeps)
Sets the accuracy request for Newton-Raphson step size.
Definition: gs_solver.hpp:121
Abstract base class for solving linear and nonlinear problems. Different implementation may exist...
Definition: solver.hpp:57
virtual void solve(const Problem &p, Vector &X)
Solve problem p defined in geometry g. Initial guess and solution are in vector X.
~GSSolver()
Destructor.
Definition: gs_solver.hpp:92
virtual void reset(void)
Reset solver.
N-dimensional vector.
GSSolver(double w=1.66, double eps=1.0e-6, uint32_t imax=10000, double newton_Reps=1.0e-5, double newton_dXeps=1.0e-6, uint32_t newton_imax=10)
Constructor.