Belos Package Browser (Single Doxygen Collection) Development
Loading...
Searching...
No Matches
BelosOrthoManager.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
46#ifndef BELOS_ORTHOMANAGER_HPP
47#define BELOS_ORTHOMANAGER_HPP
48
67#include "BelosConfigDefs.hpp"
68#include "BelosTypes.hpp"
69#include "Teuchos_ScalarTraits.hpp"
70#include "Teuchos_RCP.hpp"
71#include "Teuchos_SerialDenseMatrix.hpp"
72#include "Teuchos_Array.hpp"
73
74
75namespace Belos {
76
77
79
80
83 class OrthoError : public BelosError
84 {public: OrthoError(const std::string& what_arg) : BelosError(what_arg) {}};
85
87
88 template <class ScalarType, class MV>
89 class OrthoManager :
90 public Teuchos::ParameterListAcceptorDefaultBase
91 {
92 public:
94
95
97
99 virtual ~OrthoManager() {};
101
103
104
113 virtual void innerProd( const MV &X, const MV &Y, Teuchos::SerialDenseMatrix<int,ScalarType>& Z ) const = 0;
114
115
128 virtual void norm (const MV& X, std::vector<typename Teuchos::ScalarTraits<ScalarType>::magnitudeType>& normvec) const = 0;
129
164 virtual void
165 project (MV &X,
166 Teuchos::Array<Teuchos::RCP<Teuchos::SerialDenseMatrix<int,ScalarType> > > C,
167 Teuchos::ArrayView<Teuchos::RCP<const MV> > Q) const = 0;
168
183 virtual int normalize ( MV &X, Teuchos::RCP<Teuchos::SerialDenseMatrix<int,ScalarType> > B ) const = 0;
184
185 protected:
186 virtual int
188 Teuchos::Array<Teuchos::RCP<Teuchos::SerialDenseMatrix<int,ScalarType> > > C,
189 Teuchos::RCP<Teuchos::SerialDenseMatrix<int,ScalarType> > B,
190 Teuchos::ArrayView<Teuchos::RCP<const MV> > Q) const = 0;
191
192 public:
193
248 int
250 Teuchos::Array<Teuchos::RCP<Teuchos::SerialDenseMatrix<int,ScalarType> > > C,
251 Teuchos::RCP<Teuchos::SerialDenseMatrix<int,ScalarType> > B,
252 Teuchos::ArrayView<Teuchos::RCP<const MV> > Q) const
253 {
254 return this->projectAndNormalizeImpl (X, C, B, Q);
255 }
256
258
260
261
264 virtual typename Teuchos::ScalarTraits< ScalarType >::magnitudeType
265 orthonormError(const MV &X) const = 0;
266
269 virtual typename Teuchos::ScalarTraits<ScalarType>::magnitudeType
270 orthogError(const MV &X1, const MV &X2) const = 0;
271
273
274
276
277
280 virtual void setLabel(const std::string& label) = 0;
281
284 virtual const std::string& getLabel() const = 0;
285
287
288 };
289
290} // end of Belos namespace
291
292
293#endif
294
295// end of file BelosOrthoManager.hpp
Belos header file which uses auto-configuration information to include necessary C++ headers.
Collection of types and exceptions used within the Belos solvers.
Parent class to all Belos exceptions.
BelosError(const std::string &what_arg)
Exception thrown to signal error in an orthogonalization manager method.
OrthoError(const std::string &what_arg)
Belos's templated virtual class for providing routines for orthogonalization and orthonormzalition of...
OrthoManager()
Default constructor.
virtual void norm(const MV &X, std::vector< typename Teuchos::ScalarTraits< ScalarType >::magnitudeType > &normvec) const =0
Compute the norm(s) of the column(s) of X.
virtual void innerProd(const MV &X, const MV &Y, Teuchos::SerialDenseMatrix< int, ScalarType > &Z) const =0
Provides the inner product defining the orthogonality concepts.
virtual int normalize(MV &X, Teuchos::RCP< Teuchos::SerialDenseMatrix< int, ScalarType > > B) const =0
This method takes a multivector X and attempts to compute an orthonormal basis for ,...
int projectAndNormalize(MV &X, Teuchos::Array< Teuchos::RCP< Teuchos::SerialDenseMatrix< int, ScalarType > > > C, Teuchos::RCP< Teuchos::SerialDenseMatrix< int, ScalarType > > B, Teuchos::ArrayView< Teuchos::RCP< const MV > > Q) const
Project X against the Q[i] and normalize X.
virtual Teuchos::ScalarTraits< ScalarType >::magnitudeType orthogError(const MV &X1, const MV &X2) const =0
This method computes the error in orthogonality of two multivectors.
virtual void project(MV &X, Teuchos::Array< Teuchos::RCP< Teuchos::SerialDenseMatrix< int, ScalarType > > > C, Teuchos::ArrayView< Teuchos::RCP< const MV > > Q) const =0
Project X against the (orthogonal) entries of Q.
virtual ~OrthoManager()
Destructor.
virtual Teuchos::ScalarTraits< ScalarType >::magnitudeType orthonormError(const MV &X) const =0
This method computes the error in orthonormality of a multivector.
virtual int projectAndNormalizeImpl(MV &X, Teuchos::Array< Teuchos::RCP< Teuchos::SerialDenseMatrix< int, ScalarType > > > C, Teuchos::RCP< Teuchos::SerialDenseMatrix< int, ScalarType > > B, Teuchos::ArrayView< Teuchos::RCP< const MV > > Q) const =0
virtual void setLabel(const std::string &label)=0
This method sets the label used by the timers in the orthogonalization manager.
virtual const std::string & getLabel() const =0
This method returns the label being used by the timers in the orthogonalization manager.