Belos Version of the Day
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 the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
00008 // the U.S. Government retains certain rights in this software.
00009 //
00010 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
00038 //
00039 // ************************************************************************
00040 //@HEADER
00041 
00046 #ifndef BELOS_ORTHOMANAGER_HPP
00047 #define BELOS_ORTHOMANAGER_HPP
00048 
00063 #include "BelosConfigDefs.hpp"
00064 #include "BelosTypes.hpp"
00065 #include "Teuchos_ScalarTraits.hpp"
00066 #include "Teuchos_RCP.hpp"
00067 #include "Teuchos_SerialDenseMatrix.hpp"
00068 #include "Teuchos_Array.hpp"
00069 
00070 
00071 namespace Belos {
00072 
00073 
00075 
00076 
00079   class OrthoError : public BelosError
00080   {public: OrthoError(const std::string& what_arg) : BelosError(what_arg) {}};
00081 
00083 
00084   template <class ScalarType, class MV>
00085   class OrthoManager {
00086   public:
00088 
00089 
00090     OrthoManager() {};
00091 
00093     virtual ~OrthoManager() {};
00095 
00097 
00098 
00107     virtual void innerProd( const MV &X, const MV &Y, Teuchos::SerialDenseMatrix<int,ScalarType>& Z ) const = 0;
00108 
00109 
00112     virtual void norm( const MV& X, std::vector< typename Teuchos::ScalarTraits<ScalarType>::magnitudeType >& normvec ) const = 0;
00113 
00148     virtual void 
00149     project (MV &X, 
00150        Teuchos::Array<Teuchos::RCP<Teuchos::SerialDenseMatrix<int,ScalarType> > > C, 
00151        Teuchos::ArrayView<Teuchos::RCP<const MV> > Q) const = 0;
00152 
00167     virtual int normalize ( MV &X, Teuchos::RCP<Teuchos::SerialDenseMatrix<int,ScalarType> > B ) const = 0;
00168 
00169 
00224     virtual int 
00225     projectAndNormalize (MV &X, 
00226        Teuchos::Array<Teuchos::RCP<Teuchos::SerialDenseMatrix<int,ScalarType> > > C, 
00227        Teuchos::RCP<Teuchos::SerialDenseMatrix<int,ScalarType> > B, 
00228        Teuchos::ArrayView<Teuchos::RCP<const MV> > Q) const = 0;
00230 
00232 
00233 
00236     virtual typename Teuchos::ScalarTraits< ScalarType >::magnitudeType 
00237     orthonormError(const MV &X) const = 0;
00238 
00241     virtual typename Teuchos::ScalarTraits<ScalarType>::magnitudeType 
00242     orthogError(const MV &X1, const MV &X2) const = 0;
00243 
00245 
00246 
00248 
00249 
00252     virtual void setLabel(const std::string& label) = 0;
00253  
00256     virtual const std::string& getLabel() const = 0;
00257     
00259 
00260   };
00261 
00262 } // end of Belos namespace
00263 
00264 
00265 #endif
00266 
00267 // end of file BelosOrthoManager.hpp
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines