Thyra  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Thyra_ScalarProdBase_decl.hpp
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Thyra: Interfaces and Support for Abstract Numerical Algorithms
5 // Copyright (2004) Sandia Corporation
6 //
7 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8 // license for use of this work by or on behalf of the U.S. Government.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Roscoe A. Bartlett (bartlettra@ornl.gov)
38 //
39 // ***********************************************************************
40 // @HEADER
41 
42 #ifndef THYRA_SCALAR_PROD_BASE_DECL_HPP
43 #define THYRA_SCALAR_PROD_BASE_DECL_HPP
44 
45 #include "Thyra_OperatorVectorTypes.hpp"
46 #include "Teuchos_Describable.hpp"
47 
48 
49 namespace Thyra {
50 
51 
89 template<class Scalar>
90 class ScalarProdBase : virtual public Teuchos::Describable {
91 public:
92 
95 
102  bool isEuclidean() const
103  { return isEuclideanImpl(); }
104 
126  Scalar scalarProd(
127  const VectorBase<Scalar>& x, const VectorBase<Scalar>& y
128  ) const
129  { return scalarProdImpl(x, y); }
130 
166  const ArrayView<Scalar> &scalarProds_out
167  ) const
168  { scalarProdsImpl(X, Y, scalarProds_out); }
169 
178  { return getLinearOpImpl(); }
179 
181 
182 protected:
183 
186 
188  virtual bool isEuclideanImpl() const = 0;
189 
191  virtual Scalar scalarProdImpl(
192  const VectorBase<Scalar>& x, const VectorBase<Scalar>& y ) const;
193 
195  virtual void scalarProdsImpl(
197  const ArrayView<Scalar> &scalarProds_out
198  ) const = 0;
199 
202  {
203  return Teuchos::null;
204  }
205 
207 
208 };
209 
210 
211 } // end namespace Thyra
212 
213 
214 #endif // THYRA_SCALAR_PROD_BASE_DECL_HPP
RCP< const LinearOpBase< Scalar > > getLinearOp() const
Return a linear operator representing the scalar product Q.
virtual bool isEuclideanImpl() const =0
bool isEuclidean() const
Return if this is a Euclidean (identity) scalar product is the same as the dot product.
void scalarProds(const MultiVectorBase< Scalar > &X, const MultiVectorBase< Scalar > &Y, const ArrayView< Scalar > &scalarProds_out) const
Return the scalar product of each column in two multi-vectors in the vector space.
Interface for a collection of column vectors called a multi-vector.
Abstract interface for finite-dimensional dense vectors.
virtual Scalar scalarProdImpl(const VectorBase< Scalar > &x, const VectorBase< Scalar > &y) const
Default implementation calls scalarProdsImpl().
Scalar scalarProd(const VectorBase< Scalar > &x, const VectorBase< Scalar > &y) const
Return the scalar product of two vectors in the vector space.
virtual RCP< const LinearOpBase< Scalar > > getLinearOpImpl() const
virtual void scalarProdsImpl(const MultiVectorBase< Scalar > &X, const MultiVectorBase< Scalar > &Y, const ArrayView< Scalar > &scalarProds_out) const =0