Thyra Package Browser (Single Doxygen Collection) Version of the Day
Thyra_ScalarProdBase_decl.hpp
Go to the documentation of this file.
00001 // @HEADER
00002 // ***********************************************************************
00003 // 
00004 //    Thyra: Interfaces and Support for Abstract Numerical Algorithms
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 THYRA_SCALAR_PROD_BASE_DECL_HPP
00030 #define THYRA_SCALAR_PROD_BASE_DECL_HPP
00031 
00032 #include "Thyra_OperatorVectorTypes.hpp"
00033 #include "Teuchos_Describable.hpp"
00034 
00035 
00036 namespace Thyra {
00037 
00038 
00076 template<class Scalar>
00077 class ScalarProdBase : virtual public Teuchos::Describable {
00078 public:
00079   
00082 
00089   bool isEuclidean() const
00090     { return isEuclideanImpl(); }
00091 
00113   Scalar scalarProd(
00114     const VectorBase<Scalar>& x, const VectorBase<Scalar>& y
00115     ) const
00116     { return scalarProdImpl(x, y); }
00117 
00151   void scalarProds(
00152     const MultiVectorBase<Scalar>& X, const MultiVectorBase<Scalar>& Y,
00153     const ArrayView<Scalar> &scalarProds_out
00154     ) const
00155     { scalarProdsImpl(X, Y, scalarProds_out); }
00156 
00164   RCP<const LinearOpBase<Scalar> > getLinearOp() const
00165     { return getLinearOpImpl(); }
00166 
00168 
00169 protected:
00170 
00173 
00175   virtual bool isEuclideanImpl() const = 0;
00176   
00178   virtual Scalar scalarProdImpl(
00179     const VectorBase<Scalar>& x, const VectorBase<Scalar>& y ) const;
00180 
00182   virtual void scalarProdsImpl(
00183     const MultiVectorBase<Scalar>& X, const MultiVectorBase<Scalar>& Y,
00184     const ArrayView<Scalar> &scalarProds_out
00185     ) const = 0;
00186 
00188   virtual RCP<const LinearOpBase<Scalar> > getLinearOpImpl() const
00189     {
00190       return Teuchos::null;
00191     }
00192 
00194 
00195 };
00196 
00197 
00198 } // end namespace Thyra
00199 
00200 
00201 #endif  // THYRA_SCALAR_PROD_BASE_DECL_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines