Belos Package Browser (Single Doxygen Collection) Development
Loading...
Searching...
No Matches
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
53namespace 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 CGPositiveDefiniteFailure(const std::string& what_arg) : CGIterateFailure(what_arg)
117 {}};
118
125 class CGIterationOrthoFailure : public BelosError {public:
126 CGIterationOrthoFailure(const std::string& what_arg) : BelosError(what_arg)
127 {}};
128
135 class CGIterationLAPACKFailure : public BelosError {public:
136 CGIterationLAPACKFailure(const std::string& what_arg) : BelosError(what_arg)
137 {}};
138
140
141
142template<class ScalarType, class MV, class OP>
143class CGIteration : virtual public Iteration<ScalarType,MV,OP> {
144
145 public:
146
148
149
164
173
174
176 virtual void setDoCondEst(bool val) = 0;
177
179 virtual Teuchos::ArrayView<typename Teuchos::ScalarTraits<ScalarType>::magnitudeType> getDiag() = 0;
180
182 virtual Teuchos::ArrayView<typename Teuchos::ScalarTraits<ScalarType>::magnitudeType> getOffDiag() = 0;
183
184};
185
186} // end Belos namespace
187
188#endif /* BELOS_CG_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
CGIterateFailure is thrown when the CGIteration object is unable to compute the next iterate in the C...
CGIterateFailure(const std::string &what_arg)
CGIterationInitFailure is thrown when the CGIteration object is unable to generate an initial iterate...
CGIterationInitFailure(const std::string &what_arg)
CGIterationLAPACKFailure is thrown when a nonzero return value is passed back from an LAPACK routine.
CGIterationLAPACKFailure(const std::string &what_arg)
CGIterationOrthoFailure is thrown when the CGIteration object is unable to compute independent direct...
CGIterationOrthoFailure(const std::string &what_arg)
virtual Teuchos::ArrayView< typename Teuchos::ScalarTraits< ScalarType >::magnitudeType > getOffDiag()=0
Gets the off-diagonal for condition estimation.
virtual void setDoCondEst(bool val)=0
Sets whether or not to store the diagonal for condition estimation.
virtual void initializeCG(CGIterationState< ScalarType, MV > &newstate)=0
Initialize the solver to an iterate, providing a complete state.
virtual CGIterationState< ScalarType, MV > getState() const =0
Get the current state of the linear solver.
virtual Teuchos::ArrayView< typename Teuchos::ScalarTraits< ScalarType >::magnitudeType > getDiag()=0
Gets the diagonal for condition estimation.
CGPositiveDefiniteFailure is thrown when the the CG 'alpha = p^H*A*P' value is less than zero,...
CGPositiveDefiniteFailure(const std::string &what_arg)
Structure to contain pointers to CGIteration state variables.
Teuchos::RCP< const MV > P
The current decent direction vector.
Teuchos::RCP< const MV > R
The current residual.
Teuchos::RCP< const MV > Z
The current preconditioned residual.
Teuchos::RCP< const MV > AP
The matrix A applied to current decent direction vector.