Belos  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
BelosFixedPointIteration.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_FIXEDPOINT_ITERATION_HPP
43 #define BELOS_FIXEDPOINT_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 
67 
70 
71  FixedPointIterationState() : R(Teuchos::null), Z(Teuchos::null)
72  {}
73  };
74 
76 
77 
90  FixedPointIterationInitFailure(const std::string& what_arg) : BelosError(what_arg)
91  {}};
92 
99  class FixedPointIterateFailure : public BelosError {public:
100  FixedPointIterateFailure(const std::string& what_arg) : BelosError(what_arg)
101  {}};
102 
110  FixedPointIterationOrthoFailure(const std::string& what_arg) : BelosError(what_arg)
111  {}};
112 
120  FixedPointIterationLAPACKFailure(const std::string& what_arg) : BelosError(what_arg)
121  {}};
122 
124 
125 
126 template<class ScalarType, class MV, class OP>
127 class FixedPointIteration : virtual public Iteration<ScalarType,MV,OP> {
128 
129  public:
130 
132 
133 
147 
156 
157 };
158 
159 } // end Belos namespace
160 
161 #endif /* BELOS_FIXEDPOINT_ITERATION_HPP */
Collection of types and exceptions used within the Belos solvers.
FixedPointIterationInitFailure is thrown when the FixedPointIteration object is unable to generate an...
FixedPointIterationOrthoFailure is thrown when the FixedPointIteration object is unable to compute in...
FixedPointIterateFailure(const std::string &what_arg)
Pure virtual base class which describes the basic interface to the linear solver iteration.
virtual FixedPointIterationState< ScalarType, MV > getState() const =0
Get the current state of the linear solver.
FixedPointIterateFailure is thrown when the FixedPointIteration object is unable to compute the next ...
FixedPointIterationLAPACKFailure(const std::string &what_arg)
Teuchos::RCP< const MV > R
The current residual.
virtual void initializeFixedPoint(FixedPointIterationState< ScalarType, MV > &newstate)=0
Initialize the solver to an iterate, providing a complete state.
Structure to contain pointers to FixedPointIteration state variables.
FixedPointIterationOrthoFailure(const std::string &what_arg)
FixedPointIterationInitFailure(const std::string &what_arg)
Teuchos::RCP< const MV > Z
The current preconditioned residual.
Parent class to all Belos exceptions.
Definition: BelosTypes.hpp:60
FixedPointIterationLAPACKFailure is thrown when a nonzero return value is passed back from an LAPACK ...
Belos header file which uses auto-configuration information to include necessary C++ headers...

Generated on Fri Aug 14 2020 10:48:33 for Belos by doxygen 1.8.5