Belos Package Browser (Single Doxygen Collection) Development
Loading...
Searching...
No Matches
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
53namespace Belos {
54
56
57
62 template <class ScalarType, class MV>
64
66 Teuchos::RCP<const MV> Y;
67
69 Teuchos::RCP<const MV> R1;
70
72 Teuchos::RCP<const MV> R2;
73
75 Teuchos::RCP<const MV> W;
76
78 Teuchos::RCP<const MV> W1;
79
81 Teuchos::RCP<const MV> W2;
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
101 class MinresIterateFailure : public BelosError {public:
102 MinresIterateFailure(const std::string& what_arg) : BelosError(what_arg)
103 {}};
104
106
107
108template<class ScalarType, class MV, class OP>
109class MinresIteration : virtual public Iteration<ScalarType,MV,OP> {
110
111 public:
112
114
115
129 virtual void initializeMinres(const MinresIterationState<ScalarType,MV> & newstate) = 0;
130
139
140};
141
142} // end Belos namespace
143
144#endif /* BELOS_MINRES_ITERATION_HPP */
Belos header file which uses auto-configuration information to include necessary C++ headers.
Pure virtual base class which describes the basic interface to the linear solver iteration.
Collection of types and exceptions used within the Belos solvers.
Parent class to all Belos exceptions.
Definition: BelosTypes.hpp:60
MinresIterateFailure is thrown when the MinresIteration object is unable to compute the next iterate ...
MinresIterateFailure(const std::string &what_arg)
virtual MinresIterationState< ScalarType, MV > getState() const =0
Get the current state of the linear solver.
virtual void initializeMinres(const MinresIterationState< ScalarType, MV > &newstate)=0
Initialize the solver to an iterate, providing a complete state.
Structure to contain pointers to MinresIteration state variables.
Teuchos::RCP< const MV > W
The current direction vector.
Teuchos::RCP< const MV > R2
Previous residual.
Teuchos::RCP< const MV > W1
Previous direction vector.
Teuchos::RCP< const MV > Y
The current residual.
Teuchos::RCP< const MV > W2
Previous direction vector.
Teuchos::RCP< const MV > R1
Previous residual.