Belos  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
BelosMinresIteration.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_MINRES_ITERATION_HPP
43 #define BELOS_MINRES_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 
73 
76 
79 
82 
83  MinresIterationState() : Y(Teuchos::null),
84  R1(Teuchos::null),
85  R2(Teuchos::null),
86  W(Teuchos::null),
87  W1(Teuchos::null),
88  W2(Teuchos::null)
89  {}
90  };
91 
93 
94 
106  class MinresIterationInitFailure : public BelosError {public:
107  MinresIterationInitFailure(const std::string& what_arg) : BelosError(what_arg)
108  {}};
109 
116  class MinresIterateFailure : public BelosError {public:
117  MinresIterateFailure(const std::string& what_arg) : BelosError(what_arg)
118  {}};
119 
126  class MinresIterationOrthoFailure : public BelosError {public:
127  MinresIterationOrthoFailure(const std::string& what_arg) : BelosError(what_arg)
128  {}};
129 
136  class MinresIterationLAPACKFailure : public BelosError {public:
137  MinresIterationLAPACKFailure(const std::string& what_arg) : BelosError(what_arg)
138  {}};
139 
141 
142 
143 template<class ScalarType, class MV, class OP>
144 class MinresIteration : virtual public Iteration<ScalarType,MV,OP> {
145 
146  public:
147 
149 
150 
164  virtual void initializeMinres(const MinresIterationState<ScalarType,MV> & newstate) = 0;
165 
172  virtual MinresIterationState<ScalarType,MV> getState() const = 0;
174 
175 };
176 
177 } // end Belos namespace
178 
179 #endif /* BELOS_MINRES_ITERATION_HPP */
Teuchos::RCP< const MV > R1
Previous residual.
Collection of types and exceptions used within the Belos solvers.
virtual void initializeMinres(const MinresIterationState< ScalarType, MV > &newstate)=0
Initialize the solver to an iterate, providing a complete state.
MinresIterationLAPACKFailure is thrown when a nonzero return value is passed back from an LAPACK rout...
Pure virtual base class which describes the basic interface to the linear solver iteration.
Teuchos::RCP< const MV > R2
Previous residual.
MinresIterateFailure is thrown when the MinresIteration object is unable to compute the next iterate ...
Structure to contain pointers to MinresIteration state variables.
MinresIterationOrthoFailure is thrown when the MinresIteration object is unable to compute independen...
Teuchos::RCP< const MV > W2
Previous direction vector.
MinresIterationInitFailure is thrown when the MinresIteration object is unable to generate an initial...
virtual MinresIterationState< ScalarType, MV > getState() const =0
Get the current state of the linear solver.
Teuchos::RCP< const MV > Y
The current residual.
MinresIterationOrthoFailure(const std::string &what_arg)
Parent class to all Belos exceptions.
Definition: BelosTypes.hpp:60
Belos header file which uses auto-configuration information to include necessary C++ headers...
Teuchos::RCP< const MV > W1
Previous direction vector.
MinresIterateFailure(const std::string &what_arg)
MinresIterationLAPACKFailure(const std::string &what_arg)
Teuchos::RCP< const MV > W
The current direction vector.
MinresIterationInitFailure(const std::string &what_arg)

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