Belos: BelosMultiVecTraits.hpp Source 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 //
00029 #ifndef BELOS_MULTI_VEC_TRAITS_HPP
00030 #define BELOS_MULTI_VEC_TRAITS_HPP
00031 
00032 #include "Teuchos_RefCountPtr.hpp"
00033 #include "Teuchos_SerialDenseMatrix.hpp"
00034 #include "BelosTypes.hpp"
00035 
00036 namespace Belos {
00037 
00038   template< class ScalarType, class MV >
00039   struct UndefinedMultiVecTraits
00040   {
00042     static inline ScalarType notDefined() { return MV::this_type_is_missing_a_specialization(); };
00043   };
00044   
00045   template<class ScalarType, class MV>
00046   class MultiVecTraits 
00047   {
00048   public:
00050     static Teuchos::RefCountPtr<MV> Clone( const MV& mv, const int numvecs )
00051     { UndefinedMultiVecTraits<ScalarType, MV>::notDefined(); return Teuchos::null; }     
00053     static Teuchos::RefCountPtr<MV> CloneCopy( const MV& mv )
00054     { UndefinedMultiVecTraits<ScalarType, MV>::notDefined(); return Teuchos::null; }     
00056     static Teuchos::RefCountPtr<MV> CloneCopy( const MV& mv, const std::vector<int>& index )
00057     { UndefinedMultiVecTraits<ScalarType, MV>::notDefined(); return Teuchos::null; }     
00059     static Teuchos::RefCountPtr<MV> CloneView( MV& mv, const std::vector<int>& index )
00060     { UndefinedMultiVecTraits<ScalarType, MV>::notDefined(); return Teuchos::null; }     
00062     static Teuchos::RefCountPtr<const MV> CloneView( const MV& mv, const std::vector<int>& index )
00063     { UndefinedMultiVecTraits<ScalarType, MV>::notDefined(); return Teuchos::null; }     
00065     static int GetVecLength( const MV& mv )
00066     { UndefinedMultiVecTraits<ScalarType, MV>::notDefined(); return 0; }     
00068     static int GetNumberVecs( const MV& mv )
00069     { UndefinedMultiVecTraits<ScalarType, MV>::notDefined(); return 0; }     
00071     static void MvTimesMatAddMv( const ScalarType alpha, const MV& A, 
00072          const Teuchos::SerialDenseMatrix<int,ScalarType>& B, 
00073          const ScalarType beta, MV& mv )
00074     { UndefinedMultiVecTraits<ScalarType, MV>::notDefined(); }     
00076     static void MvAddMv( const ScalarType alpha, const MV& A, const ScalarType beta, const MV& B, MV& mv )
00077     { UndefinedMultiVecTraits<ScalarType, MV>::notDefined(); }     
00079     static void MvTransMv( const ScalarType alpha, const MV& A, const MV& mv, Teuchos::SerialDenseMatrix<int,ScalarType>& B )
00080     { UndefinedMultiVecTraits<ScalarType, MV>::notDefined(); }     
00082     static void MvDot ( const MV& mv, const MV& A, std::vector<ScalarType>* b ) 
00083     { UndefinedMultiVecTraits<ScalarType, MV>::notDefined(); }     
00085     static void MvNorm( const MV& mv, std::vector<typename Teuchos::ScalarTraits<ScalarType>::magnitudeType>* normvec, NormType type = TwoNorm )
00086     { UndefinedMultiVecTraits<ScalarType, MV>::notDefined(); }     
00088     static void SetBlock( const MV& A, const std::vector<int>& index, MV& mv )
00089     { UndefinedMultiVecTraits<ScalarType, MV>::notDefined(); }     
00091     static void MvRandom( MV& mv )
00092     { UndefinedMultiVecTraits<ScalarType, MV>::notDefined(); }     
00094     static void MvInit( MV& mv, const ScalarType alpha = Teuchos::ScalarTraits<ScalarType>::zero() )
00095     { UndefinedMultiVecTraits<ScalarType, MV>::notDefined(); }     
00097     static void MvPrint( const MV& mv, ostream& os )
00098     { UndefinedMultiVecTraits<ScalarType, MV>::notDefined(); }     
00099   };
00100   
00101 } // namespace Belos
00102 
00103 #endif // BELOS_MULTI_VEC_TRAITS_HPP