Thyra Version of the Day
Thyra_ScalarProdBase_decl.hpp
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 // 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 Roscoe A. Bartlett (bartlettra@ornl.gov) 
00038 // 
00039 // ***********************************************************************
00040 // @HEADER
00041 
00042 #ifndef THYRA_SCALAR_PROD_BASE_DECL_HPP
00043 #define THYRA_SCALAR_PROD_BASE_DECL_HPP
00044 
00045 #include "Thyra_OperatorVectorTypes.hpp"
00046 #include "Teuchos_Describable.hpp"
00047 
00048 
00049 namespace Thyra {
00050 
00051 
00089 template<class Scalar>
00090 class ScalarProdBase : virtual public Teuchos::Describable {
00091 public:
00092   
00095 
00102   bool isEuclidean() const
00103     { return isEuclideanImpl(); }
00104 
00126   Scalar scalarProd(
00127     const VectorBase<Scalar>& x, const VectorBase<Scalar>& y
00128     ) const
00129     { return scalarProdImpl(x, y); }
00130 
00164   void scalarProds(
00165     const MultiVectorBase<Scalar>& X, const MultiVectorBase<Scalar>& Y,
00166     const ArrayView<Scalar> &scalarProds_out
00167     ) const
00168     { scalarProdsImpl(X, Y, scalarProds_out); }
00169 
00177   RCP<const LinearOpBase<Scalar> > getLinearOp() const
00178     { return getLinearOpImpl(); }
00179 
00181 
00182 protected:
00183 
00186 
00188   virtual bool isEuclideanImpl() const = 0;
00189   
00191   virtual Scalar scalarProdImpl(
00192     const VectorBase<Scalar>& x, const VectorBase<Scalar>& y ) const;
00193 
00195   virtual void scalarProdsImpl(
00196     const MultiVectorBase<Scalar>& X, const MultiVectorBase<Scalar>& Y,
00197     const ArrayView<Scalar> &scalarProds_out
00198     ) const = 0;
00199 
00201   virtual RCP<const LinearOpBase<Scalar> > getLinearOpImpl() const
00202     {
00203       return Teuchos::null;
00204     }
00205 
00207 
00208 };
00209 
00210 
00211 } // end namespace Thyra
00212 
00213 
00214 #endif  // THYRA_SCALAR_PROD_BASE_DECL_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines