Navigation

Main Page
Download
Support
Installation
Tutorial
Examples
Reference Manual
   Version 1.0.5new_solver
      Class Index
      File List
   Version 1.0.5dev
   Version 1.0.5b
   Version 1.0.4dev
   Version 1.0.4
Publications


Hosted by Get Ion Beam Simulator at SourceForge.net. Fast, secure and Free Open Source software downloads
diag_precond.hpp
Go to the documentation of this file.
1 
5 /* Copyright (c) 2005-2010,2012 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 DIAG_PRECOND_HPP
44 #define DIAG_PRECOND_HPP 1
45 
46 
47 #include "crowmatrix.hpp"
48 #include "precond.hpp"
49 
50 
53 class Diag_Precond : public Precond {
54 
55  Vector diag;
56 
57  Diag_Precond( const Diag_Precond &pc ) {}
58  const Diag_Precond &operator=( const Diag_Precond &pc ) { return( *this ); }
59 
60 public:
61 
64  Diag_Precond();
65 
69 
74  Diag_Precond *copy( void ) const { return( new Diag_Precond( *this ) ); }
75 
79  void prepare( const CRowMatrix &A );
80 
83  void construct( const CRowMatrix &A );
84 
90  void clear( void );
91 
96  bool is_prepared( void ) const { return( true ); }
97 
100  std::string typestring( void ) const;
101 
104  void solve( Vector &x, const Vector &b ) const;
105 };
106 
107 
108 #endif
Compressed row sparse matrix class.
Definition: crowmatrix.hpp:76
Diag_Precond()
Constructor for a diagonal preconditioner.
Definition: diag_precond.cpp:53
Dense math vector class.
Definition: mvector.hpp:71
void prepare(const CRowMatrix &A)
Prepare preconditioner for matrices with non-zero pattern equal to A.
Definition: diag_precond.cpp:58
Abstract base preconditioner class.
Definition: precond.hpp:59
Diagonal preconditioner class.
Definition: diag_precond.hpp:53
Compressed row sparse matrix algebra.
std::string typestring(void) const
Return string indicating type of preconditioner.
Definition: diag_precond.cpp:47
~Diag_Precond()
Destructor.
Definition: diag_precond.hpp:68
bool is_prepared(void) const
Return false if prepare is needed.
Definition: diag_precond.hpp:96
Diag_Precond * copy(void) const
Get a new copy of preconditiner.
Definition: diag_precond.hpp:74
void solve(Vector &x, const Vector &b) const
Solve M* x = b and return x.
Definition: diag_precond.cpp:85
void clear(void)
Clear preconditioner.
Definition: diag_precond.cpp:79
void construct(const CRowMatrix &A)
Construct preconditioner for matrix A.
Definition: diag_precond.cpp:64
Base class for preconditioners.


Reference manual for Ion Beam Simulator 1.0.5new_solver
Generated by Doxygen 1.8.5 on Tue May 19 2015 09:15:42.