Thyra  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Thyra_ScalarProdVectorSpaceBase_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_VECTOR_SPACE_BASE_DECL_HPP
43 #define THYRA_SCALAR_PROD_VECTOR_SPACE_BASE_DECL_HPP
44 
45 #include "Thyra_OperatorVectorAdapterSupportTypes.hpp"
46 #include "Thyra_VectorSpaceDefaultBase.hpp"
47 
48 
49 namespace Thyra {
50 
51 
84 template<class Scalar>
85 class ScalarProdVectorSpaceBase : virtual public VectorSpaceDefaultBase<Scalar> {
86 public:
87 
90 
101 
118  const RCP<const ScalarProdBase<Scalar> > &scalarProd );
119 
140  virtual void setScalarProd(
141  const RCP<const ScalarProdBase<Scalar> > &scalarProd );
142 
145  RCP<const ScalarProdBase<Scalar> > getScalarProd() const;
146 
148 
151 
153  bool isEuclidean() const;
155  Scalar scalarProd(
156  const VectorBase<Scalar>& x, const VectorBase<Scalar>& y ) const;
158  void scalarProdsImpl(
159  const MultiVectorBase<Scalar>& X, const MultiVectorBase<Scalar>& Y,
160  const ArrayView<Scalar> &scalarProds_out ) const;
161 
163 
164 private:
165 
166  RCP<const ScalarProdBase<Scalar> > scalarProd_;
167 
168 };
169 
170 
175 template<class Scalar>
176 RCP<const ScalarProdVectorSpaceBase<Scalar> >
178  const RCP<const VectorSpaceBase<Scalar> > &vs,
179  const Ordinal dim
180  )
181 {
182  return Teuchos::rcp_dynamic_cast<const ScalarProdVectorSpaceBase<Scalar> >(
183  vs->smallVecSpcFcty()->createVecSpc(dim), true);
184 }
185 
186 
187 } // end namespace Thyra
188 
189 
190 #endif // THYRA_SCALAR_PROD_VECTOR_SPACE_BASE_DECL_HPP
RCP< const ScalarProdVectorSpaceBase< Scalar > > createSmallScalarProdVectorSpaceBase(const RCP< const VectorSpaceBase< Scalar > > &vs, const Ordinal dim)
Create a small vector space casted to ScalarProdVectorSpaceBase.
ScalarProdVectorSpaceBase()
Construct to use dot product as the default.
void scalarProdsImpl(const MultiVectorBase< Scalar > &X, const MultiVectorBase< Scalar > &Y, const ArrayView< Scalar > &scalarProds_out) const
Calls getScalarProd()-&gt;scalarProds(X,Y,scalar_prods)
Abstract interface for objects that represent a space for vectors.
bool isEuclidean() const
Returns getScalarProd()-&gt;isEuclidean()
Teuchos::Ordinal Ordinal
Type for the dimension of a vector space. `*.
RCP< const ScalarProdBase< Scalar > > getScalarProd() const
Return the current scalar product.
virtual void setScalarProd(const RCP< const ScalarProdBase< Scalar > > &scalarProd)
Set a different scalar product.
Scalar scalarProd(const VectorBase< Scalar > &x, const VectorBase< Scalar > &y) const
Returns getScalarProd()-&gt;scalarProd(x,y)