Belos Package Browser (Single Doxygen Collection)  Development
BelosCGIteration.hpp
Go to the documentation of this file.
1 //@HEADER
2 // ************************************************************************
3 //
4 // Belos: Block Linear Solvers Package
5 // Copyright 2004 Sandia Corporation
6 //
7 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
8 // the U.S. Government retains certain rights in this software.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
38 //
39 // ************************************************************************
40 //@HEADER
41 
42 #ifndef BELOS_CG_ITERATION_HPP
43 #define BELOS_CG_ITERATION_HPP
44 
49 #include "BelosConfigDefs.hpp"
50 #include "BelosTypes.hpp"
51 #include "BelosIteration.hpp"
52 
53 namespace Belos {
54 
56 
57 
62  template <class ScalarType, class MV>
64 
66  Teuchos::RCP<const MV> R;
67 
69  Teuchos::RCP<const MV> Z;
70 
72  Teuchos::RCP<const MV> P;
73 
75  Teuchos::RCP<const MV> AP;
76 
77  CGIterationState() : R(Teuchos::null), Z(Teuchos::null),
78  P(Teuchos::null), AP(Teuchos::null)
79  {}
80  };
81 
83 
84 
96  class CGIterationInitFailure : public BelosError {public:
97  CGIterationInitFailure(const std::string& what_arg) : BelosError(what_arg)
98  {}};
99 
106  class CGIterateFailure : public BelosError {public:
107  CGIterateFailure(const std::string& what_arg) : BelosError(what_arg)
108  {}};
109 
116  class CGIterationOrthoFailure : public BelosError {public:
117  CGIterationOrthoFailure(const std::string& what_arg) : BelosError(what_arg)
118  {}};
119 
126  class CGIterationLAPACKFailure : public BelosError {public:
127  CGIterationLAPACKFailure(const std::string& what_arg) : BelosError(what_arg)
128  {}};
129 
131 
132 
133 template<class ScalarType, class MV, class OP>
134 class CGIteration : virtual public Iteration<ScalarType,MV,OP> {
135 
136  public:
137 
139 
140 
154  virtual void initializeCG(CGIterationState<ScalarType,MV>& newstate) = 0;
155 
162  virtual CGIterationState<ScalarType,MV> getState() const = 0;
164 
165 };
166 
167 } // end Belos namespace
168 
169 #endif /* BELOS_CG_ITERATION_HPP */
Teuchos::RCP< const MV > R
The current residual.
Collection of types and exceptions used within the Belos solvers.
CGIterateFailure(const std::string &what_arg)
CGIterationOrthoFailure(const std::string &what_arg)
virtual void initializeCG(CGIterationState< ScalarType, MV > &newstate)=0
Initialize the solver to an iterate, providing a complete state.
Structure to contain pointers to CGIteration state variables.
Pure virtual base class which describes the basic interface to the linear solver iteration.
CGIterateFailure is thrown when the CGIteration object is unable to compute the next iterate in the C...
Teuchos::RCP< const MV > AP
The matrix A applied to current decent direction vector.
CGIterationLAPACKFailure is thrown when a nonzero return value is passed back from an LAPACK routine...
Teuchos::RCP< const MV > Z
The current preconditioned residual.
CGIterationOrthoFailure is thrown when the CGIteration object is unable to compute independent direct...
CGIterationLAPACKFailure(const std::string &what_arg)
CGIterationInitFailure is thrown when the CGIteration object is unable to generate an initial iterate...
Parent class to all Belos exceptions.
Definition: BelosTypes.hpp:60
virtual CGIterationState< ScalarType, MV > getState() const =0
Get the current state of the linear solver.
Belos header file which uses auto-configuration information to include necessary C++ headers...
CGIterationInitFailure(const std::string &what_arg)
Teuchos::RCP< const MV > P
The current decent direction vector.