BelosOrthoManager.hpp

Go to the documentation of this file.
00001 // @HEADER
00002 // ***********************************************************************
00003 //
00004 //                 Belos: Block Linear Solvers Package
00005 //                 Copyright (2004) Sandia Corporation
00006 //
00007 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00008 // license for use of this work by or on behalf of the U.S. Government.
00009 //
00010 // This library is free software; you can redistribute it and/or modify
00011 // it under the terms of the GNU Lesser General Public License as
00012 // published by the Free Software Foundation; either version 2.1 of the
00013 // License, or (at your option) any later version.
00014 //
00015 // This library is distributed in the hope that it will be useful, but
00016 // WITHOUT ANY WARRANTY; without even the implied warranty of
00017 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00018 // Lesser General Public License for more details.
00019 //
00020 // You should have received a copy of the GNU Lesser General Public
00021 // License along with this library; if not, write to the Free Software
00022 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
00023 // USA
00024 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
00025 //
00026 // ***********************************************************************
00027 // @HEADER
00028 
00033 #ifndef BELOS_ORTHOMANAGER_HPP
00034 #define BELOS_ORTHOMANAGER_HPP
00035 
00050 #include "BelosConfigDefs.hpp"
00051 #include "BelosTypes.hpp"
00052 #include "Teuchos_ScalarTraits.hpp"
00053 #include "Teuchos_RCP.hpp"
00054 #include "Teuchos_SerialDenseMatrix.hpp"
00055 #include "Teuchos_Array.hpp"
00056 
00057 
00058 
00059 
00060 namespace Belos {
00061 
00062 
00064 
00065 
00068   class OrthoError : public BelosError
00069   {public: OrthoError(const std::string& what_arg) : BelosError(what_arg) {}};
00070 
00072 
00073   template <class ScalarType, class MV>
00074   class OrthoManager {
00075   public:
00077 
00078 
00079     OrthoManager() {};
00080 
00082     virtual ~OrthoManager() {};
00084 
00086 
00087 
00096     virtual void innerProd( const MV &X, const MV &Y, Teuchos::SerialDenseMatrix<int,ScalarType>& Z ) const = 0;
00097 
00098 
00101     virtual void norm( const MV& X, std::vector< typename Teuchos::ScalarTraits<ScalarType>::magnitudeType > normvec ) const = 0;
00102 
00122     virtual void project ( MV &X, 
00123                            Teuchos::Array<Teuchos::RCP<Teuchos::SerialDenseMatrix<int,ScalarType> > > C, 
00124                            Teuchos::Array<Teuchos::RCP<const MV> > Q) const = 0;
00125 
00140     virtual int normalize ( MV &X, Teuchos::RCP<Teuchos::SerialDenseMatrix<int,ScalarType> > B ) const = 0;
00141 
00142 
00170     virtual int projectAndNormalize ( MV &X, 
00171                                       Teuchos::Array<Teuchos::RCP<Teuchos::SerialDenseMatrix<int,ScalarType> > > C, 
00172                                       Teuchos::RCP<Teuchos::SerialDenseMatrix<int,ScalarType> > B, 
00173                                       Teuchos::Array<Teuchos::RCP<const MV> > Q ) const = 0;
00174 
00176 
00178 
00179 
00182     virtual typename Teuchos::ScalarTraits< ScalarType >::magnitudeType orthonormError(const MV &X) const = 0;
00183 
00186     virtual typename Teuchos::ScalarTraits<ScalarType>::magnitudeType orthogError(const MV &X1, const MV &X2) const = 0;
00187 
00189 
00190 
00192 
00193 
00196     virtual void setLabel(const std::string& label) = 0;
00197  
00200     virtual const std::string& getLabel() const = 0;
00201     
00203 
00204   };
00205 
00206 } // end of Belos namespace
00207 
00208 
00209 #endif
00210 
00211 // end of file BelosOrthoManager.hpp
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Generated on Wed Apr 13 10:05:14 2011 for Belos Package Browser (Single Doxygen Collection) by  doxygen 1.6.3