Thyra Version of the Day
Loading...
Searching...
No Matches
Thyra_ScalarProdVectorSpaceBase_def.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_DEF_HPP
43#define THYRA_SCALAR_PROD_VECTOR_SPACE_BASE_DEF_HPP
44
45#include "Thyra_ScalarProdVectorSpaceBase_decl.hpp"
46#include "Thyra_VectorSpaceDefaultBase.hpp"
47#include "Thyra_EuclideanScalarProd.hpp"
48#include "Thyra_AssertOp.hpp"
49
50
51namespace Thyra {
52
53
54// Constructors / initializers
55
56
57template<class Scalar>
59 :scalarProd_(Teuchos::rcp(new EuclideanScalarProd<Scalar>()))
60{}
61
62
63template<class Scalar>
65 const Teuchos::RCP<const ScalarProdBase<Scalar> > &scalarProd_in
66 )
67 :scalarProd_(scalarProd_in.assert_not_null())
68{}
69
70
71template<class Scalar>
73 const Teuchos::RCP<const ScalarProdBase<Scalar> > &scalarProd_in
74 )
75{
76 scalarProd_ = scalarProd_in.assert_not_null();
77}
78
79
80template<class Scalar>
83{
84 return scalarProd_;
85}
86
87
88// Overridden from VectorSpaceBase
89
90
91template<class Scalar>
93{
94 return scalarProd_->isEuclidean();
95}
96
97
98template<class Scalar>
100 const VectorBase<Scalar>& x, const VectorBase<Scalar>& y ) const
101{
102#ifdef TEUCHOS_DEBUG
103 THYRA_ASSERT_VEC_SPACES("ScalarProdVectorSpaceBase<Scalar>::scalarProd(...)",
104 *x.space(), *this);
105 THYRA_ASSERT_VEC_SPACES("ScalarProdVectorSpaceBase<Scalar>::scalarProd(...)",
106 *y.space(), *this);
107#endif
108 return scalarProd_->scalarProd(x,y);
109}
110
111
112template<class Scalar>
115 const ArrayView<Scalar> &scalarProds_out ) const
116{
117#ifdef TEUCHOS_DEBUG
118 THYRA_ASSERT_VEC_SPACES("ScalarProdVectorSpaceBase<Scalar>::scalarProds(...)",
119 *X.range(), *this);
120 THYRA_ASSERT_VEC_SPACES("ScalarProdVectorSpaceBase<Scalar>::scalarProds(...)",
121 *Y.range(), *this);
122 THYRA_ASSERT_VEC_SPACES("ScalarProdVectorSpaceBase<Scalar>::scalarProds(...)",
123 *X.domain(), *Y.domain());
124#endif
125 scalarProd_->scalarProds(X, Y, scalarProds_out);
126}
127
128
129} // end namespace Thyra
130
131
132#endif // THYRA_SCALAR_PROD_VECTOR_SPACE_BASE_DEF_HPP
Concrete implementation of a scalar product for a Euclidean vector space (i.e. using the dot product)...
virtual RCP< const VectorSpaceBase< Scalar > > range() const =0
Return a smart pointer for the range space for this operator.
virtual RCP< const VectorSpaceBase< Scalar > > domain() const =0
Return a smart pointer for the domain space for this operator.
Interface for a collection of column vectors called a multi-vector.
Abstract interface for scalar products.
bool isEuclidean() const
Returns getScalarProd()->isEuclidean()
Scalar scalarProd(const VectorBase< Scalar > &x, const VectorBase< Scalar > &y) const
Returns getScalarProd()->scalarProd(x,y)
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()->scalarProds(X,Y,scalar_prods)
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.
Abstract interface for finite-dimensional dense vectors.
virtual RCP< const VectorSpaceBase< Scalar > > space() const =0
Return a smart pointer to the vector space that this vector belongs to.
#define THYRA_ASSERT_VEC_SPACES(FUNC_NAME, VS1, VS2)
This is a very useful macro that should be used to validate that two vector spaces are compatible.
TEUCHOS_DEPRECATED RCP< T > rcp(T *p, Dealloc_T dealloc, bool owns_mem)